6 RESTful Web Service Implementation for RMS

This chapter gives an overview about the ReSTful web service implementation for RMS.

RMS Common Services

This section describes the GA account validation service.

Functional Area

Foundation

Business Overview

The primary role of this service is to provide access to cross-functional RMS data.

Vdate

Business Overview

Retrieve RMS Vdate.

Service Type

Get

ReST URL

/Common/vDate

Input Parameters

NA

Output

Vdate in long format

TABLE	SELECT	INSERT	UPDATE	DELETE
PERIOD	Yes	No	No	No

Procurement Unit Options

Business Overview

Retrieve RMS's Procurement Unit Options.

Service Type

Get

ReST URL

/Common/POSysOps

Input Parameters

NA

Output

Values of the following columns:

• BACKPOST_RCA_RUA_IND

• BILL_TO_LOC

• CALC_NEGATIVE_INCOME

• COPY_PO_CURR_RATE

• COST_LEVEL

• CREDIT_MEMO_LEVEL

• DEAL_AGE_PRIORITY

• DEAL_LEAD_DAYS

• DEAL_TYPE_PRIORITY

• DEPT_LEVEL_ORDERS

• EDI_COST_OVERRIDE_IND

• EXPIRY_DELAY_PRE_ISSUE

• GEN_CONSIGNMENT_INVC_FREQ

• GEN_CON_INVC_ITM_SUP_LOC_IND

• LATEST_SHIP_DAYS

• ORD_APPR_CLOSE_DELAY

• ORD_APPR_AMT_CODE

• ORD_AUTO_CLOSE_PART_RCVD_IND

• ORD_PART_RCVD_CLOSE_DELAY

• ORDER_BEFORE_DAYS

• ORDER_EXCH_IND

• OTB_SYSTEM_IND

• RCV_COST_ADJ_TYPE

• RECLASS_APPR_ORDER_IND

• REDIST_FACTOR

• SOFT_CONTRACT_IND

• WAC_RECALC_ADJ_IND

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
PROCUREMENT_UNIT_OPTIONS	Yes	No	No	No

Functional Config Options

Business Overview

Retrieve RMS's Functional Config Options.

Service Type

Get

ReST URL

/Common/FuncSysOps

Input Parameters

NA

Output

Values of the following columns:

• CONTRACT_IND

• ELC_IND

• IMPORT_IND

• ORG_UNIT_IND

• SUPPLIER_SITES_IND

TABLE	SELECT	INSERT	UPDATE	DELETE
FUNCTIONAL_CONFIG_OPTIONS	Yes	No	No	No

Inventory Movement Unit Options

Business Overview

Retrieve RMS's Inventory Movement Unit Options.

Service Type

Get

ReST URL

/Common/InvMovSysOps

Input Parameters

NA

Output

Values of the following columns:

• ALLOC_METHOD

• APPLY_PROF_PRES_STOCK

• AUTO_RCV_STORE

• CLOSE_OPEN_SHIP_DAYS

• COST_MONEY

• COST_OUT_STORAGE

• COST_OUT_STORAGE_MEAS

• COST_OUT_STORAGE_UOM

• COST_WH_STORAGE

• COST_WH_STORAGE_MEAS

• COST_WH_STORAGE_UOM

• DEFAULT_ALLOC_CHRG_IND

• DEFAULT_ORDER_TYPE

• DEFAULT_SIZE_PROFILE

• DEPT_LEVEL_TRANSFERS

• DISTRIBUTION_RULE

• DUPLICATE_RECEIVING_IND

• INCREASE_TSF_QTY_IND

• INTERCOMPANY_TRANSFER_BASIS

• INV_HIST_LEVEL

• LOC_ACTIVITY_IND

• LOC_DLVRY_IND

• LOOK_AHEAD_DAYS

• MAX_SCALING_ITERATIONS

• MAX_WEEKS_SUPPLY

• ORD_WORKSHEET_CLEAN_UP_DELAY

• RAC_RTV_TSF_IND

• REJECT_STORE_ORD_IND

• REPL_ORDER_DAYS

• RTV_NAD_LEAD_TIME

• RTV_UNIT_COST_IND

• SHIP_RCV_STORE

• SHIP_RCV_WH

• STORAGE_TYPE

• STORE_PACK_COMP_RCV_IND

• WF_DEFAULT_WH

• TARGET_ROI

• TSF_AUTO_CLOSE_STORE

• TSF_AUTO_CLOSE_WH

• TSF_CLOSE_OVERDUE

• SIM_FORCE_CLOSE_IND

• TSF_FORCE_CLOSE_IND

• TSF_OVER_RECEIPT_IND

• TSF_MD_STORE_TO_STORE_SND_RCV

• TSF_MD_STORE_TO_WH_SND_RCV

• TSF_MD_WH_TO_STORE_SND_RCV

• TSF_MD_WH_TO_WH_SND_RCV

• TSF_PRICE_EXCEED_WAC_IND

• SS_AUTO_CLOSE_DAYS

• WS_AUTO_CLOSE_DAYS

• SW_AUTO_CLOSE_DAYS

• WW_AUTO_CLOSE_DAYS

• WF_ORDER_LEAD_DAYS

• WH_CROSS_LINK_IND

• WRONG_ST_RECEIPT_IND

TABLE	SELECT	INSERT	UPDATE	DELETE
INV_MOVE_UNIT_OPTIONS	Yes	No	No	No

Currencies

Business Overview

Retrieve RMS's Currencies table records.

Service Type

Get

ReST URL

/Common/Currencies

Input Parameters

NA

Output

Fetches the following columns for all the currencies:

• Currency Code

• Currency Description

• Currency Cost Format

• Currency Retail Format

• Currency Cost Decimal

• Currency Retail Decimal

TABLE	SELECT	INSERT	UPDATE	DELETE
CURRENCIES	Yes	No	No	No

Department Search

Business Overview

This service retrieves departments with ID or name matching search string.

Service Type

Get

ReST URL

/Common/departmentSearch?searchString={searchString}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description	Valid values
searchString	Yes	search string for department Id or Name
PageSize	No	Maximum number of records to retrieve per page
PageNumber	No	Result page to retrieve

Output

• Department

• Name

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_DEPS	Yes	No	No	No

Department Load

Business Overview

This service retrieves departments' name of input IDs.

Service Type

Get

ReST URL

/Common/departmentLoad?departments={departments}

Input Parameters

Parameter Name	Required	Description	Valid values
departments	Yes	Comma separated values for Departments	NA

Output

• Department

• Name

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_DEPS	Yes	No	No	No

Code Detail Service

Business Overview

Code Detail service allows user to retrieve code details for a selected code and code type.

Service Type

Get

ReST URL

CodeDetail/codeDetails?code={ }&codeType={ }

Input Parameters

Parameter Name	Required	Description	Valid values
Code Code Type	Yes Yes	Code Code Type	NA

Output

• Code_Desc

• required_Ind

• code_Seq

• code_Type

• code_Type_Desc

• code

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
CODE_HEAD	Yes	No	No	No
CODE_DETAIL	Yes	No	No	No

VDATE Service

Business Overview

This service is used to retrieve the RMS virtual business date (vdate).

Service Type

Get

ReST URL

Vdate/vdateDetail

Input Parameters

na

Output

vdate

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
PERIOD	Yes	No	No	No

Create Inventory Transfer Services

This section describes the inventory transfer services.

Functional Area

Inventory Movement

Business Overview

The primary role of these services is to create transfers and send them to RMS.

Transfer Number

Business Overview

Retrieves the next transfer number from RMS.

Service Type

Get

ReST URL

/Transfer/TransferId

Input Parameters

No input

Output

Transfer Number

Table Impact

NA

Search Items

Business Overview

This service retrieves items applicable for inventory transfer. Item can be searched either by Item or VPN. To search the item, enter an item number, a partial item description, or a VPN in the search string.

• When search type is ITEM, the search string can be an item number, a partial item number, an item description, or partial item description. In this case, the query returns all items which match the item description or partial description, or which match the item number entered.

• When search type is VPN, the search string can be a VPN or partial VPN, the API should return all items with that VPN.

  The items returned are constrained by the following criteria:

  • Approved status.

  • Transaction-level items.

  • Inventory items.

• When From Location is sent as an input, then only the following items are returned:

  • With available inventory at the From Location.

  • Packs with Receive as Type as Each are filtered out when, from location is a virtual warehouse.

• If the System Option for DEPT_LEVEL_TRANSFERS is set as"Y" and a Department ID is sent as input, then only the input department items are returned.

Service Type

Get

ReST URL

/Transfer/item?itemSearchType={itemSearchType}&searchString={searchString}&dept={dept}&fromLocation={fromLocation}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description	Valid values
itemSearchType	Yes	Search type item or VPN.	ITEM, VPN
searchString	Yes	Search string for items ID or Name.	NA
dept	No	Selected items' department ID.	NA
fromLocation	No	Selected from location ID.	NA
PageSize	No	Maximum number of items to retrieve per page.	NA
PageNumber	No	Result page to retrieve.	NA

Output

Values of the following columns:

• Item

• Item Description

• Department

• Available Quantity - only populated when from loc is sent

• Average Cost - only populated when from loc is sent

• Unit Retail - only populated when from loc is sent

• Currency Code - only populated when from loc is sent

• Standard UOM

• Supplier Pack Size

• Inner Pack Size

• Item Image URL

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_HEADER	Yes	No	No	No
ALLOC_DETAIL	Yes	No	No	No
DAILY_PURGE	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No
ITEM_IMAGE	Yes	No	No	No
ITEM_SUPPLIER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
ORDHEAD	Yes	No	No	No
STORE	Yes	No	No	No
V_ITEM_MASTER	Yes	No	No	No
WH	Yes	No	No	No

Load Items

This section describes the load items.

Business Overview

Load items service allows the user to refresh item records information for already selected items.

Service Type

Get

ReST URL

/Transfer/item/load?items={items}&fromLocation={fromLocation}

Input Parameters

Parameter Name	Required	Description
items	Yes	Comma Separated values for selected items' ID.
fromLocation	No	Selected from location ID.

Output

Values of the following columns:

• Item

• Item Description

• Department

• Available Quantity - only populated when from loc is sent

• Average Cost - only populated when from loc is sent

• Unit Retail - only populated when from loc is sent

• Currency Code - only populated when from loc is sent

• Standard UOM

• Supplier Pack Size

• Inner Pack Size

• Item Image URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_HEADER	Yes	No	No	No
ALLOC_DETAIL	Yes	No	No	No
DAILY_PURGE	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No
ITEM_IMAGE	Yes	No	No	No
ITEM_SUPPLIER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
ORDHEAD	Yes	No	No	No
STORE	Yes	No	No	No
V_ITEM_MASTER	Yes	No	No	No
WH	Yes	No	No	No

Search From Location

This section describes the Search From Location service.

Business Overview

This service retrieves locations applicable for inventory transfer. Location can be searched by either 'S'tore or 'W'arehouse. Then enter a location number, a partial location number, a location description, or a partial location description in the search string.

The locations returned are constrained by the following criteria:

• When search type is warehouse only virtual warehouses are returned.

• Only stockholding location.

• When search type is store then only open stores are returned.

• When items are sent as input then only locations with available inventory are returned.

• When To Location is sent as input then:

  • It cannot be the same as the To Location.

  • When transfer type is Manual Requisition, then only locations with the same Transfer Entity/Set of Books as the To Location are returned in the search results.

  • When the transfer type is Intercompany, then only locations with a different Transfer Entity/Set of Books to the To Location are returned in the search results.

  • Only locations in the same transfer zone are returned in the search results.

Service Type

Get

ReST URL

/Transfer/fromLocation?locationType={locationType}&searchString={searchString}&tsfType={tsfType}&toLocation={toLocation}&items={items}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description	Valid values
LocationType	Yes	Location type Store or warehouse	S, W
SearchString	Yes	search string for locations Id or Name	NA
tsfType	Yes	Transfer type	IC, MR
toLocation	No	Selected to location ID	NA
items	No	Comma Separated values for selected items	NA
PageSize	No	Maximum number of locations to retrieve per page	NA
PageNumber	No	Result page to retrieve	NA

Output

Values of the following columns:

• Location

• Location Type

• Location Name

• Location Currency

• Entity

• Entity Description

• Location Item Table

  • Item

  • Available Quantity

  • Average Cost

  • Unit Retail

  • Currency Code

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_HEADER	Yes	No	No	No
ALLOC_DETAIL	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
MV_LOC_SOB	Yes	No	No	No
ORDHEAD	Yes	No	No	No
ORG_UNIT	Yes	No	No	No
STORE	Yes	No	No	No
TRANSFER_LOC	Yes	No	No	No
TSF_ENTITY	Yes	No	No	No
V_STORE	Yes	No	No	No
V_TRANSFER_FROM_LOC	Yes	No	No	No
V_TRANSFER_TO_LOC	Yes	No	No	No
V_WH	Yes	No	No	No

Search To Location

This section describes the Search To Location service.

Business Overview

This service retrieves locations applicable for inventory transfer. Location can be searched by either 'S'tore or 'W'arehouse. Then enter a location number, a partial location number, a location description, or a partial location description in the search string.

The locations returned are constrained by the following criteria:

• When search type is warehouse only virtual warehouses are returned.

• Internal finishers are filtered out.

• Only stockholding location.

• When search type is Store then only open stores are returned.

• When items are sent as input then only locations with available inventory are returned.

• When From Location is sent as input then:

  • To Location cannot be the same as the From Location.

  • When Transfer Type is set as a manual request, then only locations with the same Transfer Entity/Set of Books as the From Location are returned in the search results.

  • When the Transfer Type is Intercompany, then only locations with a different Transfer Entity/Set of Books to the From Location are returned in the search results.

  • Only locations in the same transfer zone are returned in the search results.

Service Type

Get

ReST URL

/Transfer/toLocation?locationType={locationType}&searchString={searchString}&tsfType={tsfType}&fromLocation={fromLocation}&pageSize={pageSize}&pageNumber={pageNumber}")

Input Parameters

Parameter Name	Required	Description	Valid values
LocationType	Yes	Location type Store or warehouse	S, W
SearchString	Yes	search string for locations Id or Name	NA
tsfType	Yes	Transfer type	IC, MR
fromLocation	No	Selected from location ID	NA
PageSize	No	Maximum number of locations to retrieve per page	NA
PageNumber	No	Result page to retrieve	NA

Output

Values of the following columns:

• Location

• Location Type

• Location Name

• Location Currency

• Entity

• Entity Description

• Location Item Table

  • Item

  • Available Quantity

  • Average Cost

  • Unit Retail

  • Currency Code

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_HEADER	Yes	No	No	No
ALLOC_DETAIL	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
MV_LOC_SOB	Yes	No	No	No
ORDHEAD	Yes	No	No	No
ORG_UNIT	Yes	No	No	No
STORE	Yes	No	No	No
TRANSFER_LOC	Yes	No	No	No
TSF_ENTITY	Yes	No	No	No
V_STORE	Yes	No	No	No
V_TRANSFER_FROM_LOC	Yes	No	No	No
V_TRANSFER_TO_LOC	Yes	No	No	No
V_WH	Yes	No	No	No

Load Locations

This section describes the Load Locations service.

Business Overview

Load locations Web service allows user to refresh selected locations records.

Service Type

Get

ReST URL

/Transfer/loadLocations?fromLocation={fromLocation}&toLocation={toLocation}

Input Parameters

Parameter Name	Required	Description
FromLocation	No	Selected from location ID.
ToLocation	No	Selected to location ID.

Output

Values of the following columns:

• Location

• Location Type

• Location Name

• Location Currency

• Entity

• Entity Description

• Location Item Table

  • Item

  • Available Quantity

  • Average Cost

  • Unit Retail

  • Currency Code

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_HEADER	Yes	No	No	No
ALLOC_DETAIL	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
MV_LOC_SOB	Yes	No	No	No
ORDHEAD	Yes	No	No	No
ORG_UNIT	Yes	No	No	No
STORE	Yes	No	No	No
TRANSFER_LOC	Yes	No	No	No
TSF_ENTITY	Yes	No	No	No
V_STORE	Yes	No	No	No
V_TRANSFER_FROM_LOC	Yes	No	No	No
V_TRANSFER_TO_LOC	Yes	No	No	No
V_WH	Yes	No	No	No

Create Transfer

This section describes the Create Transfer service.

Business Overview

The Web service calls the existing RMS XTSF API directly with input parameters. For more information on RMS XTSF API, see Store Order Subscription API and Transfer Subscription API sections.

Service Type

Post

ReST URL

/Transfer

Input Parameters

Example json RDO input:

{
    "links" : [ ],
     "tsfdtlRDOs" : [ {
       "links" : [ ],
       "item" : null,
       "tsfQty" : null,
       "suppPackSize" : null,
       "invStatus" : null, 
       "unitCost" : null,
       "hyperMediaContent" : {
         "linkRDO" : [ ]
       }
     } ],
     "tsfNo" : null,
     "fromLocType" : null,
     "fromLoc" : null,
     "toLocType" : null,
     "toLoc" : null,
     "deliveryDate" : null,
     "dept" : null,
     "routingCode" : null,
     "freightCode" : null,
     "tsfType" : null,
     "status" : null,
     "userId" : null,
     "commentDesc" : null,
     "contextType" : null,
     "contextValue" : null,
     "hyperMediaContent" : {
       "linkRDO" : [ ]
     }
   }

Output

NA

Table Impact

For more information on the RMS XTSF API, see the Store Order Subscription API and Transfer Subscription API sections.

Create Purchase Order Services

This section describes the Create Purchase Order Services section.

Functional Area

Procurement

Business Overview

The primary role of this service is to create purchase orders and send them to RMS.

Order Number

This section describes the Order Number.

Business Overview

Retrieves the next order number from RMS.

Service Type

Get

ReST URL

/PurchaseOrders/order/id

Input Parameters

NA

Output

Order Number

Table Impact

NA

Terms

This section describes the valid terms.

Business Overview

Retrieves all valid terms; valid terms are enabled with flag set to Yes and within the start and end active date.

Service Type

Get

ReST URL

/PurchaseOrders/supplier/terms

Input Parameters

NA

Output

• Values of the following columns:

• Terms

• Terms Code

• Terms Description

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
TERMS_HEAD	Yes	No	No	No
TERMS_DETAIL	Yes	No	No	No

Search Supplier

This section describes the Search Supplier service.

Business Overview

Supplier search can be, by entering either full or partial supplier site ID (numeric) or by a full or partial supplier site description in the search string.

Returned suppliers are constrained by the following criteria:

• Only active supplier sites are returned.

• When items are sent as input, then only supplier sites that are common amongst the items are returned.

• When locations are sent as input, then only suppliers that are valid for the Org Units associated with the input locations are returned.

Service Type

Get

ReST URL

/PurchaseOrders/supplier?supplierSearchString={supplierSearchString}&locations={locations}&items={items}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description
SupplierSearchString	No	Search string for Supplier's ID or Name.
Item	No	Comma Separated values for items.
Locations	No	Comma Separated values for locations.
PageSize	No	Maximum number of suppliers to retrieve per page.
PageNumber	No	Result page to retrieve.

Output

Values of the following columns:

• Supplier

• Supplier Name

• Supplier Currency

• Terms

• Default Item Lead Time

• Supplier Item Table

  • Item

  • Origin Country Id

  • Lead Time

• Supplier Item Location Table

  • Item

  • Location

  • Pickup Lead Time

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ITEM_SUPPLIER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
STORE	Yes	No	No	No
SUPS	Yes	No	No	No
V_SUPS	Yes	No	No	No
WH	Yes	No	No	No

Load Supplier

This section describes the load supplier service.

Business Overview

Loading supplier Web service allows a user to refresh the selected supplier records.

Service Type

Get

ReST URL

/PurchaseOrders/supplier/load?suppliers={suppliers}&locations={locations}&items={items}

Input Parameters

Parameter Name	Required	Description
Supplier	Yes	Supplier's ID.
Item	No	Comma Separated values for items.
Locations	No	Comma Separated values for locations.

Output

• Values of the following columns:

• Supplier

• Supplier Name

• Supplier Currency

• Terms

• Default Item Lead Time

• Supplier Item Table

  • Item

  • Origin_country Id

  • Lead Time

• Supplier Item Location Table

  • Item

  • Location

  • Pickup Lead Time

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ITEM_SUPPLIER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
ITEM_SUPP_COUNTRY_LOC	Yes	No	No	No
STORE	Yes	No	No	No
SUPS	Yes	No	No	No
V_SUPS	Yes	No	No	No
WH	Yes	No	No	No

Search Items

This section describes the Search Items service.

Business Overview

This service retrieves items applicable for Purchase Order. Item can be searched by either Item or VPN. Enter an item number, a partial item description, or a VPN in the search string.

1. When search type is ITEM, the search string can be an item number, a partial item number, an item description, or partial item description

2. When search type is VPN, the search string can be a VPN or partial VPN.

The items returned are constrained by the following criteria:

• Approved status.

• Transaction-level items.

• Orderable items.

• Pack items with Order Type as Each are filtered out.

• Only items belonging to Normal Merchandise Purchase Type as Department are retuned.

• When a supplier is sent as input then:

  • Only items supplied by the input supplier are returned.

  • The item information is based on the Item/Supplier/Primary Origin Country.

• When supplier is not sent as input, then item information is based on the primary supplier and primary origin country.

• If the system_options.dept_level_orders is set to"Y" and the Department ID is sent as input, then only the input department items are returned.

• Items set for deletion are filtered out.

Service Type

Get

ReST URL

/PurchaseOrders/item?itemSearchType={itemSearchType}&searchString={searchString}&dept={dept}&supplier={supplier}&locations={locations}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description	Valid values
itemSearchType	Yes	Search Type item or VPN.	ITEM, VPN
searchString	Yes	Search string for items Id or Name.	NA
dept	No	Selected items' department ID.	NA
supplier	No	Selected Supplier ID.	NA
Locations	No	Comma Separated values for selected locations' ID.	NA
PageSize	No	Maximum number of items to retrieve per page.	NA
PageNumber	No	Result page to retrieve.	NA

Output

Values of the following columns:

• Item

• Item Description

• Department

• Supplier

• Origin Country Id

• Supplier Pack Size

• Unit Cost

• Supplier Currency

• Base Unit Retail

• Base Retail Currency

• Base Retail UOM

• Item Image URL

• Locations Table

  • Location

  • Location Type

  • Item Location Status

  • Unit Retail

  • Unit Retail Currency

  • Unit Retail UOM

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
DAILY_PURGE	Yes	No	No	No
DEPS	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_IMAGE	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
ITEM_SUPPLIER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
MV_CURRENCY_CONVERSION_RATES	Yes	No	No	No
RPM_MERCH_RETAIL_DEF_EXPL	Yes	No	No	No
RPM_ZONE	Yes	No	No	No
V_ITEM_MASTER	Yes	No	No	No
V_PACKSKU_QTY	Yes	No	No	No
V_SUPS	Yes	No	No	No
WH	Yes	No	No	No

Load Items

This section describes the load items.

Business Overview

The primary use of loading items Web service is to refresh already selected PO items records.

Service Type

Get

ReST URL

/PurchaseOrders/item/load?item=item&supplier={supplier}&locations={locations}

Input Parameters

Parameter Name	Required	Description
Items	Yes	Comma Separated values for selected items' ID.
Supplier	No	Selected Supplier ID.
Locations	No	Comma Separated values for selected locations' ID.

Output

Values of the following columns:

• Item

• Item Description

• Department

• Supplier

• Origin Country Id

• Supplier Pack Size

• Unit Cost

• Supplier Currency

• Base Unit Retail

• Base Retail Currency

• Base Retail UOM

• Item Image URL

• Locations Table

  • Location

  • Location Type

  • Item Location Status

  • Unit Retail

  • Unit Retail Currency

  • Unit Retail UOM

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
DAILY_PURGE	Yes	No	No	No
DEPS	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_IMAGE	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
ITEM_SUPPLIER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
MV_CURRENCY_CONVERSION_RATES	Yes	No	No	No
RPM_MERCH_RETAIL_DEF_EXPL	Yes	No	No	No
RPM_ZONE	Yes	No	No	No
V_ITEM_MASTER	Yes	No	No	No
V_PACKSKU_QTY	Yes	No	No	No
V_SUPS	Yes	No	No	No
WH	Yes	No	No	No

Search Location

This section describes the Search Location service.

Business Overview

The Web service enables location search applicable for PO. Location can be searched by either 'S'tore or 'W'arehouse. Enter a location number, a partial location number, a location description, or a partial location description in the search string.

The locations returned are constrained by the following criteria:

• Only stockholding locations are returned.

• When search type is Warehouse then:

  • Only virtual warehouses are returned.

  • Internal finishers are filtered out.

• When search type is store then only the following stores are returned:

  • Company stores.

  • Open stores.

• When system_options.org_unit_ind is set as 'Y' then:

  • When supplier is sent as input then only locations with same org_unit_id are returned.

  • When Org Unit ID is sent as input then only locations with same org_unit_id are returned.

Service Type

Get

ReST URL

/PurchaseOrders/location?locationType={locationType}&searchString={searchString}&supplier={supplier}&orgUnitId={orgUnitId}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description	Valid values
LocationType	Yes	Location type Store or warehouse.	S, W
SearchString	Yes	Search string for locations Id or Name.	NA
Supplier	No	Selected Supplier ID.	NA
OrgUnitId	No	Selected locations' Org unit ID.	NA
PageSize	No	Maximum number of locations to retrieve per page.	NA
PageNumber	No	Result page to retrieve.	NA

Output

Values of the following columns:

• Location

• Location Type

• Location Name

• Location Currency

• Org Unit Id

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
PARTNER_ORG_UNIT	Yes	No	No	No
V_STORE	Yes	No	No	No
V_WH	Yes	No	No	No
WH	Yes	No	No	No

Load Locations

This section describes the Load Locations service.

Business Overview

This Web service allows the user to refresh already selected PO locations records.

Service Type

Get

ReST URL

/PurchaseOrders/location/load?locations={locations}&supplier={supplier}

Input Parameters

Parameter Name	Required	Description
Locations	Yes	Comma Separated values for selected locations' ID.
Supplier	No	Selected Supplier ID.

Output

Values of the following columns:

• Location

• Location Type

• Location Name

• Location Currency

• Org Unit Id

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
PARTNER_ORG_UNIT	Yes	No	No	No
V_STORE	Yes	No	No	No
V_WH	Yes	No	No	No
WH	Yes	No	No	No

Create Purchase Order

This section describes the Create Purchase Order service.

Business Overview

This Web service calls the existing RMS XOrder API directly with input parameters. For more information on RMS XOrder API, see the sections addressing both the Store Order Subscription API and the PO Subscription API.

Service Type

Post

ReST URL

/PurchaseOrders

Input Parameters

Example json RDO input:

{
         "links" : [ ],
          "itemRDOs" : [ {
            "links" : [ ],
           "item" : null,
           "location" :null,
            "unitCost" : null,
            "referenceItem" : null,
            "originCountryId" : null,
            "suppPackSize" : null,
            "qtyOrdered" : null,
            "locationType" : null,
            "cancelInd" : null,
            "reInstateInd" : null,
            "hyperMediaContent" : {
              "linkRDO" : [ ]
            }
          } ],
          "orderNo" : null,
          "supplier" : null,
          "currencyCode" : null,
          "terms" : null,
          "notBeforeDate" : null,
          "notAfterDate" : null,
          "status" : "A",
          "writtenDate" : null,
          "origInd" : null,
          "user_id" : null,
          "dept" : null,
          "exchangeRate" : null,
          "includeOnOrdInd" : null,
          "ediPoInd" : null,
          "preMarkInd" : null,
          "comment" : null,
          "otbEowDate" : null,
          "hyperMediaContent" : {
            "linkRDO" : [ ]
          }
        }

Output

NA

Table Impact

For more information on RMS XOrder API, see the Store Order Subscription API and the PO Subscription API sections.

Recent Inventory Transfer Services

This section describes the Recent Inventory Transfer services.

Functional Area

Inventory Movement

Business Overview

The primary role of these services is to approve or reject RMS's transfers.

Transfer Location Search

This section describes the transfer location search service.

Business Overview

The web service enables location search applicable for Transfers. Locations can be searched by either 'S'tore or 'W'arehouse, with the subsequent entry of a location number, a partial location number, a location description, or a partial location description in the search string.

The locations returned are constrained by the following criteria:

• When search type is warehouse then:

  • Internal finishers are filtered out

• When search type is store then:

  • Only company stores are returned

  • Only stockholding stores are returned

Service Type

Get

ReST URL

/Transfer/recent/transferLocSearch?searchString={searchString}&locType={locType}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description	Valid values
SearchString	No	search string for locations Id or Name	NA
LocType	No	Location type Store or warehouse	S, W
PageSize	No	Maximum number of locations to retrieve per page	NA
PageNumber	No	Result page to retrieve	NA

Output

• Location

• Location Type

• Location Name

• Location Currency

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_STORE	Yes	No	No	No
V_WH	Yes	No	No	No

Transfer Location Load

This section describes the Transfer Location Load service.

Business Overview

This web service allows the user to refresh already selected Transfer locations records.

Service Type

Get

ReST URL

/Transfer/recent/transferLocationLoad?locations={locations}

Input Parameters

Parameter Name	Required	Description
Locations	No	Comma Separated values for selected locations' ID

Output

• Location

• Location Type

• Location Name

• Location Currency

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_STORE	Yes	No	No	No
V_WH	Yes	No	No	No

Transfer Status List

This section describes the Transfer Status List service.

Business Overview

Retrieves all valid transfer statuses.

Service Type

Get

ReST URL

/ Transfer/recent/ transferStatusList

Input Parameters

No input.

Output

• Transfer Status Code

• Transfer Status Description

• Code Sequence

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
CODE_HEAD	Yes	No	No	No
CODE_DETAIL	Yes	No	No	No

Transfer Type List

This section describes the Transfer Type List service.

Business Overview

Retrieves all valid transfer types.

Service Type

Get

ReST URL

/ Transfer/recent/transferTypeList

Input Parameters

No input.

Output

• Transfer Type Code

• Transfer Type Description

• Code Sequence

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
CODE_HEAD	Yes	No	No	No
CODE_DETAIL	Yes	No	No	No

Search Transfer User IDs

This section describes the Search Transfer User IDs.

Business Overview

The Search Transfer User IDs service retrieves for all User IDs that created transfers.

Service Type

Get

ReST URL

/Transfer/recent/searchUserIds?searchString={searchString}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description
SearchString	Yes	search string for User Id
PageSize	No	Maximum number of transfer user IDs to retrieve per page
PageNumber	No	Result page to retrieve

Output

• Transfer User ID

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_TSFHEAD	Yes	No	No	No

Transfer Search

This section describes the Transfer Search service.

Business Overview

The web services in this area enables search for applicable transfers. Transfers can be searched by their status, transfer types, transfer number, create date, delivery date, create ID, item department and/or locations.The transfers returned are constrained by the following criteria:

• Customer Orders and Book Transfers are filtered out.

• Only Transfers with transfer details are returned.

Service Type

Get

ReST URL

/Transfer/recent/transferSearch?statuses={statuses}&transferTypes={transferTypes}&createIds={createIds}&startCreateDate={startCreateDate}&endCreateDate={endCreateDate}&startDeliveryDate={startDeliveryDate}&endDeliveryDate={endDeliveryDate}&transferNumber={transferNumber}&locations={locations}&departments={departments}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description	Valid values
Statuses	No	Comma Separated values for selected transfer statuses
TransferTypes	No	Comma Separated values for selected transfer types
CreateIds	No	Comma Separated values for selected transfer create ID
StartCreateDate	No	Start of the range of transfer create dates
EndCreateDate	No	End of the range of transfer create dates
StartDeliveryDate	No	Start of the range of transfer create dates
EndDeliveryDate	No	End of the range of transfer create dates
TransferNumber	No	Transfer Number
Locations	No	Comma Separated values for selected Location IDs
Departments	No	Comma Separated values for selected Department IDs
PageSize	No	Maximum number of locations to retrieve per page
PageNumber	No	Result page to retrieve

Output

• Transfer Number

• Transfer Type

• From Location

• From Location Type

• From Location Name

• To Location

• To Location Type

• To Location Name

• Status

• Total Cost

• Currency Code

• Delivery Date

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DLEETE
ITEM_LOC_SOH	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
TSFDETAIL	Yes	No	No	No
TSFITEM_INV_FLOW	Yes	No	No	No
V_STORE	Yes	No	No	No
V_TSFDETAIL	Yes	No	No	No
V_TSFHEAD	Yes	No	No	No
V_WH	Yes	No	No	No

Get Transfer Detail

This section describes the Get Transfer Detail service.

Business Overview

Get Transfer Detail service allow user to retrieve Transfer information for a selected transfer number.

Service Type

Get

ReST URL

/Transfer/recent/transferDetail?transferNumber={transferNumber}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description
TransferNumber	Yes	Transfer Number ID
PageSize	No	Maximum number of items to retrieve per page
PageNumber	No	Result page to retrieve

Output

• Transfer Number

• Status

• From Location

• From Location Name

• Finisher: only populated when transfer is a multi-legged transfer

• Finisher Name: only populated when transfer is a multi-legged transfer

• To Location

• To Location Name

• Transfer Type

• Total Cost

• Total Retail

• Currency Code

• Delivery Date

• Create ID

• Create Date

• Transfer Items Table

• Item

• Item Description

• Transfer Quantity

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ITEM_LOC	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No
TSF_ITEM_INV_FLOW	Yes	No	No	No
V_EXTERNAL_FINISHER	Yes	No	No	No
V_INTERNAL_FINISHER	Yes	No	No	No
V_ITEM_MASTER	Yes	No	No	No
V_LOCATION	Yes	No	No	No
V_STORE	Yes	No	No	No
V_TSFDETAIL	Yes	No	No	No
V_TSFHEAD	Yes	No	No	No
V_WH	Yes	No	No	No

Update Transfer Status

This section describes the Update Transfer Status service.

Business Overview

The web service approves or unapproves a transfer or a list of transfers.

Service Type

Post

ReST URL

/Transfer/recent/updateTransferStatus?newStatus={newStatus}&transferNumbers={transferNumbers}

Input Parameters

Parameter Name	Required	Description	Valid values
NewStatus	Yes	New status of the transfer. May only be 'A'pproved or 'I'nput.	A, I
TransferNumbers	Yes	Comma Separated values for selected locations' ID

Output

NA

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
TSFHEAD	Yes	No	Yes	No
TSFDETAIL	Yes	Yes	Yes	Yes
ITEM_LOC	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	Yes	No
ITEM_MASTER	Yes	No	No	No
PACKITEM_BREAKOUT	Yes	No	No	No
STORE	Yes	No	No	No
SYSTEM_OPTIONS	Yes	No	No	No
V_TSFHEAD	Yes	No	No	No
WH	Yes	No	No	No

Recent Purchase Order Services

This section describes the Recent Purchase Order services.

Functional Area

Procurement

Business Overview

The primary role of this service is to approve, reject, or cancel RMS's purchase orders.

Cancel Reason Code List

This section describes the Cancel Reason Code List service.

Business Overview

Retrieves all purchase order cancel reason codes.

Service Type

Get

ReST URL

/PurchaseOrders/recent/cancelReasonCodeList

Input Parameters

No input.

Output

• Code

• Code Description

• Code Sequence

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
CODE_HEAD	Yes	No	No	No
CODE_DETAIL	Yes	No	No	No

Origin Code List

This section describes the Origin Code List service.

Business Overview

Retrieves all purchase order origin codes.

Service Type

Get

ReST URL

/PurchaseOrders/recent/originCodeList

Input Parameters

No input.

Output

• Code

• Code Description

• Code Sequence

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
CODE_HEAD	Yes	No	No	No
CODE_DETAIL	Yes	No	No	No

Purchase Order Status List

This section describes the Purchase Order Status list.

Business Overview

Retrieves all valid purchase order statuses.

Service Type

Get

ReST URL

/PurchaseOrders/recent/purchaseOrderStatusList

Input Parameters

No input.

Output

• Status Code

• Code Description

• Code Sequence

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
CODE_HEAD	Yes	No	No	No
CODE_DETAIL	Yes	No	No	No

Search Purchase Order User ID

This section describes the Search Purchase Order User ID.

Business Overview

This service retrieves a list of user IDs associated with creating a purchase order.

Service Type

Get

ReST URL

/PurchaseOrders/recent/searchUserIds?searchString={searchString}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

• Search String - Required

• Page Size - Optional

• Page Number - Optional

Output

• ID

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_ORDHEAD	Yes	No	No	No

Purchase Order Search

This section describes the Purchase Order Search service.

Business Overview

This service retrieves summary information on all none closed purchase orders that match input criteria.

Service Type

Get

ReST URL

/PurchaseOrders/recent/purchaseOrderSearch?statuses={statuses}&createIds={createIds}&startCreateDate={startCreateDate}&endCreateDate={endCreateDate}&orderNumber={orderNumber}&suppliers={suppliers}&originCodes={originCodes}&departments={departments}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description	Valid values
statuses	No	List of order status	A, S, W
createIds	No	List of user IDs who created the PO
startCreateDate	No	Long format date for starting period
endCreateDate	No	Long format date for end period
orderNumber	No	Order number to retrieve
suppliers	No	List of order suppliers
originCodes	No	List of valid Origin codes
departments	No	List of valid order/item departments
pageSize		Maximum number of orders to retrieve per page
pageNumber		Result page to retrieve

Output

• Order Number

• Status

• Supplier

• Supplier Name

• Not Before Date

• Not After Date

• Total Cost

• Currency

• Previously Approved Indicator

• Editable Indicator

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ITEM_MASTER	Yes	No	No	No
PRODUCT_CONFIG_OPTIONS	Yes	No	No	No
V_ORDHEAD	Yes	No	No	No
V_ORDSKU	Yes	No	No	No
V_SUPS	Yes	No	No	No

Get Purchase Order Summary

This section describes the Get Purchase Order Summary service.

Business Overview

This service retrieves purchase order header detail with open to buy information.

Service Type

Get

ReST URL

/PurchaseOrders/recent/PurchaseOrderSummary?orderNumber={orderNumber}

Input Parameters

Order Number-Required

Output

• Order Number

• Status

• Supplier

• Supplier Name

• Not Before Date

• Not After Date

• OTB EOW Date

• Terms

• Terms Code

• Terms Description

• Total Cost

• Total Retail

• Currency

• Create Id

• Written Date

• Default Display Level

• Previously Approved Indicator

• Editable Indicator

• OTB Table

  • Department

  • Class ID

  • Subclass ID

• Subclass Name

  • Order Amount

  • Budget Amount

  • Received Amount

  • Approved Amount

  • Outstanding Amount

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
COST_ZONE_GROUP_LOC	Yes	No	No	No
COUNTRY_ATTRIB	Yes	No	No	No
DEPS	Yes	No	No	No
ELC_COMP	Yes	No	No	No
ITEM_COST_HEAD	Yes	No	No	No
ITEM_EXP_DETAIL	Yes	No	No	No
ITEM_EXP_HEAD	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
MV_CURRENCY_CONVERSION_RATES	Yes	No	No	No
ORDHEAD	Yes	No	No	No
ORDLOC	Yes	No	No	No
ORDLOC_EXP	Yes	No	No	No
ORDSKU	Yes	No	No	No
ORDSKU_HTS	Yes	No	No	No
ORDSKU_HTS_ASSESS	Yes	No	No	No
OTB	Yes	No	No	No
PERIOD	Yes	No	No	No
PRODUCT_CONFIG_OPTIONS	Yes	No	No	No
STORE	Yes	No	No	No
SUPS	Yes	No	No	No
V_ORDHEAD	Yes	No	No	No
V_PACKSKU_QTY	Yes	No	No	No
V_SUBCLASS_TL	Yes	No	No	No
V_SUPS	Yes	No	No	No
V_TERMS_HEAD_TL	Yes	No	No	No
WH	Yes	No	No	No

Get Purchase Order Items

This section describes the Get Purchase Order Items service.

Business Overview

This service retrieves items details for an order number. Based on the display level, the items record aggregates to the level specified when applicable.

Service Type

Get

ReST URL

/PurchaseOrders/recent/PurchaseOrderItems?orderNumber={orderNumber}&itemDisplayLevel={itemDisplayLevel}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Order Number - Required

Item Display Level - Optional - valid values PARENT_LEVEL, PARENT_DIFF_LEVEL, or TRAN_LEVEL

Page Size - Optional

Page Number - Optional

Output

• Item

• Item Description

• Diff1

• Diff1 Description

• Diff2

• Diff2 Description

• Diff3

• Diff3 Description

• Diff4

• Diff4 Description

• Quantity Ordered

• Total Cost

• Currency

• Item Image URL

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ITEM_IMAGE	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
ORDLOC	Yes	No	No	No
ORDSKU	Yes	No	No	No
ORDLOC_WKSHT	Yes	No	No	No
V_ITEM_MASTER	Yes	No	No	No

Get Purchase Order Item Locations

This section describes the Get Purchase Order Item Locations service.

Business Overview

This service retrieves item location details for an order number. The location record aggregates based on the display level when applicable.

Service Type

Get

ReST URL

/PurchaseOrders/recent/PurchaseOrderItemLocations?orderNumber={orderNumber}&item={item}&itemDisplayLevel={itemDisplayLevel}&diff1={diff1}&diff2={diff2}&diff3={diff3}&diff4={diff4}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description	Valid values
orderNumber	Yes	Order number
item	Yes	Item Id
itemDisplayLevel	No	Item display level	PARENT_LEVEL PARENT_DIFF_LEVEL TRAN_LEVEL
diff1	No	Diff1 Id
diff2	No	Diff2 Id
diff3	No	Diff3 Id
diff4	No	Diff4 Id
pageSize	No	Maximum number of items to retrieve per page
pageNumber	No	Result page to retrieve

Output

• Location

• Location Name

• Quantity Ordered

• Total Cost

• Currency

• Total Record Count

• Next Page URL

• Previous Page URL

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ITEM_MASTER	Yes	No	No	No
ORDLOC	Yes	No	No	No
V_STORE_TL	Yes	No	No	No
V_WH_TL	Yes	No	No	No

Update Purchase Orders Date

This section describes the Update Purchase Orders Date service.

Business Overview

This service update list of purchase order dates. If no date is sent or sent as null then the assumption is there is no change on the current record date.

Service Type

Post

ReST URL

/PurchaseOrders/recent/updatePurchaseOrderDate?notBeforeDate={notBeforeDate}&notAfterDate={notAfterDate}&otbEowDate={otbEowDate}&orderNumbers={orderNumbers}

Input Parameters

Order Numbers - Required - comma separated list

Not Before Date - Optional - in a long format

Not After Date - Optional - in a long format

OTB EWO Date - Optional - in a long format

Output

• Success Orders Count

• Success Orders Table

  • Order Number

• Fail Orders Count

• Fail Orders Table

  • Order Number

• Error Message

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_HEADER	No	No	Yes	No
CONTRACT_HEADER	Yes	No	No	No
DEAL_HEAD	Yes	No	Yes	No
ORDHEAD	Yes	No	Yes	No
OTB	No	No	Yes	No
SHIPMENT	Yes	No	No	No
SYSTEM_OPTIONS	Yes	No	No	No

Cancel Purchase Orders

This section describes the Cancel Purchase Orders service.

Business Overview

This service cancels a list of purchase order.

Service Type

Post

ReST URL

/PurchaseOrders/recent/cancelPurchaseOrders?orderNumbers={orderNumbers}

Input Parameters

Order Number -Required-comma separated list

Output

• Success Orders Count

• Success Orders Table

  • Order Number

• Fail Orders Count

• Fail Orders Table

  • Order Number

• Error Message

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_DETAIL	Yes	No	Yes	No
ALLOC_HEADER	Yes	No	Yes	No
APPT_DETAIL	Yes	No	No	No
APPT_HEAD	Yes	No	No	No
CODE_DETAIL	Yes	No	No	No
DEAL_CALC_QUEUE	No	No	No	Yes
ORDHEAD	Yes	No	Yes	No
ORDLOC	Yes	No	Yes	No
OTB	No	No	Yes	No
SHIPMENT	Yes	No	Yes	No
SHIPSKU	Yes	No	Yes	No
SYSTEM_OPTIONS	Yes	No	No	No
WH	Yes	No	No	No

Approve Purchase Orders

This section describes the Approve Purchase Orders service.

Business Overview

This service approves a list of purchase orders.

Service Type

Post

ReST URL

/PurchaseOrders/recent/cancelPurchaseOrders?orderNumbers={orderNumbers}

Input Parameters

Order Number -Required-comma separated list

Output

• Success Orders Count

• Success Orders Table

  • Order Number

• Fail Orders Count

• Fail Orders Table

  • Order Number

• Error Message

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALC_HEAD_TEMP	No	No	No	Yes
ALLOC_CHRG_TEMP	No	No	No	Yes
ALLOC_DETAIL	Yes	No	Yes	No
ALLOC_DETAIL_TEMP	No	No	No	Yes
ALLOC_HEADER	Yes	No	Yes	No
ALLOC_HEADER_TEMP	No	No	No	Yes
CONTRACT_COST_HIST	Yes	Yes	No	No
CONTRACT_DETAIL	Yes	No	Yes	No
CONTRACT_HEADER	Yes	No	Yes	No
DEAL_ACTUALS_FORECAST	No	No	No	Yes
DEAL_ACTUALS_ITEM_LOC	No	No	No	Yes
DEAL_COMP_PROM	No	No	No	Yes
DEAL_DETAIL	No	No	No	Yes
DEAL_HEAD	No	No	No	Yes
DEAL_HEAD_CFA_EXT	No	No	No	Yes
DEAL_ITEMLOC_DCS	No	No	No	Yes
DEAL_ITEMLOC_DIV_GRP	No	No	No	Yes
DEAL_ITEMLOC_ITEM	No	No	No	Yes
DEAL_ITEMLOC_PARENT_DIFF	No	No	No	Yes
DEAL_QUEUE	No	No	No	Yes
DEAL_THRESHOLD	No	No	No	Yes
DEAL_THRESHOLD_REV	No	No	No	Yes
DOC	Yes	No	No	No
DOC_LINK	Yes	No	No	No
ITEM_LOC	Yes	No	Yes	No
ITEM_MASTER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
ITEM_TICKET	Yes	No	No	No
LC_ACTIVITY	Yes	No	No	No
LC_AMENDMENTS	Yes	Yes	No	No
LC_DETAIL	Yes	Yes	No	No
LC_HEAD	Yes	No	Yes	No
LC_ORDAPPLY	No	Yes	No	Yes
ORD_INV_MGMT	Yes	No	No	Yes
ORD_LC_AMENDMENTS	Yes	No	No	Yes
ORDCUST	Yes	No	No	No
ORDCUST_DETAIL	Yes	Yes	No	Yes
ORDDIST_ITEM_TEMP	No	No	No	Yes
ORDHEAD	Yes	No	No	No
ORDHEAD_REV	No	Yes	No	No
ORDLC	Yes	No	Yes	No
ORDLOC	Yes	No	Yes	No
ORDLOC_DISCOUNT	No	No	No	Yes
ORDLOC_DISCOUNT_TEMP	No	No	No	Yes
ORDLOC_EXP_TEMP	No	No	No	Yes
ORDLOC_REV	No	Yes	No	No
ORDLOC_TEMP	No	No	No	Yes
ORDLOC_WKSHT	Yes	No	No	Yes
ORDSKU	Yes	No	No	No
ORDSKU_HTS	Yes	No	No	No
ORDSKU_HTS_ASSESS_TEMP	No	No	No	Yes
ORDSKU_HTS_TEMP	No	No	No	Yes
ORDSKU_REV	No	Yes	No	No
ORDSKU_TEMP	No	No	No	Yes
OTB	Yes	Yes	Yes	No
OTB_CASCADE_STG	No	Yes	No	No
PARTNER_ORG_UNIT	Yes	No	No	No
POP_TERMS_DEF	No	No	No	Yes
POP_TERMS_FULFILLMENT	No	No	No	Yes
PROCUREMENT_UNIT_OPTIONS	Yes	No	No	No
REPL_RESULTS_TEMP	No	No	No	Yes
REQ_DOC	Yes	Yes	No	No
REQ_DOC_TEMP	No	No	No	Yes
REV_ORDERS	No	No	No	Yes
RTM_UNIT_OPTIONS	Yes	No	No	No
STORE	Yes	No	No	No
SUP_AVAIL	Yes	No	Yes	No
SUPS	Yes	No	No	No
SYSTEM_CONFIG_OPTIONS	Yes	No	No	No
TAX_CALC_EVENT	Yes	Yes	No	No
TAX_EVENT_RUN_TYPE	Yes	No	No	No
TICKET_REQUEST	No	Yes	No	No
TIMELINE_TEMP	No	No	No	Yes
TRANSIT_TIMES	Yes	No	No	No
V_PACKSKU_QTY	Yes	No	No	No
WH	Yes	No	No	No
WO_DETAIL_TEMP	No	No	No	Yes
WO_HEAD_TEMP	No	No	No	Yes

Reject Purchase Orders

This section describes the Reject Purchase Orders service.

Business Overview

This service rejects a list of purchase order.

Service Type

Post

ReST URL

/PurchaseOrders/recent/rejectPurchaseOrders?orderNumbers={orderNumbers}

Input Parameters

Order Numbers - Required - comma separated list

Output

• Success Orders Count

• Success Orders Table

  • Order Number

• Fail Orders Count

• Fail Orders Table

  • Order Number

• Error Message

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_DETAIL	No	No	Yes	No
ALLOC_HEADER	Yes	No	Yes	No
CONTRACT_DETAIL	Yes	No	Yes	No
CONTRACT_HEADER	Yes	No	Yes	No
ITEM_MASTER	Yes	No	No	No
LC_ORDAPPLY	No	No	No	Yes
ORDHEAD	Yes	No	Yes	No
ORDLOC	Yes	No	No	No
OTB	No	No	Yes	No
SHIPMENT	Yes	No	No	No
SHIPSKU	Yes	No	No	No
SYSTEM_OPTIONS	Yes	No	No	No

Replenishment Schedule Service

This section describes the Replenishment Schedule service.

Functional Area

Inventory Movement

Business Overview

The primary role of these services is to create, modify, and delete scheduled replenishments and send them to RMS.

Create Replenishment Schedule

This section describes the Create Replenishment Schedule service.

Business Overview

This service creates scheduled replenishments by calling the SVCPROV_REPL package to load input data to the staging tables and then calling the core replenishment package to validate and insert data to the RMS tables.

Service Type

Post

ReST URL

inventory/replenishment/createReplSched

Input Parameters

Example json RDO input:

[{"replAttrId": null,
  "schRplDesc": null,
  "scheduledActiveDate": null,
  "replAction": null,
  "item": null,
  "diff1": null,
  "diff2": null,
  "diff3": null,
  "diff4": null,
  "dept": null,
  "class1": null,
  "subclass": null,
  "loc": null,
  "locType": null,
  "autoRangeInd": null,
  "activateDate": null,
  "deactivateDate": null,
  "presStock": null,
  "demoStock": null,
  "stockCat": null,
  "replOrderCtrl": null,
  "sourcingWh": null,
  "supplier": null,
  "originCountryId": null,
  "pickupLeadTime": null,
  "whLeadTime": null,
  "replMethodInd": null,
  "replMethod": null,
  "minStock": null,
  "maxStock": null,
  "incrPct": null,
  "minSupplyDays": null,
  "maxSupplyDays": null,
  "timeSupplyHorizon": null,
  "addLeadTimeInd": null,
  "invSellingDays": null,
  "serviceLevelType": null,
  "serviceLevel": null,
  "serviceLevelFloatingStd": null,
  "lostSalesFactor": null,
  "terminalStockQty": null,
  "seasonId": null,
  "phaseId": null,
  "rejectStoreOrdInd": null,
  "multRunsPerDayInd": null,
  "tsfZeroSohInd": null,
  "nonScalingInd": null,
  "maxScaleValue": null,
  "sizeProfileInd": null,
  "reviewCycle": null,
  "updateDaysInd": null,
  "mondayInd": null,
  "tuesdayInd": null,
  "wednesdayInd": null,
  "thursdayInd": null,
  "fridayInd": null,
  "saturdayInd": null,
  "sundayInd": null,
  "primaryPackNo": null,
  "defaultPackInd": null,
  "removePackInd": null,
  "mraUpdate": null,
  "mraRestore": null}]

Output

The output will contain the status of the request including validation errors, if any.

Example json RDO output:

{
    "statusMsg": null,
    "failReplTable": [
        {
           "replAttrId": null,
           "item": null,
           "dept": null,
           "class1": null,
           "subclass": null,
           "loc": null,
           "locType": null,
           "effectiveDate": null,
           "errorMsg": null,
           "links": [],
           "hyperMediaContent": {
           "linkRDO": []
           }
        }
    ],
   "links": [],
   "hyperMediaContent": {
       "linkRDO": []
    }
  }

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
REPL_ATTR_UPDATE_HEAD	Yes	Yes	No	No
REPL_ATTR_UPDATE_ITEM	Yes	Yes	No	No
REPL_ATTR_UPDATE_LOC	Yes	Yes	No	No
SVC_PROCESS_TRACKER	Yes	Yes	Yes	No
CORESVC_REPL_ERR	No	Yes	No	No
SVC_REPL_ATTR_UPDATE	Yes	Yes	No	Yes
REPL_ITEM_LOC	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
SYSTEM_OPTIONS	Yes	No	No	No
V_STORE	Yes	No	No	No
V_WH	Yes	No	No	No

Modify Replenishment Schedule

This section describes the Modify Replenishment service.

Business Overview

This service modifies scheduled replenishments by calling the SVCPROV_REPL package to load input to the staging tables and then calling the core replenishment package to validate and process data to the RMS tables.

Service Type

Post

ReST URL

inventory/replenishment/modifyReplSched

Input Parameters

Example json RDO input:

[{"replAttrId": null,
  "schRplDesc": null,
  "scheduledActiveDate": null,
  "replAction": null,
  "item": null,
  "diff1": null,
  "diff2": null,
  "diff3": null,
  "diff4": null,
  "dept": null,
  "class1": null,
  "subclass": null,
  "loc": null,
  "locType": null,
  "autoRangeInd": null,
  "activateDate": null,
  "deactivateDate": null,
  "presStock": null,
  "demoStock": null,
  "stockCat": null,
  "replOrderCtrl": null,
  "sourcingWh": null,
  "supplier": null,
  "originCountryId": null,
  "pickupLeadTime": null,
  "whLeadTime": null,
  "replMethodInd": null,
  "replMethod": null,
  "minStock": null,
  "maxStock": null,
  "incrPct": null,
  "minSupplyDays": null,
  "maxSupplyDays": null,
  "timeSupplyHorizon": null,
  "addLeadTimeInd": null,
  "invSellingDays": null,
  "serviceLevelType": null,
  "serviceLevel": null,
  "serviceLevelFloatingStd": null,
  "lostSalesFactor": null,
  "terminalStockQty": null,
  "seasonId": null,
  "phaseId": null,
  "rejectStoreOrdInd": null,
  "multRunsPerDayInd": null,
  "tsfZeroSohInd": null,
  "nonScalingInd": null,
  "maxScaleValue": null,
  "sizeProfileInd": null,
  "reviewCycle": null,
  "updateDaysInd": null,
  "mondayInd": null,
  "tuesdayInd": null,
  "wednesdayInd": null,
  "thursdayInd": null,
  "fridayInd": null,
  "saturdayInd": null,
  "sundayInd": null,
  "primaryPackNo": null,
  "defaultPackInd": null,
  "removePackInd": null,
  "mraUpdate": null,
  "mraRestore": null}]

Output

The output will contain the status of the request including validation errors, if any.

Example json RDO output:

{
   "statusMsg": null,
   "failReplTable": [
     {
          "replAttrId": null,
          "item": null,
          "dept": null,
          "class1": null,
          "subclass": null,
          "loc": null,
          "locType": null,
          "effectiveDate": null,
          "errorMsg": null,
          "links": [],
          "hyperMediaContent": {
          "linkRDO": []
          }
        }
        ],
        "links": [],
        "hyperMediaContent": {
            "linkRDO": []
        }
      }

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
REPL_ATTR_UPDATE_HEAD	Yes	Yes	No	No
REPL_ATTR_UPDATE_ITEM	Yes	Yes	No	No
REPL_ATTR_UPDATE_LOC	Yes	Yes	No	No
SVC_PROCESS_TRACKER	Yes	Yes	Yes	No
CORESVC_REPL_ERR	No	Yes	No	No
SVC_REPL_ATTR_UPDATE	Yes	Yes	No	Yes
REPL_ITEM_LOC	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
SYSTEM_OPTIONS	Yes	No	No	No
V_STORE	Yes	No	No	No
V_WH	Yes	No	No	No

Delete Replenishment Schedule

This section describes the Delete Replenishment Schedule service.

Business Overview

This service deletes scheduled replenishments by calling the SVCPROV_REPL package to load input to the staging tables and then calling the core replenishment package to validate and delete data from the RMS tables.

Service Type

Post

ReST URL

inventory/replenishment/deleteReplSched

Input Parameters

Example json RDO input:

[{"replAttrId": null,
  "item": null,
  "dept": null,
  "class1": null,
  "subclass": null,
  "loc": null,
  "locType": null}]

Output

The output will contain the status of the request including validation errors, if any.

Example json RDO output:

{
   "statusMsg": null,
   "failReplTable": [
     {
          "replAttrId": null,
          "item": null,
          "dept": null,
          "class1": null,
          "subclass": null,
          "loc": null,
          "locType": null,
          "effectiveDate": null,
          "errorMsg": null,
          "links": [],
          "hyperMediaContent": {
          "linkRDO": []
          }
        }
    ],
    "links": [],
    "hyperMediaContent": {
        "linkRDO": []
    }
  }

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
REPL_ATTR_UPDATE_HEAD	Yes	Yes	No	Yes
REPL_ATTR_UPDATE_ITEM	Yes	Yes	No	Yes
REPL_ATTR_UPDATE_LOC	Yes	Yes	No	Yes
SVC_PROCESS_TRACKER	Yes	Yes	Yes	No
CORESVC_REPL_ERR	No	Yes	No	No
SVC_REPL_ATTR_UPDATE	Yes	Yes	No	Yes

Background Process Configuration

This section describes the Background Process Configuration.

Business Overview

This service is used to update the configuration for each background jobs in RMS.

Service Type

Post

ReST URL

processes/update/process_config/execution

Input Parameters

Parameter Name	Required	Description
JobName	Yes	Job Name
numThreads	No	Maximum number of threads the job will execute
numDataToProcess	No	Number of records a jobs will process each run.
commitMaxCtr	No	Max number of records processed before a commit is issued.

Output

NA

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
B8D_PROCESS_CONFIG	No	No	Yes	No

Purchase Order Detail Service

This section describes the Purchase Order Detail Service.

Business Overview

Purchase Order Detail service allows user to retrieve purchase order information for a selected order.

Service Type

Get

ReST URL

Po/poDetail?orderNumber={orderNumber}

Input Parameters

Parameter Name	Required	Description
Order Number	Yes	Order Number

Output

• Purchase Order

• Order Number

• Order Type

• Group

• Division

• Dept

• Buyer

• Supplier

• Supplier Status

• Location Type

• Location

• Written Date

• Not Before Date

• Not After Date

• OTB End of Week Date

• Earliest Ship Date

• Latest Ship Date

• Close Date

• Terms

• Freight terms

• Origin Indicator

• Shipment Method

• Purchase Type

• Status

• Currency Code

• Master Purchase Order Number

Ordsku, Ordloc

• Item

• Reference Item

• Origin Country Id

• Earliest Ship Date

• Latest Ship Date

• Supplier Pack Size

• Location

• Location Type

• Physical Warehouse

• Unit Retail

• Quantity Ordered

• Quantity Prescaled

• Quantity Received

• Last Received Quantity

• Last Round Quantity

• Last Group Rounded Quantity

• Quantity Cancelled

• Cancel Code

• Cancel Date

• Unit Cost

• Cost Source

• Non Scale Indicator

• Estimated Stock Date

• Ordloc Expenses

• Item

• Pack Item

• Location

• Location Type

• Component Id

• Component Description

• Always Default Indicator

• Component Rate

• Component Currency

• Exchange Rate

• Estimated Expense Value

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ORDHEAD	Yes	No	No	No
ORDLOC	Yes	No	No	No
ORDSKU	Yes	No	No	No
ORDLOC_EXPENSES	Yes	No	No	No
V_DEPS	Yes	No	No	No
SUPS	Yes	No	No	No
WH	Yes	No	No	No
ELC_COMP	Yes	No	No	No

Shipment Detail Service

This section describes the Shipment Detail Service.

Business Overview

Shipment Detail service allows user to retrieve shipment and shipment item details for a given distro (transfer or allocation) or purchase order (PO).

Service Type

Get

ReST URL

Shipment/shipmentDetail?orderNumber={orderNumber}&distroNumber={distroNumber}&distroType={distroType}

Input Parameters

Parameter Name	Required	Description
orderNumber	No	Order Number. If none is specified, then Distro Number and Distro Type are required.
distroNumber	No	Distro Number. If none is specified, then Order Number is required.
distroType	No	Distro Type. If none is specified, then Order Number is required.

Output

• Shipment

• Bol Number

• ASN

• Ship Date

• Receive Date

• Estimated Arrival Date

• Ship Origin

• Status Code

• To Location

• To Location Type

• From Location

• From Location Type

• Parent Shipment

• Sequence Number

• Item

• Reference Item

• Carton

• Inventory Status

• Ship Sku Status Code

• Quantity Received

• Unit Cost

• Unit Retail

• Quantity Expected

• Adjust Type

• Actual Receiving Store

• Reconcile User Id

• Reconcile Date

• Tampered Indicator

• Dispositioned Indicator

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_SHIPMENT	Yes	No	No	No
V_SHIPSKU	Yes	No	No	No

Allocation Detail Service

This section describes the Allocation Detail service.

Business Overview

Allocation Detail service allows user to retrieve Allocation information for a selected allocation number.

Service Type

Get

ReST URL

Alloc/allocDetail?allocNumber={allocationNumber}

Input Parameters

Parameter Name	Required	Description
allocNumber	Yes	Allocation Number

Output

• alloc_no

• order_no

• wh

• item

• status

• alloc_desc

• po_type

• alloc_method

• release_date

• order_type

• doc

• doc_type

• origin_ind

• close_date

• to_loc

• to_loc_type

• qty_transferred

• qty_allocated

• qty_prescaled

• qty_distro

• qty_selected

• qty_cancelled

• qty_received

• qty_reconciled

• po_rcvd_qty

• non_scale_ind

• in_store_date

• wf_order_no

• rush_flag

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_HEADER	Yes	No	No	No
ALLOC_DETAIL	Yes	No	No	No

Currency Rate Service

This section describes the Currency Rate service.

Business Overview

This service is used to retrieve all currencies and currency conversion rates. The conversion rate is the value used to convert to the primary currency.

Service Type

Get

ReST URL

CurrencyRates/currencyRates

Input Parameters

NA

Output

• currency_code

• effective_date

• exchange_type

• exchange_rate

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
CURRENCY_RATES	Yes	No	No	No

Diff Detail Service

This section describes the Diff Detail service.

Business Overview

Diff Detail service allows user to retrieve Diff description for a selected Diff Id.

Service Type

Get

ReST URL

DiffIds/diffIdDetail?diffId={diffId}

Input Parameters

Parameter Name	Required	Description
Diff_Id	Yes	Diff ID

Output

• Diff_desc

• Diff_type

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
DIFF_IDS	Yes	No	No	No

Item Detail Service

This section describes the Item Detail service.

Business Overview

Item Detail service allows user to retrieve Item information for a selected item.

Service Type

Get

ReST URL

Item/itemDetail?item={itemNumber}

Input Parameters

Parameter Name	Required	Description
Item	Yes	Item number

Output

• Item Grandparent

• Item Parent

• Item

• Item Description

• Short Description

• Pack Indicator

• Status

• Item Level

• Transaction Level

• Department

• Class

• Sublcass

• Diff 1

• Diff 2

• Diff 3

• Diff 4

• Primary Ref Item Indicator

• Original Retail

• Sellable Indicator

• Orderable Indicator

• Inventory Indicator

Packitem Breakout Table

• Sequence Number

• Item

• Pack Item Quantity

Item Supplier Table

• Supplier

• Primary Supplier Indicator

• VPN

• Direct Ship Indicator

Item Supplier Country Table

• Origin Country

• Primary Country Indicator

• Unit Cost

• Lead Time

• Pickup Lead Time

• Supplier Pack Size

• Inner Pack Size

Vat Item Table

• Vat Region

• Active Date

• Vat Type

• Vat Code

• Vat Rate

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_ITEM_MASTER	Yes	No	No	No
PACKITEM_BREAKOUT	Yes	No	No	No
ITEM_SUPPLIER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
VAT_ITEM	Yes	No	No	No

Item Loc Inventory Detail Service

This section describes the Item Loc Inventory Detail service.

Business Overview

Item Loc Inventory Detail service allows user to retrieve Item Location and Item Location Stock on Hand information for a selected item and location. If location and location type are not specified, all locations for the item will be retrieved. If location type is specified but not the location, all locations for the item and location type will be retrieved.

Service Type

Get

ReST URL

ItemlocInvDtl/itemlocInvDetail?item={itemNumber}&location={locationNumber}&locationType={locationType}

Input Parameters

Parameter Name	Required	Description
Item	Yes	Item ID
Location	No	Location ID.
Location Type	No	Location Type.

Output

• Item

• Item Parent

• Location

• Location Type

• Unit Retail

• Selling Unit Retail

• Selling UOM

• Clearance Indicator

• Taxable Indicator

• Local Item Description

• Local Short Description

• Status

• Primary Supplier

• Primary Country

• Average Cost

• Unit Cost

• Stock On Hand

• Stock On Hand Update Datetime

• In Transit Quantity

• Pack Component In Transit Quantity

• Pack Component Stock On Hand

• Transfer Reserved Quantity

• Pack Component Reserved Quantity

• Transfer Expected Quantity

• Pack Component Expected Quantity

• RTV Quantity

• Non Sellable Quantity

• Customer Reserve

• Customer Backorder

• Pack Component Customer Reserve

• Pack Component Customer Backorder

• Pack Component Non Sellable

• First Received

• Last Received

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_ITEM_LOC	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No

MerchHierarchy Detail Service

This section describes the MerchHierarchy Detail service.

Business Overview

MerchHierarchyDetail service allows user to retrieve full merchandising hierarchy information.

Service Type

Get

ReST URL

/MerchHierarchy/merchHierarchy

Input Parameters

NA

Output

• division

• div_name

• group_no

• group_name

• dept

• dept_name

• purchase_type

• class

• class_name

• subclass

• sub_name

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_MERCH_HIERARCHY	Yes	No	No	No

Reclass Detail Service

This section describes the Reclass Detail service.

Business Overview

This service is used to retrieve reclassification details for a given item.

Service Type

Get

ReST URL

Reclass/reclass?item={itemNumber}

Input Parameters

Parameter Name	Required	Description
Item	Yes	Item number

Output

• reclass_no

• reclass_desc

• reclass_date

• to_dept

• to_class

• to_subclass

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RECLASS_HEAD	Yes	No	No	No
RECLASS_ITEM	Yes	No	No	No

Stock Count Detail Service

This section describes the Stock Count Detail service.

Business Overview

Stock Count Detail service allows user to retrieve open stock count details for a given item and/or store.

Service Type

Get

ReST URL

StockCount/stockCountDetail?cycleCount={cycleCount}&locationType={locationType}&location={location}&item={item}&stocktakeDate={stocktakeDate}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description
Item	No	Item
Location	No	Location
Location Type	No	Location Type
Cycle Count	No	Cycle Count
Stocktake Date	No	Stocktake Date (always optional)

Output

• Cycle Count

• Cycle Count Description

• Stocktake Date

• Stocktake Type

• Stake Sku Location

  • Item

  • Location

  • Location Type

  • Snapshot On Hand Quantity

  • Snapshot In Transit Quantity

  • Snapshot Unit Cost

  • Snapshot Unit Retail

  • Processed

  • Physical Count Quantity

  • Pack Component Quantity

  • In Transit Amount

  • Deposit Item Type

  • Xform Item Type

  • Distribute Quantity

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
STAKE_HEAD	Yes	No	No	No
STAKE_SKU_LOC	Yes	No	No	No

Store Detail Service

This section describes the Store Detail service.

Business Overview

Store Detail service allows user to retrieve Store information for a selected store or for all stores.

Service Type

Get

ReST URL

Store/storeDetail?store={storeNumber}

Input Parameters

Parameter Name	Required	Description
Store	No	Store ID. If none is specified, all stores will be retrieved.

Output

• Store

• Store Name

• Store Name 10

• Store Name 3

• Store Name Secondary

• Store Class

• Store Open Date

• Store Close Date

• Acquired Date

• Remodel Date

• VAT Region

• VAT Include Indicator

• Stockholding Indicator

• Channel ID

• Transfer Zone

• Default Warehouse

• Stop Order Days

• Start Order Days

• Currency Code

• Language

• Duns Number

• Duns Location

• Sister Store

• Transfer Entity ID

• Organizational Unit ID

• Store Type

• Customer ID

• Timezone Name

• Customer Order Location Indicator

• Company

• Chain

• Area

• Region

• Distinct

• Address 1

• Address 2

• Address 3

• City

• State

• Country ID

• Post

• Contact Name

• Contact Phone

• Contact Email

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_STORE	Yes	No	No	No
STORE_HIERARCHY	Yes	No	No	No
ADDR	Yes	No	No	No

Supplier Detail Service

This section describes the Supplier Detail service.

Business Overview

Supplier Detail service allows user to retrieve Supplier information for a selected supplier.

Service Type

Get

ReST URL

Supplier/supplierDetail?supplierNumber={suppliernumber}

Input Parameters

Parameter Name	Required	Description
Supplier	Yes	Supplier number

Output

• supplier

• sup_name

• sup_name_secondary

• supplier_parent

• currency_code

• terms

• freight_terms

• vat_region

• external_ref_id

• add_1

• add_2

• add_3

• city

• state

• country_id

• post

• contact_name

• contact_phone

• contact_email

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
SUPS	Yes	No	No	No
ADDR	Yes	No	No	No

Transfer Detail Service

This section describes the Transfer Detail service.

Business Overview

Transfer Detail service allows user to retrieve details for a given transfer.

Service Type

Get

ReST URL

Transfer/transferDetail?transferNumber={transferNumber}

Input Parameters

Parameter Name	Required	Description
Transfer Number	Yes	Transfer number

Output

• Transfer Number

• Parent Transfer Number

• From Location Type

• From Location

• To Location Type

• To Location

• Expected DC Date

• Department

• Inventory Type

• Transfer Type

• Status

• Delivery Date

• Close Date

• Not After Date

• Context Type

• Context Value

• Franchise Order Number

• Transfer Detail Table

  • Transfer Sequence Number

  • Item

  • Inventory Status

  • Transfer Price

  • Transfer Quantity

  • Fill Quantity

  • Ship Quantity

  • Received Quantity

  • Reconciled Quantity

  • Distro Quantity

  • Selected Quantity

  • Cancelled Quantity

  • Supplier Pack Size

  • Transfer Cost

  • Publish Indicator

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
TSFHEAD	Yes	No	No	No
TSFDETAIL	Yes	No	No	No

VAT Detail Service

This section describes the VAT Detail service.

Business Overview

VAT Detail service allows user to retrieve VAT information for a selected department.

Service Type

Get

ReST URL

Vat/vatDetail?department={departmentNumber}

Input Parameters

Parameter Name	Required	Description
Department	Yes	Department ID

Output

• VAT Region

• VAT Region Name

• VAT Region Type

• VAT Type

• VAT Code

• VAT Code Description

• VAT Rate

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_DEPS	Yes	No	No	No
VAT_DEPS	Yes	No	No	No
VAT_REGION	Yes	No	No	No
V_VAT_REGION_TL	Yes	No	No	No
V_VAT_CODES_TL	Yes	No	No	No
VAT_CODE_RATES	Yes	No	No	No

Warehouse Detail Service

This section describes the Warehouse Detail service.

Business Overview

Warehouse Detail service allows user to retrieve Warehouse information for a selected warehouse or for all warehouses.

Service Type

Get

ReST URL

Wh/whDetail?warehouse={whNumber}

Input Parameters

Parameter Name	Required	Description
Warehouse	No	Warehouse Number. If none is specified, all warehouses will be retrieved.

Output

• Warehouse

• Warehouse

• Warehouse Name

• Warehouse Secondary Name

• VAT region

• Organization Hierarchy Type

• Organization Hierarchy Value

• Currency Code

• Physical Warehouse

• Primary Virtual Warehouse

• Channel ID

• Stockholding Indicator

• Break Pack Indicator

• Redistribute Warehouse Indicator

• Restricted Indicator

• Protected Indicator

• Transfer Entity Id

• Finisher Indicator

• Inbound Handling Days

• Organizational Unit ID

• Virtual Warehouse Type

• Customer Order Location Indicator

• Address

• Address 1

• Address 2

• Address 3

• City

• State

• Country ID

• Post

• Contact Name

• Contact Phone

• Contact Email

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_WH	Yes	No	No	No
ADDR	Yes	No	No	No