list_locations
Retrieve store location data from ConsignCloud to manage consignment and retail operations, including inventory and sales tracking.
Instructions
List store locations
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of results (default: 1000) | |
| cursor | No |
Implementation Reference
- src/server.ts:228-237 (registration)Tool registration entry defining the name, description, and input schema for 'list_locations' in the MCP tools list.name: 'list_locations', description: 'List store locations', inputSchema: { type: 'object', properties: { limit: { type: 'number', description: 'Number of results (default: 1000)' }, cursor: { type: 'string' }, }, }, },
- src/server.ts:483-485 (handler)MCP server handler for executing the 'list_locations' tool: merges default limit, calls client.listLocations, and returns JSON-formatted paginated list of locations.case 'list_locations': const locationsParams = { limit: 1000, ...(args as any) }; return { content: [{ type: 'text', text: JSON.stringify(await client.listLocations(locationsParams), null, 2) }] };
- src/client.ts:289-292 (handler)Core implementation of listLocations: HTTP GET to /locations endpoint with query params, returning PaginatedResponse<Location>.async listLocations(params?: Record<string, any>): Promise<PaginatedResponse<Location>> { const response = await this.client.get('/locations', { params }); return response.data; }
- src/types.ts:67-80 (schema)Type definitions for Location and PaginatedResponse used as output schema for listLocations.export interface Location { id: string; name: string; address_line_1: string | null; address_line_2: string | null; city: string | null; state: string | null; postal_code: string | null; } export interface PaginatedResponse<T> { data: T[]; next_cursor: string | null; }