Product

{
  "id": "Required, the unique identifier of the product, in the format of a GraphQL global ID",
  "title": "Required, the product title",
  "vendor": "Required, the name of the product supplier",
  "productType": "Required, the type of product",
  "createdAt": "Required, the creation time of the product, in ISO 8601 format",
  "updatedAt": "Required, the update time of the product, in ISO 8601 format",
  "publishedAt": "Required, the publication time of the product, in ISO 8601 format",
  "handle": "Required, the URL handle of the product (used to generate friendly URLs)",
  "status": "Required, the status of the product (e.g., ACTIVE)",
  "tags": "Required, a list of product tags; if none, it should be an empty array",
  "bodyHtml": "Required, the HTML description content of the product",
  "collections": {
    "edges": [
      {
        "node": {
          "id": "Required, the unique identifier of the collection, in the format of a GraphQL global ID",
          "title": "Required, the collection title",
          "templateSuffix": "Optional, the suffix of the collection template; if none, it should be an empty string"
        }
      }
    ]
  },
  "media": {
    "edges": [
      {
        "node": {
          "id": "Required, the unique identifier of the media resource, in the format of a GraphQL global ID",
          "preview": {
            "image": {
              "url": "Required, the preview image URL of the media resource"
            }
          }
        }
      }
    ]
  },
  "variants": {
    "edges": [
      {
        "node": {
          "id": "Required, the unique identifier of the product variant, in the format of a GraphQL global ID",
          "price": "Required, the price of the product variant, as a string",
          "compareAtPrice": "Required, the original price of the product variant (used to show discounts), as a string",
          "image": {
            "altText": "Optional, the alternative text for the image; if none, it should be null",
            "url": "Required, the image URL of the product variant"
          },
          "sku": "Required, the SKU (Stock Keeping Unit) of the product variant",
          "title": "Required, the title of the product variant (e.g., 450G, 1KG, etc.)",
          "createdAt": "Required, the creation time of the product variant, in ISO 8601 format",
          "updatedAt": "Required, the update time of the product variant, in ISO 8601 format",
          "barcode": "Required, the barcode of the product variant",
          "inventoryQuantity": "Required, the inventory quantity of the product variant, as a number",
          "position": "Required, the sorting position of the product variant, as a number",
          "inventoryItem": {
            "id": "Required, the unique identifier of the inventory item, in the format of a GraphQL global ID",
            "unitCost": {
              "currencyCode": "Required, the currency code (e.g., USD)",
              "amount": "Required, the unit cost amount, as a string"
            },
            "variant": {
              "id": "Required, the associated product variant ID, in the format of a GraphQL global ID"
            },
            "sku": "Required, the SKU (Stock Keeping Unit) of the inventory item",
            "createdAt": "Required, the creation time of the inventory item, in ISO 8601 format",
            "updatedAt": "Required, the update time of the inventory item, in ISO 8601 format"
          },
          "unitPriceMeasurement": {
            "measuredType": "Optional, the measurement type of the unit price; if none, it should be null",
            "referenceValue": "Optional, the reference value of the unit price, as a number"
          }
        }
      }
    ]
  }
}
PreviousOrderNextEvent

Last updated

Was this helpful?