Merchanter API v1.1 - Depots
Discover how to efficiently manage depots using the Merchanter API v1.1, enhancing your logistics and inventory control.
Written by Ian Oldrey
Updated at June 18th, 2026
-
GET operations
-
/Depots – Retrieve information relating to depots under the current user account’s ledger
- Parameters
-
/Depots – Retrieve information relating to depots under the current user account’s ledger
-
Query type
-
Where – a filter expression string with ANDed filters. Available filters are
- IsEcommerceDepot – is this an ecommerce depot? true/false
- E.g. Where=IsEcommerceDepot==true
- Response schema & body (JSON)
-
Where – a filter expression string with ANDed filters. Available filters are
| Attribute Name | Data Type | Max Length | Notes | Response Body (JSON) |
| ID | String | 20 | Object ID |
[ { “ID”: “”, "Code": "", "Name": "", "EmailAddress": "", “Type”: “”, "IsEcommerceDepot": false, "changedDate": "1900-01-01T00:00:00.000Z", "DefaultAddress": { "AddressLine1": "", "AddressLine2": "", "AddressLine3": "", "City": "", “County”: “”, "PostalCode": "", “CountryCode”: “”, "PhoneNumber": "", “FaxNumber”: “” } } ] |
| Code | String | 2 | Depot code | |
| Name | String | 100 | Full name of the depot | |
| EmailAddress | String | 100 | ||
| Type | String | See enumerated type DepotType | ||
| IsEcommerceDepot | Boolean | Ecommerce depot? | ||
| changedDate | Datetime | Date & time of last update (UTC) | ||
| DefaultAddress | ||||
| - AddressLine1 | String | 30 | ||
| - AddressLine2 | String | 30 | ||
| - AddressLine3 | String | 30 | ||
| - City | String | 30 | ||
| - County | String | 40 | ||
| - PostalCode | String | 10 | ||
| - CountryCode | String | 2 | ISO 3166-1 country code | |
| - PhoneNumber | String | 30 | ||
| - FaxNumber | String | 30 | ||
| - Country | ||||
| - - Country_ISO3166_1 | ||||
| - - - CountryCode_2 | String | 2 | ISO 3166-1 country code |