iotoms Docs

Get a customer store

GET
/api/v1/ops/customer-stores/{id}

Returns one customer store (a shop you sell or deliver to) by its numeric ID, with its address, GPS position, credit limit, status and linked customer account.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*integer

ID of the record.

Formatint64

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?

The customer store as it is now stored.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/ops/customer-stores/0'
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"  }}