Skip to content
Zentail Developer Docs

Get retrieves a single listing by its ID

You call thisScope not enforced

GET
/v2/storefront/listing/{listingId}
curl --request GET \
  --url https://api.zentail.com/v2/storefront/listing/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
listingId
required
string

Responses

Section titled “ Responses ”

200

Section titled “200”

A successful response.

Media typeapplication/json
Listing is a representation of a product to be sold on a Channel LATER: comment this more
object
id
string
sku
A SKU to represent the entire listing (this is usually a value that is different than any of the SKUs of the Variants)
string
productData
object
enabled
boolean
categoryId
string
productTypeId
string
pivotAttributes
Array<string>
attributes
Array<object>
Attribute has data that describes a Listing or a Listing's Variants
object
id
string
textValue
string
numericValue
number format: double
numericWithUnitsValue
NumericWithUnits supports values like 1 lb
object
numeric
number format: double
units
string
multiTextValue
MultiText supports a value that has multiple sub-values (e.g. bullet points)
object
values
Array<string>
moneyValue
Money supports values like with amount and currency_code
object
amount
string
currencyCode
string
multiObjectValue
Object supports a set of keys and values
object
items
Array<object>
object
properties
object
key
additional properties
object
textValue
string
numericValue
number format: double
numericWithUnitsValue
NumericWithUnits supports values like 1 lb
object
numeric
number format: double
units
string
multiTextValue
MultiText supports a value that has multiple sub-values (e.g. bullet points)
object
values
Array<string>
moneyValue
Money supports values like with amount and currency_code
object
amount
string
currencyCode
string
multiObjectValue
object recursive
versionId
string
updatedAt
string format: date-time
submittedAt
string format: date-time
updatedAt
string format: date-time
swatchImageAttributeId

Channel aspect id(s) whose values drive per-variant images (e.g. eBay variesBy.aspectsImageVariesBy); empty means infer. Per ZEN-3240.

Array<string>
standaloneVariants

Each variant publishes as its own item, not as a variation family: the listing is a split with no pivots left. Per ZEN-5811.

boolean
baseListingSku

The Product Group’s own listing SKU, which an earlier publish may have used as the variation parent. Set on a listing that submits no parent: a standalone split, or a split with one variant.

string
retireBaseParent

Base_listing_sku is safe to delete: no other split still uses it as its parent. When false the channel only unlinks this listing’s items from it. Per ZEN-6076.

boolean
pivotOptions

The pivots this listing still varies by, as a storefront shows them to shoppers. Set for BigCommerce and Shopify only. Per ZEN-6639.

Array<object>

PivotOption is one pivot a listing varies by, as a storefront shows it: a BigCommerce option or a Shopify option.

object
attributeId

The catalog pivot attribute spec id.

string
displayName

The alias when set, else attribute_id title-cased with “_” as a space.

string
alias

The merchant’s own name for the pivot, unformatted. Empty when unset.

string
sortOrder

1-based position among all of the Product Group’s pivots, split ones included.

integer format: int32
displayType

“swatch” for the group’s swatch attribute, else the storefront’s option_type setting, else “dropdown”.

string
values
Array<object>

PivotOptionValue is one value of a PivotOption.

object
label

Labels are case-folded across every option: the first casing seen wins.

string
sortOrder

1-based, in variant order.

integer format: int32
swatchImageUrl

Set on a swatch option only: the variant’s swatch image, else its primary image.

string
skus

The listing SKUs that carry this value.

Array<string>
split

This listing is one of its Product Group’s splits, the one that kept the unsplit listing’s id included. Per ZEN-7092.

boolean
metafields

Shopify metafield values, built from the storefront’s metafield specs. Set for Shopify only. Per ZEN-6876.

Array<object>

Metafield is one Shopify metafield value, built from a storefront metafield spec.

object
namespace
string
key

The spec’s key, else its display name.

string
type

Shopify’s value type, such as “list.single_line_text_field”.

string
value

A list.* value is a JSON array. A reference is the merchant’s raw label: the Shopify service resolves it against the live shop.

string
sku

The variant’s listing SKU. Empty for a product metafield.

string
variants
Array<object>
Variant is a representation of a specific SKU in a listing LATER: comment this more
object
sku
string
channelId
string
settings

Any Integration-level Settings will be merged with Variant-level Settings to produce these Settings.

object
key
additional properties
string
inventory
Inventory contains information about the availability of this variant
object
enabled
boolean
totalQuantity
total_quantity should be the sum of merchant_fulfillable_inventory and storefront_fulfillable_quantity
string format: int64
merchantFulfillableQuantity
string format: int64
merchantFulfillableWarehouseQuantities
Array<object>
object
warehouseId
string
quantity
string format: int64
storefrontFulfillableQuantity
string format: int64
updatedAt
string format: date-time
identifiers
Attributes is a container for a list of attributes of a similar classification
object
enabled
boolean
attributes
Array<object>
Attribute has data that describes a Listing or a Listing's Variants
object
id
string
textValue
string
numericValue
number format: double
numericWithUnitsValue
NumericWithUnits supports values like 1 lb
object
numeric
number format: double
units
string
multiTextValue
MultiText supports a value that has multiple sub-values (e.g. bullet points)
object
values
Array<string>
moneyValue
Money supports values like with amount and currency_code
object
amount
string
currencyCode
string
multiObjectValue
Object supports a set of keys and values
object
items
Array<object>
object
properties
object
key
additional properties
object
textValue
string
numericValue
number format: double
numericWithUnitsValue
NumericWithUnits supports values like 1 lb
object
numeric
number format: double
units
string
multiTextValue
MultiText supports a value that has multiple sub-values (e.g. bullet points)
object
values
Array<string>
moneyValue
Money supports values like with amount and currency_code
object
amount
string
currencyCode
string
multiObjectValue
object recursive
versionId
string
updatedAt
string format: date-time
submittedAt
string format: date-time
updatedAt
string format: date-time
productData
Attributes is a container for a list of attributes of a similar classification
object
enabled
boolean
attributes
Array<object>
Attribute has data that describes a Listing or a Listing's Variants
object
id
string
textValue
string
numericValue
number format: double
numericWithUnitsValue
NumericWithUnits supports values like 1 lb
object
numeric
number format: double
units
string
multiTextValue
MultiText supports a value that has multiple sub-values (e.g. bullet points)
object
values
Array<string>
moneyValue
Money supports values like with amount and currency_code
object
amount
string
currencyCode
string
multiObjectValue
Object supports a set of keys and values
object
items
Array<object>
object
properties
object
key
additional properties
object
textValue
string
numericValue
number format: double
numericWithUnitsValue
NumericWithUnits supports values like 1 lb
object
numeric
number format: double
units
string
multiTextValue
MultiText supports a value that has multiple sub-values (e.g. bullet points)
object
values
Array<string>
moneyValue
Money supports values like with amount and currency_code
object
amount
string
currencyCode
string
multiObjectValue
object recursive
versionId
string
updatedAt
string format: date-time
submittedAt
string format: date-time
updatedAt
string format: date-time
pricing
Pricing is a container for a list of pricing attributes as well as structured information about scheduled sales
object
enabled
boolean
attributes
Array<object>
Attribute has data that describes a Listing or a Listing's Variants
object
id
string
textValue
string
numericValue
number format: double
numericWithUnitsValue
NumericWithUnits supports values like 1 lb
object
numeric
number format: double
units
string
multiTextValue
MultiText supports a value that has multiple sub-values (e.g. bullet points)
object
values
Array<string>
moneyValue
Money supports values like with amount and currency_code
object
amount
string
currencyCode
string
multiObjectValue
Object supports a set of keys and values
object
items
Array<object>
object
properties
object
key
additional properties
object
textValue
string
numericValue
number format: double
numericWithUnitsValue
NumericWithUnits supports values like 1 lb
object
numeric
number format: double
units
string
multiTextValue
MultiText supports a value that has multiple sub-values (e.g. bullet points)
object
values
Array<string>
moneyValue
Money supports values like with amount and currency_code
object
amount
string
currencyCode
string
multiObjectValue
object recursive
versionId
string
updatedAt
string format: date-time
submittedAt
string format: date-time
updatedAt
string format: date-time
sales
Array<object>
object
strikeThroughPrice
number format: double
salePrice
number format: double
startAt
string format: date-time
endAt
string format: date-time
logistics
Attributes is a container for a list of attributes of a similar classification
object
enabled
boolean
attributes
Array<object>
Attribute has data that describes a Listing or a Listing's Variants
object
id
string
textValue
string
numericValue
number format: double
numericWithUnitsValue
NumericWithUnits supports values like 1 lb
object
numeric
number format: double
units
string
multiTextValue
MultiText supports a value that has multiple sub-values (e.g. bullet points)
object
values
Array<string>
moneyValue
Money supports values like with amount and currency_code
object
amount
string
currencyCode
string
multiObjectValue
Object supports a set of keys and values
object
items
Array<object>
object
properties
object
key
additional properties
object
textValue
string
numericValue
number format: double
numericWithUnitsValue
NumericWithUnits supports values like 1 lb
object
numeric
number format: double
units
string
multiTextValue
MultiText supports a value that has multiple sub-values (e.g. bullet points)
object
values
Array<string>
moneyValue
Money supports values like with amount and currency_code
object
amount
string
currencyCode
string
multiObjectValue
object recursive
versionId
string
updatedAt
string format: date-time
submittedAt
string format: date-time
updatedAt
string format: date-time
createdAt
string format: date-time
updatedAt
string format: date-time
Examplegenerated
{
  "id": "example",
  "sku": "example",
  "productData": {
    "enabled": true,
    "categoryId": "example",
    "productTypeId": "example",
    "pivotAttributes": [
      "example"
    ],
    "attributes": [
      {
        "id": "example",
        "textValue": "example",
        "numericValue": 1,
        "numericWithUnitsValue": {
          "numeric": 1,
          "units": "example"
        },
        "multiTextValue": {
          "values": [
            "example"
          ]
        },
        "moneyValue": {
          "amount": "example",
          "currencyCode": "example"
        },
        "multiObjectValue": {
          "items": [
            {
              "properties": {
                "additionalProperty": {
                  "textValue": "example",
                  "numericValue": 1,
                  "numericWithUnitsValue": {
                    "numeric": 1,
                    "units": "example"
                  },
                  "multiTextValue": {
                    "values": [
                      "example"
                    ]
                  },
                  "moneyValue": {
                    "amount": "example",
                    "currencyCode": "example"
                  },
                  "multiObjectValue": {}
                }
              }
            }
          ]
        },
        "versionId": "example",
        "updatedAt": "2026-04-15T12:00:00Z",
        "submittedAt": "2026-04-15T12:00:00Z"
      }
    ],
    "updatedAt": "2026-04-15T12:00:00Z",
    "swatchImageAttributeId": [
      "example"
    ],
    "standaloneVariants": true,
    "baseListingSku": "example",
    "retireBaseParent": true,
    "pivotOptions": [
      {
        "attributeId": "example",
        "displayName": "example",
        "alias": "example",
        "sortOrder": 1,
        "displayType": "example",
        "values": [
          {
            "label": "example",
            "sortOrder": 1,
            "swatchImageUrl": "example",
            "skus": [
              "example"
            ]
          }
        ]
      }
    ],
    "split": true,
    "metafields": [
      {
        "namespace": "example",
        "key": "example",
        "type": "example",
        "value": "example",
        "sku": "example"
      }
    ]
  },
  "variants": [
    {
      "sku": "example",
      "channelId": "example",
      "settings": {
        "additionalProperty": "example"
      },
      "inventory": {
        "enabled": true,
        "totalQuantity": "example",
        "merchantFulfillableQuantity": "example",
        "merchantFulfillableWarehouseQuantities": [
          {
            "warehouseId": "example",
            "quantity": "example"
          }
        ],
        "storefrontFulfillableQuantity": "example",
        "updatedAt": "2026-04-15T12:00:00Z"
      },
      "identifiers": {
        "enabled": true,
        "attributes": [
          {
            "id": "example",
            "textValue": "example",
            "numericValue": 1,
            "numericWithUnitsValue": {
              "numeric": 1,
              "units": "example"
            },
            "multiTextValue": {
              "values": [
                "example"
              ]
            },
            "moneyValue": {
              "amount": "example",
              "currencyCode": "example"
            },
            "multiObjectValue": {
              "items": [
                {
                  "properties": {
                    "additionalProperty": {
                      "textValue": "example",
                      "numericValue": 1,
                      "numericWithUnitsValue": {
                        "numeric": 1,
                        "units": "example"
                      },
                      "multiTextValue": {
                        "values": [
                          "example"
                        ]
                      },
                      "moneyValue": {
                        "amount": "example",
                        "currencyCode": "example"
                      },
                      "multiObjectValue": {}
                    }
                  }
                }
              ]
            },
            "versionId": "example",
            "updatedAt": "2026-04-15T12:00:00Z",
            "submittedAt": "2026-04-15T12:00:00Z"
          }
        ],
        "updatedAt": "2026-04-15T12:00:00Z"
      },
      "productData": {
        "enabled": true,
        "attributes": [
          {
            "id": "example",
            "textValue": "example",
            "numericValue": 1,
            "numericWithUnitsValue": {
              "numeric": 1,
              "units": "example"
            },
            "multiTextValue": {
              "values": [
                "example"
              ]
            },
            "moneyValue": {
              "amount": "example",
              "currencyCode": "example"
            },
            "multiObjectValue": {
              "items": [
                {
                  "properties": {
                    "additionalProperty": {
                      "textValue": "example",
                      "numericValue": 1,
                      "numericWithUnitsValue": {
                        "numeric": 1,
                        "units": "example"
                      },
                      "multiTextValue": {
                        "values": [
                          "example"
                        ]
                      },
                      "moneyValue": {
                        "amount": "example",
                        "currencyCode": "example"
                      },
                      "multiObjectValue": {}
                    }
                  }
                }
              ]
            },
            "versionId": "example",
            "updatedAt": "2026-04-15T12:00:00Z",
            "submittedAt": "2026-04-15T12:00:00Z"
          }
        ],
        "updatedAt": "2026-04-15T12:00:00Z"
      },
      "pricing": {
        "enabled": true,
        "attributes": [
          {
            "id": "example",
            "textValue": "example",
            "numericValue": 1,
            "numericWithUnitsValue": {
              "numeric": 1,
              "units": "example"
            },
            "multiTextValue": {
              "values": [
                "example"
              ]
            },
            "moneyValue": {
              "amount": "example",
              "currencyCode": "example"
            },
            "multiObjectValue": {
              "items": [
                {
                  "properties": {
                    "additionalProperty": {
                      "textValue": "example",
                      "numericValue": 1,
                      "numericWithUnitsValue": {
                        "numeric": 1,
                        "units": "example"
                      },
                      "multiTextValue": {
                        "values": [
                          "example"
                        ]
                      },
                      "moneyValue": {
                        "amount": "example",
                        "currencyCode": "example"
                      },
                      "multiObjectValue": {}
                    }
                  }
                }
              ]
            },
            "versionId": "example",
            "updatedAt": "2026-04-15T12:00:00Z",
            "submittedAt": "2026-04-15T12:00:00Z"
          }
        ],
        "updatedAt": "2026-04-15T12:00:00Z",
        "sales": [
          {
            "strikeThroughPrice": 1,
            "salePrice": 1,
            "startAt": "2026-04-15T12:00:00Z",
            "endAt": "2026-04-15T12:00:00Z"
          }
        ]
      },
      "logistics": {
        "enabled": true,
        "attributes": [
          {
            "id": "example",
            "textValue": "example",
            "numericValue": 1,
            "numericWithUnitsValue": {
              "numeric": 1,
              "units": "example"
            },
            "multiTextValue": {
              "values": [
                "example"
              ]
            },
            "moneyValue": {
              "amount": "example",
              "currencyCode": "example"
            },
            "multiObjectValue": {
              "items": [
                {
                  "properties": {
                    "additionalProperty": {
                      "textValue": "example",
                      "numericValue": 1,
                      "numericWithUnitsValue": {
                        "numeric": 1,
                        "units": "example"
                      },
                      "multiTextValue": {
                        "values": [
                          "example"
                        ]
                      },
                      "moneyValue": {
                        "amount": "example",
                        "currencyCode": "example"
                      },
                      "multiObjectValue": {}
                    }
                  }
                }
              ]
            },
            "versionId": "example",
            "updatedAt": "2026-04-15T12:00:00Z",
            "submittedAt": "2026-04-15T12:00:00Z"
          }
        ],
        "updatedAt": "2026-04-15T12:00:00Z"
      }
    }
  ],
  "createdAt": "2026-04-15T12:00:00Z",
  "updatedAt": "2026-04-15T12:00:00Z"
}

default

Section titled “default”

An unexpected error response.

Media typeapplication/json
object
code
integer format: int32
message
string
details
Array<object>
object
@type
string
key
additional properties
Examplegenerated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Sourceapi-proto@2d6ee309 via [email protected]

Builtf1d143e6

This page describes the source document as deployed: the version listing pinned in its release r2026.10.30.08. A change merged upstream shows up here once it has deployed and the pins are next refreshed.

API changelog