NAV Navbar
Logo
cURL

Overview

Welcome to the ShipSmart API documentation! Here you’ll find API references to get you shipping with ShipSmart.

We have language bindings in Shell and are currently developing bindings for Ruby, and PHP! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

API Resources

All API URLs listed in this documentation are relative to https://shipsmart.eu/api/v1. For example the /addresses/ resource is reachable at https://shipsmart.eu/api/v1/addresses/.

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
  -H "Authorization: Bearer Authorization Key"

Make sure to replace Authorization Key with your API key.

ShipSmart uses API keys to allow access to the API. You can register a new ShipSmart API key at your dashboard.

ShipSmart expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer 5262d64b892e8d4341000001

Addresses

Create a new Addresses

curl "https://shipsmart.eu/api/v1/addresses" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4" \
  -d name="Ship Smartman" \
  -d company="ShipSmart" \
  -d street1="Hollandsestraat 1" \
  -d country="BE" \
  -d city="Brussel" \
  -d zip="1000" \
  -d phone="+321230239120" \
  -d email="ssmartman@shipsmart.eu" \

The above command returns a 201 HTTP response with JSON structured like this:

{
  "is_complete": true,
  "created_at": "2018-08-29T02:42:53+02:00",
  "last_updated": "2018-08-29T02:42:53+02:00",
  "id": "9061409b-5f87-499d-b820-3e13efaa5268",
  "name": "Ship Smartman",
  "company": "ShipSmart",
  "street1": "Hollandsestraat 1",
  "street2": "",
  "city": "Brussel",
  "zip": "1000",
  "state": "",
  "country": "BE",
  "phone": "+32123456790",
  "email": "ssmartman@shipsmart.eu",
  "type": "R",
}

This endpoint creates a new Address

HTTP Request

POST /addresses

Attributes

Attribute Type Description
name (required) string First and Last Name of the addressee.
company (optional) string Company name.
street1 (required) string First street line, 35 character limit.
street2 (optional) string Second street line, 35 character limit.
city (required) string Name of a city.
zip (optional) string Postal code of an Address. Only required if the country is Postal Aware.
state (optional) string State values are only required for the United States and Canada
country (required) string Example: ‘US’ or ‘DE’. All accepted values can be found on the Official ISO Website.
phone (required) string Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This increases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped.
email (optional) string E-mail address of the contact person, RFC3696/5321-compliant.
type (optional) string R for recipient and S for sender. Is set to R when omitted


Retrieve a Specific Address

curl "https://shipsmart.eu/api/v1/addresses/shipsmartTest" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns JSON structured like this:

{
  "is_complete": "true",
  "created_at": "2018-08-29T02:42:53+02:00",
  "last_updated": "2018-08-29T02:42:53+02:00",
  "id": "9061409b-5f87-499d-b820-3e13efaa5268",
  "name": "Ship martman",
  "company": "ShipSmart",
  "street1": "Hollandsestraat 1",
  "street2": "",
  "city": "Brussel",
  "zip": "1000",
  "state": "",
  "country": "BE",
  "phone": "+32123456790",
  "email": "ssmartman@shipsmart.eu"
  "type": "R"
}

This endpoint retrieves a specific Address.

HTTP Request

GET /addresses/<id>

URL Parameters

Parameter Type Description
id string The unique identifier of an Address


Update a Specific Address

curl "https://shipsmart.eu/api/v1/addresses/407477ae-fb72-4dac-a8d5-8b21d1322509" \
  -X "PUT" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4" \
  -d name="Ship Smartman" \
  -d street1="Rampe des Hollandais 1" \
  -d city="Bruxelles" \
  -d zip="1020" \
  -d country="BE" \
  -d phone="+32123456790"

The above command returns JSON structured like this:

{
  "is_complete": "true",
  "created_at": "2018-08-29T02:42:53+02:00",
  "last_updated": "2018-08-29T02:42:53+02:00",
  "id": "9061409b-5f87-499d-b820-3e13efaa5268",
  "name": "Ship martman",
  "company": "ShipSmart",
  "street1": "Rampe des Hollandais 1",
  "street2": "",
  "city": "Brussel",
  "zip": "1000",
  "state": "",
  "country": "BE",
  "phone": "+32123456790",
  "email": "ssmartman@shipsmart.eu"
  "type": "R"
}

This endpoint updates a specific Address.

HTTP Request

PUT /addresses/<id>

URL Parameters

Parameter Type Description
id string The unique identifier of an Address


Delete a Specific Address

curl "https://shipsmart.eu/api/v1/addresses/407477ae-fb72-4dac-a8d5-8b21d1322509" \
  -X "DELETE" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

This response has no content

{}

This endpoint deletes a specific Address.

HTTP Request

DELETE /addresses/<id>

URL Parameters

Parameter Type Description
id string The unique identifier of an Address


List All Addresses

curl "https://shipsmart.eu/api/v1/addresses?limit=20&page=1" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns a 200 HTTP response with JSON structured like this:

{
  "data": [
      {
        "is_complete": "true",
        "created_at": "2018-08-29T02:42:53+02:00",
        "last_updated": "2018-08-29T02:42:53+02:00",
        "id": "9061409b-5f87-499d-b820-3e13efaa5268",
        "name": "Ship martman",
        "company": "ShipSmart",
        "street1": "Rampe des Hollandais 1",
        "street2": "",
        "city": "Brussel",
        "zip": "1000",
        "state": "",
        "country": "BE",
        "phone": "+32123456790",
        "email": "ssmartman@shipsmart.eu"
        "type": "R"
      },
      {},
      {},
  ],
  "meta": {
      "pagination": {
          "total": 3,
          "count": 3,
          "per_page": 20,
          "current_page": 1,
          "total_pages": 1,
          "links": []
      }
  }
}

This endpoint retrieves all addresses.

HTTP Request

GET /addresses{?limit}{&page}

Query Parameters

Parameter Type Default Description
limit (optional) integer 30 How many results per page to return
page (optional) integer 1 Which page of the result data to return


Packages

Create a new Packages

curl "https://shipsmart.eu/api/v1/packages" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4" \
  -d length=10.1 \
  -d width=10.1 \
  -d height=10.1 \
  -d weight=20.5

The above command returns a 201 HTTP response with JSON structured like this:

{
  "id": "917f8a56-5106-11e7-88a5-cbaddaf2cfd7",
  "length": 10.1,
  "width": 10.1,
  "height": 10.1,
  "weight": 20.5,
  "type_of_measure": "cm/kg"
}

This endpoint creates a new Package

HTTP Request

POST /packages

Attributes

Attribute Type Description
length (required) decimal Length of the package. Up to six digits in front and two digits after the decimal separator are accepted.
width (required) decimal Width of the package. Up to six digits in front and two digits after the decimal separator are accepted.
height (required) decimal Height of the package. Up to six digits in front and two digits after the decimal separator are accepted.
weight (required) decimal Weight of the package. Up to six digits in front and two digits after the decimal separator are accepted.
type_of_measure (optional) string The unit used for weight. Can be cm/kg or in/lb. Defaults to cm/kg when omitted.


Retrieve a Specific Package

curl "https://shipsmart.eu/api/v1/packages/917f8a56-5106-11e7-88a5-cbaddaf2cfd7" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns JSON structured like this:

{
  "id": "917f8a56-5106-11e7-88a5-cbaddaf2cfd7",
  "length": 10.1,
  "width": 10.1,
  "height": 10.1,
  "weight": 20.5,
  "type_of_measure": "cm/kg"
}

This endpoint retrieves a specific Package.

HTTP Request

GET /packages/<id>

URL Parameters

Parameter Type Description
id string The unique identifier of a Package


List All Packages

curl "https://shipsmart.eu/api/v1/packages?limit=20&page=1" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns a 200 HTTP response with JSON structured like this:

{
  "data": [
      {
        "id": "917f8a56-5106-11e7-88a5-cbaddaf2cfd7",
        "length": 10.1,
        "width": 10.1,
        "height": 10.1,
        "weight": 20.5,
        "type_of_meassure": "cm/kg"
      },
      {},
      {},
  ],
  "meta": {
      "pagination": {
          "total": 3,
          "count": 3,
          "per_page": 20,
          "current_page": 1,
          "total_pages": 1,
          "links": []
      }
  }
}

This endpoint retrieves all packages.

HTTP Request

GET /packages{?limit}{&page}

Query Parameters

Parameter Type Default Description
limit (optional) integer 30 How many results per page to return
page (optional) integer 1 Which page of the result data to return


Products

Create a new Product

curl "https://shipsmart.eu/api/v1/products" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4" \
  -d sku="testProduct" \
  -d name="Test Product" \
  -d description="shipping goods" \
  -d weight="20.5" \
  -d mass_unit="kg" \
  -d price=100
  -d currency="EUR" \
  -d hs_code="2019201" \
  -d country_of_origin="NL" \

The above command returns a 201 HTTP response with JSON structured like this:

{
  "created_at": "2018-08-29T02:42:53+02:00",
  "last_updated": "2018-08-29T02:42:53+02:00",
  "id": "9061409b-5f87-499d-b820-3e13efaa5268",
  "sku": "testProduct",
  "name": "Test Product",
  "description": "shipping goods",
  "weight": 20.5,
  "mass_unit": "kg",
  "price": 100,
  "currency": "EUR",
  "hs_code": "2019201",
  "country_of_origin": "NL",
}

This endpoint creates a new Product

HTTP Request

POST /products

Attributes

Attribute Type Description
sku (required) string A unique ID to store the product in the database.
name (required) string The name of the product.
description (required) string Description of the type of goods of the shipment.
weight (required) decimal Weight of the product. Up to six digits in front and two digits after the decimal separator are accepted.
mass_unit (optional) string The unit used for the weight. Defaults to kg.
price (required) decimal Unit value of the product.
currency (optional) string The currency used for the price. Defaults to EUR.
hs_code (optional) string HS tariff code for customs declaration.
country_of_origin (required) string Country of Origin of the product. Example: ‘US’ or ‘DE’. All accepted values can be found on the Official ISO Website


Retrieve a Specific Product

curl "https://shipsmart.eu/api/v1/products/testProduct" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns JSON structured like this:

{
  "created_at": "2018-08-29T02:42:53+02:00",
  "last_updated": "2018-08-29T02:42:53+02:00",
  "id": "9061409b-5f87-499d-b820-3e13efaa5268",
  "sku": "testProduct",
  "name": "Test Product",
  "description": "shipping goods",
  "weight": 20.5,
  "mass_unit": "kg",
  "price": 100,
  "currency": "EUR",
  "hs_code": "2019201",
  "country_of_origin": "NL",
  "current_stock": 71,
}

This endpoint retrieves a specific Product.

HTTP Request

GET /products/<sku>

URL Parameters

Parameter Type Description
sku string The unique identifier of an Product


Update a Specific Product

curl "https://shipsmart.eu/api/v1/products/testProduct" \
  -X "PUT" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4" \
  -d description="goods to ship" \
  -d weight=20.5 \
  -d country_of_origin="US" \

The above command returns JSON structured like this:

{
  "created_at": "2018-08-29T02:42:53+02:00",
  "last_updated": "2018-08-29T04:42:53+02:00",
  "id": "9061409b-5f87-499d-b820-3e13efaa5268",
  "sku": "testProduct",
  "name": "Test Product",
  "description": "goods to ship",
  "weight": 20.5,
  "mass_unit": "kg",
  "price": 100,
  "currency": "EUR",
  "hs_code": "2019201",
  "country_of_origin": "US",
}

This endpoint updates a specific Product.

HTTP Request

PUT /products/<sku>

URL Parameters

Parameter Type Description
sku string The unique identifier of a Product


Delete a Specific Product

curl "https://shipsmart.eu/api/v1/products/testProduct" \
  -X "DELETE" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

This response has no content

{}

This endpoint deletes a specific Product.

HTTP Request

DELETE /products/<sku>

URL Parameters

Parameter Type Description
sku string The unique identifier of an Product


List All Products

curl "https://shipsmart.eu/api/v1/products?limit=20&page=1" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns a 200 HTTP response with JSON structured like this:

{
  "data": [
      {
          "created_at": "2018-08-29T02:42:53+02:00",
          "last_updated": "2018-08-29T02:42:53+02:00",
          "id": "9061409b-5f87-499d-b820-3e13efaa5268",
          "sku": "testProduct",
          "name": "Test Product",
          "description": "shipping goods",
          "weight": 20.5,
          "mass_unit": "kg",
          "price": 100,
          "currency": "EUR",
          "hs_code": "2019201",
          "country_of_origin": "NL",
          "current_stock": 71,
      },
      {},
      {},
  ],
  "meta": {
      "pagination": {
          "total": 3,
          "count": 3,
          "per_page": 20,
          "current_page": 1,
          "total_pages": 1,
          "links": []
      }
  }
}

This endpoint retrieves all products.

HTTP Request

GET /products{?limit}{&page}

Query Parameters

Parameter Type Default Description
limit (optional) integer 30 How many results per page to return
page (optional) integer 1 Which page of the result data to return

<hr class=“split

Shipments

Create a new Shipment

curl "https://shipsmart.eu/api/v1/shipments" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4" \
  -H "Content-Type: application/json" \
  -d '{
    "address_from": {
      "name": "Ship Smartie",
      "company": "ShipSmart BV",
      "street1": "Hollandse straat 1",
      "city": "Amsterdam",
      "zip": "1092TE",
      "country": "NL",
      "phone": "+32123456790",
      "email": "shipsmartie@shipsmart.eu"
    },
    "recipient_address": {
      "id": "9061409b-5f87-499d-b820-3e13efaa5268"
    },
    "packages": [{
      "length": 20,
      "width": 20,
      "height": 20,
      "weight": 2
    },
    {
      "length": 10,
      "width": 10,
      "height": 10,
      "weight": 1
    }],
    "products": [{
      "sku": "testProduct"
    }]
  }'

The above command returns a 201 HTTP response with JSON structured like this:

{
  "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
  "shipment_date": "2017-06-28 00:48:02",
  "address_from": {
    "is_complete": "true",
    "created_at": "2018-08-29T02:42:53+02:00",
    "last_updated": "2018-08-29T04:42:53+02:00",
    "id": "940a4e13-732f-4fee-a4f9-4d632a1289ad",
    "name": "Ship Smartie",
    "company": "ShipSmart BV",
    "street1": "Hollandse straat 1",
    "street2": "",
    "city": "Amsterdam",
    "zip": "1092TE",
    "state": "",
    "country": "NL",
    "phone": "+32123456790",
    "email": "shipsmartie@shipsmart.eu",
    "type": "S",
  },
  "address_to": {
    "is_complete": "true",
    "created_at": "2018-08-29T02:42:53+02:00",
    "last_updated": "2018-08-29T04:42:53+02:00",
    "id": "9061409b-5f87-499d-b820-3e13efaa5268",
    "name": "Ship Smartman",
    "company": "ShipSmart",
    "street1": "Rampe des Hollandais 1",
    "street2": "",
    "city": "Bruxelles",
    "zip": "1020",
    "state": "",
    "country": "BE",
    "phone": "+32123456790",
    "email": "ssmartman@shipsmart.eu",
    "type": "R",
  },
  "packages": [
    {
      "id": "1a236606-514e-11e7-a89f-8cab59432b82",
      "length": 20,
      "width": 20,
      "height": 20,
      "weight": 2,
      "type_of_measure": "cm/kg"
    },
    {
      "id": "1a24bd58-514e-11e7-9907-92bdb949e756",
      "length": 10,
      "width": 10,
      "height": 10,
      "weight": 1,
      "type_of_measure": "cm/kg"
    }
  ],
  "products": [
    {
      "created_at": "2018-08-29T02:42:53+02:00",
      "last_updated": "2018-08-29T02:42:53+02:00",
      "id": "9061409b-5f87-499d-b820-3e13efaa5268",
      "sku": "testProduct",
      "name": "Test Product",
      "description": "shipping goods",
      "weight": 20.5,
      "mass_unit": "kg",
      "price": 100,
      "currency": "EUR",
      "hs_code": "2019201",
      "country_of_origin": "NL",
    }
  ],
  "rates": [
    {
      "id": "7410371e-5b9b-11e7-841f-dbafa211d622",
      "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
      "carrier": "FedEx",
      "service": "EUROPE_FIRST_INTERNATIONAL_PRIORITY",
      "delivery_date": "2017-06-29 09:00:00",
      "currency": "EUR",
      "total_price": 60.6
    },
    {
      "id": "7411104e-5b9b-11e7-96d1-ffdc928a012b",
      "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
      "carrier": "FedEx",
      "service": "INTERNATIONAL_PRIORITY",
      "delivery_date": "2017-06-29 12:00:00",
      "currency": "EUR",
      "total_price": 30.6
    },
    {
      "id": "7411ca20-5b9b-11e7-9b51-45c8110423bd",
      "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
      "carrier": "FedEx",
      "service": "INTERNATIONAL_ECONOMY",
      "delivery_date": "2017-06-30 18:00:00",
      "currency": "EUR",
      "total_price": 16.57
    }
  ],
  "shipment_reference": ""
  "content_type": "NON_DOCUMENTS"
  "test": true
  "extra": "{\"cod\":false,\"cod_fee\":0}"
}

This endpoint creates a new Shipment

HTTP Request

POST /shipments

Attributes

Attribute Type Description
address_from (required) Address object Address object that should be used as sender Address. If the address object is already in de database, the store_id of the address is sufficient.
address_to (required) Address object Address object that should be used as recipient Address. If the address object is already in de database, the store_id of the address is sufficient.
packages (required) array Array of package objects.
products (required) array Array of product objects or existing Product store_ids.
test (optional) boolean Indicates whether the object should been created in test mode.
shipment_reference (optional) string Optional shipment reference.
content_type (optional) string Indicates whether the shipment is a DOCUMENTS_ONLY or NON_DOCUMENTS shipment. Defaulted to NON_DOCUMENTS


Retrieve a Specific Shipment

curl "https://shipsmart.eu/api/v1/shipments/70604e24-5b9b-11e7-b75f-b711eb5ced59" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns JSON structured like this:

{
  "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
  "shipment_date": "2017-06-28 00:48:02",
  "address_from": {
    "is_complete": "true",
    "created_at": "2018-08-29T02:42:53+02:00",
    "last_updated": "2018-08-29T04:42:53+02:00",
    "id": "940a4e13-732f-4fee-a4f9-4d632a1289ad",
    "name": "Ship Smartie",
    "company": "ShipSmart BV",
    "street1": "Hollandse straat 1",
    "street2": "",
    "city": "Amsterdam",
    "zip": "1092TE",
    "state": "",
    "country": "NL",
    "phone": "+32123456790",
    "email": "shipsmartie@shipsmart.eu",
    "type": "S",
  },
  "address_to": {
    "is_complete": "true",
    "created_at": "2018-08-29T02:42:53+02:00",
    "last_updated": "2018-08-29T04:42:53+02:00",
    "id": "9061409b-5f87-499d-b820-3e13efaa5268",
    "name": "Ship Smartman",
    "company": "ShipSmart",
    "street1": "Rampe des Hollandais 1",
    "street2": "",
    "city": "Bruxelles",
    "zip": "1020",
    "state": "",
    "country": "BE",
    "phone": "+32123456790",
    "email": "ssmartman@shipsmart.eu",
    "type": "R",
  },
  "packages": [
    {
      "id": "1a236606-514e-11e7-a89f-8cab59432b82",
      "length": 20,
      "width": 20,
      "height": 20,
      "weight": 2,
      "type_of_measure": "cm/kg"
    },
    {
      "id": "1a24bd58-514e-11e7-9907-92bdb949e756",
      "length": 10,
      "width": 10,
      "height": 10,
      "weight": 1,
      "type_of_measure": "cm/kg"
    }
  ],
  "products": [
    {
      "created_at": "2018-08-29T02:42:53+02:00",
      "last_updated": "2018-08-29T02:42:53+02:00",
      "id": "9061409b-5f87-499d-b820-3e13efaa5268",
      "sku": "testProduct",
      "name": "Test Product",
      "description": "shipping goods",
      "weight": 20.5,
      "mass_unit": "kg",
      "price": 100,
      "currency": "EUR",
      "hs_code": "2019201",
      "country_of_origin": "NL",
    }
  ],
  "rates": [
    {
      "id": "7410371e-5b9b-11e7-841f-dbafa211d622",
      "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
      "carrier": "FedEx",
      "service": "EUROPE_FIRST_INTERNATIONAL_PRIORITY",
      "delivery_date": "2017-06-29 09:00:00",
      "currency": "EUR",
      "total_price": 60.6
    },
    {
      "id": "7411104e-5b9b-11e7-96d1-ffdc928a012b",
      "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
      "carrier": "FedEx",
      "service": "INTERNATIONAL_PRIORITY",
      "delivery_date": "2017-06-29 12:00:00",
      "currency": "EUR",
      "total_price": 30.6
    },
    {
      "id": "7411ca20-5b9b-11e7-9b51-45c8110423bd",
      "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
      "carrier": "FedEx",
      "service": "INTERNATIONAL_ECONOMY",
      "delivery_date": "2017-06-30 18:00:00",
      "currency": "EUR",
      "total_price": 16.57
    }
  ],
  "shipment_reference": ""
  "content_type": "NON_DOCUMENTS"
  "test": true
  "extra": "{\"cod\":false,\"cod_fee\":0}"
}

This endpoint retrieves a specific Shipment.

HTTP Request

GET /shipments/<id>

URL Parameters

Parameter Type Description
id string The unique identifier of a Shipment


Retrieve Shipment Rates

curl "https://shipsmart.eu/api/v1/shipments/70604e24-5b9b-11e7-b75f-b711eb5ced59/rates" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns JSON structured like this:

{
  "data": [
    {
  "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
  "shipment_date": "2017-06-28 00:48:02",
  "address_from": {
    "is_complete": "true",
    "created_at": "2018-08-29T02:42:53+02:00",
    "last_updated": "2018-08-29T04:42:53+02:00",
    "id": "940a4e13-732f-4fee-a4f9-4d632a1289ad",
    "name": "Ship Smartie",
    "company": "ShipSmart BV",
    "street1": "Hollandse straat 1",
    "street2": "",
    "city": "Amsterdam",
    "zip": "1092TE",
    "state": "",
    "country": "NL",
    "phone": "+32123456790",
    "email": "shipsmartie@shipsmart.eu",
    "type": "S",
  },
  "address_to": {
    "is_complete": "true",
    "created_at": "2018-08-29T02:42:53+02:00",
    "last_updated": "2018-08-29T04:42:53+02:00",
    "id": "9061409b-5f87-499d-b820-3e13efaa5268",
    "name": "Ship Smartman",
    "company": "ShipSmart",
    "street1": "Rampe des Hollandais 1",
    "street2": "",
    "city": "Bruxelles",
    "zip": "1020",
    "state": "",
    "country": "BE",
    "phone": "+32123456790",
    "email": "ssmartman@shipsmart.eu",
    "type": "R",
  },
  "packages": [
    {
      "id": "1a236606-514e-11e7-a89f-8cab59432b82",
      "length": 20,
      "width": 20,
      "height": 20,
      "weight": 2,
      "type_of_measure": "cm/kg"
    },
    {
      "id": "1a24bd58-514e-11e7-9907-92bdb949e756",
      "length": 10,
      "width": 10,
      "height": 10,
      "weight": 1,
      "type_of_measure": "cm/kg"
    }
  ],
  "products": [
    {
      "created_at": "2018-08-29T02:42:53+02:00",
      "last_updated": "2018-08-29T02:42:53+02:00",
      "id": "9061409b-5f87-499d-b820-3e13efaa5268",
      "sku": "testProduct",
      "name": "Test Product",
      "description": "shipping goods",
      "weight": 20.5,
      "mass_unit": "kg",
      "price": 100,
      "currency": "EUR",
      "hs_code": "2019201",
      "country_of_origin": "NL",
    }
  ],
  "rates": [
    {
      "id": "7410371e-5b9b-11e7-841f-dbafa211d622",
      "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
      "carrier": "FedEx",
      "service": "EUROPE_FIRST_INTERNATIONAL_PRIORITY",
      "delivery_date": "2017-06-29 09:00:00",
      "currency": "EUR",
      "total_price": 60.6
    },
    {
      "id": "7411104e-5b9b-11e7-96d1-ffdc928a012b",
      "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
      "carrier": "FedEx",
      "service": "INTERNATIONAL_PRIORITY",
      "delivery_date": "2017-06-29 12:00:00",
      "currency": "EUR",
      "total_price": 30.6
    },
    {
      "id": "7411ca20-5b9b-11e7-9b51-45c8110423bd",
      "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
      "carrier": "FedEx",
      "service": "INTERNATIONAL_ECONOMY",
      "delivery_date": "2017-06-30 18:00:00",
      "currency": "EUR",
      "total_price": 16.57
    }
  ],
  "shipment_reference": ""
  "content_type": "NON_DOCUMENTS"
  "test": true
  "extra": "{\"cod\":false,\"cod_fee\":0}"
    }
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "count": 3,
      "per_page": 30,
      "current_page": 1,
      "total_pages": 1,
      "links": []
    }
  }
}

This endpoint retrieves rates from a existing Shipment.

HTTP Request

GET /shipments/<id>/rates

URL Parameters

Parameter Type Description
id string The unique identifier of a Shipment


List All Shipments

curl "https://shipsmart.eu/api/v1/shipments?limit=20&page=1" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns a 200 HTTP response with JSON structured like this:

{
  "data": [
      {
          "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
          "shipment_timestamp": "2017-06-14 19:59:41",
          "sender_address": {
              "store_id": "shipsmartTest1",
              "name": "Ship Smartie",
              "company": "ShipSmart BV",
              "street1": "Hollandse straat 1",
              "city": "Amsterdam",
              "zip": "1092TE",
              "country": "NL",
              "phone": "+32123456790",
              "email": "shipsmartie@shipsmart.eu"
          },
          "recipient_address": {
            "store_id": "shipsmartTest",
            "name": "Ship Smartman",
            "company": "ShipSmart",
            "street1": "Rampe des Hollandais 1",
            "city": "Bruxelles",
            "zip": "1020",
            "country": "BE",
            "phone": "+32123456790",
            "email": "ssmartman@shipsmart.eu"
          },
          "packages": [
              {
                  "id": "1a236606-514e-11e7-a89f-8cab59432b82",
                  "length": 20,
                  "width": 20,
                  "height": 20,
                  "weight": 2
              },
              {
                  "id": "1a24bd58-514e-11e7-9907-92bdb949e756",
                  "length": 10,
                  "width": 10,
                  "height": 10,
                  "weight": 1
              }
          ],
          "products": [
              {
                  "store_id": "testProduct",
                  "description": "test_description",
                  "country_of_manufacture": "NL",
                  "hs_tariff_code": "128281928",
                  "weight": 7,
                  "quantity": 1,
                  "quantity_units": "EA",
                  "unit_price": 20
              }
          ],
          "rates": [
              {
                  "id": "7410371e-5b9b-11e7-841f-dbafa211d622",
                  "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
                  "service": "EUROPE_FIRST_INTERNATIONAL_PRIORITY",
                  "carrier": "FedEx",
                  "delivery_date": "2017-06-29 09:00:00",
                  "currency": "EUR",
                  "total_price": 60.6
              },
              {
                  "id": "7411104e-5b9b-11e7-96d1-ffdc928a012b",
                  "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
                  "service": "INTERNATIONAL_PRIORITY",
                  "carrier": "FedEx",
                  "delivery_date": "2017-06-29 12:00:00",
                  "currency": "EUR",
                  "total_price": 30.6
              },
              {
                  "id": "7411ca20-5b9b-11e7-9b51-45c8110423bd",
                  "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
                  "service": "INTERNATIONAL_ECONOMY",
                  "carrier": "FedEx",
                  "delivery_date": "2017-06-30 18:00:00",
                  "currency": "EUR",
                  "total_price": 16.57
              }
          ],
          "test": true
      },
      {},
      {},
  ],
  "meta": {
      "pagination": {
          "total": 3,
          "count": 3,
          "per_page": 20,
          "current_page": 1,
          "total_pages": 1,
          "links": []
      }
  }
}

This endpoint retrieves all shipments.

HTTP Request

GET /shipments{?limit}{&page}

Query Parameters

Parameter Type Default Description
limit (optional) integer 30 How many results per page to return
page (optional) integer 1 Which page of the result data to return


Rates

Retrieve a Specific Rate

curl "https://shipsmart.eu/api/v1/rates/7410371e-5b9b-11e7-841f-dbafa211d622" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns JSON structured like this:

{
    "id": "7410371e-5b9b-11e7-841f-dbafa211d622",
    "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
    "carrier": "FedEx",
    "service": "EUROPE_FIRST_INTERNATIONAL_PRIORITY",
    "delivery_date": "2017-06-29 09:00:00",
    "total_price": 60.6
}

This endpoint retrieves a specific Rate.

HTTP Request

GET /rates/<id>

URL Parameters

Parameter Type Description
id string The unique identifier of a Rate


Labels

Create a Label (rate)

curl "https://shipsmart.eu/api/v1/labels" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4" \
  -d rate_id="70604e24-5b9b-11e7-b75f-b711eb5ced59"

The above command returns a 201 HTTP response with JSON structured like this:

{
  "label_id": "015872fa-5212-11e7-bfa1-72a8bb34a3ac",
  "tracking_number": "794600457742",
  "tracking_status": "CREATED",
  "tracking_url_provider": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794600457742",
  "label_url": "https://shipsmart.eu/labels/794600457742",
  "ci_url": "https://shipsmart.eu/docs/794600457742",
  "rate": {
      "id": "7410371e-5b9b-11e7-841f-dbafa211d622",
      "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
      "carrier": "FedEx",
      "service": "EUROPE_FIRST_INTERNATIONAL_PRIORITY",
      "delivery_date": "2017-06-29 09:00:00",
      "currency": "EUR",
      "total_price": 60.6
  }
}

This endpoint creates a new Shipping Label based on an existing Rate object

HTTP Request

POST /labels

Attributes

Attribute Type Description
rate (required) string A unique ID to store the rate in the database.


Create a Label (instant)

curl "https://shipsmart.eu/api/v1/labels" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4" \
  -H "Content-Type: application/json" \
  -d '{
    "shipment": {
      "address_from": {
        "name": "Ship Smartie",
        "company": "ShipSmart BV",
        "street1": "Hollandse straat 1",
        "city": "Amsterdam",
        "zip": "1092TE",
        "country": "NL",
        "phone": "+32123456790",
        "email": "shipsmartie@shipsmart.eu"
      },
      "recipient_address": {
        "id": "9061409b-5f87-499d-b820-3e13efaa5268"
      },
      "packages": [{
        "length": 20,
        "width": 20,
        "height": 20,
        "weight": 2
      },
      {
        "length": 10,
        "width": 10,
        "height": 10,
        "weight": 1
      }],
      "products": [{
        "sku": "testProduct"
      }]
    },
    "carrier": "FedEx",
    "service": "INTERNATIONAL_ECONOMY"
  }'

The above command returns a 201 HTTP response with JSON structured like this:

{
  "label_id": "015872fa-5212-11e7-bfa1-72a8bb34a3ac",
  "tracking_number": "794600457742",
  "tracking_status": "CREATED",
  "tracking_url_provider": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794600457742",
  "label_url": "https://shipsmart.eu/labels/794600457742",
  "ci_url": "https://shipsmart.eu/docs/794600457742",
  "rate": {
      "id": "7410371e-5b9b-11e7-841f-dbafa211d622",
      "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
      "carrier": "FedEx",
      "service": "EUROPE_FIRST_INTERNATIONAL_PRIORITY",
      "delivery_date": "2017-06-29 09:00:00",
      "currency": "EUR",
      "total_price": 60.6
  }
}

This endpoint creates a new Shipping Label based on a Shipment object

HTTP Request

POST /labels

Attributes

Attribute Type Description
shipment (required) object Shipment object (see [Shipments][#Shipments])
carrier (optional) string Id of the carrier for the shipment. When ommitted the system will assign a carrier automatically.
service (optional) string Service to use for the shipment. When ommitted the system will assign a service automatically.


Retrieve a Specific Label

curl "https://shipsmart.eu/api/v1/labels/015872fa-5212-11e7-bfa1-72a8bb34a3ac" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns JSON structured like this:

{
  "label_id": "015872fa-5212-11e7-bfa1-72a8bb34a3ac",
  "tracking_number": "794600457742",
  "tracking_status": "CREATED",
  "tracking_url_provider": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794600457742",
  "label_url": "https://shipsmart.eu/labels/794600457742",
  "ci_url": "https://shipsmart.eu/docs/794600457742",
  "rate": {
      "id": "7410371e-5b9b-11e7-841f-dbafa211d622",
      "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
      "carrier": "FedEx",
      "service": "EUROPE_FIRST_INTERNATIONAL_PRIORITY",
      "delivery_date": "2017-06-29 09:00:00",
      "currency": "EUR",
      "total_price": 60.6
  }
}

This endpoint retrieves a specific Label.

HTTP Request

GET /labels/<id>

URL Parameters

Parameter Type Description
id string The unique identifier of an Label


List All Labels

curl "https://shipsmart.eu/api/v1/labels?limit=20&page=1" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns a 200 HTTP response with JSON structured like this:

{
  "data": [
      {
        "label_id": "015872fa-5212-11e7-bfa1-72a8bb34a3ac",
        "tracking_number": "794600457742",
        "tracking_status": "CREATED",
        "tracking_url_provider": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794600457742",
        "label_url": "https://shipsmart.eu/labels/794600457742",
        "ci_url": "https://shipsmart.eu/docs/794600457742",
        "rate": {
            "id": "7410371e-5b9b-11e7-841f-dbafa211d622",
            "shipment_id": "70604e24-5b9b-11e7-b75f-b711eb5ced59",
            "carrier": "FedEx",
            "service": "EUROPE_FIRST_INTERNATIONAL_PRIORITY",
            "delivery_date": "2017-06-29 09:00:00",
            "currency": "EUR",
            "total_price": 60.6
        }
      },
      {},
      {},
  ],
  "meta": {
      "pagination": {
          "total": 3,
          "count": 3,
          "per_page": 20,
          "current_page": 1,
          "total_pages": 1,
          "links": []
      }
  }
}

This endpoint retrieves all labels.

HTTP Request

GET /labels{?limit}{&page}

Query Parameters

Parameter Type Default Description
limit (optional) integer 30 How many results per page to return
page (optional) integer 1 Which page of the result data to return


Fulfillment

Create a new Fulfillment

curl "https://shipsmart.eu/api/v1/fulfillments" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_order_id": "#1000",
    "name": "Ship Smartie",
    "company": "ShipSmart BV",
    "street1": "Hollandse straat 1",
    "city": "Amsterdam",
    "zip": "1092TE",
    "country": "NL",
    "phone": "+32123456790",
    "email": "shipsmartie@shipsmart.eu",
    "sku": "EAN1000",
    "quantity": 1
  }'

The above command returns a 201 HTTP response with JSON structured like this:

{
  "order_id": "O2018-1000",
  "customer_order_id": "#1000",
  "products": [
    {
      "id": "828d40b8-8fcc-4798-a7e2-f9f7a4c804b4",
      "sku": "EAN1000",
      "name": "Product",
      "description": "Usable Product",
      "current_stock": 71,
      "pivot": {
        "order_id": "1000",
        "product_id": "828d40b8-8fcc-4798-a7e2-f9f7a4c804b4",
        "quantity": 1,
        "created_at": "2018-08-29 05:33:20",
        "updated_at": "2018-08-29 05:33:20,"
      }
    }
  ],
  "status": "processing"
}

This endpoint creates a new Order for fulfillment

HTTP Request

POST /fulfillments

Attributes

Attribute Type Description
customer_order_id (required) string A unique identifier that identifies the order
name (required) string First and Last Name of the addressee.
company (optional) string Company name.
street1 (required) string First street line, 35 character limit.
street2 (optional) string Second street line, 35 character limit.
city (required) string Name of a city.
state (optional) string State values are only required for the United States and Canada
country (required) string Example: ‘US’ or ‘DE’. All accepted values can be found on the Official ISO Website.
phone (required) string Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This increases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped.
email (optional) string E-mail address of the contact person, RFC3696/5321-compliant.
sku (required) string Unique product identifier
quantity (optional) string Quantity of product. Defaulted to 1 when omitted


Retrieve a Specific Fulfillment

curl "https://shipsmart.eu/api/v1/fulfillments/O2018-1000" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns JSON structured like this:

{
  "order_id": "O2018-1000",
  "customer_order_id": "#1000",
  "products": [
    {
      "id": "828d40b8-8fcc-4798-a7e2-f9f7a4c804b4",
      "sku": "EAN1000",
      "name": "Product",
      "description": "Usable Product",
      "current_stock": 70,
      "pivot": {
        "order_id": "1000",
        "product_id": "828d40b8-8fcc-4798-a7e2-f9f7a4c804b4",
        "quantity": 1,
        "created_at": "2018-08-29 05:33:20",
        "updated_at": "2018-08-29 05:33:20,"
      }
    }
  ],
  "status": "completed"
  "tracking_number": "794600457742"
  "tracking_status": "CREATED"
  "tracking_url": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794600457742"
}

This endpoint retrieves a specific Fulfillment.

HTTP Request

GET /fulfillments/<order_id>

URL Parameters

Parameter Type Description
order_id string The unique identifier of an Order


List All Fulfillments

curl "https://shipsmart.eu/api/v1/fulfillments?limit=20&page=1&status=completed" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjliNzQxNzkxZjBmYzQ0NTUzYjhlNjU5ZWY0NjRjMmQ1YTIxMjI5ZTcyMTY4MGQ2ZjljZTgzMDAxNzk1ZGIzNjM1ZjFlY2RiMWVjOWU5NGU1In0.eyJhdWQiOiIyIiwianRpIjoiOWI3NDE3OTFmMGZjNDQ1NTNiOGU2NTllZjQ2NGMyZDVhMjEyMjllNzIxNjgwZDZmOWNlODMwMDE3OTVkYjM2MzVmMWVjZGIxZWM5ZTk0ZTUiLCJpYXQiOjE0OTkxMTAwMTQsIm5iZiI6MTQ5OTExMDAxNCwiZXhwIjoxNTMwNjQ2MDE0LCJzdWIiOiI2OGViNWZlMi02MDI1LTExZTctOGRiNC1hNjIyN2EwNGU2OTYiLCJzY29wZXMiOltdfQ.g8lPxFXzMSNx7Y3e9DfFUVDXh7tapltIqYbpp_ZSCL4e6AtdQWopLZlTxZc1VfUlOna4W8eRLY4yXNMjbfO64OEK4YhhhZcZKT1oW_KMIRR3zLWRWQJeVovWP5smc_zIAtxlpzEn9gF0Ce0wsCRc-IjQ4lr5aLnhXAQyBS26_JHZ_1aIvQgJ7Pss7JFr53Q2WaZ8gJD01VRQV0sMyyEVkAdj7W-twnDuXHFv_aWS4_ITkqSXf8MD67lIpFGyqsf8ilgbSwqzuycQjEWljkL6Vq4P1f6HHa4wuVQvNYnlI0QUeMwv9V7eqk0abj7S75m20LNVpuR1IJM0UfzIXTh533M-qz5XgdvsRWUNNfHjARLh4ahYL1xQZWvAasaxts8QyTeMdpO2igRKdHJ18r-NAQcns6yBtK6Oyhz9RrHz-ZkKs-4BnSBt09jPQsuuydi1EnLEwkzKPtws7nYW-viitKXPfBheXd2fi3nNnpH_6iett6IjtnMTG9kcb0NFrNWV_L79TiWpQqCwJkfYfF-J3VMGuTUXraCZcmpFITFAdarwmgJPTywWzx-gqNa3J98BcxdIqwfT4WCos5KNGwd6h2amvgDyiAtAEJd69PMTOlo96fJ9xl2gZVDDxwq_NSkN0OhuB-U-A03SufIAnzOzTSfInuqVcqestPXdh8rwJy4"

The above command returns a 200 HTTP response with JSON structured like this:

{
  "data": [
  {
    "order_id": "O2018-1000",
    "customer_order_id": "#1000",
    "products": [
    {
      "id": "828d40b8-8fcc-4798-a7e2-f9f7a4c804b4",
      "sku": "EAN1000",
      "name": "Product",
      "description": "Usable Product",
      "current_stock": 70,
      "pivot": {
        "order_id": "1000",
        "product_id": "828d40b8-8fcc-4798-a7e2-f9f7a4c804b4",
        "quantity": 1,
        "created_at": "2018-08-29 05:33:20",
        "updated_at": "2018-08-29 05:33:20,"
      }
    }],
    "status": "completed"
    "tracking_number": "794600457742"
    "tracking_status": "CREATED"
    "tracking_url": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794600457742"
  },
  {},
  {},
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "count": 3,
      "per_page": 20,
      "current_page": 1,
      "total_pages": 1,
      "links": []
    }
  }
}

This endpoint retrieves all orders.

HTTP Request

GET /fulfillments{?limit}{&page}{&status}

Query Parameters

Parameter Type Default Description
limit (optional) integer 30 How many results per page to return
page (optional) integer 1 Which page of the result data to return
status (optional) string Filter results on status. Possible values are: 'processing' and 'completed'.


Errors

The ShipSmart API uses the following error codes:

Error Code Meaning
400 Bad Request – Your request has errors
401 Unauthorized – Your API key is wrong
403 Forbidden – The resource requested is hidden for administrators only
404 Not Found – The specified resource could not be found
405 Method Not Allowed – You tried to access a resource with an invalid method
406 Not Acceptable – You requested a format that isn’t json
410 Gone – The resource requested has been removed from our servers
422 Unprocessable Entity – There were validation errors detected while processing your request.
429 Too Many Requests – You’re requesting too many resources!
500 Internal Server Error – We had a problem with our server. Try again later.
503 Service Unavailable – We’re temporarily offline for maintenance. Please try again later.