Search for carts

Search for carts meeting specified criteria, including creation date, status, user, approver, and purchase order

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.

x-api-key

string

API Key for Gateway

Authorization

string

required

Authorization token for the user

Body

application/json

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

offset

integer

required

Pagination offset (starts with zero)

limit

integer

required

Number of cart responses per page

filter

object

required

Cart search parameters

Show child attributes

Response

200 - application/json

Cart search response object

offset

integer

Pagination offset (starts with zero)

limit

integer

Number of cart responses per page

count

integer

Number of available carts meeting search criteria

carts

object[] | null

Details for carts meeting search criteria

Show child attributes