Get campaign by ID, chain, and store

GET

https://api.fiftytwo.com/masterdata/campaigns/v1/chain/:chainId/store/:storeId/:campaignId

GET

/masterdata/campaigns/v1/chain/:chainId/store/:storeId/:campaignId

curl https://api.fiftytwo.com/masterdata/campaigns/v1/chain/1/store/1/1

{
  "campaigns": [
    {
      "campaignId": 1123168,
      "campaignStart": "2017-06-28T22:00:00+00:00",
      "campaignStop": "2027-06-29T21:59:59+00:00",
      "campaignType": 1,
      "description": "Test campaign",
      "storeGroup": "PQRS",
      "campaignFamilies": [
        {
          "campaignFamilyId": 123,
          "description": "campaign family 123",
          "campaignFamilyDiscount": [
            {
              "quantity": 1,
              "amount": 16
            },
            {
              "quantity": 2,
              "amount": 8
            },
            {
              "quantity": 4,
              "amount": 4
            },
            {
              "quantity": 8,
              "amount": 2
            },
            {
              "quantity": 16,
              "amount": 1
            }
          ],
          "discountInSets": 1,
          "discountMaximum": 16
        },
        {
          "campaignFamilyId": 124,
          "description": "campaign family 124",
          "campaignFamilyDiscount": [
            {
              "quantity": 1,
              "amount": 16
            },
            {
              "quantity": 2,
              "amount": 8
            },
            {
              "quantity": 4,
              "amount": 4
            },
            {
              "quantity": 8,
              "amount": 2
            },
            {
              "quantity": 16,
              "amount": 1
            }
          ],
          "discountInSets": 1,
          "discountMaximum": 16
        }
      ],
      "campaignArticles": [
        {
          "campaignArticleId": 10083,
          "costPrice": 5,
          "price": 10,
          "articleFamilyId": 0,
          "discountCode": 1,
          "discountQuantity": 5,
          "discountAmount": 10,
          "discountPercentage": 0,
          "discountInSets": 1,
          "discountMaximum": 20,
          "clubId": 5
        },
        {
          "campaignArticleId": 100087,
          "costPrice": 20,
          "price": 30,
          "articleFamilyId": 0,
          "discountCode": 2,
          "discountQuantity": 1,
          "discountAmount": 5,
          "discountPercentage": 0,
          "discountInSets": 1,
          "discountMaximum": 20,
          "clubId": 5
        }
      ]
    }
  ]
}

Path parameters

campaignIdlongRequired

The ID of the campaign to retrieve

chainIdintegerRequired

The ID of the chain

storeIdintegerRequired

The ID of the store

Response

Success

campaignslist of objects

Errors

400

Bad Request Error