Campaigns API

Campaigns are directly associated with the Early Access benefit. It represents what collections will utilize the early access benefit and between what timeframes.

A campaign is represented as an object with the following structure:

{
  collectionIds: Array[String],
  endDate: String,
  updatedAt: String,
  startDate: String,
  createdAt: String,
  id: String,
  name: String,
  merchantId: String
}

Endpoints & Methods

Get all campaigns

GET https://public.inveterateapi.com/campaigns

200: OK

{
  "success": true,
  "data": {
    "campaigns": [
      {
        "collectionIds": [
          "gid://shopify/Collection/1234567890"
        ],
        "endDate": "2022-05-24 20:26:03 +00:00",
        "updatedAt": "2022-05-13T20:26:13.267Z",
        "startDate": "2022-05-13 20:26:01 +00:00",
        "createdAt": "2022-05-13T20:26:13.267Z",
        "id": "c7fd8ce6-f54e-4b1d-9841-1593f4c9bc70",
        "name": "Inveterate Campaign",
        "merchantId": "inveterate"
      }
    ],
    "count": 1
  },
  "errors": []
}