This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Get a Customer Group

Production Env

http://127.0.0.1:3658/m1/543334-505232-default

GET

/admin/customer-groups/{id}

Retrieve a Customer Group by its ID. You can expand the customer group's relations or select the fields that should be returned.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://127.0.0.1:3658/m1/543334-505232-default/admin/customer-groups/'

Response Example

200 - Example 1

{
    "customer_group": {
        "id": "cgrp_01G8ZH853Y6TFXWPG5EYE81X63",
        "name": "VIP",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "customers": [
            {}
        ],
        "price_lists": [
            {}
        ],
        "metadata": {
            "car": "white"
        }
    }
}

Request

Path Params

Query Params

Responses

🟢200OK

application/json

Body

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2024-05-20 07:45:58

List Customer Groups

Delete a Customer Group