SellAuth

Customers

Get Customers

Retrieves the customers.

GET
/v1/shops/{shopId}/customers

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Request Body

application/jsonOptional
pageinteger
perPageinteger

Must be at least 1. Must not be greater than 100.

orderColumnstring
Value in: "id" | "email" | "discord_id" | "discord_username" | "balance" | "total_completed" | "total_spent_usd" | "last_completed_at" | "newsletter_at"
orderDirectionstring
Value in: "asc" | "desc"
idstring
emailstring
discord_idstring
discord_usernamestring
subscribedstring

Path Parameters

shopIdRequiredinteger
curl -X GET "https://api.sellauth.com/v1/shops/{shopId}/customers" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "page": 16,
    "perPage": 10,
    "orderColumn": "discord_id",
    "orderDirection": "asc",
    "id": "nostrum",
    "email": "ksauer@example.org",
    "discord_id": "et",
    "discord_username": "molestias",
    "subscribed": null
  }'

{
  "message": "No query results for model [App\\Models\\Shop] 1"
}

Edit Customer Balance

Adds or deducts balance to/from a customer in a shop.

POST
/v1/shops/{shopId}/customers/{customerId}/balance

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Request Body

application/jsonRequired
amountRequirednumber

Must be at least -1000. Must not be greater than 1000.

descriptionstring

Must not be greater than 255 characters.

Path Parameters

shopIdRequiredinteger
customerIdRequiredstring
curl -X POST "https://api.sellauth.com/v1/shops/{shopId}/customers/exercitationem/balance" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 19,
    "description": "Tenetur consequatur neque facere et."
  }'

Custom Fields

Domains