List promotion codes

Request

List generated codes for a promotion. Only applicable when GeneratedCodeCount > 0.

Security

OAuth2(Required scopes: FullAccessPromotionAdminPromotionReader)

Path

promotionIDstringrequired

ID of the promotion.

Query

pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1

pageSizeinteger

Number of results to return per page.

Default:20

curl -i -X GET \
  'https://api.ordercloud.io/v1/promotions/{promotionID}/codes?page=1&pageSize=20' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List generated codes for a promotion. Only applicable when GeneratedCodeCount > 0.

Bodyapplication/json

ItemsArray of objects(PromotionCode)

Example:

[
  {
    "Code": "",
    "Redeemed": false
  }
]

Metaobject(Meta)

Response

{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}