OMS Package Command Matrix
This guide summarizes all commands that can be run on OMS packages. For each command, it shows which package statuses the command can be applied to, which status the package moves to afterwards, and which error is returned when the command cannot be applied.
Overview
Package commands drive a package through its lifecycle, from planning and preparation to packaging, shipping, delivery, and replanning. Each command is a state transition: it starts from the package's current status and, when it succeeds, moves the package to a destination status (or updates package data without changing the status).
This guide covers:
How Commands Become Available on a Package
Commands are defined per customer. For a command to appear on a package, a state transition starting from the package's current status must be defined for that customer. The matrix shows every status a command can be applied to; a given customer may have only some of these transitions defined.
Commands visible on a package = defined transitions − transitions blocked by a condition. The transitions defined for the package's current status are listed. If a transition has a condition attached (see Command conditions) and the package does not meet it, the command is not listed.
Error responses. When a command cannot be applied, the response contains an error code (
error_code) and a description. Common error codes are listed in Error codes.
Transitions Defined in the Default Setup
The following transitions are defined by default. All other transitions are added based on customer requirements.
COMPLETE_PACKAGING
100 → 500
COMPLETE_PACKAGING_WITHOUT_SHIPMENT
100 → 500
SHIP_THE_PACKAGE
500 → 700
DETECTED_OUT_OF_STOCK_ITEM
100 → 920
UPDATE_PACKAGE_SHIPMENT_STATUS
700 → 800
RENEW_PACKAGE_PLAN
920 → 900, 1000 → 900
TRANSFERS_ARRIVED
300 → 100
SELF_SERVICE_PACKAGE_DELIVERY_COMMAND
610 → 800
READY_FOR_PICKUP
500 → 610
UPDATE_INVOICE_OF_THE_PACKAGE
500 → 500, 700 → 700
ASSIGN_PACKAGE_ITEMS_MANUALLY
100 → 900
How to Read the Matrix
Row: The package's status before the command runs (current status).
Cell: The status the package moves to after the command runs successfully.
500
The command runs; the package moves to this status afterwards.
500/510
The destination depends on the context (customer setting, whether a cargo label exists, the defined transition, etc.).
920→900
The package first moves to the first status, then to the second status through an automatic replan.
⁺
The command creates new package(s); the cell shows the final status of the original package.
=
The status does not change; the command only updates data (invoice, shipment information, label).
previous
The package returns to the status it had before it was blocked.
✗
A transition can be defined for this status, but the command is rejected when run (package_100_5).
—
Not applicable. The command cannot be defined for this status (commands_100_1). If the command is run while the package is in this status, package_100_5 is returned.
Note:
PACKAGE_SYNC_OMNITRON_STATUS(SYNC) can run in every status. It aligns the package status with the status of the order item in Omnitron. For readability, it is not repeated in the tables below.
Command Abbreviations
ACCEPT
ACCEPT_PACKAGING
Preparation
PST
PKG_STATE_TRANSITION
Preparation
DEALLOC
PKG_DEALLOCATE_RESERVATIONS
Preparation
PREPARE
PREPARE_PACKAGE_COMMAND
Preparation
STALE
MARK_STALE_PACKAGES
Preparation
MERGE
MERGE_SAME_LOCATION_PACKAGES
Preparation
TRF_ARR
TRANSFERS_ARRIVED
Preparation
BLOCK
BLOCK_THE_PACKAGE
Preparation
UNBLOCK
UNBLOCK_THE_PACKAGE
Preparation
CP
COMPLETE_PACKAGING
Packaging
CP_NOSHIP
COMPLETE_PACKAGING_WITHOUT_SHIPMENT
Packaging
CP_CHAN
CHANNEL_BASED_COMPLETE_PACKAGING
Packaging
LABEL
UPDATE_SHIPMENT_LABEL_OF_THE_PACKAGE
Packaging
SHIP
SHIP_THE_PACKAGE
Shipping
SHIP_ADV
SHIP_THE_PACKAGE_ADVANCED
Shipping
SHIP_BSC
SHIP_THE_PACKAGE_BASIC
Shipping
SHIP_INFO
UPDATE_SHIPMENT_INFO_OF_THE_PACKAGE
Shipping
SHIP_RECR
RECREATE_SHIPMENT_OF_THE_PACKAGE
Shipping
SHIP_STAT
UPDATE_PACKAGE_SHIPMENT_STATUS
Delivery
DELIVER
DELIVER_PACKAGE
Delivery
PICKUP
READY_FOR_PICKUP
Delivery
SELF_DLV
SELF_SERVICE_PACKAGE_DELIVERY_COMMAND
Delivery
OOS
DETECTED_OUT_OF_STOCK_ITEM
Stock / Replan
OOS_ADV
DETECTED_OUT_OF_STOCK_ITEM_ADVANCED
Stock / Replan
MISSING
REPORT_MISSING_ITEM_COMMAND
Stock / Replan
BLACKLST
BLACKLIST_ITEM
Stock / Replan
REFUSE
REFUSE_PACKAGE
Stock / Replan
RENEW
RENEW_PACKAGE_PLAN
Stock / Replan
ASSIGN
ASSIGN_PACKAGE_ITEMS_MANUALLY
Stock / Replan
REPLACE
REPLACE_PRODUCT
Stock / Replan
TRF_CNCL
CANCEL_TRANSFER_ORDER_RENEW_PACKAGE
Stock / Replan
PFR
PACKED_FOR_REFUND
Refund / Invoice
INVOICE
UPDATE_INVOICE_OF_THE_PACKAGE
Refund / Invoice
SYNC
PACKAGE_SYNC_OMNITRON_STATUS
Sync
Command Matrix by Group
Each table lists only the statuses where at least one command in the group is applicable.
Preparation
100 waiting
110
150/200
200
200⁺
105
900⁺
—
1200
—
110 accepted
—
150/200
200
200⁺
—
—
—
1200
—
150 waiting_remote_action
—
200
—
—
—
—
—
1200
—
200 preparing
—
—
—
—
—
—
—
1200
—
300 waiting_transfer_operation
—
—
—
—
—
—
100
—
—
400 ready_to_pack
—
—
—
—
—
—
—
1200
—
1200 blocked
—
—
—
—
—
—
—
—
previous
Packaging
100 waiting
500/510
500
500
—
110 accepted
500/510
500
500
—
200 preparing
500/510
500
500
=
400 ready_to_pack
500/510
500
500
—
500 packed
—
—
—
=
510 waiting_cargo_label
—
—
—
500/700
700 shipped
—
—
—
=
Shipping
500 packed
700
700/510
700
=
=
700 shipped
—
—
—
=
=
710 delivery_failed
—
—
—
=
=
720 attempted_delivery
—
—
—
=
=
Delivery
100 waiting
—
—
610
800
105 stale_waiting
—
800/610
—
—
110 accepted
—
—
610
800
200 preparing
—
—
—
800
500 packed
—
—
610
800
610 ready_for_customer_pickup
—
—
—
800
700 shipped
800/710
800/610
610
—
710 delivery_failed
800/710
800/610
—
—
720 attempted_delivery
800/710
—
—
—
800 delivered
✗
—
—
—
Stock / Replan
100 waiting
920→900⁺
920⁺
920/900⁺
920⁺
1000
—
900⁺
900⁺
—
105 stale_waiting
—
—
—
—
—
900⁺
—
—
—
110 accepted
920→900⁺
920⁺
920/900⁺
920⁺
1000
—
900⁺
900⁺
—
150 waiting_remote_action
—
—
920/900⁺
—
1000
—
900⁺
—
—
200 preparing
920→900⁺
920⁺
920/900⁺
—
1000
—
900⁺
—
—
300 waiting_transfer_operation
—
—
—
—
—
—
900⁺
—
920→900⁺
400 ready_to_pack
920→900⁺
920⁺
—
—
—
—
—
—
—
910 defective_products
—
—
—
—
—
900⁺
900⁺
—
—
920 out_of_stock_products
—
—
—
—
—
900⁺
900⁺
—
—
1000 needs_replan
—
—
—
—
—
900⁺
900⁺
—
—
Refund / Invoice
100 waiting
1100
—
110 accepted
1100
—
300 waiting_transfer_operation
—
=
500 packed
—
=
610 ready_for_customer_pickup
—
=
700 shipped
—
=
720 attempted_delivery
—
=
800 delivered
—
=
920 out_of_stock_products
1100
—
1100 packed_for_refund
—
=
Note: There are no package commands for the
520 waiting_invoice_creation,850 cancellation_waiting,900 cancelled,1300 refund, and1310 refund_waitingstatuses. Packages are moved into these statuses by the order cancellation/refund flow or by cargo tracking (see Status glossary).
Status-Based Quick Reference
This is the list view of the matrix: for each current status, the commands that can be run and the status the package moves to afterwards.
100 waiting
ACCEPT_PACKAGING
110 accepted
PKG_STATE_TRANSITION
150 waiting_remote_action or 200 preparing
PKG_DEALLOCATE_RESERVATIONS
200 preparing
PREPARE_PACKAGE_COMMAND
200 preparing + new package(s)
MARK_STALE_PACKAGES
105 stale_waiting
MERGE_SAME_LOCATION_PACKAGES
900 cancelled + new package(s)
BLOCK_THE_PACKAGE
1200 blocked
COMPLETE_PACKAGING
500 packed or 510 waiting_cargo_label
COMPLETE_PACKAGING_WITHOUT_SHIPMENT
500 packed
CHANNEL_BASED_COMPLETE_PACKAGING
500 packed
READY_FOR_PICKUP
610 ready_for_customer_pickup
SELF_SERVICE_PACKAGE_DELIVERY_COMMAND
800 delivered
DETECTED_OUT_OF_STOCK_ITEM
920 out_of_stock_products, then 900 cancelled + new package(s)
DETECTED_OUT_OF_STOCK_ITEM_ADVANCED
920 out_of_stock_products + new package(s)
REPORT_MISSING_ITEM_COMMAND
920 out_of_stock_products or 900 cancelled + new package(s)
BLACKLIST_ITEM
920 out_of_stock_products + new package(s)
REFUSE_PACKAGE
1000 needs_replan
ASSIGN_PACKAGE_ITEMS_MANUALLY
900 cancelled + new package(s)
REPLACE_PRODUCT
900 cancelled + new package(s)
PACKED_FOR_REFUND
1100 packed_for_refund
105 stale_waiting
DELIVER_PACKAGE
800 delivered or 610 ready_for_customer_pickup
RENEW_PACKAGE_PLAN
900 cancelled + new package(s)
110 accepted
PKG_STATE_TRANSITION
150 waiting_remote_action or 200 preparing
PKG_DEALLOCATE_RESERVATIONS
200 preparing
PREPARE_PACKAGE_COMMAND
200 preparing + new package(s)
BLOCK_THE_PACKAGE
1200 blocked
COMPLETE_PACKAGING
500 packed or 510 waiting_cargo_label
COMPLETE_PACKAGING_WITHOUT_SHIPMENT
500 packed
CHANNEL_BASED_COMPLETE_PACKAGING
500 packed
READY_FOR_PICKUP
610 ready_for_customer_pickup
SELF_SERVICE_PACKAGE_DELIVERY_COMMAND
800 delivered
DETECTED_OUT_OF_STOCK_ITEM
920 out_of_stock_products, then 900 cancelled + new package(s)
DETECTED_OUT_OF_STOCK_ITEM_ADVANCED
920 out_of_stock_products + new package(s)
REPORT_MISSING_ITEM_COMMAND
920 out_of_stock_products or 900 cancelled + new package(s)
BLACKLIST_ITEM
920 out_of_stock_products + new package(s)
REFUSE_PACKAGE
1000 needs_replan
ASSIGN_PACKAGE_ITEMS_MANUALLY
900 cancelled + new package(s)
REPLACE_PRODUCT
900 cancelled + new package(s)
PACKED_FOR_REFUND
1100 packed_for_refund
150 waiting_remote_action
PKG_STATE_TRANSITION
200 preparing
BLOCK_THE_PACKAGE
1200 blocked
REPORT_MISSING_ITEM_COMMAND
920 out_of_stock_products or 900 cancelled + new package(s)
REFUSE_PACKAGE
1000 needs_replan
ASSIGN_PACKAGE_ITEMS_MANUALLY
900 cancelled + new package(s)
200 preparing
BLOCK_THE_PACKAGE
1200 blocked
COMPLETE_PACKAGING
500 packed or 510 waiting_cargo_label
COMPLETE_PACKAGING_WITHOUT_SHIPMENT
500 packed
CHANNEL_BASED_COMPLETE_PACKAGING
500 packed
UPDATE_SHIPMENT_LABEL_OF_THE_PACKAGE
Unchanged (data is updated)
SELF_SERVICE_PACKAGE_DELIVERY_COMMAND
800 delivered
DETECTED_OUT_OF_STOCK_ITEM
920 out_of_stock_products, then 900 cancelled + new package(s)
DETECTED_OUT_OF_STOCK_ITEM_ADVANCED
920 out_of_stock_products + new package(s)
REPORT_MISSING_ITEM_COMMAND
920 out_of_stock_products or 900 cancelled + new package(s)
REFUSE_PACKAGE
1000 needs_replan
ASSIGN_PACKAGE_ITEMS_MANUALLY
900 cancelled + new package(s)
300 waiting_transfer_operation
TRANSFERS_ARRIVED
100 waiting
ASSIGN_PACKAGE_ITEMS_MANUALLY
900 cancelled + new package(s)
CANCEL_TRANSFER_ORDER_RENEW_PACKAGE
920 out_of_stock_products, then 900 cancelled + new package(s)
UPDATE_INVOICE_OF_THE_PACKAGE
Unchanged (data is updated)
400 ready_to_pack
BLOCK_THE_PACKAGE
1200 blocked
COMPLETE_PACKAGING
500 packed or 510 waiting_cargo_label
COMPLETE_PACKAGING_WITHOUT_SHIPMENT
500 packed
CHANNEL_BASED_COMPLETE_PACKAGING
500 packed
DETECTED_OUT_OF_STOCK_ITEM
920 out_of_stock_products, then 900 cancelled + new package(s)
DETECTED_OUT_OF_STOCK_ITEM_ADVANCED
920 out_of_stock_products + new package(s)
500 packed
UPDATE_SHIPMENT_LABEL_OF_THE_PACKAGE
Unchanged (data is updated)
SHIP_THE_PACKAGE
700 shipped
SHIP_THE_PACKAGE_ADVANCED
700 shipped or 510 waiting_cargo_label
SHIP_THE_PACKAGE_BASIC
700 shipped
UPDATE_SHIPMENT_INFO_OF_THE_PACKAGE
Unchanged (data is updated)
RECREATE_SHIPMENT_OF_THE_PACKAGE
Unchanged (data is updated)
READY_FOR_PICKUP
610 ready_for_customer_pickup
SELF_SERVICE_PACKAGE_DELIVERY_COMMAND
800 delivered
UPDATE_INVOICE_OF_THE_PACKAGE
Unchanged (data is updated)
510 waiting_cargo_label
UPDATE_SHIPMENT_LABEL_OF_THE_PACKAGE
500 packed or 700 shipped
610 ready_for_customer_pickup
SELF_SERVICE_PACKAGE_DELIVERY_COMMAND
800 delivered
UPDATE_INVOICE_OF_THE_PACKAGE
Unchanged (data is updated)
700 shipped
UPDATE_SHIPMENT_LABEL_OF_THE_PACKAGE
Unchanged (data is updated)
UPDATE_SHIPMENT_INFO_OF_THE_PACKAGE
Unchanged (data is updated)
RECREATE_SHIPMENT_OF_THE_PACKAGE
Unchanged (data is updated)
UPDATE_PACKAGE_SHIPMENT_STATUS
800 delivered or 710 delivery_failed
DELIVER_PACKAGE
800 delivered or 610 ready_for_customer_pickup
READY_FOR_PICKUP
610 ready_for_customer_pickup
UPDATE_INVOICE_OF_THE_PACKAGE
Unchanged (data is updated)
710 delivery_failed
UPDATE_SHIPMENT_INFO_OF_THE_PACKAGE
Unchanged (data is updated)
RECREATE_SHIPMENT_OF_THE_PACKAGE
Unchanged (data is updated)
UPDATE_PACKAGE_SHIPMENT_STATUS
800 delivered or 710 delivery_failed
DELIVER_PACKAGE
800 delivered or 610 ready_for_customer_pickup
720 attempted_delivery
UPDATE_SHIPMENT_INFO_OF_THE_PACKAGE
Unchanged (data is updated)
RECREATE_SHIPMENT_OF_THE_PACKAGE
Unchanged (data is updated)
UPDATE_PACKAGE_SHIPMENT_STATUS
800 delivered or 710 delivery_failed
UPDATE_INVOICE_OF_THE_PACKAGE
Unchanged (data is updated)
800 delivered
UPDATE_PACKAGE_SHIPMENT_STATUS
Rejected (package_100_5)
UPDATE_INVOICE_OF_THE_PACKAGE
Unchanged (data is updated)
910 defective_products
RENEW_PACKAGE_PLAN
900 cancelled + new package(s)
ASSIGN_PACKAGE_ITEMS_MANUALLY
900 cancelled + new package(s)
920 out_of_stock_products
RENEW_PACKAGE_PLAN
900 cancelled + new package(s)
ASSIGN_PACKAGE_ITEMS_MANUALLY
900 cancelled + new package(s)
PACKED_FOR_REFUND
1100 packed_for_refund
1000 needs_replan
RENEW_PACKAGE_PLAN
900 cancelled + new package(s)
ASSIGN_PACKAGE_ITEMS_MANUALLY
900 cancelled + new package(s)
1100 packed_for_refund
UPDATE_INVOICE_OF_THE_PACKAGE
Unchanged (data is updated)
1200 blocked
UNBLOCK_THE_PACKAGE
Status before the block
Note:
PACKAGE_SYNC_OMNITRON_STATUSis not repeated in this table because it can run in all statuses. The following statuses have no other package commands:520 waiting_invoice_creation,850 cancellation_waiting,900 cancelled,1300 refund,1310 refund_waiting.
Status Glossary
100
waiting
The first status of a package after planning. The package also returns here when transfers are completed (TRANSFERS_ARRIVED).
Preparation, packaging, out-of-stock, block, refusal, refund, etc.
105
stale_waiting
The package has been waiting for too long (MARK_STALE_PACKAGES); its reservations are released.
RENEW_PACKAGE_PLAN, DELIVER_PACKAGE
110
accepted
The store has accepted the package (ACCEPT_PACKAGING).
Largely the same commands as 100
150
waiting_remote_action
The package has been handed over to an external system (PKG_STATE_TRANSITION).
PKG_STATE_TRANSITION, block, refusal, missing item
200
preparing
Picking has started.
Packaging, out-of-stock, block, refusal, delivery (click & collect)
300
waiting_transfer_operation
Planning requires a transfer; the package is waiting for transfers.
TRANSFERS_ARRIVED (automatically, once no active transfer remains), CANCEL_TRANSFER_ORDER_RENEW_PACKAGE, ASSIGN_PACKAGE_ITEMS_MANUALLY
400
ready_to_pack
Ready for packaging. Occurs as the starting status of a packaging scenario or when a block is removed.
Packaging, out-of-stock, block
500
packed
All items have been packed.
Shipping, click & collect, invoice/shipment updates
510
waiting_cargo_label
Packed/shipped but without a cargo label (for customers with the pending cargo label flow enabled).
UPDATE_SHIPMENT_LABEL_OF_THE_PACKAGE
520
waiting_invoice_creation
Not used in the standard flow; can only occur with a customer-specific definition.
—
610
ready_for_customer_pickup
The click & collect package is ready at the store (READY_FOR_PICKUP, or delivery/cargo tracking while the click & collect setting is enabled).
SELF_SERVICE_PACKAGE_DELIVERY_COMMAND
700
shipped
Handed over to the carrier.
Delivery commands, cargo tracking, shipment information updates
710
delivery_failed
Delivery failed (failure/cancellation information from the carrier, or a failed delivery reported via UPDATE_PACKAGE_SHIPMENT_STATUS).
DELIVER_PACKAGE, UPDATE_PACKAGE_SHIPMENT_STATUS
720
attempted_delivery
Delivery was attempted; set only by cargo tracking.
UPDATE_PACKAGE_SHIPMENT_STATUS, invoice/shipment updates
800
delivered
Delivered.
Invoice update only; refund flow (→ 1310)
850
cancellation_waiting
The order cancellation is being processed. A package with a shipment enters this status only if all of its items are being cancelled and it is in 100, 200, or 1000.
900 / 1000 when the plan is completed; the previous status if reverted
900
cancelled
Terminal. Entered through order cancellation, replan, merge, manual assignment, product replacement, or Omnitron sync.
—
910
defective_products
A defective product was reported (out-of-stock commands, if 910 is defined as the destination).
RENEW_PACKAGE_PLAN, ASSIGN_PACKAGE_ITEMS_MANUALLY
920
out_of_stock_products
Out of stock was reported.
RENEW_PACKAGE_PLAN, ASSIGN_PACKAGE_ITEMS_MANUALLY, PACKED_FOR_REFUND
1000
needs_replan
The package must be replanned (store refusal, partial cancellation).
RENEW_PACKAGE_PLAN, ASSIGN_PACKAGE_ITEMS_MANUALLY
1100
packed_for_refund
Packed for refund (PACKED_FOR_REFUND). The refund itself is processed separately.
Invoice update; refund flow
1200
blocked
Put on hold (BLOCK_THE_PACKAGE); reservations are kept.
UNBLOCK_THE_PACKAGE
1300
refund
Refund completed (order refund or Omnitron sync). Terminal.
—
1310
refund_waiting
The refund plan is being processed. Entered only from 500/510/610/700/710/720/800; otherwise the refund is rejected.
1300 when the plan is completed; the previous status if reverted
Command Conditions
Conditions are rules that can be attached to transitions. If the package does not meet the rule, the command is not listed on the package. If the command is run anyway, package_commands_100_1 is returned.
OMNISHOP_ORDERS
The order's channel is not one of the defined channels.
ONLY_CLICK_AND_COLLECT_ORDERS
The order is not a click & collect order.
OTHER_THAN_CLICK_AND_COLLECT_ORDERS
The order is a click & collect order.
BLOCK_NON_TRADEIN_PACKAGES
The order does not meet the trade-in rule. [Rule details masked.] This condition returns a dedicated error code: [masked].
RETAIL_STORE_PACKAGING_WITHOUT_SHIPMENT
The delivery store is different from the package's location.
RETAIL_STORE_PACKAGING_WITH_SHIPMENT
The delivery store is the same as the package's location.
VIEWING_STORE_IS_DELIVERY_STORE
The store performing the action is not the package's location.
SHIPPING_OPTION_GROUP
The carrier of one of the items is not in the defined list.
WAIT_MINUTES_SINCE_COMMAND
The specified command was run on this package within the last X minutes.
STOCK_LOCATION_LIST
The package location is not in the list.
EXCLUDED_STOCK_LOCATION_LIST
The package location is in the excluded list.
Error Codes
The following errors are common to all commands. Dynamic values in response messages are shown as [masked].
package_100_5
The package is not in a status the command can be applied to (e.g., SHIP_THE_PACKAGE was run on a package in status 200).
Invalid state transition ([masked]) for ([masked]) package.
package_100_6
The command ran, but the package did not move to the expected status or the expected data was not created.
Package State transition failed to complete correctly. [masked]
commands_100_1
Returned while defining a transition: the command cannot be defined with these statuses.
Command definition is not allowed! Check source & destination states of command to be created.
commands_100_3
The command parameters are invalid.
Invalid command parameters passed to command.
commands_100_4, commands_100_6
Another command required by this command is not defined for the customer.
State transition ([masked]) not defined
package_commands_100_1
A condition attached to the transition blocked the package.
Package command can not be applied this package! Package: [masked]
package_commands_100_12
The command parameters do not match the package items.
Command parameters are invalid for the package! Package: [masked]!
state_100_1
The package is already in the destination status.
Invalid state transition. Already on the same state!
—
The command could not be found.
[masked]
Was this helpful?

