Developer docs

← All schemas

CoreApiCampaign

snowbee.coreapi.CoreApiItem_snowbee.coreapi.CoreApiCampaign

object · non-null

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 raw schema
{
  "discriminator": {
    "propertyName": "type",
    "mapping": {
      "deleted": "#/components/schemas/snowbee.coreapi.CoreApiItem.Deleted_snowbee.coreapi.CoreApiCampaign",
      "entity": "#/components/schemas/snowbee.coreapi.CoreApiItem.Entity_snowbee.coreapi.CoreApiCampaign"
    }
  },
  "oneOf": [
    {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiItem.Deleted_snowbee.coreapi.CoreApiCampaign"
    },
    {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiItem.Entity_snowbee.coreapi.CoreApiCampaign"
    }
  ],
  "title": "CoreApiItem<CoreApiCampaign>"
}