Skip to content

Catalogs

A catalog is a priced product list. Every catalog item, price group and order belongs to one catalog.

Operations

List catalogs

Request

Returns the catalogs visible to the caller. Supplier users see every catalog; a customer context (vendorGuid) narrows the list to the catalogs that customer may order from.

Security
(ApiKey and ApiSecret) or (UserGuid and UserToken and SupplierGuid)
Query
vendorGuidstring, (uuid)

Customer context, as an alternative to the vendorGuid header.

onlyActivestring

Return active catalogs only.

Enum:"true""false"
checkIfHasCategoriesstring

Also return catalogsDetails with a hasCategories flag per catalog.

Enum:"true""false"
includeDeletedPriceGroupsstring

Include soft-deleted price groups under each catalog.

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/catalogs?vendorGuid=497f6eca-6276-4993-bfeb-53cbbbba6f08&onlyActive=true&checkIfHasCategories=true&includeDeletedPriceGroups=true' \
  -H 'vendorGuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-apiKey: YOUR_API_KEY_HERE' \
  -H 'x-apiSecret: YOUR_API_KEY_HERE'

Responses

The catalogs.

Bodyapplication/json
catalogsArray of objects(Catalog)required
resourcestringrequired
Example:"Catalog"
catalogsDetailsArray of objects

Present when checkIfHasCategories=true.

Response
{
  "catalogs": [
    {
      "id": 0,
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "supplier_id": 0,
      "name": "Main Catalog",
      "email": "string",
      "version": "string",
      "active": true,
      "order_item_type_id": 0,
      "currency_id": 0,
      "order_prefix_override": "string",
      "last_inventory_update": "2019-08-24T14:15:22Z",
      "Price_Groups": [ … ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "resource": "Catalog",
  "catalogsDetails": [
    {
      "catalogGuid": "5c4291bd-3307-470f-9505-c1cf7a89ee66",
      "catalogName": "string",
      "catalogId": 0,
      "hasCategories": true
    }
  ]
}