Skip to main content
GET
/
facilities
/
{ref}
Get a single facility
curl --request GET \
  --url https://api.simcel.io/master/v1/facilities/{ref} \
  --header 'Authorization: Bearer <token>'
{
  "ref": "<string>",
  "name": "<string>",
  "type": "Customer",
  "channel": "<string>",
  "subChannel": "<string>",
  "region": "<string>",
  "country": "<string>",
  "city": "<string>",
  "keyAccount": true,
  "status": "Active",
  "shipTo": "<string>",
  "groups": [
    "<string>"
  ],
  "latitude": 123,
  "longitude": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
ref
string
required

Query Parameters

​
workspaceId
string
required

The workspace ID to query master data from

Response

Facility details

​
ref
string

Unique facility reference key

​
name
string
​
type
enum<string>
Available options:
Customer,
SecondaryCustomer,
Distributor,
DC
​
channel
string
​
subChannel
string
​
region
string
​
country
string

ISO 3166-1 alpha-2 country code

​
city
string
​
keyAccount
boolean
​
status
enum<string>
Available options:
Active,
Inactive
​
shipTo
string
​
groups
string[]
​
latitude
number
​
longitude
number