iotoms Docs

List customer stores

GET
/api/v1/ops/customer-stores

Returns customer stores filtered by status (default ACTIVE), city, name, customerNumber and linkState; filters combine. Use linkState=UNLINKED to find stores not yet linked to a customer account, or customerNumber to list every store belonging to one customer.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

status?array<string>

One or more statuses to include: ACTIVE, INACTIVE, ARCHIVED, DELETED. Repeat the parameter for several. Unrecognised values are ignored; defaults to ACTIVE.

city?string

Return only stores whose city contains this text (case-insensitive).

name?string

Return only stores whose name contains this text (case-insensitive).

customerNumber?string

Return only stores linked to this customer account (exact match).

linkState?string

LINKED for stores tied to a customer account, UNLINKED for stores not yet linked. Any other value is rejected with 400.

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?array<>|

Customer stores matching the filters. Not paginated.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/ops/customer-stores'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "id": 0,      "name": "string",      "ownerName": "string",      "ownerPhone": "string",      "ownerEmail": "string",      "addressLine1": "string",      "addressLine2": "string",      "city": "string",      "state": "string",      "postalCode": "string",      "country": "string",      "latitude": 0.1,      "longitude": 0.1,      "creditLimit": 0,      "customerNumber": "string",      "executiveNotes": "string",      "photoUrl": "string",      "status": "ACTIVE",      "modifiedTime": "2019-08-24T14:15:22Z"    }  ]}