Get location by ID

get
/locations/{id}

Get a location by ID. Use the id value returned in a Location resource response, such as from GET /locations, as this path parameter.

id
string
required

Location ID. Use the id value returned in a Location resource response, such as from GET /locations, as this path parameter.

meta
Meta

The Meta model holds the metadata of the API response, including relevant error details for debugging purposes.Show all...

Example:
{"code":20000,"type":"OK","message":"The request was successfully processed by AfterShip."}
code
number
required

Error code in integer format. For detailed information, please refer to the Request Error introduction page.

Default:
20000
Example:
20000
type
string
required

Response type string for the reference. For detailed information, please refer to the Request Error introduction page.

>= 1 characters
Example:
OK
message
string
required

Human-readable response message. For detailed information, please refer to the Request Error introduction page.

>= 1 characters
Example:
The request was successfully processed by AfterShip.
errors
array[Error]

Error detail object. Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.Show all...

data
Location

A Location represents a warehouse, store, or other physical place used for fulfillment, order processing, and pickup settings. Location resources are scoped to the organization and are not bound to a store.

Example:
{"id":"warehouse_1","name":"SF Warehouse","source":"manual","address":{"company":"AfterShip","first_name":"John Doe","last_name":"","phone":"+14155551234","email":"[email protected]","street_1":"123 Main St","street_2":"Suite 100","street_3":"","city":"San Francisco","state":"CA","country_region":"USA","postal_code":"94105","coordinate":{"latitude":37.7749,"longitude":-122.4194}},"timezone_identifier":"America/New_York","opening_hours":{"sunday":{"open":false,"from":null,"to":null},"monday":{"open":true,"from":"09:00","to":"18:00"},"tuesday":{"open":true,"from":"09:00","to":"18:00"},"wednesday":{"open":true,"from":"09:00","to":"18:00"},"thursday":{"open":true,"from":"09:00","to":"18:00"},"friday":{"open":true,"from":"09:00","to":"18:00"},"saturday":{"open":false,"from":null,"to":null}},"order_processing":{"enabled":true,"order_cutoff_time":"14:00","order_processing_duration_days":0},"pickup_setting":{"enabled":true,"instructions":"Please pick up at the front desk.","order_processing_duration_seconds_min":3600,"order_processing_duration_seconds_max":7200},"created_at":"2026-01-01T00:00:00Z","updated_at":"2026-04-24T00:00:00Z"}
id
string
required

The unique identifier of the location. For locations created through Commerce API, this is the custom ID supplied when creating the location, or a system-generated UUID if no custom ID was provided. For ecommerce platform-sourced locations, the ID is returned in the format app-<platform>-<app_key>-<external_id>.

Example:
warehouse_1
name
string
required

The location name.

<= 256 characters
Example:
SF Warehouse
source
string
required

The source of the location. manual means the location was created through Commerce API. platform means the location was imported from an ecommerce platform.

Allowed values:
manualplatform
Example:
manual
address
AddressWithCoordinate
required

The physical address and contact information of the location. For Location resources, first_name and last_name are joined into one contact name on write; on read, the full contact name is returned as first_name and last_name is empty. The type field is accepted by the schema but not used for Location resources — omit it on write; on read it is always empty.

Example:
{"type":"business","street_1":"1234 Elm Street","street_2":"Apt 5","street_3":null,"city":"New York","state":"NY","postal_code":"10001","country_region":"USA","company":"My Company","first_name":"John","last_name":"Doe","email":"[email protected]","phone":"+13525554500","coordinate":{"latitude":43,"longitude":-75}}
timezone_identifier
string

The name of the timezone where the location is located, as defined by the IANA timezone database standard.

<= 256 characters
Example:
America/New_York
opening_hours
OpeningHours

The regular opening hours of the location.

order_processing
object

The order processing setting for this location.

pickup_setting
object

The pickup setting for this location.

created_at
string<date-time>
required

The date and time when the location was created in AfterShip, formatted in ISO 8601.

Example:
2026-01-01T00:00:00Z
updated_at
string<date-time>
required

The date and time when the location was updated in AfterShip, formatted in ISO 8601.

Example:
2026-04-24T00:00:00Z
Auth
:
Parameters
:
Response Example
{ "meta": { "code": 20000, "type": "OK", "message": "The request was successfully processed by AfterShip." }, "data": { "id": "warehouse_1", "name": "SF Warehouse", "source": "manual", "address": { "company": "AfterShip", "first_name": "John Doe", "last_name": "", "phone": "+14155551234", "email": "[email protected]", "street_1": "123 Main St", "street_2": "Suite 100", "street_3": "", "city": "San Francisco", "state": "CA", "country_region": "USA", "postal_code": "94105", "coordinate": { "latitude": 37.7749, "longitude": -122.4194 } }, "timezone_identifier": "America/New_York", "opening_hours": { "sunday": { "open": false, "from": null, "to": null }, "monday": { "open": true, "from": "09:00", "to": "18:00" }, "tuesday": { "open": true, "from": "09:00", "to": "18:00" }, "wednesday": { "open": true, "from": "09:00", "to": "18:00" }, "thursday": { "open": true, "from": "09:00", "to": "18:00" }, "friday": { "open": true, "from": "09:00", "to": "18:00" }, "saturday": { "open": false, "from": null, "to": null } }, "order_processing": { "enabled": true, "order_cutoff_time": "14:00", "order_processing_duration_days": 0 }, "pickup_setting": { "enabled": true, "instructions": "Please pick up at the front desk.", "order_processing_duration_seconds_min": 3600, "order_processing_duration_seconds_max": 7200 }, "created_at": "2026-01-01T00:00:00Z", "updated_at": "2026-04-24T00:00:00Z" } }