SbPublicApiProductOffer

snowbee.ecom.catalog.SbPublicApiProductOffer

A basket offer that covers the product, such as 3 for 2. It has no unit price of its own; the cart applies it once the basket qualifies.

campaignIdrequired
campaignTyperequired

Kind of offer; currently only THREE_FOR_TWO

Allowed values"NORMAL""THREE_FOR_TWO"
Example"THREE_FOR_TWO"
codeoptional
Example"TFT-SUMMER"
loyaltyProgramMembershipRequiredrequired

Whether only loyalty members get the offer

Examplefalse
namerequired
View raw schema
{
  "type": "object",
  "description": "A basket offer that covers the product, such as 3 for 2. It has no unit price of its own; the cart applies it once the basket qualifies.",
  "properties": {
    "campaignId": {
      "type": "string",
      "title": "String"
    },
    "campaignType": {
      "$ref": "#/components/schemas/snowbee.SbPublicApiCampaignType",
      "description": "Kind of offer; currently only THREE_FOR_TWO"
    },
    "code": {
      "type": [
        "null",
        "string"
      ],
      "example": "TFT-SUMMER",
      "title": "String"
    },
    "loyaltyProgramMembershipRequired": {
      "type": "boolean",
      "description": "Whether only loyalty members get the offer",
      "example": "false",
      "title": "Boolean"
    },
    "name": {
      "type": "string",
      "title": "String"
    }
  },
  "required": [
    "campaignId",
    "campaignType",
    "loyaltyProgramMembershipRequired",
    "name"
  ],
  "title": "SbPublicApiProductOffer"
}