Sales

Orders

The orders 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/Orders`	Get orders
POST	`/api/v1/Orders`	Create order
POST	`/api/v1/Orders/delete`	Bulk delete orders
GET	`/api/v1/Orders/{orderId}`	Get order
PATCH	`/api/v1/Orders/{orderId}`	Patch order
POST	`/api/v1/Orders/{orderId}/add-dimension-preset`	Assign dimension preset
POST	`/api/v1/Orders/{orderId}/shipments`	Create order shipment
PUT	`/api/v1/Orders/{orderId}/shipments/{shipmentId}/items`	Update order shipment items
GET	`/api/v1/Orders/settings`	Get order settings
PATCH	`/api/v1/Orders/settings`	Update order settings
GET	`/api/v1/Orders/{orderId}/traces`	Get activity traces
POST	`/api/v1/Orders/{orderId}/traces`	Add order trace
POST	`/api/v1/Orders/{orderId}/attachments`	Add order file attachment
DELETE	`/api/v1/Orders/{orderId}/attachments/{attachmentId}`	Remove order file attachment
POST	`/api/v1/Orders/{orderId}/metadata`	Add order metadata
GET	`/api/v1/Orders/{orderId}/comments`	Get order comments
POST	`/api/v1/Orders/{orderId}/comments`	Add order comment
DELETE	`/api/v1/Orders/{orderId}/comments/{commentId}`	Delete order comment
PATCH	`/api/v1/Orders/{orderId}/items/{orderItemId}`	Update order item
DELETE	`/api/v1/Orders/{orderId}/items/{orderItemId}`	Delete order item
POST	`/api/v1/Orders/{orderId}/items`	Add order item

Get orders

GET/api/v1/Orders

Access. Send a bearer token or an API key. The caller needs the Orders 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.
`sourceChannelId`	query	`string (uuid)`	No
`originLocationId`	query	`string (uuid)`	No
`status`	query	`enum OrderStatus`	No	One of: `Unknown`, `New`, `PendingCollection`, `PendingDelivery`, `Complete`, `Cancelled`, `PendingReturn`, `Returned`.
`fromDate`	query	`string (date-time)`	No
`toDate`	query	`string (date-time)`	No

Response

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

Request

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

Create order

POST/api/v1/Orders

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

Request body

Send JSON with the shape CreateOrderRequest.

Field	Type	Required	Description
`customerId`	`string (uuid)`	Yes
`locationId`	`string (uuid)`	Yes	The location/store this order originates at (its address becomes the order origin).
`salesChannelId`	`string (uuid)`	No	The sales channel (medium) this order comes through. Optional: when omitted, a manual order falls back to the business's default ("Direct") channel, and an integration-ingested order resolves the channel backed by its configured provider.
`description`	`string`	No
`purchaseOrderNumber`	`string`	No	The customer's purchase order number, when this order is created from a received customer PO.
`currencyCode`	`enum CurrencyCode`	No	One of: `Invalid`, `Eur`, `Usd`, `Gbp`, `Zar`, `Zmw`.
`countryCode`	`enum CountryCode`	No	One of: `Invalid`, `Global`, `FallbackZa`, `Be`, `De`, `Lu`, `Nl`, `Za`, `Zw`, `Gb`, `Us`, `Zm`.
`weightType`	`enum WeightType`	No	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`paymentProcessed`	`boolean`	No
`paymentMethod`	`enum PaymentMethod`	No	One of: `Unknown`, `Cash`, `Card`, `CashOnDelivery`, `CardOnDelivery`, `Eft`, `Crypto`, `Paypal`, `WireTransfer`, `DebitOrder`.
`fulfillmentType`	`enum FulfillmentType`	No	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`fulfillmentSubType`	`enum FulfillmentSubType`	No	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`.
`serviceLevel`	`enum ServiceLevel`	No	One of: `Unknown`, `Standard`, `Express`, `SameDay`, `Overnight`, `TwoDay`, `InternationalStandard`, `InternationalExpress`, `OnDemand`, `Freight`.
`dateOfScheduledCollection`	`string (date-time)`	No
`items`	`CreateOrderItemRequest[]`	Yes
`destinationAddress`	`CreateAddressRequest`	Yes
`billing`	`OrderBillingRequest`	No
`metadata`	`map<string, string>`	No
`effectiveDate`	`string (date-time)`	No	When the order actually occurred. Optional; defaults to now.

Response

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

Request

curl -X POST "https://api.miridia.io/api/v1/Orders" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "locationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "salesChannelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "description": "string",
  "purchaseOrderNumber": "string",
  "currencyCode": "Eur",
  "countryCode": "Global",
  "weightType": "Kilogram",
  "paymentProcessed": true,
  "paymentMethod": "Cash",
  "fulfillmentType": "Package",
  "fulfillmentSubType": "GeneralPackage",
  "serviceLevel": "Standard",
  "dateOfScheduledCollection": "2026-09-29T08:00:00Z",
  "items": [
    {
      "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity": 0,
      "dimensionPresetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "primaryImageUrl": "string",
      "weight": 0,
      "weightType": "Kilogram",
      "width": 0,
      "length": 0,
      "height": 0,
      "subTotal": 0,
      "totalPrice": 0,
      "totalTax": 0,
      "totalDiscount": 0,
      "discount": 0,
      "discountType": "Percentage"
    }
  ],
  "destinationAddress": {
    "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
  },
  "billing": {
    "subTotal": 0,
    "totalPrice": 0,
    "totalTax": 0,
    "totalDiscount": 0,
    "discount": 0,
    "discountType": "Percentage",
    "taxIncluded": true,
    "taxType": "Sales",
    "taxRate": 0
  },
  "metadata": {
    "key": "string"
  },
  "effectiveDate": "2026-09-29T08:00:00Z"
}'

Bulk delete orders

POST/api/v1/Orders/delete

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

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

Request body

Send JSON of type OrderDeleteCommand[].

Response

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

Request

curl -X POST "https://api.miridia.io/api/v1/Orders/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 order

GET/api/v1/Orders/{orderId}

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

Parameters

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

Response

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

Request

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

Partially update an order's editable header fields: fulfillment type / sub-type / service level, status (Cancelled/Complete only), payment-processed state, and collection date. Only fields present (non-null) in the body are applied.

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

Parameters

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

Request body

Send JSON with the shape PatchOrderCommand. Partial update of an order'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 order.

Field	Type	Required	Description
`orderId`	`string (uuid)`	No	Bound from the route, not the body.
`fulfillmentType`	`enum FulfillmentType`	No	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`fulfillmentSubType`	`enum FulfillmentSubType`	No	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`.
`serviceLevel`	`enum ServiceLevel`	No	One of: `Unknown`, `Standard`, `Express`, `SameDay`, `Overnight`, `TwoDay`, `InternationalStandard`, `InternationalExpress`, `OnDemand`, `Freight`.
`status`	`enum OrderStatus`	No	One of: `Unknown`, `New`, `PendingCollection`, `PendingDelivery`, `Complete`, `Cancelled`, `PendingReturn`, `Returned`.
`paymentProcessed`	`boolean`	No
`collectionDate`	`string (date-time)`	No

Response

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

Request

curl -X PATCH "https://api.miridia.io/api/v1/Orders/{orderId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fulfillmentType": "Package",
  "fulfillmentSubType": "GeneralPackage",
  "serviceLevel": "Standard",
  "status": "New",
  "paymentProcessed": true,
  "collectionDate": "2026-09-29T08:00:00Z"
}'

Assign dimension preset

POST/api/v1/Orders/{orderId}/add-dimension-preset

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

Parameters

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

Request body

Send JSON with the shape ModifyOrderItemPresetCommand.

Field	Type	Required
`orderId`	`string (uuid)`	Yes
`items`	`OrderItemIdentity[]`	Yes
`dimensionPresetId`	`string (uuid)`	Yes
`removeDimensionPreset`	`boolean`	No

Response

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

Request

curl -X POST "https://api.miridia.io/api/v1/Orders/{orderId}/add-dimension-preset" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "dimensionPresetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "removeDimensionPreset": true
}'

Create order shipment

POST/api/v1/Orders/{orderId}/shipments

Creates a order_shipment entry for the order. If no order items are specified all unassigned order items will be assigned to the created shipment.

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

Parameters

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

Request body

Send JSON with the shape CreateOrderShipmentCommand. Command to create a shipment from an order

Field	Type	Required	Description
`orderId`	`string (uuid)`	Yes
`orderItems`	`string (uuid)[]`	Yes
`dateCreated`	`string (date-time)`	No	When the shipment was created. Optional; defaults to now. Lets seeded/synthetic shipments be backdated to their order's date.

Response

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

Request

curl -X POST "https://api.miridia.io/api/v1/Orders/{orderId}/shipments" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "orderItems": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "dateCreated": "2026-09-29T08:00:00Z"
}'

Update order shipment items

PUT/api/v1/Orders/{orderId}/shipments/{shipmentId}/items

Replaces the item set of a shipment that already belongs to the order. The shipment keeps its id and its code; only the items it carries change. An item taken from another shipment of the order moves across, and a shipment left with no items is deleted.

The request body holds the complete item set, not a delta. An item of the shipment that is absent from the list becomes unassigned. The list cannot be empty: to remove the shipment, delete it. The request returns 409 when the shipment, or any shipment an item is taken from, has moved past the Active status or carries a label, an invoice, a fulfillment request, or an approved quotation.

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

Parameters

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

Request body

Send JSON with the shape UpdateOrderShipmentItemsCommand. Command to replace the item set of a shipment that already belongs to the order. Use it to move order items onto, or off, an existing shipment. To make a new shipment, use CreateOrderShipmentCommand instead.

Field	Type	Required	Description
`orderId`	`string (uuid)`	Yes
`shipmentId`	`string (uuid)`	Yes
`orderItems`	`string (uuid)[]`	Yes	The order items the shipment holds after the update. This is the complete set, not a delta: an item of the shipment that is absent here becomes unassigned. The list cannot be empty. Delete the shipment instead.

Response

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

Request

curl -X PUT "https://api.miridia.io/api/v1/Orders/{orderId}/shipments/{shipmentId}/items" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "shipmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "orderItems": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'

Get order settings

GET/api/v1/Orders/settings

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

Response

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

Request

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

Update order settings

PATCH/api/v1/Orders/settings

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

Request body

Send JSON with the shape OrderSettingsUpdateCommand.

Field	Type	Required	Description
`autoAllocatePackagePresets`	`boolean`	No
`autoAllocateFulfillmentProvider`	`boolean`	No
`autoGroupOrderItems`	`boolean`	No
`defaultDimensionPreset`	`string (uuid)`	No
`defaultFulfillmentContact`	`string (uuid)`	No
`defaultFulfillmentProvider`	`string (uuid)`	No
`defaultCollectionPreference`	`enum CollectionPreference`	No	One of: `NotAllocated`, `SameDay`, `NextDay`, `TwoDays`, `ThreeDays`, `FourDays`, `FiveDays`.

Response

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

Request

curl -X PATCH "https://api.miridia.io/api/v1/Orders/settings" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "autoAllocatePackagePresets": true,
  "autoAllocateFulfillmentProvider": true,
  "autoGroupOrderItems": true,
  "defaultDimensionPreset": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "defaultFulfillmentContact": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "defaultFulfillmentProvider": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "defaultCollectionPreference": "NotAllocated"
}'

Get activity traces

GET/api/v1/Orders/{orderId}/traces

Get order activity traces

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

Parameters

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

Response

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

Request

curl -X GET "https://api.miridia.io/api/v1/Orders/{orderId}/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",
      "activityType": "System",
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "code": "string",
      "title": "string",
      "message": "string",
      "source": "string",
      "actionLink": "string",
      "level": "Standard",
      "dateOfActivity": "2026-09-29T08:00:00Z",
      "isDashboardOnly": true,
      "icon": "SyncAlert"
    }
  ],
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ]
}

Add order trace

POST/api/v1/Orders/{orderId}/traces

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

Parameters

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

Request body

Send JSON with the shape AddActivityTraceRequest.

Field	Type	Required	Description
`title`	`string`	Yes
`message`	`string`	Yes
`code`	`string`	No
`source`	`string`	No
`actionLink`	`string`	No
`level`	`enum NotificationLevel`	No	One of: `Standard`, `Info`, `Warning`, `Error`, `Success`, `Recommendation`.
`icon`	`enum MdiIcon`	No	One of: `None`, `SyncAlert`, `Autorenew`, `Check`, `CheckMarkedCircle`, `AlertCircle`, `TruckDeliveryOutline`, `TruckFastOutline`, `PackageCheck`, `Warehouse`, `SwapHorizontal`, `AccountCheck`, `AccountRemove`, `AccountCancel`, `Delete`.

Response

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

Request

curl -X POST "https://api.miridia.io/api/v1/Orders/{orderId}/traces" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "string",
  "message": "string",
  "code": "string",
  "source": "string",
  "actionLink": "string",
  "level": "Standard",
  "icon": "SyncAlert"
}'

Add order file attachment

POST/api/v1/Orders/{orderId}/attachments

Step 2 of file attachment: associates a previously uploaded file with this order. 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 Orders modify permission.

Parameters

Name	In	Type	Required	Description
`orderId`	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 OrderResponse.

Request

curl -X POST "https://api.miridia.io/api/v1/Orders/{orderId}/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 order file attachment

DELETE/api/v1/Orders/{orderId}/attachments/{attachmentId}

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

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

Parameters

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

Response

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

Request

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

Add order metadata

POST/api/v1/Orders/{orderId}/metadata

Merges the provided key/value pairs into the order'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 Orders modify permission.

Parameters

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

Request body

Send JSON of type map<string, string>.

Response

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

Request

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

Get order comments

GET/api/v1/Orders/{orderId}/comments

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

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

Parameters

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

Response

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

Request

curl -X GET "https://api.miridia.io/api/v1/Orders/{orderId}/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",
      "orderId": "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 order comment

POST/api/v1/Orders/{orderId}/comments

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

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

Parameters

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

Request body

Send JSON with the shape OrderCommentRequest.

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

Response

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

Request

curl -X POST "https://api.miridia.io/api/v1/Orders/{orderId}/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",
    "orderId": "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 order comment

DELETE/api/v1/Orders/{orderId}/comments/{commentId}

Deletes a comment from the order.

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

Parameters

Name	In	Type	Required	Description
`orderId`	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/Orders/{orderId}/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
}

Update order item

PATCH/api/v1/Orders/{orderId}/items/{orderItemId}

Updates an existing order item

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

Parameters

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

Request body

Send JSON with the shape UpdateOrderItemRequest. Its billing fields are deliberately nullable (see below), which that non-nullable-decimal interface can't express for a partial PATCH contract.

Field	Type	Required	Description
`id`	`string (uuid)`	No
`productId`	`string (uuid)`	No
`quantity`	`number (double)`	No
`packageGroupId`	`integer (int32)`	No
`dimensionPresetId`	`string (uuid)`	No
`title`	`string`	No
`description`	`string`	No
`primaryImageUrl`	`string`	No
`weight`	`number (double)`	No
`weightType`	`enum WeightType`	No	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`width`	`number (double)`	No
`length`	`number (double)`	No
`height`	`number (double)`	No
`subTotal`	`number (double)`	No	Null means "not provided". The caller didn't touch this billing field.
`totalPrice`	`number (double)`	No
`totalTax`	`number (double)`	No
`totalDiscount`	`number (double)`	No
`discount`	`number (double)`	No
`discountType`	`enum DiscountType`	No	One of: `None`, `Percentage`, `FixedValue`.

Response

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

Request

curl -X PATCH "https://api.miridia.io/api/v1/Orders/{orderId}/items/{orderItemId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "quantity": 0,
  "packageGroupId": 0,
  "dimensionPresetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "primaryImageUrl": "string",
  "weight": 0,
  "weightType": "Kilogram",
  "width": 0,
  "length": 0,
  "height": 0,
  "subTotal": 0,
  "totalPrice": 0,
  "totalTax": 0,
  "totalDiscount": 0,
  "discount": 0,
  "discountType": "Percentage"
}'

Delete order item

DELETE/api/v1/Orders/{orderId}/items/{orderItemId}

Deletes an order item from the order

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

Parameters

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

Response

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

Request

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

Add order item

POST/api/v1/Orders/{orderId}/items

Adds a new item to the order

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

Parameters

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

Request body

Send JSON with the shape CreateOrderItemRequest. Its billing fields are deliberately nullable (see below), which that non-nullable-decimal interface can't express.

Field	Type	Required	Description
`productId`	`string (uuid)`	No
`quantity`	`number (double)`	Yes	Used when a product is assigned to a order
`dimensionPresetId`	`string (uuid)`	No
`title`	`string`	No
`description`	`string`	No
`primaryImageUrl`	`string`	No
`weight`	`number (double)`	No
`weightType`	`enum WeightType`	No	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`width`	`number (double)`	No
`length`	`number (double)`	No
`height`	`number (double)`	No
`subTotal`	`number (double)`	No	Null (or zero, matching the old non-nullable default) means "resolve this from price lists / price history". A non-zero value is a LINE TOTAL and is used unchanged. See `IOrderLinePricingService`.
`totalPrice`	`number (double)`	No
`totalTax`	`number (double)`	No
`totalDiscount`	`number (double)`	No
`discount`	`number (double)`	No
`discountType`	`enum DiscountType`	No	One of: `None`, `Percentage`, `FixedValue`.

Response

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

Request

curl -X POST "https://api.miridia.io/api/v1/Orders/{orderId}/items" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "quantity": 0,
  "dimensionPresetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "primaryImageUrl": "string",
  "weight": 0,
  "weightType": "Kilogram",
  "width": 0,
  "length": 0,
  "height": 0,
  "subTotal": 0,
  "totalPrice": 0,
  "totalTax": 0,
  "totalDiscount": 0,
  "discount": 0,
  "discountType": "Percentage"
}'

Models

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

ActionMessage

Action messages surface to the API and provide more detailed user feedback for handled exceptions or errors.

Field	Type	Description
`title`	`string`
`message`	`string`
`level`	`enum NotificationLevel`	One of: `Standard`, `Info`, `Warning`, `Error`, `Success`, `Recommendation`.
`icon`	`enum MdiIcon`	One of: `None`, `SyncAlert`, `Autorenew`, `Check`, `CheckMarkedCircle`, `AlertCircle`, `TruckDeliveryOutline`, `TruckFastOutline`, `PackageCheck`, `Warehouse`, `SwapHorizontal`, `AccountCheck`, `AccountRemove`, `AccountCancel`, `Delete`.
`code`	`string`	The Notification code / Suggestion code for this suggestion

ActivityTrace

Refer to ActionMessage. An activity trace becomes an action message once the response to the client is sent.

Field	Type	Description
`id`	`string (uuid)`
`activityType`	`enum ActivityType`	One of: `System`, `User`.
`userId`	`string (uuid)`
`code`	`string`
`title`	`string`
`message`	`string`
`source`	`string`
`actionLink`	`string`
`level`	`enum NotificationLevel`	One of: `Standard`, `Info`, `Warning`, `Error`, `Success`, `Recommendation`.
`dateOfActivity`	`string (date-time)`
`isDashboardOnly`	`boolean`
`icon`	`enum MdiIcon`	One of: `None`, `SyncAlert`, `Autorenew`, `Check`, `CheckMarkedCircle`, `AlertCircle`, `TruckDeliveryOutline`, `TruckFastOutline`, `PackageCheck`, `Warehouse`, `SwapHorizontal`, `AccountCheck`, `AccountRemove`, `AccountCancel`, `Delete`.

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

BusinessFulfillmentProviderResponse

Field	Type	Description
`id`	`string (uuid)`
`defaultOption`	`boolean`
`accountNumber`	`string`
`contactEmail`	`string`
`dateOfExpiry`	`string (date-time)`
`contactPerson`	`PrimitiveUserResponse`

CollectionPreferenceResponse

Field	Type	Description
`title`	`string`
`collectionPreference`	`enum CollectionPreference`	One of: `NotAllocated`, `SameDay`, `NextDay`, `TwoDays`, `ThreeDays`, `FourDays`, `FiveDays`.

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`

CreateAddressRequest

Field	Type	Description
`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.

CreateOrderItemRequest

Its billing fields are deliberately nullable (see below), which that non-nullable-decimal interface can't express.

Field	Type	Description
`productId`	`string (uuid)`
`quantity`	`number (double)`	Used when a product is assigned to a order
`dimensionPresetId`	`string (uuid)`
`title`	`string`
`description`	`string`
`primaryImageUrl`	`string`
`weight`	`number (double)`
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`width`	`number (double)`
`length`	`number (double)`
`height`	`number (double)`
`subTotal`	`number (double)`	Null (or zero, matching the old non-nullable default) means "resolve this from price lists / price history". A non-zero value is a LINE TOTAL and is used unchanged. See `IOrderLinePricingService`.
`totalPrice`	`number (double)`
`totalTax`	`number (double)`
`totalDiscount`	`number (double)`
`discount`	`number (double)`
`discountType`	`enum DiscountType`	One of: `None`, `Percentage`, `FixedValue`.

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

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

DimensionPresetResponse

Field	Type	Description
`id`	`string (uuid)`
`vendor`	`string`	Limits: maximum 100 characters.
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`title`	`string`	Limits: maximum 200 characters.
`weight`	`number (double)`	The weight property acts as a limit for this specific box size.
`length`	`number (double)`
`width`	`number (double)`
`height`	`number (double)`
`defaultOption`	`boolean`	every business can have one package size preset set as the default option
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`countryCode`	`enum CountryCode`	One of: `Invalid`, `Global`, `FallbackZa`, `Be`, `De`, `Lu`, `Nl`, `Za`, `Zw`, `Gb`, `Us`, `Zm`.
`dimensionType`	`GeometryFieldSymbol`

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`

FulfillmentDeliveryTypeModel

Represents the delivery type. Perhaps the company only does warehouse to warehouse deliveries etc...

Field	Type	Description
`id`	`integer (int32)`
`value`	`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`

FulfillmentProviderResponse

Field	Type	Description
`id`	`integer (int32)`
`title`	`string`
`description`	`string`
`logoUrl`	`string`
`infoUrl`	`string`
`requiresUserAccount`	`boolean`
`isThirdPartyProvider`	`boolean`
`autoConfigure`	`boolean`
`fulfillmentTypes`	`string[]`
`configuredProvider`	`BusinessFulfillmentProviderResponse`
`integrationType`	`enum IntegrationType`	One of: `Unknown`, `OneClick`, `Plugin`, `Bespoke`, `ApiKey`.
`actionLink`	`string`
`fields`	`MetadataConfigurationValue[]`
`requiredFields`	`map<string, string>`
`configuredValues`	`map<string, string>`
`deliveryTypes`	`FulfillmentDeliveryTypeModel[]`
`serviceTypes`	`FulfillmentProviderServiceTypeModel[]`
`requirementTypes`	`FulfillmentRequirementTypeModel[]`
`serviceLevels`	`FulfillmentServiceLevelModel[]`
`subTypes`	`FulfillmentSubTypeModel[]`
`types`	`FulfillmentTypeModel[]`

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`

FulfillmentServiceLevelModel

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

FulfillmentSubTypeModel

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

FulfillmentTypeModel

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

FulfillmentTypeResponse

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

Geometry

Physical shipping geometry: the bounding measurements of an item plus the units they are expressed in. The single canonical shape for dimensions across the domain. Products, variants, shipments, order/shipment line items, and dimension presets all hold one of these instead of duplicating the Weight/Width/Length/Height quartet.

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

GeometryAndCountryMetadata

Field	Type	Description
`currencyCode`	`enum CurrencyCode`	One of: `Invalid`, `Eur`, `Usd`, `Gbp`, `Zar`, `Zmw`.
`countryCode`	`enum CountryCode`	One of: `Invalid`, `Global`, `FallbackZa`, `Be`, `De`, `Lu`, `Nl`, `Za`, `Zw`, `Gb`, `Us`, `Zm`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.

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`

GeometryFieldSymbol

Field	Type	Description
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`lengthSymbol`	`string`
`weightSymbol`	`string`

MetadataConfigurationValue

Field	Type	Description
`key`	`string`
`title`	`string`
`isVisible`	`boolean`	If this is true, it should be surfaced to the dashboard...
`isRequired`	`boolean`	If the user needs to provide this value when configuring the integration.
`isSecret`	`boolean`	If this is true, it should be returned as a marked value in the API response. We will show the first 5 characters and last 3 characters and remove the rest for security purposes.
`prefixMask`	`string`
`suffixMask`	`string`
`validationRegex`	`string`	If there is regex to be applied to validate the value, it should be set here....
`validationMessage`	`string`
`value`	`string`	The stored configuration value

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`

OrderBillingRequest

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`
`taxType`	`enum TaxType`	One of: `None`, `Sales`, `Vat`, `Gst`, `Pst`, `Hst`, `Qst`, `Ist`, `Ust`, `Cst`.
`taxRate`	`number (double)`

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

OrderCommentResponse

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

OrderDeleteCommand

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

OrderIntegrationDetailsResponse

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

OrderItemIdentity

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

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

OrderSettingsResponse

Field	Type	Description
`autoAllocatePackagePresets`	`boolean`
`autoAllocateFulfillmentProvider`	`boolean`
`autoGroupOrderItems`	`boolean`
`collectionPreferences`	`CollectionPreferenceResponse[]`
`dimensionPresets`	`DimensionPresetResponse[]`
`fulfillmentContacts`	`PrimitiveUserResponse[]`
`fulfillmentProviders`	`FulfillmentProviderResponse[]`
`fulfillmentTypes`	`FulfillmentTypeResponse[]`
`defaultFulfillmentProvider`	`string (uuid)`
`fulfillmentProvider`	`FulfillmentProviderResponse`
`defaultFulfillmentContact`	`string (uuid)`
`fulfillmentContact`	`PrimitiveUserResponse`
`defaultDimensionPreset`	`string (uuid)`
`dimensionPreset`	`DimensionPresetResponse`
`defaultFulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`fulfillmentType`	`FulfillmentTypeResponse`
`defaultCollectionPreference`	`enum CollectionPreference`	One of: `NotAllocated`, `SameDay`, `NextDay`, `TwoDays`, `ThreeDays`, `FourDays`, `FiveDays`.
`collectionPreference`	`CollectionPreferenceResponse`
`collectionPreferenceDate`	`string (date-time)`

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`

ProductCategoryPrimitive

Field	Type	Description
`category`	`string`

ProductGeometryFieldsResponse

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`
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`title`	`string`
`geometrySymbol`	`GeometryFieldSymbol`

ProductGroupSummaryResponse

Catalog-card summary of a product group (variant family): the umbrella name and how many products it contains. See group.

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

ProductIntegrationProviderResponse

Field	Type	Description
`provider`	`PrimitiveIntegrationProviderResponse`
`id`	`string (uuid)`	Represents the product integration id.
`integrationId`	`string`	The composite integration id in it's original form represented as a string. Refer to ProductService::GetProductResponse()
`product`	`ProductResponse`

ProductPriceDetailsResponse

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`
`id`	`string (uuid)`
`purchasable`	`boolean`
`priceType`	`enum PriceType`	One of: `Selling`, `Purchase`, `Cost`.
`source`	`enum PriceSource`	One of: `Manual`, `SupplierUpdate`, `Import`, `Sync`, `Migration`.
`notes`	`string`
`effectiveDate`	`string (date-time)`
`currencyMetadata`	`CurrencyResponse`
`priceUnit`	`enum UnitOfMeasure`	One of: `Each`, `Kilogram`, `Gram`, `Litre`, `Millilitre`, `Metre`, `Centimetre`, `SquareMetre`, `CubicMetre`, `Pair`, `Pack`, `Box`, `Roll`, `Sheet`.
`pricePackQuantity`	`number (double)`
`pricePerUnit`	`number (double)`
`basis`	`enum PriceResolutionBasis`	One of: `FixedItem`, `PeggedItem`, `ListRule`.
`adjustmentType`	`enum PriceAdjustmentType`	One of: `Percentage`, `Amount`.
`adjustmentValue`	`number (double)`

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

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

SupplierResponse

Field	Type	Description
`id`	`string (uuid)`
`title`	`string`
`description`	`string`
`contact`	`ContactResponse`
`addressId`	`string (uuid)`	Reference to the supplier's origin address (`business_addresses`), if set.
`address`	`AddressResponse`
`paymentTerms`	`string`	Free-text payment terms (e.g. "Net 30"). Display-only.
`defaultLeadTimeDays`	`integer (int32)`	Fallback lead time in days for suppliers with no purchase-order history yet.
`code`	`string`	Optional free-text internal reference code for the supplier (e.g. "SUP-001"). Display-only.
`defaultCurrency`	`enum CurrencyCode`	One of: `Invalid`, `Eur`, `Usd`, `Gbp`, `Zar`, `Zmw`.

SymbolicLocaleMetadata

Field	Type	Description
`currency`	`string`
`country`	`string`
`weight`	`string`
`length`	`string`
`businessDefaultTypes`	`GeometryAndCountryMetadata`

Work order templates

The work order templates operations of the Core API.

Customers

The customers operations of the Core API.