orders

Get Order By ID

get/tax/connections/{connectionId}/orders/{orderId}

Request

  • Base URL: https://api.v3.taxcloud.com
  • URL: https://api.v3.taxcloud.com/tax/connections/{connectionId}/orders/{orderId}
  • Auth: HTTP bearer

Path parameters

connectionIdstring required

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

orderIdstring required

the id of the order

Query parameters

expandstring

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

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

batchIdstring

Batch ID for grouping orders

channelstring nullable required

what channel did this come from

completedDatestring date-time

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

connectionIdstring required

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

customerIdstring required

customerId in external system

deliveredBySellerboolean required

represents if the seller directly delivered the order.

excludeFromFilingboolean required

Whether to exclude from filing

kind'credit' | 'order' required

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

orderIdstring required

orderId in external system

transactionDatestring date-time required

The RFC3339 datetime string the order was purchased on

Changes

No recorded changes to this operation across all 1 revision of this API.