Shippo is a shipping API that connects you with multiple shipping carriers (such as USPS, UPS, DHL, Canada Post, Australia Post, and many others) through one interface.
You must register for a Shippo account to use our API. It's free to sign up. Only pay to print a live label, test labels are free.
To use the API, you must generate an API Token. In the following examples, replace <YOUR_API_KEY_HERE> with
your own token.
For example.
Shippo sdk = Shippo.builder()
.apiKeyHeader("shippo_test_595d9cb0c0e14497bf07e75ecfec6c6d")
.build();
JDK 11 or later is required.
The samples below show how a published SDK artifact is used:
Gradle:
implementation 'com.shippo:sdk:0.3.0'Maven:
<dependency>
<groupId>com.shippo</groupId>
<artifactId>sdk</artifactId>
<version>0.3.0</version>
</dependency>After cloning the git repository to your file system you can build the SDK artifact from source to the build directory by running ./gradlew build on *nix systems or gradlew.bat on Windows systems.
If you wish to build from source and publish the SDK artifact to your local Maven repository (on your filesystem) then use the following command (after cloning the git repo locally):
On *nix:
./gradlew publishToMavenLocal -Pskip.signingOn Windows:
gradlew.bat publishToMavenLocal -Pskip.signingpackage hello.world;
import com.shippo.sdk.Shippo;
import com.shippo.sdk.models.components.*;
import com.shippo.sdk.models.components.Security;
import com.shippo.sdk.models.operations.*;
import com.shippo.sdk.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;
public class Application {
public static void main(String[] args) throws Exception {
try {
Shippo sdk = Shippo.builder()
.apiKeyHeader("<YOUR_API_KEY_HERE>")
// the API version can be globally set, though this is normally not required
// .shippoApiVersion("<YYYY-MM-DD>")
.build();
ListAddressesResponse res = sdk.addresses().list()
.page(1L)
.results(5L)
.call();
if (res.addressPaginatedList().isPresent()) {
// handle response
}
} catch (com.shippo.sdk.models.errors.SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
// handle exception
throw e;
}
}
}Review our full guides and references at https://docs.goshippo.com/.
- list - List all addresses
- create - Create a new address
- get - Retrieve an address
- validate - Validate an address
- create - Create a batch
- get - Retrieve a batch
- addShipments - Add shipments to a batch
- purchase - Purchase a batch
- removeShipments - Remove shipments from a batch
- list - List all carrier accounts
- create - Create a new carrier account
- get - Retrieve a carrier account
- update - Update a carrier account
- initiateOauth2Signin - Connect an existing carrier account using OAuth 2.0
- register - Add a Shippo carrier account
- getRegistrationStatus - Get Carrier Registration status
- list - List all customs declarations
- create - Create a new customs declaration
- get - Retrieve a customs declaration
- create - Generate a live rates request
- getDefaultParcelTemplate - Show current default parcel template
- updateDefaultParcelTemplate - Update default parcel template
- deleteDefaultParcelTemplate - Clear current default parcel template
- create - Create a pickup
- get - Retrieve a rate
- listShipmentRates - Retrieve shipment rates
- listShipmentRatesByCurrencyCode - Retrieve shipment rates in currency
- list - List all service groups
- create - Create a new service group
- update - Update an existing service group
- delete - Delete a service group
- list - List all user parcel templates
- create - Create a new user parcel template
- delete - Delete a user parcel template
- get - Retrieves a user parcel template
- update - Update an existing user parcel template
- list - List all Shippo Accounts
- create - Create a Shippo Account
- get - Retrieve a Shippo Account
- update - Update a Shippo Account
- createWebhook - Create a new webhook
- listWebhooks - List all webhooks
- getWebhook - Retrieve a specific webhook
- updateWebhook - Update an existing webhook
- deleteWebhook - Delete a specific webhook
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!