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.
Common Use Cases
NOTE: If you cannot access any of the following pages or need access to a specific feature, please contact our Support team for the appropriate permissions.
USE CASE | DESCRIPTION |
|---|---|
id | The Proposal Id that is associated with the proposal that was created withing Ui.marketing. |
budget | The total budget for the Proposal that was created. |
externalId | The externalId is the data point that will allow a third party to store their Id to associate it back to a Proposal. |
orderId | Once a proposal is submitted into an Order there is an order Id associated with that Proposal. |
startDate | |
createdDate | |
updatedDate | |
name | |
advertiserId | |
authorizationIds | |
requester | |
budget | |
product.id | |
productKey | |
budget | |
proposedRetailRate | |
retailRate | |
wholesaleRate | |
startDate | |
endDate | |
monthlyAllocations | |
stateDate | |
endDate | |
amount | |
managementFee |
Endpoint
GET https://api.adcellerant.com/proposals
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
}
]
}