Merchant Transactions [TaxCloud]

Create Order

Available on Enterprise Plan

Forwards to TaxCloud POST /connections/{connectionId}/orders to create an order directly. All order fields other than merchantId are relayed unchanged.

Authentication

X-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
completedDatedatetimeRequired
RFC3339 datetime the order was shipped on, which created the tax liability.
currencyobjectRequired

The currency the line-item prices and tax amounts are denominated in.

customerIdstringRequired<=50 characters
Your identifier for the customer in your own system. Used to match exemption certificates and order history.
destinationobjectRequired

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

lineItemslist of objectsRequired
The items on the order, each including the tax rate and amount that was collected.
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<=50 characters

Your identifier for the order in your own system. Used later with /merchant/order/get, /merchant/order/update, and /merchant/refund/create.

originobjectRequired

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

transactionDatedatetimeRequired
RFC3339 datetime the order was purchased on.
batchIdstringOptional
Optional batch ID for grouping related orders.
channelstringOptional

The sales channel the order came from. Pass one of amazon, ebay, or walmart to exclude marketplace-collected tax from filing.

deliveredBySellerbooleanOptional

Whether the seller delivers the order directly (own vehicles) rather than via common carrier. Affects taxability of delivery charges in some states.

discountsobjectOptional

Optional line-item and order-level discounts to apply. If omitted, prices are used as is.

excludeFromFilingbooleanOptional
Whether to exclude the order from tax filing.
exemptionobjectOptional
Optional exemption information for the customer.
kindenumOptionalDefaults to order

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

Allowed values:

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 Create Body Bad Request Error
401
Merchant Order Create Body Unauthorized Error
403
Merchant Order Create Body Forbidden Error
404
Merchant Order Create Body Not Found Error
413
Merchant Order Create Body Content Too Large Error
422
Merchant Order Create Body Unprocessable Entity Error
429
Merchant Order Create Body Too Many Requests Error
500
Merchant Order Create Body Internal Server Error
502
Merchant Order Create Body Bad Gateway Error
504
Merchant Order Create Body Gateway Timeout Error