Skip to main content

promotion_effective_dates

Required Field

This field is required and must not be omitted

Description​

Defines the time period when the promotion is active.

Validation Rules​

  • Must be a string
  • Must contain two dates (start date, end date) separated by a forward slash `/
  • ISO-8601 date format with timezone offset (e.g. 2023-12-20T12:00:00+00:00)
  • Start date must start in future (start_date > now)
  • End date must be after start date (end_date > start_date)
  • Ongoing promotion cannot be updated.

Example Values​

Here are examples of how a valid promotion_effective_dates value should look like in XML.

Valid Value
<g:promotion_effective_dates>2023-12-20T00:00:00+00:00/2023-12-24T00:00:00+00:00</g:promotion_effective_dates>
Click to show more valid XML examples
<g:promotion_effective_dates>2023-12-20T00:00:00+00:00/2023-12-24T00:00:00+00:00</g:promotion_effective_dates>

Error Codes​

Below you will find possible error codes generated when validating this field alongside with an example in XML and CSV that would trigger the code. Please refer to the validation rules to understand the cause.

danger
validation_invalid_value
<g:promotion_effective_dates>2023-12-24T00:00:00+00:00/2023-12-20T00:00:00+00:00</g:promotion_effective_dates>
danger
validation_missing_value
<g:promotion_effective_dates>2023-12-24T00:00:00+00:00/</g:promotion_effective_dates>

Properties​

PropertyValueDescription
Data TypestringClosest data type in code
NestedFalseDefines if this field consists of one or more sub-fields
Case SensitiveTrueIf small or large letters matter for this field
RepeatableFalseIf you can supply multiple items of this field (it´s a list)
Repeatable limit0If a list, this specifices the max number of items

Changelog​

📅 2023-12-11

Added

Initial definition

References​