Query ASN List

PostedJanuary 13, 2022

Get a list of your ASNs.

URL: {API root URL}/asns?{query}
Method: GET

Request

URL Parameters

Parameter Name	Required	Data Type	Description
PageSize	Y	Integer	Specify how many records to return in single call, up to 200.
PageNumber	Y	Integer	Specify which page you are querying, starts from 1.
FromTime		DateTime	The start date (only support date level at this moment, time part will be supported in the future) of the ASN uploading time, based on UTC.
ToTime		DateTime	The end date (only support date level at this moment, time part will be supported in the future) of the ASN uploading time, based on UTC.
FromCloseTime		DateTime	The start date (only support date level at this moment, time part will be supported in the future) of the ASN close time (the time when the ASN is marked as Completed), based on UTC.
ToCloseTime		DateTime	The end date (only support date level at this moment, time part will be supported in the future) of the ASN close time, based on UTC.
WarehouseCode		String	Specify the warehouse that the ASN delivers to, value could be “USCA01” or “USNJ01”, empty means querying all applicable warehouses.
AsnNumber		String	ASN Number
ReferenceNumber		String	Reference number of the ASN
Type		String	The type of the ASN, value should be “SupplierReceipt” or “Return”.
Status		String	The status of the ASN.
SKU		String	The SKU number in the ASN.

Response

Attribute List

Element Name	Data Type	Description
TotalCount	Integer	The count of returned records.
PageNumber	Integer	Same value in request body.
PageSize	Integer	Same value in request body.
PageCount	Integer	Indicate the total page count based the total record count and the page size.
Result	Array<Object>	The ASN data list. the detail schema inside this node is same with the response schema of Get ASN Information API.

Response Example

{
    "totalCount": 19,
    "pageNumber": 1,
    "pageSize": 2,
    "pageCount": 10,
    "result": [
        {
            "asnNumber": "R0430A015",
            "customerCode": "TEST",
            "warehouseCode": "USCA01",
            "receiptType": "SupplierReceipt",
            "referenceNumber": "PO45003",
            "status": "Closed",
            "uploadTime": "2020-04-30T10:47:53-07:00",
            "arrivalTime": "2020-04-30T11:33:03-07:00",
            "closeTime": "2020-04-30T16:54:00-07:00",
            "details": [
                {
                    "sku": "LFT0003",
                    "condition": "Good",
                    "unitOfMeasure": "Each",
                    "quantity": 100,
                    "receivedTotalQty": 97,
                    "receivedAvailableQty": 97
                },
                {
                    "sku": "LFT0003",
                    "condition": "Damaged",
                    "unitOfMeasure": "Each",
                    "quantity": 0,
                    "receivedTotalQty": 3,
                    "receivedAvailableQty": 3
                },
                {
                    "sku": "LFT0006",
                    "condition": "Good",
                    "unitOfMeasure": "Each",
                    "quantity": 500,
                    "receivedTotalQty": 500,
                    "receivedAvailableQty": 500
                }
            ]
        },
        {
            "asnNumber": "R0430B4315",
            "customerCode": "TEST",
            "warehouseCode": "USCA01",
            "receiptType": "SupplierReceipt",
            "referenceNumber": "PO4597",
            "status": "DueIn",
            "uploadTime": "2020-04-29T10:47:53-07:00",
            "details": [
                {
                    "sku": "LFT0045",
                    "condition": "Good",
                    "unitOfMeasure": "Each",
                    "quantity": 500,
                    "receivedTotalQty": 0,
                    "receivedAvailableQty": 0
                }
            ]
        }
    ]
}