Changes the quantity of a cart item.

cURL

curl -X PUT \
 /public/checkout/cart/{id}/change-quantity \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "cartItemId": ""
}'

{
  "price": {
    "amountDue": 123,
    "currencyCode": {},
    "netAmount": 123,
    "taxes": [
      {
        "netAmount": 123,
        "taxAmount": 123,
        "rate": 123
      }
    ],
    "discountDetails": [
      "<string>"
    ]
  },
  "id": "c1b0d0c0-0b0b-4b0b-8b0b-0b0b0b0b0b0b",
  "status": "open",
  "customer": "c1b0d0c0-0b0b-4b0b-8b0b-0b0b0b0b0b0b",
  "email": "<string>",
  "invoiceAddress": {
    "id": "<string>",
    "vatId": "DE123456789",
    "type": "TYPE_DEFAULT",
    "default": "true",
    "status": "active",
    "city": "Berlin",
    "zip": "12345",
    "street": "Musterstraße",
    "houseNumber": "1a",
    "countryCode": "DE",
    "companyName": "ACME Inc.",
    "salutation": "Herr",
    "addition": "c/o John Doe",
    "costCentre": "123456789",
    "firstName": "John",
    "lastName": "Doe"
  },
  "customerPrefill": {},
  "paymentMethod": "c1b0d0c0-0b0b-4b0b-8b0b-0b0b0b0b0b0b",
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "quantity": {},
      "quantityDetails": {
        "aggregationType": "count",
        "unit": "<string>",
        "description": "<string>",
        "quantityEditable": true
      },
      "price": {
        "currencyCode": {},
        "taxRate": 123,
        "totalNetAmount": 10,
        "type": "recurring",
        "calculationType": "flat_fee",
        "payInAdvance": true,
        "price": {
          "amount": 123
        },
        "recurring": {
          "interval": "day",
          "intervalCount": 123,
          "trialPeriodDays": 123,
          "recurringAmount": 123
        },
        "freeUnits": {}
      },
      "type": "product",
      "periods": [
        {
          "contractPeriod": "<string>",
          "cancellationPeriod": "<string>"
        }
      ]
    }
  ],
  "completionDetails": [
    "<string>"
  ],
  "settings": {
    "allowCoupons": true,
    "forceCompany": true,
    "backButton": {
      "url": "https://example.com",
      "label": "Back to the shop"
    }
  }
}

PUT

public

checkout

cart

{id}

change-quantity

cURL

curl -X PUT \
 /public/checkout/cart/{id}/change-quantity \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "cartItemId": ""
}'

{
  "price": {
    "amountDue": 123,
    "currencyCode": {},
    "netAmount": 123,
    "taxes": [
      {
        "netAmount": 123,
        "taxAmount": 123,
        "rate": 123
      }
    ],
    "discountDetails": [
      "<string>"
    ]
  },
  "id": "c1b0d0c0-0b0b-4b0b-8b0b-0b0b0b0b0b0b",
  "status": "open",
  "customer": "c1b0d0c0-0b0b-4b0b-8b0b-0b0b0b0b0b0b",
  "email": "<string>",
  "invoiceAddress": {
    "id": "<string>",
    "vatId": "DE123456789",
    "type": "TYPE_DEFAULT",
    "default": "true",
    "status": "active",
    "city": "Berlin",
    "zip": "12345",
    "street": "Musterstraße",
    "houseNumber": "1a",
    "countryCode": "DE",
    "companyName": "ACME Inc.",
    "salutation": "Herr",
    "addition": "c/o John Doe",
    "costCentre": "123456789",
    "firstName": "John",
    "lastName": "Doe"
  },
  "customerPrefill": {},
  "paymentMethod": "c1b0d0c0-0b0b-4b0b-8b0b-0b0b0b0b0b0b",
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "quantity": {},
      "quantityDetails": {
        "aggregationType": "count",
        "unit": "<string>",
        "description": "<string>",
        "quantityEditable": true
      },
      "price": {
        "currencyCode": {},
        "taxRate": 123,
        "totalNetAmount": 10,
        "type": "recurring",
        "calculationType": "flat_fee",
        "payInAdvance": true,
        "price": {
          "amount": 123
        },
        "recurring": {
          "interval": "day",
          "intervalCount": 123,
          "trialPeriodDays": 123,
          "recurringAmount": 123
        },
        "freeUnits": {}
      },
      "type": "product",
      "periods": [
        {
          "contractPeriod": "<string>",
          "cancellationPeriod": "<string>"
        }
      ]
    }
  ],
  "completionDetails": [
    "<string>"
  ],
  "settings": {
    "allowCoupons": true,
    "forceCompany": true,
    "backButton": {
      "url": "https://example.com",
      "label": "Back to the shop"
    }
  }
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Path Parameters

string

required

Cart identifier

Body

The updated Cart resource

quantity

any

required

The new quantity of the cart item.

Example:

10

cartItemId

string

Response

Cart resource updated

price

object

Show child attributes

price.amountDue

number

price.currencyCode

object

price.netAmount

number

price.taxes

object[]

Show child attributes

price.taxes.netAmount

number

price.taxes.taxAmount

number

price.taxes.rate

integer

price.discountDetails

string[] | null

string

Example:

"c1b0d0c0-0b0b-4b0b-8b0b-0b0b0b0b0b0b"

status

any

The status of the cart.

Possible values:

open: The cart is open and can be edited.
confirming: The cart is confirming and cannot be edited.

Example:

"open"

customer

string | null

The customer who owns the cart.

Example:

"c1b0d0c0-0b0b-4b0b-8b0b-0b0b0b0b0b0b"

string | null

invoiceAddress

object

Show child attributes

invoiceAddress.id

string

invoiceAddress.vatId

string | null

VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.

Example:

"DE123456789"

invoiceAddress.type

enum<string>

Available options:

TYPE_DEFAULT,

TYPE_INVOICE

Example:

"TYPE_DEFAULT"

invoiceAddress.default

boolean

Example:

"true"

invoiceAddress.status

enum<string>

Available options:

active,

archived

Example:

"active"

invoiceAddress.city

string

Example:

"Berlin"

invoiceAddress.zip

string

Example:

"12345"

invoiceAddress.street

string

Example:

"Musterstraße"

invoiceAddress.houseNumber

string

Example:

"1a"

invoiceAddress.countryCode

string

Example:

"DE"

invoiceAddress.companyName

string | null

Company name, which will be used to bill to.

Example:

"ACME Inc."

invoiceAddress.salutation

enum<string>

Available options:

Firma,

Herr,

Frau

Example:

"Herr"

invoiceAddress.addition

string | null

Additional address information, which will be shown on generated documents like invoices, reminders, etc.

Example:

"c/o John Doe"

invoiceAddress.costCentre

string | null

Cost centre, which will be shown on generated documents like invoices, reminders, etc.

Example:

"123456789"

invoiceAddress.firstName

string | null

First name, which will be shown on generated documents like invoices, reminders, etc.

Example:

"John"

invoiceAddress.lastName

string | null

Last name, which will be shown on generated documents like invoices, reminders, etc.

Example:

"Doe"

customerPrefill

object

The customer prefill data which should be used to prefill the checkout form.

paymentMethod

object

The payment method which should be used for the cart.

Show child attributes

paymentMethod.id

string

paymentMethod.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

paymentMethod.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider,

paymentMethod.default

boolean

paymentMethod.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

paymentMethod.enabled

boolean

paymentMethod.name

string | null

paymentMethod.creationDate

string<date-time>

paymentMethod.expirationDate

string<date-time> | null

paymentMethod.card

object

The card data of the payment method, if the type is "card"

Show child attributes

paymentMethod.card.brand

string

The brand of the card

Example:

"Visa"

paymentMethod.card.last4

string

The last 4 digits of the card

Example:

"4242"

paymentMethod.card.expMonth

integer

The expiration month of the card

Example:

12

paymentMethod.card.expYear

integer

The expiration year of the card

Example:

2022

paymentMethod.card.cardHolder

string

The card holder name

Example:

"Max Mustermann"

paymentMethod.sepaDebit

object

The sepa mandate data of the payment method, if the type is "sepa_debit"

Show child attributes

paymentMethod.sepaDebit.iban

string

The iban of the sepa mandate

Example:

"DE8937*********3232"

paymentMethod.sepaDebit.bic

string

The bic of the sepa mandate

Example:

"COBADEFFXXX"

paymentMethod.sepaDebit.mandateReference

string

The mandate reference of the sepa mandate

Example:

"MNDT-2021-123456"

paymentMethod.sepaDebit.signingDate

string

The signing date of the sepa mandate

Example:

"2021-01-01T00:00:00+00:00"

paymentMethod.paypal

object

The paypal data of the payment method, if the type is "paypal"

Show child attributes

paymentMethod.paypal.email

string

The email of the paypal account

Example:

"[email protected]"

paymentMethod.paypal.billingAgreementId

string

The billing agreement id of the paypal account

Example:

"I-1J5gqz2eZvKYlo2C2X2X2X2X"

Example:

"c1b0d0c0-0b0b-4b0b-8b0b-0b0b0b0b0b0b"

items

object[]

The items of the cart.

Show child attributes

items.id

string

items.name

string

items.description

string | null

items.quantity

object

items.quantityDetails

object

Show child attributes

items.quantityDetails.aggregationType

enum<string>

Available options:

count,

count_unique,

max,

sum,

average,

last_value

items.quantityDetails.unit

string

items.quantityDetails.description

string | null

items.quantityDetails.quantityEditable

boolean

items.price

object

Show child attributes

items.price.currencyCode

object

items.price.taxRate

integer | null

If null, the customer has not yet provided a invoice address.

items.price.totalNetAmount

number

The total net amount for this cart item which is now due.

Example:

10

items.price.type

enum<string>

Available options:

recurring,

metered,

instant_metered

items.price.calculationType

enum<string>

Available options:

flat_fee,

per_unit,

tiered,

volume,

stair_step,

percentage

items.price.payInAdvance

boolean

items.price.price

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

items.price.price.amount

number

required

The amount of the flat fee per unit

items.price.recurring

object

Show child attributes

items.price.recurring.interval

enum<string>

Available options:

day,

week,

month,

year

items.price.recurring.intervalCount

integer

items.price.recurring.trialPeriodDays

integer | null

items.price.recurring.recurringAmount

number

items.price.freeUnits

object

items.type

enum<string>

Available options:

product

items.periods

object[]

Show child attributes

items.periods.contractPeriod

string

items.periods.cancellationPeriod

string

completionDetails

string[] | null

Details shown to the customer when the cart is completed.

settings

object

The settings of the cart.

Show child attributes

settings.allowCoupons

boolean

Whether coupons can be applied to the checkout link or not.

settings.forceCompany

boolean

Whether the company should be forced in the checkout form or not.

settings.backButton

string[] | null

The URL to redirect to when the back button is clicked.

Example:

{
  "url": "https://example.com",
  "label": "Back to the shop"
}

Retrieves a cart by its ID.Confirms a cart.

⌘I

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Changes the quantity of a cart item.

Authorizations

Path Parameters

Body

Response