Glossary
TERM | EXPLANATION |
|---|---|
ORP | Omni-channel Retail Platform |
OMS | Order Management System (part of ORP) |
FTP server | File Transfer Protocol server |
DTO | Data Transfer Object |
Table of contents
Introduction
The purpose of this document is to detail the various aspects that need to be taken into account to integrate your WeChat webstore with ORP.
ORP facilitates the interaction between WeChat and your ERP systems. That means, all orders placed on WeChat are made available in a central location in ORP that can be conveniently imported. Similarly, ORP implements a simple approach to updating your WeChat webstore’s stock and relaying shipping information to your customers.
Integration overview
ORP facilitates 3 different interactions:
...
Once an order has been processed and shipped, shipping information needs to be uploaded to your FTP instance. This information will be imported into ORP and forwarded to WeChat where the customer will be informed of their order’s progress.
Orders
Orders will be placed in the corresponding folder on the FTP. It is your responsibility to monitor this folder and import any orders that are placed inside this folder into your system(s).
Orders will be in JSON format and will conform to a standard set out and maintained by Wolfpack DCS. See Order data contract.
Order statuses
ORP orders placed on the FTP can be in one of the following statuses:
...
The CANCELLED status is assigned to an order when ORP receives shipping information containing only mispicks. No status update is sent, however the cancelled order information is still communicated to WeChat.
Order data contract
The JSON object format shown in figure 2 will be uploaded to the FTP instance - ready for import into your system(s). This is the Wolfpack DCS order DTO.
...
Figure 2: The ORP order JSON that will be uploaded to the FTP instance.
Stock
The stock keeping mechanism in ORP is kept simple with stock level processing occurring hourly.
...
The stock quantity in the uploaded .CSV file will become the newly available stock quantity in ORP.
Stock file format
ORP defines the format of the .CSV file as follows (figure 3):
...
The third column (stockentity) refers to the warehouse. It might be your brand has more than one warehouse where your products are stored. In this case, the product can be updated per SKU per warehouse. If only one warehouse exists, the same value can be populated for all rows in the file.
Updating stock deltas
When ORP receives the stock update file on the FTP instance, it will perform a “delta check” to determine whether the stock available for a specific SKU has in fact changed and merits an update. To illustrate this, consider the following:
...
By performing this delta check, ORP can limit the number of calls it makes to the WeChat platform by only updating what is necessary.
Shipping information
ORP enables you to update an order with shipping information by uploading a JSON object to the FTP instance. This information will be consequently imported into ORP and forwarded to WeChat.
ORP defines and maintains the data contract that will be used (see Shipping information data contract).
Shipping information data contract
Wolfpack DCS maintains the data contract of the shipping information (figure 4). It is your responsibility to upload the JSON object in figure 4 to your FTP instance:
...
Figure 4: The data contract for shipping information.
FTP
Wolfpack DCS has opted to use FTP file processing in facilitating the communication between your brand and ORP. The reason for this is because it aids in retrying in case of failures and also allows a neat history of the requests received - since all successfully processed files are archived automatically by ORP.
Each brand that integrates with ORP will have its own FTP instance and authentication credentials.
FTP environments
There will be 2 FTP environments:
...
Please contact a representative from Wolfpack DCS in order to receive FTP credentials. You can contact the team by sending an email to support@wolfpack-dcs.com.
FTP locations
ORP will use the following FTP locations to communicate orders and receive and process stock mutations and shipping information:
...