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 get in touch with our Support team for the appropriate permissions.
Proposal | |
|---|---|
Use Case | Description |
id | The proposal ID is associated with the proposal created within 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 order, an order Id is associated with that proposal. |
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 |
advertiserId | The Advertiser Id that is associated with the proposal |
authorizationIds | An authorization ID is needed and used as a parameter to pass into an EAPI call to get proposal or order data in a response. |
requester | The user that is requesting the proposal |
Proposal Product | |
Use Case | Description |
product.id | The product Id is associated with the advertising product that is nested underneath a proposal. |
productKey | The product key is the key associated with each advertising product |
budget | This is the total budget for a campaign which is nested underneath a proposal |
proposedRetailRate | If the retail rate is adjusted, the new retail rate is associated with a campaign. |
retailRate | The retail rate that is being charged to the Advertiser |
wholesaleRate | The retail rate that is being charged to our partner |
startDate | The start date of the advertising product underneath a proposal specific to an individual campaign |
endDate | The end date of the advertising product underneath a proposal specific to an individual campaign |
monthlyAllocations | The monthly allocations that are associated with a campaign underneath a proposal. |
managementFee | The management fee is associated with a proposal advertising product. |
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
}
]
}