Developer docs

← All schemas

CoreApiCampaign

snowbee.coreapi.CoreApiCampaign

object · non-null

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"
View raw schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "code": {
      "type": "string",
      "title": "String"
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.coreapi.CoreApiCampaignLine"
      },
      "title": "List<CoreApiCampaignLine>"
    },
    "name": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "version": {
      "type": "integer",
      "format": "int64",
      "title": "Long"
    },
    "campaign_type": {
      "type": "string",
      "title": "String"
    },
    "company_id": {
      "type": "string",
      "title": "String"
    },
    "created_at": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "currency_iso_code": {
      "type": "string",
      "title": "String"
    },
    "loyalty_program_id": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "modified_at": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "order_delivery_date": {
      "type": [
        "null",
        "string"
      ],
      "format": "date",
      "example": "2026-01-14",
      "title": "LocalDate"
    },
    "order_end": {
      "type": "string",
      "format": "date",
      "example": "2026-01-14",
      "title": "LocalDate"
    },
    "order_start": {
      "type": "string",
      "format": "date",
      "example": "2026-01-14",
      "title": "LocalDate"
    },
    "product_scopes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.coreapi.CoreApiCampaignProductScope"
      },
      "title": "List<CoreApiCampaignProductScope>"
    },
    "retail_chain_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "title": "String"
      },
      "title": "List<String>"
    },
    "time_zone": {
      "type": "string",
      "title": "String"
    },
    "valid_from": {
      "type": "string",
      "format": "date",
      "example": "2026-01-14",
      "title": "LocalDate"
    },
    "valid_from_at": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "valid_to": {
      "type": "string",
      "format": "date",
      "example": "2026-01-14",
      "title": "LocalDate"
    },
    "valid_to_at": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    }
  },
  "required": [
    "code",
    "id",
    "lines",
    "name",
    "status",
    "version",
    "campaign_type",
    "company_id",
    "created_at",
    "currency_iso_code",
    "modified_at",
    "order_end",
    "order_start",
    "product_scopes",
    "retail_chain_ids",
    "time_zone",
    "valid_from",
    "valid_from_at",
    "valid_to",
    "valid_to_at"
  ],
  "title": "CoreApiCampaign"
}