Skip to main content
GET
/
public
/
checkout
/
cart
/
{id}
cURL
curl -X GET \
 /public/checkout/cart/{id} \
 --header "Authorization: Bearer <token>"
{
  "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

​
id
string
required

Cart identifier

Response

Cart resource

​
price
object
​
id
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"

​
email
string | null
​
invoiceAddress
object
​
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.

Example:

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

​
items
object[]

The items of the cart.

​
completionDetails
string[] | null

Details shown to the customer when the cart is completed.

​
settings
object

The settings of the cart.