ShipEngine

Delete Account Image By Id via DELETE /v1/account/settings/images/{label_image_id}

Delete Batch By Id via DELETE /v1/batches/{batch_id}

Disconnect a Carrier of the given ID from the account via DELETE /v1/carriers/{carrier_id}

Disconnect a carrier via DELETE /v1/connections/carriers/{carrier_name}/{carrier_id}

Disconnect a Shipsurance Account via DELETE /v1/connections/insurance/shipsurance

Delete a webhook via DELETE /v1/environment/webhooks/{webhook_id}

Delete a custom package using the ID via DELETE /v1/packages/{package_id}

Delete a previously-scheduled pickup by ID via DELETE /v1/pickups/{pickup_id}

Remove an existing tag from the Shipment object via DELETE /v1/shipments/{shipment_id}/tags/{tag_name}

Delete a tag that is no longer needed via DELETE /v1/tags/{tag_name}

Delete a warehouse by ID via DELETE /v1/warehouses/{warehouse_id}

List all account settings for the ShipEngine account via GET /v1/account/settings

List all account images for the ShipEngine account via GET /v1/account/settings/images

Retrieve information for an account image. via GET /v1/account/settings/images/{label_image_id}

List Batches associated with your Shipengine account via GET /v1/batches

Get Batch By ID via GET /v1/batches/{batch_id}

Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors. via GET /v1/batches/{batch_id}/errors

Get Batch By External ID via GET /v1/batches/external_batch_id/{external_batch_id}

List all carriers that have been added to this account via GET /v1/carriers

Retrive carrier info by ID via GET /v1/carriers/{carrier_id}

Get a list of the options available for the carrier via GET /v1/carriers/{carrier_id}/options

List the package types associated with the carrier via GET /v1/carriers/{carrier_id}/packages

List the services associated with the carrier ID via GET /v1/carriers/{carrier_id}/services

Get carrier settings via GET /v1/connections/carriers/{carrier_name}/{carrier_id}/settings

List all webhooks currently enabled for the account. via GET /v1/environment/webhooks

Retrieve individual webhook by an ID via GET /v1/environment/webhooks/{webhook_id}

Retrieve the balance of your Shipsurance account. via GET /v1/insurance/shipsurance/balance

This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id` via GET /v1/labels

Retrieve information for individual labels. via GET /v1/labels/{label_id}

Retrieve the label's tracking information via GET /v1/labels/{label_id}/track

Find a label by using the external shipment id that was used during label creation via GET /v1/labels/external_shipment_id/{external_shipment_id}

Similar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time. via GET /v1/manifests

Get Manifest By Id via GET /v1/manifests/{manifest_id}

Get Manifest Request By Id via GET /v1/manifests/requests/{manifest_request_id}

List the custom package types associated with the account via GET /v1/packages

Get Custom Package Type by ID via GET /v1/packages/{package_id}

List all pickups that have been scheduled for this carrier via GET /v1/pickups

Get Pickup By ID via GET /v1/pickups/{pickup_id}

Retrieve a previously queried rate by its ID via GET /v1/rates/{rate_id}

Returns a carrier service point by using the service_point_id via GET /v1/service_points/{carrier_code}/{country_code}/{service_point_id}

Get list of Shipments via GET /v1/shipments

Get an individual shipment based on its ID via GET /v1/shipments/{shipment_id}

Get Rates for the shipment information associated with the shipment ID via GET /v1/shipments/{shipment_id}/rates

Get Shipment tags based on its ID via GET /v1/shipments/{shipment_id}/tags

Query Shipments created using your own custom ID convention using this endpint via GET /v1/shipments/external_shipment_id/{external_shipment_id}

Get a list of all tags associated with an account. via GET /v1/tags

Retrieve package tracking information via GET /v1/tracking

Retrieve a list of warehouses associated with this account. via GET /v1/warehouses

Retrieve warehouse data based on the warehouse ID via GET /v1/warehouses/{warehouse_id}

You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded. via PATCH /v1/insurance/shipsurance/add_funds

Create an Account Image via POST /v1/account/settings/images

Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues. via POST /v1/addresses/validate

Create a Batch via POST /v1/batches

Add a Shipment or Rate to a Batch via POST /v1/batches/{batch_id}/add

Process Batch ID Labels via POST /v1/batches/{batch_id}/process/labels

Remove a shipment or rate from a batch via POST /v1/batches/{batch_id}/remove

Connect a carrier account via POST /v1/connections/carriers/{carrier_name}

Connect a Shipsurance Account via POST /v1/connections/insurance/shipsurance

Download a combined label file via POST /v1/documents/combined_labels

Create a webhook for specific events in the environment. via POST /v1/environment/webhooks

Purchase and print a label for shipment via POST /v1/labels

Cancel a scheduled refund request for a label. Only labels with refund status "request_scheduled" can be excluded from an upcoming refund request. via POST /v1/labels/{label_id}/cancel_refund

Create a return label for an existing outbound label. You can optionally specify a custom RMA (Return Merchandise Authorization) number. If no RMA number is provided, the system will auto-generate one. via POST /v1/labels/{label_id}/return

Purchase and print a shipping label using the Rate Shopper. The Rate Shopper automatically selects the optimal carrier and service from your wallet carriers based on your specified rate selection strategy (cheapest, fastest, or best_value). For more information about this in the [rates documentation](https://www.shipengine.com/docs/rates/#about-the-response). via POST /v1/labels/rate_shopper_id/{rate_shopper_id}

When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly. via POST /v1/labels/rates/{rate_id}

Purchase a label using a shipment ID that has already been created with the desired address and package info. via POST /v1/labels/shipment/{shipment_id}

Each ShipEngine manifest is created for a specific warehouse, so you'll need to provide the warehouse_id rather than the ship_from address. You can create a warehouse for each location that you want to create manifests for. via POST /v1/manifests

Create a custom package type to better assist in getting accurate rate estimates via POST /v1/packages

Schedule a package pickup with a carrier via POST /v1/pickups

It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options! via POST /v1/rates

Get Bulk Shipment Rates via POST /v1/rates/bulk

Get Rate Estimates via POST /v1/rates/estimate

List carrier service points by location via POST /v1/service_points/list

Create one or multiple shipments. via POST /v1/shipments

Add a tag to the shipment object via POST /v1/shipments/{shipment_id}/tags/{tag_name}

Create a new tag for customizing how you track your shipments. via POST /v1/tags

Create a new tag for customizing how you track your shipments (deprecated - use POST /v1/tags instead) via POST /v1/tags/{tag_name}

This endpoint returns a token that can be passed to an application for authorized access. The lifetime of this token is 10 seconds. via POST /v1/tokens/ephemeral

Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes. via POST /v1/tracking/start

Unsubscribe from tracking updates for a package. via POST /v1/tracking/stop

Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied in the request body then it is assumed that the origin address is the return address as well via POST /v1/warehouses

Update information for an account image. via PUT /v1/account/settings/images/{label_image_id}

The address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal code, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels. > **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland. via PUT /v1/addresses/recognize

Update Batch By Id via PUT /v1/batches/{batch_id}

Add Funds To A Carrier via PUT /v1/carriers/{carrier_id}/add_funds

Update carrier settings via PUT /v1/connections/carriers/{carrier_name}/{carrier_id}/settings

Update the webhook url property via PUT /v1/environment/webhooks/{webhook_id}

Void a label by ID to get a refund. via PUT /v1/labels/{label_id}/void

Update the custom package type object by ID via PUT /v1/packages/{package_id}

Update a shipment object based on its ID via PUT /v1/shipments/{shipment_id}

Mark a shipment cancelled, if it is no longer needed or being used by your organized. Any label associated with the shipment needs to be voided first An example use case would be if a batch label creation job is going to run at a set time and only queries `pending` shipments. Marking a shipment as cancelled would remove it from this process via PUT /v1/shipments/{shipment_id}/cancel

The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's shipment-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed shipment data is returned in the same structure that's used for other ShipEngine APIs, so you can easily use the parsed data to create a shipping label. > **Note:** Shipment recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland. via PUT /v1/shipments/recognize

Update Shipments Tags via PUT /v1/shipments/tags

Change a tag name while still keeping the relevant shipments attached to it via PUT /v1/tags/{tag_name}/{new_tag_name}

Update Warehouse object information via PUT /v1/warehouses/{warehouse_id}

Update Warehouse settings object information via PUT /v1/warehouses/{warehouse_id}/settings