Get All ARNs - Leanafy Developer Portal

Note:

If no parameters are passed, returns all ARNs created for the client using API Keys (Excludes orders manually created by the warehouse operators).

Request

Query Params

_ids

string

optional

comma separated ARN ids

Example:

67fce582782e1b382e90c45a,67fce627782e1b382e90c45b

created_date_from

string

optional

Get ARNs where created_at is greater than or equal to created_date_from. If passed, created_date_to is also required.

Example:

2025-04-14

created_date_to

string

optional

Get ARNs where created_at is less than or equal to created_date_to

Example:

2025-04-14

closed_date_from

string

optional

Get ARNs where closed_at is greater than or equal to closed_date_from. If passed, closed_date_to is also required.

Example:

2025-04-14

closed_date_to

string

optional

Get ARNs where closed_at is less than or equal to created_date_to

Example:

2025-04-14

Header Params

X-API-Key

string

optional

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

success

boolean

required

payload

array [object {14}]

required

_id

string

required

warehouse_id

string

required

client_id

string

required

client_name

string

required

code

integer

required

instructions

string

optional

status

string

required

Possible values - "open", "receiving", "closed"

items

array [object {12}]

required

primary_reference_number

string

required

created_at

string

required

created_by

string

required

due_date

string

optional

closed_at

string

optional

closed_by

string

optional

Examples

SuccessException

{
    "success": true,
    "payload": [
        {
            "_id": "67fce582782e1b382e90c45a",
            "warehouse_id": "632f6d0285f8727169719897",
            "client_id": "6310b48233cbac5151bc9594",
            "client_name": "Apple",
            "code": 1647,
            "instructions": "intel inside",
            "status": "receiving",
            "items": [
                {
                    "item_id": "67bc205d2433307c7c094b0b",
                    "sku": "bmwm12",
                    "expected_qty": 15,
                    "unit": "each",
                    "scannable": "bmwm12",
                    "name": "bmw m12",
                    "description": "bmw m12",
                    "image": "https://leanafywms-stage-item.s3.amazonaws.com/67bc205d2433307c7c094b0b",
                    "base_unit": "each",
                    "base_conversion_rate": 1,
                    "received_qty": 5,
                    "received_qty_unit": "each"
                }
            ],
            "primary_reference_number": "prn123",
            "created_at": "2025-04-14",
            "created_by": "Apple API Connection",
            "due_date": "2025-04-20"
        },
        {
            "_id": "67fce627782e1b382e90c45b",
            "warehouse_id": "632f6d0285f8727169719897",
            "client_id": "6310b48233cbac5151bc9594",
            "client_name": "Apple",
            "code": 1648,
            "instructions": "intel inside",
            "status": "closed",
            "items": [
                {
                    "item_id": "67bc205d2433307c7c094b0b",
                    "sku": "bmwm12",
                    "expected_qty": 15,
                    "unit": "each",
                    "scannable": "bmwm12",
                    "name": "bmw m12",
                    "description": "bmw m12",
                    "image": "https://leanafywms-stage-item.s3.amazonaws.com/67bc205d2433307c7c094b0b",
                    "base_unit": "each",
                    "base_conversion_rate": 1,
                    "received_qty": 15,
                    "received_qty_unit": "each"
                },
                {
                    "item_id": "636ceba955d7409864ece825",
                    "sku": "2020",
                    "expected_qty": 10,
                    "unit": "meter",
                    "scannable": "20202222",
                    "name": "iphone 20",
                    "description": "teststing item 2020",
                    "image": "https://leanafywms-stage-item.s3.amazonaws.com/67bc205d2433307c7c094b0b",
                    "base_unit": "meter",
                    "base_conversion_rate": 1,
                    "received_qty": 10,
                    "received_qty_unit": "meter"
                }
            ],
            "primary_reference_number": "prn1",
            "created_at": "2025-04-14",
            "created_by": "Apple API Connection",
            "due_date": "2025-04-20",
            "closed_at": "2025-04-14",
            "closed_by": "Anshuman Vats"
        }
    ]
}