Get Channel Listing

GET

https://api.bigcommerce.com/stores/:store_hash/v3/channels/:channel_id/listings/:listing_id

GET

/stores/:store_hash/v3/channels/:channel_id/listings/:listing_id

curl https://api.bigcommerce.com/stores/store_hash/v3/channels/1/listings/1 \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "data": {
    "channel_id": 667159,
    "listing_id": 882998595,
    "product_id": 80,
    "state": "active",
    "name": "Orbit Terrarium - Large",
    "description": "The same terrarium, but not a [Sample]",
    "date_created": "2021-05-24T17:46:33Z",
    "date_modified": "2021-05-24T17:46:33Z",
    "variants": [
      {
        "channel_id": 667159,
        "product_id": 80,
        "variant_id": 64,
        "state": "active",
        "name": "Terrarium with dinosaur",
        "date_created": "2021-05-24T17:46:33Z",
        "date_modified": "2021-05-24T17:46:33Z"
      },
      {
        "channel_id": 667159,
        "product_id": 80,
        "variant_id": 65,
        "state": "active",
        "name": "Terrarium with fish",
        "date_created": "2021-05-24T17:46:33Z",
        "date_modified": "2021-05-24T17:46:33Z"
      }
    ]
  },
  "meta": {}
}

Returns a Channel Listing for a specific channel. We recommend using this endpoint for non-storefront channels like marketplaces, marketing channels, and point of sale (POS) channels.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Channel Listings	modify	`store_channel_listings`
Channel Listings	read-only	`store_channel_listings_read_only`
Channel Settings	modify	`store_channel_settings`
Channel Settings	read-only	`store_channel_settings_read_only`
Sites & Routes	modify	`store_sites`
Sites & Routes	read-only	`store_sites_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

channel_idlongRequired

The ID of a channel.

listing_idlongRequired

The ID of a channel listing.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Response

The requested channel listing.

dataobjectOptional

metaobjectOptional

Response metadata.

Errors

404

Not Found Error