Skip to main content
POST
/
api
/
v1
/
orders
/
create
Create Order
curl --request POST \
  --url https://api.retailreadyai.com/api/v1/orders/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "po_number": "some-po-number",
  "picksheet_code": "some-picksheet-code",
  "brand_id": "14e517b3-5091-4748-8a25-c497aec2ce98",
  "retailer_id": "14e517b3-5091-4748-8a25-c497aec2ce98",
  "facility_id": "14e517b3-5091-4748-8a25-c497aec2ce9z",
  "items": [
    {
      "sku": "pillow-sku",
      "upc": "pillow-upc",
      "quantity": 5,
      "case_pack_quantity": 5,
      "case_barcode": "pillow-case-upc",
      "vendor_pn": "vendor-part-number",
      "description": "soft pillows"
    }
  ],
  "address_data": {
    "ship_to_contact": {
      "name": "<string>",
      "address_line1": "<string>",
      "city": "<string>",
      "province": "<string>",
      "country": "<string>",
      "zip": "<string>",
      "address_line2": "<string>",
      "facility_code": "<string>",
      "dc_number": "<string>"
    },
    "bill_to_contact": {
      "name": "<string>",
      "address_line1": "<string>",
      "address_line2": "<string>",
      "city": "<string>",
      "province": "<string>",
      "country": "<string>",
      "zip": "<string>",
      "facility_code": "<string>",
      "address_number": "<string>"
    },
    "mark_for_contact": {
      "name": "<string>",
      "address_line1": "<string>",
      "address_line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "zip": "<string>",
      "facility_code": "<string>",
      "address_number": "<string>"
    }
  },
  "external_order_id": "some-external-order-id",
  "dept_number": "123456",
  "purchase_order_type": "Test Department",
  "transportation_method": "FREIGHT",
  "carrier": "Fedex Freight",
  "service_method": "ups_ground",
  "dates": {
    "requested_delivery_date": "2024-08-15",
    "earliest_delivery_date": "2024-08-10",
    "latest_delivery_date": "2024-08-20",
    "earliest_ship_date": "2024-08-05",
    "latest_ship_date": "2024-08-12",
    "cancel_by_date": "2024-08-25",
    "requested_ship_date": "2024-08-08",
    "stage_by": "2024-08-01"
  }
}
'
{
  "message": "Order created successfully",
  "data": {
    "order_id": "14e517b3-5091-4748-8a25-c497aec2ce98"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.retailreadyai.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
po_number
string
required

Purchase order number

Example:

"some-po-number"

​
picksheet_code
string
required

Picksheet Code/Warehouse Order Number

Example:

"some-picksheet-code"

​
brand_id
string<uuid>
required

UUID of the brand

Example:

"14e517b3-5091-4748-8a25-c497aec2ce98"

​
retailer_id
string<uuid>
required

UUID of the retailer

Example:

"14e517b3-5091-4748-8a25-c497aec2ce98"

​
facility_id
string<uuid>
required

UUID of the facility

Example:

"14e517b3-5091-4748-8a25-c497aec2ce9z"

​
items
object[]
required
​
address_data
object
required
​
external_order_id
string

External Order ID

Example:

"some-external-order-id"

​
dept_number
string

Department number. Required for Nordstrom, Walmart, TJX, Von Maur, DICK's Sporting Goods, Macy's, Dillard's, and Bloomingdales.

Example:

"123456"

​
purchase_order_type
string

Type of purchase order. Required for Walmart, TJX, SaksOffFifth.com, Saks Off Fifth Store, DICK's Sporting Goods, Macy's Store, Macy's.com, and Bloomingdales

Example:

"Test Department"

​
transportation_method
string

Method of transportation

Example:

"FREIGHT"

​
carrier
string

Carrier

Example:

"Fedex Freight"

​
service_method
enum<string>

Service Method

Available options:
ups_ground,
fedex_ground
​
dates
object

Response

Order created successfully, with reason for being on hold if applicable

​
message
string
Example:

"Order created successfully"

​
data
object
Example:
{
  "order_id": "14e517b3-5091-4748-8a25-c497aec2ce98"
}