Query Reference

Query: itemList

Returns: 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 itemList with the Program Terms API, you can identify the expected commission rates for orders containing specific SKUs.

ArgumentTypeDescription
itemListIdID!Required. Identifier for the item list.

Objects

Item

A single item within an item list.

FieldTypeDescription
nameStringHuman-readable name of the product (e.g. "Acme Running Shoes - Blue, Size 10"). May include brand, model, or other key attributes.
skuString!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.

FieldTypeArgumentsDescription
idID!Item List ID.
nameStringItem List name.
itemsItemPagepageSize: PositiveInt!, page: PageTokenPaginated 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.

FieldTypeDescription
nextPagePageTokenToken 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.

FieldTypeDescription
addressLineOneString!First line of the street address.
addressLineTwoStringSecond line of the street address.
cityString!City
countryCodeCountryCodeAddress Country Code
countrySubdivisionCodeStringState or Province
postalCodeStringPostal or Zip Code

Enums

FunctionalCurrency

Currency used for reporting. Cannot be changed afterwards.

ValueDescription
CADCanadian Dollar
CZKCzech Koruna
DKKDanish Krone
EUREuro
GBPBritish Pound
PLNPolish Zloty
SEKSwedish Krona
USDUS Dollar
ZARSouth 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. 29.999

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. +15555555555

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/