Skip to main content
GET
/
cart
JavaScript
import HenrySDK from '@henrylabs/sdk';

const client = new HenrySDK({
  apiKey: process.env['HENRY_SDK_API_KEY'], // This is the default and can be omitted
});

const carts = await client.cart.list();

console.log(carts.data);
{
  "success": true,
  "status": "<string>",
  "message": "<string>",
  "data": [
    {
      "cartId": "<string>",
      "checkoutUrl": "<string>",
      "data": {
        "items": [
          {
            "link": "https://www.nike.com/u/custom-nike-ja-3-by-you-10002205",
            "quantity": 1,
            "selectedOptions": [
              "regular",
              "black",
              "10-w"
            ],
            "selectedShipping": {
              "value": "standard"
            },
            "coupons": [
              "SUMMER26",
              "SAVE10"
            ],
            "metadata": {
              "creatorSource": "Frank Herbert"
            }
          }
        ],
        "settings": {
          "options": {
            "allowPartialPurchase": true,
            "collectBuyerEmail": "required",
            "collectBuyerAddress": "optional",
            "collectBuyerPhone": "off"
          },
          "commissionFeeFixed": {
            "value": 1.99,
            "currency": "USD"
          },
          "commissionFeePercent": 10,
          "events": [
            {
              "type": "order",
              "data": [
                {
                  "type": "<string>",
                  "points": 123
                }
              ],
              "conditional": {
                "type": "<string>",
                "operator": "equals",
                "value": "<string>"
              }
            }
          ]
        },
        "tags": {}
      },
      "metadata": {}
    }
  ]
}

Authorizations

x-api-key
string
header
required

Query Parameters

cartId
string

Filter by a specific cart ID

Example:

"crt_sa2aEsCz9PRM"

tags
object

Filter carts by key-value tags

Example:
{ "userId": "BennyJ" }
cursor
string

Cursor returned from the previous response

Example:

"2023-01-01T00:00:00Z"

limit
number
default:20

Limit the number of results

Required range: 1 <= x <= 100
Example:

20

Response

Carts fetched successfully

success
boolean
required
status
string
required
message
string
required
data
object[]
required