/v1/carriers/{carrier_id}/packages

List Carrier Package Types

/v1/carriers/{carrier_id}/services

List Carrier Services

/v1/connections/carriers/{carrier_name}

Connect a carrier account

/v1/connections/carriers/{carrier_name}/{carrier_id}

Disconnect a carrier

/v1/connections/carriers/{carrier_name}/{carrier_id}/settings

Get carrier settings

/v1/connections/carriers/{carrier_name}/{carrier_id}/settings

Update carrier settings

/v1/connections/insurance/shipsurance

Disconnect a Shipsurance Account

/v1/connections/insurance/shipsurance

Connect a Shipsurance Account

/v1/pickups/{pickup_id}

Delete a Scheduled Pickup

/v1/pickups/{pickup_id}

Get Pickup By ID

/v1/rates

Get Shipping Rates

/v1/rates/bulk

Get Bulk Rates

/v1/rates/estimate

Estimate Rates

/v1/rates/{rate_id}

Get Rate By ID

/v1/service_points/list

List Service Points

/v1/service_points/{carrier_code}/{country_code}/{service_point_id}

Get Service Point By ID

/v1/addresses/recognize

Parse an address

/v1/addresses/validate

Validate An Address

/v1/batches

List Batches

• status (query)
• page (query, page) — Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
• page_size (query, limit) — The number of results to return per response.
• sort_dir (query) — Controls the sort order of the query.
• batch_number (query) — Batch Number
• sort_by (query)

/v1/batches

Create A Batch

/v1/batches/external_batch_id/{external_batch_id}

Get Batch By External ID

/v1/batches/{batch_id}

Delete Batch By Id

/v1/batches/{batch_id}

Get Batch By ID

/v1/batches/{batch_id}

Update Batch By Id

/v1/batches/{batch_id}/add

Add to a Batch

/v1/batches/{batch_id}/errors

Get Batch Errors

• page (query, page) — Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
• pagesize (query, limit)

/v1/batches/{batch_id}/process/labels

Process Batch ID Labels

/v1/batches/{batch_id}/remove

Remove From Batch

/v1/carriers

List Carriers

/v1/carriers/{carrier_id}

Get Carrier By ID

/v1/carriers/{carrier_id}/add_funds

Add Funds To Carrier

/v1/carriers/{carrier_id}/options

Get Carrier Options

/v1/downloads/{dir}/{subdir}/{filename}

Download File

• download (query)
• rotation (query)

/v1/environment/webhooks

List Webhooks

/v1/environment/webhooks

Create a Webhook

/v1/environment/webhooks/{webhook_id}

Delete Webhook By ID

/v1/environment/webhooks/{webhook_id}

Get Webhook By ID

/v1/environment/webhooks/{webhook_id}

Update a Webhook

/v1/insurance/shipsurance/add_funds

Add Funds To Insurance

/v1/insurance/shipsurance/balance

Get Insurance Funds Balance

/v1/labels

List labels

• label_status (query) — Only return labels that are currently in the specified status
• service_code (query) — Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/)
• carrier_id (query) — Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/)
• tracking_number (query) — Only return labels with a specific tracking number
• batch_id (query) — Only return labels that were created in a specific [batch](https://www.shipengine.com/docs/labels/bulk/)
• rate_id (query) — Rate ID
• shipment_id (query) — Shipment ID
• warehouse_id (query) — Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/)
• created_at_start (query) — Only return labels that were created on or after a specific date/time
• created_at_end (query) — Only return labels that were created on or before a specific date/time
• page (query, page) — Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
• page_size (query, limit) — The number of results to return per response.
• sort_dir (query) — Controls the sort order of the query.
• sort_by (query) — Controls which field the query is sorted by.

/v1/labels

Purchase Label

/v1/labels/external_shipment_id/{external_shipment_id}

Get Label By External Shipment ID

• label_download_type (query)

/v1/labels/rates/{rate_id}

Purchase Label with Rate ID

/v1/labels/shipment/{shipment_id}

Purchase Label with Shipment ID

/v1/labels/{label_id}

Get Label By ID

• label_download_type (query)

/v1/labels/{label_id}/return

Create a return label

/v1/labels/{label_id}/track

Get Label Tracking Information

/v1/labels/{label_id}/void

Void a Label By ID

/v1/manifests

List Manifests

• warehouse_id (query) — Warehouse ID
• ship_date_start (query) — ship date start range
• ship_date_end (query) — ship date end range
• created_at_start (query) — Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
• created_at_end (query) — Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
• carrier_id (query) — Carrier ID
• page (query, page) — Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
• page_size (query, limit) — The number of results to return per response.
• label_ids (query)

/v1/manifests

Create Manifest

/v1/manifests/requests/{manifest_request_id}

Get Manifest Request By Id

/v1/manifests/{manifest_id}

Get Manifest By Id

/v1/packages

List Custom Package Types

/v1/packages

Create Custom Package Type

/v1/packages/{package_id}

Delete A Custom Package By ID

/v1/packages/{package_id}

Get Custom Package Type By ID

/v1/packages/{package_id}

Update Custom Package Type By ID

/v1/pickups

List Scheduled Pickups

• carrier_id (query) — Carrier ID
• warehouse_id (query) — Warehouse ID
• created_at_start (query) — Only return scheduled pickups that were created on or after a specific date/time
• created_at_end (query) — Only return scheduled pickups that were created on or before a specific date/time
• page (query, page) — Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
• page_size (query, limit) — The number of results to return per response.

/v1/pickups

Schedule a Pickup

/v1/shipments

List Shipments

• shipment_status (query)
• batch_id (query) — Batch ID
• tag (query) — Search for shipments based on the custom tag added to the shipment object
• created_at_start (query) — Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
• created_at_end (query) — Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
• modified_at_start (query) — Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)
• modified_at_end (query) — Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)
• page (query, page) — Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
• page_size (query, limit) — The number of results to return per response.
• sales_order_id (query) — Sales Order ID
• sort_dir (query) — Controls the sort order of the query.
• sort_by (query)

/v1/shipments

Create Shipments

/v1/shipments/external_shipment_id/{external_shipment_id}

Get Shipment By External ID

/v1/shipments/recognize

Parse shipping info

/v1/shipments/{shipment_id}

Get Shipment By ID

/v1/shipments/{shipment_id}

Update Shipment By ID

/v1/shipments/{shipment_id}/cancel

Cancel a Shipment

/v1/shipments/{shipment_id}/rates

Get Shipment Rates

• created_at_start (query) — Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)

/v1/shipments/{shipment_id}/tags/{tag_name}

Remove Tag from Shipment

/v1/shipments/{shipment_id}/tags/{tag_name}

Add Tag to Shipment

/v1/tags

Get Tags

/v1/tags/{tag_name}

Delete Tag

/v1/tags/{tag_name}

Create a New Tag

/v1/tags/{tag_name}/{new_tag_name}

Update Tag Name

/v1/tokens/ephemeral

Get Ephemeral Token

• redirect (query) — Include a redirect url to the application formatted with the ephemeral token.

/v1/tracking

Get Tracking Information

• carrier_code (query) — Carrier code used to retrieve tracking information
• tracking_number (query) — The tracking number associated with a shipment

/v1/tracking/start

Start Tracking a Package

• carrier_code (query) — Carrier code used to retrieve tracking information
• tracking_number (query) — The tracking number associated with a shipment

/v1/tracking/stop

Stop Tracking a Package

• carrier_code (query) — Carrier code used to retrieve tracking information
• tracking_number (query) — The tracking number associated with a shipment

/v1/warehouses

List Warehouses

/v1/warehouses

Create Warehouse

/v1/warehouses/{warehouse_id}

Delete Warehouse By ID

/v1/warehouses/{warehouse_id}

Get Warehouse By Id

/v1/warehouses/{warehouse_id}

Update Warehouse By Id

/v1/warehouses/{warehouse_id}/settings

Update Warehouse Settings