ShipEngine integration guide
VerifiedHow to connect ShipEngine to WEXTL and use its 4 triggers and 103 actions in your workflows. About ShipEngine: Shipping labels, rates, tracking and address checks across many carriers.
- 4 triggers
- 48 searches
- 55 actions
- Instant (webhooks)
- Auth: API key
AI-assisted documentation34 min read
This documentation is compiled from our integration source code, internal specs for ShipEngine, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your ShipEngine credentials
- API KeypasswordRequired
In the dashboard open Developer, API Management, and copy a production key. Keys that start with TEST_ are sandbox keys and buy no real labels.[1]
Connect ShipEngine in WEXTL
- Log in to your WEXTL account, add the ShipEngine node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your ShipEngine account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
ShipEngine triggers and actions on WEXTL
The list below is a reference of every ShipEngine node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any ShipEngine node module below to see exactly what it takes in, what it returns, and what connection it needs.
Watch Events
TriggerInstant ShipEngine event feed.
| Field | Type |
|---|---|
| Event | text |
| Resource Type | text |
| Resource URL | text |
| Tracking Number | text |
| Status Code | text |
| Status Description | text |
| Carrier Status Code | text |
| Carrier Status Description | text |
| Ship Date | date |
| Estimated Delivery Date | date |
| Actual Delivery Date | text |
4other output fields
Watch New Batches
TriggerPolls for newly created batches.
| Field | Type |
|---|---|
| Label Layout | text |
| Label Format | text |
| Batch ID | text |
| Batch Number | text |
| External Batch ID | text |
| Batch Notes | text |
| Created At | text |
| Processed At | text |
| Errors | number |
| Process Errors | array |
| Process Error | object |
| Warnings | number |
10other output fields
Watch New Labels
TriggerScans for freshly bought labels.
| Field | Type |
|---|---|
| Label ID | text |
| Status | text |
| Shipment ID | text |
| External Shipment ID | text |
| External Order ID | text |
| Shipment | object |
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Tax Identifiers | array |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Ship Date | text |
| Created At | text |
| Shipment Cost | object |
| Currency | text |
| Amount | number |
| Insurance Cost | object |
| Currency | text |
| Amount | number |
| Requested Comparison Amount | object |
| Currency | text |
| Amount | number |
35other output fields
Watch New Shipments
TriggerScans for freshly saved shipments.
| Field | Type |
|---|---|
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Item | object |
| Tax Identifiers | array |
| Tax Identifier | object |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Created At | text |
17other output fields
Download a Document
SearchFetches a stored document.
| Field | Type |
|---|---|
Document IDRequired | text |
| Field | Type |
|---|---|
| File | file |
| File Name | text |
| Size (Bytes) | number |
| Content Type | text |
Download a File
SearchFetches a generated file.
| Field | Type |
|---|---|
DirectoryRequired | text |
Sub DirectoryRequired | text |
File NameRequired | text |
| Rotation | number |
| Field | Type |
|---|---|
| File | file |
| File Name | text |
| Size (Bytes) | number |
| Content Type | text |
Get a Batch
SearchLabel layout and format of one batch.
| Field | Type |
|---|---|
BatchRequired | text |
| Field | Type |
|---|---|
| Label Layout | text |
| Label Format | text |
| Batch ID | text |
| Batch Number | text |
| External Batch ID | text |
| Batch Notes | text |
| Created At | text |
| Processed At | text |
| Errors | number |
| Process Errors | array |
| Process Error | object |
| Warnings | number |
10other output fields
Get a Batch by External ID
SearchBatch lookup through your reference.
| Field | Type |
|---|---|
External Batch IDRequired | text |
| Field | Type |
|---|---|
| Label Layout | text |
| Label Format | text |
| Batch ID | text |
| Batch Number | text |
| External Batch ID | text |
| Batch Notes | text |
| Created At | text |
| Processed At | text |
| Errors | number |
| Process Errors | array |
| Process Error | object |
| Warnings | number |
10other output fields
Get a Carrier
SearchOne connected carrier account.
| Field | Type |
|---|---|
CarrierRequired | choice |
| Field | Type |
|---|---|
| Carrier ID | text |
| Carrier Code | text |
| Account Number | text |
| Requires Funded Amount | boolean |
| Balance | number |
| Nickname | text |
| Friendly Name | text |
| Funding Source ID | text |
| Primary | boolean |
| Has Multi Package Supporting Services | boolean |
| Allows Returns | boolean |
8other output fields
Get a Label
SearchPurchased label and its state.
| Field | Type |
|---|---|
LabelRequired | text |
| Label Download Type | choice |
| Field | Type |
|---|---|
| Label ID | text |
| Status | text |
| Shipment ID | text |
| External Shipment ID | text |
| External Order ID | text |
| Shipment | object |
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Tax Identifiers | array |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Ship Date | text |
| Created At | text |
| Shipment Cost | object |
| Currency | text |
| Amount | number |
| Insurance Cost | object |
| Currency | text |
| Amount | number |
| Requested Comparison Amount | object |
| Currency | text |
| Amount | number |
35other output fields
Get a Label by External Shipment ID
SearchLabel found by your own reference.
| Field | Type |
|---|---|
External Shipment IDRequired | text |
| Label Download Type | choice |
| Field | Type |
|---|---|
| Label ID | text |
| Status | text |
| Shipment ID | text |
| External Shipment ID | text |
| External Order ID | text |
| Shipment | object |
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Tax Identifiers | array |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Ship Date | text |
| Created At | text |
| Shipment Cost | object |
| Currency | text |
| Amount | number |
| Insurance Cost | object |
| Currency | text |
| Amount | number |
| Requested Comparison Amount | object |
| Currency | text |
| Amount | number |
35other output fields
Get a Label Tracking
SearchDelivery progress of a label.
| Field | Type |
|---|---|
LabelRequired | text |
| Field | Type |
|---|---|
| Tracking Number | text |
| Tracking URL | text |
| Status Code | text |
| Status Detail Code | text |
| Carrier Code | text |
| Carrier ID | number |
| Status Description | text |
| Status Detail Description | text |
| Carrier Status Code | text |
| Carrier Detail Code | text |
| Carrier Status Description | text |
5other output fields
Get a Manifest
SearchForm and ship date of one manifest.
| Field | Type |
|---|---|
ManifestRequired | text |
| Field | Type |
|---|---|
| Manifest ID | text |
| Form ID | text |
| Created At | date |
| Ship Date | date |
| Shipments | number |
| Label Ids | array |
| Warehouse ID | text |
| Submission ID | text |
| Carrier ID | text |
| Manifest Download | object |
| Href | text |
Get a Manifest Request
SearchProgress of manifest creation.
| Field | Type |
|---|---|
Manifest RequestRequired | text |
| Field | Type |
|---|---|
| Manifests | array |
| Manifest | object |
| Manifest Requests | array |
| Manifest Request | object |
| Manifest ID | text |
| Form ID | text |
| Created At | date |
| Ship Date | date |
| Shipments | number |
| Warehouse ID | text |
| Submission ID | text |
| Carrier ID | text |
| Manifest Download | object |
| Href | text |
3other output fields
Get a Package Type
SearchSize definition of a saved box.
| Field | Type |
|---|---|
Package TypeRequired | choice |
| Field | Type |
|---|---|
| Package ID | text |
| Package Code | text |
| Name | text |
| Dimensions | object |
| Unit | text |
| Length | number |
| Width | number |
| Height | number |
| Description | text |
Get a Pickup
SearchCarrier pickup booking details.
| Field | Type |
|---|---|
PickupRequired | text |
| Field | Type |
|---|---|
| Pickup ID | text |
| Label Ids | array |
| Created At | text |
| Cancelled At | text |
| Carrier ID | text |
| Confirmation Number | text |
| Warehouse ID | text |
| Pickup Address | object |
| Name | text |
| Phone | text |
| text | |
| Company Name | text |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City Locality | text |
| State Province | text |
| Postal Code | text |
| Contact Details | object |
| Name | text |
| text | |
| Phone | text |
| Pickup Notes | text |
| Pickup Window | object |
| Start At | text |
| End At | text |
3other output fields
Get a Rate
SearchPrice quote with its amounts.
| Field | Type |
|---|---|
RateRequired | text |
| Field | Type |
|---|---|
| Rate ID | text |
| Rate Type | text |
| Carrier ID | text |
| Shipping Amount | object |
| Currency | text |
| Amount | number |
| Insurance Amount | object |
| Currency | text |
| Amount | number |
| Confirmation Amount | object |
| Currency | text |
| Amount | number |
| Other Amount | object |
| Currency | text |
| Amount | number |
| Requested Comparison Amount | object |
| Currency | text |
| Amount | number |
| Tax Amount | object |
| Currency | text |
| Amount | number |
| Rate Details | array |
| Rate Detail | object |
| Zone | number |
16other output fields
Get a Service Point
SearchSingle drop-off location.
| Field | Type |
|---|---|
Carrier CodeRequired | text |
Country CodeRequired | text |
Service Point IDRequired | text |
| Field | Type |
|---|---|
| Service Point | object |
| Carrier Code | text |
| Service Codes | array |
| Service Point ID | text |
| Company Name | text |
| Address Line1 | text |
| City Locality | text |
| State Province | text |
| Postal Code | text |
| Country Code | text |
| Phone Number | text |
Get a Shipment
SearchCarrier and items of a shipment.
| Field | Type |
|---|---|
ShipmentRequired | text |
| Field | Type |
|---|---|
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Item | object |
| Tax Identifiers | array |
| Tax Identifier | object |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Created At | text |
17other output fields
Get a Shipment by External ID
SearchShipment lookup through your own ID.
| Field | Type |
|---|---|
External Shipment IDRequired | text |
| Field | Type |
|---|---|
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Item | object |
| Tax Identifiers | array |
| Tax Identifier | object |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Created At | text |
17other output fields
Get a Warehouse
SearchShip-from address details.
| Field | Type |
|---|---|
WarehouseRequired | choice |
| Field | Type |
|---|---|
| Warehouse ID | text |
| Is Default | boolean |
| Name | text |
| Created At | date |
| Origin Address | object |
| Name | text |
| Phone | text |
| text | |
| Company Name | text |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City Locality | text |
| State Province | text |
| Postal Code | text |
| Return Address | object |
| Name | text |
| Phone | text |
| text | |
| Company Name | text |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City Locality | text |
| State Province | text |
| Postal Code | text |
Get a Webhook
SearchSettings of an event subscription.
| Field | Type |
|---|---|
WebhookRequired | choice |
| Field | Type |
|---|---|
| Webhook ID | text |
| URL | text |
| Event | text |
| Name | text |
| Store ID | number |
Get Account Settings
SearchAccount wide label defaults.
| Field | Type |
|---|---|
| Default Label Layout | text |
Get an Account Image
SearchStored label image and its type.
| Field | Type |
|---|---|
Label ImageRequired | choice |
| Field | Type |
|---|---|
| Label Image ID | text |
| Name | text |
| Is Default | boolean |
| Image Content Type | text |
| Image Data | text |
| Created At | text |
| Modified At | text |
Get an Ephemeral Token
ActionTemporary token for embedded access.
| Field | Type |
|---|---|
| Redirect | choice |
| Field | Type |
|---|---|
| Token | text |
| Redirect URL | text |
Get Bulk Rates
ActionRates for a whole group.
| Field | Type |
|---|---|
CarriersRequired | choice |
| Shipment IDs | array |
| Shipment ID | text |
| Shipments (JSON) | text |
| Field | Type |
|---|---|
| Results | array |
| Result | object |
Get Carrier Options
SearchOptional services of a carrier.
| Field | Type |
|---|---|
CarrierRequired | choice |
| Field | Type |
|---|---|
| Options | array |
| Option | object |
Get Carrier Settings
SearchPreferences saved for one carrier.
| Field | Type |
|---|---|
Carrier NameRequired | choice |
CarrierRequired | choice |
| Field | Type |
|---|---|
| Nickname | text |
| Should Hide Account Number On Archive Doc | boolean |
| Is Primary Account | boolean |
Get Shipping Rates
ActionPrice quotes across carriers.
| Field | Type |
|---|---|
CarriersRequired | choice |
| Shipment ID | text |
| Service Codes | array |
| Service code | text |
| Package Types | array |
| Package type | text |
| Calculate Tax | boolean |
| Preferred Currency | text |
| Return Shipment | boolean |
| Rate Type | choice |
| Ship Date | date |
| Warehouse | choice |
| External Shipment ID | text |
51other input fields
| Field | Type |
|---|---|
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Item | object |
| Tax Identifiers | array |
| Tax Identifier | object |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Created At | text |
18other output fields
Get the Insurance Balance
SearchRemaining funds for insured shipments.
| Field | Type |
|---|---|
| Currency | text |
| Amount | number |
Get Tracking
SearchCurrent parcel position and link.
| Field | Type |
|---|---|
CarrierRequired | choice |
Tracking NumberRequired | text |
| Field | Type |
|---|---|
| Tracking Number | text |
| Tracking URL | text |
| Status Code | text |
| Status Detail Code | text |
| Carrier Code | text |
| Carrier ID | number |
| Status Description | text |
| Status Detail Description | text |
| Carrier Status Code | text |
| Carrier Detail Code | text |
| Carrier Status Description | text |
5other output fields
List Account Images
SearchLabel images stored on your account.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Label Image ID | text |
| Name | text |
| Is Default | boolean |
| Image Content Type | text |
| Image Data | text |
| Created At | text |
| Modified At | text |
List Batch Errors
SearchFailures inside one batch.
| Field | Type |
|---|---|
BatchRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Error | text |
| Shipment ID | text |
| External Shipment ID | text |
List Batches
SearchBulk label groups in your account.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | choice |
| Batch Number | text |
| Created From | date |
| Created Until | date |
| Processed From | date |
| Processed Until | date |
| Sort By | choice |
| Sort Direction | choice |
| Field | Type |
|---|---|
| Label Layout | text |
| Label Format | text |
| Batch ID | text |
| Batch Number | text |
| External Batch ID | text |
| Batch Notes | text |
| Created At | text |
| Processed At | text |
| Errors | number |
| Process Errors | array |
| Process Error | object |
| Warnings | number |
10other output fields
List Carrier Package Types
SearchBoxes a carrier accepts.
| Field | Type |
|---|---|
CarrierRequired | choice |
| Field | Type |
|---|---|
| Package ID | text |
| Package Code | text |
| Name | text |
| Dimensions | object |
| Unit | text |
| Length | number |
| Width | number |
| Height | number |
| Description | text |
List Carrier Services
SearchDelivery options of a carrier.
| Field | Type |
|---|---|
CarrierRequired | choice |
| Field | Type |
|---|---|
| Carrier ID | text |
| Carrier Code | text |
| Service Code | text |
| Name | text |
| Domestic | boolean |
| International | boolean |
| Is Multi Package Supported | boolean |
| Is Return Supported | boolean |
List Carriers
SearchCarrier accounts you connected.
| Field | Type |
|---|---|
| Carrier ID | text |
| Carrier Code | text |
| Account Number | text |
| Requires Funded Amount | boolean |
| Balance | number |
| Nickname | text |
| Friendly Name | text |
| Funding Source ID | text |
| Primary | boolean |
| Has Multi Package Supporting Services | boolean |
| Allows Returns | boolean |
8other output fields
List Label Documents
SearchTypes and statuses of label paperwork.
| Field | Type |
|---|---|
LabelRequired | text |
| Field | Type |
|---|---|
| Document ID | text |
| Type | text |
| File Name | text |
| Status | text |
List Labels
SearchPurchased labels with their status.
| Field | Type |
|---|---|
LimitRequired | number |
| Label Status | choice |
| Service Code | text |
| Carrier | choice |
| Tracking Number | text |
| Batch ID | text |
| Rate ID | text |
| Shipment ID | text |
| Warehouse | choice |
| Created From | date |
| Created Until | date |
3other input fields
| Field | Type |
|---|---|
| Label ID | text |
| Status | text |
| Shipment ID | text |
| External Shipment ID | text |
| External Order ID | text |
| Shipment | object |
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Tax Identifiers | array |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Ship Date | text |
| Created At | text |
| Shipment Cost | object |
| Currency | text |
| Amount | number |
| Insurance Cost | object |
| Currency | text |
| Amount | number |
| Requested Comparison Amount | object |
| Currency | text |
| Amount | number |
35other output fields
List Manifests
SearchManifests with their form and ship date.
| Field | Type |
|---|---|
LimitRequired | number |
| Warehouse | choice |
| Carrier | choice |
| Ship Date From | date |
| Ship Date Until | date |
| Created From | date |
| Created Until | date |
| Label IDs | array |
| Label ID | text |
| Field | Type |
|---|---|
| Manifest ID | text |
| Form ID | text |
| Created At | date |
| Ship Date | date |
| Shipments | number |
| Label Ids | array |
| Warehouse ID | text |
| Submission ID | text |
| Carrier ID | text |
| Manifest Download | object |
| Href | text |
List Package Types
SearchBoxes you defined yourself.
| Field | Type |
|---|---|
| Package ID | text |
| Package Code | text |
| Name | text |
| Dimensions | object |
| Unit | text |
| Length | number |
| Width | number |
| Height | number |
| Description | text |
List Scheduled Pickups
SearchPickups booked with your carriers.
| Field | Type |
|---|---|
LimitRequired | number |
| Carrier | choice |
| Warehouse | choice |
| Created From | date |
| Created Until | date |
| Field | Type |
|---|---|
| Pickup ID | text |
| Label Ids | array |
| Created At | text |
| Cancelled At | text |
| Carrier ID | text |
| Confirmation Number | text |
| Warehouse ID | text |
| Pickup Address | object |
| Name | text |
| Phone | text |
| text | |
| Company Name | text |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City Locality | text |
| State Province | text |
| Postal Code | text |
| Contact Details | object |
| Name | text |
| text | |
| Phone | text |
| Pickup Notes | text |
| Pickup Window | object |
| Start At | text |
| End At | text |
1other output field
List Service Points
SearchNearby carrier drop-off spots.
| Field | Type |
|---|---|
Providers (JSON)Required | text |
| Address Query | text |
| Country Code | text |
| Postal Code | text |
| City | text |
| State or Province | text |
| Address Line 1 | text |
| Latitude | number |
| Longitude | number |
| Radius | number |
| Max Results | number |
| Field | Type |
|---|---|
| Lat | number |
| Long | number |
| Service Points | array |
| Service Point | object |
| Errors | array |
| Error | object |
List Shipment Documents
SearchStored shipment documents with their types.
| Field | Type |
|---|---|
ShipmentRequired | text |
| Field | Type |
|---|---|
| Document ID | text |
| Type | text |
| File Name | text |
| Status | text |
List Shipment Rates
SearchQuotes stored on a shipment.
| Field | Type |
|---|---|
ShipmentRequired | text |
| Created From | date |
| Field | Type |
|---|---|
| Rates | array |
| Rate | object |
| Invalid Rates | array |
| Invalid Rate | object |
| Rate Request ID | text |
| Shipment ID | text |
| Created At | date |
| Status | text |
| Errors | array |
| Error | object |
List Shipment Tags
SearchTag names placed on a shipment.
| Field | Type |
|---|---|
ShipmentRequired | text |
| Field | Type |
|---|---|
| Name | text |
List Shipments
SearchShipments across your account.
| Field | Type |
|---|---|
LimitRequired | number |
| Shipment Status | choice |
| Batch ID | text |
| Tag | text |
| Sales Order ID | text |
| Created From | date |
| Created Until | date |
| Modified From | date |
| Modified Until | date |
| Sort By | choice |
| Sort Direction | choice |
| Field | Type |
|---|---|
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Item | object |
| Tax Identifiers | array |
| Tax Identifier | object |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Created At | text |
17other output fields
List Tags
SearchTags with their name and color.
| Field | Type |
|---|---|
| Tag ID | number |
| Name | text |
| Color | text |
List Warehouses
SearchYour ship-from addresses.
| Field | Type |
|---|---|
| Warehouse ID | text |
| Is Default | boolean |
| Name | text |
| Created At | date |
| Origin Address | object |
| Name | text |
| Phone | text |
| text | |
| Company Name | text |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City Locality | text |
| State Province | text |
| Postal Code | text |
| Return Address | object |
| Name | text |
| Phone | text |
| text | |
| Company Name | text |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City Locality | text |
| State Province | text |
| Postal Code | text |
List Webhooks
SearchWhere ShipEngine sends events.
| Field | Type |
|---|---|
| Webhook ID | text |
| URL | text |
| Event | text |
| Name | text |
| Store ID | number |
Parse a Shipment
SearchShipment data extracted from loose text.
| Field | Type |
|---|---|
TextRequired | text |
| Shipment Hints (JSON) | text |
| Field | Type |
|---|---|
| Score | number |
| Shipment | object |
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Tax Identifiers | array |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Entities | array |
| Entitie | object |
Parse an Address
SearchStructured address from loose text.
| Field | Type |
|---|---|
TextRequired | text |
| Address Hints (JSON) | text |
| Field | Type |
|---|---|
| Score | number |
| Address | object |
| Name | text |
| Phone | text |
| text | |
| Company Name | text |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City Locality | text |
| State Province | text |
| Postal Code | text |
| Entities | array |
| Entitie | object |
Add a Tag to a Shipment
ActionPuts a tag on a parcel record.
| Field | Type |
|---|---|
ShipmentRequired | text |
TagRequired | choice |
| Field | Type |
|---|---|
| Tags | array |
Add Funds to a Carrier
ActionAdds money to a carrier account balance.
| Field | Type |
|---|---|
CarrierRequired | choice |
CurrencyRequired | text |
AmountRequired | number |
| Field | Type |
|---|---|
| Balance | object |
| Currency | text |
| Amount | number |
Add Funds to Insurance
ActionAdds money to the Shipsurance funds.
| Field | Type |
|---|---|
CurrencyRequired | text |
AmountRequired | number |
| Field | Type |
|---|---|
| Currency | text |
| Amount | number |
Add to a Batch
ActionAdds shipments or rates to a batch.
| Field | Type |
|---|---|
BatchRequired | text |
| Shipment IDs | array |
| Shipment ID | text |
| Rate IDs | array |
| Rate ID | text |
| Field | Type |
|---|---|
| Success | boolean |
Cancel a Label Refund
ActionReverses a label refund request.
| Field | Type |
|---|---|
LabelRequired | text |
| Field | Type |
|---|---|
| Label ID | text |
| Status | text |
| Shipment ID | text |
| External Shipment ID | text |
| External Order ID | text |
| Shipment | object |
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Tax Identifiers | array |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Ship Date | text |
| Created At | text |
| Shipment Cost | object |
| Currency | text |
| Amount | number |
| Insurance Cost | object |
| Currency | text |
| Amount | number |
| Requested Comparison Amount | object |
| Currency | text |
| Amount | number |
35other output fields
Cancel a Shipment
ActionVoids a saved shipment record.
| Field | Type |
|---|---|
ShipmentRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Connect a Carrier
ActionBrings a carrier into ShipEngine.
| Field | Type |
|---|---|
CarrierRequired | choice |
CredentialsRequired | array |
| Credential | object |
| Nickname | text |
| Field | Type |
|---|---|
| Carrier ID | text |
Connect an Insurer
ActionAttaches Shipsurance to your account.
| Field | Type |
|---|---|
EmailRequired | text |
Policy IDRequired | text |
Create a Batch
ActionGroup of shipments for bulk labels.
| Field | Type |
|---|---|
| External Batch ID | text |
| Batch Notes | text |
| Shipment IDs | array |
| Shipment ID | text |
| Rate IDs | array |
| Rate ID | text |
| Process Labels | boolean |
| Ship Date | date |
| Label Layout | choice |
| Label Format | choice |
| Field | Type |
|---|---|
| Label Layout | text |
| Label Format | text |
| Batch ID | text |
| Batch Number | text |
| External Batch ID | text |
| Batch Notes | text |
| Created At | text |
| Processed At | text |
| Errors | number |
| Process Errors | array |
| Process Error | object |
| Warnings | number |
10other output fields
Create a Combined Label Document
ActionSingle print file for many labels.
| Field | Type |
|---|---|
Label IDsRequired | array |
| Label ID | text |
| Label Download Type | choice |
| Field | Type |
|---|---|
| Label Download | object |
| Href | text |
| text | |
| Png | text |
| Zpl | text |
Create a Label
ActionLabel bought from addresses and packages.
| Field | Type |
|---|---|
CarrierRequired | choice |
ServiceRequired | choice |
Ship To NameRequired | text |
Ship To Address Line 1Required | text |
Ship To CityRequired | text |
Ship To State or ProvinceRequired | text |
Ship To Postal CodeRequired | text |
Ship To Country CodeRequired | text |
PackagesRequired | array |
| Package | object |
| Ship Date | date |
| Warehouse | choice |
56other input fields
| Field | Type |
|---|---|
| Label ID | text |
| Status | text |
| Shipment ID | text |
| External Shipment ID | text |
| External Order ID | text |
| Shipment | object |
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Tax Identifiers | array |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Ship Date | text |
| Created At | text |
| Shipment Cost | object |
| Currency | text |
| Amount | number |
| Insurance Cost | object |
| Currency | text |
| Amount | number |
| Requested Comparison Amount | object |
| Currency | text |
| Amount | number |
35other output fields
Create a Label from a Rate
ActionLabel for a chosen price quote.
| Field | Type |
|---|---|
Rate IDRequired | text |
| Custom Field 1 | text |
| Custom Field 2 | text |
| Custom Field 3 | text |
| Validate Address | choice |
| Test Label | boolean |
| Label Format | choice |
| Label Layout | choice |
| Display Scheme | choice |
| Label Download Type | choice |
| Field | Type |
|---|---|
| Label ID | text |
| Status | text |
| Shipment ID | text |
| External Shipment ID | text |
| External Order ID | text |
| Shipment | object |
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Tax Identifiers | array |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Ship Date | text |
| Created At | text |
| Shipment Cost | object |
| Currency | text |
| Amount | number |
| Insurance Cost | object |
| Currency | text |
| Amount | number |
| Requested Comparison Amount | object |
| Currency | text |
| Amount | number |
35other output fields
Create a Label from a Rate Shopper
ActionLabel bought through rate shopping.
| Field | Type |
|---|---|
Rate ShopperRequired | choice |
Ship To NameRequired | text |
Ship To Address Line 1Required | text |
Ship To CityRequired | text |
Ship To State or ProvinceRequired | text |
Ship To Postal CodeRequired | text |
Ship To Country CodeRequired | text |
PackagesRequired | array |
| Package | object |
| Ship Date | date |
| Warehouse | choice |
| External Shipment ID | text |
55other input fields
| Field | Type |
|---|---|
| Rate Shopper ID | text |
| Label ID | text |
| Status | text |
| Shipment ID | text |
| External Shipment ID | text |
| External Order ID | text |
| Shipment | object |
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Tax Identifiers | array |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Ship Date | text |
| Created At | text |
| Shipment Cost | object |
| Currency | text |
| Amount | number |
| Insurance Cost | object |
| Currency | text |
| Amount | number |
36other output fields
Create a Label from a Shipment
ActionLabel for an already saved shipment.
| Field | Type |
|---|---|
Shipment IDRequired | text |
| Validate Address | choice |
| Test Label | boolean |
| Label Format | choice |
| Label Layout | choice |
| Display Scheme | choice |
| Label Download Type | choice |
| Field | Type |
|---|---|
| Label ID | text |
| Status | text |
| Shipment ID | text |
| External Shipment ID | text |
| External Order ID | text |
| Shipment | object |
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Tax Identifiers | array |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Ship Date | text |
| Created At | text |
| Shipment Cost | object |
| Currency | text |
| Amount | number |
| Insurance Cost | object |
| Currency | text |
| Amount | number |
| Requested Comparison Amount | object |
| Currency | text |
| Amount | number |
35other output fields
Create a Manifest
ActionManifest for the labels of a carrier.
| Field | Type |
|---|---|
CarrierRequired | choice |
| Warehouse | choice |
| Ship Date | date |
| Label IDs | array |
| Label ID | text |
| Excluded Label IDs | array |
| Label ID | text |
| Field | Type |
|---|---|
| Manifests | array |
| Manifest | object |
| Manifest Requests | array |
| Manifest Request | object |
| Manifest ID | text |
| Form ID | text |
| Created At | date |
| Ship Date | date |
| Shipments | number |
| Warehouse ID | text |
| Submission ID | text |
| Carrier ID | text |
| Manifest Download | object |
| Href | text |
3other output fields
Create a Package Type
ActionReusable box definition with dimensions.
| Field | Type |
|---|---|
NameRequired | text |
Package CodeRequired | text |
| Description | text |
| Dimension Unit | choice |
| Length | number |
| Width | number |
| Height | number |
| Field | Type |
|---|---|
| Package ID | text |
| Package Code | text |
| Name | text |
| Dimensions | object |
| Unit | text |
| Length | number |
| Width | number |
| Height | number |
| Description | text |
Create a Return Label
ActionLabel for sending an item back.
| Field | Type |
|---|---|
Label IDRequired | text |
| RMA Number | text |
| Charge Event | choice |
| Test Label | boolean |
| Label Format | choice |
| Label Layout | choice |
| Display Scheme | choice |
| Label Download Type | choice |
| Field | Type |
|---|---|
| Label ID | text |
| Status | text |
| Shipment ID | text |
| External Shipment ID | text |
| External Order ID | text |
| Shipment | object |
| Shipment ID | text |
| Carrier ID | text |
| Service Code | text |
| Shipping Rule ID | text |
| External Order ID | text |
| Items | array |
| Tax Identifiers | array |
| External Shipment ID | text |
| Shipment Number | text |
| Ship Date | text |
| Ship Date | text |
| Created At | text |
| Shipment Cost | object |
| Currency | text |
| Amount | number |
| Insurance Cost | object |
| Currency | text |
| Amount | number |
| Requested Comparison Amount | object |
| Currency | text |
| Amount | number |
35other output fields
Create a Shipment
ActionShipment record without a label.
| Field | Type |
|---|---|
Ship To NameRequired | text |
Ship To Address Line 1Required | text |
Ship To CityRequired | text |
Ship To State or ProvinceRequired | text |
Ship To Postal CodeRequired | text |
Ship To Country CodeRequired | text |
PackagesRequired | array |
| Package | object |
| Carrier | choice |
| Service | choice |
| Ship Date | date |
| Warehouse | choice |
45other input fields
| Field | Type |
|---|---|
| Has Errors | boolean |
| Shipments | array |
| Shipment | object |
Create a Tag
ActionNew tag with a chosen name and optional color.
| Field | Type |
|---|---|
NameRequired | text |
| Color | text |
| Field | Type |
|---|---|
| Tag ID | number |
| Name | text |
| Color | text |
Create a Warehouse
ActionShip-from address on file.
| Field | Type |
|---|---|
NameRequired | text |
Origin Address Line 1Required | text |
Origin CityRequired | text |
Origin State or ProvinceRequired | text |
Origin Postal CodeRequired | text |
Origin Country CodeRequired | text |
| Origin Name | text |
| Origin Phone | text |
| Origin Company | text |
| Origin Address Line 2 | text |
| Origin Address Line 3 | text |
11other input fields
| Field | Type |
|---|---|
| Warehouse ID | text |
| Is Default | boolean |
| Name | text |
| Created At | date |
| Origin Address | object |
| Name | text |
| Phone | text |
| text | |
| Company Name | text |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City Locality | text |
| State Province | text |
| Postal Code | text |
| Return Address | object |
| Name | text |
| Phone | text |
| text | |
| Company Name | text |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City Locality | text |
| State Province | text |
| Postal Code | text |
Create a Webhook
ActionEvent subscription for a URL.
| Field | Type |
|---|---|
EventRequired | choice |
URLRequired | text |
| Name | text |
| Store ID | number |
| Headers | array |
| Row | object |
| Field | Type |
|---|---|
| Webhook ID | text |
| URL | text |
| Event | text |
| Name | text |
| Store ID | number |
Create an Account Image
ActionNew image for your printed labels.
| Field | Type |
|---|---|
NameRequired | text |
Image Content TypeRequired | choice |
Image Data (base64)Required | text |
| Default Image | boolean |
| Field | Type |
|---|---|
| Label Image ID | text |
| Name | text |
| Is Default | boolean |
| Image Content Type | text |
| Image Data | text |
| Created At | text |
| Modified At | text |
Delete a Batch
ActionBatch removal from the account.
| Field | Type |
|---|---|
BatchRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Label Document
ActionRegistered label document deleted.
| Field | Type |
|---|---|
LabelRequired | text |
DocumentRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Package Type
ActionCustom box definition deleted.
| Field | Type |
|---|---|
Package TypeRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Scheduled Pickup
ActionCarrier pickup booking cancelled.
| Field | Type |
|---|---|
PickupRequired | text |
| Field | Type |
|---|---|
| Pickup ID | text |
| Success | boolean |
Delete a Shipment Document
ActionPaperwork taken off a shipment.
| Field | Type |
|---|---|
ShipmentRequired | text |
DocumentRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Tag
ActionShipment tag removed from your tags.
| Field | Type |
|---|---|
TagRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Warehouse
ActionShip-from address removed.
| Field | Type |
|---|---|
WarehouseRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Webhook
ActionEvent subscription removed from your account.
| Field | Type |
|---|---|
WebhookRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete an Account Image
ActionLabel image removed from your account.
| Field | Type |
|---|---|
Label ImageRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Disconnect a Carrier
ActionCarrier account unplugged from ShipEngine.
| Field | Type |
|---|---|
CarrierRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Disconnect an Insurer
ActionInsurance policy disconnected from ShipEngine.
| Field | Type |
|---|---|
| Success | boolean |
Estimate Rates
ActionQuick price check between locations.
| Field | Type |
|---|---|
From Country CodeRequired | text |
From Postal CodeRequired | text |
From CityRequired | text |
From State or ProvinceRequired | text |
To Country CodeRequired | text |
To Postal CodeRequired | text |
To CityRequired | text |
To State or ProvinceRequired | text |
WeightRequired | number |
Weight UnitRequired | choice |
CarriersRequired | choice |
7other input fields
| Field | Type |
|---|---|
| Results | array |
| Result | object |
Make an API Call
universalCustom ShipEngine REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query string | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Key | text |
| Value | text |
| Status code | number |
Process Batch Labels
ActionBulk purchase for a batch.
| Field | Type |
|---|---|
BatchRequired | text |
| Ship Date | date |
| Label Layout | choice |
| Label Format | choice |
| Display Scheme | choice |
| Field | Type |
|---|---|
| Success | boolean |
Register a Label Document
ActionDocument entry for a label with its type and file name.
| Field | Type |
|---|---|
LabelRequired | text |
Document TypeRequired | choice |
File NameRequired | text |
| Format | choice |
| File | text |
| Field | Type |
|---|---|
| Document ID | text |
| Status | text |
| File Uploaded | boolean |
Register a Shipment Document
ActionDocument entry for a shipment with type and format.
| Field | Type |
|---|---|
ShipmentRequired | text |
Document TypeRequired | choice |
File NameRequired | text |
| Format | choice |
| File | text |
| Field | Type |
|---|---|
| Document ID | text |
| Status | text |
| File Uploaded | boolean |
Remove a Tag from a Shipment
ActionShipment tag detached by name.
| Field | Type |
|---|---|
ShipmentRequired | text |
TagRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Remove from a Batch
ActionSubtracts shipments or rates from a batch.
| Field | Type |
|---|---|
BatchRequired | text |
| Shipment IDs | array |
| Shipment ID | text |
| Rate IDs | array |
| Rate ID | text |
| Field | Type |
|---|---|
| Success | boolean |
Rename a Tag
ActionRetitles a shipment tag.
| Field | Type |
|---|---|
TagRequired | choice |
New NameRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Schedule a Pickup
ActionCarrier pickup booked for labels.
| Field | Type |
|---|---|
Label IDsRequired | array |
| Label ID | text |
Contact NameRequired | text |
Contact EmailRequired | text |
Contact PhoneRequired | text |
Window StartRequired | date |
Window EndRequired | date |
| Warehouse | choice |
| Pickup Notes | text |
| Field | Type |
|---|---|
| Pickup ID | text |
| Label Ids | array |
| Created At | text |
| Cancelled At | text |
| Carrier ID | text |
| Confirmation Number | text |
| Warehouse ID | text |
| Pickup Address | object |
| Name | text |
| Phone | text |
| text | |
| Company Name | text |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City Locality | text |
| State Province | text |
| Postal Code | text |
| Contact Details | object |
| Name | text |
| text | |
| Phone | text |
| Pickup Notes | text |
| Pickup Window | object |
| Start At | text |
| End At | text |
3other output fields
Send Label Documents
ActionPushes label paperwork to the carrier.
| Field | Type |
|---|---|
LabelRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Set the Default Warehouse
ActionDefault ship-from address.
| Field | Type |
|---|---|
WarehouseRequired | choice |
| Default Warehouse | boolean |
| Field | Type |
|---|---|
| Success | boolean |
Start Tracking
ActionSubscribes to parcel updates.
| Field | Type |
|---|---|
CarrierRequired | choice |
Tracking NumberRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Stop Tracking
ActionUnsubscribes from parcel updates.
| Field | Type |
|---|---|
CarrierRequired | choice |
Tracking NumberRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Update a Package Type
ActionBox definition changed in place.
| Field | Type |
|---|---|
Package TypeRequired | choice |
| Name | text |
| Package Code | text |
| Description | text |
| Dimension Unit | choice |
| Length | number |
| Width | number |
| Height | number |
| Clear Fields | choice |
| Field | Type |
|---|---|
| Success | boolean |
Update a Shipment
ActionSaved shipment adjusted in place.
| Field | Type |
|---|---|
ShipmentRequired | text |
| Carrier | choice |
| Service | choice |
| Ship Date | date |
| Warehouse | choice |
| External Shipment ID | text |
| External Order ID | text |
| Shipment Number | text |
| Confirmation | choice |
| Insurance Provider | choice |
| Ship To Name | text |
46other input fields
| Field | Type |
|---|---|
| Success | boolean |
Update a Warehouse
ActionShip-from address edited.
| Field | Type |
|---|---|
WarehouseRequired | choice |
| Name | text |
| Origin Name | text |
| Origin Phone | text |
| Origin Company | text |
| Origin Address Line 1 | text |
| Origin Address Line 2 | text |
| Origin Address Line 3 | text |
| Origin City | text |
| Origin State or Province | text |
| Origin Postal Code | text |
12other input fields
| Field | Type |
|---|---|
| Success | boolean |
Update a Webhook
ActionSubscription settings changed in place.
| Field | Type |
|---|---|
WebhookRequired | choice |
| URL | text |
| Name | text |
| Store ID | number |
| Headers | array |
| Row | object |
| Clear Fields | choice |
| Field | Type |
|---|---|
| Success | boolean |
Update an Account Image
ActionEdits a stored label image.
| Field | Type |
|---|---|
Label ImageRequired | choice |
| Default Image | choice |
| Name | text |
| Image Content Type | choice |
| Image Data (base64) | text |
| Field | Type |
|---|---|
| Success | boolean |
Update Carrier Settings
ActionCarrier account preferences edited.
| Field | Type |
|---|---|
CarrierRequired | choice |
CarrierRequired | choice |
| Nickname | text |
| Account Postal Code | text |
| text | |
| Mail Innovations Cost Center | text |
| Primary Account | choice |
| Use Negotiated Rates | choice |
| Email on Manifest Processing | choice |
| Carbon Neutral Shipping | choice |
| Ground Freight Pricing | choice |
10other input fields
| Field | Type |
|---|---|
| Success | boolean |
Update Shipments Tags
ActionBulk tag assignment across shipments.
| Field | Type |
|---|---|
ShipmentsRequired | array |
| Shipment | object |
| Field | Type |
|---|---|
| Shipments | array |
| Success | boolean |
Validate an Address
ActionCleaned and verified address.
| Field | Type |
|---|---|
Address Line 1Required | text |
CityRequired | text |
State or ProvinceRequired | text |
Country CodeRequired | text |
| Name | text |
| Phone | text |
| text | |
| Company | text |
| Address Line 2 | text |
| Address Line 3 | text |
| Postal Code | text |
2other input fields
| Field | Type |
|---|---|
| Results | array |
| Result | object |
| Status | text |
| Original Address | text |
| Matched Address | text |
| Messages | array |
Templates
Look for ShipEngine templates in the WEXTL template library.
Browse templates →Other commerce integrations on WEXTL
ShipStation[2]Shipping with orders, labels, shipments and fulfillment.
ShippoMulti-carrier shipping for rates, labels, tracking, and customs.
DHLDHL Express shipping and cross-division shipment tracking, with rates, products, shipments, labels, pickups, customs documents and delivery status.
ShipdayDelivery management for dispatching and tracking local orders.
BoxHeroInventory management for items, stock, orders, returns and grouped items.
References
- WEXTL® ShipEngine Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for ShipEngine.
- WEXTL® visual workflow builder data.
Last updated: Nov 14, 2026 14:55
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.


























