API Docs
API Reference
Inbound API
RN Import

RN Import API

This article introduces the general RN (Receive Notice) Import API use case for easily understanding and applying this API.

Introduction

The RN Import API facilities the automated integration of receipt notice into the WMS from external systems. Its purpose is to streamline the inbound goods process by allowing the WMS to receive advanced shipment notifications (ASN) or receipt data, updating inventory records and managing the flow of goods in real-time.

The key functions of the RN Import API are:

  1. Automated Data Input: Imports shipment or receipt data into the WMS, eliminating the need for manual entry.
  2. Inventory Updates: As goods are received, the API automatically updates inventory levels within the system.
  3. Shipment Tracking: Enhance tracking capabilities by synchronizing receipt data with the WMS for improved accuracy in warehouse operations.

API Request

API: POST /edi/inbound/receipt
Body Request:

Main Fields

FieldNameDescriptionDataTypeLengthRequiredVersionSample
Root
1CompanyIDHard code, assigned by UNIS system admin.string15Yes1.2"LT"
2CustomerIDHard code, assigned by UNIS accounting dept.string15Yes1.2"AUKINT0001"
3FacilityIDstring15yes1.2"889"
4ASNContent (opens in a new tab)
5TitleIDTitleID which setup under Customerstringno1.3""

ASNContent Fields

FieldNameDescriptionDataTypeLengthRequiredVersionSample
Root
4.1ReceiptTypeReceipt Typestring50no1.3.1Default is "Regular Receipt" when it is empty

Available value:
"Regular Receipt",
"Title Transfer Receipt",
"Migo Transfer Receipt",
"Sales Return",
"Transload"
"Assembly"
4.3SupplierIDA party that supplies goods. If you did not set multiple suppliers with UNIS, you can ignore this field.string15"AUKINT0001"
4.4PONoInbound Purchase Order Number, which is a uniquely identifies a purchase order and is generally defined by the buyer.string50yes"62007331"
4.5ReferenceNoUnique identifier, indicate an order.string50"007690"
4.6BOLNoThe bill of lading (BOL) works as a receipt of freight services, a contract between a freight carrier and shipper and a document of title.string50
4.7ContainerNoContainer Numberstring50"MEDU7701854"
4.8SealsContainer Sealsstring50"FJ09227242"
4.9CarrierNameCarrier Name, it is required if SCACCode is emptystring15"BESTOCEAN"
4.10SCACCodeIt is a privately controlled US code used to identify vessel operating common carriers (VOCC). It is typically two to four letters long.string15"UULN"
4.11ScheduledDateEstimated time of arrivaldatetime"5/18/2020 12:00:00 AM"
4.12ShippingInstructionShipping Instructionstring1000
4.13DynTxtPropertyValue01Customized field 01string100
4.14DynTxtPropertyValue02Customized field 02string100
4.15DynTxtPropertyValue03Customized field 03string100
4.16DynTxtPropertyValue04Customized field 04string100
4.17DynTxtPropertyValue05Customized field 05string100
4.18DynTxtPropertyValue06Customized field 06string100
4.19DynTxtPropertyValue07Customized field 07string100
4.20DynTxtPropertyValue08Customized field 08string100
4.21DynTxtPropertyValue09Customized field 09string100
4.22DynTxtPropertyValue10Customized field 10string100
4.23DynTxtPropertyValue11Customized field 11string100
4.24DynTxtPropertyValue12Customized field 12string100
4.25DynTxtPropertyValue13Customized field 13string100
4.26DynTxtPropertyValue14Customized field 14string100
4.27DynTxtPropertyValue15Customized field 15string100
4.28DynTxtPropertyValue16Customized field 16string100
4.29DynTxtPropertyValue17Customized field 17string100
4.30DynTxtPropertyValue18Customized field 18string100
4.31DynTxtPropertyValue19Customized field 19string100
4.32DynTxtPropertyValue20Customized field 20string100
4.33ActionCodeIndicates whether you want to create a new order or cancel an order. Supported Value: Hardcode "Imported" -- to create a new order or update an existing order which status is Imported; Hardcode "Cancelled" -- to Cancel an existing order which status is Imported. If the order status is not imported, you will receive an error message and will need to contact operation CSR to help cancel in WISE internal portal.string15
4.34ETDThe estimated time of departure is the projection of time that is expected for a transport system to depart its point of origin/location.string50"5/22/2020 12:00:00 AM"
4.35Items (opens in a new tab)object
4.36Cartons (opens in a new tab)Provide Carton Level information, only when you want UNIS operation team to receive by particular CartonNo.object
4.37StatusIndicates to create a new order.

Supported Value
"Imported"：
to create a new order or update an existing order which status is Imported or Open;		string20Yes1.3.1Imported
Items Fields
FieldNameDescriptionDataTypeLengthRequiredSample
Root
4.35.1POLineNoYou can pass in a sequance number for each ItemLine, it will be returned on the RC(Receiving Confirmation) file. Or you can leave it empty.int
4.35.2ItemNumberProduct Item Name, it is your unique Item SKU#.string30Yes"CA-H510B-W1"
4.35.3ExpectedQtyExpeted Qty to receive.stringYes"917.000000"
4.35.4LotNoA lot number is an identification number assigned to a particular quantity or lot of material from a single manufacturer. It is used for FIFO, if you don't have it, just leave it empty.string30
4.35.5PalletsExpected pallet quantity to receivedecimal5,2
4.35.6ItemNotesItem Notesstring1000
4.35.7UOMUnit of Measurement Supported Value: EA = Units/Each CS= Casestring15Yes
4.35.8DynTxtPropertyValue01Customized field 01string200
4.35.9DynTxtPropertyValue02Customized field 02string200
4.35.10DynTxtPropertyValue03Customized field 03string200
4.35.11DynTxtPropertyValue04Customized field 04string200
4.35.12DynTxtPropertyValue05Customized field 05string200
4.35.13DynTxtPropertyValue06Customized field 06string200
4.35.14DynTxtPropertyValue07Customized field 07string200
4.35.15DynTxtPropertyValue08Customized field 08string200
4.35.16DynTxtPropertyValue09Customized field 09string200
4.35.17DynTxtPropertyValue10Customized field 10string200
4.35.18DynTxtPropertyValue11Customized field 11string200
4.35.19DynTxtPropertyValue12Customized field 12string200
4.35.20DynTxtPropertyValue13Customized field 13string200
4.35.21DynTxtPropertyValue14Customized field 14string200
4.35.22DynTxtPropertyValue15Customized field 15string200
4.35.23DynTxtPropertyValue16Customized field 16string200
4.35.24DynTxtPropertyValue17Customized field 17string200
4.35.25DynTxtPropertyValue18Customized field 18string200
4.35.26DynTxtPropertyValue19Customized field 19string200
4.35.27DynTxtPropertyValue20Customized field 20string200
4.35.28Receiving PrioritySupported Value: 1-100 100 is the highest priority level.string50
4.35.29GoodsTypeGoods type which defined by customerstring10No
4.35.30TitleIDTitleID which setup under CustomerstringNo
Cartons Fields
FieldNameDataTypeLength
Root
4.36.1CartonNostring50
4.36.2PoundPerCarton
4.36.3ItemLines (opens in a new tab)object
ItemLines Fields
FieldNameDescriptionDataTypeLength
Root
4.36.3.1ItemIDProduct Item Name, it is your unique Item SKU#.string50
4.36.3.2LotNoA lot number is an identification number assigned to a particular quantity or lot of material from a single manufacturer.string50
4.36.3.3QtyInCartonEA Quantity per Cartonstring
4.36.3.4UOMUnit of Measurement Supported Value: EA = Units/Each CS= Casestring15
4.36.3.5DynTxtPropertyValue01Customized field 01string200
4.36.3.6DynTxtPropertyValue02Customized field 02string200
4.36.3.7DynTxtPropertyValue03Customized field 03string200
4.36.3.8DynTxtPropertyValue04Customized field 04string200
4.36.3.9DynTxtPropertyValue05Customized field 05string200
4.36.3.10DynTxtPropertyValue06Customized field 06string200
4.36.3.11DynTxtPropertyValue07Customized field 07string200
4.36.3.12DynTxtPropertyValue08Customized field 08string200
4.36.3.13DynTxtPropertyValue09Customized field 09string200
4.36.3.14DynTxtPropertyValue10Customized field 10string200
4.36.3.15DynTxtPropertyValue11Customized field 11string200
4.36.3.16DynTxtPropertyValue12Customized field 12string200
4.36.3.17DynTxtPropertyValue13Customized field 13string200
4.36.3.18DynTxtPropertyValue14Customized field 14string200
4.36.3.19DynTxtPropertyValue15Customized field 15string200
4.36.3.20DynTxtPropertyValue16Customized field 16string200
4.36.3.21DynTxtPropertyValue17Customized field 17string200
4.36.3.22DynTxtPropertyValue18Customized field 18string200
4.36.3.23DynTxtPropertyValue19Customized field 19string200
4.36.3.24DynTxtPropertyValue20Customized field 20string200

API Return

This section introduces the parameters which from RN import result.

FieldNameDescriptionDataTypeLengthVersionSample
Root
1CustomerIDHard code, assigned by UNIS accounting dept.string151.2"AUKINT0001"
2PONoInbound Purchase Order Number, which is a uniquely identifies a purchase order and is generally defined by the buyer.string501.2
3ReferenceNoUnique identifier, indicate an order.string501.2"1209129"
4WISEPOIDUNIS System (WISE) Receipt Number, unique in UNIS system.string501.2"DN-94776"
5StatusResult Statusstring301.2"Warning"
6ErrorError messagestring10001.2

Example

Request

 // Url
 http://preview.logisticsteam.com/shared/bam/v1/public/edi/inbound/receipt
 
 // Body
 {
   "CompanyID": "LT",
   "CustomerID": "AUKINT0001",
   "FacilityID": "889",
   "ASNContent":  {
     "SupplierID": "AUKINT0001",
     "Title": null,
     "PONo": "62007331",
     "ReferenceNo": "007690",
     "BOLNo": "",
     "ContainerNo": "MEDU7701854",
     "Seals": "FJ09227242",
     "CarrierName": "BESTOCEAN",
     "SCACCode": "UULN",
     "ScheduledDate": "5/18/2020 12:00:00 AM",
     "ShippingInstruction": "",
     "DynTxtPropertyValue01": "",
     "DynTxtPropertyValue02": "",
     "DynTxtPropertyValue03": "",
     "DynTxtPropertyValue04": "",
     "DynTxtPropertyValue05": "",
     "DynTxtPropertyValue06": "",
     "DynTxtPropertyValue07": "",
     "DynTxtPropertyValue08": "",
     "DynTxtPropertyValue09": "",
     "DynTxtPropertyValue10": "",
     "DynTxtPropertyValue11": "",
     "DynTxtPropertyValue12": "",
     "DynTxtPropertyValue13": "",
     "DynTxtPropertyValue14": "",
     "DynTxtPropertyValue15": "",
     "DynTxtPropertyValue16": "",
     "DynTxtPropertyValue17": "",
     "DynTxtPropertyValue18": "",
     "DynTxtPropertyValue19": "",
     "DynTxtPropertyValue20": "",
     "Items": [
       {
         "POLineNo": "1",
         "ItemNumber": "CA-H510B-W1",
         "ExpectedQty": "917.000000",
         "PalletSizeID": "",
         "Kitting": null,
         "KittingItems": null,
         "LotNo": "",
         "UOM": "",
         "Pallets": "29",
         "ItemNotes": "",
         "DynTxtPropertyValue01": "",
         "DynTxtPropertyValue02": "",
         "DynTxtPropertyValue03": "",
         "DynTxtPropertyValue04": "",
         "DynTxtPropertyValue05": "",
         "DynTxtPropertyValue06": "",
         "DynTxtPropertyValue07": "EA",
         "DynTxtPropertyValue08": "",
         "DynTxtPropertyValue09": "",
         "DynTxtPropertyValue10": "",
         "DynTxtPropertyValue11": "",
         "DynTxtPropertyValue12": "",
         "DynTxtPropertyValue13": "",
         "DynTxtPropertyValue14": "",
         "DynTxtPropertyValue15": "",
         "DynTxtPropertyValue16": "",
         "DynTxtPropertyValue17": "",
         "DynTxtPropertyValue18": "",
         "DynTxtPropertyValue19": "",
         "DynTxtPropertyValue20": "",
         "ReceivingPriority": ""
       }
     ],
     "Cartons": [],
     "Status": "Imported",
     "Source": "EDI",
     "ActionCode": "",
     "ETD": "5/22/2020 12:00:00 AM"
   }
 }

Response

  // Success return
 {
    "Receipt": {
       "CustomerID": "AUKINT0001",
       "PONo": "1187494_2",
       "ReferenceNo": [],
       "WISEPOID": "RN-6428",
       "Status": "Success",
       "Error": []
    }
 }
 // Failed return
 [
     {
         "code": "EDI-ERROR-SupplierID is required",
         "error": "SupplierID is required"
     }
 ]
Inbound APIRN Cancellation