1. Implementation Guide
  2. Appendix - Outbound and Inbound Interfaces

B Appendix - Outbound and Inbound Interfaces

Outbound from WMS Cloud

The following lists all the outbound interfaces from WMS Cloud available in USM, for integration into Merchandising or SIOCS, along with their interface names, template files, service definition files, orchestration files, supported message types, and payloads.

Note:

These interfaces have the exact same Failure and Response templates. Namely:

  • LogFireToRib_DefaultAllAction_ResponseDataMapping.template

  • LogFireToRib_DefaultAllAction_FailureResponseDataMapping.template

You will be able to see the details available in these templates in the USM screens to help with resolving any issues in the integration. See also the Integration Errors.

ASN Outbound

This integration will be used for shipments from the warehouse to a store or to another warehouse. It also will be used for customer orders that are shipped to the customer directly.

WMS Cloud Integrations

Service Definition

  • LogFireToRibASNOutObLoad_ServiceMappingDef.json

  • LogFireToRibASNOutObManifest_ServiceMappingDef.json

Orchestration File

  • LogFireToRibASNOutObLoad_ServiceMappingOrchestration.smo

  • LogFireToRibASNOutObManifest_ServiceMappingOrchestration.smo

ASN Out (ASNOutCre)

RIB Payload

  • ASNOutDesc

Template Files (Request)

  • LogFireToRibASNOutObLoad_HttpPost_RequestResponseDataMapping.template

  • LogFireToRibASNOutObManifest_HttpPost_RequestResponseDataMapping.template

Inventory Adjustments

Any inventory adjustments that will increment or decrement inventory in the warehouse will be sent via this integration point. This includes removing inventory from stock completely or moving it to and from an available status. See "Appendix - Activity Codes" for more information about mapping inventory adjustments.

WMS Cloud Integrations

Service Definition

  • LogFireToRibInvAdjust_ServiceMappingDef.json

Orchestration File

  • LogFireToRibInvAdjust_ServiceMappingOrchestration.smo

Inventory Adjustment (InvAdjustCre)

RIB Payload

  • InvAdjustDesc

Template Files (Request)

  • LogFireToRibInvAdjust_HttpPost_RequestDataMapping.template

Return to Vendor Shipments

This integration will be used when shipping inventory back to a supplier from the warehouse. RTV shipments support returns from both available and unavailable inventory buckets. When shipping out an RTV order from a non-sellable bucket, the inventory disposition codes in the shipment will be based on lock codes in WMS.

WMS Cloud Integrations

Service Definition

  • LogFireToRibRTV_ServiceMappingDef.json

Orchestration File

  • LogFireToRibRTV_ServiceMappingOrchestration.smo

RTV (RTVCre)

RIB Payload

  • RTVDesc

Template Files (Request)

  • LogFireToRibRTV_HttpPost_RequestDataMapping.template

Receiving

This integration will be used for receipts of purchase orders, transfers, or allocations into the warehouse. Both container level and detailed receipts will flow through this message to update Merchandising.

WMS Cloud Integrations

Service Definition

  • LogFireToRibReceipt_ServiceMappingDef.json

Orchestration File

  • LogFireToRibReceipt_ServiceMappingOrchestration.smo

Receipt (ReceiptMod)

RIB Payload

  • ReceiptDesc

Template Files (Request)

  • LogFireToRibReceipt_HttpPost_RequestDataMapping.template

Stock Order Status

This integration will be used to communicate updates for stock orders - which can be either a transfer or allocation. Status updates are based on certain activity codes in the Inventory History table in WMS Cloud. See "Appendix - Activity Codes" for more details.

WMS Integrations

Service Definition

  • LogFireToRibSOStatus_ServiceMappingDef.json

Orchestration File

  • LogFireToRibSOStatus_ServiceMappingOrchestration.smo

SO Status (SOStatusCre)

RIB Payload

  • SOStatusDesc

Template Files (Request)

  • LogFireToRibSOStatus_HttpPost_RequestDataMapping.template

Inbound to WMS Cloud

The following lists the inbound interfaces to interfaces used for integration into WMS Cloud from Merchandising or SIOCS, along with their interface names, template files, service definition files, orchestration files, supported message types, and payload name. Because of how WMS Cloud consumes data, for the following interface points, a full payload is used for sending updates from Merchandising, rather than just the data that changed: items, purchase orders, stock orders, vendors, and RTV requests, using the "FullRep" message type.

The following list of Interfaces have the exact same Failure and Response templates.

  • RibToLogFire_DefaultAllAction_FailureResponseDataMapping.template

  • RibToLogFire_DefaultAllAction_ResponseDataMapping.template

Store

This integration will send new and updated store information from Merchandising to WMS Cloud. If a store is deleted in Merchandising, that will also be communicated to WMS Cloud.

WMS Cloud Integrations

Service Definition

  • RibToLogFireStores_ServiceMappingDef.json

Orchestration File

  • RibToLogFireStores_ServiceMappingOrchestration.smo

Create and Modify (StoreCre)

RIB Payload

  • StoreDesc

Template Files (Request)

  • RibToLogFireStores_StoreCre_RequestDataMapping.template

Delete (StoreDel)

RIB Payload

  • StoreRef

Template Files (Request)

  • RibToLogFireStores_StoreDel_RequestDataMapping.template

Vendor

This integration will send new and updated supplier site information from Merchandising to WMS Cloud. If a supplier site is deleted, that will also be communicated to WMS Cloud.

WMS Cloud Integrations

Service Definition

  • RibToLogFireVendor_ServiceMappingDef.json

Orchestration File

  • RibToLogFireVendor_ServiceMappingOrchestration.smo

Vendor Create (VendorCre) and Modify (VendorFulRep)

RIB Payload

  • VendorDesc

Template Files (Request)

  • RibToLogFireVendor_VendorCre_RequestDataMapping.template

Vendor Delete (VendorDel)

RIB Payload

  • VendorRef

Template Files (Request)

  • RibToLogFireVendor_VendorDel_RequestDataMapping.template

External Finisher

This integration will send new and updated external finisher information, including addresses, from Merchandising to WMS Cloud. If an external finisher or its address is deleted, that will also be communicated to WMS Cloud.

WMS Cloud Integrations

Service Definition

  • RibToLogFirePartner_ServiceMappingDef.json

Orchestration File

  • RibToLogFirePartner_ServiceMappingOrchestration.smo

Partner Create (PartnerCre PartnerDtlCre) and Modify (PartnerDtlMod, PartnerMod)

RIB Payload

  • PartnerDesc

Template Files (Request)

  • RibToLogFirePartner_PartnerCre_RequestDataMapping.template

Partner Delete (PartnerDel)

RIB Payload

  • PartnerRef

Template Files (Request)

  • RibToLogFirePartner_PartnerDel_RequestDataMapping.template

Partner Details Delete (PartnerDtlDel)

RIB Payload

  • PartnerRef

Template Files (Request)

  • RibToLogFirePartner_PartnerDtlDel_RequestDataMapping.template

Items

This integration will send new or updated items to WMS Cloud from Merchandising, including parent items, transaction level items, and reference items, as applicable. Only approved items are sent in this integration. For pack items, the component details for the pack are also integrated. See the Items section for key assumptions about items that are integrated to WMS Cloud.

Note:

Item Delete is not currently supported in this integration.

WMS Cloud Integrations

Service Definition

  • RibToLogFireItem_ServiceMappingDef.json

Orchestration File

  • RibToLogFireItem_ServiceMappingOrchestration.smo

Item Create (ItemCre, ItemUpcCre, ItemBomCre) and Modify (ItemUpcMod, ItemBomMod, ItemFulRep)

RIB Payload

  • ItemDesc

Template Files (Request)

  • RibToLogFireItem_ItemCre_RequestResponseDataMapping.template

  • RibToLogFireItem_ItemUpcCre_RequestResponseDataMapping.template

  • RibToLogFireItem_ItemBomCre_RequestResponseDataMapping.template

ASN Inbound

This integration is used to map shipments inbound to a warehouse, which could be from a supplier or a store. Modifications to shipments or deletions of a shipment can also occur based on adjustments sent from a store or supplier.

WMS Cloud Integrations

Service Definition

  • RibToLogFireASNIn_ServiceMappingDef.json

Orchestration File

  • RibToLogFireASNIn_ServiceMappingOrchestration.smo

Create (ASNInCre or Modify (ASNInMod)

RIB Payload

  • ASNInDesc

Template Files (Request)

  • RibToLogFireASNIn_ASNInCre_RequestDataMapping.template

Delete (ASNInDel)

RIB Payload

  • ASNInRef

Template Files (Request)

  • RibToLogFireASNIn_ASNInDel_RequestDataMapping.template

Order

This interface is used to send new and updated purchase orders from Merchandising to WMS Cloud. Only approved orders with a warehouse as one of the destination locations will be sent to WMS Cloud. For more details about PO mapping rules, see the Purchase Orders section.

WMS Cloud Integrations

Service Definition

  • RibToLogFireOrder_ServiceMappingDef.json

Orchestration File

  • RibToLogFireOrder_ServiceMappingOrchestration.smo

PO Create (POCre) and Modify (POFulRep)

RIB Payload

  • PODesc

Template Files (Request)

  • RibToLogFireOrder_POCre_RequestDataMapping.template

PO Delete (PODel)

RIB Payload

  • PORef

Template Files (Request)

  • RibToLogFireOrder_PODel_RequestDataMapping.template

Stock Order

Stock orders can be either transfers or allocations, including customer order related transfers. These orders are sent from Merchandising to WMS Cloud when the warehouse is either the shipping location or the receiving location on the stock order. Only approved stock orders will be integrated.

WMS Cloud Integrations

Service Definition

  • RibToLogFireStockOrder_ServiceMappingDef.json

Orchestration File

  • RibToLogFireStockOrder_ServiceMappingOrchestration.smo

Stock Order Create (SOCre) or Modify (SOFulRep)

RIB Payload

  • SODesc

Template Files (Request)

  • RibToLogFireStockOrder_SOCre_RequestDataMapping.template

Stock Order Header Delete (SOHdrDel)

RIB Payload

  • SORef

Template Files (Request)

  • RibToLogFireStockOrder_SOHdrDel_RequestDataMapping.template

RTV Requests

This integration will send return to vendor transactions initiated in Merchandising that are requested to be shipped from a warehouse. Merchandising sends the inventory disposition code in the RTV request if the inventory to be returned is from an unavailable bucket. If the RTV line item is returned from the multiple inventory status codes, then Merchandising sends these codes in a comma-separated list.

WMS Cloud Integrations

Service Definition

  • RibToLogFireRTVReq_ServiceMappingDef.json

Orchestration File

  • RibToLogFireRTVReq_ServiceMappingOrchestration.smo

Create RTV Request (RTVReqCre) or Modify (RTVReqFulRep)

RIB Payload

  • RTVReqDesc

  • RTVReqRef

Template Files (Request)

  • RibToLogFireRTVReq_RTVReqCre_RequestDataMapping.template

Delete RTV Request (RTVReqDel)

RIB Payload

  • RTVReqDesc

  • RTVReqRef

Template Files (Request)

  • RibToLogFireRTVReq_RTVReqDel_RequestDataMapping.template