Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

createAccountImage

account.createAccountImage Create an Account Image Risk: write
Input The provider expects image_data as a Base64-encoded string in a JSON body (PNG or JPEG); this is not a multipart upload.
Output

deleteAccountImageById

account.deleteAccountImageById Delete Account Image By Id Risk: destructive
Input Delete Account Image By Id deletes, disconnects, cancels, or otherwise changes an account resource in a way that may be difficult to reverse. Verify the target before calling.
Output: string \| undefined

getAccountSettingsImagesById

account.getAccountSettingsImagesById Get Account Image By ID Risk: read
Input
Output

listAccountImages

account.listAccountImages List Account Images Risk: read
Input: empty object Output

listAccountSettings

account.listAccountSettings List Account Settings Risk: read
Input: empty object Output

updateAccountSettingsImagesById

account.updateAccountSettingsImagesById Update Account Image By ID Risk: write
Input
Output: string \| undefined

Addresses

parseAddress

addresses.parseAddress Parse an address Risk: read
Input
Output

validateAddress

addresses.validateAddress Validate An Address Risk: read
Input
Output: object[]

Batches

addToBatch

batches.addToBatch Add to a Batch Risk: write
Input
Output: string \| undefined

createBatch

batches.createBatch Create a batch. Setting process_labels.create_batch_and_process_labels purchases labels and may charge the account. Risk: destructive
Input The optional process_labels.create_batch_and_process_labels flag processes label purchases as part of batch creation and can incur carrier charges. This endpoint is marked destructive.
Output

deleteBatch

batches.deleteBatch Delete Batch By Id Risk: destructive
Input Delete Batch By Id deletes, disconnects, cancels, or otherwise changes an account resource in a way that may be difficult to reverse. Verify the target before calling.
Output: string \| undefined

getBatchByExternalId

batches.getBatchByExternalId Get Batch By External ID Risk: read
Input
Output

getBatchById

batches.getBatchById Get Batch By ID Risk: read
Input
Output

listBatchErrors

batches.listBatchErrors Get Batch Errors Risk: read
Input
Output

listBatches

batches.listBatches List Batches Risk: read
Input
Output

processBatch

batches.processBatch Process Batch ID Labels Risk: destructive
Input Process Batch ID Labels purchases one or more carrier labels and can incur shipping charges. ShipStation wallet-carrier costs are deducted from the account balance; merchant carrier accounts follow carrier billing terms. Verify the rate before using a production key.
Output: string \| undefined

removeFromBatch

batches.removeFromBatch Remove From Batch Risk: write
Input
Output: string \| undefined

Carrier Accounts

connectCarrier

carrierAccounts.connectCarrier Connect a carrier account Risk: write
Input
Output

disconnectCarrier

carrierAccounts.disconnectCarrier Disconnect a carrier Risk: destructive
Input Disconnect a carrier deletes, disconnects, cancels, or otherwise changes an account resource in a way that may be difficult to reverse. Verify the target before calling.
Output: string \| undefined

getCarrierSettings

carrierAccounts.getCarrierSettings Get carrier settings Risk: read
Input
Output: object

updateCarrierSettings

carrierAccounts.updateCarrierSettings Update carrier settings Risk: write
Input
Output: string \| undefined

Carriers

addFundsToCarrier

carriers.addFundsToCarrier Add Funds To Carrier Risk: destructive
Input Add Funds To Carrier transfers money into a carrier or Shipsurance balance. Confirm the amount and funding account before using a production key.
Output

disconnectCarrierById

carriers.disconnectCarrierById Disconnect Carrier by ID Risk: destructive
Input Disconnect Carrier by ID deletes, disconnects, cancels, or otherwise changes an account resource in a way that may be difficult to reverse. Verify the target before calling.
Output: string \| undefined

getCarrierById

carriers.getCarrierById Get Carrier By ID Risk: read
Input
Output

getCarrierOptions

carriers.getCarrierOptions Get Carrier Options Risk: read
Input
Output

listCarrierPackageTypes

carriers.listCarrierPackageTypes List Carrier Package Types Risk: read
Input
Output

listCarriers

carriers.listCarriers List Carriers Risk: read
Input: empty object Output

listCarrierServices

carriers.listCarrierServices List Carrier Services Risk: read
Input The provider’s List Carrier Services route example returns carrier_code values such as stamps_com. The OpenAPI se_id pattern on this field conflicts with that route example; the plugin validates it as a carrier code.
Output

Downloads

downloadFile

downloads.downloadFile Download File Risk: read
Input Binary download uses a custom byte-preserving transport because the shared Corsair JSON transport decodes binary bodies as text. The validated return value is Base64 with a 50 MiB safety limit.
Output

Insurance

addFundsToInsurance

insurance.addFundsToInsurance Add Funds To Insurance Risk: destructive
Input Add Funds To Insurance transfers money into a carrier or Shipsurance balance. Confirm the amount and funding account before using a production key.
Output

connectInsurer

insurance.connectInsurer Connect a Shipsurance Account Risk: write
Input
Output: Record<string, JsonValue>

disconnectInsurer

insurance.disconnectInsurer Disconnect a Shipsurance Account Risk: destructive
Input: empty object Disconnect a Shipsurance Account deletes, disconnects, cancels, or otherwise changes an account resource in a way that may be difficult to reverse. Verify the target before calling. Output: Record<string, JsonValue>

getInsuranceBalance

insurance.getInsuranceBalance Get Insurance Funds Balance Risk: read
Input: empty object Output

Labels

cancelLabelRefund

labels.cancelLabelRefund Cancel a label refund request Risk: write
Input
Output

createCombinedLabelDocument

labels.createCombinedLabelDocument Created Combined Label Document Risk: write
Input
Output

createLabel

labels.createLabel Purchase Label Risk: destructive
Input Purchase Label purchases one or more carrier labels and can incur shipping charges. ShipStation wallet-carrier costs are deducted from the account balance; merchant carrier accounts follow carrier billing terms. Verify the rate before using a production key.
Output

createLabelFromRate

labels.createLabelFromRate Purchase Label with Rate ID Risk: destructive
Input Purchase Label with Rate ID purchases one or more carrier labels and can incur shipping charges. ShipStation wallet-carrier costs are deducted from the account balance; merchant carrier accounts follow carrier billing terms. Verify the rate before using a production key.
Output

createLabelFromRateShopper

labels.createLabelFromRateShopper Purchase Label from Rate Shopper Risk: destructive
Input Purchase Label from Rate Shopper purchases one or more carrier labels and can incur shipping charges. ShipStation wallet-carrier costs are deducted from the account balance; merchant carrier accounts follow carrier billing terms. Verify the rate before using a production key.
Output

createLabelFromShipment

labels.createLabelFromShipment Purchase Label with Shipment ID Risk: destructive
Input Purchase Label with Shipment ID purchases one or more carrier labels and can incur shipping charges. ShipStation wallet-carrier costs are deducted from the account balance; merchant carrier accounts follow carrier billing terms. Verify the rate before using a production key.
Output

createReturnLabel

labels.createReturnLabel Create a return label Risk: destructive
Input Create a return label purchases one or more carrier labels and can incur shipping charges. ShipStation wallet-carrier costs are deducted from the account balance; merchant carrier accounts follow carrier billing terms. Verify the rate before using a production key.
Output

getLabelByExternalShipmentId

labels.getLabelByExternalShipmentId Get Label By External Shipment ID Risk: read
Input
Output

getLabelById

labels.getLabelById Get Label By ID Risk: read
Input
Output

getTrackingLogFromLabel

labels.getTrackingLogFromLabel Get Label Tracking Information Risk: read
Input
Output

listLabels

labels.listLabels List labels Risk: read
Input
Output

voidLabel

labels.voidLabel Void a Label By ID Risk: destructive
Input
Output

Manifests

createManifest

manifests.createManifest Create Manifest Risk: destructive
Input Create Manifest closes out the listed labels with the carrier. Some carriers (Royal Mail) do not let a manifested label be voided through the API, so check the label list before calling.
Output

getManifestById

manifests.getManifestById Get Manifest By Id Risk: read
Input
Output

getManifestRequestById

manifests.getManifestRequestById Get Manifest Request By Id Risk: read
Input
Output

listManifests

manifests.listManifests List Manifests Risk: read
Input
Output

Package Pickups

deleteScheduledPickup

packagePickups.deleteScheduledPickup Delete a Scheduled Pickup Risk: destructive
Input Delete a Scheduled Pickup deletes, disconnects, cancels, or otherwise changes an account resource in a way that may be difficult to reverse. Verify the target before calling.
Output

getPickupById

packagePickups.getPickupById Get Pickup By ID Risk: read
Input
Output

listScheduledPickups

packagePickups.listScheduledPickups List Scheduled Pickups Risk: read
Input
Output

schedulePickup

packagePickups.schedulePickup Schedule a Pickup Risk: destructive
Input Scheduling a carrier pickup may incur a carrier fee. Confirm pickup details and carrier charges before using a production key.
Output

Package Types

createPackageType

packageTypes.createPackageType Create Custom Package Type Risk: write
Input
Output

deletePackageType

packageTypes.deletePackageType Delete A Custom Package By ID Risk: destructive
Input Delete A Custom Package By ID deletes, disconnects, cancels, or otherwise changes an account resource in a way that may be difficult to reverse. Verify the target before calling.
Output: string \| undefined

getPackageTypeById

packageTypes.getPackageTypeById Get Custom Package Type By ID Risk: read
Input
Output

listPackageTypes

packageTypes.listPackageTypes List Custom Package Types Risk: read
Input: empty object Output

updatePackageType

packageTypes.updatePackageType Update Custom Package Type By ID Risk: write
Input
Output: string \| undefined

Rates

calculateRates

rates.calculateRates Get Shipping Rates Risk: read
Input
Output

compareBulkRates

rates.compareBulkRates Get Bulk Rates Risk: read
Input
Output: object[]

estimateRates

rates.estimateRates Estimate Rates Risk: read
Input
Output: object[]

getRateById

rates.getRateById Get Rate By ID Risk: read
Input
Output

Service Points

servicePointsGetById

servicePoints.servicePointsGetById Get Service Point By ID Risk: read
Input
Output

servicePointsList

servicePoints.servicePointsList List Service Points Risk: read
Input
Output

Shipments

cancelShipments

shipments.cancelShipments Cancel a Shipment Risk: destructive
Input Cancel a Shipment deletes, disconnects, cancels, or otherwise changes an account resource in a way that may be difficult to reverse. Verify the target before calling.
Output: string \| undefined

createShipments

shipments.createShipments Create Shipments Risk: write
Input
Output

getShipmentByExternalId

shipments.getShipmentByExternalId Get Shipment By External ID Risk: read
Input
Output

getShipmentById

shipments.getShipmentById Get Shipment By ID Risk: read
Input
Output

listShipmentRates

shipments.listShipmentRates Get Shipment Rates Risk: read
Input
Output: object[]

listShipments

shipments.listShipments List Shipments Risk: read
Input
Output

shipmentsUpdateTags

shipments.shipmentsUpdateTags Update Shipments Tags Risk: write
Input
Output: undefined

tagShipment

shipments.tagShipment Add Tag to Shipment Risk: write
Input
Output

untagShipment

shipments.untagShipment Remove Tag from Shipment Risk: destructive
Input Remove Tag from Shipment deletes, disconnects, cancels, or otherwise changes an account resource in a way that may be difficult to reverse. Verify the target before calling.
Output: string \| undefined

updateShipment

shipments.updateShipment Update Shipment By ID Risk: write
Input
Output

Tags

createTag

tags.createTag Create a New Tag Risk: write
Input
Output

createTagByName

tags.createTagByName Deprecated: create a tag by path name; use POST /v1/tags instead. Risk: write
Input This path-based tag creation operation is deprecated by ShipEngine; use POST /v1/tags (tags.createTag) instead.
Output

deleteTag

tags.deleteTag Delete Tag Risk: destructive
Input Delete Tag deletes, disconnects, cancels, or otherwise changes an account resource in a way that may be difficult to reverse. Verify the target before calling.
Output: string \| undefined

listTags

tags.listTags Get Tags Risk: read
Input: empty object Output

renameTag

tags.renameTag Update Tag Name Risk: write
Input
Output: string \| undefined

Tokens

tokensGetEphemeralToken

tokens.tokensGetEphemeralToken Get Ephemeral Token Risk: write
Input
Output

Tracking

getTrackingLog

tracking.getTrackingLog Get Tracking Information Risk: read
Input
Output

startTracking

tracking.startTracking Start Tracking a Package Risk: write
Input This starts provider tracking subscriptions. Webhook receiving/management remains out of scope; no incoming callback handler is registered by this plugin.
Output: string \| undefined

stopTracking

tracking.stopTracking Stop Tracking a Package Risk: write
Input This stops provider tracking subscriptions. Webhook receiving/management remains out of scope; no incoming callback handler is registered by this plugin.
Output: string \| undefined

Warehouses

createWarehouse

warehouses.createWarehouse Create Warehouse Risk: write
Input
Output

deleteWarehouse

warehouses.deleteWarehouse Delete Warehouse By ID Risk: destructive
Input Delete Warehouse By ID deletes, disconnects, cancels, or otherwise changes an account resource in a way that may be difficult to reverse. Verify the target before calling.
Output: string \| undefined

getWarehouseById

warehouses.getWarehouseById Get Warehouse By Id Risk: read
Input
Output

listWarehouses

warehouses.listWarehouses List Warehouses Risk: read
Input: empty object Output

updateWarehouse

warehouses.updateWarehouse Update Warehouse By Id Risk: write
Input
Output: string \| undefined