Skip to main content
POST
Search for carts

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

x-api-key
string

API Key for Gateway

Example:

"zaCELgL.0imfnc8mVLWwsAawjYr4Rx-Af50DDqtlx"

Authorization
string
required

Authorization token for the user

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."

Body

application/json

Request body for search cart

Cart search parameters and response pagination details /// Search for carts meeting specified criteria, including creation date, status, user, approver, and purchase order

offset
integer<int32>
required

Pagination offset (starts with zero)

Example:

0

limit
integer<int32>
required

Number of cart responses per page

Example:

10

filter
object
required

Cart search parameters

Response

OK

Cart search response object

offset
integer<int32>

Pagination offset (starts with zero)

Example:

0

limit
integer<int32>

Number of cart responses per page

Example:

10

count
integer<int32>

Number of available carts meeting search criteria

Example:

10

carts
object[] | null

Details for carts meeting search criteria