Change shipment status

This transaction is equivalent to the changeShipmentStatus() API. For detailed information about this transaction, see the Javadoc.

To be configured as part of your shipment processing pipeline, this transaction can be used whenever an automatic change in the status of a shipment is required. For example, this automatic change could represent exporting shipment information to a warehouse management system or to transmit an Advance Shipping Notice to the buyer.

This transaction should be configured to work from the task queue.

Attributes

The following are the attributes for this time-triggered transaction:

Table 1. Change shipment status attributes
Attribute	Value
Base Transaction ID	CHANGE_SHIPMENT_STATUS
Base Document Type	Order
Base Process Type	Order Delivery
Abstract Transaction	Yes
APIs Called	None

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Change shipment status parameters
Parameter	Description
Action	Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value.
Number of Records To Buffer	Optional. Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), it defaults to 5000.
ColonyID	Required in a sharded deployment where a table may exist in multiple schemas. Runs the agent for the colony.
Task Queue Filter Criteria	Optional. Determines the jobs to be fetched by the agent. The value assigned to this parameter is matched against the custom value stored in the `FILTER_CRITERIA` column of `YFS_TASK_Q` table, while fetching the jobs. Note: `VOID` is a valid task queue filter criteria value which is used to match records with NULL value in the `FILTER_CRITERIA` column of `YFS_TASK_Q` table. For more information, see Workload segregation for task queue agents.

Statistics tracked

The following statistics are tracked for this transaction:

Table 3. Create chained order statistics
Statistic Name	Description
NumShipmentsChanged	Number of shipments whose status was changed.

Pending job count

For this transaction the pending job count is the number of records available to be processed by the transaction with the AVAILABLE_DATE value less than or equal to (<=) the current date value in the YFS_Task_Q table.

Events raised

This transaction raises events as specified under the changeShipmentStatus() API in the Javadoc.