Product Object

Get products page. Default page response size is 50, max requested page size is 100.

{
    "id": "9GKhf8CC",
    "name": "Handmade Wooden Bowl",
    "type": "PHYSICAL",
    "description": "<p>Describe the product here, and don’t be shy! Tell visitors about the product’s unique benefits and advantages. Why is this product special? Why is it better than other products that are similar to it? Give enough details so that people who decide to buy it know exactly what to expect.</p>",
    "seo": {
        "product_url": "handmade-wooden-bowl",
        "title": "",
        "description": ""
    },
    "status": "ACTIVE",
    "sku": "5",
    "images": [
        {
            "alt": "",
            "url": "https://irp.cdn-website.com/md/dmtmpl/3aab5dd2-0715-4745-b747-f971788f6128/dms3rep/multi/wooden-design-salad-bowl.jpg"
        },
        {
            "alt": "",
            "url": "https://irp.cdn-website.com/md/dmtmpl/3aab5dd2-0715-4745-b747-f971788f6128/dms3rep/multi/wooden-design-salad-bowl-view2.jpg"
        }
    ],
    "prices": [
        {
            "currency": "USD",
            "price": "39.0",
            "compare_at_price": null
        }
    ],
    "external_id": null,
    "options": [
        {
            "id": "NREbMtmV",
            "name": "Size",
            "choices": [
                {
                    "id": "ylRZFdZO",
                    "value": "Small"
                },
                {
                    "id": "hBYWgptv",
                    "value": "Medium"
                },
                {
                    "id": "PZL9uGzl",
                    "value": "large"
                }
            ]
        }
    ],
    "variations": [
        {
            "sku": null,
            "images": [],
            "options": [
                {
                    "option_id": "NREbMtmV",
                    "option_name": "Size",
                    "choice_id": "ylRZFdZO",
                    "choice_value": "Small"
                }
            ],
            "quantity": 0,
            "status": "ACTIVE",
            "external_id": null,
            "price_difference": "0.0",
            "id": "AmENwM4V"
        },
        {
            "sku": null,
            "images": [],
            "options": [
                {
                    "option_id": "NREbMtmV",
                    "option_name": "Size",
                    "choice_id": "hBYWgptv",
                    "choice_value": "Medium"
                }
            ],
            "quantity": 0,
            "status": "ACTIVE",
            "external_id": null,
            "price_difference": "0.0",
            "id": "nx1ZG9EK"
        },
        {
            "sku": null,
            "images": [],
            "options": [
                {
                    "option_id": "NREbMtmV",
                    "option_name": "Size",
                    "choice_id": "PZL9uGzl",
                    "choice_value": "large"
                }
            ],
            "quantity": 0,
            "status": "ACTIVE",
            "external_id": null,
            "price_difference": "0.0",
            "id": "VGxTGqUu"
        }
    ],
    "managed_inventory": true,
    "custom_fields": [
      {
        "value": "This is a tagline",
        "id": "01J44P3PR742P3MRJ11HRT43Q2"
      },{
        "value": "https://example.org/path/to/image.png",
        "id": "01J44R3PO363P3VBE11IEE35Q1",
        "image": {
          "alt": "Alt text for the image",
          "url": "https://example.org/path/to/image.png"
        }
      }
    ],
    "categories": [
        {
            "id": "a1xcgrXw",
            "title": "Dining room",
            "order": 4
        }
    ],
    "requires_shipping": true
}

product

PropertyDescriptionMutable
description
string
A description of the product.Yes
external_id
string
External product identifier for referenceNo
id
string
A unique identifier for the product.No
type
enum
The type of product. Can be: PHYSICAL, DIGITAL, SERVICE, or DONATION.Yes
images
object[]
Contains images and image details for the product. Must pass all data when making any changes to this property. See the section below for details.Yes
name
string
The name of the product.Yes
options
string
Options for the product. Will be used to generate product variations. See the section below for detailsYes
prices
object[]
Contains the pricing details of the product. Must pass all data when making any changes to this property. See the section below for details.Yes
seo
object
Contains the seo properties of the object. See the section below for details.Yes
sku
string
The stock-keeping unit of the product.Yes
status
string
The status of the product. Can be either ACTIVE or HIDDEN.Yes
managed_inventory
boolean
Does the product have managed inventory? e.g., a set number of products in stock.Yes
custom_fields
array of objects
An array of custom fields assigned to the product.Yes
variations
array of objects
An array of variations. Variants represent an option/choice combination that can be specifically purchased on it's own.No
categories
array of objects
An array of categories the product is assigned to. No
requires_shipping
boolean
A flag that indicates if the product is shippable. Yes

images

PropertyDescriptionMutable
alt
string
Description of the image.Yes
url
string
The URL of the image.Yes

prices

PropertyDescriptionMutable
compare_at_price
string
The comparative price of the product. The difference between the product's discounted price and original price.Yes
currency
string
Specified currency of the product.Yes
price
string
Actual price of the product.Yes

seo

PropertyDescriptionMutable
description
string
The meta description of the product. Should be around 155 characters in length.Yes
product_url
string
The path / slug to a product in the store.Yes
title
string
Set the for this product. Should be less than 60 characters in length.Yes

options

PropertyDescriptionMutable
id
string
A unique identifier for the option.No
name
string
The name of the option.Yes
choices
array
An array of choices for the option. See the section below for detailsYes

choices

PropertyDescriptionMutable
id
string
A unique identifier for the choice.No
value
string
The value of the choice.Yes

custom_fields


PropertyDescriptionMutable
id
string
A unique identifier for the custom fieldNo
value
string
The value of the custom fieldYes
image
object
An object describing the value of an image custom field type. This object is only accepted if the custom field is of type image. The format is the same as the base images object on the product with an alt and url property. The url property will always match the value property.Yes

variations

PropertyDescriptionMutable
id
string
A unique identifier for the variant.No
sku
string
The specific SKU for the variant.Yes
images
array of objects
The same image object as product.Yes
options
array of objects
An array of options & choices combinations that make up the variant.No
quantity
number
The number of items in stock.Yes
status
enum
The status of a product. Can be: HIDDEN or ACTIVE. Yes
external_id
string
A custom string from your platform that represents the variation.Yes
price_difference
string
The difference of the variant price, as compared to the parent product. Can be positive or negative.Yes