Product

Product detail and variant information

Retrieve product detail page

get

Returns comprehensive product information for a detail page, including pricing, stock availability, images, videos, and variant selection options.

Response Behavior:

1. Standard Product Response

• Returns complete product data with all variant options

• Includes currently selected variant based on query parameters

• Provides pricing from default or inventory-specific price lists

2. Variant Selection

• Pass attribute keys as query parameters to pre-select variants

• System returns matching variant as selected_variant

• Variant options indicate selectable combinations

3. Automatic Redirects When a product is not directly listable, the system may redirect:

• Non-listable products redirect to their parent product

• Query parameters are preserved during redirection

• Variant attributes are included in redirect URL

4. Availability Handling

• Products marked as end-of-life with no stock return 404

• Hidden products are only visible to configured test users (Source: Dynamic/Real-time Configuration)

Path parameters

product_idintegerRequired

Unique identifier of the product to retrieve.

This ID corresponds to the product's primary key in the catalog system.

Example: 12345

Query parameters

seller_idintegerOptional

Filter product data for a specific seller.

When provided, returns seller-specific pricing and stock information. Useful for marketplace scenarios with multiple sellers offering the same product.

Example: 42

Responses

200

Product detail retrieved successfully

application/json

302

Redirect to an alternative product URL.

Occurs when:

• The requested product is not listable but has a listable parent
• The product type requires redirection to a variant

404

Product not found or not accessible.

Occurs when:

• No product exists with the specified ID
• Product is hidden and user is not authorized
• Product is marked as end-of-life with no remaining stock

get

/product/{product_id}/

HTTPcURLJavaScriptPython

GET /product/{product_id}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

{
  "in_stock": true,
  "product": {
    "pk": 12345,
    "name": "Premium Running Shoes - Blue/White",
    "sku": "SHOE-RUN-BLU-42",
    "base_code": "SHOE-RUN-BLU",
    "attributes": {
      "color": "Blue",
      "size": "42",
      "material": "Synthetic"
    },
    "attribute_set": 15,
    "attributes_kwargs": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "extra_attributes": null,
    "productimage_set": [
      {
        "pk": 98765,
        "status": "active",
        "image": "https://cdn.akinon.com/products/shoe-main.jpg",
        "order": 1,
        "thumbnail": "https://cdn.akinon.com/products/shoe-main-thumb.jpg",
        "mid_thumbnail": "https://example.com",
        "detailed_thumbnail": "https://example.com"
      }
    ],
    "productvideo_set": [
      {
        "pk": 1,
        "video_type": "text",
        "video": "https://example.com"
      }
    ],
    "price": "149.99",
    "retail_price": "199.99",
    "currency_type": "try",
    "price_type": "default",
    "tax_rate": "18.00",
    "in_stock": true,
    "stock": 25,
    "unit_type": "quantity",
    "product_type": "0",
    "absolute_url": "/products/premium-running-shoes-12345/",
    "form_schema": [
      {
        "key": "text",
        "label": "text",
        "type": "text",
        "required": true,
        "options": [
          {}
        ]
      }
    ],
    "is_ready_to_basket": true,
    "data_source": {
      "pk": 42,
      "name": "seller-123",
      "title": "Premium Electronics Store",
      "slug": "premium-electronics"
    },
    "basket_offers": [
      {}
    ],
    "is_listable": true,
    "listing_code": "SHOE-RUN-BLU"
  },
  "variants": [
    {
      "attribute_key": "size",
      "attribute_name": "Size",
      "options": [
        {
          "is_selected": true,
          "is_selectable": true,
          "is_selectable_without_stock": null,
          "in_stock": null,
          "order": "1",
          "label": "42 EU",
          "value": "42",
          "product": {
            "pk": 12345,
            "name": "Premium Running Shoes - Blue/White",
            "sku": "SHOE-RUN-BLU-42",
            "base_code": "SHOE-RUN-BLU",
            "attributes": {
              "color": "Blue",
              "size": "42",
              "material": "Synthetic"
            },
            "attribute_set": 15,
            "attributes_kwargs": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "extra_attributes": null,
            "productimage_set": [
              {
                "pk": 98765,
                "status": "active",
                "image": "https://cdn.akinon.com/products/shoe-main.jpg",
                "order": 1,
                "thumbnail": "https://cdn.akinon.com/products/shoe-main-thumb.jpg",
                "mid_thumbnail": "https://example.com",
                "detailed_thumbnail": "https://example.com"
              }
            ],
            "productvideo_set": [
              {
                "pk": 1,
                "video_type": "text",
                "video": "https://example.com"
              }
            ],
            "price": "149.99",
            "retail_price": "199.99",
            "currency_type": "try",
            "price_type": "default",
            "tax_rate": "18.00",
            "in_stock": true,
            "stock": 25,
            "unit_type": "quantity",
            "product_type": "0",
            "absolute_url": "/products/premium-running-shoes-12345/",
            "form_schema": [
              {
                "key": "text",
                "label": "text",
                "type": "text",
                "required": true,
                "options": [
                  {}
                ]
              }
            ],
            "is_ready_to_basket": true,
            "data_source": {
              "pk": 42,
              "name": "seller-123",
              "title": "Premium Electronics Store",
              "slug": "premium-electronics"
            },
            "basket_offers": [
              {}
            ],
            "is_listable": true,
            "listing_code": "SHOE-RUN-BLU"
          }
        }
      ]
    }
  ],
  "selected_variant": {
    "pk": 12345,
    "name": "Premium Running Shoes - Blue/White",
    "sku": "SHOE-RUN-BLU-42",
    "base_code": "SHOE-RUN-BLU",
    "attributes": {
      "color": "Blue",
      "size": "42",
      "material": "Synthetic"
    },
    "attribute_set": 15,
    "attributes_kwargs": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "extra_attributes": null,
    "productimage_set": [
      {
        "pk": 98765,
        "status": "active",
        "image": "https://cdn.akinon.com/products/shoe-main.jpg",
        "order": 1,
        "thumbnail": "https://cdn.akinon.com/products/shoe-main-thumb.jpg",
        "mid_thumbnail": "https://example.com",
        "detailed_thumbnail": "https://example.com"
      }
    ],
    "productvideo_set": [
      {
        "pk": 1,
        "video_type": "text",
        "video": "https://example.com"
      }
    ],
    "price": "149.99",
    "retail_price": "199.99",
    "currency_type": "try",
    "price_type": "default",
    "tax_rate": "18.00",
    "in_stock": true,
    "stock": 25,
    "unit_type": "quantity",
    "product_type": "0",
    "absolute_url": "/products/premium-running-shoes-12345/",
    "form_schema": [
      {
        "key": "text",
        "label": "text",
        "type": "text",
        "required": true,
        "options": [
          {}
        ]
      }
    ],
    "is_ready_to_basket": true,
    "data_source": {
      "pk": 42,
      "name": "seller-123",
      "title": "Premium Electronics Store",
      "slug": "premium-electronics"
    },
    "basket_offers": [
      {}
    ],
    "is_listable": true,
    "listing_code": "SHOE-RUN-BLU"
  },
  "offers": [
    {
      "pk": 1,
      "name": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "attribute_set": 1,
      "attributes_kwargs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "extra_attributes": null,
      "price": "text",
      "in_stock": true,
      "data_source": {
        "pk": 1,
        "name": "text",
        "title": "text"
      },
      "absolute_url": "https://example.com"
    }
  ]
}

Retrieve product variant information

get

Returns variant selection data for a product, including all available attribute combinations.

Purpose: This endpoint is optimized for scenarios where you need variant data without the full product detail response. Useful for:

• Variant selector widgets

• Quick attribute filtering

• Lightweight variant queries

Behavior:

• If the product is not listable, automatically uses the parent product

• Always passes stock check (returns all variants regardless of availability)

• Returns same variant structure as product detail endpoint

Path parameters

product_idintegerRequired

Unique identifier of the product

Example: 12345

Responses

200

Product variant data retrieved successfully

application/json

404

Product not found

get

/product/{product_id}/variants/

HTTPcURLJavaScriptPython

GET /product/{product_id}/variants/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

{
  "in_stock": true,
  "product": {
    "pk": 12345,
    "name": "Premium Running Shoes - Blue/White",
    "sku": "SHOE-RUN-BLU-42",
    "base_code": "SHOE-RUN-BLU",
    "attributes": {
      "color": "Blue",
      "size": "42",
      "material": "Synthetic"
    },
    "attribute_set": 15,
    "attributes_kwargs": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "extra_attributes": null,
    "productimage_set": [
      {
        "pk": 98765,
        "status": "active",
        "image": "https://cdn.akinon.com/products/shoe-main.jpg",
        "order": 1,
        "thumbnail": "https://cdn.akinon.com/products/shoe-main-thumb.jpg",
        "mid_thumbnail": "https://example.com",
        "detailed_thumbnail": "https://example.com"
      }
    ],
    "productvideo_set": [
      {
        "pk": 1,
        "video_type": "text",
        "video": "https://example.com"
      }
    ],
    "price": "149.99",
    "retail_price": "199.99",
    "currency_type": "try",
    "price_type": "default",
    "tax_rate": "18.00",
    "in_stock": true,
    "stock": 25,
    "unit_type": "quantity",
    "product_type": "0",
    "absolute_url": "/products/premium-running-shoes-12345/",
    "form_schema": [
      {
        "key": "text",
        "label": "text",
        "type": "text",
        "required": true,
        "options": [
          {}
        ]
      }
    ],
    "is_ready_to_basket": true,
    "data_source": {
      "pk": 42,
      "name": "seller-123",
      "title": "Premium Electronics Store",
      "slug": "premium-electronics"
    },
    "basket_offers": [
      {}
    ],
    "is_listable": true,
    "listing_code": "SHOE-RUN-BLU"
  },
  "variants": [
    {
      "attribute_key": "size",
      "attribute_name": "Size",
      "options": [
        {
          "is_selected": true,
          "is_selectable": true,
          "is_selectable_without_stock": null,
          "in_stock": null,
          "order": "1",
          "label": "42 EU",
          "value": "42",
          "product": {
            "pk": 12345,
            "name": "Premium Running Shoes - Blue/White",
            "sku": "SHOE-RUN-BLU-42",
            "base_code": "SHOE-RUN-BLU",
            "attributes": {
              "color": "Blue",
              "size": "42",
              "material": "Synthetic"
            },
            "attribute_set": 15,
            "attributes_kwargs": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "extra_attributes": null,
            "productimage_set": [
              {
                "pk": 98765,
                "status": "active",
                "image": "https://cdn.akinon.com/products/shoe-main.jpg",
                "order": 1,
                "thumbnail": "https://cdn.akinon.com/products/shoe-main-thumb.jpg",
                "mid_thumbnail": "https://example.com",
                "detailed_thumbnail": "https://example.com"
              }
            ],
            "productvideo_set": [
              {
                "pk": 1,
                "video_type": "text",
                "video": "https://example.com"
              }
            ],
            "price": "149.99",
            "retail_price": "199.99",
            "currency_type": "try",
            "price_type": "default",
            "tax_rate": "18.00",
            "in_stock": true,
            "stock": 25,
            "unit_type": "quantity",
            "product_type": "0",
            "absolute_url": "/products/premium-running-shoes-12345/",
            "form_schema": [
              {
                "key": "text",
                "label": "text",
                "type": "text",
                "required": true,
                "options": [
                  {}
                ]
              }
            ],
            "is_ready_to_basket": true,
            "data_source": {
              "pk": 42,
              "name": "seller-123",
              "title": "Premium Electronics Store",
              "slug": "premium-electronics"
            },
            "basket_offers": [
              {}
            ],
            "is_listable": true,
            "listing_code": "SHOE-RUN-BLU"
          }
        }
      ]
    }
  ],
  "selected_variant": {
    "pk": 12345,
    "name": "Premium Running Shoes - Blue/White",
    "sku": "SHOE-RUN-BLU-42",
    "base_code": "SHOE-RUN-BLU",
    "attributes": {
      "color": "Blue",
      "size": "42",
      "material": "Synthetic"
    },
    "attribute_set": 15,
    "attributes_kwargs": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "extra_attributes": null,
    "productimage_set": [
      {
        "pk": 98765,
        "status": "active",
        "image": "https://cdn.akinon.com/products/shoe-main.jpg",
        "order": 1,
        "thumbnail": "https://cdn.akinon.com/products/shoe-main-thumb.jpg",
        "mid_thumbnail": "https://example.com",
        "detailed_thumbnail": "https://example.com"
      }
    ],
    "productvideo_set": [
      {
        "pk": 1,
        "video_type": "text",
        "video": "https://example.com"
      }
    ],
    "price": "149.99",
    "retail_price": "199.99",
    "currency_type": "try",
    "price_type": "default",
    "tax_rate": "18.00",
    "in_stock": true,
    "stock": 25,
    "unit_type": "quantity",
    "product_type": "0",
    "absolute_url": "/products/premium-running-shoes-12345/",
    "form_schema": [
      {
        "key": "text",
        "label": "text",
        "type": "text",
        "required": true,
        "options": [
          {}
        ]
      }
    ],
    "is_ready_to_basket": true,
    "data_source": {
      "pk": 42,
      "name": "seller-123",
      "title": "Premium Electronics Store",
      "slug": "premium-electronics"
    },
    "basket_offers": [
      {}
    ],
    "is_listable": true,
    "listing_code": "SHOE-RUN-BLU"
  },
  "offers": [
    {
      "pk": 1,
      "name": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "attribute_set": 1,
      "attributes_kwargs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "extra_attributes": null,
      "price": "text",
      "in_stock": true,
      "data_source": {
        "pk": 1,
        "name": "text",
        "title": "text"
      },
      "absolute_url": "https://example.com"
    }
  ]
}

Retrieve miscellaneous product by SKU

get

Returns product information for a miscellaneous product identified by SKU.

Miscellaneous Products: Special product types that are:

• Identified by SKU rather than ID

• Not part of regular product listings

• Used for services, fees, or special items

Examples:

• Gift wrapping service

• Extended warranty

• Shipping fees

• Custom services

Requirements:

• Product must be of type "miscellaneous"

• Product must be active

• SKU must match exactly

Path parameters

skustringRequired

Stock Keeping Unit (SKU) of the miscellaneous product.

SKUs can contain alphanumeric characters and hyphens.

Example: GIFT-WRAP-PREMIUMPattern: ^[\w-]+$

Responses

200

Miscellaneous product retrieved successfully

application/json

404

Product not found.

Occurs when:

• No product exists with the specified SKU
• Product is not of type "miscellaneous"
• Product is not active

get

/misc-product/{sku}/

HTTPcURLJavaScriptPython

GET /misc-product/{sku}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

{
  "pk": 12345,
  "name": "Premium Running Shoes - Blue/White",
  "sku": "SHOE-RUN-BLU-42",
  "base_code": "SHOE-RUN-BLU",
  "attributes": {
    "color": "Blue",
    "size": "42",
    "material": "Synthetic"
  },
  "attribute_set": 15,
  "attributes_kwargs": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "extra_attributes": null,
  "productimage_set": [
    {
      "pk": 98765,
      "status": "active",
      "image": "https://cdn.akinon.com/products/shoe-main.jpg",
      "order": 1,
      "thumbnail": "https://cdn.akinon.com/products/shoe-main-thumb.jpg",
      "mid_thumbnail": "https://example.com",
      "detailed_thumbnail": "https://example.com"
    }
  ],
  "productvideo_set": [
    {
      "pk": 1,
      "video_type": "text",
      "video": "https://example.com"
    }
  ],
  "price": "149.99",
  "retail_price": "199.99",
  "currency_type": "try",
  "price_type": "default",
  "tax_rate": "18.00",
  "in_stock": true,
  "stock": 25,
  "unit_type": "quantity",
  "product_type": "0",
  "absolute_url": "/products/premium-running-shoes-12345/",
  "form_schema": [
    {
      "key": "text",
      "label": "text",
      "type": "text",
      "required": true,
      "options": [
        {}
      ]
    }
  ],
  "is_ready_to_basket": true,
  "data_source": {
    "pk": 42,
    "name": "seller-123",
    "title": "Premium Electronics Store",
    "slug": "premium-electronics"
  },
  "basket_offers": [
    {}
  ],
  "is_listable": true,
  "listing_code": "SHOE-RUN-BLU"
}