Shipengine API

ShipEngine API

API version: 1.1.202602041002

Auth

ApiKey API-Key in header

Base URL

https://api.shipengine.com

Setup

1. Set your API key in the appropriate header
2. GET /v1/account/settings -- verify access
3. POST /v1/account/settings/images -- create first images

Endpoints

95 endpoints across 20 groups. See references/api-spec.lap for full details.

account

addresses

batches

carriers

connections

documents

downloads

environment

insurance

labels

manifests

packages

pickups

rates

service_points

shipments

tags

tokens

tracking

warehouses

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all settings?" -> GET /v1/account/settings
• "List all images?" -> GET /v1/account/settings/images
• "Create a image?" -> POST /v1/account/settings/images
• "Get image details?" -> GET /v1/account/settings/images/{label_image_id}
• "Update a image?" -> PUT /v1/account/settings/images/{label_image_id}
• "Delete a image?" -> DELETE /v1/account/settings/images/{label_image_id}
• "Create a validate?" -> POST /v1/addresses/validate
• "List all batches?" -> GET /v1/batches
• "Create a batche?" -> POST /v1/batches
• "Get external_batch_id details?" -> GET /v1/batches/external_batch_id/{external_batch_id}
• "Delete a batche?" -> DELETE /v1/batches/{batch_id}
• "Get batche details?" -> GET /v1/batches/{batch_id}
• "Update a batche?" -> PUT /v1/batches/{batch_id}
• "Create a add?" -> POST /v1/batches/{batch_id}/add
• "List all errors?" -> GET /v1/batches/{batch_id}/errors
• "Create a label?" -> POST /v1/batches/{batch_id}/process/labels
• "Create a remove?" -> POST /v1/batches/{batch_id}/remove
• "List all carriers?" -> GET /v1/carriers
• "Get carrier details?" -> GET /v1/carriers/{carrier_id}
• "Delete a carrier?" -> DELETE /v1/carriers/{carrier_id}
• "List all options?" -> GET /v1/carriers/{carrier_id}/options
• "List all packages?" -> GET /v1/carriers/{carrier_id}/packages
• "List all services?" -> GET /v1/carriers/{carrier_id}/services
• "Delete a carrier?" -> DELETE /v1/connections/carriers/{carrier_name}/{carrier_id}
• "List all settings?" -> GET /v1/connections/carriers/{carrier_name}/{carrier_id}/settings
• "Create a shipsurance?" -> POST /v1/connections/insurance/shipsurance
• "Create a combined_label?" -> POST /v1/documents/combined_labels
• "Get download details?" -> GET /v1/downloads/{dir}/{subdir}/{filename}
• "List all webhooks?" -> GET /v1/environment/webhooks
• "Create a webhook?" -> POST /v1/environment/webhooks
• "Get webhook details?" -> GET /v1/environment/webhooks/{webhook_id}
• "Update a webhook?" -> PUT /v1/environment/webhooks/{webhook_id}
• "Delete a webhook?" -> DELETE /v1/environment/webhooks/{webhook_id}
• "List all balance?" -> GET /v1/insurance/shipsurance/balance
• "List all labels?" -> GET /v1/labels
• "Create a label?" -> POST /v1/labels
• "Get external_shipment_id details?" -> GET /v1/labels/external_shipment_id/{external_shipment_id}
• "Get label details?" -> GET /v1/labels/{label_id}
• "Create a return?" -> POST /v1/labels/{label_id}/return
• "List all track?" -> GET /v1/labels/{label_id}/track
• "List all manifests?" -> GET /v1/manifests
• "Create a manifest?" -> POST /v1/manifests
• "Get manifest details?" -> GET /v1/manifests/{manifest_id}
• "Get request details?" -> GET /v1/manifests/requests/{manifest_request_id}
• "List all packages?" -> GET /v1/packages
• "Create a package?" -> POST /v1/packages
• "Get package details?" -> GET /v1/packages/{package_id}
• "Update a package?" -> PUT /v1/packages/{package_id}
• "Delete a package?" -> DELETE /v1/packages/{package_id}
• "List all pickups?" -> GET /v1/pickups
• "Create a pickup?" -> POST /v1/pickups
• "Get pickup details?" -> GET /v1/pickups/{pickup_id}
• "Delete a pickup?" -> DELETE /v1/pickups/{pickup_id}
• "Create a rate?" -> POST /v1/rates
• "Create a bulk?" -> POST /v1/rates/bulk
• "Create a estimate?" -> POST /v1/rates/estimate
• "Get rate details?" -> GET /v1/rates/{rate_id}
• "Create a list?" -> POST /v1/service_points/list
• "Get service_point details?" -> GET /v1/service_points/{carrier_code}/{country_code}/{service_point_id}
• "List all shipments?" -> GET /v1/shipments
• "Create a shipment?" -> POST /v1/shipments
• "Get external_shipment_id details?" -> GET /v1/shipments/external_shipment_id/{external_shipment_id}
• "Get shipment details?" -> GET /v1/shipments/{shipment_id}
• "Update a shipment?" -> PUT /v1/shipments/{shipment_id}
• "List all rates?" -> GET /v1/shipments/{shipment_id}/rates
• "List all tags?" -> GET /v1/shipments/{shipment_id}/tags
• "Delete a tag?" -> DELETE /v1/shipments/{shipment_id}/tags/{tag_name}
• "List all tags?" -> GET /v1/tags
• "Create a tag?" -> POST /v1/tags
• "Delete a tag?" -> DELETE /v1/tags/{tag_name}
• "Update a tag?" -> PUT /v1/tags/{tag_name}/{new_tag_name}
• "Create a ephemeral?" -> POST /v1/tokens/ephemeral
• "List all tracking?" -> GET /v1/tracking
• "Create a start?" -> POST /v1/tracking/start
• "Create a stop?" -> POST /v1/tracking/stop
• "List all warehouses?" -> GET /v1/warehouses
• "Create a warehouse?" -> POST /v1/warehouses
• "Get warehouse details?" -> GET /v1/warehouses/{warehouse_id}
• "Update a warehouse?" -> PUT /v1/warehouses/{warehouse_id}
• "Delete a warehouse?" -> DELETE /v1/warehouses/{warehouse_id}
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP