Read one product

GET /products/ on the WISEPIM Public API: one product with its attribute values and category ids. Requires products:read.

GET /api/public/v1/products/{product_id}

Read one product

cURL

curl --request GET \
  --url https://wisepim.com/api/public/v1/products/{product_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": 123,
  "sku": "<string>",
  "name": "<string>",
  "name_long": "<string>",
  "name_localized": {},
  "description_localized": {},
  "short_description_localized": {},
  "status": "<string>",
  "product_type": "<string>",
  "category_ids": [
    123
  ],
  "attributes": [
    {
      "code": "<string>",
      "label": "<string>",
      "type": "<string>",
      "value": "<unknown>",
      "unit": "<string>"
    }
  ],
  "version": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "ean": "<string>",
  "upc": "<string>",
  "manufacturer_part_number": "<string>",
  "brand": "<string>",
  "description": "<string>",
  "short_description": "<string>",
  "parent_id": 123,
  "family": {
    "id": 123,
    "code": "<string>",
    "name": "<string>"
  },
  "price": "<string>",
  "special_price": "<string>",
  "special_price_start_date": "2023-11-07T05:31:56Z",
  "special_price_end_date": "2023-11-07T05:31:56Z",
  "main_image": "<string>",
  "meta_title": "<string>",
  "meta_description": "<string>",
  "meta_keywords": "<string>"
}

Authorizations

Authorization · string · header · required

Use a project API key from Settings > API Access. Send it as Authorization: Bearer wpk_.... See authentication and scopes for setup and permissions.

Path Parameters

product_id · integer · required

Response

200

application/json

OK

id · integer · required

sku · string · required

name · string · required

name_long · string · required

name_localized · Name Localized · object · required

description_localized · Description Localized · object · required

short_description_localized · Short Description Localized · object · required

status · string · required

product_type · string · required

category_ids · integer[] · required

attributes · AttributeValueOut · object[] · required

Show child attributes

version · integer · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

ean · string | null

upc · string | null

manufacturer_part_number · string | null

brand · string | null

description · string | null

short_description · string | null

parent_id · integer | null

family · FamilyRefOut · object | null

Show child attributes

price · string | null

Decimal string, e.g. "19.99".

special_price · string | null

Decimal string, e.g. "14.99".

special_price_start_date · string<date-time> | null

special_price_end_date · string<date-time> | null

main_image · string | null

meta_title · string | null

meta_description · string | null

meta_keywords · string | null