← All schemas

SbPublicApiCartResponse

snowbee.ecom.cart.SbPublicApiCartResponse

object · non-null

customerIdstringnullableoptional

The customer the cart is bound to, once the shopper has logged in. Priced on their loyalty membership and used for the order at checkout.

idstringnon-nullrequired

Keep it in a cookie or request body, never in a URL.

linesarray of objectnon-nullrequired

Cart lines in the order they were added

Show item fields

idstringnon-nullrequired

pricingobjectnullableoptional

Current pricing of the line. Null when the line cannot be priced (no current sales price or VAT rate) or the store is not B2C.

Show child fields

basicGrossUnitPricestringnon-nullrequired

The sku's ordinary gross unit price before any campaign

• Format: BigDecimal
• Pattern: ^-?\d+(\.\d{1,2})?$

Example"299"

basicNetUnitPricestringnon-nullrequired

The sku's ordinary net unit price before any campaign, up to 4 decimals

• Format: BigDecimal
• Pattern: ^-?\d+(\.\d{1,4})?$

Example"239.2"

campaignobjectnullableoptional

Show child fields

appliesbooleannon-nullrequired

True when this campaign changed the line charge

Exampletrue

campaignTypestringnon-nullrequired

NORMAL sets the unit price; THREE_FOR_TWO discounts the basket

Allowed values"NORMAL""THREE_FOR_TWO"

Example"THREE_FOR_TWO"

codestringnon-nullrequired

Campaign code, the value to send as campaignCode when the order is created

Example"SUMMER24"

idstringnon-nullrequired

namestringnon-nullrequired

netUnitPricestringnullableoptional

The campaign's own net unit price, up to 4 decimals. For a 3 for 2 the blended net unit price after the offer, or null when the offer did not bite.

• Format: BigDecimal
• Pattern: ^-?\d+(\.\d{1,4})?$

Example"191.2"

grossLineAmountstringnon-nullrequired

Gross amount for the whole line quantity

• Format: BigDecimal
• Pattern: ^-?\d+(\.\d{1,2})?$

Example"598"

grossUnitPricestringnon-nullrequired

Gross unit price charged

• Format: BigDecimal
• Pattern: ^-?\d+(\.\d{1,2})?$

Example"299"

netLineAmountstringnon-nullrequired

Net amount for the whole line quantity

• Format: BigDecimal
• Pattern: ^-?\d+(\.\d{1,2})?$

Example"478.4"

netUnitPricestringnon-nullrequired

Net unit price charged, up to 4 decimals. Send this as netUnitPrice when the order is created.

• Format: BigDecimal
• Pattern: ^-?\d+(\.\d{1,4})?$

Example"239.2"

vatRatestringnon-nullrequired

VAT rate in percent

• Format: BigDecimal
• Pattern: ^-?\d+(\.\d{1,2})?$

Example"25"

quantityintegernon-nullrequired

• Format: int32

Example2

skuobjectnon-nullrequired

The sku and its product, for display

Show child fields

barcodestringnullableoptional

colorNameobjectnullableoptional

Color name by language code

Show child fields

valuedictionary of stringnon-nullrequired

Show dictionary values

Each dictionary key maps to stringnon-null.

idstringnon-nullrequired

mainImageUrlstringnullableoptional

Delivery URL of the product's main image

productIdstringnon-nullrequired

Product ID; fetch details with GET /products/{productId}

productNameobjectnon-nullrequired

Product name by language code

Show child fields

valuedictionary of stringnon-nullrequired

Show dictionary values

Each dictionary key maps to stringnon-null.

productNumberstringnon-nullrequired

Example"100234"

sizeNameobjectnullableoptional

Size name by language code

Show child fields

valuedictionary of stringnon-nullrequired

Show dictionary values

Each dictionary key maps to stringnon-null.

skuNumberstringnon-nullrequired

Example"100234-BLK-L"

skuIdstringnon-nullrequired

paymentRequiredbooleannon-nullrequired

Whether the store takes web payment: checkout then requires a completed payment session

pricingobjectnullableoptional

Totals over the priced lines. Null for stores that are not B2C.

Show child fields

completebooleannon-nullrequired

False when at least one line has no pricing; the totals then exclude it

Exampletrue

currencyIsoCodestringnon-nullrequired

ISO 4217 currency of every amount in the cart

Example"NOK"

grossAmountstringnon-nullrequired

Gross amount of the cart, what the shopper pays before freight

• Format: BigDecimal
• Pattern: ^-?\d+(\.\d{1,2})?$

Example"598"

netAmountstringnon-nullrequired

• Format: BigDecimal
• Pattern: ^-?\d+(\.\d{1,2})?$

Example"478.4"

vatAmountstringnon-nullrequired

• Format: BigDecimal
• Pattern: ^-?\d+(\.\d{1,2})?$

Example"119.6"

progressstringnon-nullrequired

Only ACTIVE carts can be changed.

Allowed values"ACTIVE""CONVERTED""EXPIRED"

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": [
        "null",
        "string"
      ],
      "description": "The customer the cart is bound to, once the shopper has logged in. Priced on their loyalty membership and used for the order at checkout.",
      "title": "String"
    },
    "id": {
      "type": "string",
      "description": "Keep it in a cookie or request body, never in a URL.",
      "title": "String"
    },
    "lines": {
      "type": "array",
      "description": "Cart lines in the order they were added",
      "items": {
        "$ref": "#/components/schemas/snowbee.ecom.cart.SbPublicApiCartLineResponse"
      },
      "title": "List<SbPublicApiCartLineResponse>"
    },
    "paymentRequired": {
      "type": "boolean",
      "description": "Whether the store takes web payment: checkout then requires a completed payment session",
      "title": "Boolean"
    },
    "pricing": {
      "description": "Totals over the priced lines. Null for stores that are not B2C.",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/snowbee.ecom.cart.SbPublicApiCartPricing"
        }
      ]
    },
    "progress": {
      "$ref": "#/components/schemas/snowbee.ecom.cart.SbPublicApiCartProgress",
      "description": "Only ACTIVE carts can be changed."
    }
  },
  "required": [
    "id",
    "lines",
    "paymentRequired",
    "progress"
  ],
  "title": "SbPublicApiCartResponse"
}