Logistics

Shipments

The shipments operations of the Core API.

Base URL: https://api.miridia.io. Read Authentication and Conventions before you call these operations.

Method	Path	Operation
GET	`/api/v1/shipments/overview`	Get shipment overview
GET	`/api/v1/shipments/{shipmentId}`	Get shipment
PUT	`/api/v1/shipments/{shipmentId}`	Update shipment
PATCH	`/api/v1/shipments/{shipmentId}`	Patch shipment
DELETE	`/api/v1/shipments/{shipmentId}`	Delete shipment
GET	`/api/v1/shipments`	Get shipments
POST	`/api/v1/shipments`	Create shipment
GET	`/api/v1/shipments/unassigned`	Get unassigned shipments
POST	`/api/v1/shipments/delete`	Bulk delete shipments
GET	`/api/v1/shipments/{shipmentId}/traces`	Get shipment traces
POST	`/api/v1/shipments/{shipmentId}/collect`	Request shipment collection
GET	`/api/v1/shipments/{shipmentId}/comments`	Get shipment comments
POST	`/api/v1/shipments/{shipmentId}/comments`	Add shipment comment
DELETE	`/api/v1/shipments/{shipmentId}/comments/{commentId}`	Delete shipment comment
GET	`/api/v1/shipments/{shipmentId}/quotations`	Get shipment quotations
GET	`/api/v1/shipments/{shipmentId}/quotations/{quotationId}`	Get shipment quotation
DELETE	`/api/v1/shipments/{shipmentId}/quotations/{quotationId}`	Delete shipment quotation
POST	`/api/v1/shipments/{shipmentId}/quotations/{quotationId}/accept`	Accept shipment quotation
DELETE	`/api/v1/shipments/{shipmentId}/quotations/{quotationId}/accept`	Withdraw shipment quotation acceptance
POST	`/api/v1/shipments/{shipmentId}/quotations/refresh`	Refresh shipment quotations
POST	`/api/v1/shipments/{shipmentId}/waypoints`	Create shipment waypoint
DELETE	`/api/v1/shipments/{shipmentId}/waypoints/{waypointId}`	Delete shipment waypoint
POST	`/api/v1/shipments/{shipmentId}/attachments`	Add shipment file attachment
DELETE	`/api/v1/shipments/{shipmentId}/attachments/{attachmentId}`	Remove shipment file attachment
POST	`/api/v1/shipments/{shipmentId}/metadata`	Add shipment metadata

Get shipment overview

GET/api/v1/shipments/overview

Access. Send a bearer token or an API key. The caller needs the Shipments view permission.

Response

200. Returns a SingleResult envelope. The data field is ShipmentOverview.

Request

curl -X GET "https://api.miridia.io/api/v1/shipments/overview" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": {
    "total": 0,
    "active": 0,
    "pending": 0,
    "closed": 0,
    "complete": 0
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Get shipment

GET/api/v1/shipments/{shipmentId}

Access. Send a bearer token or an API key. The caller needs the Shipments view permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is ShipmentResponse.

Request

curl -X GET "https://api.miridia.io/api/v1/shipments/{shipmentId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Update shipment

PUT/api/v1/shipments/{shipmentId}

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes

Request body

Send JSON with the shape UpdateShipmentCommand.

Field	Type	Required	Description
`id`	`string (uuid)`	No
`originAddress`	`UpdateAddressRequest`	No
`destinationAddress`	`UpdateAddressRequest`	No
`handlingType`	`enum HandlingType`	Yes	One of: `Unknown`, `Delivery`, `Collection`, `Unassigned`.
`fulfillmentType`	`enum FulfillmentType`	No	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`status`	`enum ShipmentStatus`	Yes	One of: `Unknown`, `Active`, `PendingCollection`, `CollectionUnassigned`, `CollectionAssigned`, `CollectionRejected`, `CollectionException`, `CollectionFailedAttempt`, `Collected`, `AtHub`, `ReturnedToHub`, `InTransit`, `AtDestinationHub`, `DeliveryUnassigned`, `DeliveryAssigned`, `DeliveryRejected`, `DeliveryException`, `OutForDelivery`, `DeliveryFailedAttempt`, `InLocker`, `Delivered`, `Cancelled`.
`hasDimensions`	`boolean`	No
`description`	`string`	No
`weight`	`number (double)`	No
`height`	`number (double)`	No
`width`	`number (double)`	No
`length`	`number (double)`	No
`dateOfDeparture`	`string (date-time)`	No
`dateOfScheduledDelivery`	`string (date-time)`	No
`earliestDateOfDelivery`	`string (date-time)`	No
`latestDateOfDelivery`	`string (date-time)`	No
`deliveryTimeUpperLimit`	`string (date-time)`	No
`deliveryTimeLowerLimit`	`string (date-time)`	No
`dateOfScheduledCollection`	`string (date-time)`	No
`earliestDateOfCollection`	`string (date-time)`	No
`latestDateOfCollection`	`string (date-time)`	No
`collectionTimeUpperLimit`	`string (date-time)`	No
`collectionTimeLowerLimit`	`string (date-time)`	No

Response

200. Returns a SingleResult envelope. The data field is ShipmentResponse.

Request

curl -X PUT "https://api.miridia.io/api/v1/shipments/{shipmentId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "originAddress": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "placeId": "string",
    "name": "string",
    "website": "https://example.com",
    "fullAddress": "string",
    "street": "string",
    "suburb": "string",
    "city": "string",
    "country": "string",
    "postcode": "string",
    "unit": "string",
    "number": "string",
    "province": "string",
    "latitude": 0,
    "longitude": 0
  },
  "destinationAddress": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "placeId": "string",
    "name": "string",
    "website": "https://example.com",
    "fullAddress": "string",
    "street": "string",
    "suburb": "string",
    "city": "string",
    "country": "string",
    "postcode": "string",
    "unit": "string",
    "number": "string",
    "province": "string",
    "latitude": 0,
    "longitude": 0
  },
  "handlingType": "Delivery",
  "fulfillmentType": "Package",
  "status": "Active",
  "hasDimensions": true,
  "description": "string",
  "weight": 0,
  "height": 0,
  "width": 0,
  "length": 0,
  "dateOfDeparture": "2026-09-29T08:00:00Z",
  "dateOfScheduledDelivery": "2026-09-29T08:00:00Z",
  "earliestDateOfDelivery": "2026-09-29T08:00:00Z",
  "latestDateOfDelivery": "2026-09-29T08:00:00Z",
  "deliveryTimeUpperLimit": "2026-09-29T08:00:00Z",
  "deliveryTimeLowerLimit": "2026-09-29T08:00:00Z",
  "dateOfScheduledCollection": "2026-09-29T08:00:00Z",
  "earliestDateOfCollection": "2026-09-29T08:00:00Z",
  "latestDateOfCollection": "2026-09-29T08:00:00Z",
  "collectionTimeUpperLimit": "2026-09-29T08:00:00Z",
  "collectionTimeLowerLimit": "2026-09-29T08:00:00Z"
}'

Partially update a shipment's status and/or pickup/delivery/departure dates. Only fields present (non-null) in the body are applied. Absorbs the former dates-only endpoint; Status is a raw override (same power as the full PUT update).

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes

Request body

Send JSON with the shape PatchShipmentCommand. Partial update of a shipment's editable header fields. Every field is nullable and only applied when non-null, so a caller can PATCH a single property without supplying (and clobbering) the rest of the shipment. Absorbs the former dates-only endpoint.

Field	Type	Required	Description
`shipmentId`	`string (uuid)`	No	Bound from the route, not the body.
`status`	`enum ShipmentStatus`	No	One of: `Unknown`, `Active`, `PendingCollection`, `CollectionUnassigned`, `CollectionAssigned`, `CollectionRejected`, `CollectionException`, `CollectionFailedAttempt`, `Collected`, `AtHub`, `ReturnedToHub`, `InTransit`, `AtDestinationHub`, `DeliveryUnassigned`, `DeliveryAssigned`, `DeliveryRejected`, `DeliveryException`, `OutForDelivery`, `DeliveryFailedAttempt`, `InLocker`, `Delivered`, `Cancelled`.
`dateOfPickup`	`string (date-time)`	No
`dateOfDelivery`	`string (date-time)`	No
`dateOfDeparture`	`string (date-time)`	No

Response

200. Returns a SingleResult envelope. The data field is ShipmentResponse.

Request

curl -X PATCH "https://api.miridia.io/api/v1/shipments/{shipmentId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "shipmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Active",
  "dateOfPickup": "2026-09-29T08:00:00Z",
  "dateOfDelivery": "2026-09-29T08:00:00Z",
  "dateOfDeparture": "2026-09-29T08:00:00Z"
}'

Delete shipment

DELETE/api/v1/shipments/{shipmentId}

Access. Send a bearer token or an API key. The caller needs the Shipments delete permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is boolean.

Request

curl -X DELETE "https://api.miridia.io/api/v1/shipments/{shipmentId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": true,
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Get shipments

GET/api/v1/shipments

Access. Send a bearer token or an API key. The caller needs the Shipments view permission.

Parameters

Name	In	Type	Required	Description
`Page`	query	`integer (int32)`	No	Limits: minimum 1.
`PageSize`	query	`integer (int32)`	No	Limits: minimum 1, maximum 100.
`$orderby`	query	`string`	No	Example: "created_at desc" or "name asc"
`$filter`	query	`string`	No	Apply a ODATA style filter to the query to add a fixed constraint. For example, if you want to filter by the creation date, you would set the filter to "created_at ge 2022-01-01". Or if you want to filter by a specific status, you would set the filter to "status eq 'active'".
`$search`	query	`string`	No	Provide a search value which would inherit the 'CONTAINS' behaviour.
`from`	query	`string`	No
`to`	query	`string`	No
`customerId`	query	`string (uuid)`	No
`status`	query	`string`	No

Response

200. Returns a PagedResult envelope. Each item in data is ShipmentResponse.

Request

curl -X GET "https://api.miridia.io/api/v1/shipments" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Create shipment

POST/api/v1/shipments

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Request body

Send JSON with the shape CreateShipmentCommand.

Field	Type	Required	Description
`requiresApproval`	`boolean`	No
`description`	`string`	No	Limits: maximum 3000 characters.
`handlingType`	`enum HandlingType`	Yes	One of: `Unknown`, `Delivery`, `Collection`, `Unassigned`.
`fulfillmentType`	`enum FulfillmentType`	No	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`status`	`enum ShipmentStatus`	No	One of: `Unknown`, `Active`, `PendingCollection`, `CollectionUnassigned`, `CollectionAssigned`, `CollectionRejected`, `CollectionException`, `CollectionFailedAttempt`, `Collected`, `AtHub`, `ReturnedToHub`, `InTransit`, `AtDestinationHub`, `DeliveryUnassigned`, `DeliveryAssigned`, `DeliveryRejected`, `DeliveryException`, `OutForDelivery`, `DeliveryFailedAttempt`, `InLocker`, `Delivered`, `Cancelled`.
`hasDimensions`	`boolean`	No
`geometry`	`ShipmentDimensionsRequest`	No
`dateOfDeparture`	`string (date-time)`	No
`delivery`	`DeliveryRequest`	No
`collection`	`CollectionRequest`	No
`customerId`	`string (uuid)`	No

Response

200. Returns a SingleResult envelope. The data field is ShipmentResponse.

Request

curl -X POST "https://api.miridia.io/api/v1/shipments" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "requiresApproval": true,
  "description": "string",
  "handlingType": "Delivery",
  "fulfillmentType": "Package",
  "status": "Active",
  "hasDimensions": true,
  "geometry": {
    "weight": 0,
    "width": 0,
    "length": 0,
    "height": 0,
    "lengthType": "Centimeter",
    "weightType": "Kilogram",
    "presetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "dateOfDeparture": "2026-09-29T08:00:00Z",
  "delivery": {
    "estimatedDateOfDelivery": "2026-09-29T08:00:00Z",
    "dateOfDelivery": "2026-09-29T08:00:00Z",
    "earliestDateOfDelivery": "2026-09-29T08:00:00Z",
    "latestDateOfDelivery": "2026-09-29T08:00:00Z",
    "deliverBeforeTime": "string",
    "deliverAfterTime": "string",
    "additionalRemarks": "string"
  },
  "collection": {
    "dateOfCollection": "2026-09-29T08:00:00Z",
    "estimatedDateOfCollection": "2026-09-29T08:00:00Z",
    "dateOfScheduledCollection": "2026-09-29T08:00:00Z",
    "earliestDateOfCollection": "2026-09-29T08:00:00Z",
    "latestDateOfCollection": "2026-09-29T08:00:00Z",
    "collectBeforeTime": "string",
    "collectAfterTime": "string",
    "additionalRemarks": "string"
  },
  "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Get unassigned shipments

GET/api/v1/shipments/unassigned

Access. Send a bearer token or an API key. The caller needs the Shipments view permission.

Response

200. Returns a PagedResult envelope. Each item in data is ShipmentResponse.

Request

curl -X GET "https://api.miridia.io/api/v1/shipments/unassigned" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Bulk delete shipments

POST/api/v1/shipments/delete

Bulk delete shipments handled as HTTP POST (action endpoint for bulk operations)

Access. Send a bearer token or an API key. The caller needs the Shipments delete permission.

Request body

Send JSON of type DeleteShipmentCommand[].

Response

200. Returns a PagedResult envelope. Each item in data is ShipmentResponse.

Request

curl -X POST "https://api.miridia.io/api/v1/shipments/delete" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]'

Get shipment traces

GET/api/v1/shipments/{shipmentId}/traces

Access. Send a bearer token or an API key. The caller needs the Shipments view permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes

Response

200. Returns a PagedResult envelope. Each item in data is ShipmentTraceResponse.

Request

curl -X GET "https://api.miridia.io/api/v1/shipments/{shipmentId}/traces" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "count": 0,
  "totalCount": 0,
  "page": 0,
  "finalPage": 0,
  "pageSize": 0,
  "hasMore": true,
  "statusCode": "OK",
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "message": "string",
      "shipmentStatus": "Active",
      "activityAction": "StatusChange",
      "dateCreated": "2026-09-29T08:00:00Z",
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "activityType": "System"
    }
  ],
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ]
}

Request shipment collection

POST/api/v1/shipments/{shipmentId}/collect

Once a carrier has been assigned to a shipment, a collection can be requested by scheduling a collection date.

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes

Request body

Send JSON with the shape RequestShipmentCollectionRequest.

Field	Type	Required	Description
`dateOfCollection`	`string (date-time)`	Yes

Response

200. Returns a SingleResult envelope. The data field is ShipmentResponse.

Request

curl -X POST "https://api.miridia.io/api/v1/shipments/{shipmentId}/collect" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "dateOfCollection": "2026-09-29T08:00:00Z"
}'

Get shipment comments

GET/api/v1/shipments/{shipmentId}/comments

Returns the user-authored comments on this shipment, oldest first.

Access. Send a bearer token or an API key. The caller needs the Shipments view permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes

Response

200. Returns a PagedResult envelope. Each item in data is ShipmentCommentResponse.

Request

curl -X GET "https://api.miridia.io/api/v1/shipments/{shipmentId}/comments" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "count": 0,
  "totalCount": 0,
  "page": 0,
  "finalPage": 0,
  "pageSize": 0,
  "hasMore": true,
  "statusCode": "OK",
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "shipmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "comment": "string",
      "user": {},
      "dateCreated": "2026-09-29T08:00:00Z"
    }
  ],
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ]
}

Add shipment comment

POST/api/v1/shipments/{shipmentId}/comments

Adds a comment to the shipment, attributed to the authenticated user.

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes

Request body

Send JSON with the shape ShipmentCommentRequest.

Field	Type	Required	Description
`comment`	`string`	Yes	Limits: maximum 4000 characters.

Response

200. Returns a SingleResult envelope. The data field is ShipmentCommentResponse.

Request

curl -X POST "https://api.miridia.io/api/v1/shipments/{shipmentId}/comments" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "comment": "string"
}'

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "shipmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "comment": "string",
    "user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "displayName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string"
    },
    "dateCreated": "2026-09-29T08:00:00Z"
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Delete shipment comment

DELETE/api/v1/shipments/{shipmentId}/comments/{commentId}

Deletes a comment from the shipment.

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes
`commentId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is boolean.

Request

curl -X DELETE "https://api.miridia.io/api/v1/shipments/{shipmentId}/comments/{commentId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": true,
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Get shipment quotations

GET/api/v1/shipments/{shipmentId}/quotations

Retrieves all quotations for a shipment.

Access. Send a bearer token or an API key. The caller needs the Shipments view permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes

Response

200. Returns a PagedResult envelope. Each item in data is ShipmentQuotationResponse.

Request

curl -X GET "https://api.miridia.io/api/v1/shipments/{shipmentId}/quotations" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Get shipment quotation

GET/api/v1/shipments/{shipmentId}/quotations/{quotationId}

Retrieves one quotation of a shipment.

Access. Send a bearer token or an API key. The caller needs the Shipments view permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes
`quotationId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is ShipmentQuotationResponse.

Request

curl -X GET "https://api.miridia.io/api/v1/shipments/{shipmentId}/quotations/{quotationId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Delete shipment quotation

DELETE/api/v1/shipments/{shipmentId}/quotations/{quotationId}

Deletes one quotation of a shipment. The accepted quotation cannot be deleted.

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes
`quotationId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is boolean.

Request

curl -X DELETE "https://api.miridia.io/api/v1/shipments/{shipmentId}/quotations/{quotationId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": true,
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Accept shipment quotation

POST/api/v1/shipments/{shipmentId}/quotations/{quotationId}/accept

Accepts one quotation of a shipment. Any other accepted quotation of the same shipment is reset, so a shipment never carries two accepted prices.

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes
`quotationId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is ShipmentResponse.

Request

curl -X POST "https://api.miridia.io/api/v1/shipments/{shipmentId}/quotations/{quotationId}/accept" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Withdraw shipment quotation acceptance

DELETE/api/v1/shipments/{shipmentId}/quotations/{quotationId}/accept

Withdraws the acceptance of a quotation. The quotation stays, and the shipment carries no accepted price until one is accepted again.

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes
`quotationId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is ShipmentResponse.

Request

curl -X DELETE "https://api.miridia.io/api/v1/shipments/{shipmentId}/quotations/{quotationId}/accept" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Refresh shipment quotations

POST/api/v1/shipments/{shipmentId}/quotations/refresh

Clears the quotations of a shipment and asks the carriers to quote it again. The new prices arrive through the integration callback, so the response returns the shipment, not the quotations.

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes	The shipment GUID
`fulfillmentProviderId`	query	`integer (int32)`	No	Limits the request to one carrier

Response

200. Returns a SingleResult envelope. The data field is ShipmentResponse.

Request

curl -X POST "https://api.miridia.io/api/v1/shipments/{shipmentId}/quotations/refresh" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Create shipment waypoint

POST/api/v1/shipments/{shipmentId}/waypoints

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes

Request body

Send JSON with the shape CreateShipmentWaypointCommand.

Field	Type	Required	Description
`shipmentId`	`string (uuid)`	No
`locationId`	`string (uuid)`	Yes
`title`	`string`	No	Limits: maximum 150 characters.

Response

200. Returns a SingleResult envelope. The data field is ShipmentWaypointResponse.

Request

curl -X POST "https://api.miridia.io/api/v1/shipments/{shipmentId}/waypoints" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "shipmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "locationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string"
}'

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "segmentPosition": 0,
    "title": "string",
    "dateCheckedIn": "2026-09-29T08:00:00Z",
    "dateCheckedOut": "2026-09-29T08:00:00Z",
    "dateCreated": "2026-09-29T08:00:00Z",
    "dateModified": "2026-09-29T08:00:00Z",
    "address": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "placeId": "string",
      "name": "string",
      "website": "string",
      "fullAddress": "string",
      "street": "string",
      "suburb": "string",
      "city": "string",
      "country": "string",
      "postcode": "string",
      "unit": "string",
      "number": "string",
      "province": "string",
      "latitude": 0,
      "longitude": 0
    }
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Delete shipment waypoint

DELETE/api/v1/shipments/{shipmentId}/waypoints/{waypointId}

Access. Send a bearer token or an API key. The caller needs the Shipments delete permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes
`waypointId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is ShipmentWaypointResponse.

Request

curl -X DELETE "https://api.miridia.io/api/v1/shipments/{shipmentId}/waypoints/{waypointId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "segmentPosition": 0,
    "title": "string",
    "dateCheckedIn": "2026-09-29T08:00:00Z",
    "dateCheckedOut": "2026-09-29T08:00:00Z",
    "dateCreated": "2026-09-29T08:00:00Z",
    "dateModified": "2026-09-29T08:00:00Z",
    "address": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "placeId": "string",
      "name": "string",
      "website": "string",
      "fullAddress": "string",
      "street": "string",
      "suburb": "string",
      "city": "string",
      "country": "string",
      "postcode": "string",
      "unit": "string",
      "number": "string",
      "province": "string",
      "latitude": 0,
      "longitude": 0
    }
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Add shipment file attachment

POST/api/v1/shipments/{shipmentId}/attachments

Step 2 of file attachment: associates a previously uploaded file with this shipment. Upload the file first via POST /api/files/single, then pass the returned FileAttachment id here.

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes

Request body

Send JSON with the shape AddFileAttachmentRequest. Adds an attachment to an entity's metadata attachment collection. Two shapes, discriminated by Type: - File (default). title and url are required and taken as-is from the request; FileAttachmentId on the resulting metadata entry stays Guid.Empty.

Field	Type	Required	Description
`type`	`enum MetadataAttachmentType`	No	One of: `File`, `Link`.
`fileId`	`string (uuid)`	No	Required when `Type` is `File`.
`title`	`string`	No	Required when `Type` is `Link`. Ignored for `File`.
`url`	`string`	No	Required when `Type` is `Link`. Ignored for `File`.
`description`	`string`	No

Response

200. Returns a SingleResult envelope. The data field is ShipmentResponse.

Request

curl -X POST "https://api.miridia.io/api/v1/shipments/{shipmentId}/attachments" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "File",
  "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "url": "string",
  "description": "string"
}'

Remove shipment file attachment

DELETE/api/v1/shipments/{shipmentId}/attachments/{attachmentId}

Removes a previously associated attachment (file or link) from this shipment by its metadata attachment entry id.

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes
`attachmentId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is ShipmentResponse.

Request

curl -X DELETE "https://api.miridia.io/api/v1/shipments/{shipmentId}/attachments/{attachmentId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Add shipment metadata

POST/api/v1/shipments/{shipmentId}/metadata

Merges the provided key/value pairs into the shipment's free-form metadata dictionary. A non-null value adds or overwrites the key; a null value removes the key.

Access. Send a bearer token or an API key. The caller needs the Shipments modify permission.

Parameters

Name	In	Type	Required	Description
`shipmentId`	path	`string (uuid)`	Yes

Request body

Send JSON of type map<string, string>.

Response

200. Returns a SingleResult envelope. The data field is ShipmentResponse.

Request

curl -X POST "https://api.miridia.io/api/v1/shipments/{shipmentId}/metadata" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "string"
}'

Models

The operations on this page use these object types. Select a type to see its fields.

AddressResponse

Field	Type	Description
`id`	`string (uuid)`
`placeId`	`string`
`name`	`string`
`website`	`string`
`fullAddress`	`string`
`street`	`string`
`suburb`	`string`
`city`	`string`
`country`	`string`
`postcode`	`string`
`unit`	`string`
`number`	`string`
`province`	`string`
`latitude`	`number (double)`
`longitude`	`number (double)`

BusinessResponse

Field	Type	Description
`id`	`string (uuid)`
`registeredName`	`string`
`registrationNumber`	`string`
`displayName`	`string`
`phoneNumber`	`string`
`website`	`string`
`email`	`string`
`requiresOrderIntegration`	`boolean`
`requiresOrderFulfillment`	`boolean`
`requiresAccountingIntegration`	`boolean`
`requiresDispatchBuilder`	`boolean`
`billingAddress`	`AddressResponse`
`shippingAddress`	`AddressResponse`
`currentUser`	`PrimitiveUserResponse`

CollectionRequest

Field	Type	Description
`dateOfCollection`	`string (date-time)`
`estimatedDateOfCollection`	`string (date-time)`
`dateOfScheduledCollection`	`string (date-time)`
`earliestDateOfCollection`	`string (date-time)`
`latestDateOfCollection`	`string (date-time)`
`collectBeforeTime`	`string`
`collectAfterTime`	`string`
`additionalRemarks`	`string`

CollectionResponse

Field	Type	Description
`address`	`AddressResponse`
`instructions`	`string`
`contact`	`ContactResponse`
`businessName`	`string`
`collectAfterTime`	`string`	Formatted in HH not hh (24 hours)
`collectBeforeTime`	`string`	Formatted in HH not hh (24 hours)
`dateOfCollection`	`string (date-time)`

ContactResponse

Field	Type	Description
`id`	`string (uuid)`
`title`	`string`
`description`	`string`
`firstName`	`string`
`lastName`	`string`
`email`	`string`
`phoneNumber`	`string`
`mobileNumber`	`string`

CurrencyResponse

Field	Type	Description
`iso4217`	`string`
`utf8Symbol`	`string`
`currencyCode`	`enum CurrencyCode`	One of: `Invalid`, `Eur`, `Usd`, `Gbp`, `Zar`, `Zmw`.

CustomerIntegrationProviderResponse

Field	Type	Description
`provider`	`PrimitiveIntegrationProviderResponse`
`customer`	`CustomerResponse`

CustomerResponse

Field	Type	Description
`id`	`string (uuid)`
`isBusiness`	`boolean`
`title`	`string`
`website`	`string`
`email`	`string`
`businessName`	`string`
`groupId`	`string (uuid)`	The customer group this customer belongs to, if any. Used as a price-list assignment scope.
`phoneNumber`	`string`	This would generally represent the phone number for the customer if the customer is a business. Otherwise, the contact details should be part of the contact, and not the customer. Limits: maximum 20 characters.
`integrationType`	`enum IntegrationProviderType`	One of: `None`, `Commerce`, `Accounting`, `Erp`, `Crm`, `Fulfillment`, `Warehouse`, `WorkflowManager`.
`dateCreated`	`string (date-time)`
`billingAddress`	`AddressResponse`
`shippingAddress`	`AddressResponse`
`integrations`	`CustomerIntegrationProviderResponse[]`
`contacts`	`ContactResponse[]`
`primaryContact`	`ContactResponse`
`parent`	`CustomerResponse`
`attachments`	`MetadataFileAttachment[]`
`totalSales`	`integer (int32)`
`totalSpent`	`number (double)`
`metadata`	`map<string, string>`

DeleteShipmentCommand

Field	Type	Description
`id`	`string (uuid)`

DeliveryRequest

Field	Type	Description
`estimatedDateOfDelivery`	`string (date-time)`
`dateOfDelivery`	`string (date-time)`
`earliestDateOfDelivery`	`string (date-time)`
`latestDateOfDelivery`	`string (date-time)`
`deliverBeforeTime`	`string`
`deliverAfterTime`	`string`
`additionalRemarks`	`string`

DeliveryResponse

Field	Type	Description
`address`	`AddressResponse`
`instructions`	`string`
`contact`	`ContactResponse`
`businessName`	`string`
`deliverAfterTime`	`string`	Formatted in HH not hh (24 hours)
`deliverBeforeTime`	`string`	Formatted in HH not hh (24 hours)
`dateOfDelivery`	`string (date-time)`

DimensionTypeWithSymbols

Field	Type	Description
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`volumeType`	`enum VolumeType`	One of: `None`, `Litre`, `CubicCentimeter`, `CubicMeter`, `Gallon`, `CubicInch`, `CubicFoot`.
`lengthSymbol`	`string`
`weightSymbol`	`string`
`volumeSymbol`	`string`

DispatchResponse

Field	Type	Description
`id`	`string (uuid)`
`code`	`string`
`description`	`string`
`dispatchStatus`	`enum DispatchStatuses`	One of: `Active`, `Pending`, `Dispatched`, `Cancelled`, `Complete`, `Draft`, `InTransit`, `Unassigned`.
`dateOfDeparture`	`string (date-time)`
`scheduledDateOfDeparture`	`string (date-time)`
`dateOfCompletion`	`string (date-time)`
`shipments`	`ShipmentResponse[]`
`drivers`	`DriverResponse[]`
`vehicle`	`VehicleResponse`
`business`	`BusinessResponse`

DriverResponse

Field	Type	Description
`id`	`string (uuid)`
`idNumber`	`string`
`licenseNumber`	`string`
`licenseTypeId`	`integer (int32)`
`licenseRenewalDate`	`string (date-time)`
`licenseIssuedDate`	`string (date-time)`
`user`	`DriverUserResponse`

DriverUserResponse

Field	Type	Description
`id`	`string (uuid)`
`firstName`	`string`
`lastName`	`string`
`email`	`string`
`phoneNumber`	`string`

FulfillmentItemResponse

Field	Type	Description
`weight`	`number (double)`
`width`	`number (double)`
`length`	`number (double)`
`height`	`number (double)`
`title`	`string`
`quantity`	`number (double)`
`declaredValue`	`number (double)`
`description`	`string`

FulfillmentProviderServiceTypeModel

This model represents the different services which the fulfillment provider provides.

Field	Type	Description
`id`	`integer (int32)`
`value`	`string`

FulfillmentRequirementTypeModel

Field	Type	Description
`id`	`integer (int32)`
`value`	`string`

GeometryFieldsResponse

Field	Type	Description
`weight`	`number (double)`
`width`	`number (double)`
`length`	`number (double)`
`height`	`number (double)`
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`weightSymbol`	`string`
`lengthSymbol`	`string`

MetadataFileAttachment

Not quite as complete as the normal FileAttachment aggregate.

Field	Type	Description
`id`	`string (uuid)`
`type`	`enum MetadataAttachmentType`	One of: `File`, `Link`.
`fileAttachmentId`	`string (uuid)`	Left as `Guid.Empty` for `Link` entries.
`title`	`string`
`url`	`string`
`contentType`	`string`
`description`	`string`

OrderCarrierMetadata

Field	Type	Description
`carrierId`	`string (uuid)`
`earliestCollection`	`string (date-time)`
`collectionRequested`	`string (date-time)`
`collectionAfterRequest`	`string (date-time)`
`dateDelivered`	`string (date-time)`
`dateOfReturnRequested`	`string (date-time)`
`timeframe`	`string`
`requestedCollection`	`boolean`
`shipmentLabelGenerated`	`boolean`
`requestedReturn`	`boolean`
`packageCount`	`integer (int32)`
`packages`	`OrderPackageMetadata[]`

OrderIntegrationDetailsResponse

Field	Type	Description
`id`	`string (uuid)`
`integrationId`	`string`	The integration id as displayed on the relevant integration
`provider`	`PrimitiveIntegrationProviderResponse`

OrderItemResponse

Order Item maps onto ProductOrder and contains a property with all of the product information.

Field	Type	Description
`id`	`string (uuid)`
`code`	`string`
`quantityOrdered`	`number (double)`
`unit`	`enum UnitOfMeasure`	One of: `Each`, `Kilogram`, `Gram`, `Litre`, `Millilitre`, `Metre`, `Centimetre`, `SquareMetre`, `CubicMetre`, `Pair`, `Pack`, `Box`, `Roll`, `Sheet`.
`orderShipment`	`OrderShipmentResponse`
`product`	`ProductResponse`
`shipment`	`ShipmentResponse`
`carrier`	`PrimitiveIntegrationProviderResponse`
`dimensionPreset`	`PrimitiveDimensionPreset`
`title`	`string`
`description`	`string`
`primaryImageUrl`	`string`
`geometry`	`GeometryFieldsResponse`
`billing`	`PriceDetailsResponse`

OrderPackageMetadata

Field	Type	Description
`productId`	`string (uuid)`
`dimensions`	`Geometry`

OrderResponse

Field	Type	Description
`dateCreated`	`string (date-time)`
`dateModified`	`string (date-time)`
`id`	`string (uuid)`
`code`	`string`
`deliveryItemCount`	`integer (int32)`
`orderItemCount`	`number (double)`	Total quantity of items ordered across all line items. Surfaced for list views.
`description`	`string`
`purchaseOrderNumber`	`string`	The customer's purchase order number, when this order was raised from a received customer PO.
`billing`	`PriceDetailsResponse`
`shippingCosts`	`OrderShippingCostsResponse`
`fulfillmentStatus`	`enum FulfillmentStatus`	One of: `Unknown`, `Unassigned`, `PendingCollection`, `PendingDelivery`, `Fulfilled`, `Cancelled`.
`customerIpAddress`	`string`
`serviceLevel`	`enum ServiceLevel`	One of: `Unknown`, `Standard`, `Express`, `SameDay`, `Overnight`, `TwoDay`, `InternationalStandard`, `InternationalExpress`, `OnDemand`, `Freight`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`status`	`enum OrderStatus`	One of: `Unknown`, `New`, `PendingCollection`, `PendingDelivery`, `Complete`, `Cancelled`, `PendingReturn`, `Returned`.
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`fulfillmentSubType`	`enum FulfillmentSubType`	One of: `Unknown`, `GeneralPackage`, `FoodDelivery`, `MedicalDelivery`, `GroceriesDelivery`, `StandardPallet`, `StandardInternationalPallet`, `StandardUsPallet`, `StandardEuroPallet`, `CustomPallet`, `General10Ft`, `General20Ft`, `HighCube20Ft`, `General40Ft`, `HighCube40Ft`, `General45Ft`, `HighCube45Ft`, `FlatRack20FtWithSides`, `FlatRack20FtWithoutSides`, `FlatRack40FtWithSides`, `FlatRack40FtWithoutSides`, `OpenTop20Ft`, `OpenTop40Ft`, `Reefer20Ft`, `Reefer40Ft`, `MiniVan`, `DryVan`, `Flatbed`, `Tanker`, `AutoHauler`, `BoxTruck`, `Trailer`, `LowBoy`, `Dumper`, `Pickup`, `TowTruck`, `DumpTruck`.
`dateOfScheduledCollection`	`string (date-time)`
`dateCreatedOnIntegration`	`string (date-time)`
`effectiveDate`	`string (date-time)`
`dateOfDeliveryCompletion`	`string (date-time)`
`dateImported`	`string (date-time)`
`countryCode`	`enum CountryCode`	One of: `Invalid`, `Global`, `FallbackZa`, `Be`, `De`, `Lu`, `Nl`, `Za`, `Zw`, `Gb`, `Us`, `Zm`.
`paymentProcessed`	`boolean`
`paymentUrl`	`string`
`integrationOrderUrl`	`string`
`multiCarrier`	`boolean`
`currencyCode`	`enum CurrencyCode`	One of: `Invalid`, `Eur`, `Usd`, `Gbp`, `Zar`, `Zmw`.
`paymentMethod`	`enum PaymentMethod`	One of: `Unknown`, `Cash`, `Card`, `CashOnDelivery`, `CardOnDelivery`, `Eft`, `Crypto`, `Paypal`, `WireTransfer`, `DebitOrder`.
`attachments`	`MetadataFileAttachment[]`
`orderItems`	`OrderItemResponse[]`
`orderShipments`	`OrderShipmentResponse[]`
`destinationAddress`	`AddressResponse`
`originAddress`	`AddressResponse`
`originLocationId`	`string (uuid)`	The location/store the order is attributed to (trace which store it came from).
`originLocationTitle`	`string`
`sourceChannelId`	`string (uuid)`	The sales channel (medium) the order came through.
`sourceChannelTitle`	`string`
`sourceChannel`	`SalesChannelResponse`
`customer`	`CustomerResponse`
`carrierMetadata`	`OrderCarrierMetadata`
`dimensionType`	`DimensionTypeWithSymbols`
`currencyMetadata`	`CurrencyResponse`
`fulfillmentProviders`	`PrimitiveIntegrationProviderResponse[]`
`packageSizes`	`PrimitiveDimensionPreset[]`
`integrations`	`OrderIntegrationDetailsResponse[]`
`metadata`	`map<string, string>`

OrderShipmentResponse

Field	Type	Description
`shipmentQuotation`	`ShipmentQuotationResponse`
`order`	`OrderResponse`
`shipment`	`ShipmentResponse`
`fulfillmentProvider`	`PrimitiveIntegrationProviderResponse`
`canModifyItems`	`boolean`	Whether the item set of this shipment can still be changed, through `PUT /orders/{orderId}/shipments/{shipmentId}/items`. False once the shipment leaves the Active status, or once a label, an invoice, a fulfillment request, an approved quotation, or a manual lock names the load it carries.

OrderShippingCostsResponse

Field	Type	Description
`shippingSubTotal`	`number (double)`
`shippingDiscount`	`number (double)`
`shippingTax`	`number (double)`
`shippingTotal`	`number (double)`

PriceDetailsResponse

Field	Type	Description
`subTotal`	`number (double)`
`totalPrice`	`number (double)`
`totalTax`	`number (double)`
`totalDiscount`	`number (double)`
`discount`	`number (double)`
`discountType`	`enum DiscountType`	One of: `None`, `Percentage`, `FixedValue`.
`taxIncluded`	`boolean`
`taxRate`	`number (double)`
`taxType`	`enum TaxType`	One of: `None`, `Sales`, `Vat`, `Gst`, `Pst`, `Hst`, `Qst`, `Ist`, `Ust`, `Cst`.
`currency`	`CurrencyResponse`

PrimitiveDimensionPreset

Field	Type	Description
`title`	`string`
`weight`	`number (double)`
`width`	`number (double)`
`length`	`number (double)`
`height`	`number (double)`
`id`	`string (uuid)`
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.

PrimitiveIntegrationProviderResponse

Field	Type	Description
`configuredProviderId`	`string (uuid)`
`id`	`integer (int32)`
`title`	`string`
`description`	`string`
`logoUrl`	`string`

PrimitiveUserResponse

Field	Type	Description
`id`	`string (uuid)`
`displayName`	`string`
`firstName`	`string`
`lastName`	`string`
`email`	`string`
`phoneNumber`	`string`

ProductResponse

Field	Type	Description
`id`	`string (uuid)`
`code`	`string`
`sku`	`string`
`barcode`	`string`
`upc`	`string`
`ean`	`string`
`mpn`	`string`
`title`	`string`
`description`	`string`
`body`	`string`
`productLink`	`string`
`productType`	`enum ProductType`	One of: `FinishedGood`, `RawMaterial`, `Component`, `Consumable`, `Service`.
`status`	`enum ProductStatus`	One of: `Active`, `Inactive`, `Discontinued`.
`unit`	`enum UnitOfMeasure`	One of: `Each`, `Kilogram`, `Gram`, `Litre`, `Millilitre`, `Metre`, `Centimetre`, `SquareMetre`, `CubicMetre`, `Pair`, `Pack`, `Box`, `Roll`, `Sheet`.
`purchasable`	`boolean`
`isSellable`	`boolean`
`isPurchasable`	`boolean`
`isTaxable`	`boolean`
`requiresShipping`	`boolean`
`totalAvailableQuantity`	`number (double)`	Available stock derived from the inventory ledger: the sum of (on-hand − reserved) across the product's inventory records at all locations.
`totalSold`	`number (double)`
`totalSoldValue`	`number (double)`
`onSale`	`boolean`
`currentPrice`	`ProductPriceDetailsResponse`
`traces`	`ActionMessage[]`	Get the historical view of changes for this object
`defaultImage`	`MetadataFileAttachment`
`images`	`MetadataFileAttachment[]`
`attachments`	`MetadataFileAttachment[]`
`geometry`	`ProductGeometryFieldsResponse`
`integrations`	`ProductIntegrationProviderResponse[]`
`locale`	`SymbolicLocaleMetadata`
`dimensionPreset`	`DimensionPresetResponse`
`dimensionPresets`	`DimensionPresetResponse[]`
`categories`	`ProductCategoryPrimitive[]`
`supplier`	`SupplierResponse`
`group`	`ProductGroupSummaryResponse`
`tags`	`string[]`
`hasRating`	`boolean`
`rating`	`number (double)`
`metadata`	`map<string, string>`
`dateCreated`	`string (date-time)`

SalesChannelResponse

Field	Type	Description
`id`	`string (uuid)`
`title`	`string`
`kind`	`enum SalesChannelKind`	One of: `Direct`, `PointOfSale`, `Online`, `Marketplace`.
`defaultLocationId`	`string (uuid)`

ShipmentCommentResponse

Field	Type	Description
`id`	`string (uuid)`
`shipmentId`	`string (uuid)`
`comment`	`string`
`user`	`PrimitiveUserResponse`
`dateCreated`	`string (date-time)`

ShipmentDimensionsRequest

Field	Type	Description
`weight`	`number (double)`
`width`	`number (double)`
`length`	`number (double)`
`height`	`number (double)`
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`presetId`	`string (uuid)`

ShipmentItemResponse

Field	Type	Description
`id`	`string (uuid)`
`orderItemId`	`string (uuid)`
`productId`	`string (uuid)`
`quantity`	`number (double)`
`unit`	`enum UnitOfMeasure`	One of: `Each`, `Kilogram`, `Gram`, `Litre`, `Millilitre`, `Metre`, `Centimetre`, `SquareMetre`, `CubicMetre`, `Pair`, `Pack`, `Box`, `Roll`, `Sheet`.
`title`	`string`
`description`	`string`
`geometry`	`GeometryFieldsResponse`
`subTotal`	`number (double)`
`totalPrice`	`number (double)`
`totalTax`	`number (double)`
`totalDiscount`	`number (double)`
`discount`	`number (double)`
`discountType`	`enum DiscountType`	One of: `None`, `Percentage`, `FixedValue`.

ShipmentOverview

Field	Type	Description
`total`	`integer (int32)`
`active`	`integer (int32)`
`pending`	`integer (int32)`
`closed`	`integer (int32)`
`complete`	`integer (int32)`

ShipmentQuotationResponse

Field	Type	Description
`id`	`string (uuid)`
`provider`	`PrimitiveIntegrationProviderResponse`
`items`	`FulfillmentItemResponse[]`
`requiredServices`	`FulfillmentProviderServiceTypeModel[]`
`requirements`	`FulfillmentRequirementTypeModel[]`
`collection`	`CollectionResponse`
`delivery`	`DeliveryResponse`
`totalDeclaredValue`	`number (double)`
`isInternational`	`boolean`
`isApprovedByUser`	`boolean`
`totalItems`	`integer (int32)`
`serviceLevelText`	`string`
`serviceLevel`	`enum ServiceLevel`	One of: `Unknown`, `Standard`, `Express`, `SameDay`, `Overnight`, `TwoDay`, `InternationalStandard`, `InternationalExpress`, `OnDemand`, `Freight`.
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`deliveryType`	`enum FulfillmentDeliveryType`	One of: `Unknown`, `DoorToDoor`, `DoorToCollectionPoint`, `CollectionPointToDoor`, `CollectionPointToCollectionPoint`, `DoorToPort`, `PortToDoor`, `PortToPort`, `LockerToLocker`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`countryCode`	`enum CountryCode`	One of: `Invalid`, `Global`, `FallbackZa`, `Be`, `De`, `Lu`, `Nl`, `Za`, `Zw`, `Gb`, `Us`, `Zm`.
`dateOfEstimatedCollection`	`string (date-time)`	The estimated collection and delivery dates, when they are known. They are null when no estimate exists. Do not substitute today's date.
`dateOfEstimatedDelivery`	`string (date-time)`
`currency`	`CurrencyResponse`
`subTotal`	`number (double)`
`totalPrice`	`number (double)`
`totalTax`	`number (double)`
`totalDiscount`	`number (double)`
`discount`	`number (double)`
`discountType`	`enum DiscountType`	One of: `None`, `Percentage`, `FixedValue`.
`taxIncluded`	`boolean`
`shipment`	`ShipmentResponse`

ShipmentResponse

Field	Type	Description
`dateCreated`	`string (date-time)`
`dateModified`	`string (date-time)`
`id`	`string (uuid)`
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`status`	`enum ShipmentStatus`	One of: `Unknown`, `Active`, `PendingCollection`, `CollectionUnassigned`, `CollectionAssigned`, `CollectionRejected`, `CollectionException`, `CollectionFailedAttempt`, `Collected`, `AtHub`, `ReturnedToHub`, `InTransit`, `AtDestinationHub`, `DeliveryUnassigned`, `DeliveryAssigned`, `DeliveryRejected`, `DeliveryException`, `OutForDelivery`, `DeliveryFailedAttempt`, `InLocker`, `Delivered`, `Cancelled`.
`hasDimensions`	`boolean`
`dateOfDeparture`	`string (date-time)`
`title`	`string`	Limits: maximum 100 characters.
`providerServiceLevelId`	`Uid`
`providerServiceLevelIdType`	`enum UidType`	One of: `Unknown`, `Long`, `Guid`, `String`.
`serviceLevel`	`enum ServiceLevel`	One of: `Unknown`, `Standard`, `Express`, `SameDay`, `Overnight`, `TwoDay`, `InternationalStandard`, `InternationalExpress`, `OnDemand`, `Freight`.
`code`	`string`
`description`	`string`	Limits: maximum 3000 characters.
`handlingType`	`enum HandlingType`	One of: `Unknown`, `Delivery`, `Collection`, `Unassigned`.
`requiresApproval`	`boolean`
`totalDeclaredValue`	`number (double)`
`quantityOfItems`	`number (double)`
`trackingId`	`string`
`barcode`	`string`
`delivery`	`DeliveryResponse`
`collection`	`CollectionResponse`
`currency`	`CurrencyResponse`
`dispatch`	`DispatchResponse`
`business`	`BusinessResponse`
`customer`	`CustomerResponse`
`items`	`ShipmentItemResponse[]`
`fulfillmentContacts`	`ContactResponse[]`
`orderShipments`	`OrderShipmentResponse[]`
`waypoints`	`ShipmentWaypointResponse[]`
`metadata`	`map<string, string>`
`attachments`	`MetadataFileAttachment[]`

ShipmentTraceResponse

Field	Type	Description
`id`	`string (uuid)`
`title`	`string`
`message`	`string`
`shipmentStatus`	`enum ShipmentStatus`	One of: `Unknown`, `Active`, `PendingCollection`, `CollectionUnassigned`, `CollectionAssigned`, `CollectionRejected`, `CollectionException`, `CollectionFailedAttempt`, `Collected`, `AtHub`, `ReturnedToHub`, `InTransit`, `AtDestinationHub`, `DeliveryUnassigned`, `DeliveryAssigned`, `DeliveryRejected`, `DeliveryException`, `OutForDelivery`, `DeliveryFailedAttempt`, `InLocker`, `Delivered`, `Cancelled`.
`activityAction`	`enum ShipmentActivityAction`	One of: `None`, `StatusChange`, `AllocatedToDispatch`, `OnRoute`, `CloseToDestination`, `AtDestination`, `AtDepotCentre`, `Sorted`, `Scanned`, `SortingInProgress`, `OrderReceived`, `Delivered`, `Modified`, `Created`.
`dateCreated`	`string (date-time)`
`userId`	`string (uuid)`
`activityType`	`enum ActivityType`	One of: `System`, `User`.

ShipmentWaypointResponse

Field	Type	Description
`id`	`string (uuid)`
`segmentPosition`	`integer (int32)`
`title`	`string`
`dateCheckedIn`	`string (date-time)`
`dateCheckedOut`	`string (date-time)`
`dateCreated`	`string (date-time)`
`dateModified`	`string (date-time)`
`address`	`AddressResponse`

UpdateAddressRequest

Field	Type	Description
`id`	`string (uuid)`
`placeId`	`string (string)`	Limits: maximum 100 characters.
`name`	`string (string)`	Limits: maximum 50 characters.
`website`	`string (uri)`	Limits: maximum 100 characters.
`fullAddress`	`string`	Limits: maximum 500 characters.
`street`	`string (string)`	Limits: maximum 80 characters.
`suburb`	`string (string)`	Limits: maximum 80 characters.
`city`	`string`	Limits: maximum 80 characters.
`country`	`string`	Limits: maximum 80 characters.
`postcode`	`string (postal-code)`	Limits: maximum 15 characters.
`unit`	`string`	Limits: maximum 10 characters.
`number`	`string (postal-code)`	Limits: maximum 20 characters.
`province`	`string (string)`	Limits: maximum 80 characters.
`latitude`	`number (double)`	Limits: minimum -90, maximum 90.
`longitude`	`number (double)`	Limits: minimum -180, maximum 180.

VehicleResponse

Field	Type	Description
`id`	`string (uuid)`
`licensePlate`	`string`
`dateOfLicenseExpiry`	`string (date-time)`
`licenseDisc`	`string`
`vehicleIdentificationNumber`	`string`
`model`	`string`
`make`	`string`
`acquisitionDate`	`string (date-time)`
`vehicleType`	`enum VehicleType`	One of: `Motorcycle`, `LightMotorVehicle`, `HeavyMotorVehicleSub16`, `HeaveMotorVehicleOver16`.
`dateCreated`	`string (date-time)`
`dateModified`	`string (date-time)`

Sales channels

The sales channels operations of the Core API.

Carriers

The carriers operations of the Core API.