Request Type:
POST
API Endpoint:
<url>/api/orders
Mandatory Headers Properties:
- Authorization (type: string): the valid access token from the authentication.
Response:
Your order object as it was created on Grasshopper platform.
Sample Request
{
"order":{
"retailer":{
"identifier":"<your retailer id>"
},
"service_level": "rocp", // available service level
"ref_order_number": "MY_PO_NUMBER",
"customer":
{
"first_name": "John",
"last_name": "Smith",
"address":
{
"address1": "1234 Main Street",
"address2": "Apt 4G",
"zip": "11201",
"city": "Brooklyn",
"state": "NY"
},
"company": "Indei Corp",
"phone1": { "number": "2223342211" },
"phone2": { "number": "3334445555" },
"email": "name@gmail.com"
},
"total_insurance_coverage": 0, // optional The total insurance coverage requested on this order
"line_items":
[
{
"quantity": 1,
"weight": 50,
"retail_value": 658.43,
"cube": 43,
"sku": "item1-sku",
"category": "Sofa",
"name": "item-name",
"vendor": "vendor name",
"serial_number": "112233445566-1",
"freight_info":{
"is_fob": true // marked as FOB, hence, no freight component is added
"vendor_info":
{
"company": "",
"first_name":"",
"last_name": "",
"address": {
"address1": "",
"address2": "",
"city": "",
"state": "",
"zip": ""
},
"phone": "",
"email": "",
"receiving_hours": ""
},
"tracking_number": "", // optional tracking number on the line
"ref_order_number":"", // optional po number on the line item
"dimensions":{
"height":50 // optional
"width":20 // optional
"depth":30 // optional
"unit":"inch" // optional ⇐ inch / cm
},
},
{
"quantity": 2,
"retail_value": 658.43,
"cube": 43,
"weight": 350,
"sku": "item2-sku",
"category": "Table",
"name": "item-name",
"dimensions": {
"height":20 // optional
"width":10 // optional
"depth":40 // optional
"unit": "inch" // optional ⇐ inch / cm
},
"vendor": "2nd vendor name",
"serial_number": "112233445566-2",
"freight_info": {
"is_fob":false
"vendor_info": {
"company": "CEF Manufacturer",
"first_name":"contact first name",
"last_name": "contact last name",
"address": {
"address1": "4123 Manufacturer Rd",
"address2": "Suit 23",
"city": "Brooklyn",
"state": "NY",
"zip": "11201"
},
"phone": "218-858-8557",
"email": "[help@manufacturer2.com](mailto:help@manufacturer.com)",
"receiving_hours": "8 AM - 8 PM"
}
},
}
],
"send_retailer_confirmation": "true",
"expected_arrival_date":"11/22/2018”, // optional The expected arrival date of the order if the shipper arrange the freight.
"note": "Order notes for any special instructions, etc.",
"options": // optional
{
"send_retailer_confirmation":true, // optional
"send_labels_to_manufacturer":true, // optional
"reserve_manifest:”5cac997f8afc7a0020539caf" // optional the manifest the order should be booked and scheduled with (when using on-checkout-schedule API)
}
} // close of orderResponse:
Your order object as it was created on Grasshopper platform.