Machship MCP

Returns all custom schemas defined in the Machship organisation. Custom schemas extend Machship entities with additional fields.

Returns the dangerous goods declaration document PDF for a consignment. Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header. Args: - consignmentId (number): Consignment ID

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

Get all identities owned by an organisation, with details on which companies they are linked to. Requires administrator access to the organisation. Args: - organisationId (number): Organisation ID - onlyUnlinkedIdentities (boolean, optional): Return only identities not linked to any company - identityProviderId (number, optional): Filter by identity provider

Get the identity with the given ID. Args: - id (number): Identity ID

Get a specific identity provider by ID. Args: - identityProviderId (number): Identity provider ID

Get all identity providers associated with a specific company. Args: - companyId (number): Company ID

Returns all identity providers for the current user's organisation. No parameters required.

Returns all identity providers for the specified organisation. Args: - organisationId (number): Organisation ID

Returns a specific financial invoice by document number, with optional PDF download. Args: - documentNumber (string): Invoice document number - returnPdfFileBytes (boolean, optional): Include PDF as base64 bytes in response

Returns a single saved item (product/SKU) with its dimensions by ID. Args: - id (number): Item ID

Returns a saved item matching the given SKU for a company. Args: - companyId (number): Company ID - sku (string): Product SKU code

Returns a single complex item (with detailed dimensions/packaging data) by ID. Args: - id (number): Item ID

Returns a complex item (detailed dimensions) by SKU for a company. Args: - companyId (number): Company ID - sku (string): Product SKU code

Returns item/package labels for a consignment as a PDF. Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header. Args: - consignmentId (number): Consignment ID - printA4 (boolean, optional): Print in A4 format (default: label-size)

Gets item labels as a zip file for up to 40 consignments. Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header. Args: - consignmentIds (number[]): Consignment IDs (max 40) - printA4 (boolean, optional): Print in A4 format - singlePdf (boolean, optional): Combine all labels into a single PDF inside the zip

Returns the item/package label PDF as JSON. object.content holds the file as base64, with object.fileName and object.contentType. Args: - consignmentId (number): Consignment ID - printA4 (boolean, optional): Whether the label is in A4 format

Returns a paginated list of saved items for a company (max 200 per request). Args: - companyId (number): Company ID - startIndex (number, optional): Pagination start index (default 1) - retrieveSize (number, optional): Number of items to retrieve (default 200, max 200)

Returns a list of saved items matching any of the supplied SKUs (standard items only, max 100 SKUs). SKUs that don't match any item are silently omitted — compare returned Sku values against your input to detect misses. Args: - companyId (number): Company ID - skus (string[]): Array of SKU codes to look up (max 100)

Returns a paginated list of complex items for a company (max 200 per request). Args: - companyId (number): Company ID - startIndex (number, optional): Pagination start index (default 1) - retrieveSize (number, optional): Number of items to retrieve (default 200, max 200)

Returns all organisations that have linked INTO this organisation (suppliers, partners). Args: - startIndex (number, optional): Pagination start index - retrieveSize (number, optional): Number to retrieve - sort (string, optional): Sort field - searchText (string, optional): Filter by name

Returns all organisations this organisation has linked TO (customers, subsidiaries). Args: - startIndex (number, optional): Pagination start index - retrieveSize (number, optional): Number to retrieve - sort (string, optional): Sort field - searchText (string, optional): Filter by name

Returns locations that exactly match provided suburb/postcode combinations. Supports multiple location lookups in one call. Args: - locations (array): Array of suburb/postcode pairs to look up exactly

Returns locations with additional search options/filters applied. Args: - s (string): Search string - options (object): Additional search options (country, state, etc.)

Returns the manifest document as a PDF by manifest ID. Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header. Args: - manifestId (number): Manifest ID

Returns the manifest PDF for the manifest associated with a given consignment. Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header. Args: - consignmentId (number): Consignment ID

Returns the manifest PDF as JSON. object.content holds the file as base64, with object.fileName and object.contentType. Args: - manifestId (number): Manifest ID

Returns a paginated list of manifests for a company (max 200 per call). A manifest represents a carrier pickup booking for a group of consignments. Args: - companyId (number, optional): Company ID - startIndex (number, optional): Pagination start index (default 1) - retrieveSize (number, optional): Number to retrieve (default 40, max 200) - carrierId (number, optional): Filter by carrier - includeChildCompanies (boolean, optional): Include sub-companies - startDate / endDate (string, optional): Date range filter (ISO 8601) - response_format ('json' | 'markdown'): Output format (default: 'json') Returns: Array of manifest summary objects: { "id": number, "manifestDate": string, "carrierName": string, "status": string, "consignmentCount": number } Examples: - Use when: "List today's manifests" -> set startDate/endDate to today - Use when: You need a manifestId to download a manifest PDF

Returns the MO41 document PDF for a consignment (used for specific carrier compliance documents). Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header. Args: - consignmentId (number): Consignment ID

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

Validates a public key and returns the corresponding organisation details. Use this to verify a partner's public key before linking. Args: - publicKey (string): Organisation public key to look up

Returns all links (partnerships/integrations) that exist for an organisation. Args: - id (number, optional): Organisation ID (leave blank for current authenticated org)

Returns the public key for an organisation, used to set up inter-organisation links. Args: - id (number, optional): Organisation ID (defaults to current org)

Returns details for a single pending consignment by ID. Args: - id (number): Pending consignment ID

Returns details for multiple pending consignments by IDs (max 10 per request). Args: - ids (number[]): Pending consignment IDs (max 10)

Finds pending consignments by Reference 1 field. Max 10 per request. Args: - references (string[]): Reference 1 values (max 10)

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

Gets all permanent scheduled pickups configured for a company location. Args: - companyLocationId (number): Company location ID

Returns posted financial invoices within an optional date range (max 100 per call). Args: - startDate (string, optional): Start date filter (ISO 8601) - endDate (string, optional): End date filter (ISO 8601) - startIndex (number, optional): Pagination start index (default 1) - retrieveSize (number, optional): Number to retrieve (default 100, max 100)

Returns full details for a single quote by ID, including all carrier rate options. Args: - id (number): Quote ID - response_format ('json' | 'markdown'): Output format (default: 'json') Returns: Full quote object with all carrier rate options, addresses, and item details. Examples: - Use when: "Show me the full details for quote 456" - Use when: You have a quote ID and need the carrier rates to pick one for a consignment

Returns all quotes for a given company. Args: - companyId (number): Company ID - response_format ('json' | 'markdown'): Output format (default: 'json') Returns: Array of quote summary objects: { "id": number, "reference": string, "status": string, "createdDate": string } Examples: - Use when: "List all quotes for company 123" - Use when: You need a quote ID to pass to machship_get_quote for full details - Don't use when: You want to create a new quote (use machship_create_quote instead) Error Handling: - Error 404: companyId does not exist or is not accessible

Returns consignments created or updated within a UTC date range. Ideal for sync/polling workflows. Args: - companyId (number): Company ID - fromDateUtc (string): Start datetime in UTC (ISO 8601) - toDateUtc (string): End datetime in UTC (ISO 8601) - startIndex (number, optional): Pagination start index - retrieveSize (number, optional): Number to retrieve - carrierId (number, optional): Filter by carrier - includeChildCompanies (boolean, optional): Include sub-companies - getNotes (boolean, optional): Include notes in response - getReconciliationData (boolean, optional): Include reconciliation data

Returns pending consignments created or updated within a UTC date range. Useful for sync workflows. Args: - companyId (number): Company ID - fromDateUtc (string): Start datetime UTC (ISO 8601) - toDateUtc (string): End datetime UTC (ISO 8601) - startIndex (number, optional): Pagination start - retrieveSize (number, optional): Page size - carrierId (number, optional): Filter by carrier - includeChildCompanies (boolean, optional): Include sub-companies - getDeleted (boolean, optional): Include deleted pending consignments

Returns a list of available freight routes and carrier services for a single shipment request. Use this to find all carrier options (rates, ETAs) before creating a consignment. Args: - request (object): Route request including: - companyId: Company ID (required) - fromLocation: { suburb, postcode, state, country } — origin location - toLocation: { suburb, postcode, state, country } — destination location - items: Array of packages with weight (kg), length/width/height (cm), name (string), quantity (integer > 0) - despatchDate (optional): Planned despatch date (ISO 8601) Example: { "companyId": 1790, "fromLocation": { "suburb": "Melbourne", "postcode": "3000", "state": "VIC", "country": "AU" }, "toLocation": { "suburb": "Sydney", "postcode": "2000", "state": "NSW", "country": "AU" }, "items": [{ "weight": 10, "length": 30, "width": 30, "height": 30, "name": "Parcel", "quantity": 1 }] }

Returns available routes for multiple shipment requests in a single call. Efficient for bulk rate shopping across multiple shipments. Args: - requests (array): Array of route request objects (same structure as single route request)

Returns available routes for a shipment with complex item definitions (dangerous goods, specialised packaging). Args: - request (object): Route request with complexItems array (including dangerous goods classifications)

Returns the special instructions document PDF for a consignment. Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header. Args: - consignmentId (number): Consignment ID - printA4 (boolean, optional): Print in A4 format

Get an unmanifested consignment in the same format required to perform an update via the editUnmanifestedConsignment endpoint. Args: - id (number): Consignment ID (must be in unmanifested state)

Returns consignments that have been created but not yet manifested (booked with carrier). 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

Groups ALL unmanifested consignments for a company into manifest groups (preview before manifesting). Args: - companyId (number): Company ID