Marketplace Sold Inventory API V4 allows Marketplace buyers to retrieve basic information for Sold Marketplace Inventory Orders in their networks. Sold Inventory Orders are Inventory Orders (Marketplace orders between the buyer and seller) sold in the Marketplace.
Marketplace Sold Inventory API V4 can retrieve Marketplace Inventory Orders from MRM buyers as well as third-party buyers (i.e., Marketplace Parter Tag orders).
Note
Marketplace Sold Inventory API V4 functionality is only available for Marketplace Seller users.
You can use Marketplace Sold Inventory Order API V4 to:
- Retrieve basic information for a Sold Inventory Order belonging to your current network
- Retrieve a list of Sold Inventory Orders belonging to your current network
- Retrieve IDs, names, buyers, order types, and other key data related to listed Marketplace Orders
- Query the Marketplace Order list by name, status, and last-updated time
- Sort the Marketplace Order list by last updated time.
Info
Marketplace Sold 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/sold_inventory_orders?{param1}={query1}&... |
| Staging Instance | https://api.stg.freewheel.tv/services/v4/sold_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 certain Inventory Order | |
| name | String | The name of a certain Inventory Order | |
| order_type | Enum | The type of a certain Inventory Order. whether it is from MRM or a third party. Valid values:
| |
| transaction_type | Enum | The transaction type of a certain 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 |
| priority_override | Integer | The priority of a certain Inventory Order | If transaction_priority = ABOVE_GUARANTEED, then valid value 21-30, default value is 25; If order_type = PARTNER_TAG_ORDER and transaction_priority = AMONG _GUARANTEED, then the valid value is 11- 20, the default value is null. |
| buyer_name | String | The buyer name on a certain Inventory Order | |
| start_time | Time | The start time of a certain Inventory Order | |
| end_time | Time | The end time of a certain Inventory Order. | Return empty if it’s an ongoing order, and only valid for Non-Guaranteed Orders |
| status | Enum | The status of a certain Marketplace Order. Valid values:
| |
| created_at | Time | The creation time of a certain Inventory Inventory Order | |
| updated_at | Time | The last updated time of a certain Inventory Order. | |
| 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. |
| volume_cap | Integer | The delivery volume cap of an Inventory Order | Only valid when transaction_type = NON_GUARANTEED; default value is null, which means no limit. |
| pacing | Enum | The pacing of a certain Marketplace Order. Valid values:
| Only valid when transaction_type = GUARANTEED. |
| creative_approval | Set | The creative approval type and clearance level of a sold inventory order. | Only valid when order_type= PARTNER_TAG_ORDER |
| freewheel_clearing | Boolean | Determines if buyer is billed by FreeWheel for the media cost. Valid values:
| If order_type = PARTNER_TAG_ORDER, this can only be false. |
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 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 |
currency## Budget – Child Attributes
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] |
Creative Approval – Child Attributes
Creative Approval fields are only valid for Partner Tag Orders.
| Name | Type | Description | Notes |
|---|---|---|---|
| type | Enum | The creative approval type of a certain Inventory Order. Valid values:
| GLOBAL means managed approval in the Marketplace UI. |
| clearance_level | Enum | The creative clearance level of a certain Inventory Order. Valid values:
| Only valid when Creative Approval Type = GLOBAL |