Skip to content
/
Get a catalog item

Get a catalog item

Request

Returns one catalog item with its category, attachments, options and attributes.

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

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

catalogItemGuidstring, (uuid)required

GUID of the catalog item.

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/catalog/{catalogGuid}/catalog_items/{catalogItemGuid}' \
  -H 'vendorGuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-apiKey: YOUR_API_KEY_HERE' \
  -H 'x-apiSecret: YOUR_API_KEY_HERE'

Responses

The catalog item.

Bodyapplication/json
catalog_itemobject(CatalogItem)required

A product. With API key authentication the paged list endpoint returns exactly the fields below; other endpoints (and user session calls) return the full model, which has many more optional fields.

resourcestringrequired
Example:"catalog_item"
Response
{
  "catalog_item": {
    "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": {
      "Retail": 99.99,
      "Wholesale": 79.99,
      "Distributor": "N/A"
    },
    "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": {
      "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"
    },
    "CategoryHierarchy": [
      { … }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z"
  },
  "resource": "catalog_item"
}