Marketplace Purchased Inventory Orders API V4 allows Marketplace buyer to retrieve basic information for Purchased Marketplace Inventory Order in its network. Retrieved corresponding IDs are essential for further Marketplace Supply Source configuration through Placement API V3.
From the Marketplace Buyer view, there are two types of Marketplace Orders to retrieve,
and each type of Order has one OpenAPI to retrieve the list:
- Purchased Inventory Orders: the Inventory Orders acquired from Marketplace. Inventory Order is the Marketplace Order between the buyer and seller in the Marketplace Platform
- Marketplace Inventory Split Orders API V4 : Specifically for agreements shared a percentage split of inventory between parties.
Note
This API's functionality is only available for API users of networks enabled Marketplace Platform as a buyer.
You can use Marketplace Purchased Inventory Orders API V4 to:
- Retrieve a list of Purchased Inventory Orders belonging to your current network with corresponding IDs, names, and other key information of listed Orders.
- Query the Marketplace Order list by name, status, and last updated time and sort the Marketplace Order list by last updated time.
- Get basic attributes of a certain purchased Inventory Order.
Note
Marketplace Purchased Inventory Order API V4 supports JSON format only. XML format is not supported.
General Resource URIs
| URI | Type of URI |
|---|---|
| Production Instance | https://api.freewheel.tv/services/v4/purchased_inventory_orders?{param1}={query1}&... |
| Staging Instance | https://api.stg.freewheel.tv/services/v4/purchased_inventory_orders?{param1}={query1}&... |
Attributes
The following attributes are included in GET requests only.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | FW_ID | The ID of a particular Inventory Order | |
| name | String | The name of a particular Inventory Order | |
| order_type | FW_ID | The order type of a particular Inventory Order. Valid values:
| |
| transaction_type | Enum | The transaction type of a particular Inventory Order. Valid values:
| |
| transaction_priority | Enum | The transaction priority of a certain Inventory Order. Valid values:
| BELOW_GUARANTEED and BACKFILL are only valid when transaction_type = NON_GUARANTEED |
| seller_name | String | The seller name on a particular Inventory Order | |
| start_time | Time | The start time of a particular Inventory Order. | |
| end_time | Time | The end time of a particular Inventory Order | Returns empty if the request is for an ongoing order, and only valid for Non- Guaranteed Orders |
| status | Enum | The status of a particular Inventory Order Valid values:
| |
| pricing | Set | The pricing model and rate card of an Inventory Order | |
| budget | Set | The budget model and budget of an Inventory Order | Only valid when transaction_type = GUARANTEED |
| pacing | Enum | The pacing of a certain Marketplace Order. Valid values:
| Only valid when transaction_type = GUARANTEED |
| freewheel_clearing | Boolean | Determines if buyer is billed by FreeWheel for the media cost. Valid values:
| |
| created_at | Time | The creation time of a particular Inventory Inventory Order | |
| updated_at | Time | The last updated time of a particular Inventory Order. |
Pricing – Child Attributes
| Name | Type | Description | Notes |
|---|---|---|---|
| model | Enum | The pricing model of a certain Inventory Order. Valid values:
| Model = FLOOR is only valid when transaction_type = NON_GUARANTEED |
| price | Decimal | The price CPM of a certain Inventory Order. | Valid in [0.00, 10,000,000,000.00] |
| currency | Enum | The currency code set on the Inventory Order. e.g. USD |
The following are only valid for Guaranteend Inventory Orders.
| Name | Type | Description | Notes |
|---|---|---|---|
| model | Enum | The budget model of a certain Inventory Order. Valid value: IMPRESSION | |
| impression_goal | Integer | The budget impression goal of a certain Inventory Order. | Valid in [0, 10,000,000,000] |