Get all Recall Items

This endpoint allows you to get details of all recall items based on the search and filters passed in the request, along with page and per page.

Get recall items endpoint: https://{{workspace}}.myeshopbox.com/api/v1/recallItems

Query Parameters

Name	Type	Description
sort_order	string	Specifies the sort order, either desc or asc.
sort_by	string	Attribute by which the results should be sorted.
page	integer	Specifies the page number for pagination.
per_page	integer	Specifies the number of items to be returned per page.
eshopboxOrderId	string	B2B order ID for which box details should be fetched.
boxId	string	Returns details for the specified box ID.
packedOnFrom	date	Start date for filtering orders packed on or after this date.
packedOnTo	date	End date for filtering orders packed on or before this date.
inventoryType	String	Specifies the type of inventory being managed or queried

Search fields and their corresponding values:

packedOnTo and packedOnFrom values:

These are date fields in the format "YYYY-MM-DD”, specifying that your order was packed within this time frame. Both from and to date will be included in the filter. Ex: If you specify from date as 10-Jan and to date as 12-Jan, then recall items packed on both 10-Jan and 12-Jan will be fetched.

Sample Request URL with filter for packed on date range:

cURL

curl --location -g --request GET 'https://{{workspace}}.myeshopbox.com/api/v1/recallItems?page=1&perPage=10&packedOnFrom=2024-01-09&packedOnTo=2024-01-31
--header 'Authorization: Bearer XXXX' \
--header 'Content-Type: application/json' \
--header 'proxyHost: Accountlug'

InventoryType values:

• sellable: Fetches B2B order items created for sellable inventory. Example: inventoryType=sellable

• nonsellable: Filters Removal items created for any type of non-sellable inventory. Example: inventoryType=nonsellable

• non_sellable_returns: Fetches specific types of removal items i.e. non-sellable returns. Example: inventoryType=non_sellable_returns

• non_sellable_inward: Fetches specific types of removal items i.e. non-sellable inward items. Example: inventoryType=non_sellable_inward

• overage_inward: Fetches specific types of removal items i.e. overage inward items. Example: inventoryType=overage_inward

• non_sellable_transfer_items: Fetches specific types of removal items i.e. non-sellable transfer items. Example: inventoryType=non_sellable_transfer_items

Sample Request URL with packed On and inventory type filter:

cURL

curl --location -g --request GET 'https://{{workspace}}.myeshopbox.com/api/v1/recallItems?page=1&perPage=10&packedOnFrom=2024-01-09&packedOnTo=2024-01-31&inventoryType=sellable' \
--header 'Content-Type: application/json' \
--header 'proxyHost: Accountlug'

eshopboxOrderId value:

Unique RTV number generated by eshopbox. Example: eshopboxOrderId=RTV/24-25/221883

Sample Request URL with filter eshopboxOrderId:

cURL

curl --location -g --request GET 'https://{{workspace}}.myeshopbox.com/api/v1/recallItems?page=1&perPage=10&eshopboxOrderId=RTV/24-25/221883' \
--header 'Authorization: Bearer XXXX' \
--header 'Content-Type: application/json' \
--header 'proxyHost: Accountlug'

Sample Request URL: https://{{workspace}}.myeshopbox.com/api/v1/recallItems

Sample Response

200 recall items successfully retrieved.

{
    "total": 1,
    "perPage": 10,
    "data": [
        {
            "eshopboxOrderId": "RTV/24-25/221883",
            "customerOrderId": "ISO1231",
            "invoiceNumber": "IN/232/090",
            "invoiceUrl": "https://cdn.filestackcontent.com/DEDQB6nTMWOFrIrb",
            "inventoryType": "Sellable",
            "fromLocation": "xyz",
            "toLocation": "123A",
            "totalOrderedQty": 30,
            "totalFulfillableQty": 26,
            "totalUnfulfillableQty": 4,
            "status": "PACKED",
            "totalBoxNumber": 3,
            "orderCreatedOn": "2024-01-12 13:19:00",
            "orderPackedOn": "2024-01-18 12:39:00",
            "boxDetails": [
                {
                    "boxId": "100988",
                    "sku": "ProductTest1",
                    "esin": "T1YV73H0TCS",
                    "packedQty": 5,
                    "itemMrp": 30000.0,
                    "unitPrice": 10000.0,
                    "brandName": "DummyBrand",
                    "hsnCode": "6203490",
                    "batchTrackingEnabled": false,
                    "batchingInfo": {
                        "batchingMethod": null,
                        "shelfLife": null,
                        "thresholdPeriod": null,
                        "stopShipDate": "null"
                    }
                },
                {
                    "boxId": "100988",
                    "sku": "ProductTest1",
                    "esin": "T1YV73H0TCS",
                    "packedQty": 5,
                    "itemMrp": 30000.0,
                    "unitPrice": 10000.0,
                    "brandName": "DummyBrand",
                    "hsnCode": "6203490",
                    "batchTrackingEnabled": false,
                    "batchingInfo": {
                        "batchingMethod": null,
                        "shelfLife": null,
                        "thresholdPeriod": null,
                        "stopShipDate": "null"
                    }
                },
                {
                    "boxId": "100989",
                    "sku": "ProductTest1",
                    "esin": "T1YV73H0TCS",
                    "packedQty": 10,
                    "itemMrp": 30000.0,
                    "unitPrice": 10000.0,
                    "brandName": "DummyBrand",
                    "hsnCode": "6203490",
                    "batchTrackingEnabled": false,
                    "batchingInfo": {
                        "batchingMethod": null,
                        "shelfLife": null,
                        "thresholdPeriod": null,
                        "stopShipDate": "null"
                    }
                },
                {
                    "boxId": "100990",
                    "sku": "ProductTest1",
                    "esin": "T1YV73H0TCS",
                    "packedQty": 6,
                    "itemMrp": 30000.0,
                    "unitPrice": 10000.0,
                    "brandName": "DummyBrand",
                    "hsnCode": "6203490",
                    "batchTrackingEnabled": false,
                    "batchingInfo": {
                        "batchingMethod": null,
                        "shelfLife": null,
                        "thresholdPeriod": null,
                        "stopShipDate": "null"
                    }
                }
            ]
        }
    ]
}

Possible value for the mentioned attribute:

attribute	values
batchTrackingEnabled	false, true
batchingMethod	manufacturing date, expiry date, batch code
status	PACKED, CREATED, PROCESSING, DISPATCHED