EasyPost

App · 20 actions

Create addresses, parcels, shipments and trackers, buy or refund shipping labels, and read events.

Actions

ActionWhat it does
Buy shipmentBuy shipment.
Create addressCreate address.
Create and verify addressCreate an address and verify it with the postal service.
Create batchCreate an unprocessed batch.
Create parcelCreate parcel.
Create shipmentCreate shipment.
Create trackerCreate tracker.
Get addressGet address.
Get batchGet batch.
Get eventGet event.
Get parcelGet parcel.
Get shipmentGet shipment.
Get trackerGet tracker.
Get userGet user.
List addressesList stored addresses with a continuation value.
List carrier accountsList carrier accounts.
List eventsList events.
List shipmentsList shipments.
List trackersList trackers.
Refund shipmentRefund shipment.

Buy shipment

Buy shipment.

Inputs

IdidtextRequired
Id.
Rate idrate_idtextRequired
A rate ID returned by Create shipment.
Insuranceinsurancenumber
Declared value in US dollars; leave empty for no extra insurance.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Create address

Create address.

Inputs

Street1street1textRequired
Street1.
Street2street2text
Street2.
CitycitytextRequired
City.
StatestatetextRequired
State.
ZipziptextRequired
Zip.
CountrycountrytextRequired
Country.One of: AF (Afghanistan), AX (Åland Islands), AL (Albania), DZ (Algeria), AD (Andorra), AO (Angola), AI (Anguilla), AQ (Antarctica), AG (Antigua & Barbuda), AR (Argentina), and 239 more.
Namenametext
Name.
Companycompanytext
Company.
Phonephonetext
Phone.
Emailemailtext
Email.
Residentialresidentialtrue/false
Residential.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Create and verify address

Create an address and verify it with the postal service.

Inputs

Street1street1textRequired
Street1.
Street2street2text
Street2.
CitycitytextRequired
City.
StatestatetextRequired
State.
ZipziptextRequired
Zip.
CountrycountrytextRequired
Country.One of: AF (Afghanistan), AX (Åland Islands), AL (Albania), DZ (Algeria), AD (Andorra), AO (Angola), AI (Anguilla), AQ (Antarctica), AG (Antigua & Barbuda), AR (Argentina), and 239 more.
Namenametext
Name.
Companycompanytext
Company.
Phonephonetext
Phone.
Emailemailtext
Email.
Residentialresidentialtrue/false
Residential.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Create batch

Create an unprocessed batch. This does not purchase shipping labels.

Inputs

Referencereferencetext
Your reference for the unprocessed batch.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Create parcel

Create parcel.

Inputs

Lengthlengthnumber
Length.
Widthwidthnumber
Width.
Heightheightnumber
Height.
WeightweightnumberRequired
Weight.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Create shipment

Create shipment.

Inputs

To addressto_addressobjectRequired
Use an address from Create address as {"id": "adr_..."}, or fill the address fields.
From addressfrom_addressobjectRequired
Use an address from Create address as {"id": "adr_..."}, or fill the address fields.
ParcelparcelobjectRequired
Use a parcel from Create parcel as {"id": "prcl_..."}, or supply dimensions and weight in ounces.
Referencereferencetext
Reference.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Create tracker

Create tracker.

Inputs

Tracking codetracking_codetextRequired
Tracking code.
Carriercarriertext
Carrier.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get address

Get address.

Inputs

IdidtextRequired
Id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get batch

Get batch.

Inputs

IdidtextRequired
Id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get event

Get event.

Inputs

IdidtextRequired
Id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get parcel

Get parcel.

Inputs

IdidtextRequired
Id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get shipment

Get shipment.

Inputs

IdidtextRequired
Id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get tracker

Get tracker.

Inputs

IdidtextRequired
Id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get user

Get user.

Inputs

None.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List addresses

List stored addresses with a continuation value.

Inputs

Page sizepage_sizenumber
Records per page, 1 to 100.From 1 to 100.
Before idbefore_idtext
ID immediately after the page to read.
After idafter_idtext
ID immediately before the page to read.
Start datetimestart_datetimedate and time
Only records created on or after this time.
End datetimeend_datetimedate and time
Only records created before this time.

Outputs

Result.

dataobject
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "addresses": [],
    "has_more": false
  },
  "has_more": false,
  "next_cursor": null
}

List carrier accounts

List carrier accounts.

Inputs

None.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List events

List events. Returns one page; use the continuation value for more records.

Inputs

Page sizepage_sizenumber
Records per page, 1 to 100.From 1 to 100.
Before idbefore_idtext
ID immediately after the page to read.
After idafter_idtext
ID immediately before the page to read.
Start datetimestart_datetimedate and time
Only records created on or after this time.
End datetimeend_datetimedate and time
Only records created before this time.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "events": [],
    "has_more": false
  },
  "has_more": false,
  "next_cursor": null
}

List shipments

List shipments. Returns one page; use the continuation value for more records.

Inputs

Page sizepage_sizenumber
Records per page, 1 to 100.From 1 to 100.
Before idbefore_idtext
ID immediately after the page to read.
After idafter_idtext
ID immediately before the page to read.
Start datetimestart_datetimedate and time
Only records created on or after this time.
End datetimeend_datetimedate and time
Only records created before this time.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "has_more": false,
    "shipments": []
  },
  "has_more": false,
  "next_cursor": null
}

List trackers

List trackers. Returns one page; use the continuation value for more records.

Inputs

Page sizepage_sizenumber
Records per page, 1 to 100.From 1 to 100.
Before idbefore_idtext
ID immediately after the page to read.
After idafter_idtext
ID immediately before the page to read.
Start datetimestart_datetimedate and time
Only records created on or after this time.
End datetimeend_datetimedate and time
Only records created before this time.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "has_more": false,
    "trackers": []
  },
  "has_more": false,
  "next_cursor": null
}

Refund shipment

Refund shipment.

Inputs

IdidtextRequired
Id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

On this page