This page will help you get started with Marketplace Inventory Split API V4.
Marketplace Inventory Splits API V4 allows Marketplace sellers to retrieve basic information for Marketplace Inventory Splits in its network.
Note
Inventory Split API V4 functionality is only available for Marketplace Seller users.
You can use the Inventory Split API to:
- Retrieve a list of Inventory Splits belonging to your current network
- Retrieve IDs, names, status, inventory shares and other key information of listed Inventory Splits
- Query the Inventory Splits list by name or last updated time
- Sort the Inventory Splits list by the last updated time
General Resource URIs
| Type | URI |
|---|---|
| Production Instance | https://api.freewheel.tv/services/v4/inventory_splits?{param1}={quer y1}&... |
| Staging Instance | https://api.stg.freewheel.tv/services/v4/inventory_splits?{param1}={q uery1}&... |
Basic Attributes
The following attributes are included in GET requests only.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | FW_ID | The ID of a particular Inventory Split | |
| name | String | The name of a particular Inventory Split | |
| status | Enum | The status of a particular Inventory Split. Valid values:
| |
| start_time | Time | The start time of a particular Inventory Split | |
| end_time | Time | The end time of a particular Inventory Split | |
| created_at | Time | The creation time of a particular Inventory Split | |
| updated_at | Time | The last updated time of a particular Inventory Split | |
| inventory_split_by | Enum | The inventory dimensions to split targeted inventory with partners. Valid values:
| |
| inventory_share_by | Enum | The inventory split module with partners Valid values:
| |
| inventory_shares | Set | The inventory share splitting details with each partner. |
Inventory Shares - Child Attributes
| Name | Type | Description | Notes |
|---|---|---|---|
| share_with_partner_id | FW_ID | The ID of the partner whom to split the inventory with. | If share_with_partner_id =-1, it means the inventory owner itself. |
| share_with_partner_name | String | The name of the partner whom to split the inventory with. | |
| partner_tag | Set | The tag information is linked to the Inventory Split from a Partner Tag deal. | Valid only when the share_with_partner_name is a Partner Tag buyer |
| endpoint_owner_id | FW_ID | The ID of the Endpoint Owner | Valid only when the inventory_split_by = 'BRAND_AND_ENDPOINT_OWNER' |
| brand_id | FW_ID | The ID of the Brand | Valid only when the inventory_split_by = 'BRAND_AND_ENDPOINT_OWNER' |
| ratio | Decimal | The ratio of this Inventory Share with the partner. | The range of the ratio is [0, 100]. |
Partner Tag - Child Attribute
Partner Tag is only valid when the Partner to split the inventory with is a Partner Tag buyer.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | FW_ID | The ID of the Partner Tag on the Inventory Split | |
| name | String | The name of the Partner Tag on the Inventory Split |