Sales Tax APIOrders

Create Order

Create orders from marketplace transactions, pre-existing systems, or bulk uploads.

Path parameters

connectionIdstringRequired>=36 characters
represents the ID of a connection. It is used as a unique identifier for the connection

Headers

X-API-KEYstringRequired

Query parameters

addressAutocompleteenumOptionalDefaults to none

The specified addresses (origin, destination, or all) will be overridden with the first result from an address validation search

Allowed values:

Request

This endpoint expects an object.
completedDatestringRequiredformat: "date-time"
The RFC3339 datetime string the order was shipped on, created a tax liability
currencyobjectRequired
represents information about a currency including its code and denomination.
customerIdstringRequired<=50 characters
customerId in external system
destinationobjectRequired
the destination address of the order
lineItemslist of objectsRequired
orderIdstringRequired<=50 characters
orderId in external system
originobjectRequired
the origin address of the order
transactionDatestringRequiredformat: "date-time"
The RFC3339 datetime string the order was purchased on
channelstringOptional
what channel did this come from. Pass in one of amazon,ebay,walmart for tax exclusion
deliveredBySellerbooleanOptional
represents if the seller directly delivered the order.
excludeFromFilingbooleanOptional
Whether to exclude from filing
exemptionobjectOptional
information about exemption on the order

Response

Created
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
transactionDatestringformat: "date-time"
The RFC3339 datetime string the order was purchased on
$schemastring or nullformat: "uri"
A URL to the JSON Schema for this object.
channelstring or null
what channel did this come from
completedDatestring or nullformat: "date-time"
The RFC3339 datetime string the order was shipped on, created a tax liability

Errors