Cart items

Manage Cart items

Adding multiple products to cart

post

Adds multiple products to the specified cart and creates cart items.

---

Required scopes

• cart.cart_manage

  Note: This scope is only required for OAuth2 authorization method to authorize the request with the access_token.

Authorizations

OAuth2CustomerAccessToken

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

• : Needed to manage carts.

Path parameters

cartIdstringRequired

Cart unique identifier generated when a cart is created.

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Bodyobject[]

application/json

idstringOptional

Cart item's unique identifier.

keepAsSeparateLineItembooleanOptional

Indicates that products are maintained as individual entries in the cart, rather than being consolidated. When identical products are added multiple times, each addition creates a new line item instead of increasing the quantity of an existing one.

itemYrnstring · min: 1Optional

A unique identifier of a global resource, which stores information about the resource, such as its type, ID or name of the tenant. This field should not be provided when itemType is EXTERNAL and request contains external product.

itemTypeall ofOptional

string · enumOptionalPossible values:

and

objectOptional

Optional field which allows fetching external prices if set to EXTERNAL.

taxCodestringOptional

Tax code. Tax indicated in this field overrides the site's default tax value.

quantitynumber · doubleRequired

Quantity of the product added to cart.

weightDependentbooleanOptionalDeprecated

Deprecated, use product weightDependent attribute that is stored in the database. If set to true, the storefront displays a hint that the total price of the product may vary depending on the product’s actual weight.

Responses

200

The request was successful. Items have been added to the cart.

application/json

400

The request was syntactically incorrect. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

500

Some server-side error occurred. Details will be provided in the response payload.

application/json

post

/cart/{tenant}/carts/{cartId}/itemsBatch

HTTPcURLJavaScriptPython

POST /cart/{tenant}/carts/{cartId}/itemsBatch HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1225

[
  {
    "product": {
      "id": "5f5a3ce35bac380024b93cff",
      "yrn": "{productYrn}",
      "name": "Cherry Tomatoes",
      "description": "Guaranteed to be the sweetest tomato you have ever tasted! This super sweet bite sized tomato is juicy and bursting with flavor. They are great for snacking and in salads. Kids love them too!",
      "images": [
        {
          "id": "dbf2f8a4-1ff6-40a9-982f-1485ddb602e0",
          "url": "https://res.cloudinary.com/saas-ag/image/upload/v1599749351cart/{tenant}/products/dbf2f8a4-1ff6-40a9-982f-1485ddb602e0.jpg"
        }
      ]
    },
    "quantity": 100,
    "price": {
      "priceId": "5f5a3ce5fb29e20020be99c8",
      "yrn": "{priceYrn}",
      "originalAmount": 4.99,
      "effectiveAmount": 4.99,
      "currency": "EUR",
      "measurementUnit": {
        "quantity": 100,
        "unitCode": "GRM"
      }
    }
  },
  {
    "product": {
      "id": "5f5a3b435bac380024b93c88",
      "yrn": "{productYrn}",
      "name": "Black Tea",
      "description": "A pack of high-quality black tea to drink with your guests.",
      "images": [
        {
          "id": "4b4addad-9272-4435-83a0-4b5f1621208d",
          "url": "https://res.cloudinary.com/saas-ag/image/upload/v1599749351cart/{tenant}/products/4b4addad-9272-4435-83a0-4b5f1621208d.jpg"
        }
      ]
    },
    "quantity": 1,
    "price": {
      "priceId": "5f5a3b45fb29e20020be9976",
      "yrn": "{priceYrn}",
      "originalAmount": 2.29,
      "effectiveAmount": 2.29,
      "currency": "EUR",
      "measurementUnit": {
        "quantity": 1,
        "unitCode": "H87"
      }
    }
  }
]

[
  {
    "status": 201,
    "id": "1",
    "headers": {
      "location": "/carts/612cc4783cff1d66f699b6a1/items/1"
    },
    "yrn": "urn:yaas:saasag:caasproduct:product:saastest2;5c3351aea9812100098ffc60"
  },
  {
    "status": 201,
    "id": "2",
    "headers": {
      "location": "/carts/612cc4783cff1d66f699b6a1/items/2"
    },
    "yrn": "urn:yaas:saasag:caasproduct:product:saastest2;5c3351aea9812100098ffc61"
  }
]

Retrieving all products added to a cart

get

Retrieves all items added to the specified cart.

---

Required scopes

• cart.cart_manage

  Note: This scope is only required for OAuth2 authorization method to authorize the request with the access_token.

Authorizations

OAuth2CustomerAccessToken

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

• : Needed to manage carts.

Path parameters

cartIdstringRequired

Cart unique identifier generated when a cart is created.

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Responses

200

The request was successful. Cart items details are returned.

application/json

400

The request was syntactically incorrect. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

500

Some server-side error occurred. Details will be provided in the response payload.

application/json

get

/cart/{tenant}/carts/{cartId}/items

HTTPcURLJavaScriptPython

GET /cart/{tenant}/carts/{cartId}/items HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "0",
    "keepAsSeparateLineItem": true,
    "type": "INTERNAL",
    "product": {
      "id": "mobile-phone-s24-gross",
      "sku": "Mobile Phone s24 gross",
      "code": "Mobile Phone s24 gross",
      "name": "Mobile Phone s24 gross",
      "localizedName": {
        "en": "Mobile Phone s24 gross"
      },
      "images": [
        {
          "id": "67169928ceaab717e17f3734",
          "url": "http://res.cloudinary.com/saas-ag/image/upload/v1729534248/b2b2cstage/media/67169928ceaab717e17f3734"
        }
      ]
    },
    "itemYrn": "urn:yaas:saasag:caasproduct:product:b2b2cstage;mobile-phone-s24-gross",
    "quantity": 2,
    "effectiveQuantity": 2,
    "price": {
      "priceId": "679ca63dbcdefe5b380c98bc",
      "priceListId": "abc123",
      "originalAmount": 350,
      "effectiveAmount": 350,
      "currency": "EUR"
    },
    "unitPrice": {
      "netValue": 294.118,
      "grossValue": 350,
      "taxValue": 55.882,
      "taxCode": "STANDARD",
      "taxRate": 19
    },
    "itemPrice": {
      "amount": 700,
      "currency": "EUR"
    },
    "itemTaxInfo": [
      {
        "name": "STANDARD",
        "value": {
          "amount": 111.76
        },
        "rate": 19,
        "grossValue": 700,
        "netValue": 588.24
      }
    ],
    "linePrice": {
      "effectiveAmount": 595,
      "originalAmount": 795,
      "currency": "EUR"
    },
    "lineTax": {
      "name": "STANDARD",
      "rate": 19,
      "grossValue": 595,
      "netValue": 500,
      "quantity": 3
    },
    "fees": {
      "elements": [
        {
          "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;677d49ca3a421b451eab23f2",
          "taxCode": "REDUCED",
          "total": {
            "subTotal": 3.5,
            "totalTax": 0,
            "total": 3.08,
            "discount": 0.42
          },
          "name": {
            "de": "Apple Picking Fee",
            "en": "Apple Picking Fee"
          }
        }
      ],
      "total": {
        "subTotal": 3.5,
        "totalTax": 0,
        "total": 3.08,
        "discount": 0.42
      }
    },
    "authorizedAmount": {
      "amount": 700,
      "currency": "EUR"
    },
    "totalDiscount": {
      "amount": 84.32,
      "currency": "EUR"
    },
    "couponDiscounts": [
      {
        "couponId": "LS100EUROTOTAL",
        "value": 84.32
      }
    ],
    "externalDiscounts": [
      {
        "id": "buy-2-get-1-free",
        "discountType": "PERCENT",
        "value": 40,
        "sequence": 1
      }
    ],
    "calculatedPrice": {
      "price": {
        "netValue": 588.235,
        "grossValue": 700,
        "taxValue": 111.765,
        "taxCode": "STANDARD",
        "taxRate": 19
      },
      "discountedPrice": {
        "netValue": 282.511,
        "grossValue": 336.188,
        "taxValue": 53.677,
        "taxCode": "STANDARD",
        "taxRate": 19,
        "appliedDiscounts": [
          {
            "id": "buy-2-get-1-free",
            "value": 280,
            "price": {
              "netValue": 235.294,
              "grossValue": 280,
              "taxValue": 44.706,
              "taxCode": "STANDARD",
              "taxRate": 19
            },
            "discountType": "PERCENT",
            "origin": "EXTERNAL"
          },
          {
            "id": "LS100EUROTOTAL",
            "value": 83.812,
            "price": {
              "netValue": 70.43,
              "grossValue": 83.812,
              "taxValue": 13.382,
              "taxCode": "STANDARD",
              "taxRate": 19
            },
            "discountType": "ABSOLUTE",
            "origin": "INTERNAL"
          }
        ]
      },
      "fees": [
        {
          "id": "677d49ca3a421b451eab23f2",
          "type": "ABSOLUTE",
          "origin": "INTERNAL",
          "name": {
            "de": "Apple Picking Fee",
            "en": "Apple Picking Fee"
          },
          "price": {
            "netValue": 3.5,
            "grossValue": 3.745,
            "taxValue": 0.245,
            "taxCode": "REDUCED",
            "taxRate": 7
          },
          "discountedPrice": {
            "netValue": 3.081,
            "grossValue": 3.297,
            "taxValue": 0.216,
            "taxCode": "REDUCED",
            "taxRate": 7,
            "appliedDiscounts": [
              {
                "id": "LS100EUROTOTAL",
                "value": 0.448,
                "price": {
                  "netValue": 0.419,
                  "grossValue": 0.448,
                  "taxValue": 0.029,
                  "taxCode": "REDUCED",
                  "taxRate": 7
                },
                "discountType": "ABSOLUTE",
                "origin": "INTERNAL"
              }
            ]
          }
        }
      ],
      "totalFee": {
        "netValue": 3.081,
        "grossValue": 3.297,
        "taxValue": 0.216,
        "taxCode": "REDUCED",
        "taxRate": 7,
        "appliedDiscounts": [
          {
            "id": "LS100EUROTOTAL",
            "value": 0.448,
            "price": {
              "netValue": 0.419,
              "grossValue": 0.448,
              "taxValue": 0.029,
              "taxCode": "REDUCED",
              "taxRate": 7
            },
            "discountType": "ABSOLUTE",
            "origin": "INTERNAL"
          }
        ]
      },
      "totalDiscount": {
        "calculationType": "ApplyDiscountAfterTax",
        "value": 364.26,
        "price": {
          "netValue": 306.143,
          "grossValue": 364.26,
          "taxValue": 58.117
        },
        "appliedDiscounts": [
          {
            "id": "buy-2-get-1-free",
            "value": 280,
            "price": {
              "netValue": 235.294,
              "grossValue": 280,
              "taxValue": 44.706,
              "taxCode": "STANDARD",
              "taxRate": 19
            },
            "discountType": "PERCENT",
            "origin": "EXTERNAL"
          },
          {
            "id": "LS100EUROTOTAL",
            "value": 84.26,
            "price": {
              "netValue": 70.849,
              "grossValue": 84.26,
              "taxValue": 13.411
            },
            "discountType": "ABSOLUTE",
            "origin": "INTERNAL"
          }
        ]
      },
      "finalPrice": {
        "netValue": 285.592,
        "grossValue": 339.485,
        "taxValue": 53.893
      }
    }
  }
]

Adding a product to cart

post

Adds a product to the specified cart and creates a cart item.

---

Required scopes

• cart.cart_manage

  Note: This scope is only required for OAuth2 authorization method to authorize the request with the access_token.

• cart.cart_manage_external_prices

  Note: This scope is used to manage external prices, products, fees and discounts. It's required only when an external price, product, fee or discount is provided.

Authorizations

CustomerAccessTokenOAuth2

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cartIdstringRequired

Cart unique identifier generated when a cart is created.

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Query parameters

siteCodestringRequired

Site unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

Body

application/json

idstringOptional

Cart item's unique identifier.

keepAsSeparateLineItembooleanOptional

Indicates that products are maintained as individual entries in the cart, rather than being consolidated. When identical products are added multiple times, each addition creates a new line item instead of increasing the quantity of an existing one.

itemYrnstring · min: 1Optional

A unique identifier of a global resource, which stores information about the resource, such as its type, ID or name of the tenant. This field should not be provided when itemType is EXTERNAL and request contains external product.

itemTypeall ofOptional

string · enumOptionalPossible values:

and

objectOptional

Optional field which allows fetching external prices if set to EXTERNAL.

taxCodestringOptional

Tax code. Tax indicated in this field overrides the site's default tax value.

quantitynumber · doubleRequired

Quantity of the product added to cart.

weightDependentbooleanOptionalDeprecated

Deprecated, use product weightDependent attribute that is stored in the database. If set to true, the storefront displays a hint that the total price of the product may vary depending on the product’s actual weight.

Responses

201

The request was successful. The product has been added to the cart.

application/json

400

The request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired.

Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

409

The request could not be completed due to a conflict with the current state of the target resource.

application/json

500

Some server-side error occurred. Details will be provided in the response payload.

application/json

post

/cart/{tenant}/carts/{cartId}/items

HTTPcURLJavaScriptPython

POST /cart/{tenant}/carts/{cartId}/items?siteCode=text HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "itemYrn": "{productYrn}",
  "price": {
    "priceId": "{priceId}",
    "effectiveAmount": 0.3582,
    "originalAmount": 0.3582,
    "currency": "EUR"
  },
  "quantity": 6
}

Payload exampleExternal price exampleExternal line price and line tax exampleExternal product exampleExternal product with discount example

{
  "itemId": "5c3351aea9812100098ffc60",
  "yrn": "urn:yaas:saasag:caasproduct:product:saastest2;5c3351aea9812100098ffc60"
}

Deleting all products added to a cart

delete

Removes all products from the specified cart and deletes the cart items.

---

Required scopes

• cart.cart_manage

  Note: This scope is only required for OAuth2 authorization method to authorize the request with the access_token.

Authorizations

OAuth2CustomerAccessToken

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

• : Needed to manage carts.

Path parameters

cartIdstringRequired

Cart unique identifier generated when a cart is created.

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Responses

204

The request was successful. Products have been deleted from the cart.

400

The request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired.

Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

500

Some server-side error occurred. Details will be provided in the response payload.

application/json

delete

/cart/{tenant}/carts/{cartId}/items

HTTPcURLJavaScriptPython

DELETE /cart/{tenant}/carts/{cartId}/items HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Retrieving a cart item

get

Retrieves a specified cart item's details.

---

Required scopes

• cart.cart_manage

  Note: This scope is only required for OAuth2 authorization method to authorize the request with the access_token.

Authorizations

OAuth2CustomerAccessToken

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

• : Needed to manage carts.

Path parameters

itemIdstringRequired

Cart item's unique identifier generated when the product is added to the cart.

cartIdstringRequired

Cart unique identifier generated when a cart is created.

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Responses

200

The request was successful. Cart item details are returned.

application/json

400

The request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired.

Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

500

Some server-side error occurred. Details will be provided in the response payload.

application/json

get

/cart/{tenant}/carts/{cartId}/items/{itemId}

HTTPcURLJavaScriptPython

GET /cart/{tenant}/carts/{cartId}/items/{itemId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "0",
  "keepAsSeparateLineItem": true,
  "type": "INTERNAL",
  "product": {
    "id": "mobile-phone-s24-gross",
    "sku": "Mobile Phone s24 gross",
    "code": "Mobile Phone s24 gross",
    "name": "Mobile Phone s24 gross",
    "localizedName": {
      "en": "Mobile Phone s24 gross"
    },
    "images": [
      {
        "id": "67169928ceaab717e17f3734",
        "url": "http://res.cloudinary.com/saas-ag/image/upload/v1729534248/b2b2cstage/media/67169928ceaab717e17f3734"
      }
    ]
  },
  "itemYrn": "urn:yaas:saasag:caasproduct:product:b2b2cstage;mobile-phone-s24-gross",
  "quantity": 2,
  "effectiveQuantity": 2,
  "price": {
    "priceId": "679ca63dbcdefe5b380c98bc",
    "priceListId": "abc123",
    "originalAmount": 350,
    "effectiveAmount": 350,
    "currency": "EUR"
  },
  "unitPrice": {
    "netValue": 294.118,
    "grossValue": 350,
    "taxValue": 55.882,
    "taxCode": "STANDARD",
    "taxRate": 19
  },
  "itemPrice": {
    "amount": 700,
    "currency": "EUR"
  },
  "itemTaxInfo": [
    {
      "name": "STANDARD",
      "value": {
        "amount": 111.76
      },
      "rate": 19,
      "grossValue": 700,
      "netValue": 588.24
    }
  ],
  "linePrice": {
    "effectiveAmount": 595,
    "originalAmount": 795,
    "currency": "EUR"
  },
  "lineTax": {
    "name": "STANDARD",
    "rate": 19,
    "grossValue": 595,
    "netValue": 500,
    "quantity": 3
  },
  "fees": {
    "elements": [
      {
        "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;677d49ca3a421b451eab23f2",
        "taxCode": "REDUCED",
        "total": {
          "subTotal": 3.5,
          "totalTax": 0,
          "total": 3.08,
          "discount": 0.42
        },
        "name": {
          "de": "Apple Picking Fee",
          "en": "Apple Picking Fee"
        }
      }
    ],
    "total": {
      "subTotal": 3.5,
      "totalTax": 0,
      "total": 3.08,
      "discount": 0.42
    }
  },
  "authorizedAmount": {
    "amount": 700,
    "currency": "EUR"
  },
  "totalDiscount": {
    "amount": 84.32,
    "currency": "EUR"
  },
  "couponDiscounts": [
    {
      "couponId": "LS100EUROTOTAL",
      "value": 84.32
    }
  ],
  "externalDiscounts": [
    {
      "id": "buy-2-get-1-free",
      "discountType": "PERCENT",
      "value": 40,
      "sequence": 1
    }
  ],
  "calculatedPrice": {
    "price": {
      "netValue": 588.235,
      "grossValue": 700,
      "taxValue": 111.765,
      "taxCode": "STANDARD",
      "taxRate": 19
    },
    "discountedPrice": {
      "netValue": 282.511,
      "grossValue": 336.188,
      "taxValue": 53.677,
      "taxCode": "STANDARD",
      "taxRate": 19,
      "appliedDiscounts": [
        {
          "id": "buy-2-get-1-free",
          "value": 280,
          "price": {
            "netValue": 235.294,
            "grossValue": 280,
            "taxValue": 44.706,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          "discountType": "PERCENT",
          "origin": "EXTERNAL"
        },
        {
          "id": "LS100EUROTOTAL",
          "value": 83.812,
          "price": {
            "netValue": 70.43,
            "grossValue": 83.812,
            "taxValue": 13.382,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          "discountType": "ABSOLUTE",
          "origin": "INTERNAL"
        }
      ]
    },
    "fees": [
      {
        "id": "677d49ca3a421b451eab23f2",
        "type": "ABSOLUTE",
        "origin": "INTERNAL",
        "name": {
          "de": "Apple Picking Fee",
          "en": "Apple Picking Fee"
        },
        "price": {
          "netValue": 3.5,
          "grossValue": 3.745,
          "taxValue": 0.245,
          "taxCode": "REDUCED",
          "taxRate": 7
        },
        "discountedPrice": {
          "netValue": 3.081,
          "grossValue": 3.297,
          "taxValue": 0.216,
          "taxCode": "REDUCED",
          "taxRate": 7,
          "appliedDiscounts": [
            {
              "id": "LS100EUROTOTAL",
              "value": 0.448,
              "price": {
                "netValue": 0.419,
                "grossValue": 0.448,
                "taxValue": 0.029,
                "taxCode": "REDUCED",
                "taxRate": 7
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            }
          ]
        }
      }
    ],
    "totalFee": {
      "netValue": 3.081,
      "grossValue": 3.297,
      "taxValue": 0.216,
      "taxCode": "REDUCED",
      "taxRate": 7,
      "appliedDiscounts": [
        {
          "id": "LS100EUROTOTAL",
          "value": 0.448,
          "price": {
            "netValue": 0.419,
            "grossValue": 0.448,
            "taxValue": 0.029,
            "taxCode": "REDUCED",
            "taxRate": 7
          },
          "discountType": "ABSOLUTE",
          "origin": "INTERNAL"
        }
      ]
    },
    "totalDiscount": {
      "calculationType": "ApplyDiscountAfterTax",
      "value": 364.26,
      "price": {
        "netValue": 306.143,
        "grossValue": 364.26,
        "taxValue": 58.117
      },
      "appliedDiscounts": [
        {
          "id": "buy-2-get-1-free",
          "value": 280,
          "price": {
            "netValue": 235.294,
            "grossValue": 280,
            "taxValue": 44.706,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          "discountType": "PERCENT",
          "origin": "EXTERNAL"
        },
        {
          "id": "LS100EUROTOTAL",
          "value": 84.26,
          "price": {
            "netValue": 70.849,
            "grossValue": 84.26,
            "taxValue": 13.411
          },
          "discountType": "ABSOLUTE",
          "origin": "INTERNAL"
        }
      ]
    },
    "finalPrice": {
      "netValue": 285.592,
      "grossValue": 339.485,
      "taxValue": 53.893
    }
  }
}

Updating a cart item

put

Updates a specified cart item.

---

Required scopes

• cart.cart_manage

  Note: This scope is only required for OAuth2 authorization method to authorize the request with the access_token.

Authorizations

OAuth2CustomerAccessToken

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

• : Needed to manage carts.

Path parameters

itemIdstringRequired

Cart item's unique identifier generated when the product is added to the cart.

cartIdstringRequired

Cart unique identifier generated when a cart is created.

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Query parameters

partialbooleanOptional

Option	Description
true	A partial product update will be performed.
false	A full product replacement will be performed.

Default: false

Body

application/json

itemYrnstring · min: 1Optional

A unique identifier of a global resource, which stores information about the resource, such as its type, ID or name of the tenant.

itemTypeall ofOptional

string · enumOptionalPossible values:

and

objectOptional

Optional field which allows fetching external prices if set to EXTERNAL.

quantitynumber · doubleOptional

Quantity of the product added to cart.

taxCodestringOptional

Tax code. Tax indicated in this field overrides the site's default tax value.

Responses

204

The request was successful. The cart item has been updated.

400

The request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired.

Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

409

The request could not be completed due to a conflict with the current state of the target resource.

application/json

500

Some server-side error occurred. Details will be provided in the response payload.

application/json

put

/cart/{tenant}/carts/{cartId}/items/{itemId}

HTTPcURLJavaScriptPython

PUT /cart/{tenant}/carts/{cartId}/items/{itemId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "itemYrn": "{productYrn}",
  "quantity": 5,
  "price": {
    "priceId": "5f59fe70fb29e20020be8f12",
    "originalAmount": 9.49,
    "effectiveAmount": 9.49,
    "currency": "EUR",
    "measurementUnit": {
      "quantity": 1,
      "unitCode": "H87"
    }
  }
}

Payload exampleUpdate item with new external line price

No content

Removing an item from cart

delete

Removes a specified product from cart and deletes the cart item.

---

Required scopes

• cart.cart_manage

  Note: This scope is only required for OAuth2 authorization method to authorize the request with the access_token.

Authorizations

OAuth2CustomerAccessToken

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

• : Needed to manage carts.

Path parameters

itemIdstringRequired

Cart item's unique identifier generated when the product is added to the cart.

cartIdstringRequired

Cart unique identifier generated when a cart is created.

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Responses

204

The request was successful. The item has been removed from cart.

400

The request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired.

Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

500

Some server-side error occurred. Details will be provided in the response payload.

application/json

delete

/cart/{tenant}/carts/{cartId}/items/{itemId}

HTTPcURLJavaScriptPython

DELETE /cart/{tenant}/carts/{cartId}/items/{itemId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content