Skip to content

Look up catalog items by SKU

Request

Fast exact-SKU lookup within a catalog. Returns a lightweight projection; use Get a catalog item for the full record.

Security
(ApiKey and ApiSecret) or (UserGuid and UserToken and SupplierGuid)
Bodyapplication/jsonrequired
catalogGuidstring, (uuid)required
skuNamestringrequired

Exact SKU to match (case-insensitive, trimmed).

Example:"WIDGET-001"
curl -i -X POST \
  https://docs.orderwerks.com/_mock/openapi/v1/catalog_items/sku-lookup \
  -H 'Content-Type: application/json' \
  -H 'x-apiKey: YOUR_API_KEY_HERE' \
  -H 'x-apiSecret: YOUR_API_KEY_HERE' \
  -d '{
    "catalogGuid": "5c4291bd-3307-470f-9505-c1cf7a89ee66",
    "skuName": "WIDGET-001"
  }'

Responses

Matching items (empty array when none).

Bodyapplication/json
catalog_itemsArray of objectsrequired
resourcestringrequired
Example:"catalog_items"
Response
{ "catalog_items": [ { "id": 0, "name": "string", "sku": "string", "description": "string" } ], "resource": "catalog_items" }