This page will help you get started with Marketplace Inventory Split Orders API V4.
Marketplace Inventory Split Orders API V4 allows Marketplace buyer to retrieve basic information for Marketplace Inventory Split Orders in its network. Retrieved corresponding IDs are essential for further Marketplace Supply Source configuration through Placement API V3.
Note
This API's functionality is only available to Marketplace Buyer users
You can use this API to:
- Retrieve a list of Inventory Split Orders belonging to your current network
- Retrieve IDs, names, seller/buyer, order type and other key informations of listed Marketplace Orders
- Query the Inventory Split Orders list by name, status and last updated time
- Sort the Inventory Split Orders list by last updated time
General Resource URIs
| Type | URI |
|---|---|
| Production Instance | https://api.freewheel.tv/services/v4/inventory_split_orders?{param1}={quer y1}&... |
| Staging Instance | https://api.stg.freewheel.tv/services/v4/inventory_split_orders?{param1}={q uery1}&... |
Attributes
The following attributes are included in GET requests only.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | FW_ID | The ID of a particular Inventory Split Order | |
| name | String | The name of a particular Inventory Split Order | |
| order_type | FW_ID | The order type of a particular Inventory Split Order. Valid value: *INVENTORY_SPLIT_OR DER | |
| shared_from_name | String | The inventory shared from party of this Inventory Split Order | Only valid for Order Type = INVENTORY_SP LIT_ORDER |
| start_time | Time | The start time of a particular Marketplace Order | Returned empty if the request is for an ongoing order |
| end_time | Time | The end time of a particular Marketplace Order | Returned empty if the request is for an ongoing order |
| status | Enum | The status of a particular Marketplace Order. Valid values:
| Returned empty if the request is for an ongoing order |
| created_at | Time | The creation time of a particular Marketplace Order | |
| updated_at \ | Time | The last updated time of a particular Marketplace Order |