Query Reference
Query: itemList
itemListReturns: ItemList!
Get information about SKUs within an item list. This is particularly useful for publishers with active, pending, or expired Program Terms that feature an item list from an advertiser.
Note: This query does not include commission information. For commission rate details, use the Program Terms API. By combining
itemListwith the Program Terms API, you can identify the expected commission rates for orders containing specific SKUs.
| Argument | Type | Description |
|---|---|---|
itemListId | ID! | Required. Identifier for the item list. |
Objects
Item
A single item within an item list.
| Field | Type | Description |
|---|---|---|
name | String | Human-readable name of the product (e.g. "Acme Running Shoes - Blue, Size 10"). May include brand, model, or other key attributes. |
sku | String! | The Stock Keeping Unit (SKU) — a unique identifier for the product, typically encoding attributes such as type, size, or color. |
ItemList
A list of SKUs, typically grouped together for the purpose of commissioning.
| Field | Type | Arguments | Description |
|---|---|---|---|
id | ID! | — | Item List ID. |
name | String | — | Item List name. |
items | ItemPage | pageSize: PositiveInt!, page: PageToken | Paginated list of items in this list. pageSize is required and sets the number of records per page (max 10,000). page is the token from a previous response — omit on the first request. |
ItemPage
A single page of items, up to pageSize in length.
| Field | Type | Description |
|---|---|---|
nextPage | PageToken | Token to use in the next request to retrieve the following page. A null value means this is the last page. |
records | [Item!]! | The items or products in this page of results. |
Input Objects
AddressInput
Address details.
| Field | Type | Description |
|---|---|---|
addressLineOne | String! | First line of the street address. |
addressLineTwo | String | Second line of the street address. |
city | String! | City |
countryCode | CountryCode | Address Country Code |
countrySubdivisionCode | String | State or Province |
postalCode | String | Postal or Zip Code |
Enums
FunctionalCurrency
Currency used for reporting. Cannot be changed afterwards.
| Value | Description |
|---|---|
| CAD | Canadian Dollar |
| CZK | Czech Koruna |
| DKK | Danish Krone |
| EUR | Euro |
| GBP | British Pound |
| PLN | Polish Zloty |
| SEK | Swedish Krona |
| USD | US Dollar |
| ZAR | South African Rand |
Scalars
Value | Description |
|---|---|
Boolean | Built-in Boolean |
CountryCode | A two letter ISO 3166-1 alpha-2 country code. |
CurrencyCode | A three letter ISO 4217 currency code. |
Decimal | A signed decimal number, which supports arbitrary precision and is serialized as a string. eg. |
EmailAddress | An email address in the format |
ID | Built-in ID |
PageToken | An opaque token that can be used to select the next page of records. |
PhoneNumber | An E.164 phone number. eg. |
PositiveInt | An Int that is greater than 0. |
String | Built-in String |
Timestamp | A date and time in UTC, in the format |
Url | A URL in the format |
Updated 9 days ago
