Overview
The Marketplace Supply Source Package API allows Marketplace buyers to retrieve basic information from Supply Source Packages within their networks. The queried Supply Source Packages consist of Purchased Inventory Orders and Inventory Split Orders. The basic information returned includes package IDs and names essential for package trafficking with Placement API v3.
Users can leverage this API to accomplish the following tasks:
- Retrieve a list of supply source packages belonging to the current network
- Retrieve IDs, names, statuses, times of creation, and times of last updated time of listed supply source packages
- Query the supply source package list by name, status, and last updated time
- Sort the supply source package list by last updated time
Note
This API is only available for Marketplace buyers. To enable Marketplace, contact your account representative.
Resources
URIs
| Type | URI |
|---|---|
| Production Instance | https://api.freewheel.tv/services/v4/supply_source_packages?{param1}={query1}&... |
| Staging Instance | https://api.stg.freewheel.tv/services/v4/supply_source_packages?{param1}={query1}&... |
Query Parameters
Note
Parameters and values are case-sensitive.
| Parameter | Value | Description |
|---|---|---|
| name | string | Specify filtering criteria by supply source package name. This parameter can match a name composed of continuous characters with specified strings. Maximum character length is 255. For example, a request containing ?name=STB retrieves a list of all supply source packages whose names contain the characters STB, like STBVOD package or Linear STB package. |
| status | Enum | Specify filtering criteria by supply source package status. Valid values:
|
| updated_at | string | Use the following syntax to filter supply source packages by last updated time:
Use the following syntax to sort the list of supply source packages by the last updated time:
|
| page | int32 | Specifies the number of pages in the returned list. Default value = 1 Maximum value = 1000 |
| per_page | int32 | Specifies the number of items to show on each page. Default value = 20 Valid value range = 5-50 |
Response Schema
| Name | Type | Description |
|---|---|---|
| id | FW_ID | The ID of a supply source package |
| name | String | The name of a supply source package |
| status | Enum | The status of a supply source package. Valid values:
|
| created_at | Time | The creation time of a supply source package |
| updated_at | Time | The last updated time of a supply source package |