Skip to content

Price Groups

Named price levels within a catalog (for example Retail, Wholesale). Each vendor is assigned one.

Operations

List price groups

Request

Returns the price groups defined on a catalog. name is the key used in each catalog item's pricing object.

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

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

curl -i -X GET \
  'https://docs.orderwerks.com/_mock/openapi/v1/catalog/{catalogGuid}/price_groups' \
  -H 'x-apiKey: YOUR_API_KEY_HERE' \
  -H 'x-apiSecret: YOUR_API_KEY_HERE'

Responses

The catalog's price groups.

Bodyapplication/json
priceGroupsArray of objectsrequired
Response
{
  "priceGroups": [
    {
      "id": 0,
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "name": "Wholesale",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}