Skip to main content
GET
/
products
/
{id}
Get product
curl --request GET \
  --url https://store.salesive.com/api/v1/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "price": 123,
  "description": "<string>",
  "currency": "<string>",
  "category": "<string>",
  "status": "<string>",
  "images": [
    "<string>"
  ],
  "addons": [
    {
      "name": "<string>",
      "price": 123,
      "maxQuantity": 2,
      "available": true,
      "_id": "<string>",
      "description": "<string>",
      "image": "<string>"
    }
  ],
  "variants": [
    {
      "sku": "<string>",
      "options": {},
      "stock": 1
    }
  ]
}
Retrieves a single product by its ID, scoped to the store, with shop, currency and category populated. Returns 404 if the product does not exist in this store. Requires the READ_INVENTORY scope.

Authorizations

Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Path Parameters

id
string
required

Product's MongoDB identifier or slug.

Response

Product detail response.

id
string
required

Unique product identifier.

name
string
required

Display name of the product.

price
number<float>
required

Unit price for the product.

itemType
enum<string>

Catalog item type.

Available options:
product,
food,
service
catalogType
enum<string>

Catalog response type for the current storefront.

Available options:
product,
food,
service
description
string

Rich description of the product.

currency
string

ISO currency code for the product price.

category
string

Identifier of the category the product belongs to.

status
string

Derived status such as active or archived.

images
string<uri>[]

Optional list of image URLs for the product.

addons
object[]

Available add-ons for food catalog items.

variants
object[]

Optional list of variant definitions for the product.