# Shipping API For Ecommerce Developers | Easyship Documentation > Made for ecommerce developers, use our shipping API to connect to Easyship to accommodate your shipping needs and grow your business. ## Docs: Getting started - [Sandbox](https://developers.easyship.com/docs/sandbox.md): The sandbox environment allows you to test all of the APIs. The data, rates and labels are for illustrative purposes only. ## Docs: MCP - [Easyship - Shipping MCP](https://developers.easyship.com/docs/easyship-mcp-server.md) ## Docs: How-to guides - [Overview Flow Guide](https://developers.easyship.com/docs/overview-flow-guide.md) - [How to Automate your Shipments](https://developers.easyship.com/docs/how-to-automate-your-shipments.md) - [How to Display Rates at Checkout](https://developers.easyship.com/docs/how-to-display-rates-at-checkout.md) - [HS Codes, Address Validation and T&Ds Features](https://developers.easyship.com/docs/hs-codes-address-validation-and-tds-features.md) - [How to Create a Return Shipment](https://developers.easyship.com/docs/how-to-create-a-return-shipment.md) - [Address Validation Consolidation: Migration Guide](https://developers.easyship.com/docs/address-validation-consolidation-migration-guide.md) - [How to Use QR Code Labels](https://developers.easyship.com/docs/how-to-use-qr-code-labels.md) - [How to get Shipping Rates](https://developers.easyship.com/docs/how-to-get-shipping-rates.md) - [How to Validate Addresses](https://developers.easyship.com/docs/how-to-validate-addresses.md) - [How to Calculate Taxes and Duties](https://developers.easyship.com/docs/how-to-calculate-taxes-and-duties.md) - [How to Track a Shipment](https://developers.easyship.com/docs/how-to-track-a-shipment.md) ## Docs: How-To Guides for partners - [How to connect Easyship users to your platform](https://developers.easyship.com/docs/how-to-authorize-easyship-user.md): This guide is for platforms as partner apps on Easyship to connect existing Easyship users or new signed up users. ## API Reference: API - [Overview](https://developers.easyship.com/reference/introduction.md) - [Changelog](https://developers.easyship.com/reference/changelog.md) - [Migrate from v2023 to v2024](https://developers.easyship.com/reference/migrate-from-v2023-to-v2024.md) - [Migrate from v1 to v2024](https://developers.easyship.com/reference/migrate-from-v1-to-v2024.md): This guide highlights changes required for migrating APIs from v1 (legacy version) to v2024-09 (latest version) - [Errors](https://developers.easyship.com/reference/errors.md) - [Scopes](https://developers.easyship.com/reference/scopes.md) - [Rate Limit](https://developers.easyship.com/reference/rate-limit.md) - [Register an App](https://developers.easyship.com/reference/register-an-app.md) ## API Reference: Easyship Public API - Account - [Information about the Account](https://developers.easyship.com/reference/account_show.md): Retrieve information about current account Properties below would display only when the access token includes the corresponding scopes. | Property | Required API Scope | | -------- |… - Assets - [Create an Asset](https://developers.easyship.com/reference/assets_create.md): Create an asset. > You can store up to five assets for each type. > Allowed file types: png or jpeg. Required authorization scope: `public.asset:write` - [Activate Assets](https://developers.easyship.com/reference/asset_activate_create.md): Activate specific uploaded asset and define other assets of the same type as inactive. Required authorization scope: `public.asset:write` - [Deactivate Assets](https://developers.easyship.com/reference/asset_deactivate_create.md): Deactivate specific uploaded asset. Required authorization scope: `public.asset:write` - [List all Assets](https://developers.easyship.com/reference/assets_index.md): Retrieve a list of assets. Required authorization scope: `public.asset:read` - [Update an Asset](https://developers.easyship.com/reference/assets_update.md): Update an asset. Required authorization scope: `public.asset:write` - [Delete an Asset](https://developers.easyship.com/reference/assets_delete.md): Delete an asset. Required authorization scope: `public.asset:write` - App Access - [Create an App Access](https://developers.easyship.com/reference/app_access_create.md): Create a temporary app access redirect token Required authorization scope: `public.app_access:write` - Settings - [List Account Settings](https://developers.easyship.com/reference/settings_index.md): Retrieve account settings. Required authorization scope: `public.setting:read` - [Update Multiple Account Settings](https://developers.easyship.com/reference/settings_update.md): Update multiple account settings. Required authorization scope: `public.setting:write` - Redirects - [Create a Redirect](https://developers.easyship.com/reference/redirects_create.md): Create a redirect to the Easyship Dashboard. Required authorization scope: `public.redirect:write` - Addresses - [Create an Address](https://developers.easyship.com/reference/addresses_create.md): Create a new address. Required authorization scope: `public.address:write` - [List all Addresses](https://developers.easyship.com/reference/addresses_index.md): Retrieve a list of all addresses ordered by date of creation. Required authorization scope: `public.address:read` - [Update an Address](https://developers.easyship.com/reference/addresses_update.md): Update an address in your account. Required authorization scope: `public.address:write` - [Activate an Address](https://developers.easyship.com/reference/address_activate_create.md): Activate specific address Required authorization scope: `public.address:write` - [Deactivate an Address](https://developers.easyship.com/reference/address_deactivate_create.md): Deactivate specific address. If the address is default for the company, the first active address will be set as default. Required authorization scope: `public.address:write` - [Validate a single US address (Deprecated)](https://developers.easyship.com/reference/addresses_validation_domestic.md): > ⚠️ **Address Validation is moving to a single endpoint.** We've combined Domestic and International Address Validation into one Address Validation endpoint. If your connection uses the Domestic… - [Validate a single address](https://developers.easyship.com/reference/addresses_validation.md): Create an address validation. Supports both US and non-US addresses. Pass `country_alpha2: "US"` for US addresses — these are billed at the US Address Validation rate. All other countries are billed… - Analytics - [List Analytics Sale Channels Data](https://developers.easyship.com/reference/analytics_sale_channels_index.md): Retrieve sales analytics. Required authorization scope: `public.analytics:read` - [List Analytics Shipment Status Data](https://developers.easyship.com/reference/analytics_shipment_status_index.md): Retrieve shipment status. Possible statuses: - Label Pending - Label Rejected - Label Ready - Pickup/Drop-off in Progress - In Transit to Customer - Failed Delivery Attempt - Exception Required… - [List Shipment Analytics within a Date Range](https://developers.easyship.com/reference/analytics_shipment_shipped_index.md): Retrieve data on whether the company has made any shipments within specified period. Required authorization scope: `public.analytics:read` - [List Analytics Shipments Data](https://developers.easyship.com/reference/analytics_shipments_index.md): Retrieve analytics shipments data. Required authorization scope: `public.analytics:read` - [List Analytics Top Couriers Data](https://developers.easyship.com/reference/analytics_top_couriers_index.md): Retrieve analytics top couriers data. Required authorization scope: `public.analytics:read` - [List Analytics Top Shipments Destinations](https://developers.easyship.com/reference/analytics_top_shipments_destinations_index.md): Retrieve a company top shipments destinations country. Required authorization scope: `public.analytics:read` - Auto Recharge - [Update Auto Recharge Credit Settings](https://developers.easyship.com/reference/credit_auto_recharge_update.md): Update the settings for auto recharging your credit when your account balance falls below the threshold specified through this endpoint. This endpoint is in beta (subject to change). Please get in… - [Get Auto Recharge Credit Settings](https://developers.easyship.com/reference/credit_auto_recharge_show.md): Show the auto recharge settings for the company. Required authorization scope: `public.payment:read` - Batches - [Create a Batch of Shipments](https://developers.easyship.com/reference/batch_shipments_create.md): Create a batch of shipments and schedule it for processing. Required authorization scopes: `public.batch:write`, `public.shipment:write` and `public.label:write` if a label(s) will be created during… - [Create a Batch of Addresses](https://developers.easyship.com/reference/batch_addresses_create.md): Create a batch of addresses. Required authorization scopes: `public.batch:write`, `public.address:write` - [Create a Batch of Labels](https://developers.easyship.com/reference/batch_labels_create.md): Create a batch of labels. Required authorization scopes: `public.batch:write`, `public.label:write` Labels confirm a shipment created with the Shipment API. Calling **Batch Labels** will confirm… - [List all Batches](https://developers.easyship.com/reference/batches_index.md): Retrieve a list of all batches ordered by date of creation. Required authorization scope: `public.batch:read` - [Get a Batch](https://developers.easyship.com/reference/batches_show.md): Retrieve a batch by its ID. Required authorization scope: `public.batch:read` - [List all Batch Items](https://developers.easyship.com/reference/batch_items_index.md): Retrieve a list of all batches ordered by date of creation. Required authorization scope: `public.batch:read` - Billing Documents - [Download Billing Document](https://developers.easyship.com/reference/billing_documents_download.md): Download the Billing Document in PDF format. Required authorization scope: `public.billing_document:read` - [List all Billing Documents](https://developers.easyship.com/reference/billing_documents_index.md): Retrieve a list of all billing documents within range. Pagination of this endpoint is not indexed. `count` on the response body will always be `null`. Required authorization scope:… - [List all Billing Document's Transaction Records](https://developers.easyship.com/reference/billing_documents_transactions_index.md): Retrieve a list of all billing document's transactions. Pagination of this endpoint is not indexed. `count` on the response body will always be `null`. Required authorization scope:… - Boxes - [Create a Box](https://developers.easyship.com/reference/boxes_create.md): Create a box. Required authorization scope: `public.box:write` - [List all Boxes](https://developers.easyship.com/reference/boxes_index.md): Retrieve a list of available courier boxes and your custom boxes. Required authorization scope: `public.box:read` This request returns box types specified with a `slug` when creating a shipment via… - [Update a Box](https://developers.easyship.com/reference/boxes_update.md): Update a box in your account. Required authorization scope: `public.box:write` - [Delete a Box](https://developers.easyship.com/reference/boxes_delete.md): Delete a box from your account. Required authorization scope: `public.box:write` - Countries - [List all Countries](https://developers.easyship.com/reference/countries_index.md): Retrieve a list of countries. Required authorization scope: `public.reference:read` Available filtering parameters: by Alpha-2 country code or continent. - Couriers - [List all Courier Services of a Courier](https://developers.easyship.com/reference/courier_courier_services_index.md): Retrieve a list of courier services for selected courier. Required authorization scope: `public.courier_service:read` - [List all LYOC](https://developers.easyship.com/reference/courier_lyoc_index.md): LYOC (Link Your Own Courier) allows merchants to connect their existing courier accounts — such as DHL, UPS, FedEx, or Royal Mail — to Easyship, enabling shipments to be rated and labeled using their… - [List all Couriers](https://developers.easyship.com/reference/couriers_index.md): Retrieve a list of active couriers. Required authorization scope: `public.courier:read` - [Create a Courier](https://developers.easyship.com/reference/couriers_create.md): Creates a new courier. - `201` status when created successfully. - `202` status when created but requiring additional verification. Required authorization scope: `public.courier:write` - [Get a Courier](https://developers.easyship.com/reference/couriers_show.md): Retrieve details of a couriers. Required authorization scope: `public.courier:read` - [Update a Courier](https://developers.easyship.com/reference/couriers_update.md): Updates a courier. Required authorization scope: `public.courier:write` - [Delete a Courier](https://developers.easyship.com/reference/couriers_delete.md): Delete a LYOC courier. Required authorization scope: `public.courier:write` - Courier Services - [List all Estimated Delivery Dates for a Courier Service](https://developers.easyship.com/reference/courier_service_estimated_delivery_dates_index.md): Retrieve a list of estimated delivery dates for a specific courier service. Required authorization scope: `public.courier_service:read` Easyship builds estimation model based on shipments delivered… - [List Available Pickup Slots](https://developers.easyship.com/reference/courier_services_pickup_slots_index.md): Retrieve a list of pickup slots in local time for the coming seven days. Required authorization scope: `public.pickup:read` - [List all Courier Services](https://developers.easyship.com/reference/courier_services_index.md): Retrieve a list of active courier services available with your account. Required authorization scope: `public.courier_service:read` - Credit - [Confirm Credit Top-up](https://developers.easyship.com/reference/credit_confrim_3ds_create.md): Easyship integrate with Stripe Payment Intent to collect credit card payments. Ref: https://stripe.com/docs/payments/payment-intents The confirmation process includes the collection of payment and… - [Refund a Credit](https://developers.easyship.com/reference/credit_refund_create.md): Refund your credit. Required authorization scope: `public.payment:write` - [Get credit](https://developers.easyship.com/reference/credits_show.md): Retrieve your credit balance. Required authorization scope: `public.credit:read` - [Add credit](https://developers.easyship.com/reference/credits_create.md): Top up your credit. In case your payment source (credit card) requires 3D validation use the Stripe SDK. To detect any fraudulent activities and initiate Radar and 3D Secure, integrate… - eFulfillment - [Tracking Updates](https://developers.easyship.com/reference/efulfillment_tracking_update.md): Update the shipment tracking number and create tracking events. Required authorization scopes: `public.shipment:write`, `public.efulfillment:write` > This endpoint is only available to eFulfillment… - [Warehouse State Updates](https://developers.easyship.com/reference/efulfillment_warehouse_state_update.md): Update the warehouse state of one or multiple shipments. Required authorization scope: `public.shipment:write`, `public.efulfillment:write` > This endpoint is only available to eFulfillment clients… - HS codes - [List HS Codes](https://developers.easyship.com/reference/hs_code_index.md): Retrieve a list of HS codes. Required authorization scope: `public.hs_code:read` **Rate limit**: This endpoint is rate-limited by 100 requests per second, 1,000 requests per minute, 1,000 requests… - Item Categories - [List all Item Categories](https://developers.easyship.com/reference/item_categories_index.md): Retrieve a list of item categories. Required authorization scope: `public.reference:read` - Locations - [List FedEx Locations](https://developers.easyship.com/reference/locations_fedex_index.md): Retrieve FedEx locations. This endpoint routes requests to the FedEx Location API. For further information, kindly look into the FedEx API documentation available at… - [List UPS Locations](https://developers.easyship.com/reference/locations_ups_index.md): Retrieve UPS locations. This endpoint routes requests to the UPS locator API. For further information, kindly look into the UPS API documentation available at… - [List USPS Locations](https://developers.easyship.com/reference/locations_usps_index.md): Retrieve USPS locations. This endpoint routes requests to the USPS Locations API. For further information, kindly look into the UPS API documentation available at… - [List Canada Post Locations](https://developers.easyship.com/reference/locations_canada_post_index.md): Retrieve Canada Post locations. This endpoint routes requests to the Canada Post `Get Nearest Post Office` API. For further information, kindly look into the Canada Post API documentation available… - Manifests - [Create a Manifest](https://developers.easyship.com/reference/manifests_create.md): Create a [manifest](https://support.easyship.com/hc/en-us/articles/4414489808525-What-Is-a-Manifest-in-Shipping). Required authorization scope: `public.manifest:write` - [List all Manifests](https://developers.easyship.com/reference/manifests_index.md): Retrieve a list of [manifests](https://support.easyship.com/hc/en-us/articles/4414489808525-What-Is-a-Manifest-in-Shipping). Required authorization scope: `public.manifest:read` - [Get a Manifest](https://developers.easyship.com/reference/manifests_show.md): Retrieve details of a specific manifest. Required authorization scope: `public.manifest:read` - Payment Sources - [Create a Payment Source](https://developers.easyship.com/reference/payment_sources_create.md): Create a payment sources. Easyship won't hold the details of your credit card. We use `stripe token` to attach the credit card to your easyship account on Stripe. Please upload your credit card to… - [List all Payment Sources](https://developers.easyship.com/reference/payment_sources_index.md): Retrieve a list of payment sources. Required authorization scope: `public.payment_source:read` - [Get a Stripe Public Key](https://developers.easyship.com/reference/stripes_show.md): Retrieve a stripe public key according to your registration country. Required authorization scope: `public.payment_sources:read` - [Confirm Payment Source](https://developers.easyship.com/reference/payment_sources_confrim_3ds_create.md): Easyship integrate with Stripe Setup Intent to collect credit card and bank account information. Ref: https://docs.stripe.com/payments/save-and-reuse-cards-only Here's a example of how you can… - [Update a Payment Source](https://developers.easyship.com/reference/payment_sources_update.md): Update a card payment source. Required authorization scope: `public.payment_source:write` - [Delete a Payment Source](https://developers.easyship.com/reference/payment_sources_delete.md): Delete a card Payment Source Required authorization scope: `public.payment_source:write` - Pickups - [Create a Pickup](https://developers.easyship.com/reference/pickups_create.md): Schedule a pickup. Required authorization scope: `public.pickup:write` > Only available if your courier provides pickup options. ## Select a pickup time After retrieving a courier's pickup slots,… - [List all Pickups](https://developers.easyship.com/reference/pickups_index.md): Retrieve a list of pickups. Required authorization scope: `public.pickup:read` - [Get a Pickup](https://developers.easyship.com/reference/pickups_show.md): Retrieve details of a specific pickup. Required authorization scope: `public.pickup:write` - [List All Shipments of Specific Pickup](https://developers.easyship.com/reference/pickups_shipments_index.md): Retrieve a list of pickup's shipments. Required authorization scope: `public.shipment:read` - [Cancel a Pickup](https://developers.easyship.com/reference/pickups_cancel.md): Cancel a pickup. Required authorization scope: `public.pickup:write` - Products - [Create a Product](https://developers.easyship.com/reference/products_create.md): Create a single product in your account. Required authorization scope: `public.product:write` - [List all Products](https://developers.easyship.com/reference/products_index.md): Retrieve a list of products available with your account. Required authorization scope: `public.product:read` - [Update a Product](https://developers.easyship.com/reference/products_update.md): Update a single product in your account. Required authorization scope: `public.product:write` - [Delete a Product](https://developers.easyship.com/reference/products_delete.md): Delete a single product from your account. Required authorization scope: `public.product:write` - Rates - [Request Rates](https://developers.easyship.com/reference/rates_request.md): Request a list of shipping quotes for a prospective shipment. Required authorization scope: `public.rate:read` > Compare couriers to see the cheapest, fastest and best value for money, or a… - Shipping Rule's Actions - [Create Action for a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_action_create.md): Create action for a shipping rule. Required authorization scope: `public.shipping_rule:write` - [List all Actions for a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_action_index.md): List actions for a shipping rule. Required authorization scope: `public.shipping_rule:read` - [Update Action of a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_action_update.md): Update shipping rule action. Required authorization scope: `public.shipping_rule:write` - [Delete Action of a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_action_delete.md): Delete shipping rule action. Required authorization scope: `public.shipping_rule:write` - Shipping Rule's Conditions - [Create Condition for a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_condition_create.md): Create condition for a shipping rule. Required authorization scope: `public.shipping_rule:write` - [List all Conditions for a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_condition_index.md): List conditions of a shipping rule. Required authorization scope: `public.shipping_rule:read` - [Update Condition of the Shipping Rule](https://developers.easyship.com/reference/shipping_rule_condition_update.md): Update shipping rule condition. Required authorization scope: `public.shipping_rule:write` - [Delete Condition of a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_condition_delete.md): Delete shipping rule condition. Required authorization scope: `public.shipping_rule:write` - Shipping Rules - [Create a Shipping Rule](https://developers.easyship.com/reference/shipping_rules_create.md): Create a shipping rule. Required authorization scope: `public.shipping_rule:write` - [Activate a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_activate.md): Activate specific shipping rule. Required authorization scope: `public.shipping_rule:write` - [Deactivate a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_deactivate.md): Deactivate specific shipping rule. Required authorization scope: `public.shipping_rule:write` - [List all Shipping Rules](https://developers.easyship.com/reference/shipping_rules_index.md): Retrieve a list of shipping rules. Required authorization scope: `public.shipping_rule:read` - [Get a Shipping Rule](https://developers.easyship.com/reference/shipping_rules_show.md): Retrieve a shipping rule. Required authorization scope: `public.shipping_rule:read` - [Update a Shipping Rule](https://developers.easyship.com/reference/shipping_rules_update.md): Update a shipping rule. Required authorization scope: `public.shipping_rule:write` - [Delete a Shipping Rule](https://developers.easyship.com/reference/shipping_rules_delete.md): Delete a shipping rule. Required authorization scope: `public.shipping_rule:write` - [List all Platform Names](https://developers.easyship.com/reference/shipping_rule_platforms_index.md): Retrieve a list of available platform names for shipping rules. Required authorization scope: `public.shipping_rule:write` - Shipments - [Create a Shipment](https://developers.easyship.com/reference/shipments_create.md): Create a new shipment. Required authorization scope: `public.shipment:write` and `public.label:write` if a label is requested during the request. ## Select a courier If you use our Rates API, you… - [List all Shipments](https://developers.easyship.com/reference/shipments_index.md): Retrieve a list of shipments. Required authorization scope: `public.shipment:read` - [Get a Shipment](https://developers.easyship.com/reference/shipments_show.md): Retrieve details of a specific shipment. Required authorization scope: `public.shipment:read` > All shipment documents are customisable. You can set: > > - Document format: URL, PDF or PNG > -… - [Update a Shipment](https://developers.easyship.com/reference/shipments_update.md): Update shipment details. Required authorization scope: `public.shipment:write` and `public.label:write` if a label is requested during the request. - [Cancel a Shipment](https://developers.easyship.com/reference/shipments_cancel.md): Cancel a shipment after a label has been requested, as long as the shipment is not yet in transit. Required authorization scope: `public.shipment:write` > **Cancel vs Delete:** Use **Delete** to… - [Delete a Shipment](https://developers.easyship.com/reference/shipments_delete.md): Delete a shipment before a label has been requested (`label_state: not_created`). Required authorization scope: `public.shipment:write` > **Cancel vs Delete:** Use **Delete** to remove a shipment… - [Create Label](https://developers.easyship.com/reference/shipment_labels_create.md): Create a label for an existing shipment and retrieve it synchronously. Required authorization scope: `public.label:write` This API **finalizes** a shipment created via the Shipment API. Executing… - [List All Documents](https://developers.easyship.com/reference/shipments_documents_index.md): Retrieve shipping documents of specific shipment. Required authorization scope: `public.shipment_document:read` - [Buy Insurance for a Shipment](https://developers.easyship.com/reference/shipments_insure_create.md): Buy insurance for a shipment with a generated label. If the shipment label hasn't been generated yet, you can update the insurance settings through the [shipment… - [Create a Return Shipment](https://developers.easyship.com/reference/return_shipments_create.md): Create a new return shipment from an existing shipment. Required authorization scope: `public.shipment:write` - [List all Trackings](https://developers.easyship.com/reference/shipments_trackings_index.md): Retrieve the most recent status for a shipment and a history of all previous checkpoints. Required authorization scope: `public.track:read` - [List Transaction Records for a Shipment](https://developers.easyship.com/reference/shipments_transaction_records_index.md): List transaction records for a shipment. Required authorization scope: `public.transaction_record:read` - [List Unavailable Couriers for a Shipment](https://developers.easyship.com/reference/shipment_unavailable_couriers_index.md): List unavailable couriers for a shipment. Required authorization scopes: `public.shipment:read`, `public.rate:read` - States - [List all States](https://developers.easyship.com/reference/states_index.md): Retrieve a list of states. Required authorization scope: `public.reference:read` This endpoint in only used for the United States, Canada, Australia and Mexico. - Stores - [List all Stores](https://developers.easyship.com/reference/stores_index.md): Retrieve a list of stores available with your account. Required authorization scope: `public.store:read` - Tags - [List all Tags](https://developers.easyship.com/reference/tags_index.md): Retrieve a list of tags. Required authorization scope: `public.tag:read` > You can filter your tags by keywords. - [Create a Tag](https://developers.easyship.com/reference/tags_create.md): Create a new tag. Required authorization scope: `public.tag:write` - Taxes and Duties - [Calculate Tax and Duty](https://developers.easyship.com/reference/taxes_and_duties_calculate.md): Retrieve tax and duty costs information. Use either of the two schemas `WITH COUNTRY IDS` OR `WITH COUNTRY ALPHA2` to provide country specific details. Required authorization scope:… - Trackings (non-Easyship shipments) - [Create a Tracking](https://developers.easyship.com/reference/trackings_create.md): Create a single tracking in your account. Required authorization scope: `public.track_3p:write` > **Note:** This endpoint requires an **advanced scope**. You can enable advanced scopes when… - [List all Trackings](https://developers.easyship.com/reference/trackings_index.md): Retrieve a list of trackings available with your account. Required authorization scope: `public.track_3p:read` > **Note:** This endpoint requires an **advanced scope**. You can enable advanced… - [Get a Tracking](https://developers.easyship.com/reference/trackings_show.md): Show a single tracking in your account. Required authorization scope: `public.track_3p:read` > **Note:** This endpoint requires an **advanced scope**. You can enable advanced scopes when creating… - [Update a tracking](https://developers.easyship.com/reference/sandbox_trackings_update.md): Update a tracking (Sandbox only) This endpoint is intended for testing tracking status updates and is exclusively available in the Sandbox environment. Required authorization scope:… - [Delete a Tracking](https://developers.easyship.com/reference/trackings_delete.md): Delete a single tracking from your account. Required authorization scope: `public.track_3p:write` > **Note:** This endpoint requires an **advanced scope**. You can enable advanced scopes when… - [List of Supported Couriers](https://developers.easyship.com/reference/trackings_list_supported_couriers.md): List supported couriers. Required authorization scope: `public.track_3p:read` > **Note:** Calls to this endpoint count towards your API usage allowance. You can monitor your current usage in the… - [List of Supported Couriers](https://developers.easyship.com/reference/trackings_external_courier_services_index.md): List courier services that do not support label generation but are trackable. Required authorization scope: `public.track_3p:read` > **Note:** Calls to this endpoint count towards your API usage… - Transaction Records - [List all Transaction Records](https://developers.easyship.com/reference/transactions_index.md): Retrieve a list of all transactions within range. Pagination of this endpoint is not indexed. `count` on the response body will always be `null`. Required authorization scope:… - Insurance - [Create an Insurance Quote](https://developers.easyship.com/reference/insurances_quotes_create.md): > **API version**: Available from `2024-09` and above. Create an insurance quote for products to be shipped. Returns a quote with fee calculations per product and an overall total. The quote is… - [Create an Insurance Policy from Quote](https://developers.easyship.com/reference/insurances_policies_from_quote_create.md): > **API version**: Available from `2024-09` and above. Create an insurance policy from an existing quote. The quote must be active and not expired. Easyship relies on the tracking number and… - [List all Insurance Policies](https://developers.easyship.com/reference/insurances_policies_index.md): Retrieve a list of insurance policies. Required authorization scope: `public.insurance_policy:read` - [Cancel an Insurance Policy](https://developers.easyship.com/reference/insurances_policies_cancel.md): Cancel an insurance policy. Only policies in `awaiting` state can be cancelled. This only cancels `external_label` policies (created via `POST /insurances/policies-from-quote`). Passing the… ## API Reference: Webhooks - [Webhooks Guide](https://developers.easyship.com/reference/webhooks-guide.md) - [Webhook Events](https://developers.easyship.com/reference/webhook_events.md): Easyship provides webhook events to notify you proactively. - [shipment.label.created](https://developers.easyship.com/reference/shipmentlabelcreated.md) - [shipment.label.failed](https://developers.easyship.com/reference/shipmentlabelfailed.md) - [shipment.tracking.checkpointscreated](https://developers.easyship.com/reference/shipmenttrackingcheckpointscreated.md) - [shipment.tracking.statuschanged](https://developers.easyship.com/reference/shipmenttrackingstatuschanged.md) - [shipment.cancelled](https://developers.easyship.com/reference/shipmentcancelled.md) - [shipment.warehouse.stateupdated](https://developers.easyship.com/reference/shipmentwarehousestateupdated.md) - [batch.started](https://developers.easyship.com/reference/batchstarted.md) - [batch.finished](https://developers.easyship.com/reference/batchfinished.md) - [batch.item.finished](https://developers.easyship.com/reference/batchitemfinished.md) - [credit.balance.low](https://developers.easyship.com/reference/creditbalancelow.md) - [enterprise.company.creation](https://developers.easyship.com/reference/enterprisecompanycreation.md) - [external.shipment.insured](https://developers.easyship.com/reference/externalshipmentinsured.md) - [courier.state.changed](https://developers.easyship.com/reference/courierstatechanged.md) - [oauth.authorization.revoked](https://developers.easyship.com/reference/oauthauthorizationrevoked.md) - Webhooks - [Create a Webhook](https://developers.easyship.com/reference/webhooks_create.md): Create a single webhook in your account. Required authorization scope: `public.webhook:write` - [Activate a Webhook](https://developers.easyship.com/reference/webhooks_activate.md): Activates a single webhook for your account. Required authorization scope: `public.Webhook` - [Deactivate a Webhook](https://developers.easyship.com/reference/webhooks_deactivate.md): Deactivates a single webhook for your account. Required authorization scope: `public.Webhook` - [Test a Webhook](https://developers.easyship.com/reference/webhooks_test.md): Test a single webhook in your account. Required authorization scope: `public.Webhook` - [List all Webhooks](https://developers.easyship.com/reference/webhooks_index.md): Retrieve a list of webhooks available within your account. Required authorization scope: `public.webhook:read` - [Get a Webhook](https://developers.easyship.com/reference/webhooks_show.md): Show a single webhook in your account. Required authorization scope: `public.webhook:read` - [Update a Webhook](https://developers.easyship.com/reference/webhooks_update.md): Update a single webhook in your account. Required authorization scope: `public.webhook:write` - [Delete a Webhook](https://developers.easyship.com/reference/webhooks_delete.md): Delete a single webhook from your account. Required authorization scope: `public.webhook:write` ## API Reference: Easyship Partner App Authentication - Authorization - [Authorize user on Easyship](https://developers.easyship.com/reference/oauth2_authorize.md): Redirect a user for authentication on Easyship. The endpoint is part of [OAuth 2.0 Authorization Code](https://developers.easyship.com/docs/how-to-authorize-easyship-user) flow. > 🚧 Warning > >… - [Create an Access Token](https://developers.easyship.com/reference/oauth2_token-1.md): Retrieve an OAuth 2 Access Token. The endpoint is part of [OAuth 2.0 Authorization Code](https://developers.easyship.com/docs/how-to-authorize-easyship-user) flow. Refresh tokens are for one-time… - [Retrieve info for the Access Token](https://developers.easyship.com/reference/oauth2_token_info-1.md): Retrieve an OAuth 2 Access Token information. - [Introspect an Access Token](https://developers.easyship.com/reference/oauth2_token_introspect-1.md): Introspect an OAuth 2 Access Token using another Access Token. - [Revoke an Access Token](https://developers.easyship.com/reference/oauth2_token_revoke-1.md): Revoke an OAuth 2 Access Token using your Client Credentials. ## API Reference: Easyship Hyper Structure API - Authorization - [Retrieve an Access Token](https://developers.easyship.com/reference/oauth2_token.md): Retrieve an OAuth 2 Access Token. There are two ways of accessing the child companies: 1. **Client Credentials Grant** with a `enterprise.child_company::access` scope and a custom header… - [Retrieve info for the Access Token](https://developers.easyship.com/reference/oauth2_token_info.md): Retrieve an OAuth 2 Access Token information. - [Introspect an Access Token](https://developers.easyship.com/reference/oauth2_token_introspect.md): Introspect an OAuth 2 Access Token using another Access Token. - [Revoke an Access Token](https://developers.easyship.com/reference/oauth2_token_revoke.md): Revoke an OAuth 2 Access Token using your Client Credentials. - Organizations - [List all Companies of the Organization](https://developers.easyship.com/reference/organization_companies_index.md): Retrieve a list of companies from a specific organization. Required authorization scope: `enterprise.company:read` - [List all Organizations](https://developers.easyship.com/reference/organizations_index.md): Retrieve a list of organizations (groups of child companies) that are a part of your group. Required authorization scope: `enterprise.organization:read` - Companies - [Create a Company](https://developers.easyship.com/reference/companies_create.md): Create a new company in specific organization. Required authorization scope: `enterprise.company:write` - [List all Companies](https://developers.easyship.com/reference/companies_index.md): List all companies which belong to organisation. Required authorization scope: `enterprise.company:read` - [Update a Company](https://developers.easyship.com/reference/companies_update.md): Update a company. Required authorization scope: `enterprise.company:write` - [Delete a Company](https://developers.easyship.com/reference/companies_delete.md): Delete a company. Required authorization scope: `enterprise.company:write` - [Create a Company Onboarding](https://developers.easyship.com/reference/company_onboardings_create.md): Create a Company Onboarding. Required authorization scope: `enterprise.company:write` - [Get a Company Onboarding](https://developers.easyship.com/reference/company_onboardings_show.md): Retrieve a Company Onboarding. Required authorization scope: `enterprise.company:read` - [Downgrade a Subscription](https://developers.easyship.com/reference/downgrade_subscription_create.md): Switch a specific child company to the free-tier subscription plan. The free-tier plan takes effect upon expiration of the current plan period. Required authorization scope:… - Webhooks - [Create a Webhook](https://developers.easyship.com/reference/organizations_webhooks_create.md): Create a single webhook for specific organization. Required authorization scope: `enterprise.webhook:write` - [Activate a Webhook](https://developers.easyship.com/reference/organizations_webhooks_activate.md): Activates a single webhook for your organization. Required authorization scope: `enterprise.webhook:write` - [Deactivate a Webhook](https://developers.easyship.com/reference/organizations_webhooks_deactivate.md): Deactivates a single webhook for your organization. Required authorization scope: `enterprise.webhook:write` - [Test a Webhook](https://developers.easyship.com/reference/organizations_webhooks_test.md): Test a single webhook in the organization. (The company ID of the organization owner will be included in the `X-EASYSHIP-COMPANY-ID` header.) Required authorization scope: `enterprise.webhook:write` - [List all Webhooks](https://developers.easyship.com/reference/organizations_webhooks_index.md): List all webhooks which belong to specific organisation. Required authorization scope: `enterprise.webhook:read` - [Get a Webhook](https://developers.easyship.com/reference/organizations_webhooks_show.md): Retrieve details of a specific webhook in the organization. Required authorization scope: `enterprise.webhook:read` - [Update a Webhook](https://developers.easyship.com/reference/organizations_webhooks_update.md): Update a single webhook in the organization. Required authorization scope: `enterprise.webhook:write` - [Delete a Webhook](https://developers.easyship.com/reference/organizations_webhooks_delete.md): Delete a single webhook from your organization. Required authorization scope: `enterprise.webhook:write` - Shipping Rules - [Create a Shipping Rule](https://developers.easyship.com/reference/organizations_shipping_rules_create.md): Create a shipping rule for a specific organization. Required authorization scope: `enterprise.shipping_rule:write` - [Activate a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_activate-1.md): Activate specific shipping rule. Required authorization scope: `enterprise.shipping_rule:write` - [Deactivate a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_deactivate-1.md): Deactivate specific shipping rule. Required authorization scope: `enterprise.shipping_rule:write` - [List all Shipping Rules](https://developers.easyship.com/reference/organizations_shipping_rules_index.md): Retrieve a list of an organization's shipping rules. Required authorization scope: `enterprise.shipping_rule:read` - [Get a Shipping Rule](https://developers.easyship.com/reference/shipping_rules_show-1.md): Retrieve a shipping rule. Required authorization scope: `enterprise.shipping_rule:read` The path does not include the `organization_id` path parameter used for 'List all Shipping Rules' and 'Create… - [Update a Shipping Rule](https://developers.easyship.com/reference/shipping_rules_update-1.md): Update a shipping rule. Required authorization scope: `enterprise.shipping_rule:write` The path does not include the `organization_id` path parameter used for 'List all Shipping Rules' and 'Create… - [Delete a Shipping Rule](https://developers.easyship.com/reference/shipping_rules_delete-1.md): Delete a shipping rule. Required authorization scope: `enterprise.shipping_rule:write` The path does not include the `organization_id` path parameter used for 'List all Shipping Rules' and 'Create… - [List all Platform Names](https://developers.easyship.com/reference/shipping_rule_platforms_index-1.md): Retrieve a list of available platform names for shipping rules. Required authorization scope: `enterprise.shipping_rule:read` - Shipping Rule's Conditions - [Create Condition for a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_condition_create-1.md): Create condition for a shipping rule. Required authorization scope: `enterprise.shipping_rule:write` - [List all Conditions for a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_condition_index-1.md): List conditions of a shipping rule. Required authorization scope: `enterprise.shipping_rule:read` - [Update Condition of the Shipping Rule](https://developers.easyship.com/reference/shipping_rule_condition_update-1.md): Update shipping rule condition. Required authorization scope: `enterprise.shipping_rule:write` - [Delete Condition of a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_condition_delete-1.md): Delete shipping rule condition. Required authorization scope: `enterprise.shipping_rule:write` - Shipping Rule's Actions - [Create Action for a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_action_create-1.md): Create an action for a shipping rule. Required authorization scope: `enterprise.shipping_rule:write` - [List all Actions for a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_action_index-1.md): List actions for a shipping rule. Required authorization scope: `enterprise.shipping_rule:read` - [Update Action of a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_action_update-1.md): Update shipping rule action. Required authorization scope: `enterprise.shipping_rule:write` - [Delete Action of a Shipping Rule](https://developers.easyship.com/reference/shipping_rule_action_delete-1.md): Delete shipping rule action. Required authorization scope: `enterprise.shipping_rule:write` ## Samples - [How to Create a Shipment](https://developers.easyship.com/recipes/how-to-create-a-shipment.md) ## Pages - [Enterprise Organization Restructure](https://developers.easyship.com/page/enterprise-organization-restructure.md) - [IP Addresses](https://developers.easyship.com/page/ip-addresses.md) - [Warehouse Integration for Easyship customers](https://developers.easyship.com/page/warehouse-integration-for-easyship-customers.md)