loading

Products: List

Retrieve all Product Lists for an account.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

limit
integer <= 50
Default: 10

Number of results to return.

offset
integer
Default: 0

Number of results to skip. Used to page through results. Cannot be used together with pageToken.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Products: Create

Create a new Product List.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/kjson
id
string <= 32 characters

List ID.

name
string

List name.

title
string

List title that appears on listings.

publish
boolean

Indicates whether the List should be shown on your listings.

language
string

List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language.

Examples: en, en_GB, fr_CA

currency
string

The three-letter ISO 4217 currency code. Defaults to USD.

Array of objects

A list of sections.

Responses

Request samples

Content type
application/kjson
{
  • "id": "string",
  • "name": "string",
  • "title": "string",
  • "publish": true,
  • "language": "string",
  • "currency": "string",
  • "sections": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Products: Get

Retrieve a specific Product List.

path Parameters
accountId
required
string
listId
required
string

ID of this List.

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Products: Update

Update an existing Product List.

path Parameters
accountId
required
string
listId
required
string

ID of this List.

query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/kjson
id
string <= 32 characters

List ID.

name
string

List name.

title
string

List title that appears on listings.

publish
boolean

Indicates whether the List should be shown on your listings.

language
string

List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language.

Examples: en, en_GB, fr_CA

currency
string

The three-letter ISO 4217 currency code. Defaults to USD.

Array of objects

A list of sections.

Responses

Request samples

Content type
application/kjson
{
  • "id": "string",
  • "name": "string",
  • "title": "string",
  • "publish": true,
  • "language": "string",
  • "currency": "string",
  • "sections": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Products: Delete

Delete an existing Products List.

path Parameters
accountId
required
string
listId
required
string

ID of this List.

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": { }
}