RN Cancellation API
This article introduces the general RC Cancellation API for easily understanding and applying this API.
Introduction
The RC Cancellation API in the WMS domain is used to cancel receipt nonfiction. This API allows users to reverse or remove a previously created RN entry, typically representing the receipt of products at a warehouse.
Using this API, businesses can correct errors, handle returns or cancel orders that were mistakenly processed. The purpose of this API is to ensure accurate inventory tracking an maintain operation integrity by allowing cancellation within the system when necessary.
API Request
API: PUT /edi/inbound/receipt/cancel
Body Request:
| FieldName | Description | DataType | Length | Required | Version | Sample | |
|---|---|---|---|---|---|---|---|
| Root | |||||||
| 1 | CompanyID | Hard code, assigned by UNIS system admin. | string | 15 | Yes | 1.4 | "LT" |
| 2 | FacilityID | FacilityID indicates which warehouse UNIS ship from. It should be assigned by UNIS CSR | string | 15 | Yes | 1.4 | "889" |
| 3 | CustomerID | Hard code, assigned by UNIS accounting dept. | string | 15 | Yes | 1.4 | "AUKINT0001" |
| 4 | PONo | Your customer's Purchse Order Number, doesn't need to be unique. | string | 50 | No | 1.4 | "8957515451-10" |
| 5 | ReferenceNo | Reference Number, Unique identifier, indicate an order. | string | 50 | No | 1.4 | "LIV2020021804-10" |
| 6 | CancelNote | Created From | string | 50 | No | 1.4 | "Cancel by consumer" |
API Request
It will return a message to indicate whether the cancellation successes or not. For more details, please refer to the Example below.
Example
Request
// Url
http://preview.logisticsteam.com/shared/bam/v1/public/edi/inbound/receipt/cancel
// Body
{
"CompanyID": "LT",
"CustomerID": "AUKINT0001",
"FacilityID": "889",
"PONo": "2007331_1",
"ReferenceNo": "liv202001159-1",
"CancelNote": "Cancel for testing"
}Response
// Success return
{
"success": true
}// Failed return
{
"error": "Not found order"
}