Skip to content
/
List catalog items (legac...

List catalog items (legacy path)
deprecated

Request

Legacy alias of GET /v1/catalog/{catalogGuid}/catalog_items. Same parameters and response; use the new path.

Security
(ApiKey and ApiSecret) or (UserGuid and UserToken and SupplierGuid)
Path
catalogGuidstring, (uuid)required

GUID of the catalog. Must belong to the authenticated supplier.

Query
limitinteger, [ 1 .. 100 ]

Number of rows per page.

Default:25
offsetinteger, >= 0

Zero-based page number. The server skips offset * limit rows.

Default:0
lastUpdatedAtstring

Delta-sync cursor. Pass the serverTimestamp returned by the previous call to receive only rows created, updated or soft-deleted since then (deleted rows carry deleted_at). Accepts ISO-8601 (2026-09-01T14:00:00.000Z) or YYYY-MM-DD HH:mm:ss (treated as UTC). The server re-fetches a 60-second overlap window to absorb clock skew. An unparsable value returns 400 with code: INVALID_DELTA_CURSOR.

Example:lastUpdatedAt=2026-09-01T14:00:00.000Z
skipTotalCountstring
Enum:"true""false"
skipCategoryRetrievalstring
Enum:"true""false"
includeAttributesstring
Enum:"true""false"
Headers
vendorGuidstring, (uuid)

GUID of the customer (vendor) to act for. With API key authentication this selects the customer context; with user session headers it is the vendor the user is acting on behalf of.

curl -i -X GET \
  'https://docs.orderwerks.com/_mock/openapi/v1/{catalogGuid}/catalogItems?limit=25&offset=0&lastUpdatedAt=2026-09-01T14%3A00%3A00.000Z&skipTotalCount=true&skipCategoryRetrieval=true&includeAttributes=true' \
  -H 'vendorGuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-apiKey: YOUR_API_KEY_HERE' \
  -H 'x-apiSecret: YOUR_API_KEY_HERE'

Responses

A page of catalog items.

Bodyapplication/json
catalog_itemsArray of objects(CatalogItem)required
totalCatalogItemsintegerrequired

Total items in the catalog (0 when skipTotalCount=true).

hasMoreItemsbooleanrequired
resourcestringrequired
Example:"catalog_items"
serverTimestampstring, (date-time)

Pass back as lastUpdatedAt on the next call for delta sync.

Response
{
  "catalog_items": [
    {
      "id": 0,
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "catalog_id": 0,
      "category_id": 0,
      "sku": "string",
      "upc": "string",
      "name": "string",
      "description": "string",
      "manufacturer": "string",
      "color": "string",
      "style": "string",
      "active": true,
      "is_taxable": true,
      "msrp": 0,
      "cost_per_uom": 0,
      "pricing": { … },
      "has_inventory": true,
      "qty_on_hand": 0,
      "qty_incoming": 0,
      "reserved_qty_on_hand": 0,
      "qty_backordered": 0,
      "qty_held_for_backorders": 0,
      "min_qty_on_hand": 0,
      "max_qty_on_hand": 0,
      "min_order_qty": 0,
      "allow_backorder": true,
      "qty_break": 0,
      "qty_break_price": 0,
      "has_serials": true,
      "has_lots": true,
      "has_exp_date": true,
      "width": 0,
      "height": 0,
      "depth": 0,
      "item_weight": 0,
      "shipping_weight": 0,
      "is_product_group": true,
      "product_group_type": "flat",
      "product_group_display_style": "string",
      "group_parent_catalog_item_id": 0,
      "group_sequence": 0,
      "group_title": "string",
      "subsection_id": 0,
      "third_party_sku": "string",
      "third_party_pricing": "string",
      "third_party_size": "string",
      "Category": { … },
      "CategoryHierarchy": [ … ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z"
    }
  ],
  "totalCatalogItems": 0,
  "hasMoreItems": true,
  "resource": "catalog_items",
  "serverTimestamp": "2019-08-24T14:15:22Z"
}