Product Object

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

{
  "description": "The most amazing t shirt ever sold",
  "external_id": "KTP9XGbSg2",
  "id": "IakdKbiUiK",
  "images": [
    {
      "alt": "Image of fancy shirt",
      "url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
    }
  ],
  "name": "Amazing T-shirt",
  "options": [
    {
      "choices": [
        {
          "id": "db3je27rg7",
          "value": "45"
        }
      ],
      "id": "WMd1xylGrp",
      "name": "Shirt size"
    }
  ],
  "prices": [
    {
      "compare_at_price": "19.99",
      "currency": "USD",
      "price": "12.34"
    }
  ],
  "seo": {
    "description": "Amazing T-shirt made with 100% biologic cotton",
    "product_url": "amazing-t-shirt",
    "title": "Amazing T-shirt"
  },
  "sku": "UGG-BB-PUR-06",
  "status": "ACTIVE",
  "variations": [
    {
      "external_id": "KTP9XGbSg2",
      "id": "KTP9XGbSg2",
      "images": [
        {
          "alt": "Image of fancy shirt",
          "url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
        }
      ],
      "options": [
        {
          "choice_id": "db3je27rg7",
          "choice_value": "45",
          "option_id": "WMd1xylGrp",
          "option_name": "Shirt size"
        }
      ],
      "price_difference": "string",
      "quantity": 25,
      "sku": "UGG-BB-PUR-06",
      "status": "ACTIVE",
      "stock_status": "IN_STOCK, OUT_OF_STOCK"
    }
  ]
}

product_details

Property

Description

Mutable

description string

A description of the product.

Yes

external_id
string

External product identifier for reference

No

id
string

A unique identifier for the product.

No

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 details

Yes

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 INACTIVE.

Yes

images

Property

Description

Mutable

alt string

Description of the image.

Yes

url
string

The url of the image.

Yes

prices

Property

Description

Mutable

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

Property

Description

Mutable

description string

The meta description of the product. Should be around 155 characters in length.

Yes

product_url
string

The path / URL to a product in the store.

Yes

title
string

Set the <title> for this product. Should be less than 60 characters in length.

Yes

options

Property

Description

Mutable

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 details

Yes

choices

Property

Description

Mutable

id string

A unique identifier for the choice.

No

value
string

The value of the choice.

Yes