POST api/Promotions

Request Information

URI Parameters

None.

Body Parameters

ProductPromotions
NameDescriptionTypeAdditional information
StoreId

string

None.

OperationDate

date

None.

Barcodes

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "StoreId": "sample string 1",
  "OperationDate": "2025-12-11T11:59:41.045257-06:00",
  "Barcodes": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ProductPromotions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EnigmaSDK.Request">
  <Barcodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Barcodes>
  <OperationDate>2025-12-11T11:59:41.045257-06:00</OperationDate>
  <StoreId>sample string 1</StoreId>
</ProductPromotions>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ItemSignage
NameDescriptionTypeAdditional information
Barcode

string

None.

PromotionalSignages

Collection of PromotionalSignage

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Barcode": "sample string 1",
    "PromotionalSignages": [
      {
        "PromotionId": "sample string 1",
        "DisplayName": "sample string 2",
        "ImageUrl": "sample string 3",
        "EffectiveStartDate": "2025-12-11T11:59:41.045257-06:00",
        "EffectiveEndDate": "2025-12-11T11:59:41.045257-06:00",
        "DaysOfWeek": [
          1,
          2
        ],
        "Hours": [
          1,
          2
        ],
        "Rewards": [
          {
            "Type": "sample string 1",
            "Value": "sample string 2",
            "Value2": "sample string 3"
          },
          {
            "Type": "sample string 1",
            "Value": "sample string 2",
            "Value2": "sample string 3"
          }
        ],
        "Conditions": [
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ],
        "Exceptions": [
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ]
      },
      {
        "PromotionId": "sample string 1",
        "DisplayName": "sample string 2",
        "ImageUrl": "sample string 3",
        "EffectiveStartDate": "2025-12-11T11:59:41.045257-06:00",
        "EffectiveEndDate": "2025-12-11T11:59:41.045257-06:00",
        "DaysOfWeek": [
          1,
          2
        ],
        "Hours": [
          1,
          2
        ],
        "Rewards": [
          {
            "Type": "sample string 1",
            "Value": "sample string 2",
            "Value2": "sample string 3"
          },
          {
            "Type": "sample string 1",
            "Value": "sample string 2",
            "Value2": "sample string 3"
          }
        ],
        "Conditions": [
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ],
        "Exceptions": [
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ]
      }
    ]
  },
  {
    "Barcode": "sample string 1",
    "PromotionalSignages": [
      {
        "PromotionId": "sample string 1",
        "DisplayName": "sample string 2",
        "ImageUrl": "sample string 3",
        "EffectiveStartDate": "2025-12-11T11:59:41.045257-06:00",
        "EffectiveEndDate": "2025-12-11T11:59:41.045257-06:00",
        "DaysOfWeek": [
          1,
          2
        ],
        "Hours": [
          1,
          2
        ],
        "Rewards": [
          {
            "Type": "sample string 1",
            "Value": "sample string 2",
            "Value2": "sample string 3"
          },
          {
            "Type": "sample string 1",
            "Value": "sample string 2",
            "Value2": "sample string 3"
          }
        ],
        "Conditions": [
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ],
        "Exceptions": [
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ]
      },
      {
        "PromotionId": "sample string 1",
        "DisplayName": "sample string 2",
        "ImageUrl": "sample string 3",
        "EffectiveStartDate": "2025-12-11T11:59:41.045257-06:00",
        "EffectiveEndDate": "2025-12-11T11:59:41.045257-06:00",
        "DaysOfWeek": [
          1,
          2
        ],
        "Hours": [
          1,
          2
        ],
        "Rewards": [
          {
            "Type": "sample string 1",
            "Value": "sample string 2",
            "Value2": "sample string 3"
          },
          {
            "Type": "sample string 1",
            "Value": "sample string 2",
            "Value2": "sample string 3"
          }
        ],
        "Conditions": [
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ],
        "Exceptions": [
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "Type": "sample string 1",
            "Values": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfItemSignage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EnigmaSDK.Response">
  <ItemSignage>
    <Barcode>sample string 1</Barcode>
    <PromotionalSignages>
      <PromotionalSignage>
        <Conditions>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
        </Conditions>
        <DaysOfWeek xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </DaysOfWeek>
        <DisplayName>sample string 2</DisplayName>
        <EffectiveEndDate>2025-12-11T11:59:41.045257-06:00</EffectiveEndDate>
        <EffectiveStartDate>2025-12-11T11:59:41.045257-06:00</EffectiveStartDate>
        <Exceptions>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
        </Exceptions>
        <Hours xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </Hours>
        <ImageUrl>sample string 3</ImageUrl>
        <PromotionId>sample string 1</PromotionId>
        <Rewards>
          <PromotionReward>
            <Type>sample string 1</Type>
            <Value>sample string 2</Value>
            <Value2>sample string 3</Value2>
          </PromotionReward>
          <PromotionReward>
            <Type>sample string 1</Type>
            <Value>sample string 2</Value>
            <Value2>sample string 3</Value2>
          </PromotionReward>
        </Rewards>
      </PromotionalSignage>
      <PromotionalSignage>
        <Conditions>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
        </Conditions>
        <DaysOfWeek xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </DaysOfWeek>
        <DisplayName>sample string 2</DisplayName>
        <EffectiveEndDate>2025-12-11T11:59:41.045257-06:00</EffectiveEndDate>
        <EffectiveStartDate>2025-12-11T11:59:41.045257-06:00</EffectiveStartDate>
        <Exceptions>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
        </Exceptions>
        <Hours xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </Hours>
        <ImageUrl>sample string 3</ImageUrl>
        <PromotionId>sample string 1</PromotionId>
        <Rewards>
          <PromotionReward>
            <Type>sample string 1</Type>
            <Value>sample string 2</Value>
            <Value2>sample string 3</Value2>
          </PromotionReward>
          <PromotionReward>
            <Type>sample string 1</Type>
            <Value>sample string 2</Value>
            <Value2>sample string 3</Value2>
          </PromotionReward>
        </Rewards>
      </PromotionalSignage>
    </PromotionalSignages>
  </ItemSignage>
  <ItemSignage>
    <Barcode>sample string 1</Barcode>
    <PromotionalSignages>
      <PromotionalSignage>
        <Conditions>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
        </Conditions>
        <DaysOfWeek xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </DaysOfWeek>
        <DisplayName>sample string 2</DisplayName>
        <EffectiveEndDate>2025-12-11T11:59:41.045257-06:00</EffectiveEndDate>
        <EffectiveStartDate>2025-12-11T11:59:41.045257-06:00</EffectiveStartDate>
        <Exceptions>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
        </Exceptions>
        <Hours xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </Hours>
        <ImageUrl>sample string 3</ImageUrl>
        <PromotionId>sample string 1</PromotionId>
        <Rewards>
          <PromotionReward>
            <Type>sample string 1</Type>
            <Value>sample string 2</Value>
            <Value2>sample string 3</Value2>
          </PromotionReward>
          <PromotionReward>
            <Type>sample string 1</Type>
            <Value>sample string 2</Value>
            <Value2>sample string 3</Value2>
          </PromotionReward>
        </Rewards>
      </PromotionalSignage>
      <PromotionalSignage>
        <Conditions>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
        </Conditions>
        <DaysOfWeek xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </DaysOfWeek>
        <DisplayName>sample string 2</DisplayName>
        <EffectiveEndDate>2025-12-11T11:59:41.045257-06:00</EffectiveEndDate>
        <EffectiveStartDate>2025-12-11T11:59:41.045257-06:00</EffectiveStartDate>
        <Exceptions>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
          <PromotionCondition>
            <Type>sample string 1</Type>
            <Values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Values>
          </PromotionCondition>
        </Exceptions>
        <Hours xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </Hours>
        <ImageUrl>sample string 3</ImageUrl>
        <PromotionId>sample string 1</PromotionId>
        <Rewards>
          <PromotionReward>
            <Type>sample string 1</Type>
            <Value>sample string 2</Value>
            <Value2>sample string 3</Value2>
          </PromotionReward>
          <PromotionReward>
            <Type>sample string 1</Type>
            <Value>sample string 2</Value>
            <Value2>sample string 3</Value2>
          </PromotionReward>
        </Rewards>
      </PromotionalSignage>
    </PromotionalSignages>
  </ItemSignage>
</ArrayOfItemSignage>