How to use Ship&co API

The Ship&co API is built around RESTful principles, and it is available for all the Ship&co users.

Our REST API comes with several features covering from Shipment, Rate, Tracking, Listing and more. It allows you to seamlessly integrate Ship&co's label generation capabilities into your own system. Check out the up-to-date API Document on our homepage. 
 

Setting up Ship&co API

There are few steps you have to proceed in order to use Ship&co API

1. Create an Ship&co account:
   To access the Ship&co API, you must have a Ship&co account. If you haven't created an account yet, please proceed to register here.
2. Generate the API Token to authorize your account:
   Setting an API Token to HTTP headers enables you to be authorized and use our API. Please follow the steps in this guide to get an API token.
   Once these steps are complete, you can create shipping labels by sending requests including the correct shipping address and sender address, parcel information, product information, carrier information, etc. 
3. Create/Test API Call: 
   Refer to the Ship&co API document and Postman Sample Codes for more details. 

Before starting using Ship&co API, make sure to read the following details:

• Ship&co API integrates with multi-carrier system which requires you to have an accurate shipping address for both shipper and consignee. Please make sure to use the valid address in order to successfully create shipping label.
• The API usage fee is the same as our app (dashboard) usage. For more information on our billing, please check out here.
• Ship&co offers an initial 30-day trial, where you can try out our services for free, with unlimited usage volumes. There is no credit card information required during your trial. After the trial, you are required to register with Ship&co subscription in the Profile page in the app.
   

Setting up Ship&co API in Test Environment

To make a test call with Ship&co API, please add "test": true in your request that enables you to create dummy shipping labels free-of-charge. You will not need to subscribe for using the test environment.

Note: Test labels are currently only available for UPS, DHL, Sagawa and Yamato. Sagawa and Yamato don't require carrier account registration, either. Details available from here for creating test labels.
 

Support for API Issues

If you come across any error messages or issues, our Support team is here to assist you. Our team can help test API calls to ensure they're functioning correctly and help pinpoint any incorrect or missing details that might be causing errors. If you're experiencing problems with your API calls and need help, don't hesitate to reach out to our Support team at hello@shipandco.com.

To provide the best assistance, please make sure to include the following information:

• The API action you were trying to perform
•  The full JSON body of the request and response