Cart

The Cart API is used to interact with a cart during a customer's session. This guide shows how to use the Cart API to add, update, and delete cart line items, and update cart notes.

Get the cart

GET /{locale}/api/cart

Use the GET /{locale}/api/cart endpoint to get the cart as JSON.

All monetary properties are returned in the customer's presentment currency. To check the customer's presentment currency, you can use the currency field in the response when you have added other markets.

Below is a simplified GET request using the fetch API. The Content-Type should be set to application/json in the headers object. The response is the JSON of the line items associated.

Example request

Example request
fetch(window.SHOPLAZZA.routes.root + '/api/cart', {
  headers: {
    'Content-Type': 'application/json'
  }
})
  .then((response) => response.json())
  .then((data) => {
    // do something...
  });

Response

Schema
Example

cart object
line_items object[]
List of line items.
Array [
idstring
ID of the line item.
item_idstring
product_idstring
ID of the product.
variant_idstring
ID of the variant.
quantitystring
Quantity of the item.
notestring
Note attached to the line item.
propertiesstring
Custom properties of the line item, returned as a JSON string. Parse it before use.
customboolean
Whether the line item is a custom item.
product_titlestring
Title of the product.
product_handlestring
Handle of the product.
product_urlstring
Relative URL of the product page.
variant_titlestring
Title of the variant, for example Blue, Size M.
product_typestring
Product type.
pricestring
Price of a single unit of the line item.
compare_at_pricestring
Compare-at price of the item.
origin_pricestring
line_pricestring
Combined price of all units in this line item, before discounts.
original_line_pricenumber
Original price of the line item before discounts.
saved_pricenumber
Amount saved on this line item.
final_line_pricestring
Combined price of all units in this line item, after line-level discounts.
final_pricestring
Price of a single unit of this line item, after line-level discounts.
discount_applicationsundefined[]
Discounts applied to this object.
fixed_discount_totalstring
discount_totalstring
Total discount applied.
discount_idstring
ID of the discount applied.
availableboolean
Whether the item can be purchased.
available_quantitynumber
Quantity still available for purchase.
can_buyboolean
Whether the variant of the line item can be sold.
weightstring
Weight of the variant.
weight_unitstring
Unit of the weight, for example kg.
skustring
SKU of the variant, used for inventory tracking.
spustring
SPU of the product.
requires_shippingboolean
Whether shipping is required.
taxableboolean
Whether tax is charged.
image object
Image of the line item's variant.
srcstring
URL of the image.
pathstring
Path of the image file on the image server.
widthnumber
Width of the image, in pixels.
heightnumber
Height of the image, in pixels.
altstring
Alt text of the image.
options object[]
Option values of the line item's variant.
Array [
namestring
Name of the product option, for example Color.
valuestring
Value selected for this product option.
]
wholesale_price object[]
Wholesale price tiers.
Array [
min_quantitynumber
Minimum quantity required for this wholesale tier.
pricestring
Unit price of this wholesale tier.
]
parts_pricestring
product_tagsundefined[]
Tags of the product.
publishedboolean
Whether the resource is published.
published_atstring
Publication time, in ISO-8601 format.
inventory_quantitynumber
Inventory quantity.
inventory_policystring
Whether the product keeps selling when it is out of stock.
inventory_trackingboolean
Whether inventory tracking is enabled.
cost_pricestring
Cost price of the variant.
vendorstring
Vendor of the product.
vendor_urlstring
URL of the product vendor.
barcodestring
Barcode of the variant.
mixed_wholesaleboolean
Whether mixed wholesale is supported.
tax_codestring
retail_pricestring
Retail price in the store's main currency unit.
item_textstring
disabledboolean
is_free_giftboolean
Whether the item is a free gift.
custom_discountsundefined[]
]
ineffectivesundefined[]
Line items in the cart that can no longer be purchased.
discount_applicationsundefined[]
Discounts applied to this object.
attributesundefined[]
total_discountstring
Total amount saved by all discounts on the cart.
discount_line_item_pricestring
Discounted total for the applied discounts.
currencystring
Currency of the cart, for example USD.
original_line_pricestring
Original price of the line item before discounts.
original_total_pricestring
Total price of the cart before any discounts.
line_pricestring
Combined price of all units in this line item, before discounts.
total_pricestring
Total price of the cart after discounts.
notestring
Note attached to the object.
created_atstring
Creation time, in ISO-8601 format.
updated_atstring
Last update time, in ISO-8601 format.
item_countnumber
Number of items in the cart.
total_weightnumber
Total weight of all items in the cart.
invalid_msgstring
identity_cart_idstring
Identifier of the cart. Use it to link a cart to the order it becomes.
user_idstring
ID of the signed-in customer. Absent for guests.

json
{
  "cart": {
    "line_items": [
      {
        "id": "684953787470717063_d41d8cd98f00b204e9800998ecf8427e",
        "item_id": "684953787470717063",
        "product_id": "14a309ec-b966-4cf9-a9bb-33baa821fdbc",
        "variant_id": "fff360dd-6457-466a-98b3-16878bacef5b",
        "quantity": "1",
        "note": "",
        "properties": "",
        "custom": false,
        "product_title": "sample-product",
        "product_handle": "sample-product",
        "product_url": "/products/sample-product",
        "variant_title": "01",
        "product_type": "default",
        "price": "1.00",
        "compare_at_price": "1.00",
        "origin_price": "1.00",
        "line_price": "1.00",
        "original_line_price": 1,
        "saved_price": 0,
        "final_line_price": "1.00",
        "final_price": "1.00",
        "discount_applications": [],
        "fixed_discount_total": "0.00",
        "discount_total": "0.00",
        "discount_id": "",
        "available": true,
        "available_quantity": 999999999,
        "can_buy": true,
        "weight": "0.00",
        "weight_unit": "kg",
        "sku": "",
        "spu": "",
        "requires_shipping": true,
        "taxable": false,
        "image": {
          "src": "//img.staticdj.com/free/e6e8dc980211cbef103e16371d6e0e61.jpeg",
          "path": "free/e6e8dc980211cbef103e16371d6e0e61.jpeg",
          "width": 3000,
          "height": 1500,
          "alt": ""
        },
        "options": [
          {
            "name": "Size",
            "value": "01"
          }
        ],
        "wholesale_price": [
          {
            "min_quantity": 1,
            "price": "1.00"
          }
        ],
        "parts_price": "0.00",
        "product_tags": [],
        "published": true,
        "published_at": "2026-08-10T07:28:24Z",
        "inventory_quantity": 0,
        "inventory_policy": "",
        "inventory_tracking": false,
        "cost_price": "1.00",
        "vendor": "",
        "vendor_url": "",
        "barcode": "",
        "mixed_wholesale": false,
        "tax_code": "",
        "retail_price": "0.00",
        "item_text": "",
        "disabled": false,
        "is_free_gift": false,
        "custom_discounts": []
      }
    ],
    "ineffectives": [],
    "discount_applications": [],
    "attributes": [],
    "total_discount": "0.00",
    "discount_line_item_price": "0.00",
    "currency": "USD",
    "original_line_price": "1.00",
    "original_total_price": "1.00",
    "line_price": "1.00",
    "total_price": "1.00",
    "note": "",
    "created_at": "2026-09-03T01:03:36Z",
    "updated_at": "2026-09-03T02:41:50Z",
    "item_count": 1,
    "total_weight": 0,
    "invalid_msg": "",
    "identity_cart_id": "879f8b8f-c3a0-483c-baf6-f5a55a7ff5b4",
    "user_id": "9fe44049-abab-4fed-ab3d-1bf4ffee8ef5"
  }
}

Add a variant to the cart

POST /{locale}/api/cart

Use the POST /{locale}/api/cart endpoint to add a single variant to the cart.

Example request

If an item is already in the cart, then quantity is added to the current quantity for that item.

Example request
const data = {
  product_id: "b1ab6324-ae4f-4cca-907e-18af16839447",
  variant_id: "4a3d825c-2fac-4f72-a68b-b8604b0935c4",
  quantity: 1,
  refer_info: {
    source: "add_to_cart"
  },
  properties: {
    Engraving: "Happy Birthday",
    _design_id: "dsg_8f21c"
  }
};

fetch(window.SHOPLAZZA.routes.root + '/api/cart', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
})
  .then((response) => response.json())
  .then((data) => {
    // do something...
  })
	.catch((error) => {
    console.error('Error: ', error);
  });

Request parameters

Schema
Example

product_idstring

The product id of the variant.

quantitynumber

The quantity that needs to add to the cart.

variant_idstring

The variant id.

refer_info object

The refer info for the source of the request. It has a source property that possible values: add_to_cart, buy_now, or cart.

sourcestring

propertiesobject

Custom properties to attach to the line item, such as customization options. They stay on the line item through to the order.

json
{
  "product_id": "b1ab6324-ae4f-4cca-907e-18af16839447",
  "variant_id": "4a3d825c-2fac-4f72-a68b-b8604b0935c4",
  "quantity": 1,
  "refer_info": {
    "source": "add_to_cart"
  },
  "properties": {
    "Engraving": "Happy Birthday",
    "_design_id": "dsg_8f21c"
  }
}

note

A line item is identified by its variant together with its properties. Adding the same variant with different properties creates a second line item instead of increasing the quantity of the first one.

In responses, properties comes back as a JSON string, so parse it before reading keys. A line added without properties comes back as an empty string, so check for a value first and guard against a parsed result that is not a plain object.

A key that starts with an underscore is still returned by this API, but it is never displayed to the shopper or in the admin. For the full flow, from writing properties on the product page to reading them back off the order, see Add custom properties to cart and orders.

Response

Schema
Example

statestring

Request result flag; success or 0 means the request succeeded.

messagestring

Result message returned with the response.

errorsundefined[]

List of errors returned when the request fails.

data object

The response payload.

items object[]

List of line items in the cart.

Array [

idstring

ID of the line item.

item_idstring

product_idstring

ID of the product.

variant_idstring

ID of the variant.

quantitynumber

Quantity of the item.

notestring

Note attached to the line item.

propertiesstring

Custom properties of the line item, returned as a JSON string. Parse it before use.

customboolean

Whether the line item is a custom item.

product_titlestring

Title of the product.

product_handlestring

Handle of the product.

product_urlstring

Relative URL of the product page.

variant_titlestring

Title of the variant, for example Blue, Size M.

product_typestring

Product type.

pricestring

Price of a single unit of the line item.

compare_at_pricestring

Compare-at price of the item.

origin_pricestring

availableboolean

Whether the item can be purchased.

available_quantitynumber

Quantity still available for purchase.

weightstring

Weight of the variant.

weight_unitstring

Unit of the weight, for example kg.

skustring

SKU of the variant, used for inventory tracking.

spustring

SPU of the product.

requires_shippingboolean

Whether shipping is required.

taxableboolean

Whether tax is charged.

image object

Image of the line item's variant.

srcstring

URL of the image.

pathstring

Path of the image file on the image server.

widthnumber

Width of the image, in pixels.

heightnumber

Height of the image, in pixels.

altstring

Alt text of the image.

options object[]

Option values of the line item's variant.

Array [

namestring

Name of the product option, for example Color.

valuestring

Value selected for this product option.

]

wholesale_price object[]

Wholesale price tiers.

Array [

min_quantitynumber

Minimum quantity required for this wholesale tier.

pricestring

Unit price of this wholesale tier.

]

product_tagsundefined[]

Tags of the product.

publishedboolean

Whether the resource is published.

published_atstring

Publication time, in ISO-8601 format.

inventory_quantitynumber

Inventory quantity.

inventory_policystring

Whether the product keeps selling when it is out of stock.

inventory_trackingboolean

Whether inventory tracking is enabled.

cost_pricestring

Cost price of the variant.

vendorstring

Vendor of the product.

vendor_urlstring

URL of the product vendor.

barcodestring

Barcode of the variant.

mixed_wholesaleboolean

Whether mixed wholesale is supported.

tax_codestring

retail_pricestring

Retail price in the store's main currency unit.

add_quantitystring

disabledboolean

]

json
{
  "state": "success",
  "message": "",
  "errors": [],
  "data": {
    "items": [
      {
        "id": "0_d41d8cd98f00b204e9800998ecf8427e",
        "item_id": "684953787470717063",
        "product_id": "14a309ec-b966-4cf9-a9bb-33baa821fdbc",
        "variant_id": "fff360dd-6457-466a-98b3-16878bacef5b",
        "quantity": 1,
        "note": "",
        "properties": "",
        "custom": false,
        "product_title": "sample-product",
        "product_handle": "sample-product",
        "product_url": "/products/sample-product",
        "variant_title": "01",
        "product_type": "default",
        "price": "1.00",
        "compare_at_price": "1.00",
        "origin_price": "1.00",
        "available": true,
        "available_quantity": 999999999,
        "weight": "0.00",
        "weight_unit": "kg",
        "sku": "",
        "spu": "",
        "requires_shipping": true,
        "taxable": false,
        "image": {
          "src": "//img.staticdj.com/free/e6e8dc980211cbef103e16371d6e0e61.jpeg",
          "path": "free/e6e8dc980211cbef103e16371d6e0e61.jpeg",
          "width": 3000,
          "height": 1500,
          "alt": ""
        },
        "options": [
          {
            "name": "Size",
            "value": "01"
          }
        ],
        "wholesale_price": [
          {
            "min_quantity": 1,
            "price": "1.00"
          }
        ],
        "product_tags": [],
        "published": true,
        "published_at": "2026-08-10T07:28:24Z",
        "inventory_quantity": 0,
        "inventory_policy": "",
        "inventory_tracking": false,
        "cost_price": "1.00",
        "vendor": "",
        "vendor_url": "",
        "barcode": "",
        "mixed_wholesale": false,
        "tax_code": "",
        "retail_price": "0.00",
        "add_quantity": "1",
        "disabled": false
      }
    ]
  }
}

Add one or more variants to the cart

POST /{locale}/api/cart/batch

Use the POST /{locale}/api/cart/batch endpoint to add one or multiple variants to the cart.

Example request

If an item is already in the cart, then quantity is added to the current quantity for that item.

Example request
const data = {
  line_items: [
    {
      product_id: "b1ab6324-ae4f-4cca-907e-18af16839447",
      variant_id: "4a3d825c-2fac-4f72-a68b-b8604b0935c4",
      quantity: 1,
      properties: {
        Engraving: "Happy Birthday"
      }
    },
    {
      quantity: 2,
      product_id: "588ed0ce-40af-44c7-8dea-afa18b489ef8",
      variant_id: "83196e5a-b25f-42c3-8df5-359d83ea7ae8"
    }
  ]
}

fetch(window.SHOPLAZZA.routes.root + '/api/cart/batch', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
})
  .then((response) => response.json())
  .then((data) => {
    // do something...
  })
  .catch((error) => {
    console.error('Error: ', error);
  });

Request parameters

Schema
Example

line_items object[]

List of line items.

Array [

product_idstring

ID of the product to add.

variant_idstring

ID of the variant to add.

quantitynumber

Quantity to add.

propertiesobject

Custom properties to attach to the line item.

]

json
{
  "line_items": [
    {
      "product_id": "b1ab6324-ae4f-4cca-907e-18af16839447",
      "variant_id": "4a3d825c-2fac-4f72-a68b-b8604b0935c4",
      "quantity": 1,
      "properties": {
        "Engraving": "Happy Birthday"
      }
    },
    {
      "quantity": 2,
      "product_id": "588ed0ce-40af-44c7-8dea-afa18b489ef8",
      "variant_id": "83196e5a-b25f-42c3-8df5-359d83ea7ae8"
    }
  ]
}

Response

Schema
Example

items object[]

List of line items in the cart.

Array [

idstring

ID of the line item.

item_idstring

product_idstring

ID of the product.

variant_idstring

ID of the variant.

quantitynumber

Quantity of the item.

notestring

Note attached to the line item.

propertiesstring

Custom properties captured on the line item.

customboolean

Whether the line item is a custom item.

product_titlestring

Title of the product.

product_handlestring

Handle of the product.

product_urlstring

Relative URL of the product page.

variant_titlestring

Title of the variant, for example Blue, Size M.

product_typestring

Product type.

pricestring

Price of a single unit of the line item.

compare_at_pricestring

Compare-at price of the item.

origin_pricestring

availableboolean

Whether the item can be purchased.

available_quantitynumber

Quantity still available for purchase.

weightstring

Weight of the variant.

weight_unitstring

Unit of the weight, for example kg.

skustring

SKU of the variant, used for inventory tracking.

spustring

SPU of the product.

requires_shippingboolean

Whether shipping is required.

taxableboolean

Whether tax is charged.

image object

Image of the line item's variant.

srcstring

URL of the image.

pathstring

Path of the image file on the image server.

widthnumber

Width of the image, in pixels.

heightnumber

Height of the image, in pixels.

altstring

Alt text of the image.

options object[]

Option values of the line item's variant.

Array [

namestring

Name of the product option, for example Color.

valuestring

Value selected for this product option.

]

wholesale_price object[]

Wholesale price tiers.

Array [

min_quantitynumber

Minimum quantity required for this wholesale tier.

pricestring

Unit price of this wholesale tier.

]

product_tagsundefined[]

Tags of the product.

publishedboolean

Whether the resource is published.

published_atstring

Publication time, in ISO-8601 format.

inventory_quantitynumber

Inventory quantity.

inventory_policystring

Whether the product keeps selling when it is out of stock.

inventory_trackingboolean

Whether inventory tracking is enabled.

cost_pricestring

Cost price of the variant.

vendorstring

Vendor of the product.

vendor_urlstring

URL of the product vendor.

barcodestring

Barcode of the variant.

mixed_wholesaleboolean

Whether mixed wholesale is supported.

tax_codestring

retail_pricestring

Retail price in the store's main currency unit.

add_quantitystring

disabledboolean

]

json
{
  "items": [
    {
      "id": "684765446766863303_d41d8cd98f00b204e9800998ecf8427e",
      "item_id": "684765446766863303",
      "product_id": "14a309ec-b966-4cf9-a9bb-33baa821fdbc",
      "variant_id": "fff360dd-6457-466a-98b3-16878bacef5b",
      "quantity": 2,
      "note": "",
      "properties": "",
      "custom": false,
      "product_title": "sample-product",
      "product_handle": "sample-product",
      "product_url": "/products/sample-product",
      "variant_title": "01",
      "product_type": "default",
      "price": "1.00",
      "compare_at_price": "1.00",
      "origin_price": "1.00",
      "available": true,
      "available_quantity": 999999999,
      "weight": "0.00",
      "weight_unit": "kg",
      "sku": "",
      "spu": "",
      "requires_shipping": true,
      "taxable": false,
      "image": {
        "src": "//img.staticdj.com/free/e6e8dc980211cbef103e16371d6e0e61.jpeg",
        "path": "free/e6e8dc980211cbef103e16371d6e0e61.jpeg",
        "width": 3000,
        "height": 1500,
        "alt": ""
      },
      "options": [
        {
          "name": "Size",
          "value": "01"
        }
      ],
      "wholesale_price": [
        {
          "min_quantity": 1,
          "price": "1.00"
        }
      ],
      "product_tags": [],
      "published": true,
      "published_at": "2026-08-10T07:28:24Z",
      "inventory_quantity": 0,
      "inventory_policy": "",
      "inventory_tracking": false,
      "cost_price": "1.00",
      "vendor": "",
      "vendor_url": "",
      "barcode": "",
      "mixed_wholesale": false,
      "tax_code": "",
      "retail_price": "0.00",
      "add_quantity": "1",
      "disabled": false
    }
  ]
}

Set the quantity of several line items

POST /{locale}/api/cart/update

Use the POST /{locale}/api/cart/update endpoint to set the quantity of one or more line items that are already in the cart. Unlike POST /{locale}/api/cart, the quantity you send replaces the current quantity instead of being added to it.

Example request

Example request
const data = {
  line_items: [
    {
      product_id: "b1ab6324-ae4f-4cca-907e-18af16839447",
      variant_id: "4a3d825c-2fac-4f72-a68b-b8604b0935c4",
      quantity: 1
    }
  ]
};

fetch(window.SHOPLAZZA.routes.root + '/api/cart/update', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
})
  .then((response) => response.json())
  .then((data) => {
    // do something...
  });

Request parameters

Schema
Example

line_items object[]

The line items to update.

Array [

product_idstring

The product id of the variant.

variant_idstring

The variant id.

quantitynumber

The new quantity of the line item.

]

json
{
  "line_items": [
    {
      "product_id": "b1ab6324-ae4f-4cca-907e-18af16839447",
      "variant_id": "4a3d825c-2fac-4f72-a68b-b8604b0935c4",
      "quantity": 1
    }
  ]
}

Response

Schema
Example

cart object
line_items object[]
List of line items.
Array [
idstring
ID of the line item.
item_idstring
product_idstring
ID of the product.
variant_idstring
ID of the variant.
quantitystring
Quantity of the item.
notestring
Note attached to the line item.
propertiesstring
Custom properties captured on the line item.
customboolean
Whether the line item is a custom item.
product_titlestring
Title of the product.
product_handlestring
Handle of the product.
product_urlstring
Relative URL of the product page.
variant_titlestring
Title of the variant, for example Blue, Size M.
product_typestring
Product type.
pricestring
Price of a single unit of the line item.
compare_at_pricestring
Compare-at price of the item.
origin_pricestring
line_pricestring
Combined price of all units in this line item, before discounts.
original_line_pricenumber
Original price of the line item before discounts.
saved_pricenumber
Amount saved on this line item.
final_line_pricestring
Combined price of all units in this line item, after line-level discounts.
final_pricestring
Price of a single unit of this line item, after line-level discounts.
discount_applicationsundefined[]
Discounts applied to this object.
fixed_discount_totalstring
discount_totalstring
Total discount applied.
discount_idstring
ID of the discount applied.
availableboolean
Whether the item can be purchased.
available_quantitynumber
Quantity still available for purchase.
can_buyboolean
Whether the variant of the line item can be sold.
weightstring
Weight of the variant.
weight_unitstring
Unit of the weight, for example kg.
skustring
SKU of the variant, used for inventory tracking.
spustring
SPU of the product.
requires_shippingboolean
Whether shipping is required.
taxableboolean
Whether tax is charged.
image object
Image of the line item's variant.
srcstring
URL of the image.
pathstring
Path of the image file on the image server.
widthnumber
Width of the image, in pixels.
heightnumber
Height of the image, in pixels.
altstring
Alt text of the image.
options object[]
Option values of the line item's variant.
Array [
namestring
Name of the product option, for example Color.
valuestring
Value selected for this product option.
]
wholesale_price object[]
Wholesale price tiers.
Array [
min_quantitynumber
Minimum quantity required for this wholesale tier.
pricestring
Unit price of this wholesale tier.
]
parts_pricestring
product_tagsundefined[]
Tags of the product.
publishedboolean
Whether the resource is published.
published_atstring
Publication time, in ISO-8601 format.
inventory_quantitynumber
Inventory quantity.
inventory_policystring
Whether the product keeps selling when it is out of stock.
inventory_trackingboolean
Whether inventory tracking is enabled.
cost_pricestring
Cost price of the variant.
vendorstring
Vendor of the product.
vendor_urlstring
URL of the product vendor.
barcodestring
Barcode of the variant.
mixed_wholesaleboolean
Whether mixed wholesale is supported.
tax_codestring
retail_pricestring
Retail price in the store's main currency unit.
item_textstring
disabledboolean
is_free_giftboolean
Whether the item is a free gift.
custom_discountsundefined[]
]
ineffectivesundefined[]
Line items in the cart that can no longer be purchased.
discount_applicationsundefined[]
Discounts applied to this object.
attributesundefined[]
total_discountstring
Total amount saved by all discounts on the cart.
discount_line_item_pricestring
Discounted total for the applied discounts.
currencystring
Currency of the cart, for example USD.
original_line_pricestring
Original price of the line item before discounts.
original_total_pricestring
Total price of the cart before any discounts.
line_pricestring
Combined price of all units in this line item, before discounts.
total_pricestring
Total price of the cart after discounts.
notestring
Note attached to the object.
created_atstring
Creation time, in ISO-8601 format.
updated_atstring
Last update time, in ISO-8601 format.
item_countnumber
Number of items in the cart.
total_weightnumber
Total weight of all items in the cart.
invalid_msgstring
identity_cart_idstring
Identifier of the cart. Use it to link a cart to the order it becomes.
user_idstring

json
{
  "cart": {
    "line_items": [
      {
        "id": "684765446766863303_d41d8cd98f00b204e9800998ecf8427e",
        "item_id": "684765446766863303",
        "product_id": "14a309ec-b966-4cf9-a9bb-33baa821fdbc",
        "variant_id": "fff360dd-6457-466a-98b3-16878bacef5b",
        "quantity": "1",
        "note": "",
        "properties": "",
        "custom": false,
        "product_title": "sample-product",
        "product_handle": "sample-product",
        "product_url": "/products/sample-product",
        "variant_title": "01",
        "product_type": "default",
        "price": "1.00",
        "compare_at_price": "1.00",
        "origin_price": "1.00",
        "line_price": "1.00",
        "original_line_price": 1,
        "saved_price": 0,
        "final_line_price": "1.00",
        "final_price": "1.00",
        "discount_applications": [],
        "fixed_discount_total": "0.00",
        "discount_total": "0.00",
        "discount_id": "",
        "available": true,
        "available_quantity": 999999999,
        "can_buy": true,
        "weight": "0.00",
        "weight_unit": "kg",
        "sku": "",
        "spu": "",
        "requires_shipping": true,
        "taxable": false,
        "image": {
          "src": "//img.staticdj.com/free/e6e8dc980211cbef103e16371d6e0e61.jpeg",
          "path": "free/e6e8dc980211cbef103e16371d6e0e61.jpeg",
          "width": 3000,
          "height": 1500,
          "alt": ""
        },
        "options": [
          {
            "name": "Size",
            "value": "01"
          }
        ],
        "wholesale_price": [
          {
            "min_quantity": 1,
            "price": "1.00"
          }
        ],
        "parts_price": "0.00",
        "product_tags": [],
        "published": true,
        "published_at": "2026-08-10T07:28:24Z",
        "inventory_quantity": 0,
        "inventory_policy": "",
        "inventory_tracking": false,
        "cost_price": "1.00",
        "vendor": "",
        "vendor_url": "",
        "barcode": "",
        "mixed_wholesale": false,
        "tax_code": "",
        "retail_price": "0.00",
        "item_text": "",
        "disabled": false,
        "is_free_gift": false,
        "custom_discounts": []
      },
      {
        "id": "684698318307074183_d41d8cd98f00b204e9800998ecf8427e",
        "item_id": "684698318307074183",
        "product_id": "b3b656ae-504f-4f01-a054-879a610925e3",
        "variant_id": "0699bc80-19ae-41bb-87c4-dbcbe5ed90a0",
        "quantity": "2",
        "note": "",
        "properties": "",
        "custom": false,
        "product_title": "Sample product",
        "product_handle": "Sample product",
        "product_url": "/products/Sample product",
        "variant_title": "Black-S",
        "product_type": "default",
        "price": "10.00",
        "compare_at_price": "20.00",
        "origin_price": "10.00",
        "line_price": "20.00",
        "original_line_price": 40,
        "saved_price": 10,
        "final_line_price": "20.00",
        "final_price": "10.00",
        "discount_applications": [],
        "fixed_discount_total": "0.00",
        "discount_total": "0.00",
        "discount_id": "",
        "available": true,
        "available_quantity": 48,
        "can_buy": true,
        "weight": "0.00",
        "weight_unit": "kg",
        "sku": "1111-BLACK-S-A001001",
        "spu": "1111",
        "requires_shipping": true,
        "taxable": false,
        "image": {
          "src": "//img.staticdj.com/50fa9b8c054f4d11b0d765de5f35dd4e.png",
          "path": "50fa9b8c054f4d11b0d765de5f35dd4e.png",
          "width": 1254,
          "height": 1254,
          "alt": ""
        },
        "options": [
          {
            "name": "Color",
            "value": "Black"
          },
          {
            "name": "Size",
            "value": "S"
          }
        ],
        "wholesale_price": [
          {
            "min_quantity": 1,
            "price": "10.00"
          }
        ],
        "parts_price": "0.00",
        "product_tags": [],
        "published": true,
        "published_at": "2026-07-30T02:28:23Z",
        "inventory_quantity": 48,
        "inventory_policy": "deny",
        "inventory_tracking": true,
        "cost_price": "10.00",
        "vendor": "",
        "vendor_url": "",
        "barcode": "",
        "mixed_wholesale": false,
        "tax_code": "",
        "retail_price": "0.00",
        "item_text": "",
        "disabled": false,
        "is_free_gift": false,
        "custom_discounts": []
      }
    ],
    "ineffectives": [],
    "discount_applications": [],
    "attributes": [],
    "total_discount": "0.00",
    "discount_line_item_price": "0.00",
    "currency": "USD",
    "original_line_price": "41.00",
    "original_total_price": "41.00",
    "line_price": "21.00",
    "total_price": "21.00",
    "note": "",
    "created_at": "2026-06-23T19:57:16Z",
    "updated_at": "2026-09-02T14:13:29Z",
    "item_count": 3,
    "total_weight": 0,
    "invalid_msg": "",
    "identity_cart_id": "879f8b8f-c3a0-483c-baf6-f5a55a7ff5b4",
    "user_id": ""
  }
}

Set the quantity of one line item

PATCH /{locale}/api/cart/{variant_id}

Use the PATCH /{locale}/api/cart/{variant_id} endpoint to update the cart's line item quantities.

Example request

If an item is already in the cart, then quantity is equal to the new quantity quantity for that item.

Example request
const data = {
  id: "298422_d41d8cd98f00b204e9800998ecf8427e",
  product_id: "588ed0ce-40af-44c7-8dea-afa18b489ef8",
  variant_id: "83196e5a-b25f-42c3-8df5-359d83ea7ae8",
  quantity: 3,
  properties: {
    Engraving: "Happy Anniversary"
  }
};

fetch(window.SHOPLAZZA.routes.root + '/api/cart/83196e5a-b25f-42c3-8df5-359d83ea7ae8', {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
})
  .then((response) => response.json())
  .then((data) => {
    // do something...
  })
  .catch((error) => {
    console.error('Error: ', error);
  });

Request parameters

Schema
Example

variant_idstring

ID of the variant. Send it in the path and in the request body.

idstring

ID of the line item to update, taken from the id of a line item in the cart.

product_idstring

ID of the product.

quantitynumber

Quantity of the item.

propertiesobject

Custom properties of the line item. What you send replaces the properties the line item already has.

json
{
  "id": "298422_d41d8cd98f00b204e9800998ecf8427e",
  "product_id": "588ed0ce-40af-44c7-8dea-afa18b489ef8",
  "variant_id": "83196e5a-b25f-42c3-8df5-359d83ea7ae8",
  "quantity": 3,
  "properties": {
    "Engraving": "Happy Anniversary"
  }
}

Response

Schema
Example

cart object
line_items object[]
List of line items.
Array [
idstring
ID of the line item.
item_idstring
product_idstring
ID of the product.
variant_idstring
ID of the variant.
quantitystring
Quantity of the item.
notestring
Note attached to the line item.
propertiesstring
Custom properties captured on the line item.
customboolean
Whether the line item is a custom item.
product_titlestring
Title of the product.
product_handlestring
Handle of the product.
product_urlstring
Relative URL of the product page.
variant_titlestring
Title of the variant, for example Blue, Size M.
product_typestring
Product type.
pricestring
Price of a single unit of the line item.
compare_at_pricestring
Compare-at price of the item.
origin_pricestring
line_pricestring
Combined price of all units in this line item, before discounts.
original_line_pricenumber
Original price of the line item before discounts.
saved_pricenumber
Amount saved on this line item.
final_line_pricestring
Combined price of all units in this line item, after line-level discounts.
final_pricestring
Price of a single unit of this line item, after line-level discounts.
discount_applicationsundefined[]
Discounts applied to this object.
fixed_discount_totalstring
discount_totalstring
Total discount applied.
discount_idstring
ID of the discount applied.
availableboolean
Whether the item can be purchased.
available_quantitynumber
Quantity still available for purchase.
can_buyboolean
Whether the variant of the line item can be sold.
weightstring
Weight of the variant.
weight_unitstring
Unit of the weight, for example kg.
skustring
SKU of the variant, used for inventory tracking.
spustring
SPU of the product.
requires_shippingboolean
Whether shipping is required.
taxableboolean
Whether tax is charged.
image object
Image of the line item's variant.
srcstring
URL of the image.
pathstring
Path of the image file on the image server.
widthnumber
Width of the image, in pixels.
heightnumber
Height of the image, in pixels.
altstring
Alt text of the image.
options object[]
Option values of the line item's variant.
Array [
namestring
Name of the product option, for example Color.
valuestring
Value selected for this product option.
]
wholesale_price object[]
Wholesale price tiers.
Array [
min_quantitynumber
Minimum quantity required for this wholesale tier.
pricestring
Unit price of this wholesale tier.
]
parts_pricestring
product_tagsundefined[]
Tags of the product.
publishedboolean
Whether the resource is published.
published_atstring
Publication time, in ISO-8601 format.
inventory_quantitynumber
Inventory quantity.
inventory_policystring
Whether the product keeps selling when it is out of stock.
inventory_trackingboolean
Whether inventory tracking is enabled.
cost_pricestring
Cost price of the variant.
vendorstring
Vendor of the product.
vendor_urlstring
URL of the product vendor.
barcodestring
Barcode of the variant.
mixed_wholesaleboolean
Whether mixed wholesale is supported.
tax_codestring
retail_pricestring
Retail price in the store's main currency unit.
item_textstring
disabledboolean
is_free_giftboolean
Whether the item is a free gift.
custom_discountsundefined[]
]
ineffectivesundefined[]
Line items in the cart that can no longer be purchased.
discount_applicationsundefined[]
Discounts applied to this object.
attributesundefined[]
total_discountstring
Total amount saved by all discounts on the cart.
discount_line_item_pricestring
Discounted total for the applied discounts.
currencystring
Currency of the cart, for example USD.
original_line_pricestring
Original price of the line item before discounts.
original_total_pricestring
Total price of the cart before any discounts.
line_pricestring
Combined price of all units in this line item, before discounts.
total_pricestring
Total price of the cart after discounts.
notestring
Note attached to the object.
created_atstring
Creation time, in ISO-8601 format.
updated_atstring
Last update time, in ISO-8601 format.
item_countnumber
Number of items in the cart.
total_weightnumber
Total weight of all items in the cart.
invalid_msgstring
identity_cart_idstring
Identifier of the cart. Use it to link a cart to the order it becomes.
user_idstring

json
{
  "cart": {
    "line_items": [
      {
        "id": "684765446766863303_d41d8cd98f00b204e9800998ecf8427e",
        "item_id": "684765446766863303",
        "product_id": "14a309ec-b966-4cf9-a9bb-33baa821fdbc",
        "variant_id": "fff360dd-6457-466a-98b3-16878bacef5b",
        "quantity": "2",
        "note": "",
        "properties": "",
        "custom": false,
        "product_title": "sample-product",
        "product_handle": "sample-product",
        "product_url": "/products/sample-product",
        "variant_title": "01",
        "product_type": "default",
        "price": "1.00",
        "compare_at_price": "1.00",
        "origin_price": "1.00",
        "line_price": "2.00",
        "original_line_price": 2,
        "saved_price": 0,
        "final_line_price": "2.00",
        "final_price": "1.00",
        "discount_applications": [],
        "fixed_discount_total": "0.00",
        "discount_total": "0.00",
        "discount_id": "",
        "available": true,
        "available_quantity": 999999999,
        "can_buy": true,
        "weight": "0.00",
        "weight_unit": "kg",
        "sku": "",
        "spu": "",
        "requires_shipping": true,
        "taxable": false,
        "image": {
          "src": "//img.staticdj.com/free/e6e8dc980211cbef103e16371d6e0e61.jpeg",
          "path": "free/e6e8dc980211cbef103e16371d6e0e61.jpeg",
          "width": 3000,
          "height": 1500,
          "alt": ""
        },
        "options": [
          {
            "name": "Size",
            "value": "01"
          }
        ],
        "wholesale_price": [
          {
            "min_quantity": 1,
            "price": "1.00"
          }
        ],
        "parts_price": "0.00",
        "product_tags": [],
        "published": true,
        "published_at": "2026-08-10T07:28:24Z",
        "inventory_quantity": 0,
        "inventory_policy": "",
        "inventory_tracking": false,
        "cost_price": "1.00",
        "vendor": "",
        "vendor_url": "",
        "barcode": "",
        "mixed_wholesale": false,
        "tax_code": "",
        "retail_price": "0.00",
        "item_text": "",
        "disabled": false,
        "is_free_gift": false,
        "custom_discounts": []
      },
      {
        "id": "684698318307074183_d41d8cd98f00b204e9800998ecf8427e",
        "item_id": "684698318307074183",
        "product_id": "b3b656ae-504f-4f01-a054-879a610925e3",
        "variant_id": "0699bc80-19ae-41bb-87c4-dbcbe5ed90a0",
        "quantity": "2",
        "note": "",
        "properties": "",
        "custom": false,
        "product_title": "Sample product",
        "product_handle": "Sample product",
        "product_url": "/products/Sample product",
        "variant_title": "Black-S",
        "product_type": "default",
        "price": "10.00",
        "compare_at_price": "20.00",
        "origin_price": "10.00",
        "line_price": "20.00",
        "original_line_price": 40,
        "saved_price": 10,
        "final_line_price": "20.00",
        "final_price": "10.00",
        "discount_applications": [],
        "fixed_discount_total": "0.00",
        "discount_total": "0.00",
        "discount_id": "",
        "available": true,
        "available_quantity": 48,
        "can_buy": true,
        "weight": "0.00",
        "weight_unit": "kg",
        "sku": "1111-BLACK-S-A001001",
        "spu": "1111",
        "requires_shipping": true,
        "taxable": false,
        "image": {
          "src": "//img.staticdj.com/50fa9b8c054f4d11b0d765de5f35dd4e.png",
          "path": "50fa9b8c054f4d11b0d765de5f35dd4e.png",
          "width": 1254,
          "height": 1254,
          "alt": ""
        },
        "options": [
          {
            "name": "Color",
            "value": "Black"
          },
          {
            "name": "Size",
            "value": "S"
          }
        ],
        "wholesale_price": [
          {
            "min_quantity": 1,
            "price": "10.00"
          }
        ],
        "parts_price": "0.00",
        "product_tags": [],
        "published": true,
        "published_at": "2026-07-30T02:28:23Z",
        "inventory_quantity": 48,
        "inventory_policy": "deny",
        "inventory_tracking": true,
        "cost_price": "10.00",
        "vendor": "",
        "vendor_url": "",
        "barcode": "",
        "mixed_wholesale": false,
        "tax_code": "",
        "retail_price": "0.00",
        "item_text": "",
        "disabled": false,
        "is_free_gift": false,
        "custom_discounts": []
      }
    ],
    "ineffectives": [],
    "discount_applications": [],
    "attributes": [],
    "total_discount": "0.00",
    "discount_line_item_price": "0.00",
    "currency": "USD",
    "original_line_price": "42.00",
    "original_total_price": "42.00",
    "line_price": "22.00",
    "total_price": "22.00",
    "note": "",
    "created_at": "2026-06-23T19:57:16Z",
    "updated_at": "2026-09-02T14:13:27Z",
    "item_count": 4,
    "total_weight": 0,
    "invalid_msg": "",
    "identity_cart_id": "879f8b8f-c3a0-483c-baf6-f5a55a7ff5b4",
    "user_id": ""
  }
}

Remove a line item from the cart

DELETE /{locale}/api/cart/{variant_id}

Use the DELETE /{locale}/api/cart/{variant_id} endpoint to remove a line item.

Example request

Example request
const data = {
  id: "298422_d41d8cd98f00b204e9800998ecf8427e",
  product_id: "588ed0ce-40af-44c7-8dea-afa18b489ef8",
  variant_id: "83196e5a-b25f-42c3-8df5-359d83ea7ae8",
};

fetch(window.SHOPLAZZA.routes.root + '/api/cart/83196e5a-b25f-42c3-8df5-359d83ea7ae8', {
  method: 'DELETE',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
})
  .then((response) => response.json())
  .then((data) => {
    // do something...
  })
  .catch((error) => {
    console.error('Error: ', error);
  });

Request parameters

Schema
Example

variant_idstring

ID of the variant. Send it in the path and in the request body.

idstring

ID of the line item to remove, taken from the id of a line item in the cart.

product_idstring

ID of the product.

json
{
  "id": "298422_d41d8cd98f00b204e9800998ecf8427e",
  "product_id": "588ed0ce-40af-44c7-8dea-afa18b489ef8",
  "variant_id": "83196e5a-b25f-42c3-8df5-359d83ea7ae8"
}

Response

Schema
Example

cart object
line_itemsundefined[]
List of line items.
ineffectivesundefined[]
Line items in the cart that can no longer be purchased.
discount_applicationsundefined[]
Discounts applied to this object.
attributesundefined[]
total_discountstring
Total amount saved by all discounts on the cart.
discount_line_item_pricestring
Discounted total for the applied discounts.
currencystring
Currency of the cart, for example USD.
original_line_pricestring
Original price of the line item before discounts.
original_total_pricestring
Total price of the cart before any discounts.
line_pricestring
Combined price of all units in this line item, before discounts.
total_pricestring
Total price of the cart after discounts.
notestring
Note attached to the object.
created_atstring
Creation time, in ISO-8601 format.
updated_atstring
Last update time, in ISO-8601 format.
item_countnumber
Number of items in the cart.
total_weightnumber
Total weight of all items in the cart.
invalid_msgstring
identity_cart_idstring
Identifier of the cart. Use it to link a cart to the order it becomes.
user_idstring

json
{
  "cart": {
    "line_items": [],
    "ineffectives": [],
    "discount_applications": [],
    "attributes": [],
    "total_discount": "0.00",
    "discount_line_item_price": "0.00",
    "currency": "USD",
    "original_line_price": "0.00",
    "original_total_price": "0.00",
    "line_price": "0.00",
    "total_price": "0.00",
    "note": "",
    "created_at": "2026-09-03T01:03:36Z",
    "updated_at": "2026-09-03T02:41:51Z",
    "item_count": 0,
    "total_weight": 0,
    "invalid_msg": "",
    "identity_cart_id": "879f8b8f-c3a0-483c-baf6-f5a55a7ff5b4",
    "user_id": "9fe44049-abab-4fed-ab3d-1bf4ffee8ef5"
  }
}

Select which line items are checked out

POST /{locale}/api/cart/cart-select

Use the POST /{locale}/api/cart/cart-select endpoint to choose which line items of the cart are selected for checkout. Line items that are not in selected_cart_ids become unselected.

Example request

Example request
const data = {
  selected_cart_ids: ["684765446766863303_d41d8cd98f00b204e9800998ecf8427e"]
};

fetch(window.SHOPLAZZA.routes.root + '/api/cart/cart-select', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
})
  .then((response) => response.json())
  .then((data) => {
    // do something...
  });

Request parameters

Schema
Example

selected_cart_idsstring[]

The ids of the line items to select, as returned in id.

json
{
  "selected_cart_ids": [
    "684765446766863303_d41d8cd98f00b204e9800998ecf8427e"
  ]
}

Response

Schema
Example

cart object
line_items object[]
List of line items.
Array [
idstring
ID of the line item.
item_idstring
product_idstring
ID of the product.
variant_idstring
ID of the variant.
quantitystring
Quantity of the item.
notestring
Note attached to the line item.
propertiesstring
Custom properties captured on the line item.
customboolean
Whether the line item is a custom item.
product_titlestring
Title of the product.
product_handlestring
Handle of the product.
product_urlstring
Relative URL of the product page.
variant_titlestring
Title of the variant, for example Blue, Size M.
product_typestring
Product type.
pricestring
Price of a single unit of the line item.
compare_at_pricestring
Compare-at price of the item.
origin_pricestring
line_pricestring
Combined price of all units in this line item, before discounts.
original_line_pricenumber
Original price of the line item before discounts.
saved_pricenumber
Amount saved on this line item.
final_line_pricestring
Combined price of all units in this line item, after line-level discounts.
final_pricestring
Price of a single unit of this line item, after line-level discounts.
discount_applicationsundefined[]
Discounts applied to this object.
fixed_discount_totalstring
discount_totalstring
Total discount applied.
discount_idstring
ID of the discount applied.
availableboolean
Whether the item can be purchased.
available_quantitynumber
Quantity still available for purchase.
can_buyboolean
Whether the variant of the line item can be sold.
weightstring
Weight of the variant.
weight_unitstring
Unit of the weight, for example kg.
skustring
SKU of the variant, used for inventory tracking.
spustring
SPU of the product.
requires_shippingboolean
Whether shipping is required.
taxableboolean
Whether tax is charged.
image object
Image of the line item's variant.
srcstring
URL of the image.
pathstring
Path of the image file on the image server.
widthnumber
Width of the image, in pixels.
heightnumber
Height of the image, in pixels.
altstring
Alt text of the image.
options object[]
Option values of the line item's variant.
Array [
namestring
Name of the product option, for example Color.
valuestring
Value selected for this product option.
]
wholesale_price object[]
Wholesale price tiers.
Array [
min_quantitynumber
Minimum quantity required for this wholesale tier.
pricestring
Unit price of this wholesale tier.
]
parts_pricestring
product_tagsundefined[]
Tags of the product.
publishedboolean
Whether the resource is published.
published_atstring
Publication time, in ISO-8601 format.
inventory_quantitynumber
Inventory quantity.
inventory_policystring
Whether the product keeps selling when it is out of stock.
inventory_trackingboolean
Whether inventory tracking is enabled.
cost_pricestring
Cost price of the variant.
vendorstring
Vendor of the product.
vendor_urlstring
URL of the product vendor.
barcodestring
Barcode of the variant.
mixed_wholesaleboolean
Whether mixed wholesale is supported.
tax_codestring
retail_pricestring
Retail price in the store's main currency unit.
item_textstring
disabledboolean
is_free_giftboolean
Whether the item is a free gift.
custom_discountsundefined[]
]
ineffectivesundefined[]
Line items in the cart that can no longer be purchased.
discount_applicationsundefined[]
Discounts applied to this object.
attributesundefined[]
total_discountstring
Total amount saved by all discounts on the cart.
discount_line_item_pricestring
Discounted total for the applied discounts.
currencystring
Currency of the cart, for example USD.
original_line_pricestring
Original price of the line item before discounts.
original_total_pricestring
Total price of the cart before any discounts.
line_pricestring
Combined price of all units in this line item, before discounts.
total_pricestring
Total price of the cart after discounts.
notestring
Note attached to the object.
created_atstring
Creation time, in ISO-8601 format.
updated_atstring
Last update time, in ISO-8601 format.
item_countnumber
Number of items in the cart.
total_weightnumber
Total weight of all items in the cart.
invalid_msgstring
identity_cart_idstring
Identifier of the cart. Use it to link a cart to the order it becomes.
user_idstring

json
{
  "cart": {
    "line_items": [
      {
        "id": "684765446766863303_d41d8cd98f00b204e9800998ecf8427e",
        "item_id": "684765446766863303",
        "product_id": "14a309ec-b966-4cf9-a9bb-33baa821fdbc",
        "variant_id": "fff360dd-6457-466a-98b3-16878bacef5b",
        "quantity": "2",
        "note": "",
        "properties": "",
        "custom": false,
        "product_title": "sample-product",
        "product_handle": "sample-product",
        "product_url": "/products/sample-product",
        "variant_title": "01",
        "product_type": "default",
        "price": "1.00",
        "compare_at_price": "1.00",
        "origin_price": "1.00",
        "line_price": "2.00",
        "original_line_price": 2,
        "saved_price": 0,
        "final_line_price": "2.00",
        "final_price": "1.00",
        "discount_applications": [],
        "fixed_discount_total": "0.00",
        "discount_total": "0.00",
        "discount_id": "",
        "available": true,
        "available_quantity": 999999999,
        "can_buy": true,
        "weight": "0.00",
        "weight_unit": "kg",
        "sku": "",
        "spu": "",
        "requires_shipping": true,
        "taxable": false,
        "image": {
          "src": "//img.staticdj.com/free/e6e8dc980211cbef103e16371d6e0e61.jpeg",
          "path": "free/e6e8dc980211cbef103e16371d6e0e61.jpeg",
          "width": 3000,
          "height": 1500,
          "alt": ""
        },
        "options": [
          {
            "name": "Size",
            "value": "01"
          }
        ],
        "wholesale_price": [
          {
            "min_quantity": 1,
            "price": "1.00"
          }
        ],
        "parts_price": "0.00",
        "product_tags": [],
        "published": true,
        "published_at": "2026-08-10T07:28:24Z",
        "inventory_quantity": 0,
        "inventory_policy": "",
        "inventory_tracking": false,
        "cost_price": "1.00",
        "vendor": "",
        "vendor_url": "",
        "barcode": "",
        "mixed_wholesale": false,
        "tax_code": "",
        "retail_price": "0.00",
        "item_text": "",
        "disabled": false,
        "is_free_gift": false,
        "custom_discounts": []
      },
      {
        "id": "684698318307074183_d41d8cd98f00b204e9800998ecf8427e",
        "item_id": "684698318307074183",
        "product_id": "b3b656ae-504f-4f01-a054-879a610925e3",
        "variant_id": "0699bc80-19ae-41bb-87c4-dbcbe5ed90a0",
        "quantity": "2",
        "note": "",
        "properties": "",
        "custom": false,
        "product_title": "Sample product",
        "product_handle": "Sample product",
        "product_url": "/products/Sample product",
        "variant_title": "Black-S",
        "product_type": "default",
        "price": "10.00",
        "compare_at_price": "20.00",
        "origin_price": "10.00",
        "line_price": "20.00",
        "original_line_price": 40,
        "saved_price": 10,
        "final_line_price": "20.00",
        "final_price": "10.00",
        "discount_applications": [],
        "fixed_discount_total": "0.00",
        "discount_total": "0.00",
        "discount_id": "",
        "available": true,
        "available_quantity": 48,
        "can_buy": true,
        "weight": "0.00",
        "weight_unit": "kg",
        "sku": "1111-BLACK-S-A001001",
        "spu": "1111",
        "requires_shipping": true,
        "taxable": false,
        "image": {
          "src": "//img.staticdj.com/50fa9b8c054f4d11b0d765de5f35dd4e.png",
          "path": "50fa9b8c054f4d11b0d765de5f35dd4e.png",
          "width": 1254,
          "height": 1254,
          "alt": ""
        },
        "options": [
          {
            "name": "Color",
            "value": "Black"
          },
          {
            "name": "Size",
            "value": "S"
          }
        ],
        "wholesale_price": [
          {
            "min_quantity": 1,
            "price": "10.00"
          }
        ],
        "parts_price": "0.00",
        "product_tags": [],
        "published": true,
        "published_at": "2026-07-30T02:28:23Z",
        "inventory_quantity": 48,
        "inventory_policy": "deny",
        "inventory_tracking": true,
        "cost_price": "10.00",
        "vendor": "",
        "vendor_url": "",
        "barcode": "",
        "mixed_wholesale": false,
        "tax_code": "",
        "retail_price": "0.00",
        "item_text": "",
        "disabled": false,
        "is_free_gift": false,
        "custom_discounts": []
      }
    ],
    "ineffectives": [],
    "discount_applications": [],
    "attributes": [],
    "total_discount": "0.00",
    "discount_line_item_price": "0.00",
    "currency": "USD",
    "original_line_price": "0.00",
    "original_total_price": "0.00",
    "line_price": "0.00",
    "total_price": "0.00",
    "note": "",
    "created_at": "2026-06-23T19:57:16Z",
    "updated_at": "2026-09-02T14:13:27Z",
    "item_count": 0,
    "total_weight": 0,
    "invalid_msg": "",
    "identity_cart_id": "879f8b8f-c3a0-483c-baf6-f5a55a7ff5b4",
    "user_id": ""
  }
}

Save a note on the cart

POST /{locale}/api/cart/note

Use the POST /{locale}/api/cart/note endpoint to save a note on the cart. The body is application/x-www-form-urlencoded, not JSON.

Example request

Example request
const body = new URLSearchParams({ note: 'Leave the parcel at the door' });

fetch(window.SHOPLAZZA.routes.root + '/api/cart/note', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: body
})
  .then((response) => response.json())
  .then((data) => {
    // do something...
  });

Request parameters

notestring

The note to save on the cart.

Response

Schema
Example

statestring

Request result flag; success or 0 means the request succeeded.

messagestring

Result message returned with the response.

errorsundefined[]

List of errors returned when the request fails.

datastringnullable

The response payload.

json
{
  "state": "success",
  "message": "success",
  "errors": [],
  "data": null
}

Get the number of items in the cart

GET /{locale}/api/cart/count

Use the GET /{locale}/api/cart/count endpoint to get cart count.

Example request

Example request
fetch(window.SHOPLAZZA.routes.root + '/api/cart/count')
  .then((response) => response.json())
  .then((data) => {
    // do something...
  })
  .catch((error) => {
    console.error('Error: ', error);
  });

Response

Schema
Example

statestring

Request result flag; success or 0 means the request succeeded.

messagestring

Result message returned with the response.

errorsundefined[]

List of errors returned when the request fails.

data object

The response payload.

countnumber

Number of items in the cart.

json
{
  "state": "success",
  "message": "success",
  "errors": [],
  "data": {
    "count": 2
  }
}

Get the cart​

Example request​

Response​

Add a variant to the cart​

Example request​

Request parameters​

Response​

Add one or more variants to the cart​

Example request​

Request parameters​

Response​

Set the quantity of several line items​

Example request​

Request parameters​

Response​

Set the quantity of one line item​

Example request​

Request parameters​

Response​

Remove a line item from the cart​

Example request​

Request parameters​

Response​

Select which line items are checked out​

Example request​

Request parameters​

Response​

Save a note on the cart​

Example request​

Request parameters​

Response​

Get the number of items in the cart​

Example request​

Response​

Get the cart

Example request

Response

Add a variant to the cart

Example request

Request parameters

Response

Add one or more variants to the cart

Example request

Request parameters

Response

Set the quantity of several line items

Example request

Request parameters

Response

Set the quantity of one line item

Example request

Request parameters

Response

Remove a line item from the cart

Example request

Request parameters

Response

Select which line items are checked out

Example request

Request parameters

Response

Save a note on the cart

Example request

Request parameters

Response

Get the number of items in the cart

Example request

Response