Get All Orders
Developing
GET
/v1/orders
1.
Request
Query Params
_ids
string
optional
Example:
67fd058a2d19a0b4ee9cbdbf
shipped_date_from
string
optional
Example:
2025-04-14
shipped_date_to
string
optional
Example:
2025-04-14
Header Params
X-API-Key
string
required
Example:
{{APIKEY}}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://nova-sandbox.leanafywms.com/v1/orders' \
--header 'X-API-Key: 'Responses
🟢200Success
application/json
Body
success
boolean
required
payload
array [object {16}]
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
shipping_address
object
required
items
array [object {12}]
required
shipments
array [object {15}]
required
shipped_at
string
optional
primary_reference_number
string
optional
default_shipping_carrier
object
optional
customer_type
string
optional
due_date
string
optional
billing_address
object
optional
Example
{
"success": true,
"payload": [
{
"_id": "67acb143aff86ec69d652e8a",
"warehouse_id": "632f6d0285f8727169719897",
"client_id": "6310b48233cbac5151bc9594",
"client_name": "Apple",
"code": 2399,
"instructions": "Handle with care",
"status": "closed",
"shipping_address": {
"name": "Jane Smith",
"email": "jane.smith@example.com",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "California",
"state_code": "CA",
"country": "United States",
"country_code": "US",
"zip": "94103",
"phone_number": {
"number": "4151234567",
"country_code": "+1"
}
},
"items": [
{
"item_id": "636ceba955d7409864ece825",
"sku": "2020",
"total_qty": 10,
"unit": "meter",
"scannable": "20202222",
"name": "iphone 20",
"description": "teststing item 2020",
"base_conversion_rate": 1,
"base_unit": "meter",
"shipped_qty": 10,
"shipped_qty_unit": "meter"
}
],
"shipments": [
{
"shipment_id": "shp_4f48e706d55f48da83547daf4760a77e",
"shipment_status": "scheduled",
"carrier": "USPS",
"service": "GroundAdvantage",
"cost": {
"value": 12.881,
"currency": "USD"
},
"tracking_number": "9436200208271109445315",
"label": "https://leanafywms-stage-shipment.s3.amazonaws.com/202502141846180854071430000UTCm10345987681218leanafypost_label_shp_4f48e706d55f48da83547daf4760a77e.pdf",
"public_url": "https://track.easypost.com/djE6dHJrX2E2MTIzOGYxNDhiZDQyMTg4ZDFjN2M1YzhiYTE1Njk0",
"ship_date": "2025-02-14T12:30:00Z",
"created_at": "2025-02-14T18:46:11Z",
"to_address": {
"name": "Jane Smith",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "CA",
"state_code": "CA",
"country": "US",
"country_code": "US",
"zip": "94103",
"phone_number": {
"number": "7878456578",
"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": 35.27
},
"dimensions": {
"unit": "in",
"length": 7.87,
"width": 8.27,
"height": 8.66
},
"delivery_date": "2025-02-18T18:46:11Z"
}
],
"shipped_at": "2025-02-14"
},
{
"_id": "67acb3ebdcd6f1bfbf5e55ab",
"warehouse_id": "632f6d0285f8727169719897",
"client_id": "6310b48233cbac5151bc9594",
"client_name": "Apple",
"code": 2401,
"instructions": "Handle with care",
"status": "open",
"shipping_address": {
"name": "Jane Smith",
"email": "jane.smith@example.com",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "California",
"state_code": "CA",
"country": "United States",
"country_code": "US",
"zip": "94103",
"phone_number": {
"number": "4151234567",
"country_code": "+1"
}
},
"items": [
{
"item_id": "636ceba955d7409864ece825",
"sku": "2020",
"total_qty": 20,
"unit": "meter",
"scannable": "20202222",
"name": "iphone 20",
"description": "teststing item 2020",
"base_conversion_rate": 1,
"base_unit": "meter"
}
],
"primary_reference_number": "12346",
"default_shipping_carrier": {
"name": "FastShip Express",
"id": "FS12345",
"service": "Next Day Delivery",
"price": "$19.99"
},
"customer_type": "B2B",
"due_date": "2025-02-26"
},
{
"_id": "67aea0e14dd19ab2f6738830",
"warehouse_id": "632f6d0285f8727169719897",
"client_id": "6310b48233cbac5151bc9594",
"client_name": "Apple",
"code": 2409,
"instructions": "Handle with care",
"status": "closed",
"shipping_address": {
"name": "Jane Smith",
"email": "jane.smith@example.com",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "California",
"state_code": "CA",
"country": "United States",
"country_code": "US",
"zip": "94103",
"phone_number": {
"number": "4151234567",
"country_code": "+1"
}
},
"items": [
{
"item_id": "636ceba955d7409864ece825",
"sku": "2020",
"total_qty": 10,
"unit": "meter",
"scannable": "20202222",
"name": "iphone 20",
"description": "teststing item 2020",
"base_conversion_rate": 1,
"base_unit": "meter",
"shipped_qty": 10,
"shipped_qty_unit": "meter"
}
],
"primary_reference_number": "12348",
"default_shipping_carrier": {
"name": "FastShip Express",
"id": "FS12345",
"service": "Next Day Delivery",
"price": "$19.99"
},
"customer_type": "B2B",
"due_date": "2025-02-26",
"shipments": [
{
"shipment_id": "shp_bcdfd7e8a4444967a30ef4e88837627e",
"shipment_status": "scheduled",
"carrier": "USPS",
"service": "GroundAdvantage",
"cost": {
"value": 5.324,
"currency": "USD"
},
"tracking_number": "9418400208303109449739",
"label": "https://leanafywms-stage-shipment.s3.amazonaws.com/202504090815428237255990000UTCm236438699689leanafypost_label_shp_bcdfd7e8a4444967a30ef4e88837627e.pdf",
"public_url": "https://track.easypost.com/djE6dHJrX2FjMDdkMmIwMGMwYzRiN2FhYzQ2OTFkNjA0N2UzZDhm",
"ship_date": "2025-04-09T12:30:00Z",
"created_at": "2025-04-09T08:15:35Z",
"to_address": {
"name": "Jane Smith",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "CA",
"state_code": "CA",
"country": "US",
"country_code": "US",
"zip": "94103",
"phone_number": {
"number": "7878654568",
"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-13T08:15:35Z"
},
{
"shipment_id": "shp_fe3a807b3c3e49d6a5a12bae5e34d857",
"shipment_status": "scheduled",
"carrier": "USPS",
"service": "GroundAdvantage",
"cost": {
"value": 5.324,
"currency": "USD"
},
"tracking_number": "9418400208303109449746",
"label": "https://leanafywms-stage-shipment.s3.amazonaws.com/202504090818552915328760000UTCm428906506956leanafypost_label_shp_fe3a807b3c3e49d6a5a12bae5e34d857.pdf",
"public_url": "https://track.easypost.com/djE6dHJrX2RkMzlkMjI1YTUzNDQzOTQ5YzM4MjE2M2ZlNWExYmM1",
"ship_date": "2025-04-09T12:30:00Z",
"created_at": "2025-04-09T08:18:47Z",
"to_address": {
"name": "Jane Smith",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "CA",
"state_code": "CA",
"country": "US",
"country_code": "US",
"zip": "94103",
"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-13T08:18:47Z"
}
],
"shipped_at": "2025-04-09"
},
{
"_id": "67acb3d1dcd6f1bfbf5e55aa",
"warehouse_id": "632f6d0285f8727169719897",
"client_id": "6310b48233cbac5151bc9594",
"client_name": "Apple",
"code": 2400,
"instructions": "Handle with care",
"status": "open",
"shipping_address": {
"name": "Jane Smith",
"email": "jane.smith@example.com",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "California",
"state_code": "CA",
"country": "United States",
"country_code": "US",
"zip": "94103",
"phone_number": {
"number": "4151234567",
"country_code": "+1"
}
},
"items": [
{
"item_id": "636ceba955d7409864ece825",
"sku": "2020",
"total_qty": 10,
"unit": "meter",
"scannable": "20202222",
"name": "iphone 20",
"description": "teststing item 2020",
"base_conversion_rate": 1,
"base_unit": "meter"
}
],
"primary_reference_number": "12345",
"default_shipping_carrier": {
"name": "FastShip Express",
"id": "FS12345",
"service": "Next Day Delivery",
"price": "$19.99"
},
"customer_type": "B2B",
"due_date": "2025-02-26"
},
{
"_id": "67ae0b971e189173984201b6",
"warehouse_id": "632f6d0285f8727169719897",
"client_id": "6310b48233cbac5151bc9594",
"client_name": "Apple",
"code": 2403,
"instructions": "Handle with care",
"status": "open",
"shipping_address": {
"name": "Jane Smith",
"email": "jane.smith@example.com",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "California",
"state_code": "CA",
"country": "United States",
"country_code": "US",
"zip": "94103",
"phone_number": {
"number": "4151234567",
"country_code": "+1"
}
},
"items": [
{
"item_id": "636ceba955d7409864ece825",
"sku": "2020",
"total_qty": 20,
"unit": "meter",
"scannable": "20202222",
"name": "iphone 20",
"description": "teststing item 2020",
"base_conversion_rate": 1,
"base_unit": "meter"
}
],
"primary_reference_number": "12347",
"default_shipping_carrier": {
"name": "FastShip Express",
"id": "FS12345",
"service": "Next Day Delivery",
"price": "$19.99"
},
"customer_type": "B2B",
"due_date": "2025-02-26"
},
{
"_id": "67e13f35b6938af1fb63ef70",
"warehouse_id": "632f6d0285f8727169719897",
"client_id": "6310b48233cbac5151bc9594",
"client_name": "Apple",
"code": 2596,
"instructions": "intel inside",
"status": "closed",
"shipping_address": {
"name": "Jane Smith",
"email": "jane.smith@example.com",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "California",
"state_code": "CA",
"country": "United States",
"country_code": "US",
"zip": "94103",
"phone_number": {
"number": "4151234567",
"country_code": "+1"
}
},
"items": [
{
"item_id": "67bc205d2433307c7c094b0b",
"sku": "bmwm12",
"total_qty": 1,
"unit": "each",
"scannable": "bmwm12",
"name": "bmw m12",
"description": "bmw m12",
"base_conversion_rate": 1,
"base_unit": "each",
"image": "https://leanafywms-stage-item.s3.amazonaws.com/67bc205d2433307c7c094b0b",
"shipped_qty": 1,
"shipped_qty_unit": "each"
}
],
"primary_reference_number": "prn12345",
"default_shipping_carrier": {
"name": "FastShip Express",
"id": "FS12345",
"service": "Next Day Delivery",
"price": "$19.99"
},
"customer_type": "B2B",
"due_date": "2025-02-26",
"shipments": [
{
"shipment_id": "shp_3455669b31f14b26a56afffc286e6600",
"shipment_status": "scheduled",
"carrier": "USPS",
"service": "GroundAdvantage",
"cost": {
"value": 5.324,
"currency": "USD"
},
"tracking_number": "9400100208303109695013",
"label": "https://leanafywms-stage-shipment.s3.amazonaws.com/202504090645344568730370000UTCm157426510605043leanafypost_label_shp_3455669b31f14b26a56afffc286e6600.pdf",
"public_url": "https://track.easypost.com/djE6dHJrX2JhZWYzZTg3YTM1YjQyMmE4MWQ3ZDg3MTI4Y2FkODUy",
"ship_date": "2025-04-09T12:30:00Z",
"created_at": "2025-04-09T06:45:20Z",
"to_address": {
"name": "Jane Smith",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "CA",
"state_code": "CA",
"country": "US",
"country_code": "US",
"zip": "94103",
"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-13T06:45:20Z"
}
],
"shipped_at": "2025-04-09"
},
{
"_id": "67e13f5fb6938af1fb63ef71",
"warehouse_id": "632f6d0285f8727169719897",
"client_id": "6310b48233cbac5151bc9594",
"client_name": "Apple",
"code": 2597,
"instructions": "intel inside",
"status": "closed",
"shipping_address": {
"name": "Jane Smith",
"email": "jane.smith@example.com",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "California",
"state_code": "CA",
"country": "United States",
"country_code": "US",
"zip": "94103",
"phone_number": {
"number": "4151234567",
"country_code": "+1"
}
},
"billing_address": {
"name": "John Smith",
"email": "jane.smith@example.com",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "California",
"state_code": "CA",
"country": "United States",
"country_code": "US",
"zip": "94103",
"phone_number": {
"number": "4151234567",
"country_code": "+1"
}
},
"items": [
{
"item_id": "67bc205d2433307c7c094b0b",
"sku": "bmwm12",
"total_qty": 1,
"unit": "each",
"scannable": "bmwm12",
"name": "bmw m12",
"description": "bmw m12",
"base_conversion_rate": 1,
"base_unit": "each",
"image": "https://leanafywms-stage-item.s3.amazonaws.com/67bc205d2433307c7c094b0b",
"shipped_qty": 1,
"shipped_qty_unit": "each"
}
],
"primary_reference_number": "prn123456",
"default_shipping_carrier": {
"name": "FastShip Express",
"id": "FS12345",
"service": "Next Day Delivery",
"price": "$19.99"
},
"customer_type": "B2B",
"due_date": "2025-02-26",
"shipments": [
{
"shipment_id": "shp_b8c1db47924d4459a8798ea5ca3f886b",
"shipment_status": "scheduled",
"carrier": "USPS",
"service": "GroundAdvantage",
"cost": {
"value": 5.324,
"currency": "USD"
},
"tracking_number": "9400100208303109686011",
"label": "https://leanafywms-stage-shipment.s3.amazonaws.com/202504071608420899592140000UTCm18414143691220leanafypost_label_shp_b8c1db47924d4459a8798ea5ca3f886b.pdf",
"public_url": "https://track.easypost.com/djE6dHJrX2EwNzM0MmU3ZGVjYTRmMTM5NzcyZjAyYTg5NjhmYWYy",
"ship_date": "2025-04-07T12:30:00Z",
"created_at": "2025-04-07T16:08:34Z",
"to_address": {
"name": "Jane Smith",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "CA",
"state_code": "CA",
"country": "US",
"country_code": "US",
"zip": "94103",
"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-11T16:08:34Z"
}
],
"shipped_at": "2025-04-07"
},
{
"_id": "67da7781594caa530300f5f2",
"warehouse_id": "632f6d0285f8727169719897",
"client_id": "6310b48233cbac5151bc9594",
"client_name": "Apple",
"code": 2584,
"instructions": "Test Order. DO NOT SHIP!",
"status": "open",
"shipping_address": {
"name": "Jane Smith",
"email": "jane.smith@example.com",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "California",
"state_code": "CA",
"country": "United States",
"country_code": "US",
"zip": "94103",
"phone_number": {
"number": "4151234567",
"country_code": "+1"
}
},
"items": [
{
"item_id": "67bc205d2433307c7c094b0b",
"sku": "bmwm12",
"total_qty": 1,
"unit": "each",
"scannable": "bmwm12",
"name": "bmw m12",
"description": "bmw m12",
"base_conversion_rate": 1,
"base_unit": "each",
"image": "https://leanafywms-stage-item.s3.amazonaws.com/67bc205d2433307c7c094b0b"
}
],
"primary_reference_number": "prn123",
"default_shipping_carrier": {
"name": "FastShip Express",
"id": "FS12345",
"service": "Next Day Delivery",
"price": "$19.99"
},
"customer_type": "B2B",
"due_date": "2025-02-26"
},
{
"_id": "67e13f06b6938af1fb63ef6f",
"warehouse_id": "632f6d0285f8727169719897",
"client_id": "6310b48233cbac5151bc9594",
"client_name": "Apple",
"code": 2595,
"instructions": "intel inside",
"status": "open",
"shipping_address": {
"name": "Jane Smith",
"email": "jane.smith@example.com",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "California",
"state_code": "CA",
"country": "United States",
"country_code": "US",
"zip": "94103",
"phone_number": {
"number": "4151234567",
"country_code": "+1"
}
},
"billing_address": {
"name": "Jane Smith",
"email": "jane.smith@example.com",
"company": "Smith Industries",
"address_line1": "456 Elm St",
"address_line2": "Suite 200",
"city": "San Francisco",
"state": "California",
"state_code": "CA",
"country": "United States",
"country_code": "US",
"zip": "94103",
"phone_number": {
"number": "4151234567",
"country_code": "+1"
}
},
"items": [
{
"item_id": "67bc205d2433307c7c094b0b",
"sku": "bmwm12",
"total_qty": 1,
"unit": "each",
"scannable": "bmwm12",
"name": "bmw m12",
"description": "bmw m12",
"base_conversion_rate": 1,
"base_unit": "each",
"image": "https://leanafywms-stage-item.s3.amazonaws.com/67bc205d2433307c7c094b0b"
}
],
"primary_reference_number": "prn1234",
"default_shipping_carrier": {
"name": "FastShip Express",
"id": "FS12345",
"service": "Next Day Delivery",
"price": "$19.99"
},
"customer_type": "B2B",
"due_date": "2025-02-26"
}
]
}
Modified at 2025-04-14 13:22:56