Openapi For Warehouse FAQ – OneWarehouse

Question 1: What is the meaning of each interface? Which interfaces are necessary to be connected in series?

A: To ensure smooth collaboration between OneWarehouse (OW) and your WMS system, the APIs are divided into two main categories: "Push" and "Query". APIs marked with a ⭐️ symbol are core interfaces that are strongly recommended to be accepted .

A. Service Push and Feedback Interface

Business Scenarios	API Interface Name	Direction of transmission	Triggering and Application Context Description
Products	⭐️ Products are available simultaneously	OW ➔ WMS	When OW adds or updates product profiles, it pushes the data to WMS for filing.
Inbound	⭐️ Placement of Purchase Receipt Order	OW ➔ WMS	After OW creates a "Purchase Receipt Order", it pushes the document to WMS to prepare for receiving the goods.
	⭐️ Order for returned goods received	OW ➔ WMS	After OW executes the "Return Inbound Order", it pushes the return information to WMS.
	⭐️ Inbound order cancellation	OW ➔ WMS	When OW initiates the cancellation of an inbound order (including purchases/returns), it sends a cancellation request.
	⭐️ Inbound order callback	WMS ➔ OW	After WMS completes the actual receipt and warehousing, it sends the "warehousing status and actual details" back to OW.
Outbound	⭐️ Order placement for outbound shipment	OW ➔ WMS	When OW executes a shipment, it pushes the "outbound order" to WMS to arrange picking and packing.
	⭐️ Outbound order cancellation	OW ➔ WMS	When OW initiates a shipment interception, it pushes a shipment cancellation request to WMS.
	⭐️ Outbound order callback	WMS ➔ OW	After WMS completes the packaging and dispatch, it sends "dispatch status, package and dispatch details" back to OW.
	⭐️ Warehouse cancels shipment	WMS ➔ OW	When WMS detects an anomaly (such as out of stock/damage) and needs to actively interrupt shipment, it pushes a cancellation request to OW.

B. Query and Auxiliary Interface

Business Scenarios	API Interface Name	Direction of transmission	Triggering and Application Context Description
Outbound	⭐️ Obtain the waybill (shipping label)	WMS ➔ OW	WMS can retrieve the logistics tracking document of outbound orders (download link in PDF format).
	Get self-drawn waybill parameters	WMS ➔ OW	If WMS does not directly retrieve the image file, it can obtain the underlying parameters of the waybill and have the WMS system draw and render the waybill itself.
	⭐️Request unpacking interface	WMS ➔ OW	When the warehouse finds that an order is too large and needs to be split into multiple packages, call this interface to request a new sub-tracking number.
Base	Get merchant information	WMS ➔ OW	WMS allows you to query basic information such as the company name of the merchant.

Question 2: System trigger node in the API interface

A: The following are the specific operation nodes for triggering a call in the OW system:

Interface Name	Business type	Triggering Nodes and Execution Actions	Operation path (OW backend)
Product synchronization interface	Product	1. New Product : Click the "Save" button on the purchase receipt. 2. Old products (already in stock) : Click the "Save" button on the product editing page.	1. Purchase Receipt > Create Receipt Order 2. Product Management > Editing
Purchase receipt order interface	Inbound	Click the "Save" button on the purchase receipt.	Purchase receipt > Create receipt
Return and Inbound Order Interface		Click the "Execute Return" button on the return order (pending processing).	Returns Management
Inbound Order Cancellation Interface		Click the "Cancel" button on the inbound order (pending inbound).	Purchase and warehousing
Outbound order placement interface	Outbound	Click the "Execute Shipment" button for the order (pending processing).	Order Management
Outbound Order Cancellation Interface	Outbound	Click the "Intercept Shipment" button for the order (pending shipment).	Order Management
Inventory Inquiry Interface	in stock	The timed trigger is configured by the internal scheduling of OW.	(Executed in the system background)

Question 3: What are the corresponding purposes of the callback key and the delivery key? What is the basis for checking the Webhook Request?

A: These two sets of keys play a crucial role in identity verification during system interactions:

Callback Key

Purpose : This is used by WMS to perform "identity verification" when calling back the OW system after a successful inbound/outbound operation. It ensures the request originates legitimately and prevents unauthorized access.
Inspection criteria :
1. Key consistency : Checks whether the key in the request is completely consistent with the callback key stored in the OW system.
2. Source verification : Confirmed that the request did indeed originate from the WMS system.
3. Timestamps and signatures (if applicable) : Combine timestamps and signatures for verification to ensure timeliness and data integrity.

[Push Key]

Purpose : "Identity verification" when the OW system calls the WMS system. OW will send a request to WMS containing fields such as sign(signature) and (timestamp).timestamp
Inspection criteria :
1. Encryption result consistency : WMS must use the issued key and specified encryption method to encrypt the request parameters, and the result must be signcompletely consistent with the one in the request.
2. Parameter validation : Validate timestampparameters to ensure the request has not expired.
3. Security : Ensure that the encryption algorithm used is secure and has no known vulnerabilities.

Question 4: In a multi-merchant business scenario, how does the WMS distinguish the identity of the cargo owner?

A: In the API parameters, the system uniformly uses account_nothe field as the cargo owner's unique identity ID.

Practical suggestion : Please link the internally created customer files in your WMS system with the files issued by OW account_no. This will allow your WMS to accurately identify and process product, document, and inventory information from different merchants.

Question 5: Is it necessary to set up an IP whitelist restriction?

A: It depends on the security requirements of the WMS system. There are no IP restrictions on the OW client .

WMS End-to-End Restrictions (Optional Configuration) : If your WMS system requires security restrictions on access sources, we provide a fixed egress IP address for the OneWarehouse system . Please add the following IP address to the whitelist in your firewall / gateway to successfully receive push requests from OneWarehouse .
OW -side restrictions (no configuration required) : When the WMS system calls back to the OneWarehouse gateway, the OW system will not implement IP whitelist restrictions , and your company does not need to provide us with the outbound IP .

OneWarehouse system fixed exit IP address list (for WMS whitelist configuration):

121.11.221.130
121.11.221.131
52.77.143.211
122.248.196.11
46.51.219.5
13.214.244.173
18.143.33.165
13.215.123.123
120.78.70.56
120.78.69.89
120.78.67.40
120.78.71.91