Create an order from a cartID

Use this endpoint to convert an existing cart into a full order that will be filed. We recommend doing this when customer checks out or the order has been submitted, rather than when payment is collected. Note that the transactionDate will be the moment the endpoint is called.

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

Request

This endpoint expects an object.
cartIdstringRequired>=1 character<=50 characters
Id that represents this cart.
orderIdstringRequired>=1 character<=50 characters
orderId in external system
completedbooleanOptionalDefaults to false
was the order shipped, creating a tax liability.

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