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
POSTcreateShipment

Creates a new shipment object.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
addressToIdSTRING
REQUIREDAddress of the receiver
parcelIdSTRING
REQUIREDparcel Id
apiKeyCREDENTIALS
REQUIREDThe api key obtained from Shippo.
objectPurposeSELECT
REQUIREDPurpose of the new address. Possible valuse: QUOTE or PURCHASE.
addressFromIdSTRING
REQUIREDAddress of the sender
Optional Parameters
reference2STRING
OPTIONALAdditional reference information
insuranceAmountSTRING
OPTIONALInsurance amount
asyncBOOLEAN
OPTIONALShipment async of not
submissionDateSTRING
OPTIONALDatetime of the submission
extraJSON
OPTIONALExtra information about the shipment
addressReturnIdSTRING
OPTIONALAddress of the return
customsDeclarationIdSTRING
OPTIONALCustoms declaration Id
reference1STRING
OPTIONALReference information
metadataSTRING
OPTIONALMetadata of the shipment
insuranceCurrencySTRING
OPTIONALCurrency of insurance amount. ISO 4217 Currency Code
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication