Populate Ship Status for EmailOut XML (L61)

Purpose: Use this screen to define whether the system populates the ist_ship_status attribute when generating the Outbound Email XML Message (CWEmailOut) for a shipment or return confirmation.

Yes/No field: Select this field to have the system populate the ist_ship_status when generating the Outbound Email XML Message (CWEmailOut) for a shipment or return confirmation.

The system includes the ist_ship_status attribute in the Invoice element of the CWEmailOut message. The ist_ship_status attribute defines the status of the shipment.

• Partial = Partial shipment. The OST Order status for the Order Ship To is:

- O Open.

- X Closed, but there are newer non-credit invoice records for the Order Ship To. The system looks at the IHD Invoice type in the Invoice Header table to determine if the invoice record is a debit or credit invoice: I = Invoice, C = Credit Invoice.

• Complete = Complete shipment. The OST Order status for the Order Ship To is X Closed and there are no other invoices for the order, regardless of date.

• Final = Final shipment. The OST Order status for the Order Ship To is X Closed and there are older invoice records for the Order Ship To. Note: Order maintenance and item exchanges to previously closed orders will send the customer a second Final shipment confirmation status. This occurs because the originally closed order was opened again with the addition of the new order line.

Note: The ist_ship_status attribute is available in version 8.0 of the CWEmailOut message (version 3.5 of Order Management System).

Leave this field unselected to exclude the ist_ship_status attribute when generating the Outbound Email XML Message (CWEmailOut) for a shipment confirmation.

Example 1

An order contains three order lines that ship together. When you bill the shipment, the system generates one invoice for the order and updates its status to X Closed. When the system generates a CWEmailOut message for the shipment, the system populates the ist_ship_status attribute with Complete.

Example 2

An order contain three order lines. Order line 1 ships. When you bill the shipment, the system generates an invoice for the order. The status for the Order Ship To remains O Open since there are two other lines to ship. When the system generates a CWEmailOut message for the shipment, the system populates the ist_ship_status attribute with Partial.

You ship line 2 on the order. When you bill the shipment, the system generates another invoice for the order. The status for the Order Ship To remains O Open since there is one other line to ship. When the system generates a CWEmailOut message for the shipment, the system populates the ist_ship_status attribute with Partial.

You ship line 3 on the order. When you bill the shipment, the system generates another invoice for the order and updates the status for the Order Ship To to X Closed. When the system generates a CWEmailOut message for the shipment, the system populates the ist_ship_status attribute with Final.

Example 3

An order contains three order lines. All three order lines ship; however each item on the order is flagged as a ship alone item. Because all three of the order lines have shipped, the system updates the status for the Order Ship To to X Closed.

When you bill the shipment for the first ship alone item, the system generates an invoice for the order. When the system generates a CWEmailOut message for the shipment, the system populates the ist_ship_status attribute with Partial since there are other outstanding invoices for the Order Ship To.

When you bill the shipment for the second ship alone item, the system generates an invoice for the order. When the system generates a CWEmailOut message for the shipment, the system populates the ist_ship_status attribute with Partial since there is an outstanding invoice for the Order Ship To.

When you bill the shipment for the third ship alone item, the system generates an invoice for the order. When the system generates a CWEmailOut message for the shipment, the system populates the ist_ship_status attribute with Final since there are no other outstanding invoices for the Order Ship To.

Example 4

An order contains three order lines that ship together. When you bill the shipment, the system generates one invoice for the order and updates its status to X Closed. When the system generates a CWEmailOut message for the shipment, the system populates the ist_ship_status attribute with Complete.

In order maintenance, you add two items to the order.

One of the newly added items ship. When you bill the shipment, the system generates one invoice for the order. The status for the order ship to remains O Open since there is one other line to ship.When the system generates a CWEmailOut message for the shipment, the system populates the ist_ship_status attribute with Partial.

The other newly added item ships. When you bill the shipment, the system generates one invoice for the order and updates its status to X Closed. When the system generates a CWEmailOut message for the shipment, the system populates the ist_ship_status attribute with Final.

Consolidate invoice: If you consolidate invoices for the same order on the same date (the Consolidated Invoice (B49) system control value is selected), the setting of the ist_ship_status attribute depends on when you generate shipment confirmations for the day. Example: If an order contains two ship alone items, the ist_ship_status will be Partial if you generate a shipment confirmation after you ship one of the items and will be Complete if you generate a shipment confirmation after both of the items have shipped.

For more information: See Outbound Email API.