Retrieve variant

GET

/variants/{id}

curl --request GET \
  --url https://acme.mykreezalid.com/api/v1/variants/1 \
  --header 'Authorization: Basic <credentials>'

• Your marketplace's address. A marketplace with a custom domain must be called on that domain instead (https://developers.kreezalid.com/getting-started/base-urls/).

Returns one variant.

Authorizations

• basic

Parameters

Path Parameters

id

required

integer

Variant’s unique identifier

Responses

200

Variant’s details

Media typeapplication/json

object

variant

A version of a listing that differs by size, color or any other characteristic, with its own price, SKU and stock.

object

id

Variant’s unique identifier

integer

object

string

default: Variant

external_id

Your own reference for the variant

string

nullable

listing_id

Unique identifier of the listing the variant belongs to

integer

price

number

nullable

price_unit

integer

nullable

quantity

The quantity of the variant that is available for sale

number

nullable

sort_priority

Sorts the variants with the lowest number first. Negative numbers are allowed.

number

nullable

sku

string

nullable

title

required

string

weight

number

cover_id

Unique identifier of the listing image used for this variant

integer

nullable

Example

{
  "variant": {
    "id": 432432,
    "object": "Variant",
    "external_id": "INTERNAL_REF_234324",
    "listing_id": 324353,
    "price": 123.5,
    "price_unit": null,
    "quantity": 10,
    "sort_priority": 10,
    "sku": "BASKT-XYZ-BLN-41",
    "title": "Blue Shoes Size 41",
    "weight": 0.8,
    "cover_id": 4242
  }
}

403

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

Media typeapplication/json

object

error

string

Example ^generated

{
  "error": "example"
}

404

No variant has this identifier