Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 2

This Endpoint is Deprecated. Please use the /search endpoint instead.

Endpoint

GET https://api.adcellerant.com/orders

Example Request:

Example Response:

  • Status: 200 OK

 GET https://api.adcellerant.com/orders
{
   "pageNumber": 1,
   "pageSize": 25,
   "totalPages": 1,
   "totalCount": 2,
   "results": [
       {
           "id": 2,
           "status": "SOLD",
           "advertiserId": "123",
           "ownerEmail": "someEmail@domain.com",
           "name": "Sample Order - 1",
           "orderDetails": [
               {
                   "id": 14,
                   "status": "SOLD",
                   "name": "Sample Order - 1, Detail - 2",
                   "budget": 1234.0,
                   "approvedBy": "someApprover@domain.com",
                   "startDate": "2020-05-01T04:30:45.123Z",
                   "endDate": "2020-05-30T04:30:45.123Z"
               },
               {
                   "id": 13,
                   "status": "SOLD",
                   "name": "Sample Order - 1, Detail - 1",
                   "budget": 123.0,
                   "approvedBy": null,
                   "startDate": "2020-05-11T04:30:45.123Z",
                   "endate": "2020-05-30T04:30:45.123Z"
               }
           ]
       },
       {
           "id": 1,
           "status": "SOLD",
           "advertiserId": "123",
           "hierarchyId": "200",
           "ownerEmail": "someEmail@domain.com",
           "name": "Sample Order - 2",
           "orderDetails": [
               {
                   "id": 12,
                   "status": "SOLD",
                   "name": "Sample Order - 2, Detail - 1",
                   "budget": 123.0,
                   "approvedBy": null,
                   "startDate": "2020-05-23T04:30:45.123Z",
                   "endDate": "2020-05-26T04:30:45.123Z"
               }
           ]
       }
   ]
}

Header Specifications

  • Authorization

Input Specifications

  • Parameters

    • advertiserId (optional, required if no authorizationId given)

    • authorizationId (optional, required if no advertiserId given)

    • pageNumber (optional, defaults to 1)

    • pageSize (optional, defaults to 25)

Output Specifications

  • Pagination Information

    • Total number of results

    • Total number of pages

    • The current page number

    • The page size

  • Results

    • The page of orders that match the query params

Order

Field

Description

id

The order ID is associated with the sold proposal created within Ui.marketing

status

The total budget for the proposal that was created

advertiserId

The advertiserId is the id associated with an advertiser that matches up in our system.

ownerEmail

The user that is requesting the proposal

name

The order name that correlates with the proposal name

startDate

The start date of a specific proposal

endDate

The end date of a particular proposal

createdDate

The date the proposal was created

updatedDate

The last updated date of a proposal

name

The name of the proposal

Order Details

Field

Description

id

The id for the order detail, each product id on the proposal has an order id

status

The status of the order

name

The name of the order detail

budget

The budget for the product in the order

approvedBy

The user that approved the order

productKey

The name of the product associated with the order detail

startDate

The start date of the order detail

endDate

The end date of the order detail

  • No labels