ProductListing

Version 2019-10

Sales Channel SDK

The ProductListing resource is available to Sales Channel SDK applications only.

A ProductListing resource represents a Product which is available to your sales channel. Merchants can make products available to your sales channel directly from their Shopify admin.

You can use this resource to retrieve products that a merchant has published and display them to customers in your marketplace for sale.

A ProductListing resource itself is unable to have its attributes modified directly. The attributes of a ProductListing are inherited from the Product resource to which it is associated. Therefore, all attributes of a ProductListing should be considered read-only.

A product can have one of the following statuses: active, draft, or archived. Draft and archived are considered non-active statuses. If you create a listing for a non-active product, then the product won't be published immediately. You must change the product status to active to make the product available on a sales channel.

If the product is sold exclusively on subscription, then you can create a listing for the product only on an online store.

What you can do with ProductListing

The Shopify API lets you do the following with the ProductListing resource. More detailed versions of these general actions may be available:

ProductListing properties

product_id
read-only
"product_id": 1053727709

The unique identifer of the product this listing is for. The primary key for this resource.

body_html
read-only
"body_html": "It's the small iPod with a big idea: Video."

The description of the product, complete with HTML formatting.

created_at
read-only
"created_at": "2012-02-15T15:12:21-05:00"

The date and time when the product was created. The API returns this in ISO 8601.

handle
read-only
"handle": "ipod-nano"

A human-friendly unique string for the Product automatically generated from its title.

images
read-only
"images": [
  {
    "src": "http://example.com/burton.jpg"
  }
]

A list of image objects, each one representing an image associated with the product.

options
read-only
"options": [
  {
    "name": "Title"
  }
]

Custom product property names like "Size", "Color", and "Material".

product_type
read-only
"product_type": "Cult Products"

A categorization that a product can be tagged with, commonly used for filtering.

published_at
read-only
"published_at": "2007-12-31T19:00:00-05:00"

The date and time when the product was published. The API returns this in ISO 8601.

tags
read-only
"tags": "Emotive, Flash Memory, MP3, Music"

A categorization that a product can be tagged with, commonly used for filtering.

title
read-only
"title": "IPod Nano - 8GB"

The name of the product.

updated_at
read-only
"updated_at": "2012-08-24T14:01:47-04:00"

The date and time when the product was last modified. The API returns this in ISO 8601.

variants
read-only
"variants": {
  "barcode": "1234_pink",
  "compare_at_price": null,
  "created_at": "2012-08-24T14:01:47-04:00",
  "fulfillment_service": "manual",
  "grams": 567,
  "weight": 0.2,
  "weight_unit": "kg",
  "id": 808950810,
  "inventory_management": "shopify",
  "inventory_policy": "continue",
  "inventory_quantity": 10,
  "option1":