Skip to content
Esc
↑↓navigate↵open⌘Jpreview

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/v1/{app_id}/customer-groups/store-groups/{store_group_id}/markets/{market_id}/prices
Authorization
AuthorizationAPI key · headerrequired

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

Path parameters
app_idstringrequired

uuid of the app

store_group_idstringrequired

uuid of the store group

market_idstringrequired

uuid of the market

Query parameters
user_idstring

uuid of the user (mutually exclusive with organisation_id)

organisation_idstring

uuid of the organisation (mutually exclusive with user_id)

parent_numberstring[]

filter by parent product number (repeatable)

pageinteger

Page number

default: 1
per_pageinteger

Number of prices per page

default: 10
Responses
200

Customer groups with nested paginated prices

customer_groupsCustomerGroupPrices[]
Show properties
Array of CustomerGroupPrices
app_idstring
created_atstring
discount_percentageinteger
discount_percentage_decimalsinteger
idstring
namestring
pricesCustomerGroupProductPrice[]
Show properties
Array of CustomerGroupProductPrice
created_atstring
idstring
price_amountnumber
product_numberstring
product_variant_idstring
updated_atstring
variant_numberstring
slugstring
store_group_idstring
typestring
updated_atstring
pageinteger
page_sizeinteger
total_itemsinteger
total_pagesinteger
400

Invalid request

detailsstring[] | null
messagestring
successboolean
401

Unauthorized access

detailsstring[] | null
messagestring
successboolean
500

Internal server error

detailsstring[] | null
messagestring
successboolean
Try it
Server
Authorization
Parameters
Request
curl -X GET '//customers.enad.io/api/v1/string/customer-groups/store-groups/string/markets/string/prices' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "customer_groups": [
    {
      "app_id": "string",
      "created_at": "string",
      "discount_percentage": 0,
      "discount_percentage_decimals": 0,
      "id": "string",
      "name": "string",
      "prices": [
        {
          "created_at": "string",
          "id": "string",
          "price_amount": 0,
          "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": 0,
  "page_size": 0,
  "total_items": 0,
  "total_pages": 0
}