Product Details API Examples

Simple product

Request

{
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "items": [
    {
      "id": "33",
      "quantity": 1,
    }
  ]
}

Response

{
  "request_id": "6bcaac84-2c51-42cb-af80-defe68a77b9e",
  "items": [
    {
      "id": "33",
      "title": "Strive Shoulder Pack",
      "sku": "24-MB04",
      "stock": 20,
      "image_url": "https://my-store/media/catalog/product/m/b/mb04-black-0.jpg",
      "price_cents": 3200,
      "shippable": true
    }
  ]
}

Variable product with variation products

Variable products

Learn more about handling variable products in the Product Options & Variations tutorial

Request

{
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "items": [
    {
      "id": "MJ02",
      "quantity": 1,
    }
  ]
}

Response

{
  "request_id": "af4ebaa6-7f47-4163-85af-d5b82a8cf4b0",
  "items": [
    {
      "id": "123456",
      "sku": "MJ02",
      "title": "Hyperion Elements Jacket",
      "image_url": "https://my-store/media/catalog/product/m/j/mj02-green_main_1.jpg",
      "stock": 3,
      "price_cents": 5100,
      "shippable": true,
      "options": [
        {
          "id": "144",
          "title": "Size",
          "values": [
            {
              "id": "166",
              "title": "S"
            },
            {
              "id": "170",
              "title": "L"
            }
          ]
        },
        {
          "id": "93",
          "title": "Color",
          "values": [
            {
              "id": "53",
              "title": "Red"
            },
            {
              "id": "56",
              "title": "Yellow"
            }
          ]
        }
      ],
      "variations": [
        {
          "id": "1",
          "sku": "MJ02-S-Yellow",
          "title": "Hyperion Elements Jacket-S-Yellow",
          "stock": 2,
          "image_url": "https://my-store/media/catalog/product/m/j/mj02-orange_main_1.jpg",
          "price_cents": 4200,
          "shippable": true,
          "attributes": {
            "144": "166",
            "93": "56"
          }
        },
        {
          "id": "2",
          "sku": "MJ02-L-Yellow",
          "title": "Hyperion Elements Jacket-L-Yellow",
          "stock": 2,
          "image_url": "https://my-store/media/catalog/product/m/j/mj02-orange_main_1.jpg",
          "price_cents": 4200,
          "shippable": true,
          "attributes": {
            "144": "170",
            "93": "56"
          }
        },
        {
          "id": "3",
          "sku": "MJ02-S-Red",
          "title": "Hyperion Elements Jacket-S-Red",
          "stock": 2,
          "image_url": "https://my-store/media/catalog/product/m/j/mj02-orange_main_1.jpg",
          "price_cents": 4200,
          "shippable": true,
          "attributes": {
            "144": "166",
            "93": "53"
          }
        },
        {
          "id": "4",
          "sku": "MJ02-L-Red",
          "title": "Hyperion Elements Jacket-L-Red",
          "stock": 2,
          "image_url": "https://my-store/media/catalog/product/m/j/mj02-orange_main_1.jpg",
          "price_cents": 4200,
          "shippable": true,
          "attributes": {
            "144": "170",
            "93": "53"
          }
        }
      ]
    }
  ]
}

Variable product with variation attributes

Request

{
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "items": [
    {
      "id": "MJ02",
      "quantity": 1,
    }
  ]
}

Response

{
  "request_id": "af4ebaa6-7f47-4163-85af-d5b82a8cf4b0",
  "items": [
    {
      "id": "123456",
      "sku": "MJ02",
      "title": "Hyperion Elements Jacket",
      "image_url": "https://my-store/media/catalog/product/m/j/mj02-green_main_1.jpg",
      "stock": 3,
      "price_cents": 5100,
      "shippable": true,
      "options": [
        {
          "id": "144",
          "title": "Size",
          "values": [
            {
              "id": "166",
              "title": "S"
            },
            {
              "id": "170",
              "title": "L"
            }
          ]
        },
        {
          "id": "93",
          "title": "Color",
          "values": [
            {
              "id": "53",
              "title": "Red"
            },
            {
              "id": "56",
              "title": "Yellow"
            }
          ]
        }
      ],
      "variations": [
        {
          "id": "1",
          "sku": "MJ02-S-Yellow",
          "title": "Hyperion Elements Jacket-S-Yellow",
          "stock": 2,
          "image_url": "https://my-store/media/catalog/product/m/j/mj02-orange_main_1.jpg",
          "price_cents": 4200,
          "shippable": true,
          "attributes": {
            "144": "166",
            "93": "56"
          }
        },
        {
          "id": "1",
          "sku": "MJ02-L-Yellow",
          "title": "Hyperion Elements Jacket-L-Yellow",
          "stock": 2,
          "image_url": "https://my-store/media/catalog/product/m/j/mj02-orange_main_1.jpg",
          "price_cents": 4200,
          "shippable": true,
          "attributes": {
            "144": "170",
            "93": "56"
          }
        },
        {
          "id": "1",
          "sku": "MJ02-S-Red",
          "title": "Hyperion Elements Jacket-S-Red",
          "stock": 2,
          "image_url": "https://my-store/media/catalog/product/m/j/mj02-orange_main_1.jpg",
          "price_cents": 4200,
          "shippable": true,
          "attributes": {
            "144": "166",
            "93": "53"
          }
        },
        {
          "id": "1",
          "sku": "MJ02-L-Red",
          "title": "Hyperion Elements Jacket-L-Red",
          "stock": 2,
          "image_url": "https://my-store/media/catalog/product/m/j/mj02-orange_main_1.jpg",
          "price_cents": 4200,
          "shippable": true,
          "attributes": {
            "144": "170",
            "93": "53"
          }
        }
      ]
    }
  ]
}