Skip to docs navigation

ShipEngine integration guide

Verified

How 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].

Open ShipEngine on WEXTL →
  • ShipEngine
  • WEXTL
  • ShipStation
  • Shippo
  • DHL
  • Shipday
  • BoxHero
  • Onfleet
  • Unleashed
  • BigCommerce
  • Booqable
  • Recharge
  • Gift Up
  • MemberPress
  • Speedaf Express
  • Printavo
  • Ticket Tailor
  • SamCart
  • Chowdeck
  • Glovo
  • Zid
  • Loyverse
  • Lightspeed Retail
  • Hotmart
  • Salla
  • Patreon
  • Amazon Seller Partner
  • Sharetribe
  • 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]

  1. 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.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your ShipEngine account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Events

TriggerInstant ShipEngine event feed.
Output fields[3]
FieldType
Eventtext
Resource Typetext
Resource URLtext
Tracking Numbertext
Status Codetext
Status Descriptiontext
Carrier Status Codetext
Carrier Status Descriptiontext
Ship Datedate
Estimated Delivery Datedate
Actual Delivery Datetext

4other output fields

Watch New Batches

TriggerPolls for newly created batches.
Output fields[3]
FieldType
Label Layouttext
Label Formattext
Batch IDtext
Batch Numbertext
External Batch IDtext
Batch Notestext
Created Attext
Processed Attext
Errorsnumber
Process Errorsarray
Process Errorobject
Warningsnumber

10other output fields

Watch New Labels

TriggerScans for freshly bought labels.
Output fields[3]
FieldType
Label IDtext
Statustext
Shipment IDtext
External Shipment IDtext
External Order IDtext
Shipmentobject
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Tax Identifiersarray
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Ship Datetext
Created Attext
Shipment Costobject
Currencytext
Amountnumber
Insurance Costobject
Currencytext
Amountnumber
Requested Comparison Amountobject
Currencytext
Amountnumber

35other output fields

Watch New Shipments

TriggerScans for freshly saved shipments.
Output fields[3]
FieldType
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Itemobject
Tax Identifiersarray
Tax Identifierobject
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Created Attext

17other output fields

Download a Document

SearchFetches a stored document.
Input fields[3]
FieldType
Document IDRequired
text
Output fields[3]
FieldType
Filefile
File Nametext
Size (Bytes)number
Content Typetext

Download a File

SearchFetches a generated file.
Input fields[3]
FieldType
DirectoryRequired
text
Sub DirectoryRequired
text
File NameRequired
text
Rotationnumber
Output fields[3]
FieldType
Filefile
File Nametext
Size (Bytes)number
Content Typetext

Get a Batch

SearchLabel layout and format of one batch.
Input fields[3]
FieldType
BatchRequired
text
Output fields[3]
FieldType
Label Layouttext
Label Formattext
Batch IDtext
Batch Numbertext
External Batch IDtext
Batch Notestext
Created Attext
Processed Attext
Errorsnumber
Process Errorsarray
Process Errorobject
Warningsnumber

10other output fields

Get a Batch by External ID

SearchBatch lookup through your reference.
Input fields[3]
FieldType
External Batch IDRequired
text
Output fields[3]
FieldType
Label Layouttext
Label Formattext
Batch IDtext
Batch Numbertext
External Batch IDtext
Batch Notestext
Created Attext
Processed Attext
Errorsnumber
Process Errorsarray
Process Errorobject
Warningsnumber

10other output fields

Get a Carrier

SearchOne connected carrier account.
Input fields[3]
FieldType
CarrierRequired
choice
Output fields[3]
FieldType
Carrier IDtext
Carrier Codetext
Account Numbertext
Requires Funded Amountboolean
Balancenumber
Nicknametext
Friendly Nametext
Funding Source IDtext
Primaryboolean
Has Multi Package Supporting Servicesboolean
Allows Returnsboolean

8other output fields

Get a Label

SearchPurchased label and its state.
Input fields[3]
FieldType
LabelRequired
text
Label Download Typechoice
Output fields[3]
FieldType
Label IDtext
Statustext
Shipment IDtext
External Shipment IDtext
External Order IDtext
Shipmentobject
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Tax Identifiersarray
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Ship Datetext
Created Attext
Shipment Costobject
Currencytext
Amountnumber
Insurance Costobject
Currencytext
Amountnumber
Requested Comparison Amountobject
Currencytext
Amountnumber

35other output fields

Get a Label by External Shipment ID

SearchLabel found by your own reference.
Input fields[3]
FieldType
External Shipment IDRequired
text
Label Download Typechoice
Output fields[3]
FieldType
Label IDtext
Statustext
Shipment IDtext
External Shipment IDtext
External Order IDtext
Shipmentobject
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Tax Identifiersarray
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Ship Datetext
Created Attext
Shipment Costobject
Currencytext
Amountnumber
Insurance Costobject
Currencytext
Amountnumber
Requested Comparison Amountobject
Currencytext
Amountnumber

35other output fields

Get a Label Tracking

SearchDelivery progress of a label.
Input fields[3]
FieldType
LabelRequired
text
Output fields[3]
FieldType
Tracking Numbertext
Tracking URLtext
Status Codetext
Status Detail Codetext
Carrier Codetext
Carrier IDnumber
Status Descriptiontext
Status Detail Descriptiontext
Carrier Status Codetext
Carrier Detail Codetext
Carrier Status Descriptiontext

5other output fields

Get a Manifest

SearchForm and ship date of one manifest.
Input fields[3]
FieldType
ManifestRequired
text
Output fields[3]
FieldType
Manifest IDtext
Form IDtext
Created Atdate
Ship Datedate
Shipmentsnumber
Label Idsarray
Warehouse IDtext
Submission IDtext
Carrier IDtext
Manifest Downloadobject
Hreftext

Get a Manifest Request

SearchProgress of manifest creation.
Input fields[3]
FieldType
Manifest RequestRequired
text
Output fields[3]
FieldType
Manifestsarray
Manifestobject
Manifest Requestsarray
Manifest Requestobject
Manifest IDtext
Form IDtext
Created Atdate
Ship Datedate
Shipmentsnumber
Warehouse IDtext
Submission IDtext
Carrier IDtext
Manifest Downloadobject
Hreftext

3other output fields

Get a Package Type

SearchSize definition of a saved box.
Input fields[3]
FieldType
Package TypeRequired
choice
Output fields[3]
FieldType
Package IDtext
Package Codetext
Nametext
Dimensionsobject
Unittext
Lengthnumber
Widthnumber
Heightnumber
Descriptiontext

Get a Pickup

SearchCarrier pickup booking details.
Input fields[3]
FieldType
PickupRequired
text
Output fields[3]
FieldType
Pickup IDtext
Label Idsarray
Created Attext
Cancelled Attext
Carrier IDtext
Confirmation Numbertext
Warehouse IDtext
Pickup Addressobject
Nametext
Phonetext
Emailtext
Company Nametext
Address Line1text
Address Line2text
Address Line3text
City Localitytext
State Provincetext
Postal Codetext
Contact Detailsobject
Nametext
Emailtext
Phonetext
Pickup Notestext
Pickup Windowobject
Start Attext
End Attext

3other output fields

Get a Rate

SearchPrice quote with its amounts.
Input fields[3]
FieldType
RateRequired
text
Output fields[3]
FieldType
Rate IDtext
Rate Typetext
Carrier IDtext
Shipping Amountobject
Currencytext
Amountnumber
Insurance Amountobject
Currencytext
Amountnumber
Confirmation Amountobject
Currencytext
Amountnumber
Other Amountobject
Currencytext
Amountnumber
Requested Comparison Amountobject
Currencytext
Amountnumber
Tax Amountobject
Currencytext
Amountnumber
Rate Detailsarray
Rate Detailobject
Zonenumber

16other output fields

Get a Service Point

SearchSingle drop-off location.
Input fields[3]
FieldType
Carrier CodeRequired
text
Country CodeRequired
text
Service Point IDRequired
text
Output fields[3]
FieldType
Service Pointobject
Carrier Codetext
Service Codesarray
Service Point IDtext
Company Nametext
Address Line1text
City Localitytext
State Provincetext
Postal Codetext
Country Codetext
Phone Numbertext

Get a Shipment

SearchCarrier and items of a shipment.
Input fields[3]
FieldType
ShipmentRequired
text
Output fields[3]
FieldType
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Itemobject
Tax Identifiersarray
Tax Identifierobject
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Created Attext

17other output fields

Get a Shipment by External ID

SearchShipment lookup through your own ID.
Input fields[3]
FieldType
External Shipment IDRequired
text
Output fields[3]
FieldType
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Itemobject
Tax Identifiersarray
Tax Identifierobject
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Created Attext

17other output fields

Get a Warehouse

SearchShip-from address details.
Input fields[3]
FieldType
WarehouseRequired
choice
Output fields[3]
FieldType
Warehouse IDtext
Is Defaultboolean
Nametext
Created Atdate
Origin Addressobject
Nametext
Phonetext
Emailtext
Company Nametext
Address Line1text
Address Line2text
Address Line3text
City Localitytext
State Provincetext
Postal Codetext
Return Addressobject
Nametext
Phonetext
Emailtext
Company Nametext
Address Line1text
Address Line2text
Address Line3text
City Localitytext
State Provincetext
Postal Codetext

Get a Webhook

SearchSettings of an event subscription.
Input fields[3]
FieldType
WebhookRequired
choice
Output fields[3]
FieldType
Webhook IDtext
URLtext
Eventtext
Nametext
Store IDnumber

Get Account Settings

SearchAccount wide label defaults.
Output fields[3]
FieldType
Default Label Layouttext

Get an Account Image

SearchStored label image and its type.
Input fields[3]
FieldType
Label ImageRequired
choice
Output fields[3]
FieldType
Label Image IDtext
Nametext
Is Defaultboolean
Image Content Typetext
Image Datatext
Created Attext
Modified Attext

Get an Ephemeral Token

ActionTemporary token for embedded access.
Input fields[3]
FieldType
Redirectchoice
Output fields[3]
FieldType
Tokentext
Redirect URLtext

Get Bulk Rates

ActionRates for a whole group.
Input fields[3]
FieldType
CarriersRequired
choice
Shipment IDsarray
Shipment IDtext
Shipments (JSON)text
Output fields[3]
FieldType
Resultsarray
Resultobject

Get Carrier Options

SearchOptional services of a carrier.
Input fields[3]
FieldType
CarrierRequired
choice
Output fields[3]
FieldType
Optionsarray
Optionobject

Get Carrier Settings

SearchPreferences saved for one carrier.
Input fields[3]
FieldType
Carrier NameRequired
choice
CarrierRequired
choice
Output fields[3]
FieldType
Nicknametext
Should Hide Account Number On Archive Docboolean
Is Primary Accountboolean

Get Shipping Rates

ActionPrice quotes across carriers.
Input fields[3]
FieldType
CarriersRequired
choice
Shipment IDtext
Service Codesarray
Service codetext
Package Typesarray
Package typetext
Calculate Taxboolean
Preferred Currencytext
Return Shipmentboolean
Rate Typechoice
Ship Datedate
Warehousechoice
External Shipment IDtext

51other input fields

Output fields[3]
FieldType
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Itemobject
Tax Identifiersarray
Tax Identifierobject
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Created Attext

18other output fields

Get the Insurance Balance

SearchRemaining funds for insured shipments.
Output fields[3]
FieldType
Currencytext
Amountnumber

Get Tracking

SearchCurrent parcel position and link.
Input fields[3]
FieldType
CarrierRequired
choice
Tracking NumberRequired
text
Output fields[3]
FieldType
Tracking Numbertext
Tracking URLtext
Status Codetext
Status Detail Codetext
Carrier Codetext
Carrier IDnumber
Status Descriptiontext
Status Detail Descriptiontext
Carrier Status Codetext
Carrier Detail Codetext
Carrier Status Descriptiontext

5other output fields

List Account Images

SearchLabel images stored on your account.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Label Image IDtext
Nametext
Is Defaultboolean
Image Content Typetext
Image Datatext
Created Attext
Modified Attext

List Batch Errors

SearchFailures inside one batch.
Input fields[3]
FieldType
BatchRequired
text
LimitRequired
number
Output fields[3]
FieldType
Errortext
Shipment IDtext
External Shipment IDtext

List Batches

SearchBulk label groups in your account.
Input fields[3]
FieldType
LimitRequired
number
Statuschoice
Batch Numbertext
Created Fromdate
Created Untildate
Processed Fromdate
Processed Untildate
Sort Bychoice
Sort Directionchoice
Output fields[3]
FieldType
Label Layouttext
Label Formattext
Batch IDtext
Batch Numbertext
External Batch IDtext
Batch Notestext
Created Attext
Processed Attext
Errorsnumber
Process Errorsarray
Process Errorobject
Warningsnumber

10other output fields

List Carrier Package Types

SearchBoxes a carrier accepts.
Input fields[3]
FieldType
CarrierRequired
choice
Output fields[3]
FieldType
Package IDtext
Package Codetext
Nametext
Dimensionsobject
Unittext
Lengthnumber
Widthnumber
Heightnumber
Descriptiontext

List Carrier Services

SearchDelivery options of a carrier.
Input fields[3]
FieldType
CarrierRequired
choice
Output fields[3]
FieldType
Carrier IDtext
Carrier Codetext
Service Codetext
Nametext
Domesticboolean
Internationalboolean
Is Multi Package Supportedboolean
Is Return Supportedboolean

List Carriers

SearchCarrier accounts you connected.
Output fields[3]
FieldType
Carrier IDtext
Carrier Codetext
Account Numbertext
Requires Funded Amountboolean
Balancenumber
Nicknametext
Friendly Nametext
Funding Source IDtext
Primaryboolean
Has Multi Package Supporting Servicesboolean
Allows Returnsboolean

8other output fields

List Label Documents

SearchTypes and statuses of label paperwork.
Input fields[3]
FieldType
LabelRequired
text
Output fields[3]
FieldType
Document IDtext
Typetext
File Nametext
Statustext

List Labels

SearchPurchased labels with their status.
Input fields[3]
FieldType
LimitRequired
number
Label Statuschoice
Service Codetext
Carrierchoice
Tracking Numbertext
Batch IDtext
Rate IDtext
Shipment IDtext
Warehousechoice
Created Fromdate
Created Untildate

3other input fields

Output fields[3]
FieldType
Label IDtext
Statustext
Shipment IDtext
External Shipment IDtext
External Order IDtext
Shipmentobject
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Tax Identifiersarray
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Ship Datetext
Created Attext
Shipment Costobject
Currencytext
Amountnumber
Insurance Costobject
Currencytext
Amountnumber
Requested Comparison Amountobject
Currencytext
Amountnumber

35other output fields

List Manifests

SearchManifests with their form and ship date.
Input fields[3]
FieldType
LimitRequired
number
Warehousechoice
Carrierchoice
Ship Date Fromdate
Ship Date Untildate
Created Fromdate
Created Untildate
Label IDsarray
Label IDtext
Output fields[3]
FieldType
Manifest IDtext
Form IDtext
Created Atdate
Ship Datedate
Shipmentsnumber
Label Idsarray
Warehouse IDtext
Submission IDtext
Carrier IDtext
Manifest Downloadobject
Hreftext

List Package Types

SearchBoxes you defined yourself.
Output fields[3]
FieldType
Package IDtext
Package Codetext
Nametext
Dimensionsobject
Unittext
Lengthnumber
Widthnumber
Heightnumber
Descriptiontext

List Scheduled Pickups

SearchPickups booked with your carriers.
Input fields[3]
FieldType
LimitRequired
number
Carrierchoice
Warehousechoice
Created Fromdate
Created Untildate
Output fields[3]
FieldType
Pickup IDtext
Label Idsarray
Created Attext
Cancelled Attext
Carrier IDtext
Confirmation Numbertext
Warehouse IDtext
Pickup Addressobject
Nametext
Phonetext
Emailtext
Company Nametext
Address Line1text
Address Line2text
Address Line3text
City Localitytext
State Provincetext
Postal Codetext
Contact Detailsobject
Nametext
Emailtext
Phonetext
Pickup Notestext
Pickup Windowobject
Start Attext
End Attext

1other output field

List Service Points

SearchNearby carrier drop-off spots.
Input fields[3]
FieldType
Providers (JSON)Required
text
Address Querytext
Country Codetext
Postal Codetext
Citytext
State or Provincetext
Address Line 1text
Latitudenumber
Longitudenumber
Radiusnumber
Max Resultsnumber
Output fields[3]
FieldType
Latnumber
Longnumber
Service Pointsarray
Service Pointobject
Errorsarray
Errorobject

List Shipment Documents

SearchStored shipment documents with their types.
Input fields[3]
FieldType
ShipmentRequired
text
Output fields[3]
FieldType
Document IDtext
Typetext
File Nametext
Statustext

List Shipment Rates

SearchQuotes stored on a shipment.
Input fields[3]
FieldType
ShipmentRequired
text
Created Fromdate
Output fields[3]
FieldType
Ratesarray
Rateobject
Invalid Ratesarray
Invalid Rateobject
Rate Request IDtext
Shipment IDtext
Created Atdate
Statustext
Errorsarray
Errorobject

List Shipment Tags

SearchTag names placed on a shipment.
Input fields[3]
FieldType
ShipmentRequired
text
Output fields[3]
FieldType
Nametext

List Shipments

SearchShipments across your account.
Input fields[3]
FieldType
LimitRequired
number
Shipment Statuschoice
Batch IDtext
Tagtext
Sales Order IDtext
Created Fromdate
Created Untildate
Modified Fromdate
Modified Untildate
Sort Bychoice
Sort Directionchoice
Output fields[3]
FieldType
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Itemobject
Tax Identifiersarray
Tax Identifierobject
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Created Attext

17other output fields

List Tags

SearchTags with their name and color.
Output fields[3]
FieldType
Tag IDnumber
Nametext
Colortext

List Warehouses

SearchYour ship-from addresses.
Output fields[3]
FieldType
Warehouse IDtext
Is Defaultboolean
Nametext
Created Atdate
Origin Addressobject
Nametext
Phonetext
Emailtext
Company Nametext
Address Line1text
Address Line2text
Address Line3text
City Localitytext
State Provincetext
Postal Codetext
Return Addressobject
Nametext
Phonetext
Emailtext
Company Nametext
Address Line1text
Address Line2text
Address Line3text
City Localitytext
State Provincetext
Postal Codetext

List Webhooks

SearchWhere ShipEngine sends events.
Output fields[3]
FieldType
Webhook IDtext
URLtext
Eventtext
Nametext
Store IDnumber

Parse a Shipment

SearchShipment data extracted from loose text.
Input fields[3]
FieldType
TextRequired
text
Shipment Hints (JSON)text
Output fields[3]
FieldType
Scorenumber
Shipmentobject
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Tax Identifiersarray
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Entitiesarray
Entitieobject

Parse an Address

SearchStructured address from loose text.
Input fields[3]
FieldType
TextRequired
text
Address Hints (JSON)text
Output fields[3]
FieldType
Scorenumber
Addressobject
Nametext
Phonetext
Emailtext
Company Nametext
Address Line1text
Address Line2text
Address Line3text
City Localitytext
State Provincetext
Postal Codetext
Entitiesarray
Entitieobject

Add a Tag to a Shipment

ActionPuts a tag on a parcel record.
Input fields[3]
FieldType
ShipmentRequired
text
TagRequired
choice
Output fields[3]
FieldType
Tagsarray

Add Funds to a Carrier

ActionAdds money to a carrier account balance.
Input fields[3]
FieldType
CarrierRequired
choice
CurrencyRequired
text
AmountRequired
number
Output fields[3]
FieldType
Balanceobject
Currencytext
Amountnumber

Add Funds to Insurance

ActionAdds money to the Shipsurance funds.
Input fields[3]
FieldType
CurrencyRequired
text
AmountRequired
number
Output fields[3]
FieldType
Currencytext
Amountnumber

Add to a Batch

ActionAdds shipments or rates to a batch.
Input fields[3]
FieldType
BatchRequired
text
Shipment IDsarray
Shipment IDtext
Rate IDsarray
Rate IDtext
Output fields[3]
FieldType
Successboolean

Cancel a Label Refund

ActionReverses a label refund request.
Input fields[3]
FieldType
LabelRequired
text
Output fields[3]
FieldType
Label IDtext
Statustext
Shipment IDtext
External Shipment IDtext
External Order IDtext
Shipmentobject
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Tax Identifiersarray
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Ship Datetext
Created Attext
Shipment Costobject
Currencytext
Amountnumber
Insurance Costobject
Currencytext
Amountnumber
Requested Comparison Amountobject
Currencytext
Amountnumber

35other output fields

Cancel a Shipment

ActionVoids a saved shipment record.
Input fields[3]
FieldType
ShipmentRequired
text
Output fields[3]
FieldType
Successboolean

Connect a Carrier

ActionBrings a carrier into ShipEngine.
Input fields[3]
FieldType
CarrierRequired
choice
CredentialsRequired
array
Credentialobject
Nicknametext
Output fields[3]
FieldType
Carrier IDtext

Connect an Insurer

ActionAttaches Shipsurance to your account.
Input fields[3]
FieldType
EmailRequired
text
Policy IDRequired
text

Create a Batch

ActionGroup of shipments for bulk labels.
Input fields[3]
FieldType
External Batch IDtext
Batch Notestext
Shipment IDsarray
Shipment IDtext
Rate IDsarray
Rate IDtext
Process Labelsboolean
Ship Datedate
Label Layoutchoice
Label Formatchoice
Output fields[3]
FieldType
Label Layouttext
Label Formattext
Batch IDtext
Batch Numbertext
External Batch IDtext
Batch Notestext
Created Attext
Processed Attext
Errorsnumber
Process Errorsarray
Process Errorobject
Warningsnumber

10other output fields

Create a Combined Label Document

ActionSingle print file for many labels.
Input fields[3]
FieldType
Label IDsRequired
array
Label IDtext
Label Download Typechoice
Output fields[3]
FieldType
Label Downloadobject
Hreftext
Pdftext
Pngtext
Zpltext

Create a Label

ActionLabel bought from addresses and packages.
Input fields[3]
FieldType
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
Packageobject
Ship Datedate
Warehousechoice

56other input fields

Output fields[3]
FieldType
Label IDtext
Statustext
Shipment IDtext
External Shipment IDtext
External Order IDtext
Shipmentobject
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Tax Identifiersarray
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Ship Datetext
Created Attext
Shipment Costobject
Currencytext
Amountnumber
Insurance Costobject
Currencytext
Amountnumber
Requested Comparison Amountobject
Currencytext
Amountnumber

35other output fields

Create a Label from a Rate

ActionLabel for a chosen price quote.
Input fields[3]
FieldType
Rate IDRequired
text
Custom Field 1text
Custom Field 2text
Custom Field 3text
Validate Addresschoice
Test Labelboolean
Label Formatchoice
Label Layoutchoice
Display Schemechoice
Label Download Typechoice
Output fields[3]
FieldType
Label IDtext
Statustext
Shipment IDtext
External Shipment IDtext
External Order IDtext
Shipmentobject
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Tax Identifiersarray
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Ship Datetext
Created Attext
Shipment Costobject
Currencytext
Amountnumber
Insurance Costobject
Currencytext
Amountnumber
Requested Comparison Amountobject
Currencytext
Amountnumber

35other output fields

Create a Label from a Rate Shopper

ActionLabel bought through rate shopping.
Input fields[3]
FieldType
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
Packageobject
Ship Datedate
Warehousechoice
External Shipment IDtext

55other input fields

Output fields[3]
FieldType
Rate Shopper IDtext
Label IDtext
Statustext
Shipment IDtext
External Shipment IDtext
External Order IDtext
Shipmentobject
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Tax Identifiersarray
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Ship Datetext
Created Attext
Shipment Costobject
Currencytext
Amountnumber
Insurance Costobject
Currencytext
Amountnumber

36other output fields

Create a Label from a Shipment

ActionLabel for an already saved shipment.
Input fields[3]
FieldType
Shipment IDRequired
text
Validate Addresschoice
Test Labelboolean
Label Formatchoice
Label Layoutchoice
Display Schemechoice
Label Download Typechoice
Output fields[3]
FieldType
Label IDtext
Statustext
Shipment IDtext
External Shipment IDtext
External Order IDtext
Shipmentobject
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Tax Identifiersarray
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Ship Datetext
Created Attext
Shipment Costobject
Currencytext
Amountnumber
Insurance Costobject
Currencytext
Amountnumber
Requested Comparison Amountobject
Currencytext
Amountnumber

35other output fields

Create a Manifest

ActionManifest for the labels of a carrier.
Input fields[3]
FieldType
CarrierRequired
choice
Warehousechoice
Ship Datedate
Label IDsarray
Label IDtext
Excluded Label IDsarray
Label IDtext
Output fields[3]
FieldType
Manifestsarray
Manifestobject
Manifest Requestsarray
Manifest Requestobject
Manifest IDtext
Form IDtext
Created Atdate
Ship Datedate
Shipmentsnumber
Warehouse IDtext
Submission IDtext
Carrier IDtext
Manifest Downloadobject
Hreftext

3other output fields

Create a Package Type

ActionReusable box definition with dimensions.
Input fields[3]
FieldType
NameRequired
text
Package CodeRequired
text
Descriptiontext
Dimension Unitchoice
Lengthnumber
Widthnumber
Heightnumber
Output fields[3]
FieldType
Package IDtext
Package Codetext
Nametext
Dimensionsobject
Unittext
Lengthnumber
Widthnumber
Heightnumber
Descriptiontext

Create a Return Label

ActionLabel for sending an item back.
Input fields[3]
FieldType
Label IDRequired
text
RMA Numbertext
Charge Eventchoice
Test Labelboolean
Label Formatchoice
Label Layoutchoice
Display Schemechoice
Label Download Typechoice
Output fields[3]
FieldType
Label IDtext
Statustext
Shipment IDtext
External Shipment IDtext
External Order IDtext
Shipmentobject
Shipment IDtext
Carrier IDtext
Service Codetext
Shipping Rule IDtext
External Order IDtext
Itemsarray
Tax Identifiersarray
External Shipment IDtext
Shipment Numbertext
Ship Datetext
Ship Datetext
Created Attext
Shipment Costobject
Currencytext
Amountnumber
Insurance Costobject
Currencytext
Amountnumber
Requested Comparison Amountobject
Currencytext
Amountnumber

35other output fields

Create a Shipment

ActionShipment record without a label.
Input fields[3]
FieldType
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
Packageobject
Carrierchoice
Servicechoice
Ship Datedate
Warehousechoice

45other input fields

Output fields[3]
FieldType
Has Errorsboolean
Shipmentsarray
Shipmentobject

Create a Tag

ActionNew tag with a chosen name and optional color.
Input fields[3]
FieldType
NameRequired
text
Colortext
Output fields[3]
FieldType
Tag IDnumber
Nametext
Colortext

Create a Warehouse

ActionShip-from address on file.
Input fields[3]
FieldType
NameRequired
text
Origin Address Line 1Required
text
Origin CityRequired
text
Origin State or ProvinceRequired
text
Origin Postal CodeRequired
text
Origin Country CodeRequired
text
Origin Nametext
Origin Phonetext
Origin Companytext
Origin Address Line 2text
Origin Address Line 3text

11other input fields

Output fields[3]
FieldType
Warehouse IDtext
Is Defaultboolean
Nametext
Created Atdate
Origin Addressobject
Nametext
Phonetext
Emailtext
Company Nametext
Address Line1text
Address Line2text
Address Line3text
City Localitytext
State Provincetext
Postal Codetext
Return Addressobject
Nametext
Phonetext
Emailtext
Company Nametext
Address Line1text
Address Line2text
Address Line3text
City Localitytext
State Provincetext
Postal Codetext

Create a Webhook

ActionEvent subscription for a URL.
Input fields[3]
FieldType
EventRequired
choice
URLRequired
text
Nametext
Store IDnumber
Headersarray
Rowobject
Output fields[3]
FieldType
Webhook IDtext
URLtext
Eventtext
Nametext
Store IDnumber

Create an Account Image

ActionNew image for your printed labels.
Input fields[3]
FieldType
NameRequired
text
Image Content TypeRequired
choice
Image Data (base64)Required
text
Default Imageboolean
Output fields[3]
FieldType
Label Image IDtext
Nametext
Is Defaultboolean
Image Content Typetext
Image Datatext
Created Attext
Modified Attext

Delete a Batch

ActionBatch removal from the account.
Input fields[3]
FieldType
BatchRequired
text
Output fields[3]
FieldType
Successboolean

Delete a Label Document

ActionRegistered label document deleted.
Input fields[3]
FieldType
LabelRequired
text
DocumentRequired
text
Output fields[3]
FieldType
Successboolean

Delete a Package Type

ActionCustom box definition deleted.
Input fields[3]
FieldType
Package TypeRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Scheduled Pickup

ActionCarrier pickup booking cancelled.
Input fields[3]
FieldType
PickupRequired
text
Output fields[3]
FieldType
Pickup IDtext
Successboolean

Delete a Shipment Document

ActionPaperwork taken off a shipment.
Input fields[3]
FieldType
ShipmentRequired
text
DocumentRequired
text
Output fields[3]
FieldType
Successboolean

Delete a Tag

ActionShipment tag removed from your tags.
Input fields[3]
FieldType
TagRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Warehouse

ActionShip-from address removed.
Input fields[3]
FieldType
WarehouseRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Webhook

ActionEvent subscription removed from your account.
Input fields[3]
FieldType
WebhookRequired
choice
Output fields[3]
FieldType
Successboolean

Delete an Account Image

ActionLabel image removed from your account.
Input fields[3]
FieldType
Label ImageRequired
choice
Output fields[3]
FieldType
Successboolean

Disconnect a Carrier

ActionCarrier account unplugged from ShipEngine.
Input fields[3]
FieldType
CarrierRequired
choice
Output fields[3]
FieldType
Successboolean

Disconnect an Insurer

ActionInsurance policy disconnected from ShipEngine.
Output fields[3]
FieldType
Successboolean

Estimate Rates

ActionQuick price check between locations.
Input fields[3]
FieldType
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

Output fields[3]
FieldType
Resultsarray
Resultobject

Make an API Call

universalCustom ShipEngine REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Keytext
Valuetext
Status codenumber

Process Batch Labels

ActionBulk purchase for a batch.
Input fields[3]
FieldType
BatchRequired
text
Ship Datedate
Label Layoutchoice
Label Formatchoice
Display Schemechoice
Output fields[3]
FieldType
Successboolean

Register a Label Document

ActionDocument entry for a label with its type and file name.
Input fields[3]
FieldType
LabelRequired
text
Document TypeRequired
choice
File NameRequired
text
Formatchoice
Filetext
Output fields[3]
FieldType
Document IDtext
Statustext
File Uploadedboolean

Register a Shipment Document

ActionDocument entry for a shipment with type and format.
Input fields[3]
FieldType
ShipmentRequired
text
Document TypeRequired
choice
File NameRequired
text
Formatchoice
Filetext
Output fields[3]
FieldType
Document IDtext
Statustext
File Uploadedboolean

Remove a Tag from a Shipment

ActionShipment tag detached by name.
Input fields[3]
FieldType
ShipmentRequired
text
TagRequired
choice
Output fields[3]
FieldType
Successboolean

Remove from a Batch

ActionSubtracts shipments or rates from a batch.
Input fields[3]
FieldType
BatchRequired
text
Shipment IDsarray
Shipment IDtext
Rate IDsarray
Rate IDtext
Output fields[3]
FieldType
Successboolean

Rename a Tag

ActionRetitles a shipment tag.
Input fields[3]
FieldType
TagRequired
choice
New NameRequired
text
Output fields[3]
FieldType
Successboolean

Schedule a Pickup

ActionCarrier pickup booked for labels.
Input fields[3]
FieldType
Label IDsRequired
array
Label IDtext
Contact NameRequired
text
Contact EmailRequired
text
Contact PhoneRequired
text
Window StartRequired
date
Window EndRequired
date
Warehousechoice
Pickup Notestext
Output fields[3]
FieldType
Pickup IDtext
Label Idsarray
Created Attext
Cancelled Attext
Carrier IDtext
Confirmation Numbertext
Warehouse IDtext
Pickup Addressobject
Nametext
Phonetext
Emailtext
Company Nametext
Address Line1text
Address Line2text
Address Line3text
City Localitytext
State Provincetext
Postal Codetext
Contact Detailsobject
Nametext
Emailtext
Phonetext
Pickup Notestext
Pickup Windowobject
Start Attext
End Attext

3other output fields

Send Label Documents

ActionPushes label paperwork to the carrier.
Input fields[3]
FieldType
LabelRequired
text
Output fields[3]
FieldType
Successboolean

Set the Default Warehouse

ActionDefault ship-from address.
Input fields[3]
FieldType
WarehouseRequired
choice
Default Warehouseboolean
Output fields[3]
FieldType
Successboolean

Start Tracking

ActionSubscribes to parcel updates.
Input fields[3]
FieldType
CarrierRequired
choice
Tracking NumberRequired
text
Output fields[3]
FieldType
Successboolean

Stop Tracking

ActionUnsubscribes from parcel updates.
Input fields[3]
FieldType
CarrierRequired
choice
Tracking NumberRequired
text
Output fields[3]
FieldType
Successboolean

Update a Package Type

ActionBox definition changed in place.
Input fields[3]
FieldType
Package TypeRequired
choice
Nametext
Package Codetext
Descriptiontext
Dimension Unitchoice
Lengthnumber
Widthnumber
Heightnumber
Clear Fieldschoice
Output fields[3]
FieldType
Successboolean

Update a Shipment

ActionSaved shipment adjusted in place.
Input fields[3]
FieldType
ShipmentRequired
text
Carrierchoice
Servicechoice
Ship Datedate
Warehousechoice
External Shipment IDtext
External Order IDtext
Shipment Numbertext
Confirmationchoice
Insurance Providerchoice
Ship To Nametext

46other input fields

Output fields[3]
FieldType
Successboolean

Update a Warehouse

ActionShip-from address edited.
Input fields[3]
FieldType
WarehouseRequired
choice
Nametext
Origin Nametext
Origin Phonetext
Origin Companytext
Origin Address Line 1text
Origin Address Line 2text
Origin Address Line 3text
Origin Citytext
Origin State or Provincetext
Origin Postal Codetext

12other input fields

Output fields[3]
FieldType
Successboolean

Update a Webhook

ActionSubscription settings changed in place.
Input fields[3]
FieldType
WebhookRequired
choice
URLtext
Nametext
Store IDnumber
Headersarray
Rowobject
Clear Fieldschoice
Output fields[3]
FieldType
Successboolean

Update an Account Image

ActionEdits a stored label image.
Input fields[3]
FieldType
Label ImageRequired
choice
Default Imagechoice
Nametext
Image Content Typechoice
Image Data (base64)text
Output fields[3]
FieldType
Successboolean

Update Carrier Settings

ActionCarrier account preferences edited.
Input fields[3]
FieldType
CarrierRequired
choice
CarrierRequired
choice
Nicknametext
Account Postal Codetext
Emailtext
Mail Innovations Cost Centertext
Primary Accountchoice
Use Negotiated Rateschoice
Email on Manifest Processingchoice
Carbon Neutral Shippingchoice
Ground Freight Pricingchoice

10other input fields

Output fields[3]
FieldType
Successboolean

Update Shipments Tags

ActionBulk tag assignment across shipments.
Input fields[3]
FieldType
ShipmentsRequired
array
Shipmentobject
Output fields[3]
FieldType
Shipmentsarray
Successboolean

Validate an Address

ActionCleaned and verified address.
Input fields[3]
FieldType
Address Line 1Required
text
CityRequired
text
State or ProvinceRequired
text
Country CodeRequired
text
Nametext
Phonetext
Emailtext
Companytext
Address Line 2text
Address Line 3text
Postal Codetext

2other input fields

Output fields[3]
FieldType
Resultsarray
Resultobject
Statustext
Original Addresstext
Matched Addresstext
Messagesarray

Void a Label

ActionRefund request for a label.
Input fields[3]
FieldType
LabelRequired
text
Output fields[3]
FieldType
Approvedboolean
Messagetext
Reason Codetext

Look for ShipEngine templates in the WEXTL template library.

Browse templates →
  1. WEXTL® ShipEngine Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for ShipEngine.
  4. 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.