Get a single customer - Hellgate Cloud Platform

GET

customers

{id}

Get a single customer

curl --request GET \
  --url https://commerce1.on-hellgate.dev/customers/{id} \
  --header 'X-API-Key: <api-key>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "address": {
    "city": "<string>",
    "country_code": "<string>",
    "line_1": "<string>",
    "postal_code": "<string>",
    "state": "<string>",
    "line_2": "<string>"
  },
  "description": "<string>",
  "email": "<string>",
  "tax_settings": {
    "tax_id": "<string>"
  }
}

Authorizations

X-API-Key

string

header

required

Headers

X-Account-ID

string

Identifies the account. Required when authenticating via mTLS — omit when using an API key (account is inferred from the key).

Path Parameters

string

required

Customer ID

Response

Success

string<uuid>

required

name

string

required

address

AddressSchema · object

Show child attributes

description

string

tax_settings

TaxSettingsSchema · object

Show child attributes

Update a customer

⌘I

Get a single customer

curl --request GET \
  --url https://commerce1.on-hellgate.dev/customers/{id} \
  --header 'X-API-Key: <api-key>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "address": {
    "city": "<string>",
    "country_code": "<string>",
    "line_1": "<string>",
    "postal_code": "<string>",
    "state": "<string>",
    "line_2": "<string>"
  },
  "description": "<string>",
  "email": "<string>",
  "tax_settings": {
    "tax_id": "<string>"
  }
}