Omnium Get Order
Fetches a specific order from Omnium and breaks out the most useful details, including customer information and shipment tracking. Use it in order tracking, returns and customer service flows for stores running on Omnium.
What it does
- Retrieves the order that matches the given order ID from Omnium.
- Surfaces customer details such as name, email and the order currency, status and dates.
- Summarises shipments, including how many there are and whether the order is split across several.
- Breaks out the first shipment's status, shipping method, tracking and return details for quick use.
Inputs
| Name | Type | Description |
|---|---|---|
| Bearer Token | String | The bearer token for Omnium |
| Order ID | String | The order to look up in Omnium |
Outputs
| Name | Type | Description |
|---|---|---|
| Tracking Found? | Boolean | Whether any tracking info was found for the tracking number provided |
| Order Object | Object | The object representing the order |
| Customer Email | String | Email address of the customer |
| Customer Name | String | Name of the customer |
| Currency | String | Currency used in the order |
| Status | String | Status of the package delivery |
| Created Date | String | Date when the order was created |
| Modified Date | String | Date when the order was last modified |
| Order Type | String | Type of the order |
| Number of Shipments | Integer | Total number of shipments for the order |
| Multiple Shipments | Boolean | Whether the order has multiple shipments |
| First Shipment | Object | Details of the first shipment |
| First Shipment Status | String | Status of the first shipment |
| First Shipment Shipping Method | String | Shipping method used for the first shipment |
| First Shipment In Transit | Boolean | Whether the first shipment is currently in transit |
| First Shipment Expected Delivery | String | Expected delivery date for the first shipment |
| First Shipment Tracking Reference | String | Tracking reference number for the first shipment |
| First Shipment Tracking URL | String | URL to track the first shipment |
| First Shipment Return Tracking Reference | String | Tracking reference number for the return shipment of the first shipment |
| First Shipment Return Tracking Link | String | Link to track the return shipment of the first shipment |
| First Shipment Return Label Link | String | Link to the return label for the first shipment |
Notes
- The full order is available in
Order Object; the individual outputs are convenience fields pulled from it. - The first-shipment outputs describe only the first shipment. Use
Number of ShipmentsandMultiple Shipmentsto detect orders with more than one shipment.