GET
/
api
/
v2
/
platform
/
promotions
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/promotions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "23",
      "type": "promotion",
      "attributes": {
        "description": null,
        "expires_at": null,
        "starts_at": null,
        "name": "Promo",
        "type": null,
        "usage_limit": null,
        "match_policy": "all",
        "code": null,
        "advertise": false,
        "path": null,
        "created_at": "2022-11-08T19:35:02.793Z",
        "updated_at": "2022-11-08T19:35:02.795Z",
        "public_metadata": {},
        "private_metadata": {}
      },
      "relationships": {
        "promotion_category": {
          "data": null
        },
        "promotion_rules": {
          "data": []
        },
        "promotion_actions": {
          "data": []
        },
        "stores": {
          "data": [
            {
              "id": "375",
              "type": "store"
            }
          ]
        }
      }
    },
    {
      "id": "24",
      "type": "promotion",
      "attributes": {
        "description": null,
        "expires_at": null,
        "starts_at": null,
        "name": "Promo",
        "type": null,
        "usage_limit": null,
        "match_policy": "all",
        "code": null,
        "advertise": false,
        "path": null,
        "created_at": "2022-11-08T19:35:02.805Z",
        "updated_at": "2022-11-08T19:35:02.807Z",
        "public_metadata": {},
        "private_metadata": {}
      },
      "relationships": {
        "promotion_category": {
          "data": {
            "id": "13",
            "type": "promotion_category"
          }
        },
        "promotion_rules": {
          "data": []
        },
        "promotion_actions": {
          "data": [
            {
              "id": "16",
              "type": "promotion_action"
            }
          ]
        },
        "stores": {
          "data": [
            {
              "id": "375",
              "type": "store"
            }
          ]
        }
      }
    },
    {
      "id": "25",
      "type": "promotion",
      "attributes": {
        "description": null,
        "expires_at": null,
        "starts_at": null,
        "name": "Promo",
        "type": null,
        "usage_limit": null,
        "match_policy": "all",
        "code": null,
        "advertise": false,
        "path": null,
        "created_at": "2022-11-08T19:35:02.822Z",
        "updated_at": "2022-11-08T19:35:02.824Z",
        "public_metadata": {},
        "private_metadata": {}
      },
      "relationships": {
        "promotion_category": {
          "data": {
            "id": "13",
            "type": "promotion_category"
          }
        },
        "promotion_rules": {
          "data": []
        },
        "promotion_actions": {
          "data": [
            {
              "id": "17",
              "type": "promotion_action"
            }
          ]
        },
        "stores": {
          "data": [
            {
              "id": "375",
              "type": "store"
            }
          ]
        }
      }
    },
    {
      "id": "26",
      "type": "promotion",
      "attributes": {
        "description": null,
        "expires_at": null,
        "starts_at": null,
        "name": "Promo",
        "type": null,
        "usage_limit": null,
        "match_policy": "all",
        "code": null,
        "advertise": false,
        "path": null,
        "created_at": "2022-11-08T19:35:02.837Z",
        "updated_at": "2022-11-08T19:35:02.839Z",
        "public_metadata": {},
        "private_metadata": {}
      },
      "relationships": {
        "promotion_category": {
          "data": {
            "id": "13",
            "type": "promotion_category"
          }
        },
        "promotion_rules": {
          "data": [
            {
              "id": "12",
              "type": "promotion_rule"
            }
          ]
        },
        "promotion_actions": {
          "data": [
            {
              "id": "18",
              "type": "promotion_action"
            }
          ]
        },
        "stores": {
          "data": [
            {
              "id": "375",
              "type": "store"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "count": 4,
    "total_count": 4,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/promotions?page=1&per_page=&include=&filter[code_eq]=&filter[name_cont]=",
    "next": "http://www.example.com/api/v2/platform/promotions?filter%5Bcode_eq%5D=&filter%5Bname_cont%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/promotions?filter%5Bcode_eq%5D=&filter%5Bname_cont%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/promotions?filter%5Bcode_eq%5D=&filter%5Bname_cont%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/promotions?filter%5Bcode_eq%5D=&filter%5Bname_cont%5D=&include=&page=1&per_page="
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
​
per_page
integer
​
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

​
filter[code_eq]
string
​
filter[name_cont]
string

Response

200
application/vnd.api+json
Records returned
​
data
object[]
required
​
meta
object
required
​
links
object
required

Was this page helpful?

Suggest editsRaise issue
Update a Promotion RuleCreate a Promotion