Search Cart API

Retrieve a user's active cart (and its cartId) by userUniqueKey, or fetch a specific cart by cartId.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request Schema

ParameterTypeDescription
userUniqueKeyStringUnique identifier of the end user whose active cart should be returned (required unless cartId is passed).
cartIdStringFetch a specific cart by its cart ID instead of by user.

Response Schema

PathTypeDescription
dataobjectRoot response object.
data.searchCartobjectContainer for the cart lookup result.
data.searchCart.statusnumberAPI execution status (1 = success).
data.searchCart.dataobjectCart payload (contains cartId and cart contents).
data.searchCart.data.cartIdstringUnique identifier of the returned/created cart.

Implementation Notes

  1. Call Search Cart first to obtain the cartId used by Add or Update Item to Cart, Update Shipment, Update Payment, and Place Cart Order.
  2. Pass either userUniqueKey or cartId. If no cart exists for the user, a new active cart is returned.
  3. The data.searchCart.data shape is representative; confirm the full cart payload against a live response.
Body Params
string
required
Defaults to plumProAPI.mutation.searchCart

Please use 'plumProAPI.mutation.searchCart' always in query

string
required
Defaults to plumProAPI

Please use 'plumProAPI' always in query

json
required
Defaults to {"data":{}}
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json