Skip to main content
POST
Start Purchase

Authorizations

X-Authorization
string
header
required

This API requires a client session ticket, available from any Client Login function.

Body

application/json

This is the first step in the purchasing process. For security purposes, once the order (or "cart") has been created, additional inventory objects may no longer be added. In addition, inventory objects will be locked to the current prices, regardless of any subsequent changes at the catalog level which may occur during the next two steps.

This is the first step in the purchasing process. For security purposes, once the order (or "cart") has been created, additional inventory objects may no longer be added. In addition, inventory objects will be locked to the current prices, regardless of any subsequent changes at the catalog level which may occur during the next two steps.

Items
object[]
required

Array of items to purchase.

CatalogVersion
string

Catalog version for the items to be purchased. Defaults to most recent catalog.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

StoreId
string

Store through which to purchase items. If not set, prices will be pulled from the catalog itself.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Example:
Last modified on October 1, 2026