API Guides

Ready-to-use client libraries for popular programming languages.

API Center Menu

Order Booking (Returns)

Request Type: 

POST 

API Endpoint:

<url>/api/orders

Mandatory Headers Properties:

  • Authorization (type: string):  the valid access token from the authentication.

Response:

Your return order object as it was created on Grasshopper platform.

Sample Request [Return]

{

   "order": {

       "type": "2",

       "retailer": {

           "identifier": "<company identifier>"

       },

       "ref_order_number": "po-return",

       "line_items": [

           {

               "quantity": 1,

               "freight_info": {

                   "is_fob": false,

                   "vendor_info": {

                       "first_name": "John",

                       "last_name": "Smith",

                       "email": "jon.smith@deliveright.com",

                       "address": { // pickup address

                           "address1": "123 William Street",

                           "address2": "",

                           "zip": "28277",

                           "city": "Charlotte",

                           "state": "NC"

                       },

                       "phone1": {

                           "number": "6468585857"

                       },

                       "phone": "6468585857"

                   }

               },

               "sku": "123",

               "name": "test",

               "weight": 123,

               "vendor": "Test Vendor",

               "packaging": { // whether you need packaging, and what type

                   "required": true,

                   "type": 1

               }

           }

       ],

       "customer": { // the return-to address

           "company": "Return Vendor Name destination",

           "address": {

               "address1": "651 middagh street",

               "zip": "90036",

               "city": "Los Angeles",

               "state": "CA"

           },

           "phone1": {

               "number": "910-888-9999"

           },

           "email": "return@vendor.com"

       }

   }

}

Response:

Your order object as it was created on Grasshopper platform.