Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Promotional Products Data Interface Specification for Web services

 

 

...

 

Inventory 2.0

 

 

Document Change Log

Version

Date

Reason for Change

Author

2.0.0RC1

11/03/2017

Initial Draft

Raj Mukherjee, Integration Team Lead, Hit Promotional Products Inc

 

Eric Shonebarger, CIO, Hit Promotional Products Inc

 

2.0.0RC2

11/17/2017

·         Renamed GetFilterValuesReply to GetFilterValuesReponse

·         Renamed InventoryRequest to GetInventoryLevelsRequest

·         Renamed InventoryReply to GetInventoryLevelsResponse

·         Changed id in GetInventoryLevelsRequest to be required

·         Changed password in GetInventoryLevelsRequest to be optional

·         All token types have been changed to strings.  We used tokens very early on and then switched to strings.

·         Added ErrorMessageArray to match PO spec.  Updated ErrorMessage object to include severity element.

·         Simplified filtering in both GetInventoryLevelsRequest and GetyFilterValuesResponse to use an object called "Filter".

·         futureAvailableInventoryQuantity and futureAvailableInventoryTimeStamp changed to required. The FutureAvailabilityArray is optional, so when specifying an element in the array, it must have this info.

·         Changed address1,address2,address3 and address4 to string array and renamed to addressLines to match the PO spec.

·         Updated default endpoint location to "[Endpoint URL]"

·         Renamed partSize to labelSize to match ProductData spec.

·         Renamed colorName to partColor to match ProductData spec.

·         Renamed filterSize to labelSizeEnum to match ProductData spec.

·         Renamed futureAvailableInventoryTimeStamp to arrivalDate

·         Changed quantityAvailable to use Quantity object

·         Changed onOrderQuantity to use Quantity object

·         Changed futureAvailableInventoryQuantity to use Quantity object

·         Changed warehouseName to be optional

·         Changed Address object to be optional

 

Paul Fleischman, Technical Lead, PCNA

2.0.0RC2

11/20/2017

·         Renamed Warehouse object to InventoryLocation

·         Renamed warehouseName to inventoryLocationName

·         Renamed warehouseQuantity to inventoryLocationQuantity

·         Renamed warehouseId to inventoryLocationId

Paul Fleischman, Technical Lead, PCNA

2.0.0RC3

12/7/2017

·         Renamed ErrorMessage to ServiceMessage

Paul Fleischman, Technical Lead, PCNA

2.0.0RC4

02/26/2018

Changes made based on February meeting:

·         Removed partId element from GetFilterValuesRequest

·         Created a partIdArray within the Filter object

·         Changed the FilterArray to not be an array within GetFilterValuesResponse. A single instance is all that is needed because of the new partIdArray within the Filter object.

Paul Fleischman, Technical Lead, PCNA

2.0.0RC4

05/10/2018

·         On the SharedObjectsInventory.xsd:

o   added mentioned partIdArray definition

o   Removed FilterValues definition

o   Replaced the partId with a partIdArray on the Filter definition.

 

Raj Mukherjee, Integration Team Lead, Hit Promotional Products Inc

 

Tim Dietrich, NetSuite Integrator / PromoStandards Implementer

2.0.0

07/24/2018

·         On the SharedObjectsInventory.xsd:

o   added replenishmentLeadTime

o   Removed SelectionArray definition from Filter object

 

Raj Mukherjee, Integration Team Lead, Hit Promotional Products Inc

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Contributors

The following have contributed to the creation of this specification:

Contributors:     Raj Mukherjee, Integration Team Lead Hit Promotional Products, Inc

                                Paul Fleischman, Technical Lead, PCNA

                                Eric Shonebarger, CIO Hit Promotional Products, Inc

                                Jon Norris, VP of Operations, Starline

                                                 

                               

Abstract and Recommended Audience

This document describes the technologies for integration of suppliers and distributors in the Promotional Products Industry. This document will discuss in detail the technology required to build the interface. Additionally, this document will provide sample code to use the interface.

This document will assume that the reader is fluent in web based technologies, and has knowledge of the language they plan to consume the web service in.

Background Information

All specifications will be built using the Simple Object Access Protocol (SOAP) over HTTPS as the foundation for the web services protocol stack in order to provide a standard based on a secure form of communication.

More information on SOAP can be found at http://www.w3.org/TR/soap12-part1/

 

 

 

 

 

 

 

Service Details

 

FunctionService Details

 Function: getFilterValues ()

We recommend the suppliers to implement get filter values request

...