ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.shipengine.com
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build po
| method | path | what the vendor says it does |
|---|---|---|
PUT | /v1/addresses/recognize | Parse an address The address-recognition API makes it easy for you to extract address data from unstructured t |
POST | /v1/addresses/validate | Validate An Address Address validation ensures accurate addresses and can lead to reduced shipping costs by pr |
GET | /v1/batches | List Batches List Batches associated with your Shipengine account batches |
POST | /v1/batches | Create A Batch Create a Batch batches |
GET | /v1/batches/external_batch_id/{external_batch_id} | Get Batch By External ID Get Batch By External ID batches |
GET | /v1/batches/{batch_id} | Get Batch By ID Get Batch By ID batches |
PUT | /v1/batches/{batch_id} | Update Batch By Id Update Batch By Id batches |
DELETE | /v1/batches/{batch_id} | Delete Batch By Id Delete Batch By Id batches |
POST | /v1/batches/{batch_id}/add | Add to a Batch Add a Shipment or Rate to a Batch batches |
GET | /v1/batches/{batch_id}/errors | Get Batch Errors Error handling in batches are handled differently than in a single synchronous request. You m |
POST | /v1/batches/{batch_id}/process/labels | Process Batch ID Labels Process Batch ID Labels batches |
POST | /v1/batches/{batch_id}/remove | Remove From Batch Remove a shipment or rate from a batch batches |
GET | /v1/carriers | List Carriers List all carriers that have been added to this account carriers |
GET | /v1/carriers/{carrier_id} | Get Carrier By ID Retrive carrier info by ID carriers |
PUT | /v1/carriers/{carrier_id}/add_funds | Add Funds To Carrier Add Funds To A Carrier carriers |
GET | /v1/carriers/{carrier_id}/options | Get Carrier Options Get a list of the options available for the carrier carriers |
GET | /v1/carriers/{carrier_id}/packages | List Carrier Package Types List the package types associated with the carrier carriers |
GET | /v1/carriers/{carrier_id}/services | List Carrier Services List the services associated with the carrier ID carriers |
POST | /v1/connections/carriers/{carrier_name} | Connect a carrier account Connect a carrier account carrier_accounts |
DELETE | /v1/connections/carriers/{carrier_name}/{carrier_id} | Disconnect a carrier Disconnect a carrier carrier_accounts |
GET | /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Get carrier settings Get carrier settings carrier_accounts |
PUT | /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Update carrier settings Update carrier settings carrier_accounts |
POST | /v1/connections/insurance/shipsurance | Connect a Shipsurance Account Connect a Shipsurance Account insurance |
DELETE | /v1/connections/insurance/shipsurance | Disconnect a Shipsurance Account Disconnect a Shipsurance Account insurance |
GET | /v1/downloads/{dir}/{subdir}/{filename} | Download File Get File downloads |
GET | /v1/environment/webhooks | List Webhooks List all webhooks currently enabled for the account. webhooks |
POST | /v1/environment/webhooks | Create a Webhook Create a webook for specific events in the environment. webhooks |
GET | /v1/environment/webhooks/{webhook_id} | Get Webhook By ID Retrieve individual webhook by an ID webhooks |
PUT | /v1/environment/webhooks/{webhook_id} | Update a Webhook Update the webhook url property webhooks |
DELETE | /v1/environment/webhooks/{webhook_id} | Delete Webhook By ID Delete a webhook webhooks |
PATCH | /v1/insurance/shipsurance/add_funds | Add Funds To Insurance You may need to auto fund your account from time to time. For example, if you don't nor |
GET | /v1/insurance/shipsurance/balance | Get Insurance Funds Balance Retrieve the balance of your Shipsurance account. insurance |
GET | /v1/labels | List labels This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/label |
POST | /v1/labels | Purchase Label Purchase and print a label for shipment labels |
GET | /v1/labels/external_shipment_id/{external_shipment_id} | Get Label By External Shipment ID Find a label by using the external shipment id that was used during label cr |
POST | /v1/labels/rates/{rate_id} | Purchase Label with Rate ID When retrieving rates for shipments using the `/rates` endpoint, the returned info |
POST | /v1/labels/shipment/{shipment_id} | Purchase Label with Shipment ID Purchase a label using a shipment ID that has already been created with the de |
GET | /v1/labels/{label_id} | Get Label By ID Retrieve information for individual labels. labels |
POST | /v1/labels/{label_id}/return | Create a return label Create a return label labels |
GET | /v1/labels/{label_id}/track | Get Label Tracking Information Retrieve the label's tracking information labels |
and 44 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.