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",
"external_order_id": "some-external-order-id",
"brand_id": "14e517b3-5091-4748-8a25-c497aec2ce98",
"retailer_id": "14e517b3-5091-4748-8a25-c497aec2ce98",
"facility_id": "14e517b3-5091-4748-8a25-c497aec2ce9z",
"dept_number": "123456",
"purchase_order_type": "Test Department",
"transportation_method": "FREIGHT",
"carrier": "Fedex Freight",
"service_method": "ups_ground",
"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"
}
],
"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"
},
"address_data": {
"ship_from_contact": {
"name": "Test 3PL",
"address_line1": "123 York St",
"address_line2": "<string>",
"city": "San Francisco",
"state": "CA",
"country": "USA",
"zip": "94133",
"facility_code": "9431"
},
"ship_to_contact": {
"name": "Test Retailer",
"address_line1": "123 Union St",
"address_line2": "<string>",
"city": "New York",
"province": "NY",
"country": "United States",
"zip": "10001",
"dc_number": "1234"
},
"bill_to_contact": {
"name": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"city": "<string>",
"state": "<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>"
}
}
}'
{
"message": "Order created successfully",
"data": {
"order_id": "14e517b3-5091-4748-8a25-c497aec2ce98"
}
}
Create a new 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",
"external_order_id": "some-external-order-id",
"brand_id": "14e517b3-5091-4748-8a25-c497aec2ce98",
"retailer_id": "14e517b3-5091-4748-8a25-c497aec2ce98",
"facility_id": "14e517b3-5091-4748-8a25-c497aec2ce9z",
"dept_number": "123456",
"purchase_order_type": "Test Department",
"transportation_method": "FREIGHT",
"carrier": "Fedex Freight",
"service_method": "ups_ground",
"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"
}
],
"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"
},
"address_data": {
"ship_from_contact": {
"name": "Test 3PL",
"address_line1": "123 York St",
"address_line2": "<string>",
"city": "San Francisco",
"state": "CA",
"country": "USA",
"zip": "94133",
"facility_code": "9431"
},
"ship_to_contact": {
"name": "Test Retailer",
"address_line1": "123 Union St",
"address_line2": "<string>",
"city": "New York",
"province": "NY",
"country": "United States",
"zip": "10001",
"dc_number": "1234"
},
"bill_to_contact": {
"name": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"city": "<string>",
"state": "<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>"
}
}
}'
{
"message": "Order created successfully",
"data": {
"order_id": "14e517b3-5091-4748-8a25-c497aec2ce98"
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Order created successfully, with reason for being on hold if applicable
The response is of type object
.