Logistics

Delivery plans

The delivery plans 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/plans/overview`	Get dispatch overview
GET	`/api/v1/plans/{dispatchId}`	Get dispatch
DELETE	`/api/v1/plans/{dispatchId}`	Delete dispatch
GET	`/api/v1/plans/{deliveryPlanId}/timeline`	Get delivery plan timeline
PUT	`/api/v1/plans/{deliveryPlanId}`	Update dispatch
DELETE	`/api/v1/plans/{deliveryPlanId}/shipments/{shipmentId}`	Remove shipment from dispatch
GET	`/api/v1/plans/in-shipment/{shipmentId}`	Get dispatch by shipment id
POST	`/api/v1/plans/{deliveryPlanId}/shipments`	Add shipment
POST	`/api/v1/plans/{dispatchId}/autobatch`	Auto batch shipments
GET	`/api/v1/plans/code`	Get dispatch code
GET	`/api/v1/plans`	Get trips
POST	`/api/v1/plans`	Save dispatch
GET	`/api/v1/plans/unassigned-shipments`	Get unassigned shipments

Get dispatch overview

GET/api/v1/plans/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 DispatchOverviewResponse.

Request

curl -X GET "https://api.miridia.io/api/v1/plans/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 dispatch

GET/api/v1/plans/{dispatchId}

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

Parameters

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

Response

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

Request

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

Delete dispatch

DELETE/api/v1/plans/{dispatchId}

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

Parameters

Name	In	Type	Required	Description
`dispatchId`	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/plans/{dispatchId}" \
  -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 delivery plan timeline

GET/api/v1/plans/{deliveryPlanId}/timeline

The milestone timestamps of the plan and of every shipment on it.

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

Parameters

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

Response

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

Request

curl -X GET "https://api.miridia.io/api/v1/plans/{deliveryPlanId}/timeline" \
  -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": {
    "planId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "code": "string",
    "status": "Active",
    "planCreated": "2026-09-29T08:00:00Z",
    "scheduledDeparture": "2026-09-29T08:00:00Z",
    "departed": "2026-09-29T08:00:00Z",
    "scheduledCompletion": "2026-09-29T08:00:00Z",
    "completed": "2026-09-29T08:00:00Z",
    "shipments": [
      {}
    ]
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Update dispatch

PUT/api/v1/plans/{deliveryPlanId}

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

Parameters

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

Request body

Send JSON with the shape DispatchUpdateRequest.

Field	Type	Required	Description
`code`	`string`	No
`description`	`string`	No
`dispatchStatus`	`enum DispatchStatuses`	No	One of: `Active`, `Pending`, `Dispatched`, `Cancelled`, `Complete`, `Draft`, `InTransit`, `Unassigned`.
`shipments`	`MultiSelectShipmentDto[]`	Yes
`drivers`	`DriverIdAndName[]`	Yes
`vehicle`	`SelectVehicle`	No
`vehicleId`	`integer (int32)`	No
`dateModified`	`string (date-time)`	No
`dateOfDeparture`	`string (date-time)`	No
`scheduledDateOfDeparture`	`string (date-time)`	No
`dateOfCompletion`	`string (date-time)`	No
`completed`	`boolean`	No
`dateCreated`	`string (date-time)`	No

Response

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

Request

curl -X PUT "https://api.miridia.io/api/v1/plans/{deliveryPlanId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "string",
  "description": "string",
  "dispatchStatus": "Active",
  "shipments": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "drivers": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "vehicle": {
    "id": 0
  },
  "vehicleId": 0,
  "dateModified": "2026-09-29T08:00:00Z",
  "dateOfDeparture": "2026-09-29T08:00:00Z",
  "scheduledDateOfDeparture": "2026-09-29T08:00:00Z",
  "dateOfCompletion": "2026-09-29T08:00:00Z",
  "completed": true,
  "dateCreated": "2026-09-29T08:00:00Z"
}'

Remove shipment from dispatch

DELETE/api/v1/plans/{deliveryPlanId}/shipments/{shipmentId}

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

Parameters

Name	In	Type	Required	Description
`deliveryPlanId`	path	`string (uuid)`	Yes
`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/plans/{deliveryPlanId}/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 dispatch by shipment id

GET/api/v1/plans/in-shipment/{shipmentId}

This endpoint is required for the shipment details page. To retrieve the related dispatch information for that 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	The shipment id.

Response

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

Request

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

Add shipment

POST/api/v1/plans/{deliveryPlanId}/shipments

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

Parameters

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

Request body

Send JSON with the shape AddShipmentToDispatchDto.

Field	Type	Required	Description
`shipmentId`	`string (uuid)`	Yes

Response

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

Request

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

Response

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

Auto batch shipments

POST/api/v1/plans/{dispatchId}/autobatch

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

Parameters

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

Response

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

Request

curl -X POST "https://api.miridia.io/api/v1/plans/{dispatchId}/autobatch" \
  -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 dispatch code

GET/api/v1/plans/code

This endpoint is called since the dispatch code needs to be created before the dispatch itself is created.

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 DispatchCodeResponse.

Request

curl -X GET "https://api.miridia.io/api/v1/plans/code" \
  -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": {
    "code": "string"
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Get trips

GET/api/v1/plans

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	Default: `1`.
`perPage`	query	`integer (int32)`	No	Default: `50`.
`from`	query	`string`	No
`to`	query	`string`	No
`status`	query	`string`	No

Response

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

Request

curl -X GET "https://api.miridia.io/api/v1/plans" \
  -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",
      "code": "string",
      "description": "string",
      "dispatchStatus": "Active",
      "dateOfDeparture": "2026-09-29T08:00:00Z",
      "scheduledDateOfDeparture": "2026-09-29T08:00:00Z",
      "dateOfCompletion": "2026-09-29T08:00:00Z",
      "shipments": [
        {}
      ],
      "drivers": [
        {}
      ],
      "vehicle": {},
      "business": {}
    }
  ],
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ]
}

Save dispatch

POST/api/v1/plans

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

Request body

Send JSON with the shape DispatchRequest.

Field	Type	Required
`shipmentIds`	`string (uuid)[]`	No
`dispatchCode`	`string`	No
`description`	`string`	No
`driverIds`	`integer (int32)[]`	No
`vehicleId`	`integer (int32)`	No

Response

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

Request

curl -X POST "https://api.miridia.io/api/v1/plans" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "shipmentIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "dispatchCode": "string",
  "description": "string",
  "driverIds": [
    0
  ],
  "vehicleId": 0
}'

Get unassigned shipments

GET/api/v1/plans/unassigned-shipments

Shipments not yet attached to any delivery plan/dispatch.

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/plans/unassigned-shipments" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

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`

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>`

DeliveryPlanShipmentTimelineResponse

The milestone timestamps of one shipment on a delivery plan. Every timestamp can be null, because a step can still be pending.

Field	Type	Description
`shipmentId`	`string (uuid)`
`code`	`string`
`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`.
`orderId`	`string (uuid)`
`orderCode`	`string`
`orderKind`	`enum TimelineOrderKind`	One of: `None`, `Sales`, `Purchase`.
`orderPlaced`	`string (date-time)`
`orderCreated`	`string (date-time)`
`shipmentCreated`	`string (date-time)`
`addedToPlan`	`string (date-time)`
`departed`	`string (date-time)`
`collected`	`string (date-time)`
`delivered`	`string (date-time)`

DeliveryPlanTimelineResponse

The milestone timestamps of a delivery plan and of every shipment on it.

Field	Type	Description
`planId`	`string (uuid)`
`code`	`string`
`status`	`enum DispatchStatuses`	One of: `Active`, `Pending`, `Dispatched`, `Cancelled`, `Complete`, `Draft`, `InTransit`, `Unassigned`.
`planCreated`	`string (date-time)`
`scheduledDeparture`	`string (date-time)`
`departed`	`string (date-time)`
`scheduledCompletion`	`string (date-time)`
`completed`	`string (date-time)`
`shipments`	`DeliveryPlanShipmentTimelineResponse[]`

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`

DispatchCodeResponse

Field	Type	Description
`code`	`string`

DispatchOverviewResponse

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

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`

DriverIdAndName

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

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`

MultiSelectShipmentDto

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

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`

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`

SalesChannelResponse

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

SelectVehicle

Field	Type	Description
`id`	`integer (int32)`	Limits: minimum 1.

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`.

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[]`

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`

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)`

Waybills

The waybills operations of the Core API.

Delivery zones

The delivery zones operations of the Core API.