SbPublicApiCartLineCampaign

snowbee.ecom.cart.SbPublicApiCartLineCampaign

appliesrequired

True when this campaign changed the line charge

Exampletrue
campaignTyperequired

NORMAL sets the unit price; THREE_FOR_TWO discounts the basket

Allowed values"NORMAL""THREE_FOR_TWO"
Example"THREE_FOR_TWO"
coderequired

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

Example"SUMMER24"
idrequired
namerequired
netUnitPriceoptional

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"
View raw schema
{
  "type": "object",
  "properties": {
    "applies": {
      "type": "boolean",
      "description": "True when this campaign changed the line charge",
      "example": "true",
      "title": "Boolean"
    },
    "campaignType": {
      "$ref": "#/components/schemas/snowbee.SbPublicApiCampaignType",
      "description": "NORMAL sets the unit price; THREE_FOR_TWO discounts the basket"
    },
    "code": {
      "type": "string",
      "description": "Campaign code, the value to send as campaignCode when the order is created",
      "example": "SUMMER24",
      "title": "String"
    },
    "id": {
      "type": "string",
      "title": "String"
    },
    "name": {
      "type": "string",
      "title": "String"
    },
    "netUnitPrice": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "description": "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.",
      "example": "191.2",
      "pattern": "^-?\\d+(\\.\\d{1,4})?$",
      "title": "BigDecimalAsString"
    }
  },
  "required": [
    "applies",
    "campaignType",
    "code",
    "id",
    "name"
  ],
  "title": "SbPublicApiCartLineCampaign"
}