Orders are an additional level between a campaign and its line items. If you run extensive, long-term campaigns, orders can help you manage your line items more efficiently. For example, you can set up an order per language, buying strategy, channel, ad type, or budget goal used in your campaign.
When you create a campaign, a default order is automatically created under this campaign. You can either use this order or create new ones to manage line items under them.
With Orders API, you can create and update orders, activate and deactivate them, retrieve a specific order or a list of all orders under a campaign.
To create an order, you must use an advertiser ID and a campaign ID in your requests. Use these IDs to assign the new order to the relevant hierarchy — parent advertiser and campaign.
Tip
To learn about Adform DSP and Ad Server API structure and use cases, see Learn About DSP and Ad Server APIs.
To start working with Orders API, you need:
-
Adform DSP or Ad Server user account that has these permissions assigned:
-
Manage Campaigns & Orders
-
-
The following scopes assigned to your OAuth client by Adform Support (technical@adform.com):
-
https://api.adform.com/scope/buyer.orders: Grants access to all endpoints of the Orders API.
-
https://api.adform.com/scope/buyer.orders.readonly: Grants read-only access to some of the endpoints of the Orders API.
-
-
The following IDs to use in your requests:
Note
Additional IDs might be used, but the listed ones are required to pass a request.
Note
If you don't have an OAuth client yet, follow the procedure in Get Authentication Credentials for Adform APIs to register one.