Developer docs

← All schemas

SbPublicApiCartLineResponse

snowbee.ecom.cart.SbPublicApiCartLineResponse

object · non-null

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
View raw schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "pricing": {
      "description": "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.",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/snowbee.ecom.cart.SbPublicApiCartLinePricing"
        }
      ]
    },
    "quantity": {
      "type": "integer",
      "format": "int32",
      "example": "2",
      "title": "Int"
    },
    "sku": {
      "$ref": "#/components/schemas/snowbee.ecom.cart.SbPublicApiCartLineSkuResponse",
      "description": "The sku and its product, for display"
    },
    "skuId": {
      "type": "string",
      "title": "String"
    }
  },
  "required": [
    "id",
    "quantity",
    "sku",
    "skuId"
  ],
  "title": "SbPublicApiCartLineResponse"
}