Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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
titleGET https://api.adcellerant.com/authorization
Code Block
{

}

Header Specifications

  • Authorization

order/12345
Code Block
{
    "id": 12345,
    "externalId": "my external id",
    "status": "SOLD",
    "advertiserId": "12345",
    "advertiserName": "Mr. Advertiser",
    "divisionName": "Mrs. Division",
    "ownerEmail": "email@gmail.com",
    "name": "Advertiser Order 1",
    "updated": "2023-10-19T19:50:49.95Z",
    "orderDetails": [
        {
            "id": 12345,
            "status": "NEW",
            "name": "Email Stuff",
            "budget": 0.0,
            "productKey": null,
            "startDate": "2023-09-01",
            "endDate": "2023-09-30",
            "productId": 12345,
            "activeRateId": 12345,
            "rates": [
                {
                    "id": 12345,
                    "description": null,
                    "billingType": "CPM",
                    "retailAmount": 15.0,
                    "wholesaleAmount": 6.0,
                    "monthlyBudgetMinimum": 0.0,
                    "monthlyImpressionMinimum": 40000.0,
                    "flightMinimum": 0.0
                }
            ],
            "allocations": [
                {
                    "dateRange": {
                        "start": "2023-09-01",
                        "end": "2023-09-30"
                    },
                    "goalSubtype": "NONE",
                    "retailBudget": 600.0,
                    "goalAmounts": {
                        "adSpend": null,
                        "clicks": null,
                        "impressions": 40000.0,
                        "views": null
                    }
                }
            ]
        }
    ]
}

Header Specifications

header

value

Authorization

Basic <your encoded value>

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: