Makini
v4 (Latest)
  • v4 (Latest)
  • v3 (Legacy)
User GuideAPI Reference
MCPPlatforms
User GuideAPI Reference
MCPPlatforms
Website
v4 (Latest)
  • v4 (Latest)
  • v3 (Legacy)
v4 (Latest)
  • v4 (Latest)
  • v3 (Legacy)
  1. Shipments
  • System
    • Service health check
      GET
  • Accounts
    • List accounts
      GET
    • Create an account
      POST
    • Get an account
      GET
    • Update an account
      PATCH
  • Addresses
    • List addresses
      GET
    • Get an address
      GET
  • Assets
    • List assets
      GET
    • Create an asset
      POST
    • Get an asset
      GET
    • Update an asset
      PATCH
    • Set the status of an asset
      POST
  • Budgets
    • List budgets
      GET
    • Get a budget
      GET
  • Contacts
    • List contacts
      GET
    • Get a contact
      GET
  • Contracts
    • List contracts
      GET
    • Get a contract
      GET
  • Countries
    • List countries
    • Get a country
  • Currencies
    • List currencies
    • Get a currency
  • Customers
    • List customers
    • Create a customer
    • Get a customer
    • Update a customer
  • Employees
    • List employees
    • Get an employee
  • Invoices
    • List invoices
    • Create an invoice
    • Get an invoice
    • Update an invoice
    • Submit an invoice
    • Approve an invoice
    • Cancel an invoice
    • Set the status of an invoice
  • Locations
    • List locations
    • Create a location
    • Get a location
    • Update a location
  • Meters
    • List meters
    • Create a meter
    • Get a meter
  • Organizations
    • List organizations
    • Get an organization
  • Partners
    • List partners
    • Get a partner
  • Quotes
    • List quotes
    • Create a quote
    • Get a quote
    • Submit a quote
    • Cancel a quote
    • Convert a quote
  • Receipts
    • List receipts
    • Get a receipt
  • Units
    • List units
    • Get an unit of measure
  • Vendors
    • List vendors
    • Create a vendor
    • Get a vendor
    • Update a vendor
  • Query
    • Run a Makini Query Language (MQL) statement
  • Passthrough
    • Call the connected system’s own API with the connection’s credentials
  • Raw
    • List the raw tables synced for this connection
    • List the rows of one raw table
  • OAuth
    • Issue an access token (client_credentials, authorization_code or refresh_token)
    • Revoke a refresh token, and with it the access tokens issued from it (RFC 7009)
    • JSON Web Key Set for access-token verification
    • Authorization server metadata (RFC 8414)
  • MCP
    • List the platforms an MCP user can see and use
    • Resolve whether an MCP user may execute tools against a platform
    • The folded tool policy of this MCP user on a platform
    • Ask an administrator for a tool this MCP user is denied
    • List the tool catalogue of a platform for this user
    • Execute one MCP tool against a platform for this user
  • Writes
    • Fetch the record of a queued write
  • Work Orders
    • Update a work order’s status (legacy alias of the set-status action)
    • Fetch the record of a queued write (legacy alias of GET /v4/writes/{writeId})
    • List work orders
    • Create a work order
    • Get a work order
    • Update a work order
    • Delete a work order
    • Assign a work order
    • Accept a work order
    • Reject a work order
    • Start a work order
    • Hold a work order
    • Resume a work order
    • Complete a work order
    • Close a work order
    • Cancel a work order
    • Set the status of a work order
    • Convert a work order
  • Taxonomies
    • List taxonomies
    • Get a taxonomy
  • Business Units
    • List business units
    • Get a business unit
  • Users
    • List users
    • Get an user
  • Labor Resources
    • List labor resources
    • Get a labor resource
  • Asset Assignments
    • List asset assignments
    • Create an asset assignment
    • Get an asset assignment
    • Update an asset assignment
    • Complete an asset assignment
  • Meter Readings
    • List meter readings
    • Create one or many meter readings
    • Get a meter reading
  • Alarms
    • List alarms
    • Get an alarm
    • Close an alarm
  • Dispense Transactions
    • List dispense transactions
    • Create one or many dispense transactions
    • Get a dispense transaction
    • Update a dispense transaction
    • Delete a dispense transaction
  • Work Requests
    • List work requests
    • Create a work request
    • Get a work request
    • Approve a work request
    • Reject a work request
    • Cancel a work request
    • Set the status of a work request
  • Work Tasks
    • List work tasks
    • Get a work task
    • Update a work task
    • Complete a work task
  • Maintenance Templates
    • List maintenance templates
    • Get a maintenance template
  • Maintenance Triggers
    • List maintenance triggers
    • Get a maintenance trigger
  • Events
    • List events
    • Get an event
  • Event Recurrences
    • List event recurrences
    • Get an event recurrence
  • Order Materials
    • List order materials
    • Create an order material
    • Get an order material
    • Update an order material
  • Order Resources
    • List order resources
    • Create an order resource
    • Get an order resource
    • Update an order resource
  • Comments
    • List comments
    • Create one or many comments
    • Get a comment
  • Inventory Items
    • List inventory items
    • Create an inventory item
    • Get an inventory item
    • Update an inventory item
  • Stock Levels
    • List stock levels
    • Get a stock level
  • Supply Options
    • List supply options
    • Get a supply option
  • Purchase Orders
    • List purchase orders
    • Create a purchase order
    • Get a purchase order
    • Update a purchase order
    • Submit a purchase order
    • Approve a purchase order
    • Receive a purchase order
    • Close a purchase order
    • Cancel a purchase order
    • Reopen a purchase order
    • Set the status of a purchase order
    • Convert a purchase order
  • Purchase Order Lines
    • List purchase order lines
    • Get a purchase order line
  • Invoice Lines
    • List invoice lines
    • Get an invoice line
  • Budget Lines
    • List budget lines
    • Get a budget line
  • Work Centers
    • List work centers
    • Get a work center
  • Production Routings
    • List production routings
    • Get a production routing
  • Production Routing Operations
    • List production routing operations
    • Get a production routing operation
  • Bills Of Material
    • List bills of material
    • Get a bill of material
  • Bill Of Material Lines
    • List bill of material lines
    • Get a bill of material line
  • Production Orders
    • List production orders
    • Create a production order
    • Get a production order
    • Update a production order
    • Delete a production order
    • Start a production order
    • Reopen a production order
    • Close a production order
  • Production Order Operations
    • List production order operations
    • Get a production order operation
  • Purchase Requisitions
    • List purchase requisitions
    • Create a purchase requisition
    • Get a purchase requisition
    • Submit a purchase requisition
    • Approve a purchase requisition
    • Reject a purchase requisition
    • Cancel a purchase requisition
    • Convert a purchase requisition
  • Purchase Requisition Lines
    • List purchase requisition lines
    • Get a purchase requisition line
  • Quote Lines
    • List quote lines
    • Get a quote line
  • Sales Orders
    • List sales orders
    • Create a sales order
    • Get a sales order
    • Update a sales order
    • Ship a sales order
    • Close a sales order
    • Cancel a sales order
    • Reopen a sales order
    • Set the status of a sales order
    • Convert a sales order
  • Sales Order Lines
    • List sales order lines
    • Get a sales order line
  • Return Orders
    • List return orders
    • Get a return order
  • Return Order Lines
    • List return order lines
    • Get a return order line
  • Shipments
    • List shipments
      GET
    • Create a shipment
      POST
    • Get a shipment
      GET
    • Complete a shipment
      POST
  • Shipment Lines
    • List shipment lines
    • Get a shipment line
  • Receipt Lines
    • List receipt lines
    • Get a receipt line
  • Inventory Transactions
    • List inventory transactions
    • Create one or many inventory transactions
    • Get an inventory transaction
  • Leases
    • List leases
    • Get a lease
  • Lease Applications
    • List lease applications
    • Get a lease application
  • Projects
    • List projects
    • Get a project
  • Inventory Documents
    • List inventory documents
    • Create an inventory document
    • Get an inventory document
    • Post an inventory document
    • Cancel an inventory document
  • Checklists
    • List checklists
    • Get a checklist
  • Checklist Items
    • List checklist items
    • Get a checklist item
  • Attachments
    • List attachments
    • Create an attachment
    • Get an attachment
    • Delete an attachment
  • Management API
    • Connections
      • List connections
      • Create a connection (real with credentials, or intended)
      • Get one connection
      • Update a connection
      • Soft-delete a connection
      • Permanently delete a connection
      • Activate or deactivate a connection (inactive is refused by /v4, MCP and sync, but is not a deletion)
      • The forms, solutions and flow folders of a connection, and which are on
      • Set exactly which forms, solutions and flow folders are on for a connection
      • Issue a connection-scoped access token for one of your connections
    • Embed
      • Mint a short-lived embed session for a connection’s settings form
      • Read the settings an end user saved for a connection
      • Store an end user’s submitted settings (first-party only)
      • Flip the end user’s kill switch for a connection’s settings form (first-party only)
      • Disconnect a connection from inside the embed (first-party only)
      • Read the form a custom-modal field's endpoint defines (first-party only)
      • One page of a connection’s support requests (first-party only)
      • Open a support request for a connection (first-party only)
      • One support request and its public thread (first-party only)
      • Reply to a support request (first-party only)
      • One file from a support request (first-party only)
      • Open one of your customers’ embedded experience: their connections, connecting another, each connection’s forms
      • Resolve an embed session token into everything the embed renders (first-party only)
      • List the client’s embed settings forms
      • Read one of the client’s embed settings forms
      • Create or replace one of the client’s embed settings forms
      • Delete one of the client’s embed settings forms, with every connection’s answers to it
    • Clients
      • Register a management-layer OAuth client and issue its first secret
      • List clients, optionally filtered by exact email
      • Get one client, with its redirect URIs and its secrets’ metadata
      • Update a client’s name, email or logos
    • Secrets
      • Generate a new client secret
      • Read a secret value (decrypted)
      • Revoke a secret (soft delete)
    • Redirect URIs
      • Add a redirect URI to a client
      • Replace the value of a redirect URI
      • Delete a redirect URI
    • Whitelabel
      • Replace a client’s Makini Link whitelabel config
      • Clear a client’s Makini Link whitelabel config
    • Log Retention
      • Set how long a client’s API request log is kept
    • Webhook Endpoints
      • List a client’s outbound webhook endpoints
      • Register an outbound webhook endpoint
      • Update an outbound webhook endpoint
      • Delete an outbound webhook endpoint
      • The outbound webhook delivery log
    • Support
      • One page of an application’s support requests, from its team and its end users
      • Open a support request for an application, as a named member
      • One of an application’s support requests and its public thread
      • Reply to an application’s support request, as a named member
      • One file from an application’s support request
      • Store one file for a later support request or reply
    • Platforms
      • The platforms your application can connect
    • Compat
      • v1 compatibility: GET /api/system/platforms (temporary, removed at the end of November 2026)
      • v1 compatibility: GET /api/system/connections (temporary, removed at the end of November 2026)
      • v1 compatibility: POST /api/system/connections (temporary, removed at the end of November 2026)
      • v1 compatibility: POST /v1/embed/session (temporary, removed at the end of November 2026)
    • Field Mappings
      • Read a connection’s field mappings: what it serves and the active mapping document
      • Save a connection’s field mappings as a new revision
      • List a connection’s field-mapping revisions, newest first
      • Activate an earlier field-mapping revision
      • Replace a connection’s custom streams
      • Test-fetch a (possibly unsaved) custom stream against the live vendor endpoint
      • Read the source tables and columns a connection’s mappings can use
    • Data Mappings
      • List the entities of a connection that are mapped to the customer’s own identifiers
      • Start mapping one entity of a connection
      • Read one data mapping’s definition
      • Change a data mapping’s cardinality
      • Stop mapping an entity, discarding its pairs
      • Read one page of a data mapping’s pairs
      • Replace a data mapping’s pairs wholesale
    • MCP
      • Create an MCP role (first-party only)
      • List a client’s MCP roles (first-party only)
      • Update an MCP role (first-party only)
      • Delete an MCP role, optionally reassigning its users (first-party only)
      • List end customers
      • Register an end customer
      • Which metadata key names a connection’s end customer
      • Set the metadata key that names a connection’s end customer
      • One customer, with its counts
      • Rename a customer, or re-point the provider’s identifier for them
      • Remove one of the provider’s customers
      • List one customer’s MCP users
      • Provision an MCP user for one of the provider’s customers
      • Update one of a customer’s MCP users
      • Offboard one of a customer’s MCP users
      • Read one of a customer’s MCP users
      • Mint a personal access token for one of a customer’s MCP users
      • List the personal access tokens of one of a customer’s MCP users
      • End one personal access token of one of a customer’s MCP users
      • Connect a platform for one of a customer’s agents
      • List one customer’s connections
      • List one customer’s MCP roles
      • Create a role for one customer
      • Rename a customer’s role, or make it their default
      • Delete a customer’s role, optionally reassigning its users
      • Read one of a customer’s MCP roles
      • What one customer sees, and what it inherits
      • Which platforms a customer has company-wide credentials for
      • What to send for a customer’s company-wide credentials, and what is stored
      • Set one customer’s company-wide credentials for a platform
      • Stop supplying a customer’s company-wide credentials for a platform
      • What one customer has set up: every platform on for it, its sign-in choice, and what it stored
      • The customer’s live setup link, if any — who it went to and when it dies, never the code
      • Mint the customer’s setup link, replacing a live one
      • Revoke the customer’s live setup link
      • Record whom the live setup link was emailed to
      • The customer’s choice for one platform: one shared account for everyone, or each person from their agent
      • Remove the customer’s sign-in to one platform: its shared account, its API key or its company-wide fields
      • What one of a customer’s roles may call on a platform
      • Set a page of tool permissions for one of a customer’s roles
      • Enable or disable every tool on a platform for one of a customer’s roles
      • Override, or clear, one platform for one customer
      • Create an MCP user (first-party only)
      • List a client’s MCP users (first-party only)
      • Update an MCP user (first-party only)
      • Soft-delete an MCP user (first-party only)
      • Give a pending MCP user its seat (first-party only)
      • Issue a personal access token for an agent (first-party only)
      • List an agent’s personal access tokens (first-party only)
      • End one of an agent’s personal access tokens (first-party only)
      • Connect a platform for an agent (first-party only)
      • Read a client’s platform visibility (first-party only)
      • Set the platform-visibility default, and optionally the decided platforms (first-party only)
      • Show or hide one platform (first-party only)
      • The workspace’s third-party MCP servers: catalog and custom (first-party only)
      • Register a custom MCP server by URL (first-party only)
      • Edit a custom MCP server (first-party only)
      • Remove an MCP server from the workspace (first-party only)
      • Start an OAuth sign-in to a third-party MCP server: the workspace's or one person's (first-party only)
      • Sign in to the server now and load its tool list (first-party only)
      • List an adapter’s tool catalogue, searched and paginated (first-party only)
      • One level’s guardrail rules on a platform, every tool (first-party only)
      • Replace one tool’s guardrail rules at one level (first-party only)
      • Relabel a tool or rewrite its description for this workspace (first-party only)
      • List the platforms a client has company-wide credentials for (first-party only)
      • Read one platform’s company-wide credential form and state (first-party only)
      • Set a platform’s company-wide credentials (first-party only)
      • Clear a platform’s company-wide credentials (first-party only)
      • Read the tool policy for a page of tool names (first-party only)
      • Write the tool policy for a page of tool names (first-party only)
      • Flip one level’s tool-policy default, wiping its exceptions (first-party only)
      • Access requests of the workspace, newest first (first-party only)
      • Grant a pending access request to the person or their role (first-party only)
      • Dismiss a pending access request (first-party only)
  1. Shipments

Get a shipment

GET
https://api.makini.io/v4/v4/shipments/{id}
Goods sent out against an order: a delivery to a customer, or goods returned to a vendor. Lines are ShipmentLine records; goods coming in are a Receipt.

Request

Path Params

Query Params

Responses

🟢200OK
application/json
The shipment
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠402
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
🔴502Bad Gateway
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.makini.io/v4/v4/shipments/?expand=undefined'
Response Response Example
200 - Example 1
{
    "data": {
        "id": "string",
        "code": "string",
        "_source": "string",
        "_idValue": "string",
        "_displayValue": "string",
        "_updatedAt": "2019-08-24T14:15:22.123Z",
        "_createdAt": "2019-08-24T14:15:22.123Z",
        "_deletedAt": "2019-08-24T14:15:22.123Z",
        "_implements": [
            "string"
        ],
        "customFields": {},
        "_mappings": {},
        "statusCategory": "draft",
        "lifecyclePhase": "pending",
        "status": {
            "id": "string",
            "_idValue": "string",
            "_displayValue": "string",
            "rel": "string",
            "href": "http://example.com"
        },
        "customer": {
            "id": "string",
            "_idValue": "string",
            "_displayValue": "string",
            "rel": "string",
            "href": "http://example.com"
        },
        "vendor": {
            "id": "string",
            "_idValue": "string",
            "_displayValue": "string",
            "rel": "string",
            "href": "http://example.com"
        },
        "carrier": {
            "id": "string",
            "_idValue": "string",
            "_displayValue": "string",
            "rel": "string",
            "href": "http://example.com"
        },
        "salesOrder": {
            "id": "string",
            "_idValue": "string",
            "_displayValue": "string",
            "rel": "string",
            "href": "http://example.com"
        },
        "sourceDocument": {
            "id": "string",
            "_idValue": "string",
            "_displayValue": "string",
            "rel": "string",
            "href": "http://example.com"
        },
        "fromLocation": {
            "id": "string",
            "_idValue": "string",
            "_displayValue": "string",
            "rel": "string",
            "href": "http://example.com"
        },
        "toLocation": {
            "id": "string",
            "_idValue": "string",
            "_displayValue": "string",
            "rel": "string",
            "href": "http://example.com"
        },
        "shipToAddress": {
            "id": "string",
            "_idValue": "string",
            "_displayValue": "string",
            "rel": "string",
            "href": "http://example.com"
        },
        "shipMethod": "string",
        "trackingNumber": "string",
        "shippedAt": "2019-08-24T14:15:22.123Z",
        "expectedAt": "2019-08-24T14:15:22.123Z",
        "receivedAt": "2019-08-24T14:15:22.123Z",
        "grossWeight": 0,
        "weightUom": {
            "id": "string",
            "_idValue": "string",
            "_displayValue": "string",
            "rel": "string",
            "href": "http://example.com"
        },
        "carrierReference": "string",
        "externalReferences": null
    }
}
Modified at 2026-10-16 14:17:58
Previous
Create a shipment
Next
Complete a shipment
Built with