Product Properties

🔒
Requires product access scope.

Product properties

Fields	Type	Desc
id	string	The ID of the product.
title	string	The title of the product, limited to 1-255 characters
brief	string	Subtitle, limited to 600 characters
description	string	Description, supports rich text editing
published	boolean	`true` if the product is published. Returns `false` if not.
requires_shipping	boolean	Set to `true` if the product is a physical item that needs to be delivered to a customer. Set to `false` for digital products, services, or items that do not involve shipping.
taxable	boolean	The taxable field indicates whether a product requires tax calculation, which is unlike tax-included pricing where taxes are already added to the product price. `true` if taxes should be charged on the product. Returns `false` if not.
tags	string	The tags of the product, separated by commas
vendor	string	The vendor of the product, limited to 100 characters It is applicable in scenarios like product creation, supply chain management and categorization.
vendor_url	string	The vendor URL of the product, limited to 1000 characters
inventory_quantity	integer	Total inventory quantity of the product, sum of all variants' inventory_quantity.
published_at	string	The last Date and time for when the product was published, formatted as ISO-8601
created_at	string	The first Creation time, formatted as ISO-8601
updated_at	string	Last modification time, formatted as ISO-8601
note	string	Note, limit of 500 characters.
seo_title	string	SEO title, limit of 5000 characters.
seo_description	string	SEO description, limit of 5000 characters.
seo_keywords	string	SEO keywords, separated by commas.
handle	string	SEO handle
has_only_default_variant	boolean	`true` if the product is single-style, `false` if not.
inventory_tracking	boolean	`true` if inventory is tracked, `false` if not. It relates to the logic of whether a product or its variants can be purchased.
inventory_policy	string	Required when inventory_tracking is set to true. The following options are available: `continue`: Continue selling when out of stock `deny`: Stop selling when out of stock `auto_unpublished`: Set as draft when out of stock
need_variant_image	bool	The need_variant_image field is automatically set to true if any variant has an image; otherwise, it is set to false.
spu	string	Product SPU (Standard Product Unit)
display_fake_sales	bool	Product sales = current real sales + virtual sales, when display_fake_sales is true.
fake_sales	integer	Virtual sales
options	array of object	Product styles, supports up to three styles. Required when has_only_default_variant is set to false.
option.name	string	Option name, e.g., `color`
option.values	array of string	Values supported by the variant, e.g., `red`
image	image	Main product image
images	array of image	Product images, the first image uploaded when creating the product will be set as the main product image by default.
variants	array of variant	The variants of the product.
category	Category	The category of the product.

Fields	Type	Desc
id	integer	The ID of the category. eg: `368313940138040910`
name	string	Category name
google_id	integer	Google category id
level	integer	Level of category
path	string	The full path of a category, consisting of a category id. eg: `368313940138008142,368313940138024526,368313940138040910`

MetaFields

Fields	Type	Desc
id	string	Unique identifier for the metafield.
namespace	string	The namespace for organizing metafields
value	string	The value stored in the metafield
value_type	string	Level of category
key	string	The type of the value stored
description	string	Optional description or explanation of the metafield.

Options Object

Field	Type	Required	Example	Description
`options.name`	`string`	Yes	`"Size"`	Name of the option (e.g., size).
`options.values`	`array of string`	Yes	`["S", "M", "L"]`	List of possible option values.

Wholesale Price Object

Field	Type	Required	Example	Description
`wholesale_price.price`	`string`	Yes	`"8.99"`	The wholesale price for the variant.
`wholesale_price.min_quantity`	`integer`	Yes	`10`	Minimum quantity for the price.

Example

{
  "product": {
    "id": "4c8d6a4a-f4d6-4f65-b5f3-49b500669401",
    "title": "shirt-2",
    "brief": "shirt",
    "description": "Good shirt",
    "published": false,
    "requires_shipping": true,
    "taxable": true,
    "tags": "s1,s2",
    "vendor": "shoplazza",
    "vendor_url": "https://shoplazza.com",
    "inventory_quantity": 82,
    "published_at": null,
    "created_at": "2024-04-17T02:39:05Z",
    "updated_at": "2024-04-17T02:39:05Z",
    "note": "",
    "seo_title": "seo-title",
    "seo_description": "seo-desc",
    "seo_keywords": "s1,s2",
    "handle": "shirt-2",
    "has_only_default_variant": false,
    "inventory_tracking": true,
    "inventory_policy": "continue",
    "need_variant_image": true,
    "spu": "T-S",
    "fake_sales": 10,
    "display_fake_sales": true,
    "mixed_wholesale": false,
    "image": {
      "src": "//cdn.shoplazza.com/loading.png",
      "width": 100,
      "height": 100,
      "path": "loading.png",
      "alt": ""
    },
    "images": [
      {
        "id": "671bee1a-ace7-4ee0-852d-a14a61eaa576",
        "product_id": "4c8d6a4a-f4d6-4f65-b5f3-49b500669401",
        "position": 1,
        "src": "//cdn.shoplazza.com/loading.png",
        "width": 100,
        "height": 100,
        "alt": "",
        "created_at": "2024-04-17T02:39:05Z",
        "updated_at": "2024-04-17T02:39:05Z"
      }
    ],
    "options": [
      {
        "id": "da0754b0-e06c-4218-9335-b6e2fc813aaa",
        "product_id": "4c8d6a4a-f4d6-4f65-b5f3-49b500669401",
        "position": 1,
        "name": "size",
        "values": [
          "S",
          "L"
        ]
      },
      {
        "id": "6d0417a1-72ad-41b9-ad63-d1d04567c599",
        "product_id": "4c8d6a4a-f4d6-4f65-b5f3-49b500669401",
        "position": 2,
        "name": "color",
        "values": [
          "blue",
          "red"
        ]
      },
      {
        "id": "237ee09d-b1f2-46dc-9d2f-8ac81d854447",
        "product_id": "4c8d6a4a-f4d6-4f65-b5f3-49b500669401",
        "position": 3,
        "name": "type",
        "values": [
          "T",
          "S"
        ]
      }
    ],
    "variants": [
      {
        "id": "26ba6b35-b464-4da2-9692-38581a057341",
        "product_id": "4c8d6a4a-f4d6-4f65-b5f3-49b500669401",
        "image_id": "671bee1a-ace7-4ee0-852d-a14a61eaa576",
        "created_at": "2024-04-17T02:39:05Z",
        "updated_at": "2024-04-17T02:39:05Z",
        "title": "S-red-T",
        "option1": "S",
        "option2": "red",
        "option3": "T",
        "image": {
          "src": "//cdn.shoplazza.com/loading.png",
          "width": 100,
          "height": 100,
          "path": "loading.png",
          "alt": ""
        },
        "position": 1,
        "compare_at_price": "10.10",
        "price": "10.10",
        "sku": "sku1",
        "barcode": "6929000212340",
        "note": "note",
        "inventory_quantity": 82,
        "weight": "0.70",
        "weight_unit": "kg",
        "cost_price": "10.10",
        "wholesale_price": [
          {
            "price": "10.10",
            "min_quantity": 1
          }
        ]
      }
    ]
  }
}

Requires product access scope.

Product properties

Category

MetaFields

Options Object

Wholesale Price Object

Example

Requires `product` access scope.