ReST APIs

3 ReST APIs

Manage Allocation

Functional Area

Foundation - Allocation

Business Overview

The service accepts a collection of Allocation data for use in AIF Data. It can be a single record or a collection of Allocation records.

Service Type

POST

ReST URL

RiRestService/services/foundation/allocation/manage

Input Payload Details

Table 3-1 Manage - Object. See list of elements for detail

Element Name	Required	Data Type	Description
count	Yes	Number (4)
items	Yes	Collection of Object

Table 3-2 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	Yes	String (30)	Identifies whether the data submitted is for INSERT, UPDATE or DELETE.
allocNo	Yes	String (30)	Number that uniquely identifies the allocation within the system.
orderNo	No	String (30)	This is the order number to which the allocation applies.
item	Yes	String (30)	This column contains a unique alphanumeric value that identifies the item.
allocStatus	Yes	String (1)	This is the status of the allocation. Valid values are:W = Worksheet R =Reserved A = Approved C = Closed X = Allocation is being externally closed Note: X is a dummy status only being used in integration processing and should never actually be saved to the table.
poType	No	String (4)	This is the value associated with the PO_TYPE for the order.
allocMethod	Yes	String (1)	This is the preferred allocation method, which is used to distribute goods when the stock received at a warehouse cannot immediately fill all requested allocations to stores. Valid values for this field are: A - Allocation quantity based P - Prorate method C - Custom
releaseDate	No	date	This is the date on which the allocation should be released from the warehouse for delivery to the store locations.
documentNo	No	String (30)	This field is the ASN or BOL number for an ASN or BOL sourced allocation. This will be populated for the product source of the tier one allocation.
docType	No	String (5)	This field is the type of allocation product source.
effectiveFromDt	No	date	This is the date from which the source record (in the Source system) is effective. The value is extracted from the source (whenever available)
effectiveToDt	No	date	This is the date up to which the source record (in the Source system) is effective. The value is extracted from the source (whenever available)
warehouse	No	String (30)	This is the Source warehouse for the allocation.
allocDesc	No	String (300)	This is the description of the allocation.
orderType	No	String (30)	This identifies the type of the order. Allocations created against Purchase Orders will be marked as PREDIST order types. Allocations created against Warehouse stock will be populated with AUTOMATIC, MANUAL or WAVE.
contextType	No	String (10)	This is the functional area code to which the transfer relates to, for example, Promotions. Valid values are: PROM - Promotion
contextValue	No	String (30)	This is the value relating to the context type, for example, Promotion Number.
commentDesc	No	String (300)	This is additional information concerning the allocation.
allocParent	No	Number (30)	This is the allocation number for all MLD allocations that are not the original product source.
originInd	No	String (10)	This identifies the origin point of the allocation. Valid values are: AIP, EG, RMS, ALC.
closeDate	No	date	This is the date when the allocation is closed.
details	Yes	Collection of Object	This holds the allocation details.

Table 3-3 Details - Object. See list of elements for detail

Element Name	Required	Data Type	Description
toLocation	Yes	String (30)	This column contains the location to which the allocation is being sent.
createDateTime	Yes	date-time	This column holds the allocation record business date.
averageCost	No	Number (20,4)	This field will contain the average cost for the SKU from the SKU/Location table.
quantityTransferred	No	Number (20,4)	This column contains the number of items that have already been transferred under this allocation.
quantityAllocated	No	Number (20,4)	This column contains the total number of items allocated.
quantityPrescaled	No	Number (20,4)	This column contains the allocation quantity (system generated or manually generated) for the item/location before order scaling processing was performed.
quantityDistro	No	Number (20,4)	This column contains the final quantity that the external system plans on filling.
quantitySelected	No	Number (20,4)	This column contains the initial quantity that the external system plans on filling.
quantityCancelled	No	Number (20,4)	This column contains the quantity that was left to be allocated when the line item was cancelled.
quantityReceived	No	Number (20,4)	This column contains the quantity of the item which has been received at the to location on the allocation.
quantityReconciled	No	Number (20,4)	This column contains the quantity received at another location for this allocated item.
poReceivedQty	No	Number (20,4)	This column tracks the quantity received against a cross-docked order. It is only used to distribute unallocated quantities that are received in a physical warehouse.
nonScaleInd	No	String (30)	This column determines if the item/locations allocation quantity should not be scaled during the order scaling process. Valid values include: Y - Yes. Fix the allocation quantity to ensure that the item/location allocation quantity is not adjusted during the order scaling process. N - No. Do not fix the allocation quantity to ensure that the item/location allocation quantity will be adjusted during the order scaling process.
inStoreDate	No	date	This column contains the date to be included in the RMS publication (Oracle Retail Service Layer) to the RIB for communication to the warehouse.
franchiseOrderNo	No	String (30)	This field holds the franchise order number this allocation detail line is linked to.
exchangeDate	No	date	This is the exchange date, identifying which date a currency conversion rate should be selected for.
docCurrencyCode	No	String (30)	Code for the currency in which the document was created in the source system.
locCurrencyCode	No	String (30)	Usually the reporting currency code for the financial company in which the document was created.
global1ExchangeRate	No	Number (22,7)	This is the exchange rate from Local currency to the first Global currency. The Global currencies are defined in the global currency master table.
global2ExchangeRate	No	Number (22,7)	This is the exchange rate from Local currency to the second Global currency. The Global currencies are defined in the global currency master table.
global3ExchangeRate	No	Number (22,7)	This is the exchange rate from Local currency to the third Global currency. The Global currencies are defined in the global currency master table.
locExchangeRate	No	Number (22,7)	This is the exchange rate from Local Currency to the Preferred Currency.

Table 3-4 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
allocNo	Yes	String (30)	Number that uniquely identifies the allocation within the system.
item	Yes	String (30)	This column contains a unique alphanumeric value that identifies the item.
toLocation	Yes	String (30)	This column contains the location to which the allocation is being sent.
message	Yes	String (2000)	Identifies error during business data processing of the request.

Sample Input Message

{
  "count": 1,
  "items": [
    {
      "action": "INSERT",
      "allocNo": "100001",
      "orderNo": "11000001",
      "item": "10200011",
      "allocStatus": "A",
      "poType": "N/B",
      "allocMethod": "A",
      "releaseDate": "2001-12-31",
      "documentNo": "100000140005",
      "docType": "T",
      "effectiveFromDt": "2001-12-31",
      "effectiveToDt": "2001-12-31",
      "warehouse": "String",
      "allocDesc": "String",
      "orderType": "PREDIST",
      "contextType": "PROM",
      "contextValue": "123",
      "commentDesc": "Allocation Comments",
      "allocParent": 339582,
      "originInd": "RMS",
      "closeDate": "2001-12-31",
      "details": [
        {
          "toLocation": "1122",
          "createDateTime": "2001-12-31T23:59:59.123Z",
          "averageCost": 12,
          "quantityTransferred": 10,
          "quantityAllocated": 12,
          "quantityPrescaled": 11,
          "quantityDistro": 10,
          "quantitySelected": 12,
          "quantityCancelled": 1,
          "quantityReceived": 12,
          "quantityReconciled": 1,
          "poReceivedQty": 12,
          "nonScaleInd": "Y",
          "inStoreDate": "2001-12-31",
          "franchiseOrderNo": "String",
          "exchangeDate": "2001-12-31",
          "docCurrencyCode": "USD",
          "locCurrencyCode": "USD",
          "global1ExchangeRate": 1,
          "global2ExchangeRate": 1,
          "global3ExchangeRate": 1,
          "locExchangeRate": 1
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service. The element businessError will be present if the payload passes schema validation but an exception is caught while processing the business logic.

Table 3-5 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
allocNo	Yes	String (30)	Number that uniquely identifies the allocation within the system.
item	Yes	String (30)	This column contains a unique alphanumeric value that identifies the item.
toLocation	Yes	String (30)	This column contains the location to which the allocation is being sent.
message	Yes	String (2000)	Identifies error during business data processing of the request.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    {
      "allocNo": "100001",
      "item": "10200011",
      "toLocation": "1122",
      "message": "One or more of the required fields is NULL example allocNo, item, toLocation"
    }
  ]
}

Manage Calendar

Functional Area

Foundation - Calendar

Business Overview

The service takes a collection of period records. It can be a single record or the complete calendar. As part of the subscription, the existing records (fiscalYear / period combination) will be overwritten if a record exists.

Service Type

POST

ReST URL

RiRestService/services/foundation/calendar/manage

Input Payload Details

Table 3-6 Manage - Object. See list of elements for detail

Element Name	Required	Data Type	Description
count	Yes	Number (4)
items	Yes	Collection of Object

Table 3-7 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	Yes	String (10)	Identifies whether the data submitted is for INSERT, UPDATE, DELETE or UPSERT.
fiscalYear	Yes	Number (4)	Identifies the fiscal year in YYYY format.
period	Yes	Number (4)	Period number within the fiscal year (usually 1 to 12)
periodName	Yes	String (240)	Name of the fiscal period.
periodStartDate	Yes	date	Identifies the first date of the period.
periodEndDate	Yes	date	Identifies the last date of the period.
weeksInPeriod	Yes	String (50)	Identifies the period type, such as 4 (for 4-week period) or 5 (for 5-week period)
quarter	Yes	Number (2)	Identifies the quarter of fiscal year to which this period belongs. Possible values are 1, 2, 3 and 4.
quarterStartDate	Yes	date	Identifies the start date of the fiscal quarter.
quarterEndDate	Yes	date	Identifies the end date of the fiscal quarter.
yearStartDate	Yes	date	Identifies the start date of the fiscal year.
yearEndDate	Yes	date	Identifies the end date of the fiscal year.

Table 3-8 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
fiscalYear	Yes	Number (4)	Identifies the fiscal year in YYYY format.
period	Yes	Number (4)	Period number within the fiscal year (usually 1 to 12)
message	Yes	String (2000)	Identifies error during business data processing of the request.

Sample Input Message

{
  "count": 1,
  "items": [
    {
      "action": "INSERT",
      "fiscalYear": 2025,
      "period": 2,
      "periodName": "Y25 - Period 02",
      "periodStartDate": "2001-12-31",
      "periodEndDate": "2001-12-31",
      "weeksInPeriod": "4",
      "quarter": 1,
      "quarterStartDate": "2001-12-31",
      "quarterEndDate": "2001-12-31",
      "yearStartDate": "2001-12-31",
      "yearEndDate": "2001-12-31"
    }
  ]
}

Response Code: 200 (Success)

Response Code: 400 (Error)

Table 3-9 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
fiscalYear	Yes	Number (4)	Identifies the fiscal year in YYYY format.
period	Yes	Number (4)	Period number within the fiscal year (usually 1 to 12)
message	Yes	String (2000)	Identifies error during business data processing of the request.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    {
      "fiscalYear": 2025,
      "period": 1,
      "message": "Invalid Period, value should be from 1 to 12"
    }
  ]
}

Manage Inventory

Functional Area

Foundation - Inventory

Business Overview

The service accepts a collection of inventory data for use in AIF Data. It can be a single record or a collection of inventory records.

Service Type

POST

ReST URL

RiRestService/services/foundation/inventory/manage

Input Payload Details

Table 3-10 Manage - Object. See list of elements for detail

Element Name	Required	Data Type	Description
count	Yes	Number (4)
items	Yes	Collection of Object

Table 3-11 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	Yes	String (10)	Identifies whether the data submitted is for INSERT, UPDATE or DELETE.
item	Yes	String (80)	External unique identifier for an item.
location	Yes	String (80)	The external identifier for a location, including stores, warehouses, and partner locations.
businessDate	Yes	date	Date on which the inventory position was recorded for.
clearanceFlg	Yes	String (1)	This indicates if inventory is on clearance with values of 'Y' for clearance price and 'N' for regular price.
invReplFlg	No	String (1)	This indicates if an item/location has replenishment attributes with values of 'Y' for yes and 'N' for no.
invReplMethodType	No	String (2)	This indicates the type of algorithm that is used to calculate the recommended order quanity with values of 'C' for constant, 'M' for minimum/maximum, 'F' for floating point, 'T' for time supply, 'D' for dynamic and 'SO' for store orders.
invReplIncrementPct	No	Number (12,4)	This percentage is multiplied by the minimum/maximum stock level to calculate the recommended order quanity.
customerResvQty	No	Number (18,4)	Customer Order Reserved Units
customerBackorderQty	No	Number (18,4)	Customer Back Order Reserved Units
stockOnHandQty	No	Number (18,4)	This is the quantity of owned inventory units. This includes inventory for pack component items.
stockOnHandCost	No	Number (20,4)	This is the cost value of owned inventory units. This includes inventory for pack component items. This is in local currency.
stockOnHandRetail	No	Number (20,4)	This is the retail value of owned inventory units. This includes inventory for pack component items. This is in local currency.
onOrderQty	No	Number (18,4)	This is the quantity of ordered inventory units that have not yet been received. This includes inventory for pack component items.
onOrderCost	No	Number (20,4)	This is the cost value of ordered inventory units that have not yet been received. This is in local currency.
onOrderRetail	No	Number (20,4)	This is the retail value of ordered inventory units that have not yet been received. This is in local currency.
inTransitQty	No	Number (18,4)	This is the quantity of transfer and allocation inventory units that have been shipped but not yet received. This includes inventory for pack component items.
inTransitCost	No	Number (20,4)	This is the cost value of transfer and allocation inventory units that have been shipped but not yet received. This includes inventory for pack component items. This is in local currency.
inTransitRetail	No	Number (20,4)	This is the retail value of transfer and allocation inventory units that have been shipped but not yet received. This includes inventory for pack component items. This is in local currency.
maxStockOnHandQty	No	Number (18,4)	This is the required maximum number of units available for sale figure used in replenishment method algorithms.
maxStockOnHandCost	No	Number (20,4)	This is the cost value of the required maximum number of units available for sale figure used in replenishment method algorithms. This is in local currency.
maxStockOnHandRetail	No	Number (20,4)	This is the retail value of the required maximum number of units available for sale figure used in replenishment method algorithms. This is in local currency.
minStockOnHandQty	No	Number (18,4)	This is the required minimum number of units available for sale figure used in replenishment method algorithms.
minStockOnHandCost	No	Number (20,4)	This is the cost value of the required minimum number of units available for sale figure used in replenishment method algorithms. This is in local currency.
minStockOnHandRetail	No	Number (20,4)	This is the retail value of the required minimum number of units available for sale figure used in replenishment method algorithms. This is in local currency.
tsfReservedQty	No	Number (18,4)	The sum of all requested quantities of an item that have not been shipped on all transfers and stand alone allocations for the source location.
tsfReservedCost	No	Number (20,4)	The total cost amount of all requested quantities of an item that have not been shipped on all transfers and stand alone allocations for the source location.
tsfReservedRetail	No	Number (20,4)	The total retail amount of all requested quantities of an item that have not been shipped on all transfers and stand alone allocations for the source location.
tsfExpectedQty	No	Number (18,4)	The sum of all expected quantities of an item that have not been shipped on all transfers and stand alone allocations for the destination location.
tsfExpectedCost	No	Number (20,4)	The total cost amount of all expected quantities of an item that have not been shipped on all transfers and stand alone allocations for the destination location.
tsfExpectedRetail	No	Number (20,4)	The total retail amount of all expected quantities of an item that have not been shipped on all transfers and stand alone allocations for the destination location.
rtvQty	No	Number (18,4)	The sum of all reserved quantities of an item that have not been shipped on RTVs for the source location.
rtvCost	No	Number (20,4)	The total cost amount all reserved quantities of an item that have not been shipped on RTVs for the source location.
rtvRetail	No	Number (20,4)	The total retail amount all reserved quantities of an item that have not been shipped on RTVs for the source location.
sellingUnitRetail	No	Number (20,4)	This is the retail value of a single inventory unit in the standard unit of measure. This is in local currency.
avCost	No	Number (20,4)	This is the weighted average cost of an item at a location and is based on the purchase order's estimated landed cost. This is adjusted each time inventory is received at this location. Stock of a pack item is valued at the component level and therefore an average cost is not applicable for pack items. This is in local currency.
unitCost	No	Number (20,4)	Depending on the RMS system options, this is the purchase order's estimated landed cost each time this item is received at this location or this is the primary supplier cost. This is in local currency.
finisherQty	No	Number (18,4)	The number of units of the adjusted item currently at the finisher.
purchaseType	No	String (50)	Identifies Purchase type. 0:Owned, 1:Consignment and 2:Concession.
docCurrCode	No	String (30)	Code for the currency in which the document was created in the source system.
locCurrCode	No	String (30)	Usually the reporting currency code for the financial company in which the document was created.
locExchangeRate	No	Number (22,7)	This is the exchange rate from Local Currency to the Preferred Currency.
global1ExchRate	No	Number (22,7)	This is the exchange rate from Local currency to the first Global currency. The Global currencies are defined in the global currency master table.
global2ExchRate	No	Number (22,7)	This is the exchange rate from Local currency to the second Global currency. The Global currencies are defined in the global currency master table.
global3ExchRate	No	Number (22,7)	This is the exchange rate from Local currency to the third Global currency. The Global currencies are defined in the global currency master table.
cumMarkonPct	No	Number (18,4)	Cumulative markon percent is used in the retail method of accounting only. This is a calculated field in the source system. cum_markon_pct = ((htd_gafs_retail - htd_gafs_cost ) / htd_gafs_retail) * 100. Currently stored in the DB but not used in reporting.
inProgressSalesQty	No	Number (12,4)	The quantity of in progress sales for the item in the location.
packCompSohQty	No	Number (18,4)	This is the quantity of owned inventory units derived from pack items.
packCompIntranQty	No	Number (18,4)	This is the quantity of transfer and allocation inventory units derived from pack items that have been shipped but not yet received.
packCompOnOrdQty	No	Number (18,4)	This is the quantity of on order units from active purchase orders derived from pack items.
packCompTsfResvQty	No	Number (18,4)	This is the requested quantities derived from pack items that have not been shipped on all transfers and stand alone allocations for the source location.
packCompTsfExpQty	No	Number (18,4)	This is the expected quantities derived from pack items that have not been shipped on all transfers and stand alone allocations for the destination location.
packCompCustResvQty	No	Number (18,4)	This is the customer order reserved units derived from pack items.
packCompCustBackQty	No	Number (18,4)	This is the customer order backorder reserved units derived from pack items.
sellingPhaseStartDate	No	date	Contains the latest/most recent date upon which a receipt of significance occurred at the location, indicating the start of the selling phase for the item/location.
flex1NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex2NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex3NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex4NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex5NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex6NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex7NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex8NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex9NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex10NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex11NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex12NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex13NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex14NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex15NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex16NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex17NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex18NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex19NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.
flex20NumValue	No	Number (18,4)	Custom flex measure for export to Planning applications. Uses SUM as the aggregation method to roll up to item/location/week and export to PDS.

Table 3-12 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (80)	External unique identifier for an item.
location	Yes	String (80)	The external identifier for a location, including stores, warehouses, and partner locations.
businessDate	Yes	date	Date on which the inventory position was recorded for.
message	Yes	String (2000)	Identifies error during business data processing of the request.

Sample Input Message

{
  "count": 1,
  "items": [
    {
      "action": "INSERT",
      "item": "102900026",
      "location": "S",
      "businessDate": "2001-12-31",
      "clearanceFlg": "N",
      "invReplFlg": "Y",
      "invReplMethodType": "C",
      "invReplIncrementPct": 10.00,
      "customerResvQty": 10,
      "customerBackorderQty": 10,
      "stockOnHandQty": 10,
      "stockOnHandCost": 10,
      "stockOnHandRetail": 10,
      "onOrderQty": 10,
      "onOrderCost": 10.50,
      "onOrderRetail": 12.50,
      "inTransitQty": 10,
      "inTransitCost": 15.50,
      "inTransitRetail": 10,
      "maxStockOnHandQty": 9999,
      "maxStockOnHandCost": 9999.99,
      "maxStockOnHandRetail": 19999.99,
      "minStockOnHandQty": 10,
      "minStockOnHandCost": 99,
      "minStockOnHandRetail": 199.99,
      "tsfReservedQty": 1,
      "tsfReservedCost": 1.99,
      "tsfReservedRetail": 1.99,
      "tsfExpectedQty": 1,
      "tsfExpectedCost": 1.99,
      "tsfExpectedRetail": 2.99,
      "rtvQty": 1,
      "rtvCost": 1,
      "rtvRetail": 1,
      "sellingUnitRetail": 1,
      "avCost": 10.99,
      "unitCost": 10.99,
      "finisherQty": 1,
      "purchaseType": "0",
      "docCurrCode": "USD",
      "locCurrCode": "USD",
      "locExchangeRate": 1,
      "global1ExchRate": 1,
      "global2ExchRate": 1,
      "global3ExchRate": 1,
      "cumMarkonPct": 50,
      "inProgressSalesQty": 12,
      "packCompSohQty": 1,
      "packCompIntranQty": 1,
      "packCompOnOrdQty": 1,
      "packCompTsfResvQty": 1,
      "packCompTsfExpQty": 1,
      "packCompCustResvQty": 1,
      "packCompCustBackQty": 1,
      "sellingPhaseStartDate": "2001-12-31",
      "flex1NumValue": 1,
      "flex2NumValue": 2,
      "flex3NumValue": 3,
      "flex4NumValue": 4,
      "flex5NumValue": 5,
      "flex6NumValue": 6,
      "flex7NumValue": 7,
      "flex8NumValue": 8,
      "flex9NumValue": 9,
      "flex10NumValue": 10,
      "flex11NumValue": 11,
      "flex12NumValue": 12,
      "flex13NumValue": 13,
      "flex14NumValue": 14,
      "flex15NumValue": 15,
      "flex16NumValue": 16,
      "flex17NumValue": 17,
      "flex18NumValue": 18,
      "flex19NumValue": 19,
      "flex20NumValue": 20
    }
  ]
}

Response Code: 200 (Success)

Response Code: 400 (Error)

Table 3-13 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (80)	External unique identifier for an item.
location	Yes	String (80)	The external identifier for a location, including stores, warehouses, and partner locations.
businessDate	Yes	date	Date on which the inventory position was recorded for.
message	Yes	String (2000)	Identifies error during business data processing of the request.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    {
      "item": "102900026",
      "location": "S",
      "businessDate": "2001-12-31",
      "message": "One or more of the required fields is NULL, example item, org number, business date or clearance flag"
    }
  ]
}

Manage Inventory Pack

Functional Area

Foundation - Inventory Pack

Business Overview

The service accepts a collection of inventory pack data for use in AIF Data. It can be a single record or a collection of inventory for pack records.

Service Type

POST

ReST URL

RiRestService/services/foundation/inventoryPack/manage

Input Payload Details

Table 3-14 Manage - Object. See list of elements for detail

Element Name	Required	Data Type	Description
count	Yes	Number (4)
items	Yes	Collection of Object

Table 3-15 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	Yes	String (30)	Identifies whether the data submitted is for INSERT, UPDATE, DELETE or UPSERT.
packNo	Yes	String (80)	External unique identifier for a pack item.
location	Yes	String (80)	The external identifier for a location, including stores, warehouses, and partner locations.
businessDate	Yes	date	Date on which the inventory position was recorded for.
clearanceFlg	No	String (1)	This indicates if inventory is on clearance with values of Y for clearance price and N for regular price.
purchaseTypeCode	No	String (50)	Identifies the inventory purchase type. 0 (Owned), 1 (Consignment), or 2 (Concession)
packStockOnHandQty	No	Number (18,4)	This is the quantity of owned inventory units for pack items.
packStockOnHandCost	No	Number (20,4)	This is the cost value of owned inventory units for pack items. This is in local currency.
packStockOnHandRetail	No	Number (20,4)	This is the retail value of owned inventory units for pack items. This is in local currency.
packOnOrderQty	No	Number (18,4)	This is the quantity of ordered inventory units for pack items that have not yet been received.
packOnOrderCost	No	Number (20,4)	This is the cost value of ordered inventory units for pack items that have not yet been received. This is in local currency.
packOnOrderRetail	No	Number (20,4)	This is the retail value of ordered inventory units for pack items that have not yet been received. This is in local currency.
packInTransitQty	No	Number (18,4)	This is the quantity of transfer and allocation inventory units for pack items that have been shipped but not yet received.
packInTransitCost	No	Number (20,4)	This is the cost value of transfer and allocation inventory units for pack items that have been shipped but not yet received. This is in local currency.
packInTransitRetail	No	Number (20,4)	This is the retail value of transfer and allocation inventory units for pack items that have been shipped but not yet received. This is in local currency.
packTsfReservedQty	No	Number (18,4)	The sum of all requested quantities of a pack item that have not been shipped on all transfers and stand alone allocations for the source location.
packTsfReservedCost	No	Number (20,4)	The total cost amount of all requested quantities of a pack item that have not been shipped on all transfers and stand alone allocations for the source location.
packTsfReservedRetail	No	Number (20,4)	The total retail amount of all requested quantities of a pack item that have not been shipped on all transfers and stand alone allocations for the source location.
packTsfExpectedQty	No	Number (18,4)	The sum of all expected quantities of a pack item that have not been shipped on all transfers and stand alone allocations for the destination location.
packTsfExpectedCost	No	Number (20,4)	The total cost amount of all expected quantities of a pack item that have not been shipped on all transfers and stand alone allocations for the destination location.
packTsfExpectedRetail	No	Number (20,4)	The total retail amount of all expected quantities of a pack item that have not been shipped on all transfers and stand alone allocations for the destination location.
packRtvQty	No	Number (18,4)	The sum of all reserved quantities of a pack item that have not been shipped on RTVs for the source location.
packRtvCost	No	Number (20,4)	The total cost amount all reserved quantities of a pack item that have not been shipped on RTVs for the source location.
packRtvRetail	No	Number (20,4)	The total retail amount all reserved quantities of a pack item that have not been shipped on RTVs for the source location.
packUnitRetail	No	Number (20,4)	This is the retail value of a single inventory unit for a pack item in the standard unit of measure. This is in local currency.
packAvCost	No	Number (20,4)	This is the weighted average cost of a pack item at a location. Most pack items will not have an average cost value.
packUnitCost	No	Number (20,4)	This is the cost value of a single inventory unit for a pack item in the standard unit of measure. This is in local currency.
packCustomerResvQty	No	Number (18,4)	This is the quantity of customer order reserved units for a pack item that have not yet been delivered to the customer.
packCustomerBackorderQty	No	Number (18,4)	This is the quantity of customer order back-order reserved units for pack items that have not yet been fulfilled.
packFinisherQty	No	Number (18,4)	This is the quantity of units for pack items of the adjusted item currently at the finisher.
packCumMarkonPct	No	Number (18,4)	Value of the cumulative markon percent, used in the retail method of accounting only.
packInProgressSalesQty	No	Number (18,4)	This field is the quantity of in progress sale units for the item in the location.
docCurrencyCode	No	String (30)	Code for the currency in which the document was created in the source system.
locCurrencyCode	No	String (30)	The reporting currency code for the financial company for which the document was created.
locExchangeRate	No	Number (22,7)	This is the exchange rate from Local Currency to the Preferred Currency.
global1ExchangeRate	No	Number (22,7)	This is the exchange rate from Local currency to the first Global currency. The Global currencies are defined in the global currency master table.
global2ExchangeRate	No	Number (22,7)	This is the exchange rate from Local currency to the second Global currency. The Global currencies are defined in the global currency master table.
global3ExchangeRate	No	Number (22,7)	This is the exchange rate from Local currency to the third Global currency. The Global currencies are defined in the global currency master table.
exchangeDate	No	date	The business date on which the transaction occurred for the purpose of exchange rate calculation.
flex1NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex2NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex3NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex4NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex5NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex6NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex7NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex8NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex9NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex10NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex11NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex12NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex13NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex14NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex15NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex16NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex17NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex18NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex19NumValue	No	Number (18,4)	Numeric fact column for external data values.
flex20NumValue	No	Number (18,4)	Numeric fact column for external data values.

Table 3-16 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
packNo	Yes	String (30)	External unique identifier for a pack item.
location	Yes	String (80)	The external identifier for a location, including stores, warehouses, and partner locations.
businessDate	Yes	date	Date on which the inventory position was recorded for.
message	Yes	String (2000)	Identifies error during business data processing of the request.

Sample Input Message

{
  "count": 1,
  "items": [
    {
      "action": "INSERT",
      "packNo": "102900030",
      "location": "1122",
      "businessDate": "2001-12-31",
      "clearanceFlg": "Y",
      "purchaseTypeCode": "0",
      "packStockOnHandQty": 12.2,
      "packStockOnHandCost": 12.2,
      "packStockOnHandRetail": 12.2,
      "packOnOrderQty": 5,
      "packOnOrderCost": 12.2,
      "packOnOrderRetail": 12.2,
      "packInTransitQty": 5,
      "packInTransitCost": 12.2,
      "packInTransitRetail": 12.2,
      "packTsfReservedQty": 5,
      "packTsfReservedCost": 12.2,
      "packTsfReservedRetail": 12.2,
      "packTsfExpectedQty": 5,
      "packTsfExpectedCost": 12.2,
      "packTsfExpectedRetail": 12.2,
      "packRtvQty": 5,
      "packRtvCost": 12.2,
      "packRtvRetail": 12.2,
      "packUnitRetail": 12.2,
      "packAvCost": 12.2,
      "packUnitCost": 12.2,
      "packCustomerResvQty": 5,
      "packCustomerBackorderQty": 5,
      "packFinisherQty": 5,
      "packCumMarkonPct": 12.2,
      "packInProgressSalesQty": 5,
      "docCurrencyCode": "USD",
      "locCurrencyCode": "USD",
      "locExchangeRate": 1.0,
      "global1ExchangeRate": 1.1,
      "global2ExchangeRate": 1.2,
      "global3ExchangeRate": 1.3,
      "exchangeDate": "2001-12-31",
      "flex1NumValue": 20.00,
      "flex2NumValue": 26.00,
      "flex3NumValue": 15.00,
      "flex4NumValue": 94.00,
      "flex5NumValue": 86.00,
      "flex6NumValue": 16.00,
      "flex7NumValue": 18.00,
      "flex8NumValue": 19.00,
      "flex9NumValue": 49.00,
      "flex10NumValue": 18.00,
      "flex11NumValue": 66.00,
      "flex12NumValue": 11.00,
      "flex13NumValue": 13.00,
      "flex14NumValue": 45.00,
      "flex15NumValue": 20.00,
      "flex16NumValue": 22.00,
      "flex17NumValue": 15.00,
      "flex18NumValue": 90.00,
      "flex19NumValue": 90.00,
      "flex20NumValue": 20.00
    }
  ]
}

Response Code: 200 (Success)

Response Code: 400 (Error)

Table 3-17 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
packNo	Yes	String (30)	External unique identifier for a pack item.
location	Yes	String (80)	The external identifier for a location, including stores, warehouses, and partner locations.
businessDate	Yes	date	Date on which the inventory position was recorded for.
message	Yes	String (2000)	Identifies error during business data processing of the request.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    {
      "packNo": "102900030",
      "location": "1122",
      "businessDate": "2001-12-31",
      "message": "One of the required fields is NULL, example pack number, org/location number or business date"
    }
  ]
}

Manage Purchase Order

Functional Area

Foundation - Purchase Order

Business Overview

The service accepts a collection of Order data for use in AIF Data. It can be a single record or a collection of Order records.

Service Type

POST

ReST URL

RiRestService/services/foundation/order/manage

Input Payload Details

Table 3-18 Manage - Object. See list of elements for detail

Element Name	Required	Data Type	Description
count	Yes	Number (4)
items	Yes	Collection of Object

Table 3-19 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	Yes	String (30)	Identifies whether the data submitted is for INSERT, UPDATE or DELETE.
orderNo	Yes	String (30)	Contains the number that uniquely identifies an order within the system.
orderType	Yes	String (3)	Indicates the type of order and which Open To Buy bucket will be updated.Valid values include: N/B - Non Basic ARB - Automatic Reorder of Basic BRB - Buyer Reorder of Basic.
dept	No	Number (4)	Contains the department number for orders limited to a single department and will be Null for orders involving items in more than one department.
supplier	Yes	Number (10)	Contains the vendor number who will provide the merchandise specified in the order.
buyer	No	String (30)	This is the BUYER from the W_RTL_BUYER_D table.
appointmentDatetime	No	date	This column will hold the date and time of the receiving appointment at the warehouse.
backhaulAllowance	No	Number (20,4)	This field will contain the backhaul allowance value.
backhaulType	No	String (6)	This field contains the type of backhaul allowance that will be applied to the order. Some examples are Calculated or Flat rate
closeDate	No	date	Contains the date when the order is closed.
contractNo	No	Number (6)	This column will hold the value of the contract number associated with the records.
currencyCode	No	String (6)	The rate of exchange used for the purchase order between the order and primary currencies.
customerOrderNo	No	String (80)	This column is populated CUST_ORDER of po detail ds
earliestShipDate	No	date	The date before which the items on the purchase order can not be shipped by the supplier. Represents the earliest earliest ship date of all the items on the order.
latestShipDate	No	date	The date after which the items on the purchase order can not be shipped by the supplier. Represents the greatest latest ship date of all the items on the order.
ediOrderInd	No	String (1)	Indicates whether or not the order will be transmitted to the supplier via an Electronic Data Exchange transaction. Valid values are: Y = Submit via EDI N = Do not use EDI
importCountryId	No	String (3)	The identifier of the country into which the items on the order are being imported.
importOrderInd	No	String (1)	Indicates if the purchase order is an import order. Valid values are Y (Yes) and N (No).
locationType	No	String (1)	This field contains the type of location in the location field. Valid values are:Valid values are S (Store) or W (Warehouse).
notBeforeDate	No	date	Contains the first date that delivery of the order will be accepted.
notAfterDate	No	date	Contains the last date that delivery of the order will be accepted.
originalApprovalDate	No	date	Contains the date that the order was originally approved.
orderOriginatedInd	No	Number (2)	Indicates where the order originated. Valid values include: 0 - Current system generated (used by automatic replenishment) 2 - Manual 3- Buyer Worksheet 4 - Consignment 5 - Vendor Generated
paymentMethod	No	String (6)	Indicates how the purchase order will be paid. Valid options are LC (Letter of Credit), WT (Wire Transfer), OA (Open Account).
pickupDate	No	date	Contains the date when the order can be picked up from the Supplier. This field is only required if the Purchase Type of the order is Pickup.
pickupLocation	No	String (250)	Contains the location at which the order will be picked up, if the order is a Pickup order.
pickupNo	No	String (25)	Contains the reference number of the Pickup order.
poType	No	String (4)	Contains the value associated with the PO_TYPE for the order.
purchaseType	No	String (6)	Indicates whats included in the suppliers cost of the item. Valid values include C (Cost), CI (Cost and Insurance), CIF (Cost, Insurance and Freight),FOB (Free on Board).
qualityControlInd	No	String (1)	Determines whether or not quality control will be required when items for this order are received. Valid values are Y and N.
rejectCode	No	String (6)	Contains a code for the reason why the order was rejected during the automatic replenishment approval process. Valid values include: VM (Vendor minimum not met), NC (Negative cost calculated on an item), UOM (UOM convert error due to incomplete data).
shipMethod	No	String (6)	The method used to ship the items on the purchase order from the country of origin to the country of import. Valid values include 10 (Vessel, Noncontainer), 11 (Vessel, Container), 12 (Border Water-borne (Only Mexico and Canada)), 20 (Rail, Non-ontainer), 21 (Rail, Container), 30 (Truck, Noncontainer),31 (Truck, Container), 32 (Auto), 33 (Pedestrian), 34 (Road,other, includes foot and animal borne), 40 (Air, Non-container), 41 (Air,Container), 50 (Mail), 60 (Passenger, Hand carried), 70 (Fixed ransportation Installation), 80 (Not used at this time).
shipPayMethod	No	String (2)	Code indicating the payment terms for freight charges associated with the order.Valid values include: CC - Collect CF - Collect Freight Credited Back to Customer DF - Defined by Buyer and Seller MX - Mixed PC - Prepaid but Charged to Customer PO - Prepaid Only PP - Prepaid by Seller.
splitRefOrderNo	No	Number (12)	This column will store the original order number from which the split orders were generated from. It will be for references purposes only. The purpose is to allow users a means of grouping orders that were split from an original super order. The original order, once split, will however be removed from the system.
status	No	String (1)	The code for the status of the order. Valid values are 'A' approved, or 'C' closed.
vendorOrderNo	No	String (15)	Contains the vendors unique identifying number for an order. These orders may have originated by the vendor through the EDI process or this number can be associated to a Retek order when the order is created on-line.
revisionNumber	No	Number (6)	This field contains an incremental counter of the number of revisions for a particular Orders dates. Revision number 1 will correspond to the original order sent to the supplier via EDIDL850.
revisionDate	No	date	This field contains the date the revision was processed by Oracle Retail.
promotion	No	Number (10)	Contains the ad number associated with the order to provide a link between the order dialog and the promotions dialog.
otbEowDate	No	date	This field contains the OTB budget bucket the order amount should be placed into.
terms	No	String (15)	Indicator identifying the sales terms for the order. These terms specify when payment is due and if any discounts exist for early payment.
freightTerms	No	String (30)	Indicator that references what freight terms are related to the order.
originalApprovalId	No	String (254)	Indicates where the order was approved. It will be the user ID of the person approving the order for all orders manually approved on-line and will contain Replen for orders automatically approved in the replenishment process.
fobTransactionResponsibility	No	String (2)	Contains the code indicating the type of the location that is responsible for the transportation of the order.
fobTransactionResponsibilityDescription	No	String (250)	User entered field describing the code for the location responsible for the transportation of the order.
fobTitlePass	No	String (2)	Indicator used to determine where the title for goods is passed from the vendor to the purchaser. Examples include city, factory, or origin.
fobTitlePassDescription	No	String (250)	User entered field describing the code where the title of the merchandise is to be passed. Could be a city name, factory name, or place of origin.
ediSentInd	No	String (1)	This field indicates whether or not the order has been sent via EDI. This field can only contain a Y if the EDI_PO_IND = Y.
poAckRecvdInd	No	String (1)	Indicates that a buyer generated purchase order has been acknowledged by the vendor with a separate EDI transaction.
includeOnOrderInd	No	String (1)	Indicator to determine if the order should be included in on-order calculations. Valid values include Yes (include the order in the on-order calculations), No (do not include the order in the on-order calculations).
factory	No	String (10)	The factory at which the items on the purchase order are made. This field is only available when the system is running Import functionality.
agent	No	String (10)	The agent that is used in the purchase of the items on the purchase order. This field is only available when the system is running Import functionality.
dischargePort	No	String (5)	The port at which the items on the purchase order will enter the country of import. This field is only available when the system is running Import functionality.
ladingPort	No	String (5)	The port from which the items on the purchase order are shipped. This field is only available when the system is running Import functionality.
freightContractNo	No	String (10)	The number of the contract with a shipper that will give specific freight rates. This field is only available when the system is running Import functionality.
preMarkInd	No	String (1)	This field indicated whether or not a supplier has agreed to break an order into separate boxes so that the boxes can be sent directly to stores.
lastSentRevisionNumber	No	Number (6)	Contains the revision number (rev_no) of the last version of the order that was sent to the supplier. The revision is held on the order revisions tables (ordhead_rev, ordsku_rev, ordloc_rev, and alloc_rev) and can be identified where the rev_no = last_sent_rev_no and origin_ind = V (version rather than revision).
comments	No	String (2000)	Any miscellaneous comments attached to the purchase order.
partnerType1	No	String (6)	Partner 1 Type
partner1	No	String (10)	Additional Partner 1
partnerType2	No	String (6)	Partner 2 Type
partner2	No	String (10)	Additional Partner 2
partnerType3	No	String (6)	Partner 3 Type
partner3	No	String (10)	Additional Partner 3
importType	No	String (1)	Valid values are IMporter and EXporter. This is the default importer/exporter assigned to the supplier of the Puchase order.
importId	No	Number (10)	This identifies the importer/exporter assigned to the supplier. This should reference the WH.WH folumn with foreign key created.
clearingZoneId	No	String (5)	This column will hold the clearing zone id.
routingLocationId	No	String (5)	This is the default routing location for the import order. FK on OUTLOC.OUTLOC_ID.
deliverySupplier	No	Number (10)	This field holds the supplier / supplier site from where the goods are delivered.
triangulationInd	No	String (1)	When the value is Y , this field ensures that the order supplier and the delivery supplier are different.
wfOrderNo	No	Number (10)	This column contains the franchise order number for which the purchase order was created.
masterPurchaseOrderNumber	No	Number (10)	A number that is used to reference the master order number from which child records were created. Orders with the same Master_PO number are grouped together using the same delivery date.
exchangeRate	No	Number (20,10)	The rate of exchange used for the purchase order between the order and primary currencies.
details	No	Collection of Object	This holds the purchase order details.

Table 3-20 Details - Object. See list of elements for detail

Element Name	Required	Data Type	Description
location	No	String (80)	This is the Organization number or short name.
item	Yes	String (80)	This is the Product number.
businessDate	No	date	This is the Day Date from W_MCAL_DAY_D.
allocNo	No	String (30)	This is the ALLOC_NO from W_RTL_ALC_DETAILS_D table, if null then use '-1'.
onOrderQuantity	No	Number (18,4)	This is the quantity of PO On Order Units.
onOrderCost	No	Number (20,4)	This is the cost value of PO On Order Units. This is stored in local currency.
onOrderRetail	No	Number (20,4)	This is the retail value of PO On Order Units. This is stored in local currency.
docCurrencyCode	No	String (30)	Code for the currency in which the document was created in the source system.
locCurrencyCode	No	String (30)	Usually the reporting currency code for the financial company in which the document was created.
global1ExchangeRate	No	Number (22,7)	This is the exchange rate from Local currency to the first Global currency. The Global currencies are defined in the global currency master table.
global2ExchangeRate	No	Number (22,7)	This is the exchange rate from Local currency to the second Global currency. The Global currencies are defined in the global currency master table.
global3ExchangeRate	No	Number (22,7)	This is the exchange rate from Local currency to the third Global currency. The Global currencies are defined in the global currency master table.
locExchangeRate	No	Number (22,7)	This is the exchange rate from Local Currency to the Preferred Currency.
physicalQuantityOrdered	No	Number (12,4)	Contains the total number of items ordered for the SKU to this location.
quantityReceived	No	Number (12,4)	Contains the number of items for this SKU already received to this location.
quantityCancelled	No	Number (12,4)	This field contains the quantity that was left to be ordered when the line item was cancelled.
unitCost	No	Number (20,4)	This field contains the unit cost for the Item/Location on the order, including discounts (deal/bracket/allowance), but not landed cost components. This field is stored in order currency.
unitRetail	No	Number (20,4)	Contains the current retail price for the SKU at this location. This field is stored in the local currency. This field is only stored on this table for the purpose of calculating Open-To-Buy.
lastReceivedDate	No	date	This field contains the date at which the transaction record was recorded into the transaction data table.
lastReceivedQuantity	No	Number (12,4)	The Total number of units involved in the transaction.
prescaledQuantity	No	Number (12,4)	This is the order quantity (system generated or manually generated) for the item/location before order scaling processing was performed.
lastRoundedQuantity	No	Number (12,4)	This column will hold the most recent system rounded order quantity value for the line item.
lastGroupRoundedQuantity	No	Number (12,4)	This column will hold the last system rounded order quantity for the rounding group the location is apart of.
originalReplenishmentQuantity	No	Number (12,4)	This is the original order quantity from replenishment.
cancelCode	No	String (30)	This field contains the reason that the line item was cancelled. This field is required if a line item is cancelled.
cancelDate	No	date	This field contains the date the line item was cancelled.
estimatedInStockDate	No	date	This is the date that the item on the PO is expected to be available to ship from the PO location to another location.
packNumber	No	Number (18,4)	Original pack item number for a purchase order of a pack item.
packOnOrderQuantity	No	Number (18,4)	The quantity of units currently on order for the pack item.
packQuantityOrdered	No	Number (18,4)	The quantity of units ordered for the pack item.
packQuantityReceived	No	Number (18,4)	The quantity of units received for the pack item.
packUnitCost	No	Number (20,4)	The unit cost of the pack item as listed on the purchase order.
packUnitRetail	No	Number (20,4)	The unit retail of the pack item as listed on the purchase order.
flex1NumValue	No	Number (18,4)	This is the plan flexible metric 1.
flex2NumValue	No	Number (18,4)	This is the plan flexible metric 2.
flex3NumValue	No	Number (18,4)	This is the plan flexible metric 3.
flex4NumValue	No	Number (18,4)	This is the plan flexible metric 4.
flex5NumValue	No	Number (18,4)	This is the plan flexible metric 5.
flex6NumValue	No	Number (18,4)	This is the plan flexible metric 6.
flex7NumValue	No	Number (18,4)	This is the plan flexible metric 7.
flex8NumValue	No	Number (18,4)	This is the plan flexible metric 8.
flex9NumValue	No	Number (18,4)	This is the plan flexible metric 9.
flex10NumValue	No	Number (18,4)	This is the plan flexible metric 10.
flex11NumValue	No	Number (18,4)	This is the plan flexible metric 11.
flex12NumValue	No	Number (18,4)	This is the plan flexible metric 12.
flex13NumValue	No	Number (18,4)	This is the plan flexible metric 13.
flex14NumValue	No	Number (18,4)	This is the plan flexible metric 14.
flex15NumValue	No	Number (18,4)	This is the plan flexible metric 15.
flex16NumValue	No	Number (18,4)	This is the plan flexible metric 16.
flex17NumValue	No	Number (18,4)	This is the plan flexible metric 17.
flex18NumValue	No	Number (18,4)	This is the plan flexible metric 18.
flex19NumValue	No	Number (18,4)	This is the plan flexible metric 19.
flex20NumValue	No	Number (18,4)	This is the plan flexible metric 20.
physicalLocationType	No	String (1)	This field contains the type of location in the location field.
physicalLocation	No	String (80)	This field contains the actual physical location that the item will be ordered to. This field may contain a store or a physical warehouse.
virtualWarehouse	No	String (80)	This field contains the location of the order only for virtual warehouse.

Table 3-21 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
orderNo	Yes	String (30)	This is the unique number to identify the purchase order within the system.
location	Yes	String (80)	This is the Organization number or short name
item	Yes	String (80)	This column contains a unique alphanumeric value that identifies the item.
message	Yes	String (2000)	Identifies error during business data processing of the request.

Sample Input Message

{
  "count": 1,
  "items": [
    {
      "action": "INSERT",
      "orderNo": "118079",
      "orderType": "N/B",
      "dept": 1000,
      "supplier": 58,
      "buyer": "String",
      "appointmentDatetime": "2001-12-31",
      "backhaulAllowance": 10.00,
      "backhaulType": "String",
      "closeDate": "2001-12-31",
      "contractNo": 100000,
      "currencyCode": "USD",
      "customerOrderNo": "String",
      "earliestShipDate": "2001-12-31",
      "latestShipDate": "2001-12-31",
      "ediOrderInd": "N",
      "importCountryId": "US",
      "importOrderInd": "N",
      "locationType": "S",
      "notBeforeDate": "2001-12-31",
      "notAfterDate": "2001-12-31",
      "originalApprovalDate": "2001-12-31",
      "orderOriginatedInd": "2",
      "paymentMethod": "LC",
      "pickupDate": "2001-12-31",
      "pickupLocation": "String",
      "pickupNo": "String",
      "poType": "????",
      "purchaseType": "C",
      "qualityControlInd": "N",
      "rejectCode": "VM",
      "shipMethod": "10",
      "shipPayMethod": "CC",
      "splitRefOrderNo": 142809,
      "status": "A",
      "vendorOrderNo": "String",
      "revisionNumber": 100000,
      "revisionDate": "2001-12-31",
      "promotion": 799212,
      "otbEowDate": "2001-12-31",
      "terms": "String",
      "freightTerms": "String",
      "originalApprovalId": "String",
      "fobTransactionResponsibility": "??",
      "fobTransactionResponsibilityDescription": "String",
      "fobTitlePass": "??",
      "fobTitlePassDescription": "String",
      "ediSentInd": "Y",
      "poAckRecvdInd": "?",
      "includeOnOrderInd": "Y",
      "factory": "String",
      "agent": "String",
      "dischargePort": "?????",
      "ladingPort": "?????",
      "freightContractNo": "String",
      "preMarkInd": "?",
      "lastSentRevisionNumber": 100000,
      "comments": "String",
      "partnerType1": "String",
      "partner1": "String",
      "partnerType2": "String",
      "partner2": "String",
      "partnerType3": "String",
      "partner3": "String",
      "importType": "?",
      "importId": 422369,
      "clearingZoneId": "?????",
      "routingLocationId": "?????",
      "deliverySupplier": 197514,
      "triangulationInd": "?",
      "wfOrderNo": 179182,
      "masterPurchaseOrderNumber": 187326,
      "exchangeRate": 14.00,
      "details": [
        {
          "location": "2093",
          "item": "62768804",
          "businessDate": "2001-12-31",
          "allocNo": "String",
          "onOrderQuantity": 2,
          "onOrderCost": 107.92,
          "onOrderRetail": 207.52,
          "docCurrencyCode": "USD",
          "locCurrencyCode": "USD",
          "global1ExchangeRate": 15.00,
          "global2ExchangeRate": 12.00,
          "global3ExchangeRate": 96.00,
          "locExchangeRate": 1,
          "physicalQuantityOrdered": 2,
          "quantityReceived": 0,
          "quantityCancelled": 0,
          "unitCost": 53.96,
          "unitRetail": 103.76,
          "lastReceivedDate": "2001-12-31",
          "lastReceivedQuantity": 19.00,
          "prescaledQuantity": 15.00,
          "lastRoundedQuantity": 44.00,
          "lastGroupRoundedQuantity": 16.00,
          "originalReplenishmentQuantity": 23.00,
          "cancelCode": "String",
          "cancelDate": "2001-12-31",
          "estimatedInStockDate": "2001-12-31",
          "packNumber": 50.00,
          "packOnOrderQuantity": 0,
          "packQuantityOrdered": 14.00,
          "packQuantityReceived": 14.00,
          "packUnitCost": 73.00,
          "packUnitRetail": 15.00,
          "flex1NumValue": 20.00,
          "flex2NumValue": 26.00,
          "flex3NumValue": 15.00,
          "flex4NumValue": 94.00,
          "flex5NumValue": 86.00,
          "flex6NumValue": 16.00,
          "flex7NumValue": 18.00,
          "flex8NumValue": 19.00,
          "flex9NumValue": 49.00,
          "flex10NumValue": 18.00,
          "flex11NumValue": 66.00,
          "flex12NumValue": 11.00,
          "flex13NumValue": 13.00,
          "flex14NumValue": 45.00,
          "flex15NumValue": 20.00,
          "flex16NumValue": 22.00,
          "flex17NumValue": 15.00,
          "flex18NumValue": 90.00,
          "flex19NumValue": 90.00,
          "flex20NumValue": 20.00,
          "physicalLocationType": "?",
          "physicalLocation": "String",
          "virtualWarehouse": "String"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Response Code: 400 (Error)

Table 3-22 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
orderNo	Yes	String (30)	This is the unique number to identify the purchase order within the system.
location	Yes	String (80)	This is the Organization number or short name
item	Yes	String (80)	This column contains a unique alphanumeric value that identifies the item.
message	Yes	String (2000)	Identifies error during business data processing of the request.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    {
      "orderNo": "2309161093",
      "location": "2093",
      "item": "62768804",
      "message": "One or more of the required fields is NULL, example order number or org/location number"
    }
  ]
}

Manage Shipment

Functional Area

Foundation - Shipment

Business Overview

The service accepts a collection of Shipment data for use in AIF Data. It can be a single record or a collection of Shipment records.

Service Type

POST

ReST URL

RiRestService/services/foundation/shipment/manage

Input Payload Details

Table 3-23 Manage - Object. See list of elements for detail

Element Name	Required	Data Type	Description
count	No	Number (4)
items	No	Collection of Object

Table 3-24 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	No	String (30)	Identifies whether the data submitted is for INSERT, UPDATE or DELETE.
shipmentNo	No	String (30)	Contains the unique number identifying a specific shipment of goods within the system.
parentShipmentNo	No	String (30)	Shipment No of Parent shipment (Indicates that this is a Child Shipment). A Child shipment is created when an already matched shipment is updated with an adjustment quantity. The adjust quantity is created for the child shipment.
bolNo	No	String (30)	This column will hold the bill of lading number associated with a shipment.
asnNo	No	String (30)	This column will hold the advance shipping notice number associated with a shipment.
toLocation	No	String (30)	This field contains the location that the shipment will be delivered to.
shipmentDate	No	date	This field contains the date the transfer or PO was shipped.
orderNo	No	String (30)	Identifies the purchase order number which relates to the goods delivered in the shipment.
receiveDate	No	date	This field contains the date the transfer or PO is received.
estimatedArrivalDate	No	date	This field contains the estimated arrival date of a vendor PO shipment.
shipmentOrigin	No	String (1)	Indicates where the shipment was created in the system.
statusCode	No	String (1)	Indicates the current status of the shipment. The valid values are: R - Received I - Input C - Cancelled E - Extracted V - Invoice Entered U - Unmatched
invoiceMatchStatus	No	String (1)	Status of the shipments invoice matching. Valid values are U for unmatched, P for partially matched, M for matched and C for closed (posted to AP or closed out by batch).
invoiceMatchDate	No	date	Date the shipment is completely matched to one or more invoices. This column will only be populated for PO shipments.
fromLocation	No	String (30)	For transfer and allocation shipments, this field will hold the location from which the shipment was sourced.
fromLocationType	No	String (1)	For transfer and allocation shipments, this field will hold the location type from which the shipment was sourced.
courier	No	String (250)	Contains the courier that will deliver the shipment.
noOfBoxes	No	Number (4)	Contains the number of boxes associated with the shipment.
extRefNoIn	No	String (30)	This field holds the transaction sequence number on the input file from the receiving PO or transfer process.
extRefNoOut	No	String (30)	This field holds the transaction sequence number on the input file from the transfer shipment confirmation process.
comments	No	String (2000)	Contains any miscellaneous comments about the shipment.
billToLoc	No	String (30)	This identifies the importer/exporter assigned to the supplier.
billToLocType	No	String (1)	Location type of the Bill_to_loc.
refDocNo	No	String (30)	This contains a reference number for a document associated to the shipment (e.g. Fiscal Document ID for Brazilian based transactions)
effectiveFromDt	No	date	This column stores the date from which the source record (in the Source system) is effective. The value is extracted from the source (whenever available).
effectiveToDt	No	date	This column stores the date up to which the source record (in the Source system) is effective. The value is extracted from the source (whenever available).
details	No	Collection of Object	This holds the shipment details.

Table 3-25 Details - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	No	String (30)	Unique identifier for the item on a shipment.
shipmentSeqNo	No	Number (10)	Due to the fact that there can be multiple Transfers[Distros], Inventory Statuses, or Cartons for the same Shipment/Item, this field contains the sequence number used along with the Shipment number and Item to make the Shipment Item records unique.
allocNo	No	String (30)	Contains the allocation number associated with a shipment if distro_type = A. Joins with W_RTL_ALC_DETAILS_D to get the allocation headers.
transferNo	No	String (30)	Contains the transfer number associated with a shipment if distro_type = T. Joins with W_RTL_TSF_DETAILS_D to get the transfer headers.
invStatus	No	Number (2)	This field contains the inventory status, if one exists, for the SHIPSKU record. The inventory status field corresponds to the inventory status type found on the INV_STATUS_TYPES table. This field will contain a valid inv_status for transfer records that have a inventory status, otherwise, this field will contain a -1.
distroType	No	String (1)	Contains distro type that indicates the distro_no is for allocation number or transfer number. If A then allocation ,If T then transfer.
referenceItem	No	String (30)	Contains a reference item to the item field.
carton	No	String (30)	Identifies the UCC-128 carton number for shipments originating from the Advance Shipment Notification process as carton shipments. This field will be zero for all shipments that are not at a carton level.
skuStatusCode	No	String (1)	Indicates the status of the SKU on the shipment. Valid values include: H - Hold A - Accept R - Reject C - Carton Received.
receivedQuantity	No	Number (12,4)	Contains the number of items already received for the SKU/Shipment combination.
receivedCost	No	Number (20,4)	The total cost amount for already received units, derived by multiplying the number of received units by the unit cost amount.
receivedRetail	No	Number (20,4)	The total retail amount for already received units, derived by multiplying the number of received units by the unit retail amount.
shippedQuantity	No	Number (12,4)	Contains the number of items expected to be received based on the associated order number or on the suppliers advance shipment notification for this SKU/Shipment combination.
shippedCost	No	Number (20,4)	The total cost amount for expected units, derived by multiplying the number of expected units by the unit cost amount.
shippedRetail	No	Number (20,4)	The total retail amount for expected units, derived by multiplying the number of expected units by the unit retail amount.
unitCost	No	Number (20,4)	If the shipment is associated with a purchase order, UNIT_COST contains the cost of the SKU for this Shipment/Location combination based on the purchase order cost for the item and is stored in the order currency. The cost does not include landed cost components. If the shipment is associated with a transfer or allocation, UNIT_COST contains the average cost of the item at the sending location plus any up-charges. If it is for a transfer of type EG (externally generated) and has multiple inventory flows, UNIT_COST contains the average of the flows sending locations average costs plus any up-charges. For transfers or allocations UNIT_COST is stored in the from locations currency.
unitRetail	No	Number (20,4)	If the shipment is associated with a purchase order, UNIT_RETAIL contains the retail price of the item based on the associated purchase order and is stored in the local currency. If the shipment is associated with a transfer or allocation, UNIT_RETAIL contains the retail of the item at the from location and is stored in the from locations currency. If it is for a transfer Of type EG (externally generated) and has multiple inventory flows, UNIT_RETAIL contains the average retail of the sending locations.
adjustmentType	No	String (6)	Contains the type of adjustment made for stock order receipt exceptions. This field is not required and valid values besides NULL are: SL - Shipping Location Faulted RL - Receiving Location Faulted FC - Freight Claim (i.e. missing units are freight claimed) FR - Force Receipt (i.e. what is shipped is received) RE - Received Elsewhere See Comments (i.e. wrong store received the qty).
actualReceivingStore	No	String (30)	Contains the Actual Receiving Store Number when the Carton was received at wrong store.
reconcileDate	No	date	Contains the date the exception was reconciled from the Stock Order Exception Reconciliation Screen.
tamperedInd	No	String (1)	Indicates the Carton was tampered or not.
dispositionedInd	No	String (1)	Indicates the shipment was dispositioned at Carton level (not BOL level).
weightReceived	No	Number (12,4)	This column contains the actual weight of the item on received on the shipment.
weightReceivedUom	No	String (4)	This column contains the unit of measure of the received weight.
weightExpected	No	Number (12,4)	This column contains the expected weight of the item on the shipment.
weightExpectedUom	No	String (4)	This column contains the unit of measure of the expected weight.
matchInvoiceId	No	String (30)	Invoice that the shipment line is matched to.
matchInvoiceStatus	No	String (1)	Invoice match status.
matchQuantity	No	Number (12,4)	Matched Quantity that will be updated by ReIM when the receipt is matched
matchCost	No	Number (20,4)	The cost at which the receipt was originally matched the first time.
exchangeDate	No	date	This is the date when the price change or cost change was posted in the transaction system.
docCurrencyCode	No	String (30)	Code for the currency in which the document was created in the source system.
locCurrencyCode	No	String (30)	Usually the reporting currency code for the financial company in which the document was created.
locExchangeRate	No	Number (22,7)	This is the exchange rate from Local Currency to the Preferred Currency.
global1ExchangeRate	No	Number (22,4)	This is the exchange rate from Local currency to the first Global currency. The Global currencies are defined in the global currency master table.
global2ExchangeRate	No	Number (22,4)	This is the exchange rate from Local currency to the second Global currency. The Global currencies are defined in the global currency master table.
global3ExchangeRate	No	Number (22,4)	This is the exchange rate from Local currency to the third Global currency. The Global currencies are defined in the global currency master table.

Table 3-26 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
shipmentNo	No	String (30)	Contains the unique number identifying a specific shipment of goods within the system.
item	No	String (30)	Unique identifier for the item on a shipment.
location	No	String (30)	This is the Organization number or short name
message	No	String (2000)	Identifies error during business data processing of the request.

Sample Input Message

{
  "count": 1,
  "items": [
    {
      "action": "INSERT",
      "shipmentNo": "11652112306",
      "parentShipmentNo": "String",
      "bolNo": "String",
      "asnNo": "String",
      "toLocation": "2073",
      "shipmentDate": "2001-12-31",
      "orderNo": "String",
      "receiveDate": "2001-12-31",
      "estimatedArrivalDate": "2001-12-31",
      "shipmentOrigin": "?",
      "statusCode": "R",
      "invoiceMatchStatus": "?",
      "invoiceMatchDate": "2001-12-31",
      "fromLocation": "99001",
      "fromLocationType": "W",
      "courier": "String",
      "noOfBoxes": 1000,
      "extRefNoIn": "String",
      "extRefNoOut": "String",
      "comments": "String",
      "billToLoc": "String",
      "billToLocType": "?",
      "refDocNo": "String",
      "effectiveFromDt": "2001-12-31",
      "effectiveToDt": "2001-12-31",
      "details": [
        {
          "item": "92810182021",
          "shipmentSeqNo": 1,
          "allocNo": "String",
          "transferNo": "String",
          "invStatus": -1,
          "distroType": "T",
          "referenceItem": "20260108",
          "carton": "92810182021-1",
          "skuStatusCode": "A",
          "receivedQuantity": 3,
          "receivedCost": 128.94,
          "receivedRetail": 299.85,
          "shippedQuantity": 3,
          "shippedCost": 128.94,
          "shippedRetail": 299.85,
          "unitCost": 42.98,
          "unitRetail": 99.95,
          "adjustmentType": "String",
          "actualReceivingStore": "String",
          "reconcileDate": "2001-12-31",
          "tamperedInd": "?",
          "dispositionedInd": "?",
          "weightReceived": 17.00,
          "weightReceivedUom": "????",
          "weightExpected": 62.00,
          "weightExpectedUom": "????",
          "matchInvoiceId": "String",
          "matchInvoiceStatus": "?",
          "matchQuantity": 15.00,
          "matchCost": 61.00,
          "exchangeDate": "2001-12-31",
          "docCurrencyCode": "String",
          "locCurrencyCode": "String",
          "locExchangeRate": 19.00,
          "global1ExchangeRate": 15.00,
          "global2ExchangeRate": 12.00,
          "global3ExchangeRate": 96.00
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Response Code: 400 (Error)

Table 3-27 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
shipmentNo	No	String (30)	Contains the unique number identifying a specific shipment of goods within the system.
item	No	String (30)	Unique identifier for the item on a shipment.
location	No	String (30)	This is the Organization number or short name
message	No	String (2000)	Identifies error during business data processing of the request.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    {
      "shipmentNo": "11652112306",
      "item": "92810182021",
      "location": "2073",
      "message": "One or more of the required fields is NULL, example item number, org/location number, business date or shipment sequence number"
    }
  ]
}

Manage Transfer

Functional Area

Foundation - Transfer

Business Overview

The service accepts a collection of transfer data for use in AIF Data. It can be a single record or a collection of transfer records.

Service Type

POST

ReST URL

RiRestService/services/foundation/transfer/manage

Input Payload Details

Table 3-28 Manage - Object. See list of elements for detail

Element Name	Required	Data Type	Description
count	Yes	Number (4)
items	Yes	Collection of Object

Table 3-29 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	Yes	String (30)	Identifies whether the data submitted is for INSERT, UPDATE or DELETE.
transferNo	Yes	String (30)	This is the unique number to identify the transfer within the system.
transferParentNo	No	String (30)	Identifies the transfer at the level above the transfer and only used for the transfer with finishing activity.
orderNo	No	String (30)	This field contains the import order number for which the intercompany book transfer was created for POs created using an Importer.
fromLocationType	No	String (1)	Contains the location type of the from location of the transfer. Valid values: S-Store; W - Warehouse; E - External Finisher
fromLocation	No	String (30)	Contains the location number of the transfer from location. This field will contain a store, warehouse or external finisher number based upon the FROM_LOC_TYPE field.
toLocation	Yes	String (80)	This is the Organization number or short name
createDateTime	Yes	date-time	This is the Day Date from W_MCAL_DAY_D.
expectedDcDate	No	date	It is the date that the transfer is expected to be shipped from a warehouse and communicated to WMS.
invType	No	String (1)	Indicates whether the transfer is for Available or Unavailable inventory (not combination of both). Valid values: A - Available, U - Unavailable
transferType	No	String (5)	Identifies the type or reason for the transfer. Valid values are: SR - Store Requisition, CO - Customer Order, RV - RTV, CF - Confirmation, AD - Administrative, MR - Manual Requisition, PL - PO-Linked Transfer, BT - Book Transfer, EG - Externally Generated, IC - Intercompany, RAC - Reallocation, AIP - AIP Generated, SIM - SIM Generated, FO - Franchise Order, FR - Franchise Return, SG - System Generated
transferStatus	No	String (1)	Contains the status of the transfer. Valid value: I - Input, B - Submitted, A - Approved, S - Shipped, C - Closed, D - Deleted (will be deleted during batch), X - Transfer is being externally closed, P - Picked, L - Selected.
freightCode	No	String (1)	Determines the priority for this transfer. Valid values: N - Normal, E - Expedite, H - Hold
routingCode	No	String (1)	Indicates the type of freight to use on the transfer. Valid values: 1 - 1 day expedite, 2 - 2 day expedite, 3 - 3 day expedite
createId	No	String (254)	Contains the user ID of the user that created the transfer.
approvalDate	No	date	Contains the date the transfer was approved.
approvalId	No	String (254)	Contains the user ID of the user that approved the transfer.
deliveryDate	No	date	Indicates the earliest date that the transfer can be delivered to the store.
closeDate	No	date	Contains the date the transfer was closed.
externalReferenceNo	No	String (30)	Contains audit trail reference to external system when an external transaction initiates master record creation in the Oracle Retail system.
comments	No	String (3000)	Contains any miscellaneous comments associated with the transfer entered by the user.
expectedDcEowDate	No	date	Contains the eow_date for the exp_dc_date column. It is used for OTB extracts for Intercompany transfers.
massReturnTransferNo	No	String (30)	Contains the Mass Return Transfer Number with with this transfer is associated.
notAfterDate	No	date	Contains the last day upon which a store can ship the requested merchandise to the warehouse.
contextType	No	String (30)	This field holds the reason code related to which a transfer is made.
contextValue	No	String (30)	Contains the value relating to the context type, for example Promotion Number.
restockingPercentage	No	Number (18,4)	Contains the percentage of cost charged by the receiving location for re-stocking.
franchiseNeedDate	No	date	Contains the need date of franchise Order. This column is populated only for Franchise Order transfers.
deliverySlotId	No	String (30)	Indicates the delivery slot that will be used for the transfer.
franchiseOrder	No	String (15)	Contains the franchise order number this transfer is linked to.
franchiseReturnAuthorizationNo	No	String (15)	Contains the franchise return number this transfer is linked to.
srcEffFromDt	No	date	This column stores the date from which the source record (in the Source system) is effective. The value is extracted from the source (whenever available).
srcEffToDt	No	date	This column stores the date up to which the source record (in the Source system) is effective. The value is extracted from the source (whenever available).
details	No	Collection of Object	This holds the transfer details.

Table 3-30 Details - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (80)	This is the product number
transferSeqNo	Yes	Number (10)	This is a sequence number from transfer details.
invStatus	No	String (2)	This is the inventory status.
transferPrice	No	Number (20,4)	Contains the unit cost of the item that will be used for this specific transfer if being transferred at something other than current WAC. Only populated for intercompany transfers.
transferAverageCost	No	Number (20,4)	Contains the weighted average cost (WAC) for the item at the shipping location, which can be used as the unit cost for the transfer if no other cost value is provided.
transferQuantity	No	Number (18,4)	Contains the total quantity of the item reserved at the from location for this transfer.
fillQuantity	No	Number (18,4)	Contains the total amount of the item that has been filled for a POLinked transfer.
shipQuantity	No	Number (18,4)	Contains the quantity of the item which has been shipped from the from location on the transfer. In-transit quantity is SHIP_QTY - RECEIVED_QTY.
receivedQuantity	No	Number (18,4)	Contains the quantity of the item which has been received at the to location on the transfer. In-transit quantity is SHIP_QTY - RECEIVED_QTY.
reconciledQuantity	No	Number (18,4)	Contains the quantity of the item on the transfer that has been reconciled based on short or over receipt.
distroQuantity	No	Number (18,4)	Contains the final quantity that the external system (e.g. RWMS) plans on filling.
selectedQuantity	No	Number (18,4)	Contains the initial quantity that the external system (e.g. RWMS) plans on filling.
cancelledQuantity	No	Number (18,4)	Contains the quantity of an item on the transfer that is left to be transferred at the time of cancellation of the line item.
supplierPackSize	No	Number (18,4)	Contains the supplier pack size for this transfer/item.
transferOrderLinkNo	No	String (12)	Contains a reference number to link the item on the transfer to any purchase orders that have been created to allow the from location (i.e. warehouse) on the transfer to fulfill the transfer quantity to the to location (i.e store) on the transfer.
defaultCharges2ndLegInd	No	String (1)	Indicator to identify whether item up charges (if exist) should be defaulted to the 2nd-leg of the transfer. The valid values are Y, N and NULL. Its value is set on transfer detail form when applying item up charges to the 1st-leg.
transferCost	No	Number (20,4)	Contains the unit cost of the item that will be used for this specific transfer if current shipping locations WAC is not used.
restockingPercentage	No	Number (18,4)	Contains the percentage of cost charged by the supplier for restocking. This could be different than the restocking percentage held in TSFHEAD if the user decides to change the percentage at item level.
finisherAverageRetail	No	Number (20,4)	Contains the weighted average retail of all the units of the transfer item currently at or in transit to the finisher. Applicable to two-legged transfers.
finisherUnits	No	Number (18,4)	Contains the number of units of the transfer item currently at or in transit to the finisher. Applicable to two-legged transfers
exchangeDate	No	date	This is the date when the price change or cost change was posted in the transaction system.
docCurrencyCode	No	String (30)	Code for the currency in which the document was created in the source system.
locCurrencyCode	No	String (30)	Usually the reporting currency code for the financial company in which the document was created.
global1ExchangeRate	No	Number (22,7)	This is the exchange rate from Local currency to the first Global currency. The Global currencies are defined in the global currency master table.
global2ExchangeRate	No	Number (22,7)	This is the exchange rate from Local currency to the second Global currency. The Global currencies are defined in the global currency master table.
global3ExchangeRate	No	Number (22,7)	This is the exchange rate from Local currency to the third Global currency. The Global currencies are defined in the global currency master table.
locExchangeRate	No	Number (22,7)	This is the exchange rate from Local Currency to the Preferred Currency.

Table 3-31 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
transferNo	Yes	String (30)	This is the unique number to identify the transfer within the system.
item	Yes	String (80)	This column contains a unique alphanumeric value that identifies the item.
toLocation	Yes	String (80)	This is the Organization number or short name
message	Yes	String (2000)	Identifies error during business data processing of the request.

Sample Input Message

{
  "count": 1,
  "items": [
    {
      "action": "INSERT",
      "transferNo": "100000405015",
      "transferParentNo": "String",
      "orderNo": "String",
      "fromLocationType": "W",
      "fromLocation": "10001",
      "toLocation": "849215724",
      "createDateTime": "2001-12-31T23:59:59.123Z",
      "expectedDcDate": "2001-12-31",
      "invType": "A",
      "transferType": "MR",
      "transferStatus": "A",
      "freightCode": "N",
      "routingCode": "2",
      "createId": "RMS_ADMIN",
      "approvalDate": "2001-12-31",
      "approvalId": "RMS_ADMIN",
      "deliveryDate": "2001-12-31",
      "closeDate": "2001-12-31",
      "externalReferenceNo": "10027740",
      "comments": "Create a Manual Requisation transfer from warehouse to Store For Regular item",
      "expectedDcEowDate": "2001-12-31",
      "massReturnTransferNo": "String",
      "notAfterDate": "2001-12-31",
      "contextType": "String",
      "contextValue": "String",
      "restockingPercentage": 10,
      "franchiseNeedDate": "2001-12-31",
      "deliverySlotId": "String",
      "franchiseOrder": "90011",
      "franchiseReturnAuthorizationNo": "String",
      "srcEffFromDt": "2001-12-31",
      "srcEffToDt": "2001-12-31",
      "details": [
        {
          "item": "105200252",
          "transferSeqNo": 1,
          "invStatus": "1",
          "transferPrice": 100.48,
          "transferAverageCost": 100.48,
          "transferQuantity": 1,
          "fillQuantity": 1,
          "shipQuantity": 1,
          "receivedQuantity": 1,
          "reconciledQuantity": 1,
          "distroQuantity": 1,
          "selectedQuantity": 1,
          "cancelledQuantity": 1,
          "supplierPackSize": 20.00,
          "transferOrderLinkNo": "String",
          "defaultCharges2ndLegInd": "?",
          "transferCost": 21.00,
          "restockingPercentage": 16.00,
          "finisherAverageRetail": 11.00,
          "finisherUnits": 78.00,
          "exchangeDate": "2001-12-31",
          "docCurrencyCode": "USD",
          "locCurrencyCode": "USD",
          "global1ExchangeRate": 15.00,
          "global2ExchangeRate": 12.00,
          "global3ExchangeRate": 96.00,
          "locExchangeRate": 19.00
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Response Code: 400 (Error)

Table 3-32 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
transferNo	Yes	String (30)	This is the unique number to identify the transfer within the system.
item	Yes	String (80)	This column contains a unique alphanumeric value that identifies the item.
toLocation	Yes	String (80)	This is the Organization number or short name
message	Yes	String (2000)	Identifies error during business data processing of the request.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    {
      "transferNo": "100000405015",
      "item": "10200011",
      "toLocation": "1122",
      "message": "One or more of the required fields is NULL, example transfer number or org/location number"
    }
  ]
}