AppsThemesSupport

Product

🔒

Requires product access scope.

Product Properties

FieldsTypeDesc
idstringThe ID of the product.
titlestringThe title of the product, limited to 1-255 characters
briefstringSubtitle, limited to 600 characters
descriptionstringDescription, supports rich text editing
publishedbooleanReturns true if the product is published. Returns false if not.
requires_shippingbooleanReturns true if the product needs shipping. Returns false if not.
taxablebooleanReturns true if taxes should be charged on the product. Returns false if not.
tagsstringThe tags of the product, separated by commas
vendorstringThe vendor of the product, limited to 100 characters
vendor_urlstringThe vendor URL of the product, limited to 1000 characters
inventory_quantityintegerTotal inventory quantity of the product, sum of all variants' inventory_quantity.
published_atstringDate and time for when the product was published, formatted as ISO-8601
created_atstringCreation time, formatted as ISO-8601
updated_atstringLast modification time, formatted as ISO-8601
notestringNote, limit of 500 characters.
seo_titlestringSEO title, limit of 5000 characters.
seo_descriptionstringSEO description, limit of 5000 characters.
seo_keywordsstringSEO keywords, separated by commas.
handlestringSEO handle
has_only_default_variantbooleanWhether it is a single style
inventory_trackingbooleanWhether to track inventory
inventory_policystringRequired 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_imageboolVariant image required, when need_variant_image is true.
spustringProduct SPU (Standard Product Unit)
display_fake_salesboolProduct sales = current real sales + virtual sales, when display_fake_sales is true.
fake_salesintegerVirtual sales
optionsarray of objectProduct styles, supports up to three styles. Required when has_only_default_variant is set to false.
option.namestringOption name, e.g., color
option.valuesarray of stringValues supported by the variant, e.g., red
imageimage Main product image
imagesarray of imageProduct images, the first image uploaded when creating the product will be set as the main product image by default.
variantsarray of variantThe variants of the product.

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
          }
        ]
      }
    ]
  }
}