This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Create Order

POST

/v1/order

order

Creates an order in Leanafy. This API allows external systems to submit order details for processing in the warehouse.

Request

Header Params

X-API-Key

string

required

Example:

Body Params application/json

instructions

string

optional

shipping_address

object

required

name

string

required

string

required

company

string

required

address_line1

string

required

address_line2

string

required

city

string

required

state

string

required

state_code

string

required

country

string

required

country_code

string

required

zip

string

required

phone_number

object

required

residential

boolean

required

billing_address

object

optional

name

string

required

string

required

company

string

required

address_line1

string

required

address_line2

string

required

city

string

required

state

string

required

state_code

string

required

country

string

required

country_code

string

required

zip

string

required

phone_number

object

required

residential

boolean

required

is_billing_same_as_shipping

boolean

optional

items

array [object {3}]

required

sku

string

optional

total_qty

integer

optional

unit

string

optional

primary_reference_number

string

optional

default_shipping_carrier

object

optional

name

string

required

string

required

service

string

required

price

string

required

disable_carrier_shipping

boolean

optional

customer_type

string

optional

due_date

string

optional

Example

{
    "instructions": "intel inside",
    "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": {
            "country_code": "+1",
            "number": "4151234567"
        },
        "residential": false
    },
    "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": {
            "country_code": "+1",
            "number": "4151234567"
        },
        "residential": false
    },
    "is_billing_same_as_shipping": false,
    "items": [
        {
            "sku": "bmwm1",
            "total_qty": 1,
            "unit": "each"
        }
    ],
    "primary_reference_number": "ref5",
    "default_shipping_carrier": {
        "name": "FastShip Express",
        "id": "FS12345",
        "service": "Next Day Delivery",
        "price": "$19.99"
    },
    "disable_carrier_shipping": false,
    "customer_type": "B2B",
    "due_date": "2025-02-26"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://nova-sandbox.leanafywms.com/v1/order' \
--header 'X-API-Key: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "instructions": "intel inside",
    "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": {
            "country_code": "+1",
            "number": "4151234567"
        },
        "residential": false
    },
    "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": {
            "country_code": "+1",
            "number": "4151234567"
        },
        "residential": false
    },
    "is_billing_same_as_shipping": false,
    "items": [
        {
            "sku": "bmwm1",
            "total_qty": 1,
            "unit": "each"
        }
    ],
    "primary_reference_number": "ref5",
    "default_shipping_carrier": {
        "name": "FastShip Express",
        "id": "FS12345",
        "service": "Next Day Delivery",
        "price": "$19.99"
    },
    "disable_carrier_shipping": false,
    "customer_type": "B2B",
    "due_date": "2025-02-26"
}'

Responses

🟢200Success

application/json

Body

success

boolean

required

payload

object

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

billing_address

object

optional

items

array [object {10}]

required

primary_reference_number

string

optional

default_shipping_carrier

object

optional

customer_type

string

optional

due_date

string

optional

Example

{
    "success": true,
    "payload": {
        "_id": "67e13f5fb6938af1fb63ef71",
        "warehouse_id": "632f6d0285f8727169719897",
        "client_id": "6310b48233cbac5151bc9594",
        "client_name": "Apple",
        "code": 2597,
        "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": "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"
            }
        ],
        "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"
    }
}

🔴500Server Error

Modified at 2025-06-16 11:08:32

Working with Orders

Get Order By ID