Search Locations
machship_search_locationsSearch Machship locations by suburb or postcode to retrieve valid location IDs for delivery or pickup before creating consignments or validating addresses.
Instructions
Returns up to 10 Machship locations matching a suburb or postcode search string. Use this to look up valid delivery/pickup locationIds before creating consignments.
Args:
s (string): Search string — suburb name, postcode, or both (e.g. "Melbourne 3000")
response_format ('json' | 'markdown'): Output format (default: 'json')
Returns: Array of location objects: { "id": number, "suburb": string, "postcode": string, "state": string, "country": string }
Examples:
Use when: "What location ID is for Sydney 2000?" -> search "Sydney 2000", pick from results
Use when: Validating a delivery address before creating a consignment
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| s | Yes | Search string: suburb name, postcode, or both (e.g. 'Melbourne 3000') | |
| response_format | No | Output format: 'json' (default) or 'markdown' | json |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| errors | No | Validation errors returned by Machship, if any | |
| object | No | Response payload from the Machship API |