Skip to main content

Shippo

With Shippo modules in Make, you can:

  • create, retrieve, and list orders

  • watch, create, retrieve, and search shipments

  • watch, create, retrieve, and search shipping labels

  • watch parcels

To get started with Shippo, create an account at shippo.com.

Connect Shippo to Make using API key

To connect Shippo with Make you need to obtain the Shippo API Key from your Shippo account:

  1. Log in to your Shippo account.

  2. Click Settings > API > Generate Token.

    Shippo_3.png
  3. Copy the API Token to a safe place.

    Shippo_2.png
  4. Log in to your Make account, and add a module from the Shippo app into a Make scenario.

  5. Click Add next to the Connection field.

    Shippo_1.gif
  6. In the Connection name field, enter a name for the connection.

  7. In the API Key field, enter the details copied in step 3, and click Save.

    You have successfully established the connection and can now build scenarios.

Orders

You can create, retrieve, and list orders using the following modules.

Creates an order.

Connection

Establish a connection to your Shippo account.

Placed at

Enter (map) the date and time when the order was placed. See the list of supported date and time formats.

This date and time can be different from the date and time of the order object creation on Shippo.

Weight

Enter (map) the total weight of the order.

Weight Unit

Select the unit used for the weight field. For example, kilogram.

To Address

Enter (map) the address details of the recipient/buyer:

Country

Select or map the recipient's country.

Name

Enter (map) the recipient's first and last name.

Company

Enter (map) the recipient's company.

Street 1

Enter (map) the recipient's street name1.

Street No.

Enter (map) the recipient's street number.

Street 2

Enter (map) the recipient's street name2.

Street 3

Enter (map) the recipient's street name3.

City

Enter (map) the recipient's city name.

ZIP

Enter (map) the recipient's postal zip code.

State

Enter (map) the recipient's state name.

Email

Enter (map) the recipient's email address.

Phone

Enter (map) the recipient's phone number.

Is Residential

Select whether the recipient's address is residential.

Validate

Select whether to validate the recipient's address by object ID.

Metadata

Enter (map) the recipient's metadata.

From Address

Enter (map) the address details of the sender/seller.

Country

Select or map the sender's country.

Name

Enter (map) the sender's name.

Company

Enter (map) the sender's company.

Street 1

Enter (map) the sender's street address.

Street No.

Enter (map) the sender's street number.

Street 2

Enter (map) the sender's street address.

Street 3

Enter (map) the sender's street address.

City

Enter (map) the sender's city name.

ZIP

Enter (map) the sender's postal zip code.

State

Enter (map) the sender's state name.

Email

Enter (map) the sender's Email address.

Phone

Enter (map) the sender's phone number.

Is Residential

Select whether the sender's address is residential.

Validate

Select whether to validate the sender's address by object ID.

Metadata

Enter (map) the sender's metadata.

Line Items

Enter (map) the details of line items

Title

Enter (map) the title of the line item.

Currency

Select or map the currency applicable to the order.

Quantity

Enter (map) the number of items in the order.

SKU

Enter (map) the stock keeping unit (SKU) value of this item.

Total Price

Enter (map) the total price paid by the buyer for this item.

Weight

Enter (map) the total weight of this/these item(s).

Note

Instead of specifying the weight of all items, you can also set the total_weight value of the order object.

Weight Unit

Select the unit used for the weight. For example, pound.

Order Number

An alphanumeric identifier for the order used by the seller/buyer.

Order Status

Select the order status. For example, paid.

Shipping Cost

Enter (map) the amount to be paid by the buyer for shipping. This amount can be different from the price the seller will pay for shipping.

Shipping Cost Currency

Select or map the currency of the shipping cost amount.

Shipping Method

Enter (map) the shipping method chosen by the buyer.

Subtotal Price

Enter (map) the subtotal price amount to be paid by the buyer for this order.

Total Price

Enter (map) the total price amount to be paid by the buyer for this order.

Total Tax

Enter (map) the total tax amount paid by the buyer for this order.

Currency

Select or map the currency of the total price and total tax amounts.

Notes

Enter (map) the additional information provided by the buyer or seller about the order.

Retrieves a single order.

Connection

Establish a connection to your Shippo account.

Order ID

Select or map an Order ID whose details you want to retrieve.

Retrieves all orders.

Connection

Establish a connection to your Shippo account.

Limit

Set the maximum number of orders Make will return during one execution cycle. The default value is 10.

Shipments

You can watch, create, retrieve, and search shipments using the following modules.

Triggers if a shipment has been created or updated.

Connection

Establish a connection to your Shippo account.

Watch

Select a method:

  • Created Date

  • Updated Date

Limit

Set the maximum number of shipments Make will return during one execution cycle. The default value is 2.

Creates a new shipment.

Connection

Establish a connection to your Shippo account.

Address from

Enter (map) the details of the sender's address:

Country

Select or map the sender's country.

Name

Enter (map) the sender's first and last name.

Street 1

Enter (map) the sender's street address 1.

Street 2

Enter (map) the sender's street address 2.

City

Enter (map) the sender's city name.

State

Enter (map) the sender's state name.

ZIP

Enter (map) the sender's postal zip code.

Phone

Enter (map) the sender's phone number.

Email

Enter (map) the sender's email address.

Address to

Enter (map) the details of the recipient's address:

Country

Select or map the recipient's country.

Name

Enter (map) the recipient's first and last name.

Street 1

Enter (map) the recipient's street address.

Street 2

Enter (map) the recipient's street address.

City

Enter (map) the recipient's city name.

State

Enter (map) the recipient's state name.

ZIP

Enter (map) the recipient's postal zip code.

Phone

Enter (map) the recipient's phone number.

Email

Enter (map) the recipient's email address.

Parcels

Enter (map) the details of shipped parcel objects:

Weight

Enter (map) the weight of the package, in units as selected in the distance unit attribute.

Length

Enter (map) the length of the package, in units as selected in the distance unit attribute.

Width

Enter (map) the width of the package, in units as selected in the distance unit attribute.

Height

Enter (map) the height of the package, in units as selected in the mass unit attribute.

Distance Unit

Select the distance unit. For example, inches.

Mass Unit

Select the mass unit. For example, pound.

Asynchronous

Select whether to enable asynchronous mode.

Retrieves a single shipment.

Connection

Establish a connection to your Shippo account.

Shipment ID

Select or map the Shipment ID whose details you want to retrieve.

Retrieves all shipment objects.

Connection

Establish a connection to your Shippo account.

Object Created Greater

Enter (map) the date and time to retrieve the object(s) created after the provided date and time. See the list of supported date and time formats.

Object Created Greater or Equal

Enter (map) the date and time to retrieve the object(s) created after or on the provided date and time. See the list of supported date and time formats.

Object Created Less

Enter (map) the date and time to retrieve the object(s) created before the provided date and time. See the list of supported date and time formats.

Object Created Less or Equal

Enter (map) the date and time to retrieve object(s) created before or on the provided date and time. See the list of supported date and time formats.

Limit

Set the maximum number of shipments Make will return during one execution cycle. The default value is 10.

Shipping Labels

You can watch, create, retrieve, and search the shipping labels.

Triggers if a shipping label has been created or updated.

Connection

Establish a connection to your Shippo account.

Watch

Select a method to watch the shipping labels:

  • Created Date

  • Updated Date

Limit

Set the maximum number of shipping labels Make should return during one execution cycle. The default value is 2.

Creates a shipping label based on a rate object.

Connection

Establish a connection to your Shippo account.

Shipment ID

Select or map the Shipment ID whose label you want to create.

Rate ID

Select or map the Rate ID object for which you want to obtain a label.

Metadata

Enter (map) any additional information you want to attach to the object.

Label File Type

Select or map the label file type. For example, PDF.

Asynchronous

Select whether to create the rates asynchronously.

Retrieves a single shipping label.

Connection

Establish a connection to your Shippo account.

Shipping Label ID

Select or map the Shipping Label ID whose details you want to retrieve.

Retrieves all shipping labels.

Connection

.Establish a connection to your Shippo account

Object Created Greater

Enter (map) the date and time to retrieve the object(s) created after the provided date and time. See the list of supported date and time formats.

Object Created Greater or Equal

Enter (map) the date and time to retrieve the object(s) created after or on the provided date and time. See the list of supported date and time formats.

Object Created Less

Enter (map) the date and time to retrieve the object(s) created before the provided date and time. See the list of supported date and time formats.

Object Created Less or Equal

Enter (map) the date and time to retrieve object(s) created before or on the provided date and time. See the list of supported date and time formats.

Limit

Set the maximum number of shipping labels Make will return during one execution cycle. The default value is 10.

Parcels

You can watch the parcels using the following module.

Triggers if a parcel has been created or updated.

Connection

Establish a connection to your Shippo account.

Watch

Select a method to watch the parcels:

  • Created Date

  • Updated Date

Limit

Set the maximum number of parcels Make will return during one execution cycle. The default value is 10.

You can call APIs using the following module.

Performs an arbitrary authorized API call.

Note

For the list of available endpoints, refer to the Shippo API documentation.

Connection

Establish a connection to your Shippo account.

URL

Enter a path relative to https://api.goshippo.com. For example, /addresses.

Method

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of use - List Orders

The following API call returns all the orders from your Shippo account.

URL:

/orders

Method:

GET

Shippo_4.png

Matches of the search can be found in the module's Output under Bundle > Body > results

In this example, 20 orders were returned:

Shippo_5.png