Get add-ons

GET

/listings/{id}/add-ons

const url = 'https://acme.mykreezalid.com/api/v1/listings/1/add-ons?page=1&limit=25&fields=id%2Ctitle%2Cprice';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://acme.mykreezalid.com/api/v1/listings/1/add-ons?page=1&limit=25&fields=id%2Ctitle%2Cprice' \
  --header 'Authorization: Basic <credentials>'

Returns the add-ons of a listing. The list is paginated with page and limit, without a pagination block in the response. Use fields to keep only some fields of each add-on.

Authorizations

basic

Parameters

Path Parameters

required

integer

Listing’s unique identifier

Query Parameters

page

integer

default: 1 >= 1

Page number, starting at 1.

limit

integer

default: 25 >= 1 <= 100

Number of results per page (at most 100).

fields

string

Example

id,title,price

Comma-separated list of the fields to return for each add-on.

Responses

200

The add-ons of the listing

application/json

object

add_ons

Array<object>

An extra product or service a buyer can add to a listing, such as gift wrapping or an extended warranty.

object

Add-on’s unique identifier

integer

object

string

default: Addon

listing_id

Unique identifier of the listing the add-on belongs to

integer

title

string

description

string

price

Price of the add-on, with up to two decimal places

number format: double

nullable

Example

{
  "add_ons": [
    {
      "id": 4242,
      "object": "Addon",
      "listing_id": 324353,
      "title": "Extended Warranty",
      "description": "Protect your purchases beyond the standard warranty period",
      "price": 12.5
    }
  ]
}

403

Missing or wrong API credentials

404

The requested page does not exist