Search for multiple carts

Returns a list of carts based on the search criteria.

Authorizations

Authorization

string

headerrequired

This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the Making your first API request section.

Headers

x-fabric-tenant-id

string

required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-request-id

string

Unique request ID for tracking.

x-fabric-channel-id

string

x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field. The default US channel is 12 while the default Canada channel is 11.

Body

application/json

Search Cart Request

limit

integer

required

The maximum number of carts returned.

Required range: x > 1

offset

integer

required

The starting point for the records returned from the database.

Required range: x > 0

filter

object

Filters used to customize the carts returned.

Show child attributes

Response

200 - application/json

Search Cart Response

query

object

required

Query details

Show child attributes

data

object[]

required

List of carts returned

Show child attributes