• Installs:
  • Today: 30
  • This Week: 150
  • This Month: 510
  • All Time: 3251
Developer:userstefan.skliarov
Readme

Shippo

Shippo Package

Create a shipment, get rates and generate shipping labels.

  • Domain: Shippo
  • Credentials: apiKey

How to get credentials:

  1. Go to Shippo website
  2. Log in or create a new account
  3. Go to API page to get your API key

Custom datatypes:

DatatypeDescriptionExample
DatepickerString which includes date and time2016-05-28 00:00:00
MapString which includes latitude and longitude coma separated50.37, 26.56
ListSimple array["123", "sample"]
SelectString with predefined valuessample
ArrayArray of objects[{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

Shippo.createAddress

Creates a new address object

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
nameStringName for the address.
objectPurposeSelectPurpose of the new address. Possible valuse: QUOTE or PURCHASE.
companyStringCompany at the provided address.
street1StringStreet of the address.
streetNoStringOptional additional info about the address.
street2StringOptional additional info about the address.
street3StringOptional additional info about the address.
cityStringCity of the address.
zipStringZip code of the address.
stateStringState of the address, if applied (otherwise leave empty).
countryStringISO 3166-1-alpha-2 code (ISO 2 country code).
phoneStringPhone of the address.
emailStringEmail of the address.
isResidentialBooleanDescribes if a person is residential.
validateBooleanDescribes if address requires validation.
metadataStringMetadata for the address.

Shippo.getAddresses

Retrieves list of addresses

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
pageNumberNumberNumber of the results page

Shippo.getSingleAddress

Retrieves single address.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
addressIdStringId of the address.

Shippo.validateSingleAddress

Validates single address.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
addressIdStringId of the address.

Shippo.createParcel

Creates a new parcel object.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
parcelLengthStringLength of the parcel.
parcelWidthStringWidth of the parcel.
parcelHeightStringHeight of the parcel.
measurementUnitSelectMeasurement units. Possible values: cm, in, ft, mm, m, yd
parcelWeightStringWeight of the parcel.
weightUnitSelectMeasurement units. Possible values: g, oz, lb, kg
templateStringTemplate of the parcel.
metadataStringEMtadata of the parcel.
extraJSONExtra data of the parcel.

Shippo.getParcels

Retrieves list of parcels.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
pageNumberNumberNumber of the results page

Shippo.getSingleParcel

Retrieves one parcel information.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
parcelIdStringId of the parcels.

Shippo.createShipment

Creates a new shipment object.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
objectPurposeSelectPurpose of the new address. Possible valuse: QUOTE or PURCHASE.
addressToIdStringAddress of the receiver
addressFromIdStringAddress of the sender
parcelIdStringparcel Id
addressReturnIdStringAddress of the return
submissionDateStringDatetime of the submission
customsDeclarationIdStringCustoms declaration Id
insuranceAmountStringInsurance amount
insuranceCurrencyStringCurrency of insurance amount. ISO 4217 Currency Code
extraJSONExtra information about the shipment
reference1StringReference information
reference2StringAdditional reference information
metadataStringMetadata of the shipment
asyncBooleanShipment async of not

Shippo.getShipments

Retrieves list of shipments.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
pageNumberNumberNumber of the results page

Shippo.getSingleShipment

Retrieves one shipment from the list.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
shipmentIdStringId of the shipment

Shippo.getShipmentRates

Retrieves list of rates for single shipment.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
shipmentIdStringId of the shipment
currencyCodeStringCode of the currency
pageNumberNumberNumber of the results page

Shippo.getShipmentSingleRate

Retrieves list of rates for single shipment.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
rateIdStringId of the rate

Shippo.createTransactionBasedOnRate

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

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
rateIdStringId of the rate
labelFileTypeSelectFiletypes of the label. Possible values: PNG, PDF, PDF_4X6,ZPLII
metadataStringMetadata for the transaction
asyncBooleanSets if transaction is async

Shippo.createTransaction

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

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
shipmentObjectPurposeSelectPurpose of the new address. Possible valuse: QUOTE or PURCHASE.
shipmentAddressToIdStringAddress of the receiver
shipmentAddressFromIdStringAddress of the sender
parcelIdStringId of the parcel
serviceLevelTokenStringSpecific rates when purchasing shipping label. Possible values are described at this page: https://goshippo.com/docs/reference#servicelevels
carrierAccountStringCarrier accounts are used as credentials to retrieve shipping rates and purchase labels from a shipping provider.
labelFileTypeSelectFiletypes of the label. Possible values: PNG, PDF, PDF_4X6,ZPLII
metadataStringMetadata for the transaction

Shippo.getTransactions

Retrieves list of transactions.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
pageNumberNumberNumber of the results page

Shippo.getSingleTransaction

Retrieves single transaction from the list of transactions.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
transactionIdStringId of the transaction

Shippo.createCustomsItem

Creates a new Customs Item object.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
itemDescriptionStringDescription of the item
itemQuantityNumberQuantity of the item
itemNetWeightStringNet weight of the item
itemWeightMeasurementUnitSelectMeasurement units. Possible values: g, oz, lb, kg
itemValueStringValue of the item
itemValueCurrencyStringISO 4217 Currency Code
itemOriginCountryStringISO 3166-1-alpha-2 code (ISO 2 country code)
itemTariffNumberStringNumber of item tariff
metadataStringItem metadata

Shippo.getCustomsItems

Retrieves list of customs items.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
pageNumberNumberNumber of the results page

Shippo.getSingleCustomsItem

Retrieves single customs item from the list of customs items.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
customsItemIdStringId of the customs item

Shippo.createCustomsDeclaration

Createsnew customs declaration

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
declarationCertifySignerStringCertify signer
certifyBooleanSets certify
declarationItemsListIds of items icluded in declaration
declarationNonDeliveryOptionSelectOptions is case of non delivery. Possible values: ABANDON OR RETURN
declarationContentsTypeSelectType of items. Possible values: DOCUMENTS, GIFT, SAMPLE, MERCHANDISE, HUMANITARIAN, DONATION, RETURN, OTHER
declarationContentsExplanationStringExplanatin of items content. Required only if declarationContentsType is OTHER
declarationExporterReferenceStringReference of the exporter.
declarationImporterReferenceStringReference of the importer.
declarationInvoiceStringInvoice for the declaration.
declarationLicenseStringLicense for the declaration.
declarationCertificateStringCertificate for the declaration.
declarationNotesStringNotes for the declaration.
declarationEelPfcSelectPossible values: 'NOEEI_30_37_a', 'NOEEI_30_37_h', 'NOEEI_30_36', 'AES_ITN'
declarationAesItnStringrequired if declarationEelPfc is 'AES_ITN'
declarationIncotermSelectPossible values: 'DDP', 'DDU', 'CPT', 'CIP'
declarationMetadataStringMetadata of the declaration

Shippo.getCustomsDeclarations

Retrieves list of customs declarations.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
pageNumberNumberNumber of the results page

Shippo.getSingleCustomsDeclaration

Retrieves single declaration from the list of customs declarations.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
declarationIdStringId of the customs declaration.

Shippo.createRefund

Creates new refund object.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
transactionIdStringId of the transaction for refund.

Shippo.getRefunds

Retrieves list of refunds.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
pageNumberNumberNumber of the results page

Shippo.getSingleRefund

Retrieves single refund from the list of refunds.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
refundIdStringId of the refund.

Shippo.createCarrierAccount

Creates new carrier account object.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
carrierNameStringName of the carrier. You can find list of carriers at this page - https://goshippo.com/docs/carriers.
carrierAccountIdStringUnique identifier of the account. You can find list of carriers at this page - https://goshippo.com/docs/carriers.
carrierParametersJSONAdditional parameters for the account, such as e.g. password or token. You can find list of carriers at this page - https://goshippo.com/docs/carriers.
carrierAccountActiveBooleanDetermines whether the account is enabled. Default is enabled.

Shippo.updateCarrierAccount

Updates existing carrier account object. carrierName and carrierAccountId can't be updated, because they form the unique identifier together.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
carrierAccountObjectIdStringObject account id to update.
carrierParametersJSONAdditional parameters for the account, such as e.g. password or token. You can find list of carriers at this page - https://goshippo.com/docs/carriers.
carrierAccountActiveBooleanDetermines whether the account is enabled. Default is enabled.

Shippo.getCarrierAccounts

Retrieves list of carrier accounts.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
pageNumberNumberNumber of the results page

Shippo.getSingleCarrierAccount

Retrieves single accout object from the list of carrier accounts.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
carrierAccountObjectIdStringObject account id to get.

Shippo.createManifest

Creates new manifest object.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
carrierAccountObjectIdStringId of the carrier account for this manifest.
manifestSubmissionDateStringDatetime of manifest submission.
addressFromIdStringId of sender address.
transactionsListTransactions for this manifest.
asyncBooleanAsync or not.

Shippo.getManifests

Retrieves list of manifests.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
pageNumberNumberNumber of the results page

Shippo.getSingleManifest

Retrieves single manifest from the list of manifests.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
manifestIdStringId of the manifest.

Shippo.getTrackingStatus

Retrieves status for the tracking number.

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
carrierNameStringName of the carrier for the current tracking
trackingIdStringId of the tracking

Shippo.registerTrackingWebhook

Registers your webhook for a shipment

FieldTypeDescription
apiKeycredentialsThe api key obtained from Shippo.
carrierNameStringName of the carrier for the current tracking
trackingIdStringId of the tracking
x
circle
Shippo
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Connect your app to APIs via RapidAPI

Consume and monitor multiple APIs through the RapidAPI SDK.
Click start to set up your app and connect to your first API.

START

Give your app a name

This app will be used in RapidAPI to collect and connect all the APIs you need.

NEXT

Connect your project

Choose your backend language and then install & require the RapidAPI SDK.

  • node
    NodeJS
  • php
    PHP
  • python
    Python
  • objc
    Obj-C
  • android
    Android
  • go
    GO
  • ruby
    Ruby
  • csharp
    C#

Install SDK

Run the following command to install the SDK:

npm install rapidapi-connect --save

Require SDK

In your code, add the following code to require the RapidAPI SDK:

NEXT

Hooray! You are connected

Use the following code to try it out by getting all the APIs that are on RapidAPI.

rapid.call('RapidAPI', 'getAll', {'{}'});
FINISH
esccloses this view
x

Login to RapidAPI

Create endpoints based on popular APIs and share with others.
Follow popular APIs and get updated. Stand out in the community of developers.

Login with Github
Login with Facebook
Login with Google
Or
Remember Me

  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Why sign up to RapidAPI?

    • integrate
      Integrate APIs into your app
      Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
    • keys
      Save all API keys in one place
    • notifications
      Get notifications about API changes
    • stats
      Get stats and monitor API connections
    Sign up with Github
    Sign up with Facebook
    Sign up with Google
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view