Locations

Warehouse and fulfillment locations

All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.

List locations

GET/api/v1/locations

Responses

200 Location list

GET/api/v1/locations

List locations

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/locations

Create a location

POST/api/v1/locations

Request body

Field	Type	Description
name	string
type	string
address	Address
is_default	boolean
metadata	object

{
  "name": "Jane Doe",
  "type": "string",
  "address": {
    "name": "Jane Doe",
    "company": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province": "string",
    "provinceCode": "string",
    "zip": "94107",
    "country": "string",
    "countryCode": "string",
    "phone": "string",
    "email": "jane@example.com"
  },
  "is_default": true,
  "metadata": {}
}

Responses

201 Location created

POST/api/v1/locations

Create a location

API key (Bearer token)

Request body (JSON){ "name": "Jane Doe", "type": "string", "address": { "name": "Jane Doe", "company": "string", "address1": "string", "address2": "string", "city": "string", "province": "string", "provinceCode": "string", "zip": "94107", "country": "string", "countryCode": "string", "phone": "string", "email": "jane@example.com" }, "is_default": true, "metadata": {} }

https://api-test.orderly-hub.com/api/v1/locations

Sync locations from a bridge (grab-warehouses)

POST/api/v1/locations/sync/{bridgeId}

Parameters

Name	In	Required	Type	Description
bridgeId	path	yes	string

Responses

200 Sync result

POST/api/v1/locations/sync/{bridgeId}

Sync locations from a bridge (grab-warehouses)

API key (Bearer token)

bridgeId * (path)

Request body (JSON)

https://api-test.orderly-hub.com/api/v1/locations/sync/

Get location details

GET/api/v1/locations/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Location details

GET/api/v1/locations/{id}

Get location details

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/locations/

Update a location

PATCH/api/v1/locations/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

{}

Responses

200 Location updated

PATCH/api/v1/locations/{id}

Update a location

API key (Bearer token)

id * (path)

Request body (JSON){}

https://api-test.orderly-hub.com/api/v1/locations/

Delete a location

DELETE/api/v1/locations/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Location deleted

DELETE/api/v1/locations/{id}

Delete a location

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/locations/