Shippo API Documentation (stefan.skliarov) | RapidAPI

Shippo

FREE
By stefan.skliarov
Updated 9 months ago
Logistics
5/10
Popularity Score
241ms
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
POSTcreateTransaction

Creates a new transaction object and purchases the shipping label for the provided rate.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
shipmentAddressToIdSTRING
REQUIREDAddress of the receiver
carrierAccountSTRING
REQUIREDCarrier accounts are used as credentials to retrieve shipping rates and purchase labels from a shipping provider.
parcelIdSTRING
REQUIREDId of the parcel
apiKeyCREDENTIALS
REQUIREDThe api key obtained from Shippo.
shipmentAddressFromIdSTRING
REQUIREDAddress of the sender
shipmentObjectPurposeSELECT
REQUIREDPurpose of the new address. Possible valuse: QUOTE or PURCHASE.
serviceLevelTokenSTRING
REQUIREDSpecific rates when purchasing shipping label. Possible values are described at this page: https://goshippo.com/docs/reference#servicelevels
Optional Parameters
metadataSTRING
OPTIONALMetadata for the transaction
labelFileTypeSELECT
OPTIONALFiletypes of the label. Possible values: PNG, PDF, PDF_4X6,ZPLII
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication