List all warehouses
Returns a paginated list of warehouses. Supports filtering by date range, country, product, and free-text search. Results can be sorted by label, country, address, city, email, telephone, postcode, or state.
Query Parameters
Page number for pagination.
Number of warehouses per page.
Sort direction.
ascdescField to sort by.
labelcountryaddresscityemailtelephone
postcodestateFree-text search across label, address, city, or contact information.
Start date filter (ISO 8601 string or Unix timestamp).
End date filter (ISO 8601 string or Unix timestamp).
Filter warehouses that stock a specific product.
Filter by warehouse country codes.
Responses
Paginated list of warehouses
Total number of warehouses matching the query.
Unique identifier of the warehouse.
Object type identifier.
Human-readable warehouse name.
Custom identifier for external system integration.
ISO country code where the warehouse is located.
Street address.
City.
Postal or ZIP code.
State or province code.
Contact email for warehouse operations.
Contact phone number.
Destination codes this warehouse can fulfill orders for.
Count of unique products with inventory in this warehouse.
Count of product variants with inventory in this warehouse.
Whether the warehouse has any notes attached.
Validation or business-logic error.
| Code | Description |
|---|---|
1002 | Referenced product not found |
Missing or invalid API key