Get a Promotion History

GET 
https://useast.api.elasticpath.com/v2/promotions/:promotionID/history

Use this endpoint to retrieve a promotion history.

Request

Path Parameters

promotionID stringrequired

The ID of the promotion.

Header Parameters

Authorization Bearerrequired

The Bearer token required to get access to the API.

Responses

200

Response Headers

application/json

Schema

Schema

data undefined[]
links object

current string

Always the current page.

first string

Always the first page.

last string

If there is only one page, it returns null.

next string

If there is only one page, it returns null.

prev string

If the user is on the first page, it returns null.

meta object

page object

current integer

The current page.

limit integer

The maximum number of records per page for this response. You can set this value up to 100.

offset integer

The current offset by number of records, not pages. Offset is zero-based.

total integer

The total page count.

results object

total integer

The total number of results.

Example (from schema)

{
  "data": [
    null
  ],
  "links": {
    "current": "string",
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string"
  },
  "meta": {
    "page": {
      "current": 0,
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "results": {
      "total": 0
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 401,
    "title": "Unauthorized"
  }
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://useast.api.elasticpath.com/v2/promotions/:promotionID/history' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Parameters

promotionID — pathrequired

Authorization — headerrequired

ResponseClear

Click the Send API Request button above and see the response here!