Retrieve product listings that are published to your app

请求参数

Path 参数

api_version

string

必需

Query 参数

collection_id

string

可选

Filter by products belonging to a particular collection

handle

string

可选

Filter by product handle

limit

string

可选

Amount of results

product_ids

string

可选

A comma-separated list of product ids

updated_at_min

string

可选

Filter by product listings last updated after a certain date and time (formatted in ISO 8601)

返回响应

🟢200Retrieve product listings that are published to your app

application/json

Body

product_listings

array[object (ProductListing) {13}]

可选

product_id

string

只读可选

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

body_html

string

只读可选

The description of the product, complete with HTML formatting.

created_at

string

只读可选

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

handle

string

只读可选

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

images

string

只读可选

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

示例值:

{"src":"http://example.com/burton.jpg"}

options

string

只读可选

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

示例值:

{"name":"Title"}

product_type

string

只读可选

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

published_at

string

只读可选

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

tags

string

只读可选

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

title

string

只读可选

The name of the product.

updated_at

string

只读可选

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

variants

string

只读可选

A list of variant objects, each one representing a slightly different version of the product. For example, if a product comes in different sizes and colors, each size and color permutation (such as "small black", "medium black", "large blue"), would be a variant.

To reorder variants, update the product with the variants in the desired order. The position attribute on the variant will be ignored.

barcode: The barcode, UPC or ISBN number for the product.
compare_at_price: The competitor's price for the same item.
created_at: The date and time when the product variant was created. The API returns this in ISO 8601.
fulfillment_service: Service which is handling fulfillment. Valid values are: manual, gift_card, or the handle of a FulfillmentService.
grams: The weight of the product variant in grams.
weight: The weight of the product variant in the unit system specified with weight_unit.
weight_unit: The unit system that the product variant's weight is measure in. The weight_unit can be either "g", "kg, "oz", or "lb".
id: The unique numeric identifier for the product variant.
inventory_management: Specifies whether or not Shopify tracks the number of items in stock for this product variant.
inventory_policy: Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock.
inventory_quantity: The number of items in stock for this product variant.
metafield: Attaches additional information to a shop's resources.
option: Custom properties that a shop owner can use to define product variants. Multiple options can exist. Options are represented as: option1, option2, option3, etc.
position: The order of the product variant in the list of product variants. 1 is the first position. To reorder variants, update the product with the variants in the desired order. The position attribute on the variant will be ignored.
price: The price of the product variant.
product_id: The unique numeric identifier for the product.
requires_shipping: Specifies whether or not a customer needs to provide a shipping address when placing an order for this product variant.
sku: A unique identifier for the product in the shop.
taxable: Specifies whether or not a tax is charged when the product variant is sold.
title: The title of the product variant.
updated_at: The date and time when the product variant was last modified. The API returns this in ISO 8601.

vendor

string

只读可选

The name of the vendor of the product.

示例

{
  "product_listings": [
    {
      "product_id": 632910392,
      "created_at": "2023-01-03T12:05:09-05:00",
      "updated_at": "2023-01-03T12:05:09-05:00",
      "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>",
      "handle": "ipod-nano",
      "product_type": "Cult Products",
      "title": "IPod Nano - 8GB",
      "vendor": "Apple",
      "available": true,
      "tags": "Emotive, Flash Memory, MP3, Music",
      "published_at": "2017-08-31T20:00:00-04:00",
      "variants": [
        {
          "id": 808950810,
          "title": "Pink",
          "option_values": [
            {
              "option_id": 594680422,
              "name": "Color",
              "value": "Pink"
            }
          ],
          "price": "199.00",
          "formatted_price": "$199.00",
          "compare_at_price": null,
          "grams": 567,
          "requires_shipping": true,
          "sku": "IPOD2008PINK",
          "barcode": "1234_pink",
          "taxable": true,
          "position": 1,
          "available": true,
          "inventory_policy": "continue",
          "inventory_quantity": 10,
          "inventory_management": "shopify",
          "fulfillment_service": "manual",
          "weight": 1.25,
          "weight_unit": "lb",
          "image_id": 562641783,
          "created_at": "2023-01-03T12:05:09-05:00",
          "updated_at": "2023-01-03T12:05:09-05:00"
        },
        {
          "id": 49148385,
          "title": "Red",
          "option_values": [
            {
              "option_id": 594680422,
              "name": "Color",
              "value": "Red"
            }
          ],
          "price": "199.00",
          "formatted_price": "$199.00",
          "compare_at_price": null,
          "grams": 567,
          "requires_shipping": true,
          "sku": "IPOD2008RED",
          "barcode": "1234_red",
          "taxable": true,
          "position": 2,
          "available": true,
          "inventory_policy": "continue",
          "inventory_quantity": 20,
          "inventory_management": "shopify",
          "fulfillment_service": "manual",
          "weight": 1.25,
          "weight_unit": "lb",
          "image_id": null,
          "created_at": "2023-01-03T12:05:09-05:00",
          "updated_at": "2023-01-03T12:05:09-05:00"
        },
        {
          "id": 39072856,
          "title": "Green",
          "option_values": [
            {
              "option_id": 594680422,
              "name": "Color",
              "value": "Green"
            }
          ],
          "price": "199.00",
          "formatted_price": "$199.00",
          "compare_at_price": null,
          "grams": 567,
          "requires_shipping": true,
          "sku": "IPOD2008GREEN",
          "barcode": "1234_green",
          "taxable": true,
          "position": 3,
          "available": true,
          "inventory_policy": "continue",
          "inventory_quantity": 30,
          "inventory_management": "shopify",
          "fulfillment_service": "manual",
          "weight": 1.25,
          "weight_unit": "lb",
          "image_id": null,
          "created_at": "2023-01-03T12:05:09-05:00",
          "updated_at": "2023-01-03T12:05:09-05:00"
        },
        {
          "id": 457924702,
          "title": "Black",
          "option_values": [
            {
              "option_id": 594680422,
              "name": "Color",
              "value": "Black"
            }
          ],
          "price": "199.00",
          "formatted_price": "$199.00",
          "compare_at_price": null,
          "grams": 567,
          "requires_shipping": true,
          "sku": "IPOD2008BLACK",
          "barcode": "1234_black",
          "taxable": true,
          "position": 4,
          "available": true,
          "inventory_policy": "continue",
          "inventory_quantity": 40,
          "inventory_management": "shopify",
          "fulfillment_service": "manual",
          "weight": 1.25,
          "weight_unit": "lb",
          "image_id": null,
          "created_at": "2023-01-03T12:05:09-05:00",
          "updated_at": "2023-01-03T12:05:09-05:00"
        }
      ],
      "images": [
        {
          "id": 850703190,
          "created_at": "2023-01-03T12:05:09-05:00",
          "position": 1,
          "updated_at": "2023-01-03T12:05:09-05:00",
          "product_id": 632910392,
          "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1672765509",
          "variant_ids": [],
          "width": 123,
          "height": 456
        },
        {
          "id": 562641783,
          "created_at": "2023-01-03T12:05:09-05:00",
          "position": 2,
          "updated_at": "2023-01-03T12:05:09-05:00",
          "product_id": 632910392,
          "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano-2.png?v=1672765509",
          "variant_ids": [
            808950810
          ],
          "width": 123,
          "height": 456
        },
        {
          "id": 378407906,
          "created_at": "2023-01-03T12:05:09-05:00",
          "position": 3,
          "updated_at": "2023-01-03T12:05:09-05:00",
          "product_id": 632910392,
          "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1672765509",
          "variant_ids": [],
          "width": 123,
          "height": 456
        }
      ],
      "options": [
        {
          "id": 594680422,
          "name": "Color",
          "product_id": 632910392,
          "position": 1,
          "values": [
            "Pink",
            "Red",
            "Green",
            "Black"
          ]
        }
      ]
    },
    {
      "product_id": 921728736,
      "created_at": "2023-01-03T12:05:09-05:00",
      "updated_at": "2023-01-03T12:05:09-05:00",
      "body_html": "<p>The iPod Touch has the iPhone's multi-touch interface, with a physical home button off the touch screen. The home screen has a list of buttons for the available applications.</p>",
      "handle": "ipod-touch",
      "product_type": "Cult Products",
      "title": "IPod Touch 8GB",
      "vendor": "Apple",
      "available": true,
      "tags": "",
      "published_at": "2017-08-31T20:00:00-04:00",
      "variants": [
        {
          "id": 447654529,
          "title": "Black",
          "option_values": [
            {
              "option_id": 891236591,
              "name": "Title",
              "value": "Black"
            }
          ],
          "price": "199.00",
          "formatted_price": "$199.00",
          "compare_at_price": null,
          "grams": 567,
          "requires_shipping": true,
          "sku": "IPOD2009BLACK",
          "barcode": "1234_black",
          "taxable": true,
          "position": 1,
          "available": true,
          "inventory_policy": "continue",
          "inventory_quantity": 13,
          "inventory_management": "shipwire-app",
          "fulfillment_service": "shipwire-app",
          "weight": 1.25,
          "weight_unit": "lb",
          "image_id": null,
          "created_at": "2023-01-03T12:05:09-05:00",
          "updated_at": "2023-01-03T12:05:09-05:00"
        }
      ],
      "images": [],
      "options": [
        {
          "id": 891236591,
          "name": "Title",
          "product_id": 921728736,
          "position": 1,
          "values": [
            "Black"
          ]
        }
      ]
    }
  ]
}

Retrieve product listings that are published to your app

请求参数

示例代码

返回响应