API Reference

GET Endpoint: https://shiprobot.com/api/shipments

Filters:

Parameter	Description
start_timestamp	Returns shipments created on or after this date. (Represented by milliseconds since January 1, 1970, 00:00:00 GMT)
end_timestamp	Returns shipments created on or before this date. (Represented by milliseconds since January 1, 1970, 00:00:00 GMT)
limit	Pagination parameter - determines the number of rows to return (from 1 to 100).
offset	Pagination parameter - determines the starting position of the set.
channel_order_id	Returns shipments filtered by your order id.

Tips:

1) If no parameters are provided, response will contain up to 100 shipments created in the last 30 days by default.
2) start_timestamp and end_timestamp should represent the number of milliseconds since January 1, 1970, 00:00:00 GMT (epoch date).
3) You must use pagination parameters if you want to retrieve more than 100 shipments.
4) channel_order_id represents your order id.
5) label_cost is in cents.

Pagination Details:

By default each GET request will return 100 rows. You can pass the limit parameter to determine the number of rows to return (from 1 to 100) and the offset parameter to determine the starting position of the set.

For example, to get the first 100 shipments looks like this:

https://shiprobot.com/api/shipments?limit=100

Then to get the next page of 100:

https://shiprobot.com/api/shipments?limit=100&offset=100

Example JSON Response:

          
                      {
                        "shipments" :
                          [
                            {
                              "id" : "54936ae6300487416d84a744",
                              "created_at" : "1418947302061",
                              "order_id" : "5493696c300487416d84a740",
                              "channel_order_id" : "#1001",
                              "tracking_number" : "1ZRE08620391194389",
                              "label_cost" : 973
                            },
                            {
                              "id" : "54936992300487416d84a742",
                              "created_at" : "1418946962969",
                              "order_id" : "5493696c300487416dg7jgf8",
                              "channel_order_id" : "#1002",
                              "tracking_number" : "9405510200829393731331",
                              "label_cost" : 505
                            },
                            {
                              "id" : "54936916300487416d84a73f",
                              "created_at" : "1418946838243",
                              "order_id" : "548a99b23004d884081046e5",
                              "channel_order_id" : "#1003",
                              "tracking_number" : "CJ414334937US",
                              "label_cost" : 3643
                            }
                          ]
                      }