Generic Inventory Inquiry API

Purpose: Use the generic inventory inquiry integration to respond to requests from external systems for current inventory information. For example, Locate uses this integration to obtain and forward up-to-date inventory information when it is requested by an external system, such as CWStore.

What does the inventory inquiry request consist of? The request specifies an item/SKU within a company, and can restrict the request:

• to a particular warehouse where you keep the item/SKU,

• to exclude non-allocatable or retail outlet warehouses,

• to the warehouses in the warehouse list associated with the SCF for the specified postal code.

The external system can identify the item/SKU using the CWDirect item and SKU codes; or, it can use the short SKU number, retail reference number, or UPC information.

What information does the inventory inquiry response include? The response includes information about the item/SKU, the warehouse(s) where it is stored, and current inventory levels such as the quantity on-hand, available, backordered, and so on. See the Inventory Inquiry Response XML Message (CWInventoryInquiryResponse) for a complete list of information.

In this topic:

Typical Flow

When is the Response Message Empty?

Resolving the Item and SKU

Inventory Inquiry API Setup Requirements

Inventory Inquiry Request XML Message (CWInventoryInquiry)

Inventory Inquiry Request: Sample XML

Inventory Inquiry Response XML Message (CWInventoryInquiryResponse)

Inventory Inquiry Response: Sample XML

Typical Flow

A typical inventory inquiry flow would be:

1. A customer at a retail location inquires into the availability of an item.

• The point of sale system, such as CWStore, generates an inventory inquiry request to Locate.

• Based on the configuration of Locate, it forwards the request to various warehouses and store locations. Its configuration specifies to forward the request for CWDirect to CWIntegrate for translation.

• CWIntegrate translates the request, produces the Inventory Inquiry Request XML Message (CWInventoryInquiry), and sends it to CWDirect.

2. The INV_INQURY process in CWDirect receives the request, generates the Inventory Inquiry Response XML Message (CWInventoryInquiryResponse), and sends it to CWIntegrate for translation.

• CWIntegrate translates the response and sends it to Locate.

• Locate sends the response to the store location, where the availability information is presented to the customer.

Inventory inquiry requests from the web storefront: You can also use the inventory inquiry integration to provide availability information to customers at your web storefront. In this situation, the web storefront could, for example, simply send the Inventory Inquiry Request XML Message (CWInventoryInquiry) message to CWDirect and receive the Inventory Inquiry Response XML Message (CWInventoryInquiryResponse).

When is the Response Message Empty?

The INV_INQURY process sends an “empty” response when the request does not include sufficient valid data. The empty response indicates to the external system that the request was not lost, but it was incomplete or invalid. For example, the process sends an empty response when the request includes:

• an invalid company code, or no company indicated

• the item cannot be resolved (see below), including:

• a SKU’ed item with no SKU information specified

• a SKU specified for a non-SKU’ed item

• a retail reference number that is assigned to more than one item/SKU

<Message source="CWDirect" target="CWIntegrate" type="CWInventoryInquiryResponse" date="08052003" time="15:11:57" >

</Message>

Resolving the Item and SKU

The inventory inquiry request can indicate the correct item and SKU through any one of the following:

1. item_number and sku_code (the sku_code is required if the item has SKUs, but should not be included for a non-SKU’d item): validated against the Item and SKU files

2. short_sku: validated against the Short SKU field in the SKU file

3. retail_reference_nbr: validated against the Reference # in the SKU file

4. upc_type and upc_code (both values must be specified): validated against the Item UPC file

In searching for an item and SKU, the system checks the values in the message in the order indicated above. If any value (or set of values, such as item_number and sku_code) is blank, it checks the next value, such as short_sku.

Once the system finds one of the values listed above in the message, it checks the related files to find a match. For example, if the request does not specify an item_number, but does specify the short_sku, the system checks the Short SKU field in the SKU file. If there is a match, the system generates the inventory inquiry response. If a short SKU is specified but there is no match, the system sends an empty message. Alternatively, if the message includes an incorrect item code and a correct short SKU, the system sends an empty response message based on the item code; it never checks the short SKU.

For more information:

• item and SKU codes: Create Item Screen and Create SKU 1 of 2 (With Overrides) Screen

• short SKU number: Short SKU

• retail reference number: Reference #

• upc type and code: Work with UPC Codes Screen

Which Warehouses are Included?

The inventory inquiry request can indicate which warehouses are included in the inventory information sent in the Inventory Inquiry Response XML Message (CWInventoryInquiryResponse).

warehouse: If you define a specific warehouse in the warehouse tag, the response includes inventory information for just that warehouse.

If you do not specify a warehouse, all warehouses where you keep the item/SKU are included (depending, also, on the exclude_non_allocatable and exclude_retail_outlet attributes).

If the warehouse specified is invalid, the response does not include any warehouse information; however, it still includes the information on the item/SKU. Similarly, if there is no record of the item in the warehouse specified, the response does not include any warehouse information, even if the warehouse specified is valid.

exclude non-allocatable warehouses: If you enter Y in the exclude_non_allocatable tag, the response includes inventory information for all warehouses except those whose Allocatable flag is set to N.

The Allocatable flag indicates whether merchandise in the warehouse can be reserved to fulfill consumer orders. A request might indicate to exclude non-allocatable warehouses because the inventory would not be available to a customer.

If the exclude_non_allocatable tag is not set to Y, the INV_INQURY process does not consider the setting of the Allocatable flag for a warehouse.

exclude retail outlet warehouses: If you enter Y in the exclude_retail_outlet tag, the response includes inventory information for all warehouses except those whose Retail outlet flag is set to Y.

The Retail outlet flag indicates whether the warehouse represents a retail store rather than a true warehouse. A request might indicate to exclude retail outlets because these warehouses might actually represent retail locations, which receive and respond to inventory inquiry requests independently of CWDirect.

If the exclude_retail_outlet tag is not set to Y, the INV_INQURY process does not consider the setting of the Retail outlet for a warehouse.

warehouse list: If you enter a country_code and postal_code, the response includes inventory information for warehouses that are part of the warehouse list for the SCF of the specified postal code. In addition, if the Evaluate Warehouses in Warehouse List Only (J47) system control value is set to N, the system also includes inventory information for the item’s primary warehouse.

The SCF is the first 3 digits of the destination postal (zip) code. You can define a warehouse list for an SCF to indicate the warehouses that are eligible to ship to the postal code. A request might specify a country code and postal code so that the response limits the inventory information to those warehouses that can fulfill an order shipping to that postal code.

If a warehouse list is not defined for the SCF, the response includes all warehouses where you keep the item/SKU.

If the SCF specified is invalid, the response does not include any warehouse information; however, it still includes the information on the item/SKU. Similarly, if there is no record of the item in the warehouses in the warehouse list, the response does not include any warehouse information, even if the SCF specified is valid.

Note: In order to limit the response message to inventory information for warehouses that are part of the warehouse list for the SCF of the postal code, you must leave the warehouse tag blank and enter Y in the exclude_non_allocatable and exclude_retail_outlet tags.

Inventory Inquiry API Setup Requirements

To use the inventory inquiry API, you need to configure the INV_INQURY process in Working with Integration Layer Processes (IJCT), and have the external system send a correctly formatted Inventory Inquiry Request XML Message (CWInventoryInquiry) to a queue specified for the job. Similarly, the external system must be prepared to receive the response described under Inventory Inquiry Response XML Message (CWInventoryInquiryResponse). Typically, you would use CWIntegrate to generate the request message and translate the response message.

You can use CWIntegrate for a seamless integration with CWStore version 7.8 or later, but the INV_INQURY process will process inventory inquiry requests from any source as long as the XML files are correctly formatted and contain the required information. More information on using the inventory inquiry API as part of the Locate integration with CWStore will be provided in the Locate manual.

Inventory Inquiry Request XML Message (CWInventoryInquiry)

The INV_INQURY process requires an XML request laid out as follows.

 

Important: Please note the following rules for numeric fields:

• Do not pass an alphanumeric value in a numeric field; doing so will cause the INV_INQURY process to go into a message wait status.

• Do not exceed the specified length of any numeric field; doing so will cause the value to be interpreted incorrectly.

General rules for alphanumeric fields:

• case-sensitive; an a is not equivalent to A.

• will be truncated if they exceed the maximum length specified below; a transaction_code of Adjustment will be truncated to A and processed correctly

For more information: See:

Typical Flow for a discussion of when you might use this message.

Inventory Inquiry Request: Sample XML for a sample message.

XML Messages for a table that provides links to the DTD, schema, and a sample XML layout for each XML message.

Attribute Name

Type

Length

Comments

Message

source

alpha

25

Identifies the source of the XML message. IDC indicates the XML message is from CWIntegrate.

target

alpha

25

Identifies the target of the XML message. RDC indicates the XML message is sent to CWDirect.

type

alpha

25

Identifies the type of information in the XML message. Should be set to CWInventoryInquiry.

InventoryInquiry

company

numeric

3

Indicates the company associated with the item/SKU. Validated against the Company file. See Setting Up Companies (WCMP).

See When is the Response Message Empty? for information on when the INV_INQURY process sends an “empty” response based on the company number indicated.

Note: See Resolving the Item and SKU for an overview of how the INV_INQURY process uses the item_number, sku_code, short_sku, retail_reference_nbr, upc_type and upc_code attributes.

item_number

alpha

12

 

sku_code

alpha

14

 

short_sku

numeric

7

 

retail_reference_nbr

numeric

15

 

upc_type

alpha

3

 

upc_code

numeric

14

 

Note: See Which Warehouses are Included? for an overview of how the INV_INQURY process uses the warehouse, exclude_non_allocatable, exclude_retail_outlet, country_code, and postal_code attributes.

warehouse

numeric

3

If a warehouse is specified, the Inventory Inquiry Response XML Message (CWInventoryInquiryResponse) includes information for just that warehouse; otherwise, all warehouses where you keep the item/SKU are included (depending, also, on the exclude_non_allocatable and exclude_retail_outlet attributes). Validated against the Warehouse file. See Creating and Maintaining Warehouses (WWHS).

If the warehouse specified is invalid, the response does not include any warehouse information; however, it still includes the information on the item/SKU. Similarly, if there is no record of the item in the warehouse specified, the response does not include any warehouse information, even if the warehouse specified is valid.

exclude_non_

allocatable

alpha

1

Indicates whether the response should exclude any warehouse whose Allocatable flag is set to N.

This flag indicates whether merchandise in the warehouse can be reserved to fulfill consumer orders. A request might indicate to exclude non-allocatable warehouses because the inventory would not be available to a customer.

If this attribute is set to Y, non-allocatable warehouses are excluded from the response; otherwise, the INV_INQURY process does not consider the setting of the Allocatable flag for a warehouse.

exclude_retail_

outlet

alpha

1

Indicates whether the response should exclude any warehouse whose Retail outlet flag is set to Y.

This flag indicates whether the warehouse represents a retail store rather than a true warehouse. A request might indicate to exclude retail outlets because these warehouses might actually represent retail locations, which receive and respond to inventory inquiry requests independently of CWDirect.

If this attribute is set to Y, retail outlet warehouses are excluded from the response; otherwise, the INV_INQURY process does not consider the setting of the Retail outlet for a warehouse.

country_code

alpha

3

The country code of a ship to customer.

If you enter a country_code and postal_code, the response includes information for warehouses that are part of the warehouse list for the SCF of the specified postal code. Also, if the Evaluate Warehouses in Warehouse List Only (J47) system control value is set to N, the system includes inventory information for the item’s primary warehouse.

If you enter a postal_code and a country_code is not defined, the system uses the country code defined in the Default Country for Customer Address (B17) system control value.

If a warehouse list is not defined for the SCF, the response includes all warehouses where you keep the item/SKU.

If the SCF specified is invalid, the response does not include any warehouse information; however, it still includes the information on the item/SKU. Similarly, if there is no record of the item in the warehouses in the warehouse list, the response does not include any warehouse information, even if the SCF specified is valid.

Available in XML version: 2.0 (version 10.5 of CWDirect).

postal_code

alpha

10

The postal code of a ship to customer.

If you enter a country_code and postal_code, the response includes information for warehouses that are part of the warehouse list for the SCF of the specified postal code. Also, if the Evaluate Warehouses in Warehouse List Only (J47) system control value is set to N, the system includes inventory information for the item’s primary warehouse.

If you enter a postal_code and a country_code is not defined, the system uses the country code defined in the Default Country for Customer Address (B17) system control value.

If a warehouse list is not defined for the SCF, the response includes all warehouses where you keep the item/SKU.

If the SCF specified is invalid, the response does not include any warehouse information; however, it still includes the information on the item/SKU. Similarly, if there is no record of the item in the warehouses in the warehouse list, the response does not include any warehouse information, even if the SCF specified is valid.

Available in XML version: 2.0 (version 10.5 of CWDirect).

Inventory Inquiry Request: Sample XML

A sample of the Inventory Inquiry Request XML Message (CWInventoryInquiry) is presented below.

 

 

<Message source="IDC" target="RDC" type="CWINVENTORYINQUIRY" resp_qmgr="CWIAS400">

<InventoryInquiry company="555" item_number="RST600" exclude_non_allocatable="Y" exclude_retail_outlet="Y" country_code="USA" postal_code="01129" />

</Message>

Inventory Inquiry Response XML Message (CWInventoryInquiryResponse)

The INV_INQURY process generates an XML response laid out as follows.

 

Note:

• Attributes are included in the response only if they contain a value. Blank attributes are not passed.

• Numeric fields use implied decimals; for example, a value of $12.34 is presented as 1234.

For more information: See:

Inventory Inquiry Response: Sample XML for a sample message.

XML Messages for a table that provides links to the DTD, schema, and a sample XML layout for each XML message.

Attribute Name

Type

Length

Comments

Message

source

alpha

25

Identifies the source of the XML message. CWDirect indicates the XML message originates from CWDirect.

target

alpha

25

Identifies the target of the XML message. CWIntegrate indicates the XML message is sent to CWIntegrate.

type

alpha

25

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

date

numeric

8

The date the response is generated, in MMDDYYYY format.

time

numeric

6

The time the response is generated, in HH:MM:SS format.

Item

company

numeric

3

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

company_

description

alpha

30

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

item_number

alpha

12

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

item_description

alpha

40

The description of the item.

item_2nd_lang_desc

alpha

40

The information in the Item second language description, if any.

item_long_sku_style

alpha

20

The item’s L/S style (Long SKU style), if any.

non_inventory

alpha

1

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

Y = This is a non-inventory item.

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

Because this flag defaults to N in Performing Initial Item Entry (MITM), it is typically populated and included in the response message.

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 (default) = 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.

Because this flag defaults to N in Performing Initial Item Entry (MITM), it is typically populated and included in the response message.

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:

You can flag an item as drop ship at the item level or SKU level. The setting at the SKU level overrides the setting at the item level. If the setting at the SKU level is blank, the system uses the setting at the item level.

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. If the item is flagged as drop ship, any SKUs for the item can be flagged as drop ship or non-drop ship.

N or blank (non-drop ship) = You ship the item from your warehouse.If the item is flagged as non-drop ship, any SKUs for the item must also be flagged as non-drop ship.

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.

Because this flag defaults to N in Performing Initial Item Entry (MITM), it is typically populated and included in the response message.

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).

item_status_

description

alpha

30

The description of the item status, if any. See Working with Item Status (WIST).

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

long_sku_

department

numeric

4

The L/S dept (Long SKU department), if any, assigned to the item.

long_sku_

department_desc

alpha

30

The description of the long SKU department, if any, as specified through Working with Long SKU Departments (WLSD).

long_sku_division

alpha

3

The L/S division (Long SKU division), if any, assigned to the item’s long SKU department.

long_sku_division_

desc

alpha

30

The description of the long SKU division, as set up through Creating and Maintaining Long SKU Divisions (WLDV).

long_sku_class

numeric

4

The L/S class (Long SKU class), if any, assigned to the item.

long_sku_class_desc

alpha

30

The description of the long SKU class, as set up through Working with Long SKU Classes (WLSC).

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

R = Remote Fulfillment Card.

V = Virtual card

See Stored Value Card Overview and Setup for more information.

SKU

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

sku_code

alpha

14

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

sku_description

alpha

40

The SKU’s description, if any.

sku_2nd_lang_desc

alpha

40

The SKU’s Second language description, if any.

sku_long_sku_style

alpha

20

The SKU’s L/S style (Long SKU style), if any. Can be different from the item_long_sku_style, if any.

short_sku

numeric

7

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

retail_reference_nbr

numeric

15

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

gift_certificate

alpha

1

The setting, if any, of the Gift cert (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.

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.

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).

sku_status_

description

alpha

30

The description of the SKU’s status, if any. See Working with Item Status (WIST).

so_control

alpha

2

The SKU’s soldout control setting, if any. Validated against the Soldout Control file. See Working with Soldout Controls (WSLD).

so_control_

description

alpha

30

The description of the soldout control code, if any, as defined through Working with Soldout Controls (WSLD).

so_control_status

alpha

1

The Sts (Status) of the soldout control, if any. Possible statuses are:

• 1 = Sellout the item/SKU immediately.

• 2 = Sellout the item/SKU when the quantity available is zero, not including open purchase orders.

• 3 = Sellout the item/SKU when the quantity available is equal to zero, including open purchase orders. (An item must be coded to sellout immediately in order to be picked up by Processing Auto Soldout Cancellations (MASO).)

sku_drop_ship

alpha

1

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

You can flag an item as drop ship at the item level and SKU level. The setting at the SKU level overrides the setting at the item level. If the setting at the SKU level is blank, the system uses the setting at the item level.

Valid values:

Y (drop ship) = When a customer orders the SKU, you order the SKU from your vendor and the vendor ships it directly to your customer. You can only flag a SKU as drop ship if the Drop ship flag at the item level is Y.

N (non-drop ship) = You ship the SKU from your warehouse.You can flag a SKU as non-drop ship if the Drop ship flag at the item level is Y, N or blank.

blank = The drop ship setting has not been defined at the SKU level; instead, the system uses the drop ship setting defined at the item level to determine if the SKU is a drop ship item.

From the Drop ship field in the SKU file.

Available in XML version: 2.0 (version 11.5 of CWDirect).

UPC

The UPC element is included only if the item/SKU has one or more UPC codes. See the Work with UPC Codes Screen for more information.

upc

numeric

14

A UPC code defined for the item/SKU.

upc_type

alpha

3

The type of UPC code. 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

upc_vendor

numeric

7

A code that identifies a supplier who sells you merchandise.

Vendor codes are defined in and validated against the Vendor file. See Working with Vendors (WVEN).

Warehouse

The warehouse name and address information, if any, are defined in the Warehouse file. See Creating and Maintaining Warehouses (WWHS) for descriptions of this information. The system does not require you to specify address information when you create a warehouse.

warehouse

numeric

3

A code identifying a warehouse where the item/SKU is located. See Which Warehouses are Included? for an overview of how the INV_INQURY process uses the warehouse, exclude_non_allocatable, exclude_retail_outlet, country_code, and postal_code attributes to determine which warehouses are included in the response.

warehouse_name

alpha

30

 

address_line_1

alpha

32

 

address_line_2

alpha

32

 

address_line_3

alpha

32

 

city

alpha

25

 

state

alpha

2

 

postal_code

alpha

10

 

country

alpha

3

 

drop_point

numeric

3

The drop point assigned to the warehouse, used to identify the warehouse’s geographical location and for zone skipping. See Working with Drop Points (WDPT) for an overview.

drop_point_

description

alpha

30

The description for the drop point, as set up through Working with Drop Points (WDPT).

manager

alpha

30

The Manager, if any, specified for the warehouse.

telephone_nbr

alpha

14

The Telephone #, if any, specified for the warehouse.

fax_nbr

alpha

14

The Fax #, if any, specified for the warehouse.

allocatable_flag

alpha

1

This flag indicates whether merchandise in the warehouse can be reserved to fulfill consumer orders. Valid values are:

Y = Merchandise in this warehouse can be reserved to fulfill orders.

N = Merchandise in the warehouse will not be used to fulfill orders. Examples of non-allocatable warehouses include non-saleable and defective item warehouses. If a warehouse is not flagged as allocatable, its on-hand quantity is not included in the availability calculation for items.

receive_restock_

transfers

alpha

1

This flag indicates whether the warehouse replenishment request will remain on the system after the transfer has been confirmed when using the Replenish Warehouses function. Valid values are:

Y = The replenishment request remains on the system when the restock shipment is confirmed. Retaining the request allows the receiving warehouse to use the request to process inventory transactions transferring merchandise from the Auto restock location to the warehouse locations where the items are stored. The request is deleted from the system when the merchandise is moved from the Auto restock location.

N = The replenishment request is deleted from the system as soon as the restock shipment is confirmed (when the merchandise has been shipped to the receiving warehouse). The receiving warehouse must use the Inventory Transactions module to transfer the merchandise from the Auto restock location to the warehouse locations where the items are stored.

inventory_value_gl_nbr

numeric

8

The warehouse’s Inventory value G/L #, if any. The system uses this number to post changes to inventory valuation resulting from purchase order receipts and order shipments if there is no Inv G/L # (Inventory general ledger account number) defined in the Item file.

value_inv_at_retail

alpha

1

This flag indicates whether the system includes the inventory allocated to this warehouse in retail price change processing. Valid values are:

Y = The inventory allocated to this warehouse is included in retail price change processing. The system includes the inventory for this warehouse in the on hand quantity defined for a retail price change history detail record.

N = The inventory allocated to this warehouse is not included in retail price change processing. The system does not include the inventory for this warehouse in the on hand quantity defined for a retail price change history detail record.

See the Use Retail Price Change Processing (H29) system control value for more information.

viewable_in_oe

alpha

1

This flag indicates whether item availability for the warehouse can be viewed in Order Entry. When you view item availability in Order Entry, a list of all viewable warehouses and the item quantity available in each warehouse displays. Valid values are:

Y = Item quantities in this warehouse can be viewed in Order Entry.

N = Item quantities in this warehouse cannot be viewed in Order Entry.

auto_restock_

location

alpha

7

The location in the warehouse, if any, where transferred stock is placed when it is transferred using the standard replenish warehouses process or the retail store restock process.

See Replenish Warehouses for more information on working with warehouse replenishment, and see Retail Stores for more information on working with retail store restock.

retail_outlet

alpha

1

Indicates whether the warehouse represents a retail store rather than a true warehouse. Valid values are:

Y = The warehouse represents a retail store location.

N = The warehouse does not represent a retail store location.

retail_type

alpha

1

Indicates whether the warehouse represents a retail outlet or home delivery service.

H = HDL Home Delivery service; this warehouse represents a delivery service provider that provides "white glove" home delivery service. Instead of shipping products directly to the customer, the system sends the products to the HDL, who in turn, delivers the products to the customer. For example, you may wish to use a home delivery service for large items, such as furniture or appliances, that require someone to carry and set up the item in the customer’s home or business. See HDL (Home Delivery Service) Processing.

M = Main retail outlet; this warehouse represents a main retail outlet that is available to fulfill backorders through the Retail Fulfillment process.

S = Satellite retail outlet; this warehouse represents a satellite retail outlet that is available to fulfill backorders through the Retail Fulfillment process. The Retail Fulfillment process allows you to place a backordered item on hold while you determine whether it is available for shipment from a retail outlet. Once you are notified that the retail outlet has shipped the item, you cancel the order line. See Retail Fulfillment Overview.

ItemWarehouse

You can review item warehouse information through Creating and Maintaining Item Warehouses and through Using Inventory Inquiry (DINI).

allocation_freeze

alpha

1

The setting of the Reservation freeze flag for the item in this warehouse. Valid values are:

Y = The item warehouse is frozen for the purposes of pick slip generation, reservation, and location or warehouse replenishment.

N = The item warehouse is not frozen. When you create an item location through Performing Initial Item Entry (MITM), this is the default setting.

economic_order_qty

numeric

7

From the Economic order qty, if any, for the item warehouse. This value, used for reporting purposes, represents the recommended optimum ordering quantity for this item/SKU, based on a set of criteria such as cost.

max_qty

numeric

7

From the Max qty, if any, for the item warehouse. This value represents the maximum amount of inventory on hand for this item/SKU, and is used by the Warehouse Replenishment program to determine when inventory should be transferred from one warehouse to another. Also, the system uses the maximum quantity during retail store restock to determine the restock order quantity for this item in the retail store.

min_qty

numeric

7

From the Min qty, if any, for the item warehouse. This value represents the least amount of inventory to keep on-hand for this item/ SKU. This value is used by Replenish Warehouses to determine when inventory should be transferred from one warehouse to another, and during retail store restock to determine if an item is eligible for restock in the retail store.

on_hand_qty

numeric

7

From the On-hand quantity, if any, for the item warehouse. This value represents the number of units for this item across all locations in the warehouse. Calculated by the system.

backorder_qty

numeric

7

From the Backorder quantity, if any, for the item warehouse. This value represents the quantity of the item/SKU in this warehouse that is currently on open orders but not available in your warehouse. Calculated by the system.

protected_qty

numeric

7

From the Protected qty, if any, for the item warehouse. This value represents the amount of inventory that cannot be reserved (using immediate or batch reservation) for this item/ SKU across all locations in this warehouse. The system uses this inventory only in Interactive Reservation.

reorder_qty

numeric

7

From the Reorder qty, if any, for the item warehouse. This value represents the quantity of this item/SKU that should be ordered when the item/SKU reaches the minimum stock level. Used in Replenish Warehouses to replenish the warehouse.

reserve_qty

numeric

7

From the Reserved quantity, if any, for the item warehouse. This value represents the quantity of this item/SKU in this warehouse that is reserved for existing orders. This total increases through immediate, batch, and interactive reservation, and decreases through confirmation or pick void/reprint. Calculated by the system.

sh_reserve_qty

numeric

7

From the S/H reserved quantity, if any, for the item warehouse. This value represents the quantity of this item/SKU in this warehouse that is reserved and flagged for some type of special handling, such as monogramming, hemming, etc. This total increases through reservation of items/SKUs assigned a special handling code in order entry or maintenance, and decreases through confirmation or pick void/reprint. Calculated by the system.

on_order_qty

numeric

7

From the On order quantity, if any, for the item warehouse. This value represents the total quantity of this item in this warehouse that is due to be received through purchase orders. Calculated by the system.

reserve_transfer_qty

numeric

7

From the Reserve transfer quantity, if any, for the item warehouse. This value represents the quantity of the item that is earmarked for an inventory transfer as a result of the Autostock Replenishment by Warehouse program. This quantity is unavailable to the Reservation program for new orders.

available_qty

numeric

7

From the Available quantity, if any, for the item warehouse. Calculated by the system as follows: On hand - Protected - Reserved - Reserve Transfer - Backordered = Quantity available

See Determining Item Availability.

next_po_date

numeric

8

Indicates the date when the next purchase order you can use to fulfill this order line is expected, based on purchase order layering. MMDDYYYY format.See Determining the Expected Ship Date.

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

This date is included for drop ship items only if the Assign Drop Ship Expected Ship Date (I59) system control value is set to Y. See that system control value for more information.

next_expected_qty

numeric

7

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

original_retail_price

numeric

7.2

From the Original retail price, if any, for the item warehouse. This value represents the original price of this item in the retail store. You can use this field to track the original retail price for the item if the warehouse represents a retail store. The Use Retail Store File (G15) system control value controls access to this field.

current_retail_price

numeric

7.2

From the Current retail price, if any, for the item warehouse. This value represents the current price of this item in the retail store. You can use this field to track the current retail price for the item if the warehouse represents a retail store. The Use Retail Store File (G15) system control value controls access to this field.

protect_current_

price

numeric

1

The setting of the Protect price (Protect current price) flag for the item warehouse. Valid values are:

Y = The system does not update the price defined in the Current retail price field when you define a new retail price in Work with Warehouse Values, and instead, keeps the existing price.

N = The system updates the price defined in the Current retail price field with the retail price you defined in Work with Warehouse Values.

The Use Retail Store File (G15) system control value controls access to this field.

protect_min_max

numeric

1

From the Protect min/max (Protect minimum and maximum quantities) flag for the item warehouse. Valid values are:

Y = The system does not update the minimum or maximum quantity for the item in this warehouse when you define a new minimum or maximum quantity in Work with Item Warehouse Values, and instead, keeps the existing quantity.

N = The system updates the minimum or maximum quantity for the item in this warehouse with the minimum or maximum quantity you defined in Work with Item Warehouse Values.

The Use Retail Store File (G15) system control value controls access to this field.

Inventory Inquiry Response: Sample XML

A sample of the Inventory Inquiry Response XML Message (CWInventoryInquiryResponse) is presented below.

 

<Message source="CWDirect" target="CWIntegrate" type="CWInventoryInquiryResponse" date="10022006" time="16:34:49">

<Item company="555" company_description="KAB Co" item_number="RST600" item_description="RST600 ITEM DESCRIPTION" item_long_sku_style="LSRST600" non_inventory="N" membership="N" drop_ship_item="N" long_sku_department="5555" long_sku_department_desc="LONG SKU DEPARTMENT" long_sku_division="1" long_sku_division_desc="LONG SKU DIVISION 1" long_sku_class="5555" long_sku_class_desc="LONG SKU CLASS">

<SKU short_sku="1994">

<Warehouses>

<Warehouse warehouse="600" warehouse_name="600 HDL WAREHOUSE" address_line_1="49 MAIN ST" city="FRAMINGHAM" state="MA" postal_code="01701" country="USA" drop_point="1" drop_point_description="MASS. DROP POINT" manager="DARCY FOX" telephone_nbr="508 652-2723" fax_nbr="555939333" allocatable_flag="Y" receive_restock_transfers="N" value_inv_at_retail="Y" viewable_in_oe="Y" retail_outlet="N" retail_type="H">

<ItemWarehouse allocation_freeze="N" protect_current_price="N" protect_min_max="N" />

</Warehouse>

<Warehouse warehouse="601" warehouse_name="601 WAREHOUSE" address_line_1="24 MAIN ST" city="FRAMINGHAM" state="MA" postal_code="01701" country="USA" drop_point="1" drop_point_description="MASS. DROP POINT" manager="DARCY FOX" allocatable_flag="Y" receive_restock_transfers="N" value_inv_at_retail="Y" viewable_in_oe="Y" retail_outlet="N">

<ItemWarehouse allocation_freeze="N" on_hand_qty="1" available_qty="1" />

</Warehouse>

<Warehouse warehouse="602" warehouse_name="602 WAREHOUSE" address_line_1="24 MAIN ST" city="FRAMINGHAM" state="MA" postal_code="01701" country="USA" drop_point="1" drop_point_description="MASS. DROP POINT" manager="DARCY FOX" allocatable_flag="Y" receive_restock_transfers="N" value_inv_at_retail="Y" viewable_in_oe="Y" retail_outlet="N">

<ItemWarehouse allocation_freeze="N" on_hand_qty="10" available_qty="10" />

</Warehouse>

<Warehouse warehouse="603" warehouse_name="603 WAREHOUSE" address_line_1="24 MAIN ST" city="FRAMINGHAM" state="MA" postal_code="01701" country="USA" drop_point="1" drop_point_description="MASS. DROP POINT" manager="DARCY FOX" allocatable_flag="Y" receive_restock_transfers="N" value_inv_at_retail="Y" viewable_in_oe="Y" retail_outlet="N">

<ItemWarehouse allocation_freeze="N" on_hand_qty="25" available_qty="25" />

</Warehouse>

</Warehouses>

</SKU>

</Item>

</Message>

ST01_09 CWDirect 18.0.x 2018 OTN