API Reference

POST Endpoint: https://shiprobot.com/api/orders

Tips:

1) date is in ISO 8601 format and refers to the date the order was received.
2) order weight and line item weight are in grams.
3) state_province is in ISO 2-letter code format.
4) country is in ISO 2-letter code format.
5) only use this endpoint if we don't support real-time syncing of orders from your sales channel.

Note: All possible JSON objects and their respective properties are shown in the example below. All properties are optional, however, we recommend providing as much data as possible.

Example JSON Request Body:

          
                      {
                        "order" :
                          {
                            "id" : "#1001",
                            "date" : "2014-08-20T11:00:00",
                            "subtotal" : 50.0,
                            "total" : 68.0,
                            "tax" : 8.0,
                            "weight" : 2543,
                            "note" : "Please pack well.",
                            "shipping" :
                              {
                                "title" : "USPS Priority Mail",
                                "code" : "USPS-PM",
                                "price" : 10.0
                              },
                            "customer" :
                              {
                                "name" : "Paul Ding",
                                "email" : "paul.ding@example.com"
                              },
                            "shipping_address" :
                              {
                                "recipient" : "Andy Nu",
                                "company" : "BetaToys",
                                "address1" : "2 Bonnieview Lane",
                                "address2" : null,
                                "phone" : "212-357-7502",
                                "city" : "New York",
                                "state_province" : "NY",
                                "country" : "US",
                                "postal_code" : "10016"
                              },
                            "line_items" : [
                              {
                                "id" : "1",
                                "sku" : "BAN-MAZ-DX",
                                "price" : 50.0,
                                "title" : "DX Chogokin Mazinger Z",
                                "vendor" : "Bandai",
                                "weight" : 2543,
                                "quantity" : 1
                              },
                              {
                                "id" : "2",
                                "sku" : "BAN-SOC-V",
                                "price" : 10.0,
                                "title" : "Diecast Robot Voltes V",
                                "vendor" : null,
                                "weight" : 5431,
                                "quantity" : 2
                              }
                            ]
                          }
                      }