Customers
Retrieves all customers for the specified store.
The ID of the store to retrieve customers for.
411486491630370816
The maximum number of items to return in a single request.
Returns items after the specified ID. Used for forward pagination through results.
Returns items before the specified ID. Used for backward pagination through results.
Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.
GET /v1/stores/{storeId}/customers HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"profile": {
"id": "text",
"platform": "steam",
"name": "text",
"avatar_url": "text"
},
"steam_id": "76561198045784099",
"steam": {
"id": "76561198045784099",
"name": "text",
"avatar_url": "text"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch",
"avatar_url": "text"
},
"xbox_xuid": "text",
"minecraft_platform": "unknown",
"name": "m0uka",
"created_at": "2025-08-01T19:16:05.373Z",
"updated_at": "2025-08-01T19:16:05.373Z",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
]
Creates a new customer based on the fields passed.
The ID of the store to create the customer for.
411486491630370816
The Steam platform identifier (Steam ID 64) for the customer.
The Minecraft UUID for the customer.
The Xbox XUID (Xbox User ID) for the customer.
The name of the customer.
POST /v1/stores/{storeId}/customers HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 153
{
"steam_id": "text",
"minecraft_uuid": "text",
"minecraft_platform": "unknown",
"xbox_xuid": "text",
"name": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"profile": {
"id": "text",
"platform": "steam",
"name": "text",
"avatar_url": "text"
},
"steam_id": "76561198045784099",
"steam": {
"id": "76561198045784099",
"name": "text",
"avatar_url": "text"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch",
"avatar_url": "text"
},
"xbox_xuid": "text",
"minecraft_platform": "unknown",
"name": "m0uka",
"created_at": "2025-08-01T19:16:05.373Z",
"updated_at": "2025-08-01T19:16:05.373Z",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
Retrieves a customer by the ID for the specified store.
The ID of the store to retrieve the customer for.
411486491630370816
The ID of the customer.
411486491630370816
GET /v1/stores/{storeId}/customers/{customerId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"profile": {
"id": "text",
"platform": "steam",
"name": "text",
"avatar_url": "text"
},
"steam_id": "76561198045784099",
"steam": {
"id": "76561198045784099",
"name": "text",
"avatar_url": "text"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch",
"avatar_url": "text"
},
"xbox_xuid": "text",
"minecraft_platform": "unknown",
"name": "m0uka",
"created_at": "2025-08-01T19:16:05.373Z",
"updated_at": "2025-08-01T19:16:05.373Z",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
Updates an existing customer based on the fields passed.
The ID of the store to update the customer for.
411486491630370816
411486491630370816
The Steam platform identifier (Steam ID 64) for the customer.
The Minecraft UUID for the customer.
The Xbox XUID (Xbox User ID) for the customer.
The name of the customer.
PATCH /v1/stores/{storeId}/customers/{customerId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 153
{
"steam_id": "text",
"minecraft_uuid": "text",
"minecraft_platform": "unknown",
"xbox_xuid": "text",
"name": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"profile": {
"id": "text",
"platform": "steam",
"name": "text",
"avatar_url": "text"
},
"steam_id": "76561198045784099",
"steam": {
"id": "76561198045784099",
"name": "text",
"avatar_url": "text"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch",
"avatar_url": "text"
},
"xbox_xuid": "text",
"minecraft_platform": "unknown",
"name": "m0uka",
"created_at": "2025-08-01T19:16:05.373Z",
"updated_at": "2025-08-01T19:16:05.373Z",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
Generates a customer token that can be used by the Storefront (Headless) API.
The ID of the store to generate the customer token for.
411486491630370816
The ID of the customer to generate the customer token for.
411486491630370816
POST /v1/stores/{storeId}/customers/{customerId}/tokens HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"token": "text"
}
Invalidates all generated customer tokens.
The ID of the store to invalidate the customer tokens for.
411486491630370816
The ID of the customer to invalidate the customer tokens for.
411486491630370816
DELETE /v1/stores/{storeId}/customers/{customerId}/tokens HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
Looks up a customer by an external platform ID.
The ID of the store to retrieve the customer for.
411486491630370816
Looks up customer by PayNow Customer ID.
Looks up customer by Steam ID 64.
Looks up customer by a Minecraft UUID.
Looks up customer by an Xbox XUID.
Looks up customer by Minecraft Java name.
Looks up customer by Minecraft Bedrock name.
Looks up customer by a PayNow Customer Name. Name has to be explicitly set in the Customer entity - profile names won't be matched.
GET /v1/stores/{storeId}/customers/lookup HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"profile": {
"id": "text",
"platform": "steam",
"name": "text",
"avatar_url": "text"
},
"steam_id": "76561198045784099",
"steam": {
"id": "76561198045784099",
"name": "text",
"avatar_url": "text"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch",
"avatar_url": "text"
},
"xbox_xuid": "text",
"minecraft_platform": "unknown",
"name": "m0uka",
"created_at": "2025-08-01T19:16:05.373Z",
"updated_at": "2025-08-01T19:16:05.373Z",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
Creates up to 200 customers at once.
The ID of the store to create the customers for.
411486491630370816
The Steam platform identifier (Steam ID 64) for the customer.
The Minecraft UUID for the customer.
The Xbox XUID (Xbox User ID) for the customer.
The name of the customer.
POST /v1/stores/{storeId}/customers/bulk HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 155
[
{
"steam_id": "text",
"minecraft_uuid": "text",
"minecraft_platform": "unknown",
"xbox_xuid": "text",
"name": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
]
[
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"profile": {
"id": "text",
"platform": "steam",
"name": "text",
"avatar_url": "text"
},
"steam_id": "76561198045784099",
"steam": {
"id": "76561198045784099",
"name": "text",
"avatar_url": "text"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch",
"avatar_url": "text"
},
"xbox_xuid": "text",
"minecraft_platform": "unknown",
"name": "m0uka",
"created_at": "2025-08-01T19:16:05.373Z",
"updated_at": "2025-08-01T19:16:05.373Z",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
]
Was this helpful?