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

• Search Orders

Endpoint

Example Request

...

• Code Block
  http://stg.api.adcellerant.com/order?advertiserId=123&pageNumber=1&pageSize=25

Example Response

...

• Status: 200 OK

Expand
title GET https://api.adcellerant.com/ordersResponse Body
Code Block language json { "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

• See: Authentication

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

...