Get Order By ID | TaxCloud

curl https://api.v3.taxcloud.com/tax/connections/connectionId/orders/orderId \
     -H "Authorization: Bearer <token>"

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

Authentication

AuthorizationBearer

This authentication type can be used to directly call the service.

X-API-KEYstring

This authentication type is supported by using the provided API key for the merchant account.

Path parameters

connectionIdstringRequired>=36 characters

represents the ID of a connection. It is used as a unique identifier for the connection

orderIdstringRequired

the id of the order

Query parameters

expandstringOptional

comma-separated list of fields to expand. Currently supports: refunds

Response

channelstring or null

what channel did this come from

connectionIdstring>=36 characters

represents the ID of a connection. It is used as a unique identifier for the connection

currencyobject

represents information about a currency including its code and denomination.

customerIdstring

customerId in external system

deliveredBySellerboolean

represents if the seller directly delivered the order.

destinationobject

the destination address of the order

excludeFromFilingbooleanDefaults to false

Whether to exclude from filing

exemptionobject

information about exemption on the order

kindenum

The kind of order, either credit or order. Defaults to order if not provided.

Allowed values:

lineItemslist of objects

orderIdstring

orderId in external system

originobject

the origin address of the order

transactionDatestringformat: "date-time"

The RFC3339 datetime string the order was purchased on

$schemastringRead-onlyformat: "uri"

A URL to the JSON Schema for this object.

batchIdstring

Batch ID for grouping orders

completedDatestringformat: "date-time"

The RFC3339 datetime string the order was shipped on, created a tax liability

refundslist of objects

refunds associated with this order when expand=refunds is specified

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error