Get All ARNs (New)

Returns all ARNs of the client

Note:

Please make sure to pass params in alphabetical order in case multiple params are passed, otherwise the API will return invalid signature

Request

Query Params

_ids

string

optional

comma separated list of _ids

Example:

67fd0851cc4cd82def756464,67fd0a7ecc4cd82def756468

cancelled_at_from

string

optional

RFC3339 timestamp

Example:

2025-05-04T14:24:45Z

cancelled_at_to

string

optional

RFC3339 timestamp

Example:

2025-05-04T14:24:46Z

closed_at_from

string

optional

RFC3339 timestamp

Example:

2025-04-14T13:16:00Z

closed_at_to

string

optional

RFC3339 timestamp

Example:

2025-04-14T13:16:01Z

created_at_from

string

optional

RFC3339 timestamp

Example:

2025-04-14

created_at_to

string

optional

RFC3339 timestamp

Example:

2025-04-14

page_no

string

required

Example:

page_size

string

required

Max value: 100

Example:

status

string

optional

comma separated list of status

Example:

open,receiving,cancelled

updated_at_from

string

optional

RFC3339 timestamp

Example:

2025-05-04T14:03:08Z

updated_at_to

string

optional

RFC3339 timestamp

Example:

2025-05-04T14:03:09Z

Header Params

X-API-Key

string

optional

Example:

Responses

🟢200Success

application/json

Body

success

boolean

required

payload

object

required

results

array [object {11}]

required

total_results

integer

required

total_pages

integer

required

current_page

integer

required

Examples

SuccessException

{
    "success": true,
    "payload": {
        "results": [
            {
                "_id": "68176b21e57e471a7e360398",
                "warehouse_id": "6388c4f3c5d9f1b1ffe48b65",
                "client_id": "67b8897317491074dc8ec49d",
                "client_name": "BMW",
                "code": 1583,
                "status": "receiving",
                "items": [
                    {
                        "item_id": "67fd0a4b9c8aece7b83ddb11",
                        "sku": "bmwm1",
                        "expected_qty": 10,
                        "unit": "each",
                        "scannable": "bmwm1",
                        "name": "bmw m1",
                        "image": "https://somecdn/image.jpeg",
                        "base_unit": "each",
                        "base_conversion_rate": 1,
                        "received_qty": 5,
                        "received_qty_unit": "each"
                    }
                ],
                "created_at": "2025-05-04T13:26:57Z",
                "created_by": "Steve Rogers",
                "updated_at": "2025-05-04T14:03:08Z",
                "updated_by": "Steve Rogers",
                "receiving_info": [
                    {
                        "_id": "68498a2da230d8cc3cc3bebd",
                        "item_id": "67fd0a4b9c8aece7b83ddb11",
                        "sku": "bmwm1",
                        "expected_qty": 10,
                        "unit": "each",
                        "scannable": "bmwm1",
                        "name": "bmw m1",
                        "base_unit": "each",
                        "base_conversion_rate": 1,
                        "received_qty": 2,
                        "received_qty_unit": "each",
                        "serial_number": "serial 1"
                    },
                    {
                        "_id": "68498a2da230d8cc3cc3bebd",
                        "item_id": "67bc205d2433307c7c094b0b",
                        "sku": "bmwm1",
                        "expected_qty": 15,
                        "unit": "each",
                        "scannable": "bmwm1",
                        "name": "bmw m1",
                        "base_unit": "each",
                        "base_conversion_rate": 1,
                        "received_qty": 3,
                        "received_qty_unit": "each",
                        "serial_number": "serial 2"
                    }
                ]
            },
            {
                "_id": "681772148fbbc4ed874cc428",
                "warehouse_id": "6388c4f3c5d9f1b1ffe48b65",
                "client_id": "67b8897317491074dc8ec49d",
                "client_name": "BMW",
                "code": 1584,
                "status": "open",
                "items": [
                    {
                        "item_id": "67fd061a9c8aece7b83ddb0f",
                        "sku": "bmwm2",
                        "expected_qty": 10,
                        "unit": "each",
                        "scannable": "bmwm2",
                        "name": "bmw m2",
                        "image": "https://somecdn/image.jpeg",
                        "base_unit": "each",
                        "base_conversion_rate": 1
                    }
                ],
                "created_at": "2025-05-04T13:56:36Z",
                "created_by": "Steve Rogers",
                "receiving_info": [
                    {
                        "_id": "68498a2da230d8cc3cc3bebd",
                        "item_id": "67fd0a4b9c8aece7b83ddb11",
                        "sku": "bmwm2",
                        "expected_qty": 10,
                        "unit": "each",
                        "scannable": "bmwm2",
                        "name": "bmw m1",
                        "base_unit": "each",
                        "base_conversion_rate": 1,
                        "received_qty": 2,
                        "received_qty_unit": "each",
                        "serial_number": "serial 1"
                    },
                    {
                        "_id": "68498a2da230d8cc3cc3bebd",
                        "item_id": "67bc205d2433307c7c094b0b",
                        "sku": "bmwm2",
                        "expected_qty": 10,
                        "unit": "each",
                        "scannable": "bmwm2",
                        "name": "bmw m2",
                        "base_unit": "each",
                        "base_conversion_rate": 1,
                        "received_qty": 3,
                        "received_qty_unit": "each",
                        "serial_number": "serial 2"
                    }
                ]
            }
        ],
        "total_results": 2,
        "total_pages": 1,
        "current_page": 1
    }
}

Request

Request samples

Responses