The Marketplace Purchased Inventory Orders API V4 allows Marketplace buyers to retrieve basic information from purchased Marketplace inventory orders in their networks. This API retrieves corresponding IDs that are essential for further Marketplace supply source configuration in the Placement API V3.
Note
API access is only available for networks that have Marketplace Platform enabled as a buyer.
Use the 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
- Get basic attributes of a specified purchased Inventory order
- Query the Marketplace order list by name, status, and last updated time
- Sort the Marketplace order list by last updated time
This API retrieves Purchased Inventory Orders . To query Marketplace Inventory Split Orders, see the Marketplace Inventory Split Orders API V4.
Note
This API 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 response schema are included in GET requests only.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | FW_ID | The ID of an inventory order | |
| name | string | The name of an inventory order | |
| order_type | FW_ID | The order type of an inventory order Valid values:
| |
| transaction_type | enum | The transaction type of an Inventory Order Valid values:
| |
| transaction_priority | enum | The transaction priority of an inventory order Valid values:
| BELOW_GUARANTEED and BACKFILL are only valid when transaction_type = NON_GUARANTEED |
| seller_name | string | The seller name on an inventory order | |
| start_time | time | The start time of an inventory order | |
| end_time | time | The end time of an inventory order | Returns empty if the request is for an ongoing order, and only valid for Non- Guaranteed Orders |
| status | enum | The status of an 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 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 an inventory order | |
| updated_at | time | The last updated time of an inventory order |
Pricing – Child Attributes
| Name | Type | Description | Notes |
|---|---|---|---|
| model | enum | The pricing model of an inventory order Valid values:
| Model = FLOOR is only valid when transaction_type = NON_GUARANTEED |
| price | decimal | The price CPM of an inventory order | Valid in [0.00, 10,000,000,000.00] |
| currency | enum | The currency code set on the inventory order. e.g. USD |
Pricing - Child Attributes - Guaranteed Inventory Orders Only
| Name | Type | Description | Notes |
|---|---|---|---|
| model | enum | The budget model of an inventory order Valid value: IMPRESSION | |
| impression_goal | integer | The budget impression goal of an inventory order | Valid in [0, 10,000,000,000] |