Shippo

FREE
By stefan.skliarov
Updated 6 months ago
Logistics
3.3/10
Popularity Score
298ms
Latency
100%
Success Rate

Shippo API Documentation

Create a shipment, get rates and generate shipping labels.

View API Details
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

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
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.
Code Snippet
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication