Shipengine integration: operations for AI agents
Shipengine connects to Type.com as an integration. This page lists the 143 operations documented for Claude and Codex in Type.com: 65 read, 48 write, 30 destructive.
About Shipengine
ShipEngine vendor API references, subject to account and carrier availability.
Categories: Commerce & Payments
How to connect Shipengine to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
143 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
143 operations listed.
account
- Read
List account settings
List all account settings for the ShipEngine account
GET /v1/account/settings - Read
List account images
List all account images for the ShipEngine account
GET /v1/account/settings/images - Read
Get account image by ID
Retrieve information for an account image.
GET /v1/account/settings/images/{label_image_id} - Write
Create an account image
Create an Account Image
POST /v1/account/settings/images - Write
Update account image by ID
Update information for an account image.
PUT /v1/account/settings/images/{label_image_id} - Destructive
Delete account image by ID
Delete Account Image By Id
DELETE /v1/account/settings/images/{label_image_id}
addresses
- Read
Parse an address
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.
PUT /v1/addresses/recognize - Read
Validate an address
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.
POST /v1/addresses/validate
batches
- Read
List batches
List Batches associated with your Shipengine account
GET /v1/batches - Read
Get batch by external ID
Get Batch By External ID
GET /v1/batches/external_batch_id/{external_batch_id} - Read
Get batch by ID
Get Batch By ID
GET /v1/batches/{batch_id} - Read
Get batch errors
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 and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.
GET /v1/batches/{batch_id}/errors - Write
Create a batch
Create a Batch
POST /v1/batches - Write
Update batch by ID
Update Batch By Id
PUT /v1/batches/{batch_id} - Write
Add to a batch
Add a Shipment or Rate to a Batch
POST /v1/batches/{batch_id}/add - Write
Process batch ID labels
Process Batch ID Labels
POST /v1/batches/{batch_id}/process/labels - Destructive
Delete batch by ID
Delete Batch By Id
DELETE /v1/batches/{batch_id} - Destructive
Remove from batch
Remove a shipment or rate from a batch
POST /v1/batches/{batch_id}/remove - Destructive
Assign user to a batch
Assign a user to a batch. Assigning a user replaces any existing assignment.
PUT /v1/batches/{batch_id}/user - Destructive
Unassign user from a batch
Remove the user assignment from a batch.
DELETE /v1/batches/{batch_id}/user
carriers
- Read
List carriers
List all carriers that have been added to this account
GET /v1/carriers - Read
Get carrier by ID
Retrive carrier info by ID
GET /v1/carriers/{carrier_id} - Read
Get carrier options
Get a list of the options available for the carrier
GET /v1/carriers/{carrier_id}/options - Read
List carrier package types
List the package types associated with the carrier. This endpoint only returns carrier-provided package types, not custom package types.
GET /v1/carriers/{carrier_id}/packages - Read
List carrier services
List the services associated with the carrier ID
GET /v1/carriers/{carrier_id}/services - Write
Add funds to carrier
Add Funds To A Carrier
PUT /v1/carriers/{carrier_id}/add_funds - Destructive
Disconnect carrier by ID
Disconnect a Carrier of the given ID from the account
DELETE /v1/carriers/{carrier_id}
carrier_accounts
- Read
Get carrier settings
Get carrier settings
GET /v1/connections/carriers/{carrier_name}/{carrier_id}/settings - Write
Connect a carrier account
Connect a carrier account
POST /v1/connections/carriers/{carrier_name} - Write
Update carrier settings
Update carrier settings
PUT /v1/connections/carriers/{carrier_name}/{carrier_id}/settings - Destructive
Disconnect a carrier
Disconnect a carrier
DELETE /v1/connections/carriers/{carrier_name}/{carrier_id}
insurance
- Read
Get insurance funds balance (deprecated)
Retrieve the balance of your Shipsurance account.
GET /v1/insurance/shipsurance/balance - Write
Connect a shipsurance account (deprecated)
Connect a Shipsurance Account
POST /v1/connections/insurance/shipsurance - Write
Add funds to insurance (deprecated)
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.
PATCH /v1/insurance/shipsurance/add_funds - Destructive
Disconnect a shipsurance account (deprecated)
Disconnect a Shipsurance Account
DELETE /v1/connections/insurance/shipsurance
labels
- Read
List labels
This endpoint returns a list of labels that you've created. 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`
GET /v1/labels - Read
Get label by ID
Retrieve information for individual labels.
GET /v1/labels/{label_id} - Read
Get label by external shipment ID
Find a label by using the external shipment id that was used during label creation
GET /v1/labels/external_shipment_id/{external_shipment_id} - Read
Get label tracking information
Retrieve the label's tracking information
GET /v1/labels/{label_id}/track - Write
Created combined label document
Download a combined label file
POST /v1/documents/combined_labels - Write
Purchase label
Purchase and print a label for shipment
POST /v1/labels - Write
Purchase label with rate 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.
POST /v1/labels/rates/{rate_id} - Write
Purchase label with rate shopper
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 the specified strategy or custom rate shopper configuration. You can use a standard strategy (`cheapest`, `fastest`, `best_value`) or pass a custom rate shopper ID (service collection GUID) to use your own configured service collection for rate selection. For more information about Rate Shopper strategies and use cases, see the rates documentation.
POST /v1/labels/rate_shopper_id/{rate_shopper_id} - Write
Purchase label with shipping rule
Purchase and print a shipping label using a Shipping Rule. The Shipping Rule automatically selects the optimal carrier and service based on the rule's configuration. **Dynamic Ordering**: Service Group Rules can now use dynamic ordering (_Cheapest_ or _Fastest_) to automatically rank eligible services in real time based on live rate or transit data. This feature is currently available for US sellers with USA domestic carrier services only. For more details, see the [Configuring "Order Services By" guide](/apis/@shipengine/docs/shipping/shipping-rules-configuring-order-services-by.md). The request body must NOT include `carrier_id`, `service_code`, or `shipping_rule_id` in the shipment object. If any of these fields are provided, the API will return a `400 Bad Request` error.
POST /v1/labels/shipping_rules/{shipping_rule_id} - Write
Purchase label with shipment ID
Purchase a label using a shipment ID that has already been created with the desired address and package info.
POST /v1/labels/shipment/{shipment_id} - Write
Create a return label
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.
POST /v1/labels/{label_id}/return - Destructive
Void a label by ID
Void a label by ID to get a refund.
PUT /v1/labels/{label_id}/void - Destructive
Cancel a label refund request
Cancel a scheduled refund request for a label. Only labels with refund status "request_scheduled" can be excluded from an upcoming refund request.
POST /v1/labels/{label_id}/cancel_refund
downloads
- Read
Download file
Get File
GET /v1/downloads/{dir}/{subdir}/{filename}
webhooks
- Read
List webhooks
List all webhooks currently enabled for the account.
GET /v1/environment/webhooks - Read
Get webhook by ID
Retrieve individual webhook by an ID
GET /v1/environment/webhooks/{webhook_id} - Write
Create a webhook
Create a webhook for specific events in the environment.
POST /v1/environment/webhooks - Write
Update a webhook
Update the webhook url property
PUT /v1/environment/webhooks/{webhook_id} - Destructive
Delete webhook by ID
Delete a webhook
DELETE /v1/environment/webhooks/{webhook_id}
freight
- Read
List freight provider accounts
Return the freight provider accounts connected to your account. Every freight request identifies the account it goes through with a `freight_provider_account_id`, so start here to find the ID to quote, book, and track with. Only active connections are returned. An account with no freight provider connected receives an empty array.
GET /v1/freight/provider_accounts - Read
Get freight quotes
Retrieve freight rate offers for a shipment. Each offer in the response is a bookable quote from a specific LTL carrier. There are two ways to request quotes: - **Inline.** Describe the shipment in the request: `ship_from`, `ship_to`, and `handling_units`. - **Linked to an existing shipment.** Provide `shipment_id`. The origin is taken from the shipment's ship-from warehouse and the destination from the order's ship-to address, so `ship_from` must be omitted, and `ship_to` may contain only `location_type`. `handling_units`, `accessorials`, and `insurance` are optional in this mode: when provided they are saved as the shipment's freight configuration, and when omitted the previously saved configuration is reused. A `ship_to.location_type` you send is saved the same way. To book one of the returned offers, pass its `offer_id` to [Book a freight shipment](#operation/book_freight_shipment). All dimensions are interpreted as inches and all weights as pounds.
POST /v1/freight/quotes - Read
List freight shipments
Return the freight shipments on your account, most recently created first. Results are paginated.
GET /v1/freight/shipments - Read
Get freight shipment by ID
Retrieve a single freight shipment, including its current status, carrier reference numbers, and the documents generated for it.
GET /v1/freight/shipments/{freight_shipment_id} - Read
List freight shipment documents
List the documents available for a freight shipment, such as the Bill of Lading, pallet labels, and the proof of delivery. Documents become available as the shipment progresses: the Bill of Lading is generated at booking, while a proof of delivery only exists after delivery. Each document's `url` is a path on the API host that returns the PDF, for example `https://api.shipengine.com/v1/downloads/...`.
GET /v1/freight/shipments/{freight_shipment_id}/documents - Read
Get freight shipment tracking
Retrieve the current tracking status and event history for a booked freight shipment directly from the carrier. The shipment is tracked by its PRO number when one has been assigned, and by its BOL number otherwise. A shipment that has neither returns a `400 Bad Request` with error code `freight_tracking_not_available` — this is normal immediately after booking, before the carrier assigns a PRO number.
GET /v1/freight/shipments/{freight_shipment_id}/tracking - Read
Get freight tracking by number
Retrieve tracking for a freight shipment by its PRO or BOL number, whether or not the shipment was booked through ShipEngine. Use this when you have the carrier's reference number but no `freight_shipment_id` — for example, for a shipment booked outside the API. `carrier_scac` is required as well as the number itself, because the freight provider needs the SCAC to resolve a tracking number.
GET /v1/freight/tracking - Write
Connect a freight provider account
Connect a freight account the seller already holds with the provider. Both connectable providers — `speedship` (WWEX) and `unishippers` — authenticate with an OAuth client ID / secret pair issued by the provider. The credentials are verified against the provider before they are stored, so a `201` means the connection can be quoted against immediately. A seller may hold one connection per provider. Connecting a provider that is already connected returns `409` with error code `freight_provider_already_connected` and the existing `freight_provider_account_id`. Use `PUT /v1/freight/provider_accounts/{freight_provider_account_id}/credentials` to rotate credentials on the existing connection. Use `DELETE /v1/freight/provider_accounts/{freight_provider_account_id}` to disconnect it.
POST /v1/freight/provider_accounts - Write
Book a freight shipment
Book one of the offers returned by [Get freight quotes](#operation/get_freight_quotes). Booking dispatches the shipment with the LTL carrier and generates the shipment's documents, such as the Bill of Lading. As with quoting, there are two ways to book: - **Linked to an existing shipment.** Provide `shipment_id`. The shipment must already have a freight quote — call [Get freight quotes](#operation/get_freight_quotes) for it first. The origin, destination, and handling units all come from the shipment and its saved freight configuration, so `ship_from`, `ship_to`, and `handling_units` must be omitted. - **Inline.** Omit `shipment_id` and provide `ship_from`, `ship_to`, and `handling_units`. A shipment record is created for the booking and marked as shipped. Pass the `offer_id` from the offer you are booking. The provider connection, carrier, and expiration are resolved server-side from the stored offer.
POST /v1/freight/shipments - Destructive
Disconnect a freight provider account
Disconnect a freight provider account, removing its stored credentials. This is a soft delete: existing shipments and their tracking and documents are unaffected, but the account can no longer be quoted or booked against until it is reconnected via `POST /v1/freight/provider_accounts`.
DELETE /v1/freight/provider_accounts/{freight_provider_account_id} - Destructive
Update freight provider account credentials
Replace the credentials stored for a freight provider account — the mechanism for rotating a client secret without disconnecting. The new credentials are verified against the provider before they replace the stored pair, so a failed verification leaves the existing connection working. The connection's nickname and account number are untouched.
PUT /v1/freight/provider_accounts/{freight_provider_account_id}/credentials - Destructive
Cancel a freight shipment
Cancel a booked freight shipment with the carrier. The response indicates whether the associated pickup was also cancelled. Cancellation windows are set by the carrier. A shipment that has already been picked up usually cannot be cancelled, and the provider's rejection is returned as a `400 Bad Request`.
DELETE /v1/freight/shipments/{freight_shipment_id}
documents
- Read
List documents for a label
Retrieve the carrier documents registered against a label, including their processing status.
GET /v1/labels/{label_id}/documents - Read
Download a document
Download the file for a previously registered carrier document.
GET /v1/documents/{document_id}/download - Read
List documents for a shipment
Retrieve the carrier documents registered against a shipment, including their processing status.
GET /v1/shipments/{shipment_id}/documents - Read
List shipments and their document statuses
Retrieve each shipment associated with the given id, including its tracking number and registered carrier documents.
GET /v1/shipments/{shipment_id}/labels - Write
Register a document for a label
Register a carrier document against a label. The response returns an `upload` target; upload the document file to that target, then call the send documents endpoint to transmit it to the carrier. Carrier information is resolved automatically from the label.
POST /v1/labels/{label_id}/documents - Write
Send label documents
Transmit all uploaded documents for a label to the carrier. Documents must be uploaded to their `upload` target before they can be sent.
POST /v1/labels/{label_id}/documents/send - Write
Register a document for a shipment
Register a carrier document against a shipment. The response returns an `upload` target; upload the document file to that target so it can later be sent to the carrier.
POST /v1/shipments/{shipment_id}/documents - Destructive
Delete a label document
Delete a carrier document registered against a label. Documents that have already been sent to the carrier cannot be deleted.
DELETE /v1/labels/{label_id}/documents/{document_id} - Destructive
Delete a shipment document
Delete a carrier document registered against a shipment. Documents that have already been sent to the carrier cannot be deleted.
DELETE /v1/shipments/{shipment_id}/documents/{document_id}
mailing
- Write
Create netstamps
Create one or more NetStamps. Each shipment in the request produces an individual stamp with row/column positioning via `advanced_options.netstamps_options`.
POST /v1/mailing/netstamps - Write
Create mailing labels
Create one or more mailing labels on a sheet layout. Use `mailing_options` to control which row and column to start printing from.
POST /v1/mailing/mail_labels - Write
Create envelope
Create a single envelope shipment.
POST /v1/mailing/envelopes
manifests
- Read
List manifests
Similar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time.
GET /v1/manifests - Read
Get manifest by ID
Get Manifest By Id
GET /v1/manifests/{manifest_id} - Read
Get manifest request by ID
Get Manifest Request By Id
GET /v1/manifests/requests/{manifest_request_id} - Write
Create manifest
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.
POST /v1/manifests
package_types
- Read
List custom package types
List the custom package types associated with the account
GET /v1/packages - Read
Get custom package type by ID
Get Custom Package Type by ID
GET /v1/packages/{package_id} - Write
Create custom package type
Create a custom package type to better assist in getting accurate rate estimates
POST /v1/packages - Write
Update custom package type by ID
Update the custom package type object by ID
PUT /v1/packages/{package_id} - Destructive
Delete a custom package by ID
Delete a custom package using the ID
DELETE /v1/packages/{package_id}
package_pickups
- Read
List scheduled pickups
List all pickups that have been scheduled for this carrier
GET /v1/pickups - Read
Get pickup by ID
Get Pickup By ID
GET /v1/pickups/{pickup_id} - Write
Schedule a pickup
Schedule a package pickup with a carrier
POST /v1/pickups - Destructive
Delete a scheduled pickup
Delete a previously-scheduled pickup by ID
DELETE /v1/pickups/{pickup_id}
rates
- Read
Get shipping rates
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!
POST /v1/rates - Read
Get bulk rates
Get Bulk Shipment Rates
POST /v1/rates/bulk - Read
Estimate rates
Get Rate Estimates
POST /v1/rates/estimate - Read
Get rate by ID
Retrieve a previously queried rate by its ID
GET /v1/rates/{rate_id}
rate_shoppers
- Read
List rate shoppers
Retrieve rate shoppers for the authenticated seller. By default this returns both the default rate shoppers (cheapest, fastest, best_value) and any custom rate shoppers. Use the `type` parameter to filter.
GET /v1/rate_shoppers - Read
Get rate shopper by ID
Retrieve a single rate shopper by its identifier. Accepts both default strategy names (`cheapest`, `fastest`, `best_value`) and custom rate shopper UUIDs.
GET /v1/rate_shoppers/{rate_shopper_id}
service_points
- Read
List service points
List carrier service points by location
POST /v1/service_points/list - Read
Get service point by ID
Returns a carrier service point by using the service_point_id
GET /v1/service_points/{carrier_code}/{country_code}/{service_point_id}
shipments
- Read
List shipments
Get list of Shipments
GET /v1/shipments - Read
Get shipment by external ID
Query Shipments created using your own custom ID convention using this endpint
GET /v1/shipments/external_shipment_id/{external_shipment_id} - Read
Parse shipping info
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.
PUT /v1/shipments/recognize - Read
Get shipment by ID
Get an individual shipment based on its ID
GET /v1/shipments/{shipment_id} - Read
Get shipment rates
Get Rates for the shipment information associated with the shipment ID
GET /v1/shipments/{shipment_id}/rates - Read
Get shipment tags
Get Shipment tags based on its ID
GET /v1/shipments/{shipment_id}/tags - Write
Create shipments
Create one or multiple shipments.
POST /v1/shipments - Write
Update shipment by ID
Update a shipment object based on its ID
PUT /v1/shipments/{shipment_id} - Write
Assign user to shipments
Assigns a user to one or more shipments. You can assign a single user to up to 500 shipments at once.
POST /v1/shipments/user - Write
Restore shipments
Restores one or more shipments that are on hold. Each restored shipment returns to the `pending` status and its `hold_until_date` is cleared. You can restore up to 500 shipments at once. Shipments that cannot be restored — because they are not found or are not on hold — are reported in `errors`, and the remaining shipments are still restored. If only some of the shipments were restored, the response status is `207`. If none of them could be restored, the response status is `404` when at least one shipment was not found, or `400` otherwise, and `shipment_ids` is empty. To restore a single shipment, use [Restore a shipment](#operation/restore_shipment).
POST /v1/shipments/restore - Write
Restore a shipment
Restores a shipment that is on hold. The shipment returns to the `pending` status and its `hold_until_date` is cleared. No request body is required. The shipment must currently be on hold. Restoring a shipment in any other status returns a `400` response. To restore up to 500 shipments in one request, use [Restore shipments](#operation/restore_shipments).
PUT /v1/shipments/{shipment_id}/restore - Write
Add tag to shipment
Add a tag to the shipment object
POST /v1/shipments/{shipment_id}/tags/{tag_name} - Destructive
Cancel a shipment
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
PUT /v1/shipments/{shipment_id}/cancel - Destructive
Update shipments tags
Update Shipments Tags
PUT /v1/shipments/tags - Destructive
Hold shipments
Holds one or more shipments until a given date. A shipment on hold has the `on_hold` status, and you can't purchase a label for it while it's on hold. On the `hold_until_date`, the shipment is released automatically and returns to the `pending` status. You can hold up to 500 shipments at once. `hold_until_date` is a date-only value: any time component you send is ignored, and the date must be later than today. Shipments that cannot be held — because they are not found, are cancelled, or have a purchased label — are reported in `errors`, and the remaining shipments are still held. If only some of the shipments were held, the response status is `207`. If none of them could be held, the response status is `404` when at least one shipment was not found, or `400` otherwise, and `shipment_ids` is empty. To hold a single shipment, use [Hold a shipment](#operation/hold_shipment).
POST /v1/shipments/hold - Destructive
Hold a shipment
Holds a shipment until a given date. A shipment on hold has the `on_hold` status, and you can't purchase a label for it while it's on hold. On the `hold_until_date`, the shipment is released automatically and returns to the `pending` status. Holding a shipment that is already on hold replaces the existing `hold_until_date`. A cancelled shipment or a shipment with a purchased label cannot be held and returns a `400` response. `hold_until_date` is a date-only value: any time component you send is ignored, and the date must be later than today. To hold up to 500 shipments in one request, use [Hold shipments](#operation/hold_shipments).
PUT /v1/shipments/{shipment_id}/hold - Destructive
Split a shipment
Move items from a shipment into one or more new shipments. Each entry in `shipments` creates one new shipment holding the items and quantities listed for it. Items and quantities that you don't list stay on the original shipment. Each new shipment is based on the original shipment and stays linked to the same sales order, so the order source keeps getting shipment notifications after the split. To split a shipment: - It must have a `shipment_status` of `pending`, `awaiting_payment`, or `on_hold`. - It must be linked to a sales order. Check `sales_order_ids` on the shipment. - It can't come from a marketplace that supplies its own shipping labels. - All of the items you move must belong to the same sales order. To move items from more than one sales order, make one request for each sales order. - At least one item must stay on the original shipment. Get the `item_id` values from the `items` array of the shipment, using [Get shipment by id](#operation/get_shipment_by_id).
POST /v1/shipments/{shipment_id}/split - Destructive
Merge shipments
Merge one or more shipments into the shipment in the URL. The items from each shipment in `shipment_ids` move onto the shipment in the URL, and the shipments in `shipment_ids` are then deleted. The shipment in the URL stays linked to its own sales orders and becomes linked to the sales orders of every shipment merged into it, so order sources keep getting shipment notifications. The merged shipments can belong to different sales orders. To merge shipments: - Every shipment, including the one in the URL, must have a `shipment_status` of `pending`, `awaiting_payment`, or `on_hold`. - Every shipment must be linked to a sales order. Check `sales_order_ids` on each shipment. - None of the shipments can come from a marketplace that supplies its own shipping labels. If `shipment_ids` includes the shipment in the URL or lists a shipment more than once, the extra entries are ignored.
POST /v1/shipments/{shipment_id}/merge - Destructive
Remove tag from shipment
Remove an existing tag from the Shipment object
DELETE /v1/shipments/{shipment_id}/tags/{tag_name}
tags
- Read
Get tags
Get a list of all tags associated with an account.
GET /v1/tags - Write
Create a new tag
Create a new tag for customizing how you track your shipments.
POST /v1/tags - Write
Create a new tag
Create a new tag for customizing how you track your shipments (deprecated - use POST /v1/tags instead)
POST /v1/tags/{tag_name} - Write
Update tag name
Change a tag name while still keeping the relevant shipments attached to it
PUT /v1/tags/{tag_name}/{new_tag_name} - Destructive
Delete tag
Delete a tag that is no longer needed
DELETE /v1/tags/{tag_name}
tokens
- Write
Get ephemeral token
This endpoint returns a token that can be passed to an application for authorized access. The lifetime of this token is 10 seconds.
POST /v1/tokens/ephemeral
tracking
- Read
Get tracking information
Retrieve package tracking information
GET /v1/tracking - Write
Start tracking a package
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.
POST /v1/tracking/start - Destructive
Stop tracking a package
Unsubscribe from tracking updates for a package.
POST /v1/tracking/stop
warehouses
- Read
List warehouses
Retrieve a list of warehouses associated with this account.
GET /v1/warehouses - Read
Get warehouse by ID
Retrieve warehouse data based on the warehouse ID
GET /v1/warehouses/{warehouse_id} - Write
Create warehouse
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
POST /v1/warehouses - Write
Update warehouse by ID
Update Warehouse object information
PUT /v1/warehouses/{warehouse_id} - Write
Update warehouse settings
Update Warehouse settings object information
PUT /v1/warehouses/{warehouse_id}/settings - Destructive
Delete warehouse by ID
Delete a warehouse by ID
DELETE /v1/warehouses/{warehouse_id}
checkout_rates
- Read
List checkout rates configurations
Return a summary of every checkout rates configuration on your account. Each entry contains identifying fields only; use [Get a checkout rates configuration](#operation/get_checkout_rates_config) to retrieve an individual configuration's options and shared settings.
GET /v1/checkout_rates - Read
Get a checkout rates configuration
Retrieve a single checkout rates configuration, including all of its delivery options and shared settings.
GET /v1/checkout_rates/{config_id} - Read
Get a delivery option
Retrieve a single delivery option belonging to a checkout rates configuration.
GET /v1/checkout_rates/{config_id}/options/{option_id} - Read
Calculate checkout rates
Calculate the shipping rates a buyer should see at checkout for the given destination and cart, using the delivery options defined on the configuration. The response contains one rate per delivery option that produced a price, and each rate carries its own `quote_id` that can be retrieved later with [Get a checkout rate quote](#operation/get_checkout_rates_quote).
POST /v1/checkout_rates/{config_id}/quotes - Read
Get a checkout rate quote
Retrieve a previously calculated rate quote, including the destination it was calculated for and the rates that were returned. > **Note:** Quotes are retained for a limited time. A request for an expired or unknown `quote_id` returns `404 Not Found`.
GET /v1/checkout_rates/quotes/{quote_id} - Write
Create a checkout rates configuration
Create a checkout rates configuration together with its initial delivery options and shared settings. The configuration is returned with a generated `config_id` and, for each option, a generated `option_id`. For `live_rate` and `local_delivery` options, each service's `carrier_id` and `service_code` are validated and resolved against the carriers connected to your account.
POST /v1/checkout_rates - Write
Add a delivery option
Add a delivery option to an existing checkout rates configuration. Option names must be unique within a configuration; adding an option whose name already exists returns a `409 Conflict`.
POST /v1/checkout_rates/{config_id}/options - Destructive
Update a delivery option
Replace the configuration of an existing delivery option. Option names must remain unique within a configuration; renaming an option to a name already in use returns a `409 Conflict`.
PUT /v1/checkout_rates/{config_id}/options/{option_id} - Destructive
Delete a delivery option
Marks a delivery option as inactive (`is_active: false`) instead of removing it; it still appears in the configuration.
DELETE /v1/checkout_rates/{config_id}/options/{option_id}
delivery_predictions
- Read
Predict delivery dates
Predict delivery dates for one or more carrier and service combinations on a single lane, using ShipStation's delivery prediction model rather than the estimate quoted by the carrier. The prediction stands on its own: this endpoint does not price the shipment, create a shipment or a label, and nothing it returns is stored. Send the origin and destination once and list every carrier and service combination you want predicted for that lane. A requested combination comes back as an entry in `delivery_predictions` or as an entry in `warnings`, never both. A combination the model has no coverage for becomes a warning, so a response where nothing is supported is still a `200` with an empty `delivery_predictions` array. A combination the model returns nothing usable for is in neither array. Combinations are matched by `carrier_code` and `service_code` rather than by position, and are returned as the model reports them rather than echoed back. There is no limit you need to manage on your side: a request with more combinations than the model accepts in one call is split across several calls automatically, and none are dropped.
POST /v1/delivery_predictions
No operations match.
See How connections work for access and permissions, or browse all integrations.
Reference date: October 29, 2026. Shipengine API docs.