Get All Orders (New) - Leanafy Developer Portal

Returns all Orders 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:

682ec3ba306cfa2ead0f6dc9

cancelled_at_from

string

optional

RFC3339 timestamp

Example:

2025-04-14T13:13:04Z

cancelled_at_to

string

optional

RFC3339 timestamp

Example:

2025-04-14T13:14:04Z

created_at_from

string

optional

RFC3339 timestamp

Example:

2025-04-01T10:40:51Z

created_at_to

string

optional

RFC3339 timestamp

Example:

2025-05-23T10:53:35Z

page_no

string

required

Example:

page_size

string

required

Max value: 100

Example:

100

shipped_at_from

array[string]

optional

RFC3339 timestamp

Example:

["2025-04-14T14:19:13Z"]

shipped_at_to

string

optional

RFC3339 timestamp

Example:

2025-05-21T14:19:14Z

status

string

optional

comma separated list of status

Example:

shipped,closed

updated_at_from

string

optional

RFC3339 timestamp

Example:

2025-02-03T15:35:48Z

updated_at_to

string

optional

RFC3339 timestamp

Example:

2025-05-12T19:15:20Z

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

object

required

results

array [object {21}]

required

total_results

integer

required

total_pages

integer

required

current_page

integer

required

Example

{
    "success": true,
    "payload": {
        "results": [
            {
                "_id": "67f167fb10537545a210b11b",
                "warehouse_id": "632f6d0285f8727169719897",
                "client_id": "6310b48233cbac5151bc9594",
                "client_name": "Apple",
                "code": 2735,
                "status": "closed",
                "shipping_address": {
                    "name": "Karan Singhasane USA",
                    "company": "KS US Inc",
                    "address_line1": "3330 Holloman Rd",
                    "city": "Falls Church",
                    "state": "Virginia",
                    "state_code": "VA",
                    "country": "United States",
                    "country_code": "US",
                    "zip": "22042",
                    "phone_number": {
                        "number": "7878654578",
                        "country_code": "+1"
                    }
                },
                "items": [
                    {
                        "item_id": "67613009a0c1d696f02b1fa4",
                        "sku": "DI-122123",
                        "total_qty": 1,
                        "unit": "Box",
                        "scannable": "DI-122123",
                        "name": "Dangerous Item",
                        "description": "Nail polish",
                        "base_conversion_rate": 1,
                        "base_unit": "Box",
                        "shipped_qty": 1,
                        "shipped_qty_unit": "Box"
                    }
                ],
                "customer_type": "B2B",
                "created_by": "Anshuman Vats",
                "created_at": "2025-04-05T17:27:22Z",
                "due_date": "2025-04-07",
                "shipments": [
                    {
                        "shipment_id": "shp_307afc94659c465c8497834f7483d147",
                        "shipment_status": "scheduled",
                        "carrier": "USPS",
                        "service": "GroundAdvantage",
                        "cost": {
                            "value": 4.972,
                            "currency": "USD"
                        },
                        "tracking_number": "9418400208303109449722",
                        "label": "https://leanafywms-stage-shipment.s3.amazonaws.com/202504051729520325018890000UTCm21072417751475leanafypost_label_shp_307afc94659c465c8497834f7483d147.pdf",
                        "public_url": "https://track.easypost.com/djE6dHJrXzVjNTIzYTdmM2I3OTRmZDE5ZGY3MWZmMzgwN2M5NTUz",
                        "ship_date": "2025-04-05T12:30:00Z",
                        "created_at": "2025-04-05T17:29:43Z",
                        "to_address": {
                            "name": "KARAN SINGHASANE USA",
                            "company": "KS US INC",
                            "address_line1": "3330 HOLLOMAN RD",
                            "city": "FALLS CHURCH",
                            "state": "VA",
                            "state_code": "VA",
                            "country": "US",
                            "country_code": "US",
                            "zip": "22042-4137",
                            "phone_number": {
                                "number": "7878654578",
                                "country_code": "+1"
                            }
                        },
                        "from_address": {
                            "company": "Apple",
                            "address_line1": "3815 River Crossing Pkwy",
                            "city": "Indianapolis",
                            "state": "IN",
                            "state_code": "IN",
                            "country": "US",
                            "country_code": "US",
                            "zip": "46240",
                            "phone_number": {
                                "number": "7878654578",
                                "country_code": "+1"
                            }
                        },
                        "weight": {
                            "unit": "oz",
                            "value": 7.05
                        },
                        "dimensions": {
                            "unit": "in",
                            "length": 7.87,
                            "width": 8.27,
                            "height": 8.66
                        },
                        "delivery_date": "2025-04-08T17:29:43Z",
                        "items": [
                            {
                                "item_id": "67613009a0c1d696f02b1fa4",
                                "sku": "DI-122123",
                                "scannable": "DI-122123",
                                "name": "Dangerous Item",
                                "description": "Nail polish",
                                "quantity": 1,
                                "unit": "Box",