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

Version 1 Next »

Endpoint

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

The Proposals API provides our Partners' capability to retrieve proposals without requiring the use of our proprietary Proposals tool in UI.Marketing. Once the proposal is created, the API partner can edit a proposal by concatenating the URL with the external API's Proposal data. 

Header Specifications

  • Authorization

Input Specifications

  • Parameters

    • hierarchId (Long, required)

    • externalId (String, required)

    • updatedAfter (Date String, optional, ISO format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX)

    • pageNumber (Integer, optional, defaults to 1)

    • pageSize (Integer, 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 proposals that match the query params

Example Request:

Example Response:

  • Status: 200 OK

{
   "pageNumber": 1,
   "pageSize": 25,
   "totalPages": 1,
   "totalCount": 1,
   "results": [
       {
          "products": [{
               "id":100
               "productKey": "key",
               "budget": 10000,
               "proposedRetailRate": 0.0,
               "retailRate": 10.0,
               "wholeSaleRate": 10.0,
               "startDate": "2021-01-02T14:00:00.000Z",
               "endDate": "2021-02-09T14:00:00.000Z",
               "monthlyAllocations": [
                     {
                        "startDate": "2021-01-01",
                        "endDate": "2021-01-31",
                        "amount": 100
                     },
                     {
                        "startDate": "2021-02-01",
                        "endDate": "2021-02-29",
                        "amount": 100
                     }
                ],
               "managementFee": null
            }
         ],
          "id": 2040,
          "externalId": "47h8347W3",
          "orderId": "2398",
          "startDate": "2021-01-02T14:00:00.000Z",
          "endDate": "2021-03-09T14:00:00.000Z",
          "createdDate": "2020-11-28T11:20:12.097Z",
          "updatedDate": "2020-12-01T05:30:45.123Z",
          "name": "Example Proposal Foo",
          "advertiserId": "300",
          "authorizationIds":[
                "0000-1234-1234-1244-14abcdefg"
          ],
          "requester": "Some Requester",
          "budget": 23000
       }
   ]
}
  • No labels