Machship MCP

Links another organisation into yours using their public key. Args: - request (object): Link request with the partner's publicKey and optional configuration

Adds permanent scheduled pickups to a company location. Args: - payload (object): Contains companyLocationId and pickup schedule details

Attempts automatic reconciliation of carrier invoices based on configured carrier thresholds. Args: - body (object): Reconciliation request payload (carrierInvoiceId, etc.)

Creates a new company location (warehouse, store, depot pickup point). Args: - location (object): Location data including companyId, name, address, suburb, postcode, state, country, contactName, phone, etc.

Creates a new unmanifested consignment in Machship. This is the core operation for booking freight. Args: - consignment (object): Full consignment details including: - companyId, fromCompanyLocationId, toAddress (suburb, postcode, state, country) - items (array of packages with weight, dimensions) - carrierId, serviceId, reference1, reference2, etc.

Creates a consignment using previously saved company items (by item ID / SKU). Args: - consignment (object): Consignment data referencing existing saved item IDs

Creates a consignment using complex item definitions (with detailed packaging/dangerous goods data). Args: - consignment (object): Consignment data with complexItems array instead of standard items

Creates a new custom schema to extend Machship entities with additional fields. Args: - name (string): Schema name - type (string): Schema type/entity to extend - schema (object): JSON schema definition

Create identities in MachShip and assign companies and roles. All identities must belong to the same identityProvider and organisation. Requires administrator access. Args: - identities (array): Array of identity objects, each with: - givenName (string): First name (required) - familyName (string): Last name (required) - displayName (string): Display name (required) - emailAddress (string): Email (required) - identifyingClaim (string): Unique claim for identity provider (required) - organisationId (number): Organisation ID (required) - identityProviderId (number): Identity provider ID (required) - owningCompanyId (number): Owning company ID (required) - password (string, optional): Password - uniqueId (string, optional): Unique ID - userAndCompanyLinks (array, optional): Company/role links to create

Creates a new complex item (product/SKU with detailed packaging info) for a company. Args: - companyId (number): Company ID to create item under - item (object): Item details including sku, description, weight, dimensions, etc.

Creates a pending consignment — a draft/staging consignment that hasn't been rated or assigned to a carrier yet. Pending consignments can be converted to full consignments after quoting. Args: - consignment (object): Pending consignment data including companyId, from/to address, items, references, etc.

Creates a freight quote in Machship — returns available carrier rates for a shipment. Use this to compare carrier prices and transit times before creating a consignment. Args: - quote (object): Quote request including: - companyId (number): Company to quote under - fromAddress or fromLocationId: Pickup address or location ID - toAddress: Delivery address (suburb, postcode, state, country) - items: Array of items with weight (kg), length/width/height (cm) - carrierId / serviceId (optional): Filter to a specific carrier/service Returns: Array of available rate options, each with: { "carrierId", "serviceName", "totalCost", "transitDays", "accountId" } Examples: - Use when: "Get freight quotes from Sydney to Melbourne for a 5kg parcel" - Don't use when: You already have a carrier in mind — use machship_create_consignment directly

Creates a freight quote using complex item definitions (detailed packaging, dangerous goods, serialisation data). Args: - quote (object): Quote request with complexItems array instead of standard items Returns: Same as machship_create_quote — array of rate options with cost and transit info. Examples: - Use when: Items have dangerous goods codes, serial numbers, or non-standard packaging - Use when: machship_create_quote returned a validation error about item structure

Deletes multiple unmanifested consignments. Cannot delete manifested consignments. Args: - ids (number[]): Array of consignment IDs to delete

Deletes a custom schema by its DotNet class ID. This is irreversible. Args: - id (string): DotNet class ID of the schema to delete

Delete the identities with the given IDs. This action is irreversible. Args: - ids (number[]): Array of identity IDs to delete

Deletes a saved item from a company. This action is irreversible. Args: - companyItemId (number): The ID of the item to delete

Deletes one or more pending consignments. Args: - ids (number[]): Pending consignment IDs to delete

Disable the identities with the given IDs, preventing them from logging in. Args: - ids (number[]): Array of identity IDs to disable

Edits an existing company location. Args: - location (object): Updated location data including id and any fields to update

Edits an existing unmanifested (not yet booked) consignment. Cannot edit manifested consignments. Args: - consignment (object): Updated consignment data including the consignment id

Returns all active (in-transit) consignments for a company. Args: - companyId (number): Company ID - startIndex (number, optional): Pagination start index - retrieveSize (number, optional): Number to retrieve - carrierId (number, optional): Filter by carrier - includeChildCompanies (boolean, optional): Include sub-companies

Returns all consignments for a company with date range and status filtering. Args: - companyId (number): Company ID - startIndex (number, optional): Pagination start index - retrieveSize (number, optional): Number to retrieve - carrierId (number, optional): Filter by carrier - includeChildCompanies (boolean, optional): Include sub-companies - includeDeletedConsignments (boolean, optional): Include deleted - fromDateTimeLocal (string, optional): Start date filter (local time) - toDateTimeLocal (string, optional): End date filter (local time) - filterByEtaCompletedOrDespatch (string, optional): Filter by ETA/despatch status

Downloads the raw attachment file from Machship by attachment ID. Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header. Args: - id (number): Attachment ID

Downloads a Proof of Delivery (POD) report that includes attachment and consignment details. Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header. Args: - id (number): Attachment ID

Downloads attachments for up to 40 consignments in bulk (returned as zip). Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header. Args: - ids (number[]): Array of consignment IDs (max 40)

Get all roles that are available to assign to users of a certain company. Args: - companyId (number): Company ID

Gets carrier invoice line entries with optional status filtering. Args: - carrierInvoiceId (number): The carrier invoice ID - status (string, optional): Filter entries by status

Returns basic carrier invoice information (max 100 records per call). Args: - companyId (number, optional): Filter by company ID - carrierId (number, optional): Filter by carrier ID - fileName (string, optional): Filter by invoice file name - invoiceId (number, optional): Filter by specific invoice ID

Returns the commercial invoice PDF for a consignment (used for international shipments). Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header. Args: - consignmentId (number): Consignment ID

Returns all companies accessible to the authenticated user. Args: - atOrBelowCompanyId (number, optional): Filter to companies at or below this company in the hierarchy - response_format ('json' | 'markdown'): Output format (default: 'json') Returns: Array of company objects, each containing: { "id": number, // Company ID — use this in other tool calls "name": string, // Display name of the company "isActive": boolean, // Whether the company is active "parentCompanyId": number | null } Examples: - Use when: "List all companies I have access to" - Use when: "What company ID does Acme Corp have?" -> call this, then search by name - Don't use when: You need carrier/service info (use machship_get_company_carriers instead) Error Handling: - Error 401: Check MACHSHIP_API_TOKEN is set correctly - Error 403: Token lacks permission to list companies

Returns all available carriers, carrier accounts, and freight services for a company. Call this before creating consignments or quotes to discover which services and accounts are available. Args: - companyId (number): Company ID - response_format ('json' | 'markdown'): Output format (default: 'json') Returns: Array of carrier objects with nested accounts and services, each containing: { "carrierId": number, "carrierName": string, "accounts": [ { "accountId": number, "accountName": string, "services": [{ "serviceId": number, "serviceName": string }] } ] } Examples: - Use when: "What carriers are available for company 123?" - Use when: You need a serviceId to pass to createConsignment - Don't use when: You just need a company list (use machship_get_companies instead)

Returns details for a single company location (warehouse, store, depot). Args: - id (number): Company location ID

Returns all locations (warehouses, stores, depots) for a given company. Args: - companyId (number): Company ID

Returns completed (delivered) consignments within a date range (max 2000 results). Args: - companyId (number): Company ID - startDate (string): Start date (ISO 8601) - endDate (string): End date (ISO 8601) - includeChildCompanies (boolean, optional): Include sub-companies

Returns full details for a single consignment by ID. Args: - id (number): Consignment ID - includeDeleted (boolean, optional): Include deleted consignments - includeRequestGuids (boolean, optional): Include request GUIDs in response

Returns attachment metadata (not file contents) for a consignment. Args: - consignmentId (number): Consignment ID

Get consignment details (if it exists) using a pending consignment ID that has been transformed (linked) into a consignment. Args: - id (number): Pending consignment ID

Returns settings and defaults needed for creating consignments for a company (required fields, defaults, etc.). Args: - companyId (number, optional): Company ID (defaults to authenticated company)

Get the details of an existing consignment in a format that can be passed directly to the createConsignmentWithComplexItems endpoint to create a copy. Args: - id (number): Consignment ID to retrieve in clone format

Returns the consignment label PDF. Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header. Args: - consignmentId (number): Consignment ID

Returns all notes attached to a consignment (internal comments, delivery instructions, etc.). Args: - id (number): Consignment ID

Returns the consignment label PDF as JSON. object.content holds the file as base64, with object.fileName and object.contentType. Args: - consignmentId (number): Consignment ID

Returns tracking/delivery statuses for a batch of consignments, with optional date filter. Args: - ids (number[]): Consignment IDs - sinceDateCreatedUtc (string, optional): Only return statuses since this UTC datetime (ISO 8601)

Finds consignments by carrier's own consignment/tracking ID. Max 10 per request. Args: - carrierConsignmentIds (string[]): Array of carrier consignment IDs (max 10)

Returns details for multiple consignments by their IDs (max 100 per request). Args: - ids (number[]): Array of consignment IDs (max 100)

Get consignment details for multiple consignments using Pending Consignment IDs as the lookup. Maximum of 100 consignments per request. Args: - ids (number[]): Array of pending consignment IDs (max 100)

Finds consignments by their Reference 1 field (order number, etc). Max 10 per request. Args: - references (string[]): Array of Reference 1 values (max 10)

Finds consignments by their Reference 2 field. Max 10 per request. Args: - references (string[]): Array of Reference 2 values (max 10)

Returns a specific custom schema by its DotNet class ID. Args: - id (string): The DotNet class ID of the schema