← All schemas

CoreApiCampaign

snowbee.coreapi.CoreApiPage_snowbee.coreapi.CoreApiCampaign

object · non-null

itemsarray of objectnon-nullrequired

Show item fields

Exactly one of these shapes is allowed.

deleted objectnon-null

typestringnon-nullrequired

Allowed values"deleted"

idstringnon-nullrequired

changed_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

deleted_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

entity objectnon-null

typestringnon-nullrequired

Allowed values"entity"

dataobjectnon-nullrequired

Show child fields

idstringnon-nullrequired

codestringnon-nullrequired

linesarray of objectnon-nullrequired

Show item fields

idstringnon-nullrequired

basic_gross_unit_pricestringnullableoptional

• Format: BigDecimal

Example"100.0"

basic_net_unit_pricestringnullableoptional

• Format: BigDecimal

Example"100.0"

campaign_gross_unit_pricestringnullableoptional

• Format: BigDecimal

Example"100.0"

campaign_net_unit_pricestringnullableoptional

• Format: BigDecimal

Example"100.0"

product_idstringnon-nullrequired

requires_loyalty_membershipbooleannon-nullrequired

sku_idstringnon-nullrequired

sku_numberstringnon-nullrequired

namestringnon-nullrequired

statusstringnon-nullrequired

versionintegernon-nullrequired

• Format: int64

campaign_typestringnon-nullrequired

company_idstringnon-nullrequired

created_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

currency_iso_codestringnon-nullrequired

loyalty_program_idstringnullableoptional

modified_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

order_delivery_datestringnullableoptional

• Format: date

Example"2026-01-14"

order_endstringnon-nullrequired

• Format: date

Example"2026-01-14"

order_startstringnon-nullrequired

• Format: date

Example"2026-01-14"

product_scopesarray of objectnon-nullrequired

Show item fields

idstringnon-nullrequired

brand_idstringnullableoptional

main_product_group_idstringnullableoptional

product_category_idstringnullableoptional

sub_product_group_idstringnullableoptional

retail_chain_idsarray of stringnon-nullrequired

time_zonestringnon-nullrequired

valid_fromstringnon-nullrequired

• Format: date

Example"2026-01-14"

valid_from_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

valid_tostringnon-nullrequired

• Format: date

Example"2026-01-14"

valid_to_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

changed_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

View schema definition

next_cursorstringnullablerequired

sync_throughstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.coreapi.CoreApiItem_snowbee.coreapi.CoreApiCampaign"
      },
      "title": "List<CoreApiItem<CoreApiCampaign>>"
    },
    "next_cursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "sync_through": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    }
  },
  "required": [
    "items",
    "next_cursor",
    "sync_through"
  ],
  "title": "CoreApiPage<CoreApiCampaign>"
}