Schema Reference
Query: itemList
itemListReturns: ItemList!
Get information about SKUs within an item list. This is particularly beneficial for publishers with active, pending, or expired Program Terms featuring an item list from an advertiser. It does not include commission information. For commission rate details, use the Program Terms API. By leveraging both the itemList query and the Program Terms API, you can better understand the expected commission rates for orders containing specific SKUs.
| Argument | Type | Description |
|---|---|---|
itemListId | ID! | Identifier for an Item List. |
Objects
Item
A single Item.
| Field | Type | Description |
|---|---|---|
name | String | The name of a product or item associated with a Stock Keeping Unit (SKU). This is a human-readable string that describes the product, often including key details such as brand, model, or specific attributes (e.g., "Acme Running Shoes - Blue, Size 10"). It provides a clear and concise description for the product in inventory or sales contexts. |
sku | String! | Represents a Stock Keeping Unit (SKU), a unique identifier for a product or item. The SKU is typically a string that encodes information such as product type, size, color, or other attributes. |
ItemList
A list of SKUs. Typically these lists are SKUs grouped together for the purpose of commissioning.
| Field | Type | Description | Arguments |
|---|---|---|---|
id | ID! | Item List id | — |
name | String | Item List name | — |
items | ItemPage | — | page (PageToken): Specifies the page of items referenced by this PageToken. The first request should omit this field, and each subsequent request should use the value of nextPage from the ItemPage struct. pageSize (PositiveInt!): Specifies the number of records per page. The maximum value is 10000. |
ItemPage
A page of Items up to pageSize in length.
| Field | Type | Description |
|---|---|---|
nextPage | PageToken | Token to be used in a subsequent query to retrieve the next page. A null value indicates that this is the last page and there are no more pages. |
records | [Item!]! | Items or products in the requested list. |
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 [email protected]. |
| 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 1969-12-31T23:59:59Z. |
| Url | A URL in the format https://www.example.com/ |
Updated 8 days ago

