MCP XYZby Jiffi
Menu
← Back to all MCPs

Unleashed MCP

An Unleashed MCP connector for stock, products, sales orders and purchasing. Explore the coverage and join the access waitlist.

Inventory and orders

What is Unleashed MCP?

MCP XYZ is building an independent Unleashed MCP connector so an AI assistant can work with authorised inventory and order records through the Model Context Protocol. The connector covers documented Unleashed API operations; new access is by invitation from the waitlist, and live business workflows still need validation.

Use the catalogue to check the operations and fields your work needs. If an existing connector is missing a useful action, tell us about it when joining the waitlist. Your software’s permissions and API limits still apply.

Unleashed workflows to explore

Check stock and warehouse records

Explore documented product, stock-on-hand and warehouse operations for questions about inventory across your business.

Inspect documented operations →

Find sales orders and line items

Inspect sales-order and customer operations, including the products, quantities and prices retained in their documented fields.

Inspect documented operations →

Work with purchasing and supplier records

Review the purchase-order, receipt and supplier coverage before planning an authorised purchasing workflow.

Inspect documented operations →
Example request to try after setup and validation

“Show stock on hand by warehouse for this product.”

Getting access to Unleashed MCP

New access starts with the Unleashed waitlist. Tell us which assistant you use and the work you want to do. We’ll contact you about relevant access updates; joining does not create an account or guarantee an invitation date.

Once invited, sign in to MCP XYZ, choose your workspace and add the API ID and key for your authorised Unleashed account. Run the connection check, then add its MCP URL to your assistant. Saved credentials alone do not verify a connection.

Unleashed API documentation ↗

Start with read-only access while you explore. Jiffi can handle setup with you. Live business workflows still need validation against an authorised account.

In Claude Desktop or web, open Settings → Connectors → Add custom connector, enter your connection’s MCP URL, then connect and choose access in MCP XYZ.

Join the Unleashed waitlistExisting user? Log in →

Unleashed MCP questions

What is the Unleashed MCP from MCP XYZ?
It is an independent connector being built by Jiffi to expose documented Unleashed API operations through the Model Context Protocol. It is intended to let an authorised AI assistant request inventory, customer, supplier and order information from your Unleashed account.
Can I use Unleashed MCP with Claude or ChatGPT?
MCP XYZ connection and tool-discovery flows have been tested with Claude Desktop and web, Codex and Claude Code. Those checks did not verify live Unleashed business requests. ChatGPT acceptance has not yet been verified. Tell us which assistant you use when joining the waitlist.
What Unleashed access will I need?
After an access invitation, setup requires an authorised Unleashed account with API access, its API ID and API key, and an MCP XYZ workspace. Your account permissions and the provider’s API limits still apply. Never put API keys into the waitlist form.
Can this connector update orders or inventory?
The documented catalogue includes reads and writes. A documented write does not establish a tested business workflow. Changes require the relevant permissions and validation in an authorised scope; ambiguous mutating requests are not automatically retried.
How do I get access, and what does it cost?
Join the Unleashed waitlist and describe the job you want to do. We will contact you about access; joining does not create an account or guarantee a launch date. MCP access is included for clients under contract with Jiffi. Standalone access and any applicable terms are discussed before activation.

Read the AI client guide → How access and permissions work →

Documented coverage

Operations and fields

145 documented operation variants. Open a contract to inspect its parameters, fields, sources and unresolved behaviour. No provider request is made here.

145 operations match. Showing 61–80.

Documented contract, live behaviour unverified

List a page of Sales Shipments

unleashed_list_sales_shipments

GET/SalesShipments

Read the provider documentation ↗

Unresolved behaviour

  • No authenticated sandbox or production request has verified this operation.

Query parameters and filters

ParameterRequiredProvider description
endDateNoReturns shipments created before a specified date.
modifiedSinceNoReturns shipments created or edited after a specified date in UTC time zone. For example: modifiedSince=2024-04-17T23:11:05
orderByNoPermitted value: ShipmentNumber. Defaults to LastModifiedOn if not supplied.
orderNumberNoReturns all shipments for the specified order number. If specified, it overrides all other filters.
pageSizeNoSpecifies the page size for pagination. Default page size is 200 shipments. Note: Requesting large numbers of shipments can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
serialBatchNoFalse by default. If set to true then the attributes SerialNumbers and BatchNumbers are displayed.
shipmentStatusNoReturns shipments for the specified status.
sortNoWorks in conjunction with orderBy to sort the list in ascending or descending order. Permitted values are asc (default) or desc.
startDateNoReturns shipments created after a specified date.
warehouseCodeNoReturns sales shipments with the specified warehouse code.

Retained Sales Shipments field and filter tables

These source tables cover the resource’s documented methods. Read each table’s heading for its request or response context.

Available Fields for GET Sales Shipments

GET Sales Shipments

PropertyTypeLengthNotes
CommentsString500Can be edited after the sales shipment is dispatched.
CreatedByString50
CreatedOnDateTime
CustomerCustomer collection
CustomerRefString500
DeliveryCityString500
DeliveryContactDeliveryContact collection
DeliveryCountryString500
DeliveryInstructionString500
DeliveryNameString500
DeliveryPostCodeString50
DeliveryRegionString500
DeliveryStreetAddressString500
DeliveryStreetAddress2String500
DeliverySuburbString500
DispatchDateDateTime
GuidGuidUnique identifier. Can only be set when adding a record.
IncotermString3
LastModifiedByString50
LastModifiedOnDateTime
NatureOfTransactionCodeString2
NumberOfPackagesInteger
OrderNumberString20
OrderGuidGuid
ReceiverEORIString20
SalesShipmentLinesSalesShipmentLine collection
ShipmentNumberString25
ShipmentStatusString20
ShipmentWeightString50
ShippingCompanyShippingCompany collectionCan be edited after the sales shipment is dispatched.
ShipperEORIString20
TotalCommercialValueDecimal
TrackingNumberString100Can be edited after the sales shipment is dispatched.
WarehouseWarehouse collection
Available Fields for Customer

GET Sales Shipments

PropertyTypeLengthNotes
CustomerCodeString500
CustomerNameString500
GuidGuidUnique identifier. Can only be set when adding a record.
LastModifiedOnDateTime
Available Fields for Delivery Contact

GET Sales Shipments

PropertyTypeLengthNotes
EmailAddressString500
FirstNameString500
GuidGuidUnique identifier. Can only be set when adding a record.
LastNameString500
MobilePhoneString500
OfficePhoneString500
PhoneNumberString500
Available Fields for Shipping Company

GET Sales Shipments

PropertyTypeLengthNotes
GuidGuidUnique identifier. Can only be set when adding a record.
NameString256
Available Fields for Warehouse

GET Sales Shipments

PropertyTypeLengthNotes
GuidGuidUnique identifier. Can only be set when adding a record.
WarehouseCodeString15
WarehouseNameString100
Available Fields for Sales Shipment Line

GET Sales Shipments

PropertyTypeLengthNotes
BatchNumbersBatchNumber collection
CommercialMonetaryValueDecimal
CreatedByString50
CreatedOnDateTime
GuidGuidUnique identifier. Can only be set when adding a record.
LastModifiedByString50
LastModifiedOnDateTime
LineNumberIntegerLine number maps to SalesOrderLineNumber
ProductProduct collection
SalesOrderLineIdInteger
SalesOrderLineNumberInteger
SerialNumbersSerialNumber collection
ShipmentQtyDecimal
UnitCostDecimal
UnitCostAtTimeOfDispatchDecimal
Available Fields for Batch Number

GET Sales Shipments

PropertyTypeLengthNotes
ExpiryDateDate
GuidGuidUnique identifier. Can only be set when adding a record.
LastModifiedOnDateTime
NumberString50
QuantityDecimal
Available Fields for Product

GET Sales Shipments

PropertyTypeLengthNotes
GuidGuidUnique identifier. Can only be set when adding a record.
ProductCodeString100
ProductDescriptionString500
Available Fields for Serial Number

GET Sales Shipments

PropertyTypeLengthNotes
GuidGuidUnique identifier. Can only be set when adding a record.
IdentifierString50
LastModifiedOnDateTime
Available Fields for POST/PUT Sales Shipments

POST / PUT Sales Shipments

PropertyTypeLengthPOSTPUTNotes
CommentsString500OptionalOptional
DispatchDateDateTimeyyyy-mm-ddOptionalOptional
GuidGuidRequiredRequiredUnique identifier. Can only be set when adding a record.
NumberOfPackagesIntegerOptionalOptional
OrderNumberString20RequiredN/A
SalesShipmentLinesSalesShipmentLine collectionRequiredRequiredAt least one shipment line is required.
ShipmentStatusString20RequiredRequired when order management is enabled.
ShipmentWeightString50OptionalOptional
ShippingCompanyShippingCompany collectionOptionalOptional
TrackingNumberString100OptionalOptional
Available Fields for Shipping Company

POST / PUT Sales Shipments

PropertyTypeLengthPOSTPUTNotes
GuidGuidOptionalOptional
NameString256OptionalOptional
Available Fields for Sales Shipment Line

POST / PUT Sales Shipments

PropertyTypeLengthPOSTPUTNotes
BatchNumbersBatchNumber collectionOptionalOptionalIf the serialBatch filter value is set to true: For POST, the batch numbers must match those assigned to the Sales Order. For PUT, the batch numbers provided must be valid and will be assigned to the shipment regardless of any batch numbers assigned to the Sales Order.
GuidGuidN/AOptionalIf the Guid is set, it will update the existing lines instead of recreating them.
ProductProduct collectionRequiredRequired
SalesOrderLineNumberIntegerOptionalOptionalSales Order line mapping. If the sales order line is specified, it will validate if the product for shipment line is the same as the product of the sales order line.
SerialNumbersSerialNumber collectionOptionalOptionalIf the serialBatch filter value is set to true: For POST, the serial numbers must match those assigned to the Sales Order. For PUT, the serial numbers provided must be valid and will be assigned to the shipment regardless of any serial numbers assigned to the Sales Order.
ShipmentQtyDecimalRequiredRequired
Available Fields for Batch Number

POST / PUT Sales Shipments

PropertyTypeLengthPOSTPUTNotes
ExpiryDateDateOptionalOptional
GuidGuidOptionalOptional
NumberString50OptionalOptional
QuantityDecimalRequiredRequired
Available Fields for Serial Number

POST / PUT Sales Shipments

PropertyTypeLengthPOSTPUTNotes
GuidGuidOptionalOptional
IdentifierString50RequiredOptional
Available Fields for Product

POST / PUT Sales Shipments

PropertyTypeLengthPOSTPUTNotes
GuidGuidOptionalOptionalUnique identifier. Can only be set when adding a record.
ProductCodeString100RequiredRequired
Available Filters for GET Sales Shipments

GET Sales Shipments

FilterDescription
endDateReturns shipments created before a specified date.
modifiedSinceReturns shipments created or edited after a specified date in UTC time zone. For example: modifiedSince=2024-04-17T23:11:05
orderByPermitted value: ShipmentNumber. Defaults to LastModifiedOn if not supplied.
orderNumberReturns all shipments for the specified order number. If specified, it overrides all other filters.
pageSizeSpecifies the page size for pagination. Default page size is 200 shipments. Note: Requesting large numbers of shipments can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
serialBatchFalse by default. If set to true then the attributes SerialNumbers and BatchNumbers are displayed.
shipmentStatusReturns shipments for the specified status.
sortWorks in conjunction with orderBy to sort the list in ascending or descending order. Permitted values are asc (default) or desc.
startDateReturns shipments created after a specified date.
warehouseCodeReturns sales shipments with the specified warehouse code.
Available Filters for POST/PUT Sales Shipments

POST / PUT Sales Shipments

FilterDescription
serialBatchIf set to true: For a POST request, the serial and batch numbers are assigned provided they are already assigned to the Sales Order. For a PUT request, the serial and batch numbers are assigned regardless of whether they are assigned on the Sales Order.
Inspect the complete operation contract

The exact retained JSON includes schemas, nested fields, notes, source evidence and unresolved questions. It is a documented contract, not a live response.

{
  "id": "list_sales_shipments",
  "name": "unleashed_list_sales_shipments",
  "resourceId": "SalesShipments",
  "description": "List a page of Sales Shipments",
  "method": "GET",
  "path": "/SalesShipments",
  "documentationUrl": "https://apidocs.unleashedsoftware.com/SalesShipments",
  "readOnly": true,
  "destructive": false,
  "idempotent": true,
  "pathParameters": [],
  "queryParameters": [
    {
      "name": "endDate",
      "required": false,
      "description": "Returns shipments created before a specified date.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns shipments created before a specified date."
      },
      "sourceSection": "Available Filters for GET Sales Shipments"
    },
    {
      "name": "modifiedSince",
      "required": false,
      "description": "Returns shipments created or edited after a specified date in UTC time zone. For example: modifiedSince=2024-04-17T23:11:05",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns shipments created or edited after a specified date in UTC time zone. For example: modifiedSince=2024-04-17T23:11:05"
      },
      "sourceSection": "Available Filters for GET Sales Shipments"
    },
    {
      "name": "orderBy",
      "required": false,
      "description": "Permitted value: ShipmentNumber. Defaults to LastModifiedOn if not supplied.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Permitted value: ShipmentNumber. Defaults to LastModifiedOn if not supplied."
      },
      "sourceSection": "Available Filters for GET Sales Shipments"
    },
    {
      "name": "orderNumber",
      "required": false,
      "description": "Returns all shipments for the specified order number. If specified, it overrides all other filters.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns all shipments for the specified order number. If specified, it overrides all other filters."
      },
      "sourceSection": "Available Filters for GET Sales Shipments"
    },
    {
      "name": "pageSize",
      "required": false,
      "description": "Specifies the page size for pagination. Default page size is 200 shipments. Note: Requesting large numbers of shipments can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.",
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 1000,
        "description": "Specifies the page size for pagination. Default page size is 200 shipments. Note: Requesting large numbers of shipments can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests."
      },
      "sourceSection": "Available Filters for GET Sales Shipments"
    },
    {
      "name": "serialBatch",
      "required": false,
      "description": "False by default. If set to true then the attributes SerialNumbers and BatchNumbers are displayed.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "False by default. If set to true then the attributes SerialNumbers and BatchNumbers are displayed."
      },
      "sourceSection": "Available Filters for GET Sales Shipments"
    },
    {
      "name": "shipmentStatus",
      "required": false,
      "description": "Returns shipments for the specified status.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns shipments for the specified status."
      },
      "sourceSection": "Available Filters for GET Sales Shipments"
    },
    {
      "name": "sort",
      "required": false,
      "description": "Works in conjunction with orderBy to sort the list in ascending or descending order. Permitted values are asc (default) or desc.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Works in conjunction with orderBy to sort the list in ascending or descending order. Permitted values are asc (default) or desc."
      },
      "sourceSection": "Available Filters for GET Sales Shipments"
    },
    {
      "name": "startDate",
      "required": false,
      "description": "Returns shipments created after a specified date.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns shipments created after a specified date."
      },
      "sourceSection": "Available Filters for GET Sales Shipments"
    },
    {
      "name": "warehouseCode",
      "required": false,
      "description": "Returns sales shipments with the specified warehouse code.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns sales shipments with the specified warehouse code."
      },
      "sourceSection": "Available Filters for GET Sales Shipments"
    }
  ],
  "requestBodySchema": null,
  "responseSchema": null,
  "pagination": {
    "strategy": "path-page",
    "pathTemplate": "/SalesShipments/{page}",
    "pageParameter": "page",
    "pageSizeParameter": "pageSize",
    "firstPage": 1,
    "defaultPageSize": 200,
    "maximumPageSize": 1000,
    "minimumPageSize": 1,
    "responseItemsPath": "Items",
    "responsePaginationPath": "Pagination",
    "documentationUrl": "https://apidocs.unleashedsoftware.com/Pagination",
    "notes": [
      "Prefer Pagination.NumberOfPages when supplied. Older responses without metadata require stopping on a short page."
    ]
  },
  "notes": [],
  "provenance": [
    {
      "sourceUrl": "https://apidocs.unleashedsoftware.com/SalesShipments",
      "sourceSha256": "f75b12e67071203dd746b580dc71ff403120e377ef53265f74647014bba7101f",
      "section": "The full range of URIs and HTTP Verbs supported are",
      "evidence": "GET /SalesShipments",
      "operationDescriptions": [
        "List a page of Sales Shipments"
      ]
    }
  ],
  "confidence": "documented-route",
  "unresolved": [
    "No authenticated sandbox or production request has verified this operation."
  ],
  "requestFieldTable": null,
  "responseFieldTable": "Available Fields for GET Sales Shipments"
}
Inspect the complete resource record
{
  "id": "SalesShipments",
  "name": "Sales Shipments",
  "group": "Editable resources",
  "documentationUrl": "https://apidocs.unleashedsoftware.com/SalesShipments",
  "snapshot": "snapshots/SalesShipments.html",
  "sourceSha256": "f75b12e67071203dd746b580dc71ff403120e377ef53265f74647014bba7101f",
  "fetchedAt": "2026-10-23T14:00:33.748923+00:00",
  "operationIds": [
    "list_sales_shipments",
    "get_sales_shipments",
    "create_sales_shipments",
    "update_sales_shipments",
    "delete_sales_shipments",
    "delete_sales_shipments_lines"
  ],
  "fieldTables": [
    {
      "heading": "GET Sales Shipments",
      "anchor": "get-sales-shipments",
      "summary": "Available Fields for GET Sales Shipments",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Notes"
        ],
        [
          "Comments",
          "String",
          "500",
          "Can be edited after the sales shipment is dispatched."
        ],
        [
          "CreatedBy",
          "String",
          "50",
          ""
        ],
        [
          "CreatedOn",
          "DateTime",
          "",
          ""
        ],
        [
          "Customer",
          "Customer collection",
          "",
          ""
        ],
        [
          "CustomerRef",
          "String",
          "500",
          ""
        ],
        [
          "DeliveryCity",
          "String",
          "500",
          ""
        ],
        [
          "DeliveryContact",
          "DeliveryContact collection",
          "",
          ""
        ],
        [
          "DeliveryCountry",
          "String",
          "500",
          ""
        ],
        [
          "DeliveryInstruction",
          "String",
          "500",
          ""
        ],
        [
          "DeliveryName",
          "String",
          "500",
          ""
        ],
        [
          "DeliveryPostCode",
          "String",
          "50",
          ""
        ],
        [
          "DeliveryRegion",
          "String",
          "500",
          ""
        ],
        [
          "DeliveryStreetAddress",
          "String",
          "500",
          ""
        ],
        [
          "DeliveryStreetAddress2",
          "String",
          "500",
          ""
        ],
        [
          "DeliverySuburb",
          "String",
          "500",
          ""
        ],
        [
          "DispatchDate",
          "DateTime",
          "",
          ""
        ],
        [
          "Guid",
          "Guid",
          "",
          "Unique identifier. Can only be set when adding a record."
        ],
        [
          "Incoterm",
          "String",
          "3",
          ""
        ],
        [
          "LastModifiedBy",
          "String",
          "50",
          ""
        ],
        [
          "LastModifiedOn",
          "DateTime",
          "",
          ""
        ],
        [
          "NatureOfTransactionCode",
          "String",
          "2",
          ""
        ],
        [
          "NumberOfPackages",
          "Integer",
          "",
          ""
        ],
        [
          "OrderNumber",
          "String",
          "20",
          ""
        ],
        [
          "OrderGuid",
          "Guid",
          "",
          ""
        ],
        [
          "ReceiverEORI",
          "String",
          "20",
          ""
        ],
        [
          "SalesShipmentLines",
          "SalesShipmentLine collection",
          "",
          ""
        ],
        [
          "ShipmentNumber",
          "String",
          "25",
          ""
        ],
        [
          "ShipmentStatus",
          "String",
          "20",
          ""
        ],
        [
          "ShipmentWeight",
          "String",
          "50",
          ""
        ],
        [
          "ShippingCompany",
          "ShippingCompany collection",
          "",
          "Can be edited after the sales shipment is dispatched."
        ],
        [
          "ShipperEORI",
          "String",
          "20",
          ""
        ],
        [
          "TotalCommercialValue",
          "Decimal",
          "",
          ""
        ],
        [
          "TrackingNumber",
          "String",
          "100",
          "Can be edited after the sales shipment is dispatched."
        ],
        [
          "Warehouse",
          "Warehouse collection",
          "",
          ""
        ]
      ]
    },
    {
      "heading": "GET Sales Shipments",
      "anchor": "get-sales-shipments",
      "summary": "Available Fields for Customer",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Notes"
        ],
        [
          "CustomerCode",
          "String",
          "500",
          ""
        ],
        [
          "CustomerName",
          "String",
          "500",
          ""
        ],
        [
          "Guid",
          "Guid",
          "",
          "Unique identifier. Can only be set when adding a record."
        ],
        [
          "LastModifiedOn",
          "DateTime",
          "",
          ""
        ]
      ]
    },
    {
      "heading": "GET Sales Shipments",
      "anchor": "get-sales-shipments",
      "summary": "Available Fields for Delivery Contact",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Notes"
        ],
        [
          "EmailAddress",
          "String",
          "500",
          ""
        ],
        [
          "FirstName",
          "String",
          "500",
          ""
        ],
        [
          "Guid",
          "Guid",
          "",
          "Unique identifier. Can only be set when adding a record."
        ],
        [
          "LastName",
          "String",
          "500",
          ""
        ],
        [
          "MobilePhone",
          "String",
          "500",
          ""
        ],
        [
          "OfficePhone",
          "String",
          "500",
          ""
        ],
        [
          "PhoneNumber",
          "String",
          "500",
          ""
        ]
      ]
    },
    {
      "heading": "GET Sales Shipments",
      "anchor": "get-sales-shipments",
      "summary": "Available Fields for Shipping Company",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Notes"
        ],
        [
          "Guid",
          "Guid",
          "",
          "Unique identifier. Can only be set when adding a record."
        ],
        [
          "Name",
          "String",
          "256",
          ""
        ]
      ]
    },
    {
      "heading": "GET Sales Shipments",
      "anchor": "get-sales-shipments",
      "summary": "Available Fields for Warehouse",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Notes"
        ],
        [
          "Guid",
          "Guid",
          "",
          "Unique identifier. Can only be set when adding a record."
        ],
        [
          "WarehouseCode",
          "String",
          "15",
          ""
        ],
        [
          "WarehouseName",
          "String",
          "100",
          ""
        ]
      ]
    },
    {
      "heading": "GET Sales Shipments",
      "anchor": "get-sales-shipments",
      "summary": "Available Fields for Sales Shipment Line",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Notes"
        ],
        [
          "BatchNumbers",
          "BatchNumber collection",
          "",
          ""
        ],
        [
          "CommercialMonetaryValue",
          "Decimal",
          "",
          ""
        ],
        [
          "CreatedBy",
          "String",
          "50",
          ""
        ],
        [
          "CreatedOn",
          "DateTime",
          "",
          ""
        ],
        [
          "Guid",
          "Guid",
          "",
          "Unique identifier. Can only be set when adding a record."
        ],
        [
          "LastModifiedBy",
          "String",
          "50",
          ""
        ],
        [
          "LastModifiedOn",
          "DateTime",
          "",
          ""
        ],
        [
          "LineNumber",
          "Integer",
          "",
          "Line number maps to SalesOrderLineNumber"
        ],
        [
          "Product",
          "Product collection",
          "",
          ""
        ],
        [
          "SalesOrderLineId",
          "Integer",
          "",
          ""
        ],
        [
          "SalesOrderLineNumber",
          "Integer",
          "",
          ""
        ],
        [
          "SerialNumbers",
          "SerialNumber collection",
          "",
          ""
        ],
        [
          "ShipmentQty",
          "Decimal",
          "",
          ""
        ],
        [
          "UnitCost",
          "Decimal",
          "",
          ""
        ],
        [
          "UnitCostAtTimeOfDispatch",
          "Decimal",
          "",
          ""
        ]
      ]
    },
    {
      "heading": "GET Sales Shipments",
      "anchor": "get-sales-shipments",
      "summary": "Available Fields for Batch Number",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Notes"
        ],
        [
          "ExpiryDate",
          "Date",
          "",
          ""
        ],
        [
          "Guid",
          "Guid",
          "",
          "Unique identifier. Can only be set when adding a record."
        ],
        [
          "LastModifiedOn",
          "DateTime",
          "",
          ""
        ],
        [
          "Number",
          "String",
          "50",
          ""
        ],
        [
          "Quantity",
          "Decimal",
          "",
          ""
        ]
      ]
    },
    {
      "heading": "GET Sales Shipments",
      "anchor": "get-sales-shipments",
      "summary": "Available Fields for Product",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Notes"
        ],
        [
          "Guid",
          "Guid",
          "",
          "Unique identifier. Can only be set when adding a record."
        ],
        [
          "ProductCode",
          "String",
          "100",
          ""
        ],
        [
          "ProductDescription",
          "String",
          "500",
          ""
        ]
      ]
    },
    {
      "heading": "GET Sales Shipments",
      "anchor": "get-sales-shipments",
      "summary": "Available Fields for Serial Number",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Notes"
        ],
        [
          "Guid",
          "Guid",
          "",
          "Unique identifier. Can only be set when adding a record."
        ],
        [
          "Identifier",
          "String",
          "50",
          ""
        ],
        [
          "LastModifiedOn",
          "DateTime",
          "",
          ""
        ]
      ]
    },
    {
      "heading": "POST / PUT Sales Shipments",
      "anchor": "post--put-sales-shipments",
      "summary": "Available Fields for POST/PUT Sales Shipments",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT",
          "Notes"
        ],
        [
          "Comments",
          "String",
          "500",
          "Optional",
          "Optional",
          ""
        ],
        [
          "DispatchDate",
          "DateTime",
          "yyyy-mm-dd",
          "Optional",
          "Optional",
          ""
        ],
        [
          "Guid",
          "Guid",
          "",
          "Required",
          "Required",
          "Unique identifier. Can only be set when adding a record."
        ],
        [
          "NumberOfPackages",
          "Integer",
          "",
          "Optional",
          "Optional",
          ""
        ],
        [
          "OrderNumber",
          "String",
          "20",
          "Required",
          "N/A",
          ""
        ],
        [
          "SalesShipmentLines",
          "SalesShipmentLine collection",
          "",
          "Required",
          "Required",
          "At least one shipment line is required."
        ],
        [
          "ShipmentStatus",
          "String",
          "20",
          "Required",
          "Required when order management is enabled.",
          ""
        ],
        [
          "ShipmentWeight",
          "String",
          "50",
          "Optional",
          "Optional",
          ""
        ],
        [
          "ShippingCompany",
          "ShippingCompany collection",
          "",
          "Optional",
          "Optional",
          ""
        ],
        [
          "TrackingNumber",
          "String",
          "100",
          "Optional",
          "Optional",
          ""
        ]
      ]
    },
    {
      "heading": "POST / PUT Sales Shipments",
      "anchor": "post--put-sales-shipments",
      "summary": "Available Fields for Shipping Company",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT",
          "Notes"
        ],
        [
          "Guid",
          "Guid",
          "",
          "Optional",
          "Optional",
          ""
        ],
        [
          "Name",
          "String",
          "256",
          "Optional",
          "Optional",
          ""
        ]
      ]
    },
    {
      "heading": "POST / PUT Sales Shipments",
      "anchor": "post--put-sales-shipments",
      "summary": "Available Fields for Sales Shipment Line",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT",
          "Notes"
        ],
        [
          "BatchNumbers",
          "BatchNumber collection",
          "",
          "Optional",
          "Optional",
          "If the serialBatch filter value is set to true: For POST, the batch numbers must match those assigned to the Sales Order. For PUT, the batch numbers provided must be valid and will be assigned to the shipment regardless of any batch numbers assigned to the Sales Order."
        ],
        [
          "Guid",
          "Guid",
          "",
          "N/A",
          "Optional",
          "If the Guid is set, it will update the existing lines instead of recreating them."
        ],
        [
          "Product",
          "Product collection",
          "",
          "Required",
          "Required",
          ""
        ],
        [
          "SalesOrderLineNumber",
          "Integer",
          "",
          "Optional",
          "Optional",
          "Sales Order line mapping. If the sales order line is specified, it will validate if the product for shipment line is the same as the product of the sales order line."
        ],
        [
          "SerialNumbers",
          "SerialNumber collection",
          "",
          "Optional",
          "Optional",
          "If the serialBatch filter value is set to true: For POST, the serial numbers must match those assigned to the Sales Order. For PUT, the serial numbers provided must be valid and will be assigned to the shipment regardless of any serial numbers assigned to the Sales Order."
        ],
        [
          "ShipmentQty",
          "Decimal",
          "",
          "Required",
          "Required",
          ""
        ]
      ]
    },
    {
      "heading": "POST / PUT Sales Shipments",
      "anchor": "post--put-sales-shipments",
      "summary": "Available Fields for Batch Number",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT",
          "Notes"
        ],
        [
          "ExpiryDate",
          "Date",
          "",
          "Optional",
          "Optional",
          ""
        ],
        [
          "Guid",
          "Guid",
          "",
          "Optional",
          "Optional",
          ""
        ],
        [
          "Number",
          "String",
          "50",
          "Optional",
          "Optional",
          ""
        ],
        [
          "Quantity",
          "Decimal",
          "",
          "Required",
          "Required",
          ""
        ]
      ]
    },
    {
      "heading": "POST / PUT Sales Shipments",
      "anchor": "post--put-sales-shipments",
      "summary": "Available Fields for Serial Number",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT",
          "Notes"
        ],
        [
          "Guid",
          "Guid",
          "",
          "Optional",
          "Optional",
          ""
        ],
        [
          "Identifier",
          "String",
          "50",
          "Required",
          "Optional",
          ""
        ]
      ]
    },
    {
      "heading": "POST / PUT Sales Shipments",
      "anchor": "post--put-sales-shipments",
      "summary": "Available Fields for Product",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT",
          "Notes"
        ],
        [
          "Guid",
          "Guid",
          "",
          "Optional",
          "Optional",
          "Unique identifier. Can only be set when adding a record."
        ],
        [
          "ProductCode",
          "String",
          "100",
          "Required",
          "Required",
          ""
        ]
      ]
    }
  ],
  "filterTables": [
    {
      "heading": "GET Sales Shipments",
      "anchor": "get-sales-shipments",
      "summary": "Available Filters for GET Sales Shipments",
      "rows": [
        [
          "Filter",
          "Description"
        ],
        [
          "endDate",
          "Returns shipments created before a specified date."
        ],
        [
          "modifiedSince",
          "Returns shipments created or edited after a specified date in UTC time zone. For example: modifiedSince=2024-04-17T23:11:05"
        ],
        [
          "orderBy",
          "Permitted value: ShipmentNumber. Defaults to LastModifiedOn if not supplied."
        ],
        [
          "orderNumber",
          "Returns all shipments for the specified order number. If specified, it overrides all other filters."
        ],
        [
          "pageSize",
          "Specifies the page size for pagination. Default page size is 200 shipments. Note: Requesting large numbers of shipments can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests."
        ],
        [
          "serialBatch",
          "False by default. If set to true then the attributes SerialNumbers and BatchNumbers are displayed."
        ],
        [
          "shipmentStatus",
          "Returns shipments for the specified status."
        ],
        [
          "sort",
          "Works in conjunction with orderBy to sort the list in ascending or descending order. Permitted values are asc (default) or desc."
        ],
        [
          "startDate",
          "Returns shipments created after a specified date."
        ],
        [
          "warehouseCode",
          "Returns sales shipments with the specified warehouse code."
        ]
      ]
    },
    {
      "heading": "POST / PUT Sales Shipments",
      "anchor": "post--put-sales-shipments",
      "summary": "Available Filters for POST/PUT Sales Shipments",
      "rows": [
        [
          "Filter",
          "Description"
        ],
        [
          "serialBatch",
          "If set to true: For a POST request, the serial and batch numbers are assigned provided they are already assigned to the Sales Order. For a PUT request, the serial and batch numbers are assigned regardless of whether they are assigned on the Sales Order."
        ]
      ]
    }
  ],
  "documentationNotes": [
    "The SalesShipments resource allows shipments on a Sales Order to be listed and viewed. An individual shipment details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX ) to the URI.",
    "Note: Default ordering is done by SalesOrderLineNumber ascending.",
    "Note: Updates made to existing SalesShipments will overwrite existing information, fields left blank will be removed.",
    "Note: At a minimum, a valid Guid or Name is required.",
    "Note: At a minimum, a valid Guid or Number is required."
  ]
}

What has been verified

Documented coverage
145 operation variants retained from official provider documentation, with 43 resource records and their field and filter tables. These counts describe documentation, not proven live workflows.
Agent connection
Actual Claude Desktop and web connection, model-selected platform utility calls, renewal after natural token expiry and revoked-access rejection passed. Codex and Claude Code authentication and discovery were also checked. These tests made no provider business requests.
Live business workflows
Awaiting an authorised Unleashed account. Provider reads, writes and business workflows are not yet verified.
More software, the same workspace

Explore Procore MCP

Inspect the Procore catalogue and the approval and account requirements while live acceptance is still pending.

Explore Procore →