Products

Get a product

Fetch the full record for a single retail product, including its inventory link, pricing and metadata. Returns 404 if the ID is not visible to the caller's site scope.

get/shop/products/{productId}

Response

A product response object.

Example response

{
  "data": {
    "name": "Dan's Hand Moisturiser",
    "currency": "gbp",
    "description": "For silky soft hands",
    "product_code": "MAS123",
    "price_from": 1000,
    "price_to": 5000,
    "standard_price": 5000,
    "image": {
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "tags": [
      {
        "name": "Moisturisers"
      }
    ],
    "categories": [
      {
        "name": "Moisturisers"
      }
    ],
    "price_rules": [
      {
        "date_from": "2020-02-01",
        "date_to": "2020-04-01",
        "price": 20000
      }
    ],
    "revenue_centre": "spa",
    "customer_cancellation_permitted": "allowed",
    "customer_cancellation_min_duration": "P7D"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.