Merchant Transactions [TaxCloud]

Create Order From Cart

Available on Enterprise Plan

Forwards to TaxCloud POST /connections/{connectionId}/carts/orders to capture a previously calculated cart as an order. cartId and orderId travel in the forwarded body.

Authentication

X-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
cartIdstringRequired1-50 characters

The cartId returned by (or supplied to) /merchant/cart/calculate identifying the calculated cart to convert into an order.

merchantIdstringRequired
UUID of the merchant. Must be owned by the calling account. Consumed by the Ziptax layer for routing and not forwarded to TaxCloud.
orderIdstringRequired1-50 characters

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

completedbooleanOptional
Whether the order has shipped, creating a tax liability. Defaults to false. Ignored when completedDate is provided.
completedDatedatetimeOptional
RFC3339 datetime the order was shipped on, which created the tax liability. Takes precedence over the completed field when provided.
kindenumOptionalDefaults to order

The kind of order to create: ‘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 from Cart Body Bad Request Error
401
Merchant Order Create from Cart Body Unauthorized Error
403
Merchant Order Create from Cart Body Forbidden Error
404
Merchant Order Create from Cart Body Not Found Error
413
Merchant Order Create from Cart Body Content Too Large Error
422
Merchant Order Create from Cart Body Unprocessable Entity Error
429
Merchant Order Create from Cart Body Too Many Requests Error
500
Merchant Order Create from Cart Body Internal Server Error
502
Merchant Order Create from Cart Body Bad Gateway Error
504
Merchant Order Create from Cart Body Gateway Timeout Error