Accessing SalesGroups

In order to access SalesGroups available to you, you can use any of the following endpoints:

Endpoint	Description
GET /sales_groups (opens new window)	Returns a list of all SalesGroups available to you
GET /sales_groups/{sales_group_id} (opens new window)	Returns the SalesGroup with the provided sales_group_id

The exclusive attribute of a sales group

Any given sales group has a boolean attribute called exclusive. If it's true it means that this sales group is exclusive, which only allows you to order items together that belong to this specific SalesGroup.

If you want to order goods using an exclusive sales group, you have to set the exclusive_sales_group_id on the Order to the id of the SalesGroup.

Usually this will be used when your Organization has access to sales groups of a different organization, e.g. if you are ordering on behalf of a customer of yours that has their own prices with the Supplier.

API Example

Example Request

GET /sales_groups

Example Response

[
  {
    "id": "42dcbaf6-e557-4423-96bc-707ebbc223c0",
    "currency": "EUR",
    "exclusive": false,
    "name": "Bounty Soap Default Sales Group",
    "supplier": {
      "id": "a8b99fd3-a790-4366-85b0-2df4af0ca000",
      "display_name": "Bounty Soap",
      "brand_color": null,
      "logo_url": null,
      "links": [
        {
          "rel": "self",
          "href": "/consumers/api/v1/suppliers/bounty_soap"
        }
      ]
    },
    "created_at": "2020-11-18T14:54:52.494Z",
    "updated_at": "2021-02-04T10:25:46.442Z"
  },
  {
    "id": "d096992b-9332-4773-924d-c5a864473ecc",
    "currency": "EUR",
    "exclusive": true,
    "name": "Bounty Soap Default Exclusive Group",
    "supplier": {
      "id": "a8b99fd3-a790-4366-85b0-2df4af0ca000",
      "display_name": "Bounty Soap",
      "brand_color": null,
      "logo_url": null,
      "links": [
        {
          "rel": "self",
          "href": "/consumers/api/v1/suppliers/bounty_soap"
        }
      ]
    },
    "created_at": "2020-11-18T14:54:52.558Z",
    "updated_at": "2020-11-18T14:54:52.558Z"
  }
]