Skip to content

Retrieve add-on

GET
/add-ons/{id}
curl --request GET \
--url https://acme.mykreezalid.com/api/v1/add-ons/1 \
--header 'Authorization: Basic <credentials>'

Returns one add-on.

id
required
integer

Add-on’s unique identifier

The add-on

Media typeapplication/json
object
add_on

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

object
id

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_on": {
"id": 4242,
"object": "Addon",
"listing_id": 324353,
"title": "Extended Warranty",
"description": "Protect your purchases beyond the standard warranty period",
"price": 12.5
}
}

Missing or wrong API credentials, or add-ons are not enabled for your marketplace (then the body carries an error message)

Media typeapplication/json
object
error
string

Example generated

{
"error": "example"
}

No add-on has this identifier