API Docs
API Reference
Inbound API
RC Search By Paging

RC Search By Paging API

This article introduces the general RC Search by Paging API use case for easily understanding and applying this API.

Introduction

The RC Search by Paging API is commonly used in WMS system to efficiently retrieve large sets of records from the system in a paginated format. It allows uses to search and filter records via PO# or a time range and return data in page, rather than fetching all data at once. This helps improve performance, particularly when dealing with extensive datasets.

The primary goal of the RC Search by Paging API is to optimize data retrieval in a way that minimizes the system’s resource load, making it easier for users to handle large volumes of records.

API Request

API: POST /edi/inbound/receipt/rc/search-by-paging
Body Request:

FieldNameDescriptionDataTypeLengthRequiredVersionSample
Root
1CompanyIDHard code, assigned by UNIS system admin.string15Yes1.2"LT"
2FacilityIDFacilityID indicates which warehouse UNIS ship from. It should be assigned by UNIS CSRstring15Yes1.2"889"
3CustomerIDHard code, assigned by UNIS accounting dept.string15Yes1.2"AUKINT0001"
4PONoInbound Purchase Order Number, which is a uniquely identifies a purchase order and is generally defined by the buyer.string50No1.2"8957515451-10"
5ReferenceNoUnique identifier, indicate an order.string50No1.2"LIV2020021804-10"
6CreatedWhenFromCreated Fromstring50No1.2"2020-02-24T00:11:11.892"
7CreatedWhenToCreated Tostring50No1.2
8PagingPagingobjectNo1.3
8.1PageNoPage NumberintNo1.3

API Return

This section introduces the parameters which from RN import result.

Main Fields

FieldNameDescriptionDataTypeLengthVersionSample
Root
1CompanyIDHard code, assigned by UNIS system admin.string151.2"889"
2CustomerIDHard code, assigned by UNIS accounting dept.string151.2"AUKINT0001"
3ReferenceNoUnique identifier, indicates an order.string501.2"Roy022501-3"
4PONoInbound Purchase Order Number, uniquely identifies a purchase order and is generally defined by buyer.string501.2"8957515451-3"
5RC (opens in a new tab)DC Contentobject1.2

RC Fields

FieldNameDescriptionDataTypeLengthVersion
Root
5.1CompanyIDHard code, assigned by UNIS system admin.string151.2
5.2CustomerIDHard code, assigned by UNIS accounting dept.string151.2
5.3SupplierIDA party that supplies goods. If you did not set multiple suppliers with UNIS, you can ignore this field.string151.2
5.4PONoInbound Purchase Order Number, uniquely identifies a purchase order and is generally defined by buyer.string501.2
5.5ReferenceNoUnique identifier, indicates an order.string501.2
5.6WISEPOIDUNIS System (WISE) Receipt Number, unique in UNIS system.string501.2
5.7ReceivedDateReceived Datestring81.2
5.8ContainerNumberContainer Numberstring501.2
5.10BOLNoThe bill of lading (BOL) works as a receipt of freight services, contract between carrier and shipper.string501.2
5.12CarrierNameCarrier Name, required if SCACCode is emptystring501.2
5.13SCACCodeCode to identify vessel operating common carriers (VOCC), typically 2-4 letters long.string501.2
5.14DynTxtPropertyValue01Customized field 01string2001.2
5.15DynTxtPropertyValue02Customized field 02string2001.2
5.16DynTxtPropertyValue03Customized field 03string2001.2
5.17DynTxtPropertyValue04Customized field 04string2001.2
5.18DynTxtPropertyValue05Customized field 05string2001.2
5.19DynTxtPropertyValue06Customized field 06string2001.2
5.20DynTxtPropertyValue07Customized field 07string2001.2
5.21DynTxtPropertyValue08Customized field 08string2001.2
5.22DynTxtPropertyValue09Customized field 09string2001.2
5.23DynTxtPropertyValue10Customized field 10string2001.2
5.24DynTxtPropertyValue11Customized field 11string2001.2
5.25DynTxtPropertyValue12Customized field 12string2001.2
5.26DynTxtPropertyValue13Customized field 13string2001.2
5.27DynTxtPropertyValue14Customized field 14string2001.2
5.28DynTxtPropertyValue15Customized field 15string2001.2
5.29DynTxtPropertyValue16Customized field 16string2001.2
5.30DynTxtPropertyValue17Customized field 17string2001.2
5.31DynTxtPropertyValue18Customized field 18string2001.2
5.32DynTxtPropertyValue19Customized field 19string2001.2
5.33DynTxtPropertyValue20Customized field 20string2001.2
5.34Items (opens in a new tab)object1.2
5.35Cartons (opens in a new tab)object1.2
Items Fields
FieldNameDescriptionDataTypeLengthVersion
Root
5.34.1POLineNoYou can pass in a sequence number for each ItemLine, it will be returned on the RC (Receiving Confirmation) file. Or you can leave it empty.1.2
5.34.2ItemNumberProduct Item Name, it is your unique Item SKU#.string501.2
5.34.3ReceivedQuantityReceived Quantityint1.2
5.34.4CustomerMaterialYour customer's product item number.string301.2
5.34.5ItemNoteItem Notesint1.2
5.34.6SerialNumberOnly apply to those Serialize product.string151.2
5.34.7LotNoA lot number is an identification number assigned to a particular quantity or lot of material from a single manufacturer.string151.2
5.34.8UOMUnit of Measurement. Supported Value: EA = Units/Each, CS = Casestring151.2
5.34.9ExpectedQtyExpected Qty to receive.1.2
5.34.10DynTxtPropertyValue01Customized field 01string2001.2
5.34.11DynTxtPropertyValue02Customized field 02string2001.2
5.34.12DynTxtPropertyValue03Customized field 03string2001.2
5.34.13DynTxtPropertyValue04Customized field 04string2001.2
5.34.14DynTxtPropertyValue05Customized field 05string2001.2
5.34.15DynTxtPropertyValue06Customized field 06string2001.2
5.34.16DynTxtPropertyValue07Customized field 07string2001.2
5.34.17DynTxtPropertyValue08Customized field 08string2001.2
5.34.18DynTxtPropertyValue09Customized field 09string2001.2
5.34.19DynTxtPropertyValue10Customized field 10string2001.2
5.34.20DynTxtPropertyValue11Customized field 11string2001.2
5.34.21DynTxtPropertyValue12Customized field 12string2001.2
5.34.22DynTxtPropertyValue13Customized field 13string2001.2
5.34.23DynTxtPropertyValue14Customized field 14string2001.2
5.34.24DynTxtPropertyValue15Customized field 15string2001.2
5.34.25DynTxtPropertyValue16Customized field 16string2001.2
5.34.26DynTxtPropertyValue17Customized field 17string2001.2
5.34.27DynTxtPropertyValue18Customized field 18string2001.2
5.34.28DynTxtPropertyValue19Customized field 19string2001.2
5.34.29DynTxtPropertyValue20Customized field 20string2001.2
Cartons Fields
FieldNameDescriptionDataTypeLengthVersion
Root
5.35.1CartonNoUNIS collected the Carton Number due to customer's requirement.string501.2
5.35.2PoundPerCartonstring151.2
5.35.3ItemLines (opens in a new tab)object1.2
ItemLines Fields
FieldNameDescriptionDataTypeLengthVersion
Root
5.35.3.1ItemIDProduct Item Name, it is your unique Item SKU#.string151.2
5.35.3.2LotNoUNIS collected the Lot No due to customer's requirement.string501.2
5.35.3.3QtyInCartonQuantity in one Carton1.2
5.35.3.4UOMUnit of Measurementstring151.2
5.35.3.5DynTxtPropertyValue01Customized field 01string2001.2
5.35.3.6DynTxtPropertyValue02Customized field 02string2001.2
5.35.3.7DynTxtPropertyValue03Customized field 03string2001.2
5.35.3.8DynTxtPropertyValue04Customized field 04string2001.2
5.35.3.9DynTxtPropertyValue05Customized field 05string2001.2
5.35.3.10DynTxtPropertyValue06Customized field 06string2001.2
5.35.3.11DynTxtPropertyValue07Customized field 07string2001.2
5.35.3.12DynTxtPropertyValue08Customized field 08string2001.2
5.35.3.13DynTxtPropertyValue09Customized field 09string2001.2
5.35.3.14DynTxtPropertyValue10Customized field 10string2001.2
5.35.3.15DynTxtPropertyValue11Customized field 11string2001.2
5.35.3.16DynTxtPropertyValue12Customized field 12string2001.2
5.35.3.17DynTxtPropertyValue13Customized field 13string2001.2
5.35.3.18DynTxtPropertyValue14Customized field 14string2001.2
5.35.3.19DynTxtPropertyValue15Customized field 15string2001.2
5.35.3.20DynTxtPropertyValue16Customized field 16string2001.2
5.35.3.21DynTxtPropertyValue17Customized field 17string2001.2
5.35.3.22DynTxtPropertyValue18Customized field 18string2001.2
5.35.3.23DynTxtPropertyValue19Customized field 19string2001.2
5.35.3.24DynTxtPropertyValue20Customized field 20string2001.2

Example

Request

// Url
http://preview.logisticsteam.com/shared/bam/v1/public/edi/inbound/receipt/rc/search-by-paging
 
// Body
{
    "CompanyID": "LT",
    "CustomerID": "AUKINT0001",
    "FacilityID": "889",
    "PONo": "",
    "ReferenceNo": "",
    "CreatedWhenFrom": "2020-06-15T00:11:11.892",
    "CreatedWhenTo": "2020-06-20T00:12:11.892",
    "Paging":{
        "PagingNo":1
    }
}

Response

// Success return
[
    {
        "FacilityID": "889",
        "CustomerID": "AUKINT0001",
        "ReferenceNo": "1186074",
        "PONo": "1030024158",
        "RC": {
            "WISECompanyID": "ORG-1",
            "CustomerID": "AUKINT0001",
            "PONo": "1030024158",
            "ReferenceNo": "1186074",
            "WISEPOID": "RN-6250",
            "ReceivedDate": "2020-05-22T12:21:11.799",
            "ContainerNumber": "CSNU1381690",
            "Note": "",
            "Items": [
                {
                    "ItemNumber": "1613402000",
                    "ItemShortDescription": "Georgian Bluffs Polished 2cm",
                    "ItemDescription": "Georgian Bluffs Polished 2cm",
                    "ReceivedQuantity": 90,
                    "CustomerMaterial": "",
                    "Diverse": null,
                    "ItemNote": "",
                    "SerialNumber": [
                        "3486800A-1613402000-306514966",
                        "3486800A-1613402000-356515221",
                        "3486800A-1613402000-356515213",
                        "3486800A-1613402000-356515120"
                    ],
                    "LotNo": "3486800A",
                    "DynTxtPropertyValue01": "",
                    "DynTxtPropertyValue02": "",
                    "DynTxtPropertyValue03": "GOOD",
                    "DynTxtPropertyValue04": "",
                    "DynTxtPropertyValue05": "",
                    "DynTxtPropertyValue06": "",
                    "DynTxtPropertyValue07": "",
                    "DynTxtPropertyValue08": "",
                    "DynTxtPropertyValue09": "",
                    "DynTxtPropertyValue10": "",
                    "dynTxtPropertyValue11": "",
                    "dynTxtPropertyValue12": "",
                    "dynTxtPropertyValue13": "",
                    "dynTxtPropertyValue14": "",
                    "dynTxtPropertyValue15": "",
                    "dynTxtPropertyValue16": "",
                    "dynTxtPropertyValue17": "",
                    "dynTxtPropertyValue18": "",
                    "dynTxtPropertyValue19": "",
                    "dynTxtPropertyValue20": "",
                    "SupplierID": "ORG-119349",
                    "SupplierName": "CAESARSTONE",
                    "UOM": "EA",
                    "ExpectedQty": 90,
                    "ExpirationDate": "",
                    "SHIPMENT_LINE_ID": ""
                }
            ],
            "PalletQty": 0,
            "Cartons": [],
            "DynTxtPropertyValue01": "",
            "DynTxtPropertyValue02": "",
            "DynTxtPropertyValue03": "",
            "DynTxtPropertyValue04": "",
            "DynTxtPropertyValue05": "",
            "DynTxtPropertyValue06": "",
            "DynTxtPropertyValue07": "",
            "DynTxtPropertyValue08": "",
            "DynTxtPropertyValue09": "",
            "DynTxtPropertyValue10": "",
            "DynTxtPropertyValue11": "",
            "DynTxtPropertyValue12": "",
            "DynTxtPropertyValue13": "",
            "DynTxtPropertyValue14": "",
            "DynTxtPropertyValue15": "",
            "DynTxtPropertyValue16": "",
            "DynTxtPropertyValue17": "",
            "DynTxtPropertyValue18": "",
            "DynTxtPropertyValue19": "",
            "DynTxtPropertyValue20": "",
            "TitleID": "ORG-119349",
            "BOLNo": "1020503947",
            "SCACCode": "WC",
            "CarrierName": "WILL CALL",
            "RECEIPT_SOURCE_CODE": null,
            "ORGANIZATION_CODE": null,
            "TO_SUBINVENTORY": null
        },
        "CreatedWhen": "2020-05-22T09:22:11.996"
    },
    ...
]
RN ACK By PagingItem Master API