Retrieve a single active simple product

Returns the advanced representation of a single active simple product.

Pass segment to retrieve prices and stock from a specific segment's price list and stock list. See the list operation for full details on segment-aware pricing.

get

/products_advanced/{id}/

Authorizations

AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Path parameters

idintegerRequired

The unique identifier of the product.

Query parameters

segmentintegerOptional

ID of a segment whose price list and stock list should be used.

Example: 5

Responses

200

The requested product.

application/json

An active simple product with segment-aware price, stock, currency, main category, first image, and variant attribute values.

pkintegerRequired

Unique product identifier.

Example: 12345

namestringRequired

Display name of the product.

Example: Premium Running Shoes - Blue/White

base_codestringRequired

Base product code shared across all variants of the same product.

Example: SHOE-RUN-BLU

skustringRequired

Stock Keeping Unit — unique code for this specific variant.

Example: SHOE-RUN-BLU-42

product_typestring · enumRequired

The product type. The value is the numeric code as a string.

• -1 — Pre Product
• 0 — Simple
• 1 — Product Meta
• 2 — Bundle
• 3 — Grouped
• -2 — Pre Miscellaneous
• 4 — Miscellaneous
• 5 — Offer

Possible values:

is_activebooleanRequired

Whether the product is active. Always true for this endpoint.

Example: true

pricestringRequired

Current selling price as a decimal string.

When a segment is provided, this is the price from the segment's price list. When the product has no entry on the requested price list, "0.00" is returned. When no segment is provided, the product's default price is returned.

Example: 149.99

currencystringRequired

Currency code for price.

When a segment is provided, this is the currency of the segment's price list. When no segment is provided, the product's own currency_type is returned.

Example: try

stockintegerRequired

Available stock quantity.

When a segment is provided, this is the stock from the segment's stock list. When the product has no entry on the requested stock list, 0 is returned. When no segment is provided, the product's default stock is returned.

Example: 25

categorystring · nullableOptional

Name of the product's main category. null when no main category is set.

Example: Running Shoes

product_imagestring · nullableOptional

URL of the product's first image. null when the product has no images.

Example: https://cdn.akinon.com/products/shoe-main.jpg

401

Authentication credentials were not provided or are invalid.

application/json

403

The authenticated user does not have administrator privileges.

application/json

404

The requested product does not exist.

application/json

get/products_advanced/{id}/

GET /api/remote/1/products_advanced/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 12345,
  "name": "Premium Running Shoes - Blue/White",
  "base_code": "SHOE-RUN-BLU",
  "sku": "SHOE-RUN-BLU-42",
  "product_type": "-1",
  "is_active": true,
  "price": "149.99",
  "currency": "try",
  "stock": 25,
  "category": "Running Shoes",
  "product_image": "https://cdn.akinon.com/products/shoe-main.jpg",
  "variants": {
    "Color": "Blue",
    "Size": "42"
  }
}