Retrieve a specific product listing that is published to your app

返回响应

🟢200Retrieve a specific product listing that is published to your app

application/json

Body

product_listing

object (ProductListing)

可选

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_listing": {
    "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 a specific product listing that is published to your app

请求参数

示例代码

返回响应