Customer Groups

Get customer groups with paginated prices for a user or organisation

Returns customer groups accessible to the given user (direct + organisations + ancestor organisations) OR to the given organisation (direct + ancestor organisations), for the given store group. Exactly one of user_id or organisation_id must be provided. Product variant customer group prices for the given market are paginated and nested under their customer group. Repeat parent_number to filter prices to variants under any of the given parent product numbers.

GET

api

{app_id}

customer-groups

store-groups

{store_group_id}

markets

{market_id}

prices

Error

A valid request URL is required to generate request examples

{
  "customer_groups": [
    {
      "app_id": "<string>",
      "created_at": "<string>",
      "discount_percentage": 123,
      "discount_percentage_decimals": 123,
      "id": "<string>",
      "name": "<string>",
      "prices": [
        {
          "created_at": "<string>",
          "id": "<string>",
          "price_amount": 123,
          "product_number": "<string>",
          "product_variant_id": "<string>",
          "updated_at": "<string>",
          "variant_number": "<string>"
        }
      ],
      "slug": "<string>",
      "store_group_id": "<string>",
      "type": "<string>",
      "updated_at": "<string>"
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_items": 123,
  "total_pages": 123
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Authorizations

Authorization

string

header

required

Bearer token (format: "Bearer {token}")

Path Parameters

app_id

string

required

uuid of the app

store_group_id

string

required

uuid of the store group

market_id

string

required

uuid of the market

Query Parameters

user_id

string

uuid of the user (mutually exclusive with organisation_id)

organisation_id

string

uuid of the organisation (mutually exclusive with user_id)

parent_number

string[]

filter by parent product number (repeatable)

page

integer

default:1

Page number

per_page

integer

default:10

Number of prices per page

Response

Customer groups with nested paginated prices

customer_groups

object[]

Show child attributes

page

integer

page_size

integer

total_items

integer

total_pages

integer

Error

A valid request URL is required to generate request examples

{
  "customer_groups": [
    {
      "app_id": "<string>",
      "created_at": "<string>",
      "discount_percentage": 123,
      "discount_percentage_decimals": 123,
      "id": "<string>",
      "name": "<string>",
      "prices": [
        {
          "created_at": "<string>",
          "id": "<string>",
          "price_amount": 123,
          "product_number": "<string>",
          "product_variant_id": "<string>",
          "updated_at": "<string>",
          "variant_number": "<string>"
        }
      ],
      "slug": "<string>",
      "store_group_id": "<string>",
      "type": "<string>",
      "updated_at": "<string>"
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_items": 123,
  "total_pages": 123
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Management API

Shopper API

Customers API

Digital Assets Management API

Get customer groups with paginated prices for a user or organisation

Authorizations

Path Parameters

Query Parameters

Response