Versions Compared

Version Old Version 4 New Version 5
Changes made by

Tyler Seale

Tyler Seale

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Tip

POST https://api.adcellerant.com/order/search

Example Request:

Expand
titleRequest Body
Code Block
{
    "page": {
        "pageNumber": 1,
        "pageSize": 25
    },
    "filter": {
        "authorizationId": "123ab456-7c89-1234-5678-812d3e4567a8",
        "state": "MANAGED",
        "externalId": "test id"
    },
    "sort": [
        {
            "field": "UPDATED_DATE",
            "direction": "ASC"
        }
    ]
}

Example Response:

  • Status: 200 OK

Expand
titlePOST https://api.adcellerant.com/order/searchResponse Body
Code Block
{
    "pageNumber": 1,
    "pageSize": 25,
    "totalPages": 5,
    "totalCount": 104,
    "results": [
        {
            "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

  • page

Field

Description

pageNumber

The page of orders to return. Value must be greater than 0. Defaults to 1.

pageSize

The number of orders to return per page. Value must be between 1 and 50. Defaults to 25.

...

Field

Description

field

The field to sort on. See: Sortable Order Field

direction

The direction to sort by. See: Sort Direction

Output Specifications

Example Request:

  • https://api.adcellerant.com/order/456