Message

There is one Message element for each CWPickOut message.

source

alpha

25

Informational only.

target

alpha

25

Informational only.

type

alpha

25

Set to CWPickOut.

date_created

numeric

8

The date the pick slip was printed in YYYY-MM-DD format.

time_created

numeric

6

The time the pick slip was printed in HH:MM:SS format.

PickHeader

There is one PickHeader element for each CWPickOut message.

transaction_type

alpha

1

Indicates whether this is a new or reprinted pick slip or a request to void a pick slip. Valid values are:

• A = Add: New or reprinted pick slip.

• D = Delete: Voided pick slip.

company

numeric

3

The company that generated the pick slip.

From the CMP Company field in the Pick Control Header table.

pick_nbr

numeric

7

The pick control number.

From the PCH Control # field in the Pick Control Header table.

pick_status

alpha

1

The status of the pick slip. Possible statuses are:

• M = manifest submission

• V = void Note: If the status of the pick slip is void, the system sends an abbreviated CWPickOut message to the external system; see Sample CWPickOut message (Void Pick Slip).

Not included if you do not use PC manifesting.

From the PCH Pick status field in the Pick Control Header table.

nbr_labels

numeric

3

The number of labels printed on the pick slip, as specified by the # of Pick Control Labels (D47) system control value.

From the PCH # of labels field in the Pick Control Header table.

billing_batch_nbr

numeric

7

The billing batch number assigned by the system to a group of pick slips.

From the PCH Billing batch # field in the Pick Control Header table.

date_printed

numeric

8

The date the pick slip was generated in YYYY-MM-DD format.

From the PCH Date printed field in the Pick Control Header table.

time_printed

numeric

8

The time the pick slip was generated in HH:MM:SS format.

From the PCH Time printed field in the Pick Control Header table.

cart_batch_nbr

numeric

3

The cart batch number assigned to the pick slip. See Using Cart/Bin Picking for an overview.

This attribute is not included if the Bypass Creation of Pick Forms during WSPS Pick Generation (K55) system control value is selected and you generated the pick out trigger through Streamlined Pick Slip Generation (WSPS).

From the PCH Cart batch # field in the Pick Control Header table.

pick_zone1

alpha

1

The warehouse zone(s) containing items on the pick slip. See Sorting Pick Slips into Separate PDF Documents for more information on how the system uses warehouse zones when sorting pick slips.

From the PCH Pick zone 1 - PCH Pick zone 6 fields in the Pick Control Header table.

pick_zone2

alpha

1

pick_zone3

alpha

1

pick_zone4

alpha

1

pick_zone5

alpha

1

pick_zone6

alpha

1

nbr_lines

numeric

3

The total number of separate lines on the pick slip, each for one or more units of an item.

From the PCH # of lines field in the Pick Control Header table.

gen_type

alpha

1

The type of pick slip generation. Possible types are:

• R = regular

• D = drop ship

• I = bill immediately

• S = special handling

• M = master pick ticket

• N = drop ship invoice

From the PCH Generation type field in the Pick Control Header table.

po_nbr

alpha

15

The purchase order number, if any, entered at the order header.

From the PCH PO # field in the Pick Control Header table.

merch_amt

numeric

7.2

The total merchandise value of all items shipping on the pick slip, after applying any discounts or repricing. This total does not include backordered, held, or drop ship items, even if they are printed on the pick slip, because they are not included in this shipment. Also, this total does not include canceled or soldout items, items shipped separately, or items with allocation stock errors.

From the PCH Merch field in the Pick Control Header table.

freight_amt

numeric

7.2

The total freight, if any, to charge for the shipment. The Prorate Freight Charges (D39) system control value controls whether to include the total order-level freight charge on the initial shipment if there is more than one shipment for an order.

From the PCH Freight field in the Pick Control Header table.

addl_freight_amt

numeric

7.2

The total amount in the additional freight bucket, if any, for the shipment. The additional freight amount is included for every pick slip printed for the order.

From the PCH Add’l Freight field in the Pick Control Header table.

addl_charge_amt

numeric

7.2

The total additional charge amount for the order ship-to. This can be a negative amount if an additional charge code was used to add a discount to the order.

From the PCH Add’l Charges field in the Pick Control Header table.

hand_charge_amt

numeric

7.2

The total special handling charges for this shipment.

From the PCH Handling field in the Pick Control Header table.

tax_amt

numeric

7.2

The total tax amount for this pick shipment.

From the PCH Tax field in the Pick Control Header table.

gst_amt

numeric

7.2

The total Canadian GST (goods and services tax) amount, if any, for the shipment.

From the PCH GST field in the Pick Control Header table.

pst_amt

numeric

7.2

The total Canadian PST (provincial services tax) amount, if any, for the shipment.

From the PCH PST field in the Pick Control Header table.

amt_paid

numeric

11.2

The total amount prepaid against the order in prepaid pay types (payment category 1). This amount is included for each pick slip for the order.

From the PCH Amount Paid field in the Pick Control Header table.

total_order_amt

numeric

11.2

The total value of the shipment, including merchandise, freight, additional freight, handling, tax, and additional charges.

Note: If the additional charge amount represents a discount, it is subtracted from the other amounts to produce the total order amount for the shipment.

From the PCH Total Order Amount field in the Pick Control Header table.

balance_due_amt

numeric

11.2

The total amount of any refund due to the customer (positive amount) or balance due (negative amount).

From the PCH Balance Due field in the Pick Control Header table.

first_pick

alpha

1

Indicates whether this is the first pick slip for a particular order detail line. Valid values are:

• Y = This is the first pick slip for the order detail line

• N = This is not the first pick slip for the order detail line

This flag is set to N only if you have previously shipped a partial quantity of an order detail line, and are now shipping an additional quantity for that line, but not making any initial shipments for any other order lines.

Example: An order includes an order detail line with a quantity of 10. Five of the units are reserved and five are backordered. The first pick slip includes the five reserved units. Subsequently, you receive a purchase order for the item and the remaining five units are reserved. If you print a pick slip for just those five units, then this flag is set to N; however, if the pick also includes a first shipment for another order detail line, this flag is set to Y.

From the PCH First Pick field in the Pick Control Header table.

alternate_pick_nbr

alpha

30

From the PCH OCR B number field in the Pick Control Header table.

master_carton_nbr

numeric

7

If the pick slip is part of a master carton, this is the master carton pick slip number; otherwise, it is the same as the pick_nbr.

From the PCH Master Carton # field in the Pick Control Header table.

pending_invoice_nbr

numeric

7

Included only if the Generate Invoice Number at Pick Gen (H80) or Generate Invoice # at Pick Gen without Address Match (K81) system control value is selected.

From the Pending Invoice Number field in the Pick Control Header table.

master_carton_pick

alpha

1

Indicates if this is a master pick slip, which displays the sold to customer’s name and address and the order totals across all ship to customers on the order. Valid values are:

• Y = This is a master pick slip

• N = This is not a master pick slip

From the PCH Master Carton Pick field in the Pick Control Header table.

master_label_order

alpha

1

Indicates if this is part of a master label order. Valid values are:

• Y = This is a part of a master label order (either the master pick slip itself, or an included pick slip)

• N = This is not part of a master label order

From the PCH Master Label Order? field in the Pick Control Header table.

order_nbr

numeric

8

The unique number identifying the order.

From the Order # field in the Pick Control Header table.

order_shipto_nbr

numeric

3

A number identifying the shipping address on the order. Set to 1 if there is only one shipping address.

From the Ship to # field in the Pick Control Header table.

sold_to_customer_nbr

numeric

9

The sold to customer who placed the order.

From the CST Customer # field in the Pick Control Header table.

ship_to_customer_nbr

numeric

3

The ship to customer on the order. From the Ship to # field in the Pick Control Header table.

The following ship-to name and address attributes are derived from:

• an order-level shipping address, if any; otherwise,

• a permanent customer ship-to address, if any, otherwise,

• a recipient customer, if any, otherwise,

• the sold-to customer who placed the order.

See:

• Assigning an Order Shipping Address

• Using a Permanent Shipping Address in Order Entry

• Adding a Recipient Order in Order Entry

• Entering Orders

ship_to_prefix

alpha

3

The prefix of the ship to customer on the pick.

From the NAM Prefix field in the Pick Control Header table.

ship_to_fname

alpha

15

The first name of the ship to customer on the pick.

From the NAM First Name field in the Pick Control Header table.

ship_to_initial

alpha

1

The middle initial of the ship to customer on the pick.

From the NAM Initial field in the Pick Control Header table.

ship_to_lname

alpha

25

The last name of the ship to customer on the pick.

From the NAM Last Name field in the Pick Control Header table.

ship_to_suffix

alpha

3

The suffix of the ship to customer on the pick.

From the NAM Suffix field in the Pick Control Header table.

ship_to_company

alpha

30

The company name for the address of the ship to customer on the pick.

From the NAM Company name field in the Pick Control Header table.

ship_to_apt

alpha

10

The apartment for the address of the ship to customer on the pick.

From the NAM Apartment field in the Pick Control Header table.

ship_to_addr1

alpha

32

The street address of the ship to customer on the pick.

From the NAM Street Address field in the Pick Control Header table.

ship_to_addr2

alpha

32

The second address line of the ship to customer on the pick.

From the NAM Address line 2 field in the Pick Control Header table.

ship_to_addr3

alpha

32

The third address line of the ship to customer on the pick.

From the XNA Address line 3 field in the Pick Control Header table.

ship_to_addr4

alpha

32

The fourth address line of the ship to customer on the pick.

From the XNA Address line 4 field in the Pick Control Header table.

ship_to_country

alpha

3

The country code for the address of the ship to customer on the pick.

From the RPR Country field in the Pick Control Header table.

ship_to_country_name

alpha

30

The name of the country for the address of the ship to customer on the pick.

From the Description field in the Country table.

ship_to_city

alpha

25

The city for the address of the ship to customer on the pick.

From the NAM City field in the Pick Control Header table.

ship_to_state

alpha

2

The state code for the address of the ship to customer on the pick.

From the NAM State field in the Pick Control Header table.

ship_to_state_name

alpha

25

The name of the state for the address of the ship to customer on the pick.

From the Description field in the State table.

ship_to_postal_code

alpha

10

The zip code for the address of the ship to customer on the pick.

From the NAM Postal Code Scan field in the Pick Control Header table.

ship_to_delivery_code

alpha

1

Identifies the address as a business or residential address.

• B = Business address.

• R = Residential address.

• N = No distinction between business and residence.

From the NAM Delivery code field in the Pick Control Header table.

ship_to_po_box_flag

alpha

1

Indicates if the customer's delivery address is a post office box.

• Y = The address is a post office box.

• N = The address is not a post office box.

From the NAM PO Box? field in the Pick Control Header table.

ship_to_day_phone

alpha

14

The day time phone number.

From the:

• Phone field in the Customer Ship To Phone # table for CS# Phone type D, or

• Phone field in the Customer Sold To Phone # table for CS# Phone type D.

ship_to_day_ext

alpha

4

The day phone extension.

From the:

• CS# extension field in the Customer Ship To Phone # table, or

• CS# extension field in the Customer Sold To Phone # table.

ship_to_eve_phone

alpha

14

The evening phone number.

From the:

• Phone field in the Customer Ship To Phone # table for CS# Phone type E, or

• Phone field in the Customer Sold To Phone # table for CS# Phone type E.

ship_to_eve_ext

alpha

4

The evening phone extension.

From the:

• CS# extension field in the Customer Ship To Phone # table, or

• CS# extension field in the Customer Sold To Phone # table.

ship_to_fax_phone

alpha

14

The third (fax or mobile) number. The Third Phone Number Type (L53) system control value determines whether the third phone number is labeled the Fax or Mobile number on screens and reports.

From the:

• Phone field in the Customer Ship To Phone # table for CS# Phone type F, or

• Phone field in the Customer Sold To Phone # table for CS# Phone type F.

ship_to_fax_ext

alpha

4

The third (fax or mobile) phone extension.

From the:

• CS# extension field in the Customer Ship To Phone # table, or

• CS# extension field in the Customer Sold To Phone # table.

ship_to_email_address

alpha

50

The email address of the ship to customer on the pick.

From the:

• OSA Email address field in the Order Ship To Address table, or

• CSH Email address field in the Customer Ship To table, or

• Email field in the Customer Sold To table.

ship_via

numeric

2

The shipper specified at the order header. See Working with Ship Via Codes (WVIA) for more information.

From the VIA Ship via code field in the Pick Control Header table.

ship_via_desc

alpha

30

The description of the ship via.

From the VIA Shipper name field in the Ship Via table.

drop_point

numeric

3

The drop point specified for the warehouse, or for the warehouse/ship via/SCF combination if you are using zone skipping. See the Work with Ship Via Indicia Screen for an overview.

From the DPT Drop Point field in the Pick Control Header table.

indicia

alpha

20

The indicia number specified for the ship via indicia, if any. See the Work with Ship Via Indicia Screen for an overview.

From the SVI Number field in the Ship Via Indicia table.

indicia_desc

alpha

20

The first line of the indicia description if a ship via indicia applies. This is the Indicia description 1 field. See the Work with Ship Via Indicia Screen for an overview.

From the SVI Description 1 field in the Ship Via Indicia table.

whse

numeric

3

The warehouse shipping the item(s).

From the Warehouse field in the Pick Control Header table.

whse_company

numeric

3

The company associated with the warehouse. The whse_company may differ from the company if you use inventory sharing. See Inventory Sharing (A69) for an overview.

From the PCH CMP Company field in the Pick Control Header table.

HAZ_Code

numeric

2

The hazard code, if any, assigned to the item(s) on the pick slip. Included only if all the items on the pick slip have the same hazard code. See Working with Hazardous Item Codes (WHAZ) for more information.

From the HAZ Code field in the Pick Control Header table.

HAZ_Description

alpha

40

The description of the hazard code.

From the HAZ Description field in the Hazard table.

HAZ_Class

alpha

15

The Class specified for the hazard code.

From the HAZ Class field in the Hazard table.

HAZ_Label_type

alpha

15

The Label type specified for the hazard code.

From the HAZ Label type field in the Hazard table.

msg_code

alpha

2

The Pick message code, if any, specified at the Streamlined Pick Slip Generation Screen, as set up through Working with Pick Slip Messages (WPSM).

Note: The text of the message is included in the PickHeaderMsg element.

From the PSM Message code field in the Pick Control Header table.

pick_weight

numeric

7.3

The total weight of items on the pick slip, calculated based on the per-unit ship weight of the item or SKU. See Performing Initial Item Entry (MITM) for more information.

From the PHX Weight of pick field in the Pick Control Header Ext table.

pick_cube_size

numeric

11.2

The total cube size of items on the pick slip, calculated based on the per-unit cube factor of the item or SKU. See Performing Initial Item Entry (MITM) for more information.

From the PHX Cube size of pick field in the Pick Control Header Ext table.

reprint

alpha

1

Set to Y if this is a reprinted pick slip; otherwise, not included. See Reprinting and Voiding Pick Slips (WVRP or WSVP) for more information.

reprint_pick_nbr

numeric

7

The original pick slip number for a reprinted pick slip.

From the PCH Reprinted PCH Control field in the Pick Control Header table.

nbr_cartons

numeric

3

The number of cartons required for the pick slip.

From the PHX Nbr of bins field in the Pick Control Header Ext table.

van_route

alpha

4

The van route defined for the shipment. The system populates this attribute only if the ship_via on the Pick Header matches the Default Van Delivery Ship Via (L07).

From the:

• Reserve Warehouse Van Route field in the Customer Ship To table for the permanent ship to customer on the order.

• Reserve Warehouse Van Route field in the Customer Sold To table for the recipient sold to customer on the order.

• Reserve Warehouse Van Route field in the Customer Sold To table for the sold to customer on the order.

See the Work with Van Routes Screen for background.

Available in: Version 3.0 in Order Management System 2.5 or later.

van_route_name

alpha

30

The name of the van_route defined for the shipment.

From the Van Route name field in the Warehouse Van Route table.

Available in: Version 3.0 in Order Management System 2.5 or later.

van_route_seq_nbr

numeric

4

The sequence number assigned to the van_route.

From the:

• Reserve Whs Van Route seq # field in the Customer Ship To table for the permanent ship to customer on the order.

• Reserve Whs Van Route seq # field in the Customer Sold To table for the recipient sold to customer on the order.

• Reserve Whs Van Route seq # field in the Customer Sold To table for the sold to customer on the order.

Available in: Version 3.0 in Order Management System 2.5 or later.

CustomerSoldToAddress

Each CWPickOut message contains one CustomerSoldToAddress element, indicating the sold to customer on the order.

Note: The sold-to name and address information below is identical to ship-to name and address information above unless the order uses an order-level shipping address, permanent customer ship-to address, or recipient customer. See Creating and Updating Sold-to Customers (WCST) for more information.

company

numeric

3

The company code for the company where the sold to customer is located.

From the CMP Company field in the Customer Sold To table.

sold_to_customer_nbr

numeric

9

The sold to customer number.

From the CST Customer # field in the Customer Sold To table.

sold_to_alternate_id

alpha

15

The alternate ID defined for the sold to customer.

From the CST Interface cust code field in the Customer Sold To table.

sold_to_prefix

alpha

3

The prefix of the sold to customer.

From the NAM Prefix field in the Customer Sold To table.

sold_to_fname

alpha

15

The first name of the sold to customer.

From the NAM First Name field in the Customer Sold To table.

sold_to_initial

alpha

1

The middle initial of the sold to customer.

From the NAM Initial field in the Customer Sold To table.

sold_to_lname

alpha

25

The last name of the sold to customer.

From the NAM Last Name field in the Customer Sold To table.

sold_to_suffix

alpha

3

The suffix of the sold to customer.

From the NAM Suffix field in the Customer Sold To table.

sold_to_company

alpha

30

The company name for the address of the sold to customer.

From the NAM Company name field in the Customer Sold To table.

sold_to_apt

alpha

10

The apartment for the address of the sold to customer.

From the NAM Apartment field in the Customer Sold To table.

sold_to_addr1

alpha

32

The street address for the address of the sold to customer.

From the NAM Street Address field in the Customer Sold To table.

sold_to_addr2

alpha

32

The second address line for the address of the sold to customer.

From the NAM Address line 2 field in the Customer Sold To table.

sold_to_addr3

alpha

32

The third address line for the address of the sold to customer.

From the XNA Address line 3 field in the Customer Sold To table.

sold_to_addr4

alpha

32

The fourth address line for the address of the sold to customer.

From the XNA Address line 4 field in the Customer Sold To table.

sold_to_country

alpha

3

The country code for the address of the sold to customer.

From the RPR Country field in the Customer Sold To table.

sold_to_country_name

alpha

30

The name of the country.

From the Country description field in the Country table.

sold_to_city

alpha

25

The city for the address of the sold to customer.

From the NAM City field in the Customer Sold To table.

sold_to_state

alpha

2

The state code for the address of the sold to customer.

From the NAM State field in the Customer Sold To table.

sold_to_state_name

alpha

25

The name of the state.

From the STE Description field in the State table.

sold_to_postal_code

alpha

10

The zip code for the address of the sold to customer.

From the NAM Zip field in the Customer Sold To table.

sold_to_delivery_code

alpha

1

Identifies the address as a business or residential address.

• B = Business address.

• R = Residential address.

• N = No distinction between business and residence.

From the NAM Delivery code field in the Customer Sold To table.

sold_to_email_address

alpha

50

The email address for the sold to customer.

From the CST E-mail address field in the Customer Sold To table.

sold_to_email_status

alpha

2

Indicates the preferred method of correspondence for the sold to customer's primary email address.

• O1 (Email) = Email is the preferred method of correspondence.

• O2 (Order-only email) = Use email for order-related correspondence only; generate a document for other correspondence.

• O3 (No email) = Do not use email for any correspondence; generate a document instead.

• O4 (Do not ask customer) = Do not ask the customer for an email address; the customer has already been asked and has declined to provide it.

From the CST E-mail Status field in the Customer Sold To table.

sold_to_po_box_flag

alpha

1

Identifies the customer's delivery address as a post office box.

• Y = The address is a post office box.

• N = The address is not a post office box.

From the NAM PO box? field in the Customer Sold To table.

sold_to_day_phone

alpha

14

The sold to customer's day phone number.

From the Phone field in the Customer Sold To Phone # table for CS# Phone # type D.

sold_to_day_ext

alpha

4

The day phone number extension.

From the CS# extension field in the Customer Sold To Phone # table.

sold_to_eve_phone

alpha

14

The sold to customer's evening phone number.

From the Phone field in the Customer Sold To Phone # table for CS# Phone # type E.

sold_to_eve_ext

alpha

4

The evening phone number extension.

From the CS# extension field in the Customer Sold To Phone # table.

sold_to_fax_phone

alpha

14

The sold to customer's third (fax or mobile) number. The Third Phone Number Type (L53) system control value determines whether the third phone number is labeled the Fax or Mobile number on screens and reports.

From the Phone field in the Customer Sold To Phone # table for CS# Phone # type F.

sold_to_fax_ext

alpha

4

The third (fax or mobile) number extension.

From the CS# extension field in the Customer Sold To Phone # table.

CustomerBillToAddress

The bill-to customer information is included if a bill-to is assigned to the sold-to customer for the order. See Creating and Updating Bill-to Customers (WCBT) for more information.

company

numeric

3

A code for the company where the bill to customer is located.

From the CMP Company field in the Customer Bill To table.

bill_to_customer_nbr

numeric

7

The bill to customer number.

From the CBT Account # field in the Customer Bill To table.

bill_to_prefix

alpha

3

The prefix of the bill to customer.

From the NAM Prefix field in the Customer Bill To table.

bill_to_fname

alpha

15

The first name of the bill to customer.

From the NAM First Name field in the Customer Bill To table.

bill_to_initial

alpha

1

The middle initial of the bill to customer.

From the NAM Initial field in the Customer Bill To table.

bill_to_lname

alpha

25

The last name of the bill to customer.

From the NAM Last Name field in the Customer Bill To table.

bill_to_suffix

alpha

3

The suffix of the bill to customer.

From the NAM Suffix field in the Customer Bill To table.

bill_to_company

alpha

30

The company name for the address of the bill to customer.

From the NAM Company name field in the Customer Bill To table.

bill_to_apt

alpha

10

The apartment for the address of the bill to customer.

From the NAM Apartment field in the Customer Bill To table.

bill_to_addr1

alpha

32

The street address for the address of the bill to customer.

From the NAM Street Address field in the Customer Bill To table.

bill_to_addr2

alpha

32

The second address line for the address of the bill to customer.

From the NAM Address line 2 field in the Customer Bill To table.

bill_to_addr3

alpha

32

The third address line for the address of the bill to customer.

From the XNA Address line 3 field in the Customer Bill To table.

bill_to_addr4

alpha

32

The fourth address line for the address of the bill to customer.

From the XNA Address line 4 field in the Customer Bill To table.

bill_to_city

alpha

25

The city for the address of the bill to customer.

From the NAM City field in the Customer Bill To table.

bill_to_state

alpha

2

The state code for the address of the bill to customer.

From the NAM State field in the Customer Bill To table.

bill_to_state_name

alpha

25

The name of the state.

From the STE Description field in the Customer Bill To table.

bill_to_postal_code

alpha

10

The zip code for the address of the bill to customer.

From the NAM Postal Code Scan field in the Customer Bill To table.

bill_to_country

alpha

3

The country code for the address of the bill to customer.

From the RPR Country field in the Customer Bill To table.

bill_to_country_name

alpha

30

The name of the country.

From the Country description field in the Country table.

bill_to_day_phone

alpha

14

The day time phone number for the bill to customer.

From the CB# Phone field in the Customer Bill To Phone # table.

bill_to_day_ext

alpha

4

The day time phone number extension.

From the CB# Extension field in the Customer Bill To Phone # table.

bill_to_eve_phone

alpha

14

The evening phone number for the bill to customer.

From the CB# Phone field in the Customer Bill To Phone # table.

bill_to_eve_ext

alpha

4

The evening phone number extension.

From the CB# Extension field in the Customer Bill To Phone # table.

bill_to_fax_phone

alpha

14

The third (fax or mobile) number for the bill to customer. The Third Phone Number Type (L53) system control value determines whether the third phone number is labeled the Fax or Mobile number on screens and reports.

From the CB# Phone field in the Customer Bill To Phone # table.

bill_to_fax_ext

alpha

4

The third (fax or mobile) number extension.

From the CB# Extension field in the Customer Bill To Phone # table.

bill_to_email_address

alpha

50

The email address of the bill to customer.

From the CBT Email Address field in the Customer Bill To Phone # table.

bill_to_email_status

alpha

2

Indicates the preferred method of correspondence for the bill to customer's email address.

• O1 (Email) = Email is the preferred method of correspondence.

• O2 (Order-only email) = Use email for order-related correspondence only; generate a document for other correspondence.

• O3 (No email) = Do not use email for any correspondence; generate a document instead.

• O4 (Do not ask customer) = Do not ask the customer for an email address; the customer has already been asked and has declined to provide it.

From the CBT Opt In/Opt Out field in the Customer Bill To table.

bill_to_delivery_code

alpha

1

Identifies the address as a business or residential address.

• B = Business address.

• R = Residential address.

• N = No distinction between business and residence.

From the NAM delivery code in the Customer Bill To table.

bill_to_po_box_flag

alpha

1

Identifies the customer's delivery address as a post office box.

• Y = The address is a post office box.

• N = The address is not a post office box.

From the NAM PO box? in the Customer Bill To table.

OrderHeader

There is one OrderHeader element for each CWPickOut message.

See Reviewing the Order Inquiry Header Screen for background.

transaction_type

alpha

25

Not currently implemented.

company

numeric

3

The company associated with the order generating the pick slip.

From the CMP Company field in the Order Header table.

order_nbr

numeric

8

A unique number to identify the order.

From the Order # field in the Order Header table.

order_status

alpha

1

From the OHD Order status field in the Order Header table.

nbr_recipients

numeric

3

The total number of shipping addresses on the order.

From the OHD # of Recipients field in the Order Header table.

order_date

numeric

8

The date the order was placed in YYYY-MM-DD format.

From the OHD Order date field in the Order Header table.

entered_date

numeric

8

The date the order was entered in YYYY-MM-DD format.

From the OHD Entered date field in the Order Header table.

entered_time

numeric

6

The time the order was entered in HH:MM:SS format.

From the OHD Entered time field in the Order Header table.

freight_amt

numeric

7.2

From the OHD Freight charge field in the Order Header table.

freight_balance_amt

numeric

7.2

From the OHD Freight balance field in the Order Header table.

user_date

numeric

8

In YYYY-MM-DD format.

From the OHD User Defined Date field in the Order Header table.

order_channel

alpha

1

Indicates the order channel, such as retail or e-commerce. Typically populated only for orders you receive from an external source, such as the generic order API.

From the OHD Internet Order field in the Order Header table.

email_confirm_date

numeric

8

YYYY-MM-DD format. Included only when the system has generated an automatic email confirmation; see When Does the System Generate an Email Notification? for more information. The confirmation can consist of an actual email message, or it can be the Outbound Email XML Message (CWEmailOut).

From the OHD Email Confirm Date field in the Order Header table.

bill_to_customer_nbr

numeric

7

Included if a bill-to account is assigned to the sold-to customer.

From the CBT Account # field in the Order Header table.

user_hold_reason

alpha

2

From the OHD OHR User hold reason field in the Order Header table.

system_hold_reason

alpha

2

From the OHD OHR Sys hold reason field in the Order Header table.

sold_to_customer_nbr

numeric

9

A unique number to identify the sold-to customer who placed the order.

From the Customer # field in the Order Header table.

membership_id

alpha

12

The membership program that generated the order. Included only for membership orders generated through the Generating Membership Orders (EGMO) menu option.

From the MEM Membership ID field in the Order Header table.

membership_seq_nbr

numeric

3

A unique number to identify a customer membership for a single sold-to customer and membership program. This sequence number makes it possible to create multiple customer memberships in the same membership program for a customer. Included only for membership orders generated through the Generating Membership Orders (EGMO) menu option.

From the CSM Sequence # field in the Order Header table.

batch_nbr

numeric

5

A unique number to identify an order batch. Included only if the order was generated as part of a batch.

From the OBA Batch # field in the Order Header table.

order_type

alpha

1

From the Order Type table. See Establishing Order Types (WOTY) for background.

From the OTY Order type field in the Order Header table.

order_type_desc

alpha

30

The description of the order type.

From the OTY Description field in the Order Header table.

sales_rep_nbr

numeric

7

The salesrep number, if any, specified for the order. See Working with Sales Representatives (WSLS) for more information.

From the SLS Salesman # field in the Order Header table.

source

alpha

9

The source code from the order header. See Entering Orders for more information on how the source code controls the freight, discounting, currency, and other factors on an order.

From the OHD SRC Source code field in the Order Header table.

entered_by_user

alpha

10

Not currently implemented.

customer_class

alpha

2

The customer class used to identify and track a group of customers. See Setting Up the Customer Class Table (WCCL) for more information.

From the CCL Customer class field in the Order Header table.

alternate_order_id

alpha

30

The number used to identify the order in a remote system, such as CWStore. From the E-comm order number in the Order Header Extended table, displayed as the Alt ord # at the Display Order Properties Screen. Included only if this field is populated, such as through the generic order API.

From the OHE E-Comm Order Number field in the Order Header Extended table.

currency_code

alpha

3

The code identifying the currency on the order, as set up through Working with Currency (WCUR). Included only if the Multi Currency by Offer (E03) system control value is selected.

From the OHE Currency field in the Order Header Extended table.

currency_desc

alpha

30

The description of the currency, as set up through Working with Currency (WCUR).

From the CUR Currency description field in the Currency table.

currency_rate

numeric

11.7

The currency Conversion rate, as set up through Working with Currency (WCUR).

From the CUR Conversion rate field in the Currency table.

email_address

alpha

50

The order-level email address, if any. See Working with an Order-Level Email Address for more information on how the system selects this email address.

From the OHE Order Email Address field in the Order Header Extended table.

entity

numeric

3

The entity code associated with the source code on the order header. Entities are associated with a source code through the division assigned to the source code. See Working with Entities (WENT) for more information on entities.

From the ENT Entity number field in the Division table.

Available in: Version 2.0 in Order Management System 2.0 or later.

entity_description

alpha

25

The description of the entity associated with the source code on the order header.

From the ENT Description field in the Entity table.

Available in: Version 2.0 in Order Management System 2.0 or later.

OrderShipTo

While some information on an order, such as payment methods, is stored at the header level, the information in the OrderShipTo can vary for each shipping address on the order. See Reviewing the Order Inquiry Header Screen for background on the fields.

company

numeric

3

The company that generated the pick slip.

From the CMP Company field in the Order Ship To table.

order_nbr

numeric

8

The order number associated with the pick slip.

From the Order # field in the Order Ship To table.

order_shipto_nbr

numeric

3

A number identifying the shipping address on the order. Set to 1 if there is only one shipping address.

From the Ship to # field in the Order Ship To table.

shipto_status

alpha

1

From the OST Order status field in the Order Ship To table.

tax_code

alpha

1

The code indicating the order’s tax status. Valid values are:

• T = Standard tax

• N = Non taxable

• R = Resale

• E = Exempt

• G = GST only

• P = PST only

See Working with Customer Tax Status for more information.

From the OST Tax code field in the Order Ship To table.

addl_charge_amt

numeric

7.2

The total additional charges for this shipping address. If there are both positive and negative additional charges, this amount is the net.

From the OST Add’l charges field in the Order Ship To table.

addl_charge_balance_amt

numeric

7.2

The total amount of the additional charges for this shipping address that have not yet been billed.

From the OST Add’l chg balance field in the Order Ship To table.

arrival_date

numeric

8

The date the customer requested to receive the order in YYYY-MM-DD format. The order date defaults, but you can override it.

From the OST Arrival date field in the Order Ship To table.

cancel_bo

alpha

1

A code that identifies whether items that are unavailable (backordered) should be canceled automatically with the first shipment on the order.

Valid values are:

• Y = Cancel backordered items with first shipment.

• N = (default): do not cancel backordered items.

From the OST Cancel BO? field in the Order Ship To table.

cancel_date

numeric

8

The date the customer wants the order canceled if it has not been shipped, in YYYY-MM-DD format. The system stops trying to reserve merchandise for this order a predefined number of days before the cancel date. The order is not canceled automatically, but is listed on the Order Cancellation List.

From the OST Cancel date field in the Order Ship To table.

contact_name

alpha

30

The name of the person who should receive the package; your entry at the Attention field in order entry.

From the OST Contact name field in the Order Ship To table.

est_freight_amt

numeric

7.2

The Estimated freight, if any, entered at the Work with Order Ship to Properties Screen. See that screen for more information.

From the OST Estimated freight field in the Order Ship To table.

fedex_nbr

alpha

10

The Carrier #, if any, entered at the Work with Order Ship to Properties Screen. See that screen for more information.

From the OST Federal express # field in the Order Ship To table.

freight_amt

numeric

7.2

The total freight charges for this shipping address.

From the OST Freight field in the Order Ship To table.

freight_balance_amt

numeric

7.2

The unpaid freight charges for this shipping address.

From the OST Frt balance field in the Order Ship To table.

gift_order

alpha

1

A code that identifies whether the order is a gift order. If the order is a gift:

• item prices do not print on the pick slip

• the system generates a gift acknowledgment card to notify the sold-to customer who placed the order that the order has been shipped

Valid values are:

• Y = This is a gift order.

• N = This is not a gift order.

From the OST Gift order field in the Order Ship To table.

hand_charge_amt

numeric

7.2

The total special handling charges for the shipping address.

From the OST Handling field in the Order Ship To table.

hand_balance_amt

numeric

7.2

The total special handling charges for the shipping address that have not yet been billed.

From the OST Handling balance field in the Order Ship To table.

merch_amt

numeric

9.2

The total dollar value of all items for this shipping address based on the actual selling price.

From the OST Merch field in the Order Ship To table.

merch_balance_amt

numeric

9.2

The total merchandise value for the shipping address that has not yet been billed.

From the OST Merch balance field in the Order Ship To table.

resale_exemption_nbr

alpha

15

The number of the certificate that identifies the customer as a reseller or tax exempt. This number is required when the customer's tax code equals R (Reseller) or E (Exempt).

From the OST Resale/Exempt # field in the Order Ship To table.

ship_complete

alpha

1

A code that determines whether all the items on an order must ship together. Valid values are:

• Y = Ship all items on the order in one shipment; delay printing pick slips until all items are available in the requested quantities.

• N = (default): Items on the order ship as soon as they are reserved.

From the OST Ship complete? field in the Order Ship To table.

tax_amt

numeric

7.2

The total tax amount for this shipping address.

From the OST Tax field in the Order Ship To table.

tax_balance_amt

numeric

7.2

The tax amount for this shipping address that has not yet been billed.

From the OST Tax balance field in the Order Ship To table.

gst_amt

numeric

7.2

The total GST (Canadian goods and services tax) amount for this shipping address.

From the OST GST field in the Order Ship To table.

gst_balance_amt

numeric

7.2

The total GST (Canadian goods and services tax) amount for this shipping address that has not yet been billed.

From the OST GST balance field in the Order Ship To table.

pst_amt

numeric

7.2

The total PST (Canadian provincial services tax) amount for this shipping address.

From the OST PST field in the Order Ship To table.

pst_balance_amt

numeric

7.2

The total PST (Canadian provincial services tax) amount for this shipping address that has not yet been billed.

From the OST PST balance field in the Order Ship To table.

po_nbr

alpha

15

The purchase order number under which the order was placed.

From the OST Purchase order # field in the Order Ship To table.

nbr_lines

numeric

3

The total number of order detail lines for this shipping address.

From the OST # of lines field in the Order Ship To table.

addl_freight_amt

numeric

7.2

The total additional freight charges for this shipping address.

From the OST Add’l freight field in the Order Ship To table.

addl_freight_balance_amt

numeric

7.2

The total additional freight charges for this shipping address that have not yet been billed.

From the OST Add’l freight balance field in the Order Ship To table.

discount_pct

numeric

5.2

The flat discount percentage that applies to the entire order. For example, when you enter a discount percentage at the order header, or it defaults from a membership, this field is updated. Prorated discounts, such as promotions or dollar discounts by source code or offer, do not update this field.

From the OST Discount % field in the Order Ship To table.

sold_to_customer_nbr

numeric

9

The sold-to customer receiving the order. Included only if it is a different customer than the one who placed the order.

From the OST CST Customer # field in the Order Ship To table.

ship_to_customer_nbr

numeric

3

The permanent ship-to customer receiving the order. Included only if the order uses a permanent ship-to address.

From the OST CSH Ship to # field in the Order Ship To table.

hold_reason

alpha

2

From the OST OHR Hold reason field in the Order Ship To table.

whse

numeric

3

A code that identifies the warehouse from which merchandise on the order will be shipped. A value appears in this field only if it was entered by an operator during order entry or order maintenance.

From the Warehouse field in the Order Ship To table.

ship_via

numeric

2

A code for the shipper. A different ship via may also exist at the item level.

From the Ship via field in the Order Ship To table.

ship_via_desc

alpha

30

The description of the ship via, as set up through Working with Ship Via Codes (WVIA).

From the VIA Shipper name field in the Ship Via table.

line_of_business

alpha

3

The code representing the line of business, if the system has assigned one to the order. See Working with Lines of Business (WLOB) for background.

From the OST Line Of Business field in the Order Ship To table.

line_of_business_desc

alpha

40

The description of the line of business.

From the LOB Description field in the Line Of Business table.

geographic_zone

alpha

3

The geographic zone where the order is shipping, as set up through Creating and Maintaining Geographic Zones (WGZN). Included only if the Bypass Geographic Zone Searching in Order Entry/Order Maintenance (H55) system control value is unselected.

From the OST GZF Geographic Zone field in the Order Ship To table.

geographic_zone_desc

alpha

30

Not currently implemented.

The description of the geographic zone.

From the GZF description field in the Geographic Zone table.

broker_delivery_type

alpha

1

Indicates the type of an order received from or sent to the Order Broker. Possible settings are:

R = retail pickup order: a store location requests the Order Management System distribution center transfer the requested merchandise to the originating store for customer pickup

D = delivery order: a store location requests the Order Management System distribution center ship the order directly to the customer

S = ship-for-pickup: Order Management System ships the merchandise to a designated store location for customer pickup

This information is stored in the Order Ship To table, and is included only if the order is a retail pickup, delivery, or ship-for-pickup order being fulfilled through integration with the Order Broker. Orders that include items that are backordered in Order Management System and sent to the Order Broker for fulfillment (brokered backorders) do not have a broker_delivery_type. See the Order Broker Integration for a discussion.

Available in: Version 3.0 in Order Management System 2.5 or later.

destination_store

alpha

12

The store number identifying the destination for a ship-for-pickup order, as set up through Work with Store Cross Reference (WSCR) and stored in the Order Ship To Address table. Included only for ship-for-pickup orders. See the Order Broker Integration for a discussion.

Available in: Version 3.0 in Order Management System 2.5 or later.

originating_store

alpha

12

The store number identifying the store location where a retail pickup or delivery order originated, as set up through Work with Store Cross Reference (WSCR) and stored in the Order Message table. Included only for retail pickup and delivery orders received from the Order Broker. See the Order Broker Integration for a discussion.

Available in: Version 3.0 in Order Management System 2.5 or later.

locate_order_nbr

alpha

35

The number assigned by the originating system to identify a retail pickup or ship-for-pickup fulfilled through the Order Broker integration. See Order Broker Integration for background.

Retail pickup order: This is the number passed from the Order Broker in the Fulfillment Response message, and is the order number assigned by the originating system, such as Xstore. Stored as the E-comm order number in the Order Header Extended record (the Alt ord on the Display Order Properties Screen).

Ship-for-pickup order:

• If the order type does not match the Order Type for Special Orders (L15), this is the same as the Order Management System order number and ship-to number, since typically the order originated in Order Management System. Formatted as 12345-001, where 12345 is the order number and 001 is the ship-to number.

• If the order type matches the Order Type for Special Orders (L15), this is the number identifying the order in the external system, from the E-comm order number in the Order Header Extended record.

Not included? The locate_order_nbr is not included:

• for any order that is not a retail pickup or ship-for-pickup order.

• if the order type matches the Order Type for Special Orders (L15), but there is no E-comm order number.

Available in: Version 4.0 in Order Management System release 3.5 or later.

OrderPayment

The OrderPayment element and its attributes repeat for each payment method associated with the pick.

pay_type

numeric

2

The code for the pay type on the order, as set up through Working with Pay Types (WPAY). If there is more than one payment method on the order, this attribute reads MULTIPLE PAY TYPES.

From the PAY Pay type field in the Order Payment Method table.

pay_type_desc

alpha

30

The description of the pay type on the order. Included only if there is just a single payment method on the order.

From the PAY Description field in the Order Payment Method table.

pay_category

numeric

1

The category of the pay type on the order. Included only if there is just a single payment method on the order.

Possible pay categories are:

• 1 = Cash/Check

• 2 = Credit Card (including stored value card and debit card)

From the OPM Pay Category field in the Order Payment Method table.

PickHeaderMsg

Pick slip header messages include:

• Order header messages entered through the Work with Order Messages Screen and flagged with a code of P (print on the pick slip), G (gift), or B (print on both the pick slip and the invoice) are included in this element.

• Pick slip messages in the Pick message code/text field for a pick slip generation template. See the msg_code for more information.

Only messages for the ship-to related to the pick slip are included.

seq_nbr

numeric

3

A unique number to identify the pick slip message or order header message. Each message type is numbered separately.

msg_type

alpha

2

Indicates whether this is an order header message or pick slip message. Valid values are:

• OH = order header message

• PM = pick slip message

msg

alpha

60 (order) or 120 (pick)

The text of the order header or pick slip message.

Note: No msg attribute is included for an order header message if you set the Print flag at the Work with Order Messages Screen without entering any text.

PickDetail

Which items included? There is a PickDetail element for each order line available to print on the current pick contained in this CWPickOut message. This element includes:

• items to print on the pick.

• items on backorder.

• items that are held; these items are included as backordered on the pick.

• items that have future arrival dates; these items are included as backordered on the pick.

• soldout items if the Soldout notifications field for the order type on the order is selected. The system includes soldout items only on the first CWPickOut message generated for an order.

• drop ship items if a drop ship pick slip or purchase order has not yet been generated; these items are included as backordered on the pick. If the Add Printed Drop Ship Lines as Backordered on Pick (E93) system control value is selected the system also includes drop ship items that have printed on a drop ship pick slip or purchase order; otherwise, these drop ship items are included in the OtherDetail element.

• the main set item and each of its component items.

The system does not include a PickLocation element for any item that does not have a printed quantity.

This element does not include:

• open order lines to print on a separate pick; these items are included in the OtherDetail element. For example, if you generate picks for an order and the order splits into two separate picks, the items that print on the other pick are included in the OtherDetail element.

• canceled items.

• soldout items if the Soldout notifications field for the order type on the order is unselected.

• shipped (closed) items.

Drop ship picks: When generating a CWPickOut message for a drop ship pick slip, there is a separate PickDetail element for each drop ship item included on the pick. Items to print on a separate pick, that are on backorder, that are held, or that have a future arrival date are included in the OtherDetail element.

See the Display Pick Control Details Screen for more information.

company

numeric

3

The company that generated the pick slip.

From the CMP Company field in the Pick Control Detail table.

pick_nbr

numeric

7

The pick control number that identifies the pick slip.

From the PCH Control # field in the Pick Control Detail table.

pick_line_nbr

numeric

5

A unique number to identify the pick slip line number for the item.

From the PCD Line # field in the Pick Control Detail table.

bo_control

alpha

1

Specifies what action should be taken for this line. Set to C (Ship and cancel remainder) only if the Auto-cancel backorder flag was selected in order entry. Otherwise, the system ship any available quantity and puts the remainder on backorder.

From the PCD Backorder control field in the Pick Control Detail table.

original_qty_printed

numeric

5

The quantity available to ship on this pick slip. Included only if the item is available to ship (that is, not backordered, held, a future order, or a drop ship item). Included for both the set component and the set master for set items.

From the PCD Original qty printed field in the Pick Control Detail table.

qty_printed

numeric

5

The same as the original quantity printed.

From the PCD Qty printed field in the Pick Control Detail table.

cart_bin_nbr

numeric

3

The cart bin number assigned to the item on the pick.

Included only for items with a printed quantity.

This attribute is not included if the Bypass Creation of Pick Forms during WSPS Pick Generation (K55) system control value is selected and you generated the pick out trigger through Streamlined Pick Slip Generation (WSPS).

From the PCD Cart bin # field in the Pick Control Detail table.

line_status

alpha

1

A status of H indicates that the order line is held. Other statuses are not currently implemented.

From the PCD Line status field in the Pick Control Detail table.

affect_inventory

alpha

1

Indicates whether shipping this item affects the inventory count. For example, the main set item does not affect inventory, but the set components do. Valid values are:

• Y = Affect inventory

• N = Does not affect inventory

Not included for items without a printed quantity (held, backordered, drop ship, or future arrival date).

From the PCD Affect Inventory field in the Pick Control Detail table.

selling_price

numeric

7.2

The single-unit selling price of the item after applying any repricing or discounts. Not included for set component items, items flagged as “no charge,” or items without a printed quantity.

From the PCD Price field in the Pick Control Detail table.

selling_price_extended

numeric

11.2

The selling price times the printed quantity. Not included unless both of these values exist.

From the PCD Extension field in the Pick Control Detail table.

freight_amt

numeric

7.2

The freight charge for this item on this pick slip. Included only if there is a printed quantity and the source code uses an item-level freight method; see Working with Source Codes (WSRC) for more information.

From the PCD Freight Charge field in the Pick Control Detail table.

hand_charge_amt

numeric

7.2

The total special handling charges for the item. Included only if there is a printed quantity.

From the PCD Spec Handling $ field in the Pick Control Detail table.

gift_charge_amt

numeric

7.2

The total giftwrap charge. Included only if there is a printed quantity.

From the PCD Gift Charge field in the Pick Control Detail table.

qty_ordered

numeric

5

The original quantity ordered for the order detail line. Always included.

From the PCD Qty Ordered field in the Pick Control Detail table.

qty_bo

numeric

5

Included for backordered, held, drop ship, and future arrival items.

From the PCD Qty Backordered field in the Pick Control Detail table.

tax_amt

numeric

10.5

The tax amount for the item on this pick slip. Included only if there is a selling price included.

If a tax override amount is defined for the order line and you process multiple shipments against the line, the system prorates the tax override amount across the units shipped on the order line to determine the new tax override amount and the tax amount to apply to each shipment. Example: If the tax override amount for the order line is 9.00 and the order quantity is 3, the system charges 3.00 if you ship 1 unit of the item and then charges 6.00 if you ship the remaining 2 units of the item.

From the PCD Tax field in the Pick Control Detail table.

gst_amt

numeric

10.5

The total Canadian GST (goods and services tax) amount, if any, for the item on this pick slip. Included only if there is a selling price included.

From the PCD GST field in the Pick Control Detail table.

pst_amt

numeric

10.5

The total Canadian PST (provincial services tax) amount, if any, for the item on this pick slip. Included only if there is a selling price included.

From the PCD PST field in the Pick Control Detail table.

order_nbr

numeric

8

A unique number to identify the order. Always included.

From the Order # field in the Pick Control Detail table.

order_shipto_nbr

numeric

3

Identifies the shipping address on the order. Always included.

From the Ship to # field in the Pick Control Detail table.

order_detail_nbr

numeric

5

Identifies the order line sequence number, which may be different from the pick slip line number. Always included.

From the Seq # field in the Pick Control Detail table.

item

alpha

12

A unique code to identify the item. Always included.

From the ITM Number field in the Pick Control Detail table.

item_desc

alpha

40

The description of the item. Always included.

From the Description field in the Item table.

sku

alpha

14

The item’s unique characteristics, such as its color and size. Always included if the item has SKUs.

Note: If the SKU does not use all three SKU elements, the system does not include the blank space for the SKU elements that are not used. For example, if the SKU is BLUE SMLL, it is passed as sku="BLUE SMLL" and not sku="BLUE SMLL ".

From the SKU Code field in the Pick Control Detail table.

sku_desc

alpha

40

The description of the SKU. Always included if the item has SKUs.

From the Description field in the SKU table.

addl_charge_code

alpha

2

The additional charge code related to special handling, if any. Always included if the item has special handling.

From the ADD Add’l chg code field in the Pick Control Detail table.

addl_charge_desc

alpha

30

Not currently implemented.

The description of the additional charge code, if any. Always included if the item has special handling.

From the ADD Description field in the Additional Charge table.

locate_line_nbr

numeric

5

Retail pickup or delivery order: The requesting system line number from the originating location and system, from the requesting_system_line_no passed in the fulfillment response message. See Building the Retail Pickup (including Ship-for-Pickup) or Delivery Order for more information.

Ship-for-pickup order:

• If the Create Separate Picks for Ship for Pickup Orders (L89) system control value is selected and the item ships from a warehouse, the locate_line_nbr is the Order Detail sequence number (typically the same as the line number unless a line has been deleted in order entry) concatenated with the zero-filled shipping warehouse number. For example, for line 2 shipping from warehouse 1, the line item number passed to Order Broker is 2001.

• Otherwise, if the Create Separate Picks for Ship for Pickup Orders (L89) system control value is not selected or if this is a CWPickOut message generated for a drop ship item, the locate_line_nbr is set to the Order Detail sequence number.

Not included for any other type of order. See the Order Broker Integration for background.

Available in: Version 4.0 in Order Management System release 3.5 or later.

broker_request_id

numeric

30

A unique number assigned by the Order Broker to identify the order in Order Broker. Included only for a retail pickup, delivery, or ship-for-pickup order, and only for an item that is actually printed on the current pick slip; for example, not included for a backordered or drop ship item. Not included for any other type of order. See the Order Broker Integration for background.

Numeric? Although the field in the Order Broker table is alphanumeric, Order Broker passes a numeric request ID, so this is always a numeric value.

Available in: Version 4.0 in Order Management System release 3.5 or later.

PickLocation

This element is included only if there is a printed quantity for the item. See the Display Pick Locations Screen for more information.

company

numeric

3

The company that generated the pick slip.

From the CMP Company field in the Pick Location table.

pick_nbr

numeric

7

The pick control number that identifies the pick slip.

From the PCH Control # field in the Pick Location table.

pick_line_nbr

numeric

5

A unique number to identify the pick slip line number for the item.

From the PCD Line # field in the Pick Location table.

whse

numeric

3

The warehouse shipping the items.

From the Warehouse field in the Pick Location table.

whse_company

numeric

3

The company associated with the warehouse shipping the item. May be different from the company associated with the order and pick slip if you use inventory sharing; see Inventory Sharing (A69) for background.

From the PDL CMP Company field in the Pick Location table.

whse_zone

alpha

1

The warehouse zone containing the item. See Sorting Pick Slips into Separate PDF Documents for more information on how the system uses warehouse zones when sorting pick slips.

From the PDL Zone field in the Pick Location table.

whse_location

alpha

7

The location in the warehouse where the item should be picked.

From the Location field in the Pick Location table.

qty_allocated

numeric

5

The same as the printed quantity.

From the PDL Qty allocated field in the Pick Location table.

OrderDetail

Note: This element is always included for every pick detail line. See Reviewing Order Inquiry Detail Information for more information.

company

numeric

3

The company where the order was placed.

From the CMP Company field in the Order Detail table.

order_nbr

numeric

8

The order number.

From the Order # field in the Order Detail table.

order_shipto_nbr

numeric

3

The order ship to number.

From the Ship to # field in the Order Detail table.

order_detail_nbr

numeric

5

The order detail line sequence number.

From the Seq # field in the Order Detail table.

drop_ship

alpha

1

Indicates if the item on the order line is a drop ship item.

• Y = The item is a drop ship item.

• N = The item is not a drop ship item.

From the ODT drop ship flag field in the Order Detail table.

discount_applied

alpha

1

Indicates if a discount was applied against the order line.

• Y = A discount was applied against the order line.

• N = A discount was not applied against the order line.

From the Discount applied field in the Order Detail table.

line_status

alpha

1

The status of the order line.

• blank = Open.

• C = Cancelled.

• H = Held.

• S = Suspended.

• X = Closed.

From the ODT line status field in the Order Detail table.

no_charge

alpha

1

Not currently implemented.

From the ODT No charge field in the Order Detail table.

affect_inventory

alpha

1

Controls whether the system reserves the item on the order line and reduces inventory after shipment.

• Y = Reserve the item and reduce inventory.

• N = Do not affect inventory.

From the ODT affect inventory field in the Order Detail table.

arrival_date

numeric

8

The date the customer requested delivery of the item, in YYYY-MM-DD format.

From the ODT arrival date field in the Order Detail table.

bo_level

numeric

2

A number that controls the priority of order fulfillment on a backordered item.

From the ODT BO level field in the Order Detail table.

cancel_date

numeric

8

The last date on which the customer will accept receipt of the item, in YYYY-MM-DD format.

From the ODT cancel date field in the Order Detail table.

coordinate_group

numeric

3

A number assigned to 2 or more order lines to ensure that they ship together.

From the ODT coordinate group field in the Order Detail table.

date_printed

numeric

8

The date on which a pick slip for the order line was printed, in YYYY-MM-DD format.

From the ODT date printed field in the Order Detail table.

date_reserved

numeric

8

The date when units on the order line were reserved, in YYYY-MM-DD format.

From the ODT date reserved field in the Order Detail table.

discount_amt

numeric

5.2

The amount of the discount applied to the item.

From the ODT discount field in the Order Detail table.

expected_ship_date

numeric

8

For backordered items, this is the date a purchase order containing the backordered item is expected, in YYYY-MM-DD format.

From the ODT expected ship date field in the Order Detail table.

freight_amt

numeric

7.2

The charge for shipping the item.

From the ODT freight charge field in the Order Detail table.

future_order

alpha

1

Not currently implemented.

From the ODT Future order field in the Order Detail table.

original_price

numeric

7.2

The offer price of the item before any discount is applied.

From the ODT original price field in the Order Detail table.

selling_price

numeric

7.2

The price the customer is charged for a single unit of the item.

From the ODT price field in the Order Detail table.

qty_cancelled

numeric

5

The number of units on the order line that have been cancelled.

From the ODT qty cancelled field in the Order Detail table.

qty_ordered

numeric

5

The number of units ordered on the order line.

From the ODT qty ordered field in the Order Detail table.

qty_printed

numeric

5

The number of units on the order line for which pick slips have been printed.

From the ODT qty printed field in the Order Detail table.

qty_reserved

numeric

5

The number of units on the order line for which stock has been reserved.

From the ODT qty reserved field in the Order Detail table.

qty_shipped

numeric

5

The number of units on the order line that have shipped.

From the ODT qty shipped field in the Order Detail table.

qty_soldout

numeric

5

The number of units on the order line that are sold out and are no longer available to ship.

From the ODT qty sold out field in the Order Detail table.

qty_returned

numeric

5

The number of units on the order line that the customer has returned.

From the ODT qty returned field in the Order Detail table.

hand_charge_amt

numeric

7.2

The charge for special handling the item.

From the ODT special handling $ field in the Order Detail table.

tax_amt

numeric

10.5

Sales tax charged for the item on the order line; this is the extended tax amount.

From the ODT tax field in the Order Detail table.

gst_amt

numeric

10.5

The Canadian Goods and Services tax for the order line.

From the ODT GST field in the Order Detail table.

pst_amt

numeric

10.5

The Provincial Services tax for the order line.

From the ODT PST field in the Order Detail table.

time_reserved

numeric

6

The time the item on the order line was reserved in HH:MM:SS format.

From the ODT time reserved field in the Order Detail table.

units_confirmed

numeric

5

The number of units on the order line that have been confirmed for shipment.

From the ODT units confirmed field in the Order Detail table.

gift_wrap

alpha

1

Indicates whether the item is gift wrapped.

• Y = Gift wrap the item.

• N = Do not gift wrap the item.

From the Gift wrap field in the Order Detail table.

cost_override_amt

numeric

11.4

The override to the item's cost from order entry or maintenance.

From the Cost override field in the Order Detail table.

date_entered

numeric

8

The date on which the order line was entered, in YYYY-MM-DD format.

From the Entered date field in the Order Detail table.

time_entered

numeric

6

The time on which the order line was entered, in HH:MM:SS format.

From the Entered time field in the Order Detail table.

priority

numeric

1

A number that controls the priority of order fulfillment on a backordered item. Priority codes range from 0 - 9, where 0 is the lowest priority and 9 is the highest priority.

From the Priority field in the Order Detail table.

bo_reason

alpha

1

A code that represents the reason the item is on backorder.

• blank = The item is not backordered.

• D = The item is a drop ship item that is not kept in inventory.

• F = The item is a future order.

• R = Item/Warehouse reservation freeze.

• I = No Item/Warehouse record.

• W = No warehouse specified.

• N = Non-allocatable warehouse.

• O = Not enough inventory available to fulfill the entire order quantity.

• S = Not selected batch reservation.

• B = Reservation bypassed.

• L = SKU reserve limit exceeded.

• U = Interactive unreserve.

• Z = Zoned reservation.

From the Backorder reason field in the Order Detail table.

freight_override

alpha

1

Indicates if the freight was overridden for the order line.

• Y = The freight was overridden for the order line.

• N = The fright was not overridden for the order line.

From the Freight override field in the Order Detail table.

addl_freight_amt

numeric

7.2

The additional freight charges for the order line.

From the Freight additional field in the Order Detail table.

offer_price

numeric

7.2

The offer price of the item on the order line before any discount is applied.

From the Offer price in the Order Detail table.

price_method

alpha

1

The method the system used to calculate the price of an item, but before applying an order-level discount.

• 1 = Coupon item price

• 2 = Customer discount%

• 3 = Contract price

• 4 = Special source price

• 5 = Column price

• 6 = Quantity break price

• C = Item cost

• D = Regular plus reprice

• E = Price codes

• I = Repriced (quantity break by item)

• N = No charge/cost tracking

• O = No charge/no cost tracking

• P = Regular hierarchy

• Q = Repriced (quantity break by offer)

• R = Price override

• V = Volume discount

From the Price method field in the Order Detail table.

unit_freight_charge

numeric

7.2

The amount of freight charged for each unit of the item on the order line.

From the ODT freight unit charge field in the Order Detail table.

set_main_item

alpha

1

Indicates if the item on the order line is a set master item.

• Y = The item is a set master item.

• N = The item is not a set master item.

From the Set main item field in the Order Detail table.

set_seq_nbr

numeric

3

The sequence number assigned to a set item, allowing you to group all components of a set.

From the Set seq # field in the Order Detail table.

qty_credited

numeric

5

The number of returned units on the order line for which a credit was issued.

From the Qty credited field in the Order Detail table.

alias

alpha

12

A code used as an additional way to identify the item on the order line.

From the Alias field in the Order Detail table.

prediscount_amt

numeric

7.2

The price of the item before any discounts were applied.

From the ODT pre-discount field in the Order Detail table.

duty_amt

numeric

7.2

The amount of duty charged for the item.

From the ODT duty field in the Order Detail table.

sub_set

alpha

1

From the ODT sub set? field in the Order Detail table.

sub_set_seq_nbr

numeric

3

From the ODT sub set sequence # field in the Order Detail table.

warranty_item

alpha

1

Indicates if the item on the order line is a warranty item.

• Y = The item is a warranty item.

• N = The item is not a warranty item.

From the ODT warranty item? field in the Order Detail table.

needed_by_date

numeric

8

In YYYY-MM-DD format.

From the ODT need by date field in the Order Detail table.

tax_override

alpha

1

If this flag is Y, the order was received from an external system and a tax, GST, or PST amount was defined, indicating the tax amount from the external system should be retained on the order line.

From the ODT future use Y/N 1 field in the Order Detail table.

sh_exclude_tax

alpha

1

Not currently implemented.

Indicates if special handling charges were excluded from tax.

From the ODT future use Y/N 2 field in the Order Detail table.

addl_charge_code

alpha

2

The code that represents the type of special handling that applies to the item.

From the ADD add'l chg code field in the Order Detail table.

addl_charge_desc

alpha

30

Not currently implemented.

A description of the additional charge.

From the ADD Description field in the Additional Charge table.

item

alpha

12

The code for the item on the order line.

From the ITM number field in the Order Detail table.

item_desc

alpha

40

The description of the item.

From the Description field in the Item table.

sku

alpha

14

A code for the SKU, such as color, size, or style, of the item.

From the SKU code field in the Order Detail table.

Note: If the SKU does not use all three SKU elements, the system does not include the blank space for the SKU elements that are not used. For example, if the SKU is BLUE SMLL, it is passed as sku="BLUE SMLL" and not sku="BLUE SMLL ".

sku_desc

alpha

40

The description of the SKU, if this is a SKUed item.

From the Description field in the SKU table.

whse

numeric

3

A code for the warehouse in which the item was reserved.

From the ODT WHS warehouse field in the Order Detail table.

cancel_reason

numeric

2

A code indicating the reason the order line was cancelled.

From the CNR cancel reason code field in the Order Detail table.

cancel_reason_desc

alpha

30

A description of the cancel reason.

From the CNR Description field in the Cancel Reason table.

offer

alpha

3

The offer code assigned to the order line.

From the Offer number field in the Order Detail table.

ship_via

numeric

2

Not currently implemented.

From the ODT VIA Ship via code field in the Order Detail table.

ship_via_desc

alpha

30

Not currently implemented.

From the VIA Shipper name field in the Ship Via table.

source

alpha

9

A code that identifies the source code assigned to the order line.

From the ODT SRC source code field in the Order Detail table.

price_override_code

alpha

1

A code that represents the reason for overriding the item price or giving the item to the customer at no charge.

From the POR price override code field in the Order Detail table.

price_override_desc

alpha

30

A description of the price override.

From the POR Description field in the Price Override Reason table.

bo_whse

numeric

3

A code that identifies the warehouse from which a backordered item will be shipped.

From the ODT B/O warehouse field in the Order Detail table.

add_on_code

numeric

3

This field is not currently implemented.

From the ODT AOC add-on code field in the Order Detail table.

add_on_desc

alpha

40

Not currently implemented.

Item

Note: This element is always included for every pick detail line. See Performing Initial Item Entry (MITM) for more information.

Transaction_type

Not currently implemented.

Company

numeric

3

A code for the company where the item is located.

From the CMP Company field in the Item table.

Item_Number

alpha

12

The item number on the pick.

From the Item number field in the Item table.

Allow_SKUs

alpha

1

Indicates whether the item contains SKUs.

• Y = The item contains SKUs.

• N = The item does not contain SKUs.

From the Allow SKUs field in the Item table.

Item_average_cost

numeric

11.4

The average cost of the item.

From the Average cost field in the Item table.

ITM_Cubing_value

numeric

7.1

The cubic volume of the item, indicating the number of units of the item that can fit into a carton.

From the Cub val field in the Item table.

Drop_ship_item

alpha

1

Indicates whether you ship the item from your warehouse, or have your vendor ship it to the customer directly.

• Y (drop ship) = When a customer orders the item, you order the item from your vendor and the vendor ships it directly to your customer.

• N or blank (non-drop ship) = You ship the item from your warehouse.

From the Drop ship field in the Item table.

FIFO_cost

numeric

11.4

The FIFO cost of the item.

From the FIFO cost field in the Item table.

Item_height

numeric

3

The height measurement for the item. The Height, Length, and Width values are used to determine the cubic volume of the item.

From the Height field in the Item table.

Kit_type

alpha

1

Defines the type of kit or set functionality for the item.

• S = Set item

• F = Finished good item

• V = Variable set item

From the Kit type field in the Item table.

Item_length

numeric

3

The length measurement for the item. The Height, Length, and Width values are used to determine the cubic volume of the item.

From the Length field in the Item table.

Long_SKU_style

alpha

20

A user-defined field you can use to further identify the item.

From the Long SKU style field in the Item table.

Long_SKU_vendor

alpha

7

A user-defined field you can use to further identify the item.

From the Long SKU vendor field in the Item table.

Lot_Nbr_tracking

alpha

1

Not currently implemented.

Indicates if you track the item using a lot number.

• Y = You track the item by lot number.

• N or blank = You do not track the item by lot number.

From the Lot # tracking field in the Item table.

Non-inventory

alpha

1

Indicates whether inventory levels are maintained for the item.

• Y = The item is a non-inventory item.

• N or blank = The item is a regular item whose inventory levels are maintained.

From the Non-inventory field in the Item table.

Partial_units

alpha

1

From the Partial units field in the Item table.

Pieces_per_case

numeric

5

Determines the number of units that fit in a case.

From the Pieces per case field in the Item table.

Selling_qty

numeric

5

The required order quantity (or multiple of) for the item.

From the Selling qty field in the Item table.

Selling_weight

numeric

7.3

The selling weight of the item, used to calculate the freight charge on an item when the freight method on the order is Freight by weight or Freight by order weight.

From the Selling weight field in the Item table.

Ship_alone

alpha

1

Indicates how to ship the item.

• S = The item must ship by itself, and each unit prints on its own pick slip.

• blank = The item can ship with other items that are not flagged to ship alone.

From the Ship alone field in the Item table.

Ship_weight

numeric

7.3

The actual shipping weight of the item.

From the Ship weight field in the Item table.

Standard_cost

numeric

11.4

The standard cost of the item.

From the Standard cost field in the Item table.

User_field_1

alpha

10

A user-defined field for the item.

From the User field 1 field in the Item table.

User_field_2

alpha

10

A user-defined field for the item.

From the User field 2 field in the Item table.

User_field_3

alpha

10

A user-defined field for the item.

From the User field 3 field in the Item table.

User_field_4

alpha

10

A user-defined field for the item.

From the User field 4 field in the Item table.

Width

numeric

3

The width measurement for the item. The Height, Length, and Width values are used to determine the cubic volume of the item.

From the Width field in the Item table.

Expiration_limit

numeric

5

From the Expiration limit field in the Item table.

FIFO_Tracking

alpha

1

Indicates if the item cost is tracked using FIFO costing.

• Y = The item cost is tracked using FIFO costing.

• N = The item cost is not tracked using FIFO costing.

From the FIFO tracking field in the Item table.

ITM_Allow_Pct_discount

alpha

1

Determines whether the item is eligible for a discount percent during order entry.

• Y = The item is eligible for a percent discount.

• N = The item is not eligible for a percent discount.

From the Allow % discount? field in the Item table.

CasePiece

alpha

1

From the C/P field in the Item table.

ITM_Oversize_flag

alpha

1

Determines whether the item is considered an oversized item.

• Y = The item is oversized.

• N or blank = The item is not oversized.

From the Oversize field in the Item table.

ITM_Description

alpha

40

A description of the item.

From the Description field in the Item table.

ITM_Required_truck_item

alpha

1

Indicates if the item is a required truck item (when the item is ordered, the system uses the truck ship via as an override on the order line).

• Y = The item is a required truck item.

• N or blank = The item is not a required truck item.

From the Required truck item field in the Item table.

ITM_Second_Language_Desc

alpha

40

The second language description defined for the item.

From the Second language desc field in the Item table.

ITM_Exclude_From_Flex_Pay

alpha

1

Determines whether the item is excluded from deferred and installment payment plans.

• Y = Exclude the item from deferred and installment payment plans.

• N or blank = Do not exclude the item from deferred and installment payment plans.

From the Exclude from flex pay field in the Item table.

ITM_Royalty

alpha

1

Indicates whether sales of the item require royalty payments to an author or owner.

• Y = This is a royalty item.

• N = This is not a royalty item.

From the Royalty field in the Item table.

ITM_Membership

alpha

1

Indicates the item represents a membership program, which you can use to generate periodic orders to a customer.

• Y = This is a membership item.

• N or blank = This is not a membership item.

From the Membership field in the Item table.

ITM_Generic_Ecommerce

alpha

20

From the Generic ecommerce field in the Item table.

ITM_Last_Ecomm_Info_Chg

numeric

8

The date the item was last changed for e-commerce, in YYYY-MM-DD format.

From the Last ecomm info chg field in the Item table.

ITM_Qty_Threshold

numeric

9

Indicates when to trigger an automatic download of item availability information to the e-commerce staging tables; from there, the information is available to the web storefront.

From the Qty threshold field in the Item table.

ITM_Create_Date

numeric

8

The date the item was created in YYYY-MM-DD format.

From the Create date field in the Item table.

ITM_Retail_Style_Nbr

alpha

20

A user-defined code used to identify the item.

From the Retail style # field in the Item table.

Buyer

alpha

3

A code that represents a person who is authorized to make purchases for your company.

From the Buyer field in the Item table.

Buyer_Name

alpha

30

The name of the buyer.

From the Name field in the Item table.

CTN_ID_Nbr

numeric

2

The type of carton in which the item must be shipped.

From the CTN ID # field in the Item table.

HAZ_Code

numeric

2

A code used to categorize the item as a hazardous material that requires special storage and handling.

From the Code field in the Item table.

HAZ_Description

alpha

40

A description of the hazard code.

From the Description field in the Hazard table.

HAZ_Class

alpha

15

A class of hazardous materials such as flammable or radioactive.

From the Class field in the Hazard table.

HAZ_Label_type

alpha

15

The type of label that should be produced for the type of hazardous material. The label identifies the hazardous item as flammable or radioactive to warehouse personnel or shippers.

From the Label type field in the Hazard table.

Item_class

alpha

3

A code that identifies a group of items.

From the Item class field in the Item table.

ICL_Description

alpha

30

A description of the item class.

From the Item class description field in the Item Class table.

ICL_Commission_Pct

numeric

5.2

A percentage used to calculate commissions for sales representatives selling the class of items.

From the Comm % field in the Item Class table.

ICL_Estimated_Frt

numeric

7.2

Your “best guess” on the vendor's freight charges for items in the item class. This unit amount is added to an item's cost to represent the estimated freight charges.

From the Estimated frt field in the Item Class table.

ICL_Estimated_Frt_Pct

numeric

5.2

Your “best guess” on the vendor's freight charges for items in the item class. This percentage amount is added to an item's cost to represent the estimated freight charges.

From the Estimated frt % field in the Item Class table.

ICL_Desired_GM_Pct

numeric

5.2

The percentage margin % of the item's price that should exceed the cost of the item, so that the selling price of the item results in a profitable outcome.

From the Desired G/M % field in the Item Class table.

ICL_Vat_Exempt

alpha

1

Indicates whether the item class is exempt from VAT.

• Y = The item class is exempt from VAT.

• N or blank= The item class is not exempt from VAT.

From the VAT exempt? field in the Item Class table.

ICL_Hidden_Tax_Amount

numeric

11.2

The amount to include in the Hidden tax field for an item class subject to VAT. On orders subject to VAT and tax-inclusive pricing, tax does not accumulate in the Tax bucket for the order; instead, you charge a tax-inclusive price for items, and the tax is “hidden” on the order detail line.

From the Hidden tax amount field in the Item Class table.

ICL_Qty_Threshold

numeric

5

Indicates when to trigger an automatic download of item availability information to the e-commerce staging tables for the item class; from there, the information is available to the web storefront.

From the Qty threshold field in the Item Class table.

ICL_Hidden_Tax_Pct

numeric

5.2

The percent to include in the Hidden tax field for an item class subject to VAT. On orders subject to VAT and tax-inclusive pricing, tax does not accumulate in the Tax bucket for the order; instead, you charge a tax-inclusive price for items, and the tax is “hidden” on the order detail line.

From the Hidden tax % field in the Item Class table.

SKU_group

numeric

3

A code that represents a group of common characteristics of a SKUed item.

From the SKU group field in the Item table.

SKU_group_description

alpha

30

A description of a SKU group.

From the Description field in the Item SKU Group table.

Item_status

alpha

1

A code that represents an item's status, such as discontinued or active.

From the STS field in the Item table.

Item_status_description

alpha

30

A description of the item status.

From the Description field in the Item Status table.

IST_Message_line_1

alpha

50

A message displayed in order entry and maintenance for items with this status code.

From the IST message line 1 field in the Item Status table.

IST_Message_line_2

alpha

50

A message displayed in order entry and maintenance for items with this status code.

From the IST message line 2 field in the Item Status table.

IST_Return_disposition

alpha

2

A code that identifies how the returned merchandise will be handled (whether the return updates inventory).

From the IST return disposition field in the Item Status table.

LCL_Location_class

alpha

2

A code that represents a location type, such as caged area.

From the LCL location class field in the Item table.

LCL_Description

alpha

30

A description of the location class.

From the Description field in the Location Class table.

Long_SKU_class

numeric

4

A code used to group items into long SKU classes for reporting purposes.

From the Class field in the Item table.

LSC_Description

alpha

30

A description of the long SKU class.

From the Description field in the Long SKU Class table.

LSD_Department

numeric

4

A code used to group items into long SKU departments for reporting purposes.

From the Department field in the Item table.

LSD_Description

alpha

30

A description of the long SKU department.

From the Description field in the Long SKU Department table.

LSD_Long_Sku_Division

alpha

3

The division associated with the long SKU department.

From the LSD long SKU division field in the Long SKU Department table.

Long_SKU_Div_Description

alpha

30

A description of the long SKU division.

From the Description field in the Long SKU Division table.

Unit_of_measure

alpha

3

The unit of measure defined for the item, for example each or case of 12.

From the UOM field in the Item table.

UOM_Description

alpha

30

A description of the unit of measure.

From the UOM description field in the Unit of Measure table.

UOM_Units

numeric

5

The number of units represented by the unit of measure, such as 12 units in a case.

From the UOM units field in the Unit of Measure table.

Vendor_Nbr

numeric

7

A code that identifies the vendor, or supplier, of the item.

From the Vendor # field in the Item table.

VIA_Ship_via_code

numeric

2

A code that represents the carrier to use when shipping the item.

From the VIA ship via code field in the Item table.

VIA_Shipper_name

alpha

30

The name of the carrier used to ship the item.

From the VIA shipper name field in the Ship Via table.

Warehouse

numeric

3

A code that represents the primary warehouse where you keep the item.

From the Whs field in the Item table.

Warehouse_name

alpha

30

The name of the primary warehouse.

From the Name field in the Warehouse table.

Manufacturer_Vendor

numeric

7

The vendor who manufactured the item.

From the Manufacturer vendor VND V field in the Item table.

ITM_ENT_Entity_Number

numeric

3

The entity, or business unit, associated with the item.

From the ITM ENT entity number field in the Item table.

ENT_Description

alpha

30

A description of the entity.

From the ENT description field in the Entity table.

ITM_SEA_Season

alpha

3

The season associated with the item, such as spring.

From the ITM SEA season field in the Item table.

SEA_description

alpha

30

A description of the season.

From the Description field in the Season table.

SEA_Start_date

numeric

8

The date that indicates the beginning of the season, in YYYY-MM-DD format.

From the SEA start date field in the Season table.

SEA_End_date

numeric

8

The date that indicates the end of the season, in YYYY-MM-DD format.

From the SEA end date field in the Season table.

ITM_SVC_Type

alpha

1

A code that indicates the item is a stored value card, and whether the stored value card is a physical or virtual card.

• blank (default) = The item is not a stored value card.

• P = The item is a physical stored value card.

• E = The item is a physical stored value card and, as soon as the stored value card is processed through billing, the system sends an email notification to the recipient card holder, notifying the customer that a stored value card has been purchased and is in the process of being delivered.

• V = The item is a virtual (non-physical) stored value card.

From the ITM SVC Type field in the Item table.

Available in: Version 4.0 in Order Management System 3.5 or later.

SKU

Note: This element is included for every pick detail line for a SKUed item. See Performing Initial Item Entry (MITM) for more information.

SKU_Code

alpha

14

The SKU code for the item, such as style, color, and/or size.

Note: If the SKU does not use all three SKU elements, the system does not include the blank space for the SKU elements that are not used. For example, if the SKU is BLUE SMLL, it is passed as sku="BLUE SMLL" and not sku="BLUE SMLL ".

From the SKU code field in the SKU table.

Collating_sequence_Nbr

numeric

5

The collating sequence number assigned to the SKU.

From the Collating seq # field in the SKU table.

Compatibility

alpha

3

The compatibility code assigned to the SKU; other SKUs that are compatible to this SKU are assigned the same compatibility code.

From the Compatibility field in the SKU table.

SKU_Cubing_value_override

numeric

7.1

The cubic volume of the SKU, which overrides the cubic volume defined for the item.

From the Cub val field in the SKU table.

SKU_Description

alpha

40

A description of the SKU.

From the Description field in the SKU table.

SKU_Subscription

alpha

1

Indicates whether the SKU is a subscription item.

• Y = this is a subscription item.

• N = this is not a subscription item.

From the Subscription field in the SKU table.

Height_override

numeric

3

The height measurement for the SKU. The Height, Length, and Width values are used to determine the cubic volume of the SKU.

From the Height override field in the SKU table.

Length_override

numeric

3

The length measurement for the SKU. The Height, Length, and Width values are used to determine the cubic volume of the SKU.

From the Length override field in the SKU table.

List_price

numeric

7.2

The list price defined for the SKU.

From the List price field in the SKU table.

Long_SKU_color

numeric

5

A code that represents the color portion of the long SKU code.

From the Long SKU color field in the SKU table.

Long_SKU_size

numeric

5

A code that represents the size portion of the long SKU code.

From the Long SKU size field in the SKU table.

Long_SKU_width

numeric

5

A code that represents the width portion of the long SKU code.

From the Long SKU width field in the SKU table.

Lowest_price

numeric

7.2

The lowest recommended sale price for the SKU.

From the Lowest price field in the SKU table.

Max_qty_for_location

numeric

7

The SKU's recommended maximum number of units to be stored in the primary pick location.

From the Max qty for location field in the SKU table.

Max_qty_for_warehouse

numeric

7

The SKU's recommended maximum number of units to be stored in the primary warehouse.

From the Max qty for warehouse field in the SKU table.

Min_qty_for_location

numeric

7

The SKU's recommended minimum number of units to be stored in the primary pick location.

From the Min qty for location field in the SKU table.

Min_qty_for_warehouse

numeric

7

The SKU's recommended minimum number of units to be stored in the primary warehouse.

From the Min qty for warehouse field in the SKU table.

Out_of_stock_flag

alpha

1

Indicates whether the SKU is out of stock.

• Y = the SKU is out of stock.

• N or blank = the SKU is not out of stock.

From the Out of stock flag field in the SKU table.

Qty_order_direct_ship

numeric

7

From the Qty order direct ship field in the SKU table.

Receipt_date

numeric

8

The last time inventory for the SKU was received in YYYY-MM-DD format.

From the Receipt date field in the SKU table.

Reserve_qty_limit

numeric

7

If the order quantity exceeds this amount, the system does not attempt to reserve the item and indicates the backorder reason.

From the Reserve qty limit field in the SKU table.

Restrict_orders

alpha

1

Defines whether you can accept an order for the SKU and whether demand is captured.

• Y = you can accept an order for the item/SKU.

• N or blank = you cannot accept an order for the item/SKU.

From the Restrict orders field in the SKU table.

Retail_reference_Nbr

numeric

15

The retail reference number assigned to the SKU.

From the Retail ref # field in the SKU table.

Out_of_stock_date

numeric

8

The last date the on hand level for the SKU was zero in YYYY-MM-DD format.

From the Out of stock date field in the SKU table.

Selling_weight_override

numeric

7.3

The selling weight of the SKU, used to calculate the freight charge on the SKU when the freight method on the order is Freight by weight or Freight by order weight.

From the Selling weight override field in the SKU table.

Short_SKU

numeric

7

The short SKU number defined for the SKU, used to identify the SKU.

From the Short SKU field in the SKU table.

User_field_1

alpha

10

A user-defined field for the SKU.

From the User field 1 field in the SKU table.

User_field_2

alpha

10

A user-defined field for the SKU.

From the User field 2 field in the SKU table.

User_field_3

alpha

10

A user-defined field for the SKU.

From the User field 3 field in the SKU table.

Weight_override

numeric

7.3

The actual shipping weight of the SKU.

From the Weight override field in the SKU table.

Width_override

numeric

3

The width measurement for the SKU. The Height, Length, and Width values are used to determine the cubic volume of the SKU.

From the Width override field in the SKU table.

Harmonize_code

alpha

16

A code that prints on customs documents for international shipments. If you charge duty on international orders, use this field to define the item's duty rate.

From the Harmonize code field in the SKU table.

SKU_Coordinate_group

numeric

3

A code assigned to the SKU to ensure that certain items ship together when ordered together. Items with the same coordinate group code will ship together through the same shipper.

From the Coord group field in the SKU table.

SKU_Open_qty

numeric

7

The total number of units on orders that have not shipped.

From the SKU open qty field in the SKU table.

SKU_Future_qty

numeric

7

The total number of units on future orders.

From the Future qty field in the SKU table.

SKU_Suspense_qty

numeric

7

The total number of units received against the purchase order that are currently in suspense.

From the SKU suspense qty field in the SKU table.

SKU_On_hold_qty

numeric

7

The total number of units on hold.

From the On hold qty field in the SKU table.

SKU_Standard_Cost

numeric

11.4

The standard cost of the SKU. The system populates this field only if the Costing Method (A25) system control value is set to STANDARD and a value exists in the SKU standard cost field in the SKU table.

SKU_Second_Language_Desc

alpha

40

The second language description defined for the SKU.

From the Second language desc field in the SKU table.

SKU_VAT_Exempt_flag

alpha

1

Indicates whether the item is exempt from VAT.

• Y = The item is exempt from VAT.

• N or blank = The item is subject to VAT.

From the VAT exempt flag field in the SKU table.

SKU_Second_compatibility

alpha

3

The compatibility code assigned to the SKU; other SKUs that are compatible to this SKU are assigned the same compatibility code.

From the Second compatibility field in the SKU table.

SKU_Hidden_tax_amount

numeric

7.2

The hidden tax amount to include in the price of an item subject to VAT.

From the Hidden tax amount field in the SKU table.

SKU_Hidden_tax_percent

numeric

5.2

The hidden tax percent to include in the price of an item subject to VAT.

From the Hidden tax percent field in the SKU table.

SKU_Suppress_BO_Card

alpha

1

Indicates whether to produce a backorder card for the SKU.

• Y = Suppress normal backorder card generation for the SKU.

• N or blank = Do not suppress normal backorder card generation.

From the SKU suppress B/O card field in the SKU table.

SKU_Projected_Returns

numeric

7

The number of units you expect to receive in returns for the SKU.

From the SKU projected returns field in the SKU table.

SKU_User_field_4

alpha

5

A user-defined field for the SKU.

From the SKU user field 4 field in the SKU table.

SKU_User_field_5

alpha

5

A user-defined field for the SKU.

From the SKU user field 5 field in the SKU table.

SKU_Book_Inventory

numeric

7

The expected inventory per catalog or advertisement.

From the SKU book inventory field in the SKU table.

SKU_Returnable

alpha

1

Indicates whether the SKU can be returned.

• Y = The SKU is returnable.

• N or blank = The SKU is not returnable.

From the SKU returnable field in the SKU table.

SKU_Retail_X-Ref_Nbr

numeric

10

The retail reference number assigned to the SKU.

From the SKU retail x-ref # field in the SKU table.

SKU_LS_Style

alpha

20

The long SKU style defined for the SKU.

From the SKU L/S style field in the SKU table.

SKU_LS_Vendor

alpha

7

The long SKU vendor defined for the SKU.

From the SKU L/S vendor field in the SKU table.

SKU_Receiving_Priority

alpha

2

A number that controls the priority of receiving the SKU.

From the SKU receiving priority field in the SKU table.

SKU_Generic_Ecommerce

alpha

10

From the SKU generic ecommerce field in the SKU table.

SKU_Last_Download_Qty

numeric

5

The inventory quantity that was last downloaded through the e-commerce interface.

From the SKU last download qty field in the SKU table.

SKU_Last_Extract

numeric

8

The date when the inventory information for the SKU was last extracted in YYYY-MM-DD format.

From the SKU last extract field in the SKU table.

SKU_Last_Ecomm_Info_

Chg

numeric

8

The date when the SKU information was last downloaded through the e-commerce interface in YYYY-MM-DD format.

From the SKU last ecomm info chg field in the SKU table.

SKU_SVC_Card_Reload

alpha

1

From the SKU future use Y/N 1 field in the SKU table.

SKU_Original_Retail_

Price

numeric

7.2

The original retail price for the SKU.

From the SKU original retail price field in the SKU table.

SKU_Create_Date

numeric

8

The date the SKU was created in YYYY-MM-DD format.

From the SKU create date field in the SKU table.

SKU_GTIN_Nbr

numeric

14

The GTIN number defined for the SKU.

From the SKU GTIN # field in the SKU table.

SKU_Commodity_Code

numeric

8

The commodity code defined for the SKU.

From the SKU commodity code field in the SKU table.

CTN_ID_Nbr

numeric

2

The carton ID number assigned to the SKU, identifying a particular size box.

From the CTN ID # (SKU) field in the SKU table.

Frequency_code

alpha

1

A code that classifies the performance of an item.

From the Freq code field in the SKU table.

Percentage_of_picks

numeric

5.2

The percentage of picks generated for the item.

From the Pct of picks field in the Frequency table.

Warehouse

numeric

3

The warehouse where the SKU is located.

From the Whs field in the SKU table.

Warehouse_name

alpha

30

The name of the warehouse.

From the Name field in the Warehouse table.

Location

alpha

7

The primary location where the SKU is located.

From the Location field in the SKU table.

SLC_Code

alpha

2

The soldout control code specified for the SKU.

From the SLC code field in the SKU table.

SLC_Description

alpha

30

The description of the soldout control code.

From the SLC description field in the Soldout Control table.

SLC_Status

numeric

1

Indicates whether the system sells out the SKU immediately.

• 1 = Sell out immediately, regardless of available on-hand stock.

• 2 = Include on order quantity in the soldout calculation.

• 3 = Exclude on order quantity in the soldout calculation.

From the Status field in the Soldout Control table.

Unit_of_measure

alpha

3

The unit of measure defined for the SKU.

From the UOM field in the SKU table.

UOM_Description

alpha

30

A description of the unit of measure.

From the UOM description field in the Unit of Measure table.

UOM_Units

numeric

5

The number of units represented by the unit of measure, such as 12 units in a case.

From the UOM units field in the Unit of Measure table.

SKU_Element_1_Code

alpha

4

A code representing a SKU element, such as blue (color) or small (size).

From the Element 1 field in the SKU table.

SKU_Element_1_Desc

alpha

10

A description of the SKU element, such as navy blue.

From the Element 1 desc field in the SKU Element 1 table.

SKU_Element_1_Name

alpha

4

The name of SKU element 1, such as color, size, or width.

From the Split SKU Element Column Headings (A52, A53, A54) system control values.

SKU_Element_2_Code

alpha

4

A code representing a SKU element, such as blue (color) or small (size).

From the Element 2 field in the SKU table.

SKU_Element_2_Desc

alpha

10

A description of the SKU element, such as navy blue.

From the Element 2 desc field in the SKU Element 2 table.

SKU_Element_2_Name

alpha

4

The name of SKU element 2, such as color, size, or width.

From the Split SKU Element Column Headings (A52, A53, A54) system control values.

SKU_Element_3_Code

alpha

4