Message

source

alpha

25

Identifies the source of the XML message. Informational only.

target

alpha

25

Identifies the target of the XML message. Informational only.

type

alpha

25

Identifies the type of information in the XML message. Needs to be set to CWItemAvailabilityWeb.

ItemAvailabilityWeb

company

numeric

3

Required. Indicates the company associated with the item/SKU. Validated against the Company table; see Setting Up Companies (WCMP).

sum_availability

alpha

1

Defines whether the Item Availability Response XML Message (CWItemAvailabilityResponseWeb) sums the item availability information for an item across all allocatable warehouses.

Y = the response sums the item availability information for an item across all allocatable warehouses.

N (default) = The response provides item availability information for an item for each allocatable warehouse.

Item

Can include one or more items. See Resolving the Item and SKU for more information on how the system determines the item that is inquired against.

item_number

alpha

12

The item number for the item you are inquiring against. See Resolving the Item and SKU for more information.

Defined in and validated against the Item table; see Creating and Working with Items.

sku_code

alpha

14

The SKU code of the item you are inquiring against. See Resolving the Item and SKU for more information.

Defined in and validated against the SKU table; see Creating and Working with Items.

• If an item contains SKUs and a sku_code is not passed, the system returns item availability information for all SKUs of the item.

• If an item contains SKUs and a sku_code is passed, the system returns item availability information only for the specified SKUs of the item.

short_sku

numeric

7

The short SKU number assigned by the system for the item you are inquiring against. Validated against the SKU table. The short SKU can be used to identify the correct item and SKU; see Resolving the Item and SKU for more information.

retail_reference_

nbr

numeric

15

The retail reference number defined for the item you are inquiring against. Validated against the SKU table. The retail reference number can be used to identify the correct item and SKU; see Resolving the Item and SKU for more information.

You can assign a Reference # at the Create Item (Base Information) screen or the Create SKU 2 of 2 (With Overrides) screen; see Creating and Working with Items.

upc_type

alpha

3

The UPC type and UPC code defined for the item you are inquiring against. Validated against the Item UPC table. The UPC type and UPC code can be used to identify the correct item and SKU; see Resolving the Item and SKU for more information.

Valid UPC types are:

• E13 = EAN-13, indicating a 13 position UPC code; however CWSerenade does not validate the UPC length.

• E8 = EAN-8, indicating an 8 position UPC code; however, CWSerenade does not validate the UPC length.

• UA = UPC-A, indicating a 12 position UPC code; however CWSerenade does not validate the UPC length.

• UE = UPC-E, indicating a 6 position UPC code; however CWSerenade does not validate the UPC length.

Note: Include any leading zeros that are part of the UPC code. For example, if the UPC code is 06012011, pass 06012011 and not 6012011.

You can use the Work with UPC Codes Screen to assign UPC codes to an item.

upc_code

alpha

14

Message

source

alpha

25

Identifies the source of the XML message. Informational only.

target

alpha

25

Identifies the target of the XML message. Informational only.

type

alpha

25

Identifies the type of information in the XML message. This will be CWItemAvailabilityResponseWeb.

ItemAvailabilityResponseWeb

company

numeric

3

Indicates the company associated with the item/SKU; see Setting Up Companies (WCMP).

From CMP Company in the Item Warehouse table.

company_

description

alpha

30

The description from the company, as set up through Setting Up Companies (WCMP).

From Company Description in the Company table.

pass_fail

alpha

6

Defines whether item availability information was retrieved successfully.

• PASS = Item availability information was retrieved successfully.

• FAILED = The Item Availability Request XML Message (CWItemAvailabilityWeb) did not include sufficient valid data. See Item Availability Web Service Errors for a list of errors.

errorMsg

alpha

50

The reason why item availability information was not retrieved successfully. See Item Availability Web Service Errors for a list of errors.

Item

The response includes item information for each item passed in the Item Availability Request XML Message (CWItemAvailabilityWeb). If you included the same item more than once in the request, for example you included the UPC type and code and the short SKU number for the same item, the response includes item information for each request of the item.

item_number

alpha

12

The item code, as set up through Performing Initial Item Entry (MITM).

From ITM Number in the Item Warehouse table.

item_description

alpha

40

The description of the item.

From Description in the Item table.

item_2nd_lang_

desc

alpha

40

The Second language description defined for the item.

From Second Language Desc in the Item table.

non_inventory

alpha

1

Indicates whether inventory levels are maintained for the item. Valid values are:

Y = This is a non-inventory item.

N = This is a regular item that will be tracked.

From Non-inventory in the Item table.

membership

alpha

1

Indicates that the item represents a membership program, which you can use to generate periodic orders to a customer. Valid values are:

Y = This is a membership item

N = This is not a membership item

Even when an item is flagged as a membership item, it is still possible to have an item warehouse record if, for example, you specified a default warehouse when creating the item.

From Membership 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. Valid values are:

Y = When a customer orders the item, you order the item from your vendor and the vendor ships it directly to your customer. However, it is still possible to ship the item from the warehouse if it is available there.

N = You ship the item from your warehouse.

If there is a record of an item in a warehouse, this information is still provided in the response message regardless of the setting of this flag.

From Drop ship item in the Item table.

item_status

alpha

1

The item’s Status, if any. An optional code that represents an item's status, such as obsolete, discontinued, etc. This information is used for inventory reporting purposes and to select items for physical inventory. See Working with Item Status (WIST).

From Item Status in the Item table.

kit_type

alpha

1

The Kit type setting, if any, for the item. Valid values are:

• C = Continuity program

• S = Set

• F = Finished goods

• V = Variable set

From Kit type in the Item table.

svc_type

alpha

1

Indicates the type of stored value card that the item is, if it is a stored value card. Valid values are:

• P = Physical card

• E = Physical card/early notification

• V = Virtual card

See Stored Value Card Overview and Setup for more information. From SVC Type in the Item table.

SKU

The response includes SKU information for each item passed in the Item Availability Request XML Message (CWItemAvailabilityWeb).

This element includes attributes that apply to both SKUed and non-SKUed items, so it is always included in the response.

sku_code

alpha

14

The item’s unique characteristics; included if this is a SKUed item.

From SKU Code in the SKU table.

sku_description

alpha

40

The SKU’s description, if any.

From Description in the SKU table.

sku_2nd_lang_

desc

alpha

40

The SKU’s Second language description, if any.

From Second Language Desc in the SKU table.

short_sku

numeric

7

The item or SKU’s Short SKU code. This is a system-assigned code to uniquely identify each item/SKU.

From Short SKU in the SKU table.

retail_reference_

nbr

numeric

15

The SKU’s Reference # (Reference number), if any. Typically, this is an alternate product ID.

From Retail reference # in the SKU table.

gift_certificate

alpha

1

The setting, if any, of the Gift certificate flag. Valid values are:

Y = The item is a gift certificate

N = The item is not a gift certificate

Because this flag is optional when you create an item/SKU, it might not contain a Y or N value; if not, it is not included in the response.

From Gift certificate in the SKU table.

subscription

alpha

1

The setting, if any, of the Subscription flag. Valid values are:

Y = Item is a subscription.

N = Item is not a subscription.

Even when an item is flagged as a subscription, it is still possible to have an item warehouse record if, for example, you specified a default warehouse when creating the item.

Because this flag is optional when you create an item/SKU, it might not contain a Y or N value; if not, it is not included in the response.

From Subscription in the SKU table.

sku_status

alpha

1

The SKU’s status code, if any. Can be different from the item’s status. See Working with Item Status (WIST).

From Item Status in the SKU table.

so_control

alpha

2

The SKU’s soldout control setting, if any. See Working with Soldout Controls (WSLD).

From SLC Code in the SKU table.

upc

alpha

14

A UPC code defined for the item/SKU.

The UPC is included only if the item/SKU has one or more UPC codes and the UPC was passed in the request. See the Work with UPC Codes Screen for more information.

From UPC in the Item UPC table.

upc_type

alpha

3

The type of UPC code. The UPC type is included only if the item/SKU has one or more UPC codes and the UPC was passed in the request. The UPC type determines the type of validation the system performs against the UPC code. Valid values are:

• E13: EAN-13

• E8: EAN-8

• UA: UPC-A

• UE: UPC-E

From UPC Type in the Item UPC table.

Warehouse

The response includes warehouse information for each item passed in the Item Availability Request XML Message (CWItemAvailabilityWeb).

The response includes only allocatable warehouses assigned to the item/SKU. The response includes all allocatable item warehouses, even if there is no available quantity, on order quantity, or next expected quantity or PO date so that you can see item warehouses with no item availability.

You can review item warehouse information through Creating and Maintaining Item Warehouses and through Using Inventory Inquiry (DINI). You can review item availability information through Inquiring into Item Availability (DIAV).

warehouse

numeric

3

A code identifying an allocatable warehouse assigned to the item/SKU.

From Warehouse in the Item Warehouse table.

ALL displays if the sum_availability attribute was set to Y in the Item Availability Request XML Message (CWItemAvailabilityWeb).

warehouse_name

alpha

30

The name of the warehouse.

From Warehouse name in the Warehouse table.

ALL displays if the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to Y.

on_order_qty

numeric

7

The total quantity of the item that is due to be received through purchase orders.

If available, the system includes an on order quantity for inventory and non-inventory items, including items that are flagged to sell out immediately, virtual stored value card items, membership items, gift certificate items, subscription items, and items on allocation freeze.

Sum Availability = N

If the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to N, this is the on order quantity, if any, for the item warehouse.

Sum Availability = Y

If the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to Y, this is the on order quantity across all allocatable item warehouses.

Set master items and continuity items: This is the on order quantity for the component with the lowest available quantity, even if this quantity is 0.

From On order qty in the Item Warehouse table.

available_qty

numeric

7

The quantity available for the item.

If available, the system calculates the available quantity for inventory and non-inventory items, including items that are flagged to sell out immediately, virtual stored value card items, membership items, gift certificate items, subscription items, and items on allocation freeze.

Calculated by the system as follows:

On hand - Protected - Reserved - Reserve Transfer - Backordered = Quantity available

Sum Availability = N

If the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to N, this is the available quantity, if any, for the item warehouse.

Sum Availability = Y

If the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to Y, this is the available quantity across all allocatable item warehouses.

Set master items and continuity items: This is the available quantity for the component with the lowest available quantity, divided by the quantity required for the set. For example, if the available quantity is 532, but the set requires 2 of the component item, the available quantity returned is 266 (532/2 = 266).

next_po_date

numeric

8

The date when the next purchase order for the item is expected, based on purchase order layering. MMDDYYYY format.

If available, the system includes a next PO date for inventory and non-inventory items, including items that are flagged to sell out immediately, virtual stored value card items, membership items, gift certificate items, subscription items, and items on allocation freeze.

Sum Availability = N

If the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to N, this is the due date from the first PO Layering record for the item warehouse.

See Purchase Order Layering and Backorder Notifications for more information on purchase order layering.

Sum Availability = Y

If the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to Y, this is the due date from the first PO Layering record across all item warehouses.

Drop ship item: This date is included for drop ship items only if the Assign Drop Ship Expected Ship Date (I59) system control value is selected.

From Due date in the PO Layering table.

next_expected_qty

numeric

7

The number of units of this item ordered on a purchase order that will be available for new orders.

If available, the system includes a next expected quantity for inventory and non-inventory items, including items that are flagged to sell out immediately, virtual stored value card items, membership items, gift certificate items, subscription items, and items on allocation freeze.

This is the open quantity associated with the next_po_date.

From Open qty in the PO Layering table.