Overview
- GET /v2/addresses
- POST /v2/addresses
- POST /v2/addresses/create_and_verify
- GET /v2/addresses/{ADDRESS_ID}/verify
- PARAMETERS /v2/addresses/{ADDRESS_ID}/verify
- GET /v2/addresses/{ADDRESS_ID}
- PARAMETERS /v2/addresses/{ADDRESS_ID}
- POST /v2/parcels
- GET /v2/parcels/{PARCEL_ID}
- PARAMETERS /v2/parcels/{PARCEL_ID}
- GET /v2/insurances
- POST /v2/insurances
- GET /v2/insurances/{INSURANCE_ID}
- PARAMETERS /v2/insurances/{INSURANCE_ID}
- GET /v2/shipments
- POST /v2/shipments
- GET /v2/shipments/{SHIPMENT_ID}
- PARAMETERS /v2/shipments/{SHIPMENT_ID}
- POST /v2/shipments/{SHIPMENT_ID}/forms
- PARAMETERS /v2/shipments/{SHIPMENT_ID}/forms
- POST /v2/shipments/{SHIPMENT_ID}/buy
- PARAMETERS /v2/shipments/{SHIPMENT_ID}/buy
- GET /v2/shipments/{SHIPMENT_ID}/label
- PARAMETERS /v2/shipments/{SHIPMENT_ID}/label
- POST /v2/shipments/{SHIPMENT_ID}/rerate
- PARAMETERS /v2/shipments/{SHIPMENT_ID}/rerate
- GET /v2/shipments/{SHIPMENT_ID}/smartrate
- PARAMETERS /v2/shipments/{SHIPMENT_ID}/smartrate
- POST /v2/shipments/{SHIPMENT_ID}/insure
- PARAMETERS /v2/shipments/{SHIPMENT_ID}/insure
- POST /v2/shipments/{SHIPMENT_ID}/refund
- PARAMETERS /v2/shipments/{SHIPMENT_ID}/refund
- GET /v2/shipments/{SHIPMENT_ID}/smartrate/delivery_date
- PARAMETERS /v2/shipments/{SHIPMENT_ID}/smartrate/delivery_date
- GET /v2/rates/{RATE_ID}
- PARAMETERS /v2/rates/{RATE_ID}
- GET /v2/trackers
- POST /v2/trackers
- GET /v2/trackers/{TRACKER_ID}
- PARAMETERS /v2/trackers/{TRACKER_ID}
- GET /v2/batches
- POST /v2/batches
- POST /v2/batches/{BATCH_ID}/add_shipments
- PARAMETERS /v2/batches/{BATCH_ID}/add_shipments
- POST /v2/batches/{BATCH_ID}/remove_shipments
- PARAMETERS /v2/batches/{BATCH_ID}/remove_shipments
- POST /v2/batches/{BATCH_ID}/buy
- PARAMETERS /v2/batches/{BATCH_ID}/buy
- POST /v2/batches/{BATCH_ID}/label
- PARAMETERS /v2/batches/{BATCH_ID}/label
- POST /v2/batches/{BATCH_ID}/scan_form
- PARAMETERS /v2/batches/{BATCH_ID}/scan_form
- GET /v2/batches/{BATCH_ID}
- PARAMETERS /v2/batches/{BATCH_ID}
- GET /v2/metadata/carriers
- POST /v2/customs_infos
- GET /v2/customs_infos/{CUSTOMS_INFO_ID}
- PARAMETERS /v2/customs_infos/{CUSTOMS_INFO_ID}
- POST /v2/customs_items
- GET /v2/customs_items/{CUSTOMS_ITEM_ID}
- PARAMETERS /v2/customs_items/{CUSTOMS_ITEM_ID}
- GET /v2/events
- GET /v2/events/{EVENT_ID}
- PARAMETERS /v2/events/{EVENT_ID}
- GET /v2/events/{EVENT_ID}/payloads
- PARAMETERS /v2/events/{EVENT_ID}/payloads
- GET /v2/events/{EVENT_ID}/payloads/{PAYLOAD_ID}
- PARAMETERS /v2/events/{EVENT_ID}/payloads/{PAYLOAD_ID}
- GET /v2/orders
- POST /v2/orders
- POST /v2/orders/{ORDER_ID}/buy
- PARAMETERS /v2/orders/{ORDER_ID}/buy
- GET /v2/pickups
- POST /v2/pickups
- GET /v2/pickups/{PICKUP_ID}
- PARAMETERS /v2/pickups/{PICKUP_ID}
- POST /v2/pickups/{PICKUP_ID}/buy
- PARAMETERS /v2/pickups/{PICKUP_ID}/buy
- POST /v2/pickups/{PICKUP_ID}/cancel
- PARAMETERS /v2/pickups/{PICKUP_ID}/cancel
- GET /v2/reports/{REPORT_TYPE}
- POST /v2/reports/{REPORT_TYPE}
- PARAMETERS /v2/reports/{REPORT_TYPE}
- GET /v2/reports/{REPORT_ID}
- PARAMETERS /v2/reports/{REPORT_ID}
- GET /v2/scan_forms
- POST /v2/scan_forms
- GET /v2/scan_forms/{SCANFORM_ID}
- PARAMETERS /v2/scan_forms/{SCANFORM_ID}
- GET /v2/webhooks
- POST /v2/webhooks
- GET /v2/webhooks/{WEBHOOK_ID}
- DELETE /v2/webhooks/{WEBHOOK_ID}
- PATCH /v2/webhooks/{WEBHOOK_ID}
- PARAMETERS /v2/webhooks/{WEBHOOK_ID}
- GET /v2/end_shippers
- POST /v2/end_shippers
- PUT /v2/end_shippers/{ENDSHIPPER_ID}
- PARAMETERS /v2/end_shippers/{ENDSHIPPER_ID}
- GET /v2/end_shippers/{ENDSHIIPPER_ID}
- PARAMETERS /v2/end_shippers/{ENDSHIIPPER_ID}
- GET /v2/api_keys
- GET /v2/users/{USER_ID}
- PATCH /v2/users/{USER_ID}
- PARAMETERS /v2/users/{USER_ID}
- GET /v2/users
- POST /v2/users
- PATCH /v2/users
- DELETE /v2/users/{CHILD_USER_ID}
- PARAMETERS /v2/users/{CHILD_USER_ID}
- PATCH /v2/users/{USER_ID}/brand
- PARAMETERS /v2/users/{USER_ID}/brand
- POST /v2/credit_cards/{CREDIT_CARD_ID}/charges
- PARAMETERS /v2/credit_cards/{CREDIT_CARD_ID}/charges
- POST /v2/bank_accounts/{BANK_ACCOUNT_ID}/charges
- PARAMETERS /v2/bank_accounts/{BANK_ACCOUNT_ID}/charges
- GET /v2/payment_methods
- DELETE /v2/credit_cards/{CREDIT_CARD_ID}
- PARAMETERS /v2/credit_cards/{CREDIT_CARD_ID}
- DELETE /v2/bank_accounts/{BANK_ACCOUNT_ID}
- PARAMETERS /v2/bank_accounts/{BANK_ACCOUNT_ID}
- GET /v2/carrier_types
- GET /v2/carrier_accounts
- POST /v2/carrier_accounts
- GET /v2/carrier_accounts/{CARRIER_ACCOUNT_ID}
- DELETE /v2/carrier_accounts/{CARRIER_ACCOUNT_ID}
- PATCH /v2/carrier_accounts/{CARRIER_ACCOUNT_ID}
- PARAMETERS /v2/carrier_accounts/{CARRIER_ACCOUNT_ID}
- GET /v2/referral_customers
- POST /v2/referral_customers
- PUT /v2/referral_customers/{REFERRAL_USER_ID}
- PARAMETERS /v2/referral_customers/{REFERRAL_USER_ID}
- GET /v2/partners/stripe_public_key
- POST /v1/tokens
- POST /v2/credit_cards
GET /v2/addresses
Summary: Retrieve All Addresses
Retrieve All Addresses
OpenAPI snippet URL
POST /v2/addresses
Summary: Create Address
Create Address
OpenAPI snippet URL
POST /v2/addresses/create_and_verify
Summary: Create and Verify Address
Create and Verify Address
OpenAPI snippet URL
GET /v2/addresses/{ADDRESS_ID}/verify
Summary: Verify Address
Verify Address
OpenAPI snippet URL
PARAMETERS /v2/addresses/{ADDRESS_ID}/verify
OpenAPI snippet URL
GET /v2/addresses/{ADDRESS_ID}
Summary: Retrieve Address
Retrieve Address
OpenAPI snippet URL
PARAMETERS /v2/addresses/{ADDRESS_ID}
OpenAPI snippet URL
POST /v2/parcels
Summary: Create Parcel
Create Parcel
OpenAPI snippet URL
GET /v2/parcels/{PARCEL_ID}
Summary: Retrieve Parcel
Retrieve Parcel
OpenAPI snippet URL
PARAMETERS /v2/parcels/{PARCEL_ID}
OpenAPI snippet URL
GET /v2/insurances
Summary: Retrieve All Insurance
Retrieve All Insurance
OpenAPI snippet URL
POST /v2/insurances
Summary: Create Insurance
Create Insurance
OpenAPI snippet URL
GET /v2/insurances/{INSURANCE_ID}
Summary: Retrieve Insurance
Retrieve Insurance
OpenAPI snippet URL
PARAMETERS /v2/insurances/{INSURANCE_ID}
OpenAPI snippet URL
GET /v2/shipments
Summary: Retrieve All Shipments
Retrieve All Shipments
OpenAPI snippet URL
POST /v2/shipments
Summary: Create Shipment
Create Shipment
OpenAPI snippet URL
GET /v2/shipments/{SHIPMENT_ID}
Summary: Retrieve Shipment
Retrieve Shipment
OpenAPI snippet URL
PARAMETERS /v2/shipments/{SHIPMENT_ID}
OpenAPI snippet URL
POST /v2/shipments/{SHIPMENT_ID}/forms
Summary: Create Form
Create Form
OpenAPI snippet URL
PARAMETERS /v2/shipments/{SHIPMENT_ID}/forms
OpenAPI snippet URL
POST /v2/shipments/{SHIPMENT_ID}/buy
Summary: Buy Shipment
Buy Shipment
OpenAPI snippet URL
PARAMETERS /v2/shipments/{SHIPMENT_ID}/buy
OpenAPI snippet URL
GET /v2/shipments/{SHIPMENT_ID}/label
Summary: Convert Shipment Label
Convert Shipment Label
OpenAPI snippet URL
PARAMETERS /v2/shipments/{SHIPMENT_ID}/label
OpenAPI snippet URL
POST /v2/shipments/{SHIPMENT_ID}/rerate
Summary: Regenerate Shipment Rates
Regenerate Shipment Rates
OpenAPI snippet URL
PARAMETERS /v2/shipments/{SHIPMENT_ID}/rerate
OpenAPI snippet URL
GET /v2/shipments/{SHIPMENT_ID}/smartrate
Summary: Retrieve SmartRates of Shipment
Retrieve SmartRates of Shipment
OpenAPI snippet URL
PARAMETERS /v2/shipments/{SHIPMENT_ID}/smartrate
OpenAPI snippet URL
POST /v2/shipments/{SHIPMENT_ID}/insure
Summary: Insure Shipment
Insure Shipment
OpenAPI snippet URL
PARAMETERS /v2/shipments/{SHIPMENT_ID}/insure
OpenAPI snippet URL
POST /v2/shipments/{SHIPMENT_ID}/refund
Summary: Refund Shipment
Refund Shipment
OpenAPI snippet URL
PARAMETERS /v2/shipments/{SHIPMENT_ID}/refund
OpenAPI snippet URL
GET /v2/shipments/{SHIPMENT_ID}/smartrate/delivery_date
Summary: Retrieve Estimated Delivery Date
Retrieve Estimated Delivery Date
OpenAPI snippet URL
PARAMETERS /v2/shipments/{SHIPMENT_ID}/smartrate/delivery_date
OpenAPI snippet URL
GET /v2/rates/{RATE_ID}
Summary: Retrieve Rate
Retrieve Rate
OpenAPI snippet URL
PARAMETERS /v2/rates/{RATE_ID}
OpenAPI snippet URL
GET /v2/trackers
Summary: Retrieve All Trackers
Retrieve All Trackers
OpenAPI snippet URL
POST /v2/trackers
Summary: Create Tracker
Create Tracker
OpenAPI snippet URL
GET /v2/trackers/{TRACKER_ID}
Summary: Retrieve Tracker
Retrieve Tracker
OpenAPI snippet URL
PARAMETERS /v2/trackers/{TRACKER_ID}
OpenAPI snippet URL
GET /v2/batches
Summary: Retrieve All Batches
Retrieve All Batches
OpenAPI snippet URL
POST /v2/batches
Summary: Create Batch
Create Batch
OpenAPI snippet URL
POST /v2/batches/{BATCH_ID}/add_shipments
Summary: Add Shipments to Batch
Add Shipments to Batch
OpenAPI snippet URL
PARAMETERS /v2/batches/{BATCH_ID}/add_shipments
OpenAPI snippet URL
POST /v2/batches/{BATCH_ID}/remove_shipments
Summary: Remove Shipments from Batch
Remove Shipments from Batch
OpenAPI snippet URL
PARAMETERS /v2/batches/{BATCH_ID}/remove_shipments
OpenAPI snippet URL
POST /v2/batches/{BATCH_ID}/buy
Summary: Buy Batch
Buy Batch
OpenAPI snippet URL
PARAMETERS /v2/batches/{BATCH_ID}/buy
OpenAPI snippet URL
POST /v2/batches/{BATCH_ID}/label
Summary: Batch Labels
Batch Labels
OpenAPI snippet URL
PARAMETERS /v2/batches/{BATCH_ID}/label
OpenAPI snippet URL
POST /v2/batches/{BATCH_ID}/scan_form
Summary: Manifest Batch
Manifest Batch
OpenAPI snippet URL
PARAMETERS /v2/batches/{BATCH_ID}/scan_form
OpenAPI snippet URL
GET /v2/batches/{BATCH_ID}
Summary: Retrieve Batch
Retrieve Batch
OpenAPI snippet URL
PARAMETERS /v2/batches/{BATCH_ID}
OpenAPI snippet URL
GET /v2/metadata/carriers
Summary: Retrieve Carrier Metadata
Retrieve Carrier Metadata
OpenAPI snippet URL
POST /v2/customs_infos
Summary: Create Customs Info
Create Customs Info
OpenAPI snippet URL
GET /v2/customs_infos/{CUSTOMS_INFO_ID}
Summary: Retrieve Customs Info
Retrieve Customs Info
OpenAPI snippet URL
PARAMETERS /v2/customs_infos/{CUSTOMS_INFO_ID}
OpenAPI snippet URL
POST /v2/customs_items
Summary: Create Customs Item
Create Customs Item
OpenAPI snippet URL
GET /v2/customs_items/{CUSTOMS_ITEM_ID}
Summary: Retrieve Customs Item
Retrieve Customs Item
OpenAPI snippet URL
PARAMETERS /v2/customs_items/{CUSTOMS_ITEM_ID}
OpenAPI snippet URL
GET /v2/events
Summary: Retrieve All Events
Retrieve All Events
OpenAPI snippet URL
GET /v2/events/{EVENT_ID}
Summary: Retrieve Event
Retrieve Event
OpenAPI snippet URL
PARAMETERS /v2/events/{EVENT_ID}
OpenAPI snippet URL
GET /v2/events/{EVENT_ID}/payloads
Summary: Retrieve All Event Payloads
Retrieve All Event Payloads
OpenAPI snippet URL
PARAMETERS /v2/events/{EVENT_ID}/payloads
OpenAPI snippet URL
GET /v2/events/{EVENT_ID}/payloads/{PAYLOAD_ID}
Summary: Retrieve Event Payload
Retrieve Event Payload
OpenAPI snippet URL
PARAMETERS /v2/events/{EVENT_ID}/payloads/{PAYLOAD_ID}
OpenAPI snippet URL
GET /v2/orders
Summary: Retrieve Order
Retrieve Order
OpenAPI snippet URL
POST /v2/orders
Summary: Create Order
Create Order
OpenAPI snippet URL
POST /v2/orders/{ORDER_ID}/buy
Summary: Buy Order
Buy Order
OpenAPI snippet URL
PARAMETERS /v2/orders/{ORDER_ID}/buy
OpenAPI snippet URL
GET /v2/pickups
Summary: Retrieve All Pickups
Retrieve All Pickups
OpenAPI snippet URL
POST /v2/pickups
Summary: Create Pickup
Create Pickup
OpenAPI snippet URL
GET /v2/pickups/{PICKUP_ID}
Summary: Retrieve Pickup
Retrieve Pickup
OpenAPI snippet URL
PARAMETERS /v2/pickups/{PICKUP_ID}
OpenAPI snippet URL
POST /v2/pickups/{PICKUP_ID}/buy
Summary: Buy Pickup
Buy Pickup
OpenAPI snippet URL
PARAMETERS /v2/pickups/{PICKUP_ID}/buy
OpenAPI snippet URL
POST /v2/pickups/{PICKUP_ID}/cancel
Summary: Cancel Pickup
Cancel Pickup
OpenAPI snippet URL
PARAMETERS /v2/pickups/{PICKUP_ID}/cancel
OpenAPI snippet URL
GET /v2/reports/{REPORT_TYPE}
Summary: Retrieve All Reports
Retrieve All Reports
OpenAPI snippet URL
POST /v2/reports/{REPORT_TYPE}
Summary: Create Report
Create Report
OpenAPI snippet URL
PARAMETERS /v2/reports/{REPORT_TYPE}
OpenAPI snippet URL
GET /v2/reports/{REPORT_ID}
Summary: Retrieve Report
Retrieve Report
OpenAPI snippet URL
PARAMETERS /v2/reports/{REPORT_ID}
OpenAPI snippet URL
GET /v2/scan_forms
Summary: Retrieve All ScanForms
Retrieve All ScanForms
OpenAPI snippet URL
POST /v2/scan_forms
Summary: Create ScanForm
Create ScanForm
OpenAPI snippet URL
GET /v2/scan_forms/{SCANFORM_ID}
Summary: Retrieve ScanForm
Retrieve ScanForm
OpenAPI snippet URL
PARAMETERS /v2/scan_forms/{SCANFORM_ID}
OpenAPI snippet URL
GET /v2/webhooks
Summary: Retrieve All Webhooks
Retrieve All Webhooks
OpenAPI snippet URL
POST /v2/webhooks
Summary: Create Webhook
Create Webhook
OpenAPI snippet URL
GET /v2/webhooks/{WEBHOOK_ID}
Summary: Retrieve Webhook
Retrieve Webhook
OpenAPI snippet URL
DELETE /v2/webhooks/{WEBHOOK_ID}
Summary: Delete Webhook
Delete Webhook
OpenAPI snippet URL
PATCH /v2/webhooks/{WEBHOOK_ID}
Summary: Update Webhook
Update Webhook
OpenAPI snippet URL
PARAMETERS /v2/webhooks/{WEBHOOK_ID}
OpenAPI snippet URL
GET /v2/end_shippers
Summary: Retrieve All EndShippers
Retrieve All EndShippers
OpenAPI snippet URL
POST /v2/end_shippers
Summary: Create EndShipper
Create EndShipper
OpenAPI snippet URL
PUT /v2/end_shippers/{ENDSHIPPER_ID}
Summary: Update EndShipper
Update EndShipper
OpenAPI snippet URL
PARAMETERS /v2/end_shippers/{ENDSHIPPER_ID}
OpenAPI snippet URL
GET /v2/end_shippers/{ENDSHIIPPER_ID}
Summary: Retrieve EndShipper
Retrieve EndShipper
OpenAPI snippet URL
PARAMETERS /v2/end_shippers/{ENDSHIIPPER_ID}
OpenAPI snippet URL
GET /v2/api_keys
Summary: Retrieve API Keys
Retrieve API Keys
OpenAPI snippet URL
GET /v2/users/{USER_ID}
Summary: Retrieve User
Retrieve User
OpenAPI snippet URL
PATCH /v2/users/{USER_ID}
Summary: Update Child User
Update Child User
OpenAPI snippet URL
PARAMETERS /v2/users/{USER_ID}
OpenAPI snippet URL
GET /v2/users
Summary: Retrieve Authenticated User
Retrieve Authenticated User
OpenAPI snippet URL
POST /v2/users
Summary: Create Child User
Create Child User
OpenAPI snippet URL
PATCH /v2/users
Summary: Update Authenticated User
Update Authenticated User
OpenAPI snippet URL
DELETE /v2/users/{CHILD_USER_ID}
Summary: Delete Child User
Delete Child User
OpenAPI snippet URL
PARAMETERS /v2/users/{CHILD_USER_ID}
OpenAPI snippet URL
PATCH /v2/users/{USER_ID}/brand
Summary: Update Brand
Update Brand
OpenAPI snippet URL
PARAMETERS /v2/users/{USER_ID}/brand
OpenAPI snippet URL
POST /v2/credit_cards/{CREDIT_CARD_ID}/charges
Summary: Fund Wallet via Credit Card
Fund Wallet via Credit Card
OpenAPI snippet URL
PARAMETERS /v2/credit_cards/{CREDIT_CARD_ID}/charges
OpenAPI snippet URL
POST /v2/bank_accounts/{BANK_ACCOUNT_ID}/charges
Summary: Fund Wallet via Bank Account
Fund Wallet via Bank Account
OpenAPI snippet URL
PARAMETERS /v2/bank_accounts/{BANK_ACCOUNT_ID}/charges
OpenAPI snippet URL
GET /v2/payment_methods
Summary: Retrieve Payment Methods
Retrieve Payment Methods
OpenAPI snippet URL
DELETE /v2/credit_cards/{CREDIT_CARD_ID}
Summary: Delete Credit Card
Delete Credit Card
OpenAPI snippet URL
PARAMETERS /v2/credit_cards/{CREDIT_CARD_ID}
OpenAPI snippet URL
DELETE /v2/bank_accounts/{BANK_ACCOUNT_ID}
Summary: Delete Bank Account
Delete Bank Account
OpenAPI snippet URL
PARAMETERS /v2/bank_accounts/{BANK_ACCOUNT_ID}
OpenAPI snippet URL
GET /v2/carrier_types
Summary: Retrieve Carrier Types
Retrieve Carrier Types
OpenAPI snippet URL
GET /v2/carrier_accounts
Summary: Retrieve All Carrier Accounts
Retrieve All Carrier Accounts
OpenAPI snippet URL
POST /v2/carrier_accounts
Summary: Create Carrier Account
Create Carrier Account
OpenAPI snippet URL
GET /v2/carrier_accounts/{CARRIER_ACCOUNT_ID}
Summary: Retrieve Carrier Account
Retrieve Carrier Account
OpenAPI snippet URL
DELETE /v2/carrier_accounts/{CARRIER_ACCOUNT_ID}
Summary: Delete Carrier Account
Delete Carrier Account
OpenAPI snippet URL
PATCH /v2/carrier_accounts/{CARRIER_ACCOUNT_ID}
Summary: Update Carrier Account
Update Carrier Account
OpenAPI snippet URL
PARAMETERS /v2/carrier_accounts/{CARRIER_ACCOUNT_ID}
OpenAPI snippet URL
GET /v2/referral_customers
Summary: Retrieve Referral Users
Retrieve Referral Users
OpenAPI snippet URL
POST /v2/referral_customers
Summary: Create Referral User
Create Referral User
OpenAPI snippet URL
PUT /v2/referral_customers/{REFERRAL_USER_ID}
Summary: Update Referral User Email
Update Referral User Email
OpenAPI snippet URL
PARAMETERS /v2/referral_customers/{REFERRAL_USER_ID}
OpenAPI snippet URL
GET /v2/partners/stripe_public_key
Summary: Step 1a: Retrieve EasyPost’s Public Stripe API Key
Step 1a: Retrieve EasyPost’s Public Stripe API Key
OpenAPI snippet URL
POST /v1/tokens
Summary: Step 1b: Get Token from Stripe
You can visit the stripe collection for this step:
OpenAPI snippet URL
POST /v2/credit_cards
Summary: Step 1c: Create Credit Card
Step 1c: Create Credit Card
OpenAPI snippet URL