Get Order By ID

1 curl https://api.v3.taxcloud.com/tax/connections/connectionId/orders/orderId \ 2 -H "X-API-KEY: <apiKey>"

1 { 2 "connectionId": "25eb9b97-5acb-492d-b720-c03e79cf715a", 3 "currency": { 4 "currencyCode": "currencyCode" 5 }, 6 "customerId": "customerId", 7 "deliveredBySeller": true, 8 "destination": { 9 "city": "Minneapolis", 10 "countryCode": "countryCode", 11 "line1": "323 Washington Ave N", 12 "state": "MN", 13 "zip": "55401-2427", 14 "line2": "line2" 15 }, 16 "excludeFromFiling": true, 17 "exemption": { 18 "exemptionId": "exemptionId", 19 "isExempt": true 20 }, 21 "lineItems": [ 22 { 23 "index": 0, 24 "itemId": "item-1", 25 "price": 10.75, 26 "quantity": 1.5, 27 "tax": { 28 "amount": 1.31, 29 "rate": 0.08125 30 }, 31 "tic": 0 32 } 33 ], 34 "orderId": "orderId", 35 "origin": { 36 "city": "Minneapolis", 37 "countryCode": "countryCode", 38 "line1": "323 Washington Ave N", 39 "state": "MN", 40 "zip": "55401-2427", 41 "line2": "line2" 42 }, 43 "transactionDate": "2024-01-15T09:30:00Z", 44 "$schema": "https://example.com/tax/schemas/OrderResponse.json", 45 "channel": "amazon", 46 "completedDate": "2024-01-15T09:30:00Z" 47 }

Path parameters

connectionIdstringRequired

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

orderIdstringRequired

the id of the order

Response

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

excludeFromFilingboolean

Whether to exclude from filing

exemptionobject

information about exemption on the order

lineItemslist of objects

orderIdstring

orderId in external system

originobject

the origin address of the order

transactionDatedatetime

The RFC3339 datetime string the order was purchased on

$schemastringOptionalformat: "uri"

A URL to the JSON Schema for this object.

channelstringOptional

what channel did this come from

completedDatedatetimeOptional

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

Path parameters

Headers

Response

Errors