Schema Reference

Query: itemList

Returns: 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.

ArgumentTypeDescription
itemListIdID!Identifier for an Item List.

Objects

Item

A single Item.

FieldTypeDescription
nameStringThe 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.
skuString!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.

FieldTypeDescriptionArguments
idID!Item List id
nameStringItem List name
itemsItemPagepage (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.

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

FieldTypeDescription
addressLineOneString!First line of the street address.
addressLineTwoStringSecond line of the street address.
cityString!City
countryCodeCountryCode!Address 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

ValueDescription
BooleanBuilt-in Boolean
CountryCodeA two letter ISO 3166-1 alpha-2 country code.
CurrencyCodeA three letter ISO 4217 currency code.
Decimal

A signed decimal number, which supports arbitrary precision and is serialized as a string.

eg. 29.999

EmailAddressAn email address in the format [email protected].
IDBuilt-in ID
PageTokenAn opaque token that can be used to select the next page of records.
PhoneNumber

An E.164 phone number.

eg. +15555555555

PositiveIntAn Int that is greater than 0.
StringBuilt-in String
TimestampA date and time in UTC, in the format 1969-12-31T23:59:59Z.
UrlA URL in the format https://www.example.com/

Did this page help you?