Update The Package’s Invoice
Actors
Akinon Order Management System (OMS)
Akinon Omnitron System
Integrated Application (ERP)
Domain Objects
Packaging Orders
Invoice Number
Invoice Document
OMS Command
Process
The OMS application copies orders from the Akinon Omnitron Application to itself to prepare a delivery/distribution plan and generate packaging orders, which are then transferred to the operation points.
The products in the order are distributed to Packaging Orders by applying the rules in the distribution scenarios by the brand.
Packaging Orders are transferred to the Akinon Instore Application or the brand's integrated software. ( Packing Orders Webhooks )
Packaging orders assigned to a Store/Warehouse begin in the Waiting status.
When the packaging is physically prepared for distribution in one or more steps, it transitions to the Packed status either through screens in the Akinon Instore application or by executing OMS commands from another integrated software.
Packages with the Packed status have a Packaging Document created by OMS, which can later be replaced with an Invoice produced by the brand's own software. The command for this change is defined in the OMS Commands API.
A packaging order in the Packed status, as well as later statuses, can be created by executing the UpdateInvoiceOfThePackageCommand command:
Invoice number
Invoice document type
Invoice document content
Date of Invoice
Upon sending the parameters according to the service requirements, the transfer of Package and Invoice information to the financial section of the OMS application is completed.
After executing this command, a copy of the document becomes available in the OMS application, allowing it to be viewed and reported on the Packing Order detail pages (Akinon Instore + Akinon OMS Web).
Command Parameters and Prerequisites
For each packaging order following parameters uses;
Packing Order ID (integer): Unique identifier for each order.
Command Transition ID (integer): Fixed value provided during OMS installation.
Invoice Number (string): Dynamic invoice number for each package.
Invoice Date (string): Date format: %Y-%m-%dT%H:%M:%S%z.
Data Type (String): Type of data (url, html, base64, text). The data type determines the format of the invoice data.
Invoice Data (String): HTML or PDF data, depending on the specified data type.
If this command is executed before a packaging order reaches the Packed status, it will result in a validation error. The prerequisite for all packaging orders that have reached the Packed status is considered to be completed (e.g., shipped status).
POST Update The Package’s Shipment Status
POST Update The Package’s Shipment StatusPath: https://{customer_api_url}-oms.akinon.net/api/v1/oms/packages/{package_id}/command/
Request Parameters
token
string
header
The API key of the customer account
Package ID: package_id (integer)
Transition ID: transition id (integer) (set after OMS installation)
Request Body
Successful Response
Status Code: 204 No Content
Body: Empty
If the invoice information will be transferred in HTML format;
Base64 Data
If the invoice information will be transferred in Base64 image or PDF format;
Transitions and Validations
The command transition source and destination values must be the same.
Last updated
Was this helpful?