Object

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

{
  "description": "The most amazing t shirt ever sold",
  "images": [
    {
      "alt": "Image of fancy shirt",
      "url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
    }
  ],
  "name": "Amazing T-shirt",
  "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"
}

product_details

PropertyDescriptionMutable
description
string
A description of the product.Yes
id
string
A unique identifier for the product.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
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

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

prices

PropertyDescriptionMutable
compare_at_price
number
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
number
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 / URL to a product in the store.Yes
title
string
Set the for this product. Should be less than 60 characters in length.Yes