Table of Contents |
---|
pre-requisites
Overview
Request an order by its id. This is a rare endpoint where an authorizationId
is not used as input; however, the order must still pertain to an advertiser the requesting user is authorized to acessaccess.
Endpoint
Tip |
---|
GET https://api.adcellerant.com/order/{id} |
Example
...
Request
Code Block |
---|
GET https://api.adcellerant.com/order/12345 |
Example Response
Status: 200 OK
Expand | ||
---|---|---|
| ||
|
Header Specifications
Authorization
| ||
|
Header Specifications
header | value |
---|---|
Authorization | Basic <your encoded value> |
See: Authentication
Input Specifications
Field | Description |
---|---|
id (path variable) | the id of the order to retrieve |
Output Specifications
The order object is returned
...
Field
...
Description
...
id
...
the id of the order
...
externalId
...
A UID that pertains to an external provider.
...
status (deprecated)
...
The status of the order.
...
advertiserId
...
The id of the advertiser the order belongs to.
...
advertiserName
...
The name of the advertiser the order belongs to.
...
divisionName
...
The name of the division the order belongs to.
...
ownerEmail
...
The email of the order owner.
...
name
...
The name of the order.
...
updated
...
The time the order was last updated.
...
orderDetails
...
The details of the order.
Example Request:
- https://api.adcellerant.com/order/456
See: Order Response