Skip to main content

Block The Package For Action Command

Actors​

  • Akinon Order Management System (OMS)

Domain Objects​

  • Packaging Order
  • OMS Command (Packaging Order Command)

Process​

  1. The OMS application copies orders from the Akinon Omnitron Application to itself to prepare delivery/distribution plans, generate packaging orders and transfer them to operation points. If there is shipping information available for the order, the order is recorded in the OMS with this shipping information.
  2. The products in the order are distributed to the Packaging Orders by running the rules in the distribution scenarios designated by the brand.
  3. Packaging Orders are transferred to the Akinon Instore App or the brand’s integrated software. (Packaging Orders Webhooks)
  4. Packaging orders assigned to the Store/Warehouse commence in the Waiting status.
  5. BlockThePackageCommand is run if the current packaging order is to be suspended, i.e. moved to a status that will block any action;
    • Packages and package items are moved to the Blocked status.
    • A StateTransitionLog is created, preserving the package status before the blocking. When the package is unblocked, it reverts to its previous status.
    • No process is carried out for the reservations of the packaged products at the current location.

Command Parameters and Prerequisites​

For each packaging order:

  • Packaging Order ID (integer – dynamic for each order)
  • Command Transition ID (integer – constant – prepared and reported during OMS installation)
  • slug (string - unique for each state transition - Either slug or Command Transition ID is required)
  • User (string – ID of the user running the command)
  • Token (string – requests sent to Omnitron are used for authentication)

If this command is run before a packaging order is moved to the Waiting, Waiting Remote Action, Preparing or Ready for Packaging status, a validation error will be triggered.

Regardless of scenarios, the process of lowering and raising quotas continues, the quota amount continues to increase and decrease on a location basis. However, for these alterations to impact planning, the scenario rules must have the SELECT_BY_QUOTA value.

  • The maximum quota value specifies how many packages can be created from the respective location. The quota value is a user-unspecified parameter used for monitoring the maximum quota value and performing increase or decrease operations.

  • max_quota - quota = available_quota

  • If the available_quota value is 0, no packages can be created. (To encounter this scenario, the SELECT_BY_QUOTA value must be chosen in the scenario rules.)

  • For packages with a status below 400 and in the cancellation_waiting state, the quota value increases by 1. (During this stage, when the package is in the waiting state, the quota amount is considered to increase by 1.)

  • Upon packaging a package, the quota value decreases by 1. Consequently, the available_quota increases, enhancing the likelihood of packaging from the respective location.

  • In the event of a package cancellation, the quota amount decreases by 1 in a similar way.

POST Block the Package for Action​

Path: https://{customer_api_url}-oms.akinon.net/api/v1/oms/packages/{package_id}/command/

  • Package ID: XXX
  • ID of the requesting user: YYY
  • Transition ID: NNN (set after OMS installation)
  • Slug: SSS (Unique Slug Value)

Request Body​

{
    "transition": NNN,
    "slug": SSS,
    "package": XXX,
    "token": "8bda3f25093XXXXXXXXXX52d34343059012131",
    "user": YYY
}

Successful Response​

Status Code: 204 No Content