Skip to Content
API ReferenceLocations

Locations

Manage warehouse and fulfillment center locations for your organization. Locations can be created manually or synced from bridge integrations.

List Locations

GET/api/v1/locations

List all locations for the current organization.

Requiredlocations:read
curl -X GET "https://api.orderly-hub.com/api/v1/locations" \ -H "Authorization: Bearer oh_..."

Response

{ "data": [ { "id": "uuid", "name": "East Coast Warehouse", "street": "123 Fulfillment Dr", "city": "Newark", "province": "NJ", "zip": "07102", "country": "US", "bridgeId": null, "externalId": null, "createdAt": "2026-01-15T10:30:00Z", "updatedAt": "2026-01-15T10:30:00Z" } ] }

Get Location

GET/api/v1/locations/:id

Retrieve a single location by ID.

Requiredlocations:read
curl -X GET "https://api.orderly-hub.com/api/v1/locations/550e8400-e29b-41d4-a716-446655440000" \ -H "Authorization: Bearer oh_..."

Create Location

POST/api/v1/locations

Create a new location manually.

Requiredlocations:write

Request Body

FieldTypeRequiredDescription
namestringYesLocation name
streetstringNoStreet address
citystringNoCity
provincestringNoState/province
zipstringNoPostal code
countrystringNoCountry code (e.g., US)
curl -X POST "https://api.orderly-hub.com/api/v1/locations" \ -H "Authorization: Bearer oh_..." \ -H "Content-Type: application/json" \ -d '{ "name": "West Coast Warehouse", "street": "456 Distribution Ave", "city": "Los Angeles", "province": "CA", "zip": "90001", "country": "US" }'

Update Location

PATCH/api/v1/locations/:id

Update a location.

Requiredlocations:write
curl -X PATCH "https://api.orderly-hub.com/api/v1/locations/550e8400-e29b-41d4-a716-446655440000" \ -H "Authorization: Bearer oh_..." \ -H "Content-Type: application/json" \ -d '{"name": "Updated Warehouse Name"}'

Delete Location

DELETE/api/v1/locations/:id

Delete a location.

Requiredlocations:write
curl -X DELETE "https://api.orderly-hub.com/api/v1/locations/550e8400-e29b-41d4-a716-446655440000" \ -H "Authorization: Bearer oh_..."

Sync Locations from Bridge

POST/api/v1/locations/sync/:bridgeId

Sync locations from a bridge integration (e.g., grab-warehouses task).

Requiredlocations:write

Triggers the bridge’s warehouse sync task and upserts returned locations.

curl -X POST "https://api.orderly-hub.com/api/v1/locations/sync/550e8400-e29b-41d4-a716-446655440000" \ -H "Authorization: Bearer oh_..."