Miridia
Portal
Guides

Orders and shipments

Manage customers, sales channels, and sales orders. Split an order into shipments, and send the logistics work to Cargopilot.

A sales order records a sale to a customer. Ownership of the goods changes, and the business earns revenue. Orders come from a connected sales channel, from the API, or from a person in the portal.

Customers

A customer record holds the name, the addresses, and the contacts of a buyer. You can also add:

  • attachments, for example a signed contract
  • free-form metadata
  • activity traces, which are a dated history of notes and events

Each customer has KPI metrics: the total number of orders, the total revenue, the total number of deliveries, the fulfilment cost, and the rank of the customer by revenue.

Customer groups

A customer group collects customers that get the same treatment. An example is "Trade" or "Wholesale". Assign a price list to a group to give the group its own prices. Read Pricing.

Sales channels

A sales channel is a place where you sell. Each channel has a kind:

KindExample
DirectAn order that a person enters in the portal.
PointOfSaleA till in a shop.
OnlineA web store, for example Shopify or WooCommerce.
MarketplaceA marketplace, for example Amazon.

Each channel can have a default location. An order from the channel starts at that location.

Sales orders

An order has a customer, an origin location, a sales channel, a currency, a destination address, and items. It can also have a customer purchase order number, billing data, a payment method, and metadata.

Order status

StatusMeaning
NewThe order arrived.
PendingCollectionThe goods wait for collection.
PendingDeliveryThe goods are on the way to the customer.
CompleteThe customer received the goods.
CancelledThe order stopped.
PendingReturnThe customer asked to return goods.
ReturnedThe goods came back.

You can set the status to Complete or Cancelled with a PATCH request. The shipment progress sets the other statuses.

Comments, attachments, and traces

Each order has comments from your team, attachments, and an activity trace. Use them to keep the history of the order in one place.

Shipments

A shipment is a group of order items that move together. One order can have more than one shipment. For example, you can send the chilled items separately from the dry items.

To create a shipment for an order, give the items that it carries. If you give no items, Miridia puts all the items that have no shipment into the new shipment. You can change the items of a shipment later. The shipment keeps its id and its code.

A shipment has a fulfilment type: Package, Pallet, Container, or Miscellaneous. It also has a service level, for example Standard, Express, or SameDay.

Miridia and Cargopilot

Miridia owns the shipment record: what moves, from where, to where, and the status.

Cargopilot owns the shipment execution. Cargopilot is the logistics product of Miridia. It does carrier quotations and booking, waybills, labels, tracking, route planning, fleet management, and customs work. Miridia gives Cargopilot a shipment. Cargopilot does the logistics work and writes the status back.

Through this link, Miridia can request carrier quotations for a shipment and show the selected quotation on the record.

Cargopilot

Read about carriers, routes, fleets, labels, and customs on the Cargopilot site.

Notifications and workflows

Miridia tells the business about a new order from a sales channel, and about an order that is complete or cancelled. It does not send a notification for an order that a person entered, because that person already knows about it.

Workflows can start on these triggers: OnOrderCreated, OnOrderUpdated, OnOrderStatusChanged, OnOrderItemCreated, OnOrderItemUpdated, OnOrderItemDeleted, and OnOrderDeleted. Read Workflows.

API reference