Get Order | Ziptax

curl -X POST https://api.zip-tax.com/merchant/order/get \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "merchantId": "merchantId",
  "orderId": "my-order-1"
}'

{
  "channel": "amazon",
  "connectionId": "25eb9b97-5acb-492d-b720-c03e79cf715a",
  "currency": {
    "currencyCode": "USD"
  },
  "customerId": "customer-453",
  "deliveredBySeller": true,
  "destination": {
    "city": "Minneapolis",
    "line1": "323 Washington Ave N",
    "state": "MN",
    "zip": "55401-2427",
    "countryCode": "US",
    "line2": "line2"
  },
  "excludeFromFiling": true,
  "exemption": {
    "exemptionId": "exemptionId",
    "isExempt": true
  },
  "kind": "order",
  "orderId": "my-order-1",
  "origin": {
    "city": "Minneapolis",
    "line1": "323 Washington Ave N",
    "state": "MN",
    "zip": "55401-2427",
    "countryCode": "US",
    "line2": "line2"
  },
  "batchId": "batchId",
  "completedDate": "2024-01-15T09:30:00Z",
  "lineItems": [
    {
      "index": 0,
      "itemId": "item-1",
      "originalPrice": 12,
      "price": 10.75,
      "quantity": 1.5,
      "tax": {
        "amount": 1.31,
        "rate": 0.08125
      },
      "tic": 0
    }
  ],
  "refunds": [
    {
      "connectionId": "25eb9b97-5acb-492d-b720-c03e79cf715a",
      "batchId": "batchId",
      "createdDate": "2024-01-15T09:30:00Z",
      "items": [
        {
          "index": 1000000,
          "itemId": "itemId",
          "price": 1.1,
          "quantity": 1.1,
          "tic": 0
        }
      ],
      "returnedDate": "2024-01-15T09:30:00Z"
    }
  ],
  "transactionDate": "2024-01-15T09:30:00Z"
}

Available on Enterprise Plan

Forwards to TaxCloud GET /connections/{connectionId}/orders/{orderId}. orderId is a path identifier; the optional expand field is passed through as a query parameter.

Authentication

X-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

merchantIdstringRequired

UUID of the merchant. Must be owned by the calling account. Consumed by the Ziptax layer for routing and not forwarded to TaxCloud.

orderIdstringRequired

Your identifier for the order to retrieve, as supplied when the order was created.

expand"refunds"Optional

Set to 'refunds' to include the order's refunds in the response. Forwarded to TaxCloud as a query parameter.

Response

TaxCloud response relayed verbatim.

channelstring

The sales channel the order came from (e.g. amazon, ebay, walmart). Null when no channel was recorded.

connectionIdstring

The TaxCloud connection the order was recorded under.

currencyobject

The currency the prices and tax amounts are denominated in.

customerIdstring

Your identifier for the customer in your own system.

deliveredBySellerboolean

Whether the seller delivered the order directly.

destinationobject

The ship-to (destination) address of the order.

excludeFromFilingboolean

Whether the order is excluded from tax filing.

exemptionobject

The exemption information recorded on the order.

kindenum

The kind of order: ‘order’ for a sale or ‘credit’ for a credit order.

orderIdstring

Your identifier for the order in your own system.

originobject

The ship-from (origin) address of the order.

batchIdstring

Batch ID grouping this order with related orders, if one was supplied.

completedDatedatetime

RFC3339 datetime the order was shipped/completed on, creating the tax liability. Absent for orders that are not yet completed.

lineItemslist of objects

The order's line items, each with its tax rate and amount.

refundslist of objects

Refunds recorded against this order. Only included when the request set expand to 'refunds'.

transactionDatedatetime

RFC3339 datetime the order was purchased on.

Errors

400

Merchant Order Get Body Bad Request Error

401

Merchant Order Get Body Unauthorized Error

403

Merchant Order Get Body Forbidden Error

404

Merchant Order Get Body Not Found Error

413

Merchant Order Get Body Content Too Large Error

422

Merchant Order Get Body Unprocessable Entity Error

429

Merchant Order Get Body Too Many Requests Error

500

Merchant Order Get Body Internal Server Error

502

Merchant Order Get Body Bad Gateway Error

504

Merchant Order Get Body Gateway Timeout Error