Add a Product Variant to Cart

POST/catalog/stores/{store_id}/carts/products

This endpoint allows you to add a specific variant of a product to a shopping cart,
along with any custom fields such as uploaded files, images, text inputs, numbers,
multi-selections, or single selection options.
Custom fields can be used to capture additional product attributes or customer inputs,
like specific dates, text, or selections.

Request

Path Params

store_id

number

required

Example:

37213

Header Params

string

required

Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.

Default:

application/json

Authorization

string

required

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

enar

Example:

string

optional

The unique identifier of the product variant.

Example:

5d376bd6-70dc-4b6b-bcce-37083616fb4e

quantity

string

optional

The quantity of the product to add to the cart.

Example:

custom_fields

array [object {5}]

optional

An array of custom field objects to further specify product details or customer preferences. Each object includes:

id: Identifier for the custom field.
price_settings: Identifier for price adjustments based on the field, if applicable.
name: Display name of the custom field.
value: Value or input for the custom field.
type: Type of the custom field (e.g., DATE, TEXT, NUMBER, MULTI_SELECT, SINGLE_SELECT).

string

optional

The unique identifier for the custom field.

Example:

40f3a8b5-fec6-488f-8b10-f1552ee63daf

price_settings

string

optional

An identifier used to apply specific price settings based on the custom field selection.
Obtain this identifier from the product configuration or pricing settings.

Example:

price_variation_01

name

string

optional

The display name of the custom field.

Example:

Date of Production

value

string

optional

The value or input for the custom field.

Example:

2012-12-06

type

string

optional

The type of the custom field.

Example:

DATE

{
  "id": "5d376bd6-70dc-4b6b-bcce-37083616fb4e",
  "quantity": "1",
  "custom_fields": [
    {
      "id": "40f3a8b5-fec6-488f-8b10-f1552ee63daf",
      "price_settings": "price_variation_01",
      "name": "Date of Production",
      "value": "2012-12-06",
      "type": "DATE"
    }
  ]
}

Request samples

Responses

Product Variant Added to Cart(200)

Product Variant Added to Cart

HTTP Code: 200

Content Type : JSONapplication/json

success

boolean

optional

Indicates whether the product variant was successfully added to the cart.

message

string

optional

{
  "success": true,
  "message": "string"
}

Last modified: 3 months ago