EasyPost
App · 20 actions
Create addresses, parcels, shipments and trackers, buy or refund shipping labels, and read events.
Actions
| Action | What it does |
|---|---|
| Buy shipment | Buy shipment. |
| Create address | Create address. |
| Create and verify address | Create an address and verify it with the postal service. |
| Create batch | Create an unprocessed batch. |
| Create parcel | Create parcel. |
| Create shipment | Create shipment. |
| Create tracker | Create tracker. |
| Get address | Get address. |
| Get batch | Get batch. |
| Get event | Get event. |
| Get parcel | Get parcel. |
| Get shipment | Get shipment. |
| Get tracker | Get tracker. |
| Get user | Get user. |
| List addresses | List stored addresses with a continuation value. |
| List carrier accounts | List carrier accounts. |
| List events | List events. |
| List shipments | List shipments. |
| List trackers | List trackers. |
| Refund shipment | Refund shipment. |
Buy shipment
Buy shipment.
Inputs
- Id
idtextRequired - Id.
- Rate id
rate_idtextRequired - A rate ID returned by Create shipment.
- Insurance
insurancenumber - 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
- Street1
street1textRequired - Street1.
- Street2
street2text - Street2.
- City
citytextRequired - City.
- State
statetextRequired - State.
- Zip
ziptextRequired - Zip.
- Country
countrytextRequired - 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. - Name
nametext - Name.
- Company
companytext - Company.
- Phone
phonetext - Phone.
- Email
emailtext - Email.
- Residential
residentialtrue/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
- Street1
street1textRequired - Street1.
- Street2
street2text - Street2.
- City
citytextRequired - City.
- State
statetextRequired - State.
- Zip
ziptextRequired - Zip.
- Country
countrytextRequired - 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. - Name
nametext - Name.
- Company
companytext - Company.
- Phone
phonetext - Phone.
- Email
emailtext - Email.
- Residential
residentialtrue/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
- Reference
referencetext - 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
- Length
lengthnumber - Length.
- Width
widthnumber - Width.
- Height
heightnumber - Height.
- Weight
weightnumberRequired - 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 address
to_addressobjectRequired - Use an address from Create address as {"id": "adr_..."}, or fill the address fields.
- From address
from_addressobjectRequired - Use an address from Create address as {"id": "adr_..."}, or fill the address fields.
- Parcel
parcelobjectRequired - Use a parcel from Create parcel as {"id": "prcl_..."}, or supply dimensions and weight in ounces.
- Reference
referencetext - 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 code
tracking_codetextRequired - Tracking code.
- Carrier
carriertext - 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
- Id
idtextRequired - 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
- Id
idtextRequired - 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
- Id
idtextRequired - 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
- Id
idtextRequired - 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
- Id
idtextRequired - 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
- Id
idtextRequired - 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 size
page_sizenumber - Records per page, 1 to 100.From 1 to 100.
- Before id
before_idtext - ID immediately after the page to read.
- After id
after_idtext - ID immediately before the page to read.
- Start datetime
start_datetimedate and time - Only records created on or after this time.
- End datetime
end_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 size
page_sizenumber - Records per page, 1 to 100.From 1 to 100.
- Before id
before_idtext - ID immediately after the page to read.
- After id
after_idtext - ID immediately before the page to read.
- Start datetime
start_datetimedate and time - Only records created on or after this time.
- End datetime
end_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 size
page_sizenumber - Records per page, 1 to 100.From 1 to 100.
- Before id
before_idtext - ID immediately after the page to read.
- After id
after_idtext - ID immediately before the page to read.
- Start datetime
start_datetimedate and time - Only records created on or after this time.
- End datetime
end_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 size
page_sizenumber - Records per page, 1 to 100.From 1 to 100.
- Before id
before_idtext - ID immediately after the page to read.
- After id
after_idtext - ID immediately before the page to read.
- Start datetime
start_datetimedate and time - Only records created on or after this time.
- End datetime
end_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
- Id
idtextRequired - 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
}