Sign Up

Log In

Shippo

FREE
By stefan.skliarov
Updated 7 months ago
Logistics
-/10
Popularity Score
-
Latency
-
Success Rate

Shippo API Documentation

Create a shipment, get rates and generate shipping labels.

View API Details

Supercharge your App

Discover and connect to thousands of APIs in the world's largest API Hub

POSTcreateAddress
POSTcreateCarrierAccount
POSTcreateCustomsDeclaration
POSTcreateCustomsItem
POSTcreateManifest
POSTcreateParcel
POSTcreateRefund
POSTcreateShipment
POSTcreateTransaction
POSTcreateTransactionBasedOnRate
POSTgetAddresses
POSTgetCarrierAccounts
POSTgetCustomsDeclarations
POSTgetCustomsItems
POSTgetManifests
POSTgetParcels
POSTgetRefunds
POSTgetShipmentRates
POSTgetShipmentSingleRate
POSTgetShipments
POSTgetSingleAddress
POSTgetSingleCarrierAccount
POSTgetSingleCustomsDeclaration
POSTgetSingleCustomsItem
POSTgetSingleManifest
POSTgetSingleParcel
POSTgetSingleRefund
POSTgetSingleShipment
POSTgetSingleTransaction
POSTgetTrackingStatus
POSTgetTransactions
POSTregisterTrackingWebhook
POSTupdateCarrierAccount
POSTvalidateSingleAddress
POSTcreateAddress

Creates a new address object

Sign up to test this endpoint
Log in
Header Parameters
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
citySTRING
REQUIREDCity of the address.
objectPurposeSELECT
REQUIREDPurpose of the new address. Possible valuse: QUOTE or PURCHASE.
apiKeyCREDENTIALS
REQUIREDThe api key obtained from Shippo.
street1STRING
REQUIREDStreet of the address.
stateSTRING
REQUIREDState of the address, if applied (otherwise leave empty).
countrySTRING
REQUIREDISO 3166-1-alpha-2 code (ISO 2 country code).
zipSTRING
REQUIREDZip code of the address.
nameSTRING
REQUIREDName for the address.
emailSTRING
REQUIREDEmail of the address.
Optional Parameters
metadataSTRING
OPTIONALMetadata for the address.
phoneSTRING
OPTIONALPhone of the address.
street2STRING
OPTIONALOptional additional info about the address.
isResidentialBOOLEAN
OPTIONALDescribes if a person is residential.
companySTRING
OPTIONALCompany at the provided address.
street3STRING
OPTIONALOptional additional info about the address.
validateBOOLEAN
OPTIONALDescribes if address requires validation.
streetNoSTRING
OPTIONALOptional additional info about the address.
Request Snippet
unirest.post("https://Shippostefan.skliarovV1.p.rapidapi.com/createAddress")
.header("X-RapidAPI-Key", "undefined")
.header("Content-Type", "application/x-www-form-urlencoded")
.send("metadata=undefined")
.send("phone=undefined")
.send("street2=undefined")
.send("isResidential=undefined")
.send("company=undefined")
.send("street3=undefined")
.send("validate=undefined")
.send("streetNo=undefined")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response

loading...

Log inSign up

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.post("https://Shippostefan.skliarovV1.p.rapidapi.com/createAddress")
.header("X-RapidAPI-Key", "undefined")
.header("Content-Type", "application/x-www-form-urlencoded")
.send("metadata=undefined")
.send("phone=undefined")
.send("street2=undefined")
.send("isResidential=undefined")
.send("company=undefined")
.send("street3=undefined")
.send("validate=undefined")
.send("streetNo=undefined")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication
Sign up for freeto test this endpoint
Join the world’s largest API marketplace with over half a million developers and thousands of APIs.
DiscoverAPIs
Testfrom the browser
Connectusing code snippets
Managefrom one dashboard