Get Products

GET 
/

Fetches products information. Typically used for a product page.

Request

Query Parameters

ids string
Comma separated list of product ids. Either ids or shortLinks must be provided.
Example: clad6pg5z00eu012gfz7hfm92,cl62j0yoj00a1013e3hsh3php
shortLinks string
Comma separated list of short link IDs. Either ids or shortLinks must be provided.
Example: j0s,48u
currency stringrequired
Possible values: [CAD, USD, GBP, AUD, EUR]
Currency to return product prices in.
Example: USD

Responses

200

Success

application/json

Schema

Schema

data object
data object[]
Array [
id stringrequired
Unique product identifier.
currency stringrequired
Possible values: [CAD, USD, GBP, AUD, EUR]
Currency code.
name stringrequired
Product name.
description object
isRaw booleanrequired
Whether the description is in raw format.
raw stringrequired
Product description
sections object[]
Product description sections.
Array [
title stringrequired
Product description section title.
htmlContent stringrequired
Product description section HTML content.
]
brand object
publicId stringrequired
Brand public id.
name stringrequired
Brand name.
logo object
url stringrequired
Source of image.
width floatnullable
Image height.
height floatnullable
Image height.
merchant object
publicId stringrequired
Merchant public id.
name stringrequired
Merchant name.
variants object[]required
Array of product variants
Array [
id stringrequired
The ID of the product variant.
productId stringrequired
Id of the main product.
sku stringnullable
The item SKU (stock keeping unit).
compareAtPrice floatnullable
Original product price if on sale, otherwise null.
position floatrequired
Position of this variant compared to all other variants (the variant index in this array).
price floatrequired
The price of this item.
inventoryQuantity floatrequired
Inventory of product.
options object[]required
Array [
type stringrequired
Option name.
value stringrequired
Option value.
]
images object[]required
Array [
url stringrequired
Source of image.
width floatnullable
Image height.
height floatnullable
Image height.
]
isFinalSale booleannullable
Final sale flag if known. Null if unknown
gtin stringnullable
GTIN if available; null otherwise
]
images object[]
Array [
contentfulId string
Contentful image id.
title string
Some title.
url stringrequired
Source of image.
format string
Image format
width floatnullable
Image height.
height floatnullable
Image height.
size floatnullable
Image height.
]
publicId stringrequired
Public id added to product as custom data.
type string
Product type.
unavailable booleanrequired
Product availability in widget
gender stringnullable
Gender
hasFreeShipping boolean
Free shipping flag
reviews object
totalRatings floatnullable
Product total ratings
starRating floatnullable
Product star ratings
merchantCountry string
Merchant country
inventory floatrequired
Inventory of product.
categories string[]
Categories of the product; Can be empty array too.
productURL string
Url for product on merchant site
isAfterpayEligible boolean
Afterpay eligibility flag
shortLinks string[]
shippingCosts object[]required
Shipping costs for the product
Array [
countryCode stringrequired
shippingRate floatrequired
freeIfPassedSubtotal float
]
returnPolicy stringrequired
return policy for the product
]
errors object[]
Array [
id stringrequired
Unique identifier for error. Can be used for tracing across services.
status floatrequired
HTTP status code.
code stringrequired
Unique code for specific error.
title stringrequired
Short description what the error entails.
]

Example (from schema)

{
  "data": {
    "data": [
      {
        "id": "9597879817",
        "currency": "USD",
        "name": "T-shirt",
        "description": {
          "isRaw": true,
          "raw": "## Description\n Lorem ipsum ...",
          "sections": [
            {
              "title": "Ingredients",
              "htmlContent": "<p>An empty, refillable palette to use with Anastasia Eyeshadows</p>"
            }
          ]
        },
        "brand": {
          "publicId": "cjzyvjb930017n8s563uqn8cy",
          "name": "Virgin Club",
          "logo": {
            "url": "http://www.3in1design.com/wp-content/uploads/2016/05/blank_tshirt.jpg",
            "width": 200,
            "height": 200
          }
        },
        "merchant": {
          "publicId": "cjzyvjb930017n8s563uqn8cy",
          "name": "Bonsai-Merchant"
        },
        "variants": [
          {
            "id": "1234-M-Black",
            "productId": "1234",
            "sku": "sku2345",
            "compareAtPrice": 25.6,
            "position": 0,
            "price": 15,
            "inventoryQuantity": 10,
            "options": [
              {
                "type": "size",
                "value": "L"
              }
            ],
            "images": [
              {
                "url": "http://www.3in1design.com/wp-content/uploads/2016/05/blank_tshirt.jpg",
                "width": 200,
                "height": 200
              }
            ],
            "isFinalSale": true,
            "gtin": "00012345678905"
          }
        ],
        "images": [
          {
            "contentfulId": "4jMIZT1PmS7DIChrlKIZ3j",
            "title": "Image title",
            "url": "http://www.3in1design.com/wp-content/uploads/2016/05/blank_tshirt.jpg",
            "format": "image/jpeg",
            "width": 200,
            "height": 200,
            "size": 200
          }
        ],
        "publicId": "cjld2cyuq0000t3rmniod1foy",
        "type": "Tops",
        "unavailable": true,
        "gender": "unisex",
        "hasFreeShipping": true,
        "reviews": {
          "totalRatings": 0,
          "starRating": 0
        },
        "merchantCountry": "US",
        "inventory": 10,
        "categories": [
          "tshirt"
        ],
        "productURL": "https://www.store.com/footwear/sneakers/nice_shoe_you_want",
        "isAfterpayEligible": true,
        "shortLinks": [
          "abc"
        ],
        "shippingCosts": [
          {
            "countryCode": "string",
            "shippingRate": 0,
            "freeIfPassedSubtotal": 0
          }
        ],
        "returnPolicy": "string"
      }
    ],
    "errors": [
      {
        "id": "123e4567-e89b-12d3-a456-426655440000",
        "status": 400,
        "code": "USER_NOT_FOUND",
        "title": "Error occurred trying to create a new order"
      }
    ]
  }
}

400

400 - Bad request

application/json

Schema

Schema

errors object[]
Array [
status floatrequired
detail stringnullablerequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "status": 400,
      "detail": "",
      "title": "Bad input request"
    }
  ]
}

401

401 - Unauthorized

application/json

Schema

Schema

errors object[]
Array [
status floatrequired
detail stringnullablerequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "status": 401,
      "detail": "",
      "title": "Authentication information is missing or invalid"
    }
  ]
}

404

404 - Not found

application/json

Schema

Schema

errors object[]
Array [
status floatrequired
detail stringnullablerequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "status": 404,
      "detail": "",
      "title": "Not Found"
    }
  ]
}

5XX

500 - Unknown error

application/json

Schema

Schema

errors object[]
Array [
status floatrequired
detail stringnullablerequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "detail": "",
      "title": "Unknown error"
    }
  ]
}

Loading...