Skip to main content

Manual Planning Command

Actors​

  • Akinon Order Management System (OMS)

Domain Objects​

  • OMS Command (Manual Planning Command): Represents the command used within the OMS to initiate manual planning activities for packaging orders.

Process​

  1. OMS application copies orders from Akinon Omnitron Application to prepare delivery/distribution plans and generates Packing Orders to transfer them to operational points.

  2. Products within orders are distributed to Packing Orders based on rules defined in the brand's chosen distribution scenarios.

  3. Packing Orders are transferred to Akinon Instore Application or integrated software of the brand (Packing Orders via Webhooks).

  4. Packing orders assigned by Store/Warehouse begin their lifecycle in "Waiting" status.

  5. Package items can be manually assigned to a location based on demand. If such a need arises, package contents are grouped, and new packages are created for specified locations.

  6. Existing reservations at the current location are canceled. Reservations are created for newly formed packages.

  7. Packages are canceled and transition to "waiting" status for newly created packages.

Command Parameters and Preconditions​

For each packing order:

  • Packing Order ID (integer - dynamic for each order)
  • Command Transition ID (integer - fixed - prepared and informed during OMS setup)
  • assignment_groups containing all package items (List)
  • Package item ID information (List - grouped according to products included in newly created packages)
  • Stock location erp_code (String - specifies the location for each new package creation)

If this command is executed before the packing order transitions to the "Packaged" status, a validation error will occur.

Usage​

Example of a packing order:

  • API Endpoint: https://<customer>.omnitron.akinon.net/api/v1/oms/packages/136/command
  • Package ID: 136
  • PackageItemSet: [1212121, 13131313]
  • StockLocation1 erp_code: "akinon_1"
  • StockLocation2 erp_code: "akinon_2"
  • Transition ID: NNN (To be determined after OMS setup)
  • Slug: SSS (Unique Slug Value)

Example Request​

  • Path: https://<customer>.omnitron.akinon.net/api/v1/oms/packages/{package_id}/command
  • Method: POST

Request Body​

    {
    "input_parameters": {
        "assignment_groups": [
            {
                "package_items": [1212121],
                "stock_location": "akinon_1"
            },
            {
                "package_items": [13131313],
                "stock_location": "akinon_2"
            }
        ]
    },
    "transition": NNN,
    "slug": SSS,
}

Example Response​

  • Status Code: 204
  • Body: Empty