Search catalog items

Request

Full-text search over a catalog (name, SKU, description, UPC) with optional category, price-group and attribute filters. This is the endpoint the order-entry screens use.

When priceGroupGuid or orderGuid is given, items not offered to that price group are excluded and each item's pricing is reduced to that single price. A 12-digit numeric name performs a UPC lookup instead of a text search.

Security

(ApiKey and ApiSecret) or (UserGuid and UserToken and SupplierGuid)

Path

catalogGuidstring, (uuid)required

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

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.

Bodyapplication/jsonrequired

namestring

Search term. Matches name, SKU and description. Empty string returns the first page of the catalog.

Example:"widget"

limitinteger

Default:10

offsetinteger

Zero-based page number.

Default:0

priceGroupGuidstring, (uuid)

Return only items offered to this price group, with pricing reduced to that group's price.

orderGuidstring, (uuid)

Use the price group of this order (alternative to priceGroupGuid).

categoryGuidstring, (uuid)

categoryIdinteger

includeSubcategoriesboolean

With a category filter, also match items in its subcategories.

onlyActiveboolean

onlyWithSerialsboolean

includeTotalboolean

Populate totalCatalogItems (costs an extra count query).

includeKitItemsboolean

includeAttributesboolean

includeOptionsboolean

includeRootCategoriesboolean

Also return the catalog's root categories in categories.

ignoreProductGroupsboolean

Return individual items instead of their product groups.

singleWildcardboolean

Match PHRASE% (prefix) instead of %PHRASE% (contains).

priceRangeobject

optionsobject

Field-level search switches and attribute filters.

statestring

Opaque value echoed back in the response, for correlating concurrent requests.

curl -i -X POST \
  'https://docs.orderwerks.com/_mock/openapi/v1/catalog/{catalogGuid}/catalog_items/typeahead' \
  -H 'Content-Type: application/json' \
  -H 'vendorGuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-apiKey: YOUR_API_KEY_HERE' \
  -H 'x-apiSecret: YOUR_API_KEY_HERE' \
  -d '{
    "name": "widget",
    "limit": 10,
    "offset": 0,
    "onlyActive": true,
    "includeTotal": true,
    "priceGroupGuid": "0f5a4b1e-1c9c-4d1a-9b8e-6f4a2a3c1d10"
  }'

Responses

Matching catalog items.

Bodyapplication/json

catalog_itemsArray of objects(CatalogItem)required

resourcestringrequired

Example:"catalog_items"

totalCatalogItemsinteger

offsetinteger or null

statestring

categoriesArray of objects(Category)

Root categories, when includeRootCategories was true.

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,
  "resource": "catalog_items",
  "offset": 0,
  "state": "string",
  "categories": [
    {
      "id": 0,
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "catalog_id": 0,
      "parent_category_id": 0,
      "name": "string",
      "sequence": 0,
      "hide_category": true,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}