Inventory 2.0

Promotional Products Data Interface Specification for Web services

Service Details

Function: getFilterValues ()

We recommend the suppliers to implement get filter values request

Gets the different variations on a product, broken out by size, color, selection

Request: GetFilterValuesRequest

Field	Description	WSDL Data Type	SQL Data Type	Required?	Best Practices
wsVersion	The Standard Version of the Web Service being referenced. Values are enumerated {2.0.0}	STRING	VARCHAR(64)	TRUE
id	The customerId or any other agreed upon Id.	STRING	VARCHAR(64)	TRUE
password	The password associated with the customerId.	STRING	VARCHAR(64)	FALSE
productId	The Product Id	STRING	VARCHAR(64)	TRUE

Reply: GetFilterValuesRequestResponse

Field	Description	WSDL Data Type	SQL Data Type	Required?	Best Practices
FilterValues	An object containing the variations of a product by size, color, selection, etc	OBJECT	OBJECT	FALSE
ServiceMessageArray	Error message object Array	OBJECT ARRAY	OBJECT ARRAY	FALSE

FilterValues

Field	Description	WSDL Data Type	SQL Data Type	Required?	Best Practices
productId	The product id	VARCHAR(64)	VARCHAR(64)	TRUE
Filter	A Filter Object that contains the variations of a product by part, size, and/or color.	OBJECT	OBJECT	FALSE

Function: getInventoryLevels ()

Gets the different inventory levels for the product broken out by product and inventory location

It also gives you future stock on the product

Request: getInventoryLevelsRequest

Field	Description	WSDL Data Type	SQL Data Type	Required?	Best Practices
wsVersion	The Standard Version of the Web Service being referenced. Values are enumerated {2.0.0}	STRING	VARCHAR(64)	TRUE
id	The customer Id or any other agreed upon Id.	STRING	VARCHAR(64)	TRUE
password	The password associated with the Id.	STRING	VARCHAR(64)	FALSE
productId	The Product Id	STRING	VARCHAR(64)	TRUE
Filter	Filter the response of getInventoryLevels by using a portion of the filter information received in the response of GetFilterValuesRequest.	OBJECT	OBJECT	FALSE

Reply: getInventoryLevelsResponse

Field	Description	WSDL Data Type	SQL Data Type	Required?	Best Practices
Inventory	An object containing inventory by part and inventory location. Also shows future inventory by part and inventory location.	OBJECT	OBJECT	FALSE
ServiceMessage	Service message object	OBJECT	OBJECT	FALSE

Inventory

Field	Description	WSDL Data Type	SQL Data Type	Required?	Best Practices
productId	The product id	VARCHAR(64)	VARCHAR(64)	TRUE
PartInventoryArray	An array of ProductVariation objects	OBJECT ARRAY	OBJECT ARRAY	FALSE

PartInventory

Field	Description	WSDL Data Type	SQL Data Type	Required?	Best Practices
partId	The part id	VARCHAR(64)	VARCHAR(64)	TRUE
mainPart	A boolean value indicating if this is a main part of the product. In a tumbler with an optional lid configuration, the parts associated with the tumbler would be set to TRUE. The parts associated with the Lid would be set to false.	BOOLEAN	BOOLEAN	TRUE
partColor	Description of the color of the part	VARCHAR(64)	VARCHAR(64)	FALSE
labelSize	The apparel items tagged size. Enumerated values: {6XS,5XS,4XS,3XS,2XS,XS,S,M,L,XL,2XL,3XL,4XL,5XL,6XL,CUSTOM} CUSTOM is used for any size that does not match one of the other sizes. For example 7XL and 8XL would return CUSTOM. To identify the actual size when CUSTOM is returned, reference the Product Data endpoint.	ENUMERATED STRING	VARCHAR(6)	FALSE
partDescription	Description of the part	VARCHAR(256)	VARCHAR(256)	FALSE	Include the label value in the description if the size is “Custom”
quantityAvailable	A quantity object containing the sum of inventory of all inventory locations of the part	QUANTITY OBJECT	QUANTITY OBJECT	FALSE	Even if the item is buy to order or manufactured on demand, provide 0 as quantity rather than leaving the field empty
manufacturedItem	Indicates that the supplier produces this part according to demand. The supplier may keep a limited amount of inventory or inventory may be 0.	BOOLEAN	BOOLEAN	TRUE
buyToOrder	Indicates that the supplier purchases this product to order. The supplier may keep a limited amount of inventory, show available inventory to buy, or it might be 0.	BOOLEAN	BOOLEAN	TRUE
replenishmentLeadTime	Time to replenish buy to order or made to order	INT(3)	INT(3)	FALSE	Unit for this field should be “days”. If the item is both manufactured and buy to order, the minimum lead time should be included here.
attributeSelection	A string describing the attribute of the product other than size and color	VARCHAR(64)	VARCHAR(64)	FALSE	Provide it if there are one or more attributes that define the part other than the sizes or colors.
InventoryLocationArray	An array of InventoryLocation objects	ARRAY	ARRAY	FALSE	Provide at least one location.
lastModified	A date timestamp in UTC specifying the last time inventory was modified.	DATETIME	DATETIME	FALSE	ISO 8601

Instead of the enumerated labelSize field, It would be much more useful to utilize the ApparelSize object type from Product Data 2.0.0 in order to accommodate special sizes.

InventoryLocation

Provide 0 quantity rather that not including the inventoryLocationQuantity field altogether

Field	Description	WSDL Data Type	SQL Data Type	Required?	Best Practices
inventoryLocationId	The inventory location id	VARCHAR(64)	VARCHAR(64)	TRUE
inventoryLocationName	The name of the inventory location	VARCHAR(64)	VARCHAR(64)	FALSE
postalCode	The postal code	STRING	VARCHAR(10)	TRUE
country	The country in ISO 3166-2 format	STRING	VARCHAR(2)	TRUE
inventoryLocationQuantity	An object which contains available to order quantity for this inventory location	QUANTITY OBJECT	QUANTITY OBJECT	FALSE	Provide at least one location. If the item is manufactured item or buy to order, do not include the locations.
FutureAvailabilityArray	Array of FutureAvailability objects	OBJECT ARRAY	OBJECT ARRAY	FALSE

FutureAvailability

Field	Description	WSDL Data Type	SQL Data Type	Required?	Best Practices
Quantity	Future net available inventory quantity for the part/inventory location combination indicating goods on order or future quantity at manufactured goods.	QUANTITY OBJECT	QUANTITY OBJECT	TRUE
availableOn	A date timestamp in UTC specifying the valid timestamp depicting when the inventory will be available for allocation to sales orders.	DATETIME	DATETIME	TRUE	ISO 8601

Filter

Field	Description	WSDL Data Type	SQL Data Type	Required?	Best Practices
partIdArray	A list of part ids to be used when filtering	STRING ARRAY	VARHCAR(64)	FALSE
LabelSizeArray	An array of labelSize object	STRING ARRAY	VARCHAR(64)	FALSE
PartColorArray	A list of colors to be used when filtering	STRING ARRAY	VARCHAR(64)	FALSE

Quantity

value

The quantity value

DECIMAL

DECIMAL(12,4)

TRUE

uom

The unit of measure; values are enumerated.

Values are: {BX, CA, DZ, EA, KT, PR, PK, RL, ST, SL, TH}

BX - Box

CA - Case

DZ - Dozen

EA - Each

KT - Kit

PR - Pair

PK - Package

RL - Roll

ST - Set

SL - Sleeve

TH – Thousand

ENUMERATED STRING

VARCHAR(2)

TRUE

Appendix A: Error Messages

ServiceMessage

Field	Description	WSDL Data Type	SQL Data Type	Required?	Best Practices
code	The numerical value of the code	INT	INT	TRUE
description	Response for any message requiring notification to requestor	STRING	VARCHAR(256)	TRUE
severity	The severity of the message. Values are enumerated: {Error, Information, Warning}	ENUMERATED STRING	VARCHAR(64)	TRUE

Standardized Codes: The range of 100-199 has been reserved for standardized error codes. The number 999 has been reserved for an error codes that is a “General Error - Contact System Service Provider”

Code	Description
100	ID (customerID) not found
104	This account is unauthorized to use this service. Please contact the service provider
105	Authentication Credentials failed
110	Authentication Credentials required
115	wsVersion not found
120	The following field(s) are required [Comma Delimited field names]
125	Not Supported: [details]
999	General Error – Contact the System Service Provider Details: [Details]

Service Specific Code: These error codes are only for this service.

Code	Description
600	Product Id not found
610	Data violation: {0} (Occurs when a supplier does a pre-check on the data and finds that there is a mismatch of data and/or there are incorrect calculations)
620	Field is not supported: {0}
630	Part Id not found