Connectors
E-commerce
ShipStation
Shipping: shipments, labels, rates, batches, inventory, and carriers
- Signs in with
- API key
- Runs on
- Cloud or On-Prem Worker
- Operations
- 173
- Ready-made triggers
- 0
Connect ShipStation
- In Neblex open Connect › Connections and click New Connection.
- Search for ShipStation and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| API keyRequiredSecret | ShipStation API v2 key from Settings, Account, API Settings. |
Use it in a flow
- Open a flow, open the node library and search for ShipStation.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from ShipStation without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if ShipStation can send webhooks, a Webhook trigger receives them at its own URL.
Operations
173 operations in 30 groups. Each one is a step you can add to a flow.
Account6
Create an account imagecreateAccountImage | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create an account image |
Delete account image by IDdeleteAccountImageById | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Delete account image by ID |
Get account image by IDgetAccountSettingsImagesById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve information for an account image |
List account imageslistAccountImages | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans List all account images for the ShipStation API account |
List account settingslistAccountSettings | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans List all account settings for the ShipStation API account |
Update account image by IDupdateAccountSettingsImagesById | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update information for an account image |
Addresses1
Validate an addressvalidateAddress | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Address validation ensures accurate addresses and can lead to... |
Batches12
Add to a batchaddToBatch | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Add a shipment or rate to a batch. |
Assign user to a batchassignUserToBatch | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Assign a user to a batch. |
Create a batchcreateBatch | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create a batch containing multiple labels. |
Delete batch by IDdeleteBatch | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Delete a batch based on its batch ID. |
Get batch by external idgetBatchByExternalId | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retreive a batch using an external batch ID |
Get batch by IDgetBatchById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get batch details for a specific batch ID. |
Get batch errorslistBatchErrors | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Errors in batches must be handled differently from synchronous... |
List batcheslistBatches | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans List the batches associated with your ShipStation account. |
Process batch ID labelsprocessBatch | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create and purchase the labels for the shipments included in the... |
Remove from batchremoveFromBatch | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Remove specific shipment ids or rate ids from a batch. |
Unassign user from a batchunassignUserFromBatch | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Remove the user assignment from a batch. |
Update batch status to 'archived' by IDupdateBatch | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update a batch by ID setting its status to 'archived'. |
Carriers7
Add funds to carrieraddFundsToCarrier | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Add funds to a carrier account. |
Disconnect carrier by IDdisconnectCarrierById | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Disconnect a carrier from the account by its carrier ID. |
Get carrier by IDgetCarrierById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrive details about a specific carrier by its carrier ID. |
Get carrier optionsgetCarrierOptions | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get a list of the options available for a specific carriers. |
List carrier package typeslistCarrierPackageTypes | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans List the package types associated with a specific carrier. |
List carrier serviceslistCarrierServices | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans List the services associated with a specific carrier ID. |
List carrierslistCarriers | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans List all carriers that have been added to this account. |
Checkout rates9
Add a delivery optionaddCheckoutRatesOption | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Add a delivery option to an existing checkout rates configuration. |
Calculate checkout ratescalculateCheckoutRates | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Calculate the shipping rates a buyer should see at checkout for... |
Create a checkout rates configurationcreateCheckoutRatesConfig | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create a checkout rates configuration together with its initial... |
Delete a delivery optiondeleteCheckoutRatesOption | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Marks a delivery option as inactive (is active: false) instead of... |
Get a checkout rate quotegetCheckoutRatesQuote | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve a previously calculated rate quote, including the... |
Get a checkout rates configurationgetCheckoutRatesConfig | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve a single checkout rates configuration, including all of... |
Get a delivery optiongetCheckoutRatesOption | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve a single delivery option belonging to a checkout rates... |
List checkout rates configurationslistCheckoutRatesConfigs | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Return a summary of every checkout rates configuration on your... |
Update a delivery optionupdateCheckoutRatesOption | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Replace the configuration of an existing delivery option. |
Connections4
Connect a carrier accountconnectCarrier | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Connect a carrier account |
Disconnect a carrierdisconnectCarrier | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Disconnect a carrier |
Get carrier settingsgetCarrierSettings | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get carrier settings |
Update carrier settingsupdateCarrierSettings | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update carrier settings |
Documents9
Delete a label documentdeleteLabelDocument | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Delete a carrier document registered against a label. |
Delete a shipment documentdeleteShipmentDocument | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Delete a carrier document registered against a shipment. |
Download a documentdownloadDocument | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Download the file for a previously registered carrier document. |
List documents for a labellistLabelDocuments | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve the carrier documents registered against a label,... |
List documents for a shipmentlistShipmentDocuments | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve the carrier documents registered against a shipment,... |
List shipments and their document statuseslistShipmentLabelDocuments | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve each shipment associated with the given id, including its... |
Register a document for a labelregisterLabelDocument | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Register a carrier document against a label. |
Register a document for a shipmentregisterShipmentDocument | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Register a carrier document against a shipment. |
Send label documentssendLabelDocuments | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Transmit all uploaded documents for a label to the carrier. |
Downloads1
Download filedownloadFile | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Download labels and other shipment-related documents. |
Freight12
Book a freight shipmentbookFreightShipment | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Book one of the offers returned by Get freight quotes. |
Cancel a freight shipmentcancelFreightShipment | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Cancel a booked freight shipment with the carrier. |
Connect a freight provider accountconnectFreightProviderAccount | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Connect a freight account the seller already holds with the provider. |
Disconnect a freight provider accountdisconnectFreightProviderAccount | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Disconnect a freight provider account, removing its stored... |
Get freight quotesgetFreightQuotes | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve freight rate offers for a shipment. |
Get freight shipment by IDgetFreightShipmentById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve a single freight shipment, including its current status,... |
Get freight shipment trackinggetFreightShipmentTracking | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve the current tracking status and event history for a... |
Get freight tracking by numbergetFreightTracking | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve tracking for a freight shipment by its PRO or BOL number,... |
List freight provider accountslistFreightProviderAccounts | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Return the freight provider accounts connected to your account. |
List freight shipment documentslistFreightShipmentDocuments | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans List the documents available for a freight shipment, such as the... |
List freight shipmentslistFreightShipments | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Return the freight shipments on your account, most recently... |
Update freight provider account credentialsupdateFreightProviderAccountCredentials | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Replace the credentials stored for a freight provider account -... |
Fulfillments2
Create fulfillmentscreateFulfillments | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create one or more fulfillments by marking shipments as shipped... |
List fulfillmentslistFulfillments | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve a list of fulfillments based on various filter criteria. |
Inventory12
Create a new inventory locationcreateInventoryLocation | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Create a new inventory warehouseaddNewInventoryWarehouse | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Delete an inventory locationdeleteInventoryLocationById | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Delete an inventory warehousedeleteInventoryWarehouse | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Get a specific inventory warehouse and related properties using its warehouse IDgetInventoryWarehouseById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Get inventory location by IDgetInventoryLocationById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
List all inventory locationslistInventoryLocations | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
List all inventory warehousesgetInventoryWarehouses | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
List SKU inventory levelsgetInventoryLevels | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Update an inventory locationupdateInventoryLocation | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Update an inventory warehouse nameupdateInventoryWarehouse | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Update SKU stock levels and related propertiesupdateSkuStockLevels | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Labels13
Cancel a label refund requestcancelLabelRefund | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Cancel a scheduled refund request for a label. |
Create a return labelcreateReturnLabel | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create a return label for a previously created outbound label. |
Created combined label documentcreateCombinedLabelDocument | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Download a combined label file |
Get label by external shipment IDgetLabelByExternalShipmentId | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Find a label by using the external shipment id that was used... |
Get label by IDgetLabelById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve a specific label by its label ID. |
Get label tracking informationgetTrackingLogFromLabel | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve the label's tracking details. |
List labelslistLabels | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans This method returns a list of labels that you've created. |
Purchase labelcreateLabel | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Purchase and print a label for shipment. |
Purchase label with rate idcreateLabelFromRate | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans When retrieving rates for shipments using the /rates endpoint, the... |
Purchase label with rate shoppercreateLabelFromRateShopper | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create a label using Rate Shopper to automatically select the best... |
Purchase label with shipment idcreateLabelFromShipment | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Purchase a label using a shipment ID that has already been created... |
Purchase label with shipping rulecreateLabelFromShippingRule | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Purchase and print a shipping label using a Shipping Rule. |
Void a label by IDvoidLabel | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Void a specific label using its label ID. |
Mailing3
Create envelopecreateEnvelope | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create a single envelope shipment. |
Create mailing labelscreateMailingLabels | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create one or more mailing labels on a sheet layout. |
Create netstampscreateNetstamps | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create one or more NetStamps. |
Manifests4
Create manifestcreateManifest | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Each ShipStation manifest is created for a specific warehouse, so... |
Get manifest by IDgetManifestById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get Manifest By Id |
Get manifest request by IDgetManifestRequestById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get Manifest Request By Id |
List manifestslistManifests | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Similar to querying shipments, we allow you to query manifests... |
Package pickups4
Delete a scheduled pickupdeleteScheduledPickup | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Delete a previously-scheduled pickup by ID |
Get pickup by IDgetPickupById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get Pickup By ID |
List scheduled pickupslistScheduledPickups | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans List all pickups that have been scheduled for this carrier |
Schedule a pickupschedulePickup | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Schedule a package pickup with a carrier |
Package types5
Create custom package typecreatePackageType | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create a custom package type to better assist in getting accurate... |
Delete a custom package by IDdeletePackageType | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Delete a custom package using the ID |
Get custom package type by IDgetPackageTypeById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get Custom Package Type by ID |
List custom package typeslistPackageTypes | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans List the custom package types associated with the account |
Update custom package type by IDupdatePackageType | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update the custom package type object by ID |
Products5
Create productscreateProducts | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Deactivate productsdeactivateProducts | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Get productgetProduct | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
List productslistProducts | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Update productupdateProducts | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Purchase orders9
Create a new purchase ordercreatePurchaseOrder | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create a new purchase order with products from a supplier. |
Get purchase order detailsgetPurchaseOrder | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve detailed information about a specific purchase order... |
Get purchase order received summary PDFgetPurchaseOrderReceivedSummaryPdf | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Download a PDF document containing the received products summary. |
Get purchase order summary PDFgetPurchaseOrderSummaryPdf | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Download a PDF document containing the purchase order summary. |
List purchase orderslistPurchaseOrders | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve a paginated list of purchase orders with optional... |
Receive purchase order productsreceivesPurchaseOrderProducts | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Record receipt of products from a purchase order. |
Update a purchase orderupdatePurchaseOrder | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update an existing purchase order. |
Update purchase order shipping detailsupdatePurchaseOrderShippingDetails | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update shipping-related details for a purchase order in open status. |
Update purchase order statusupdatePurchaseOrderStatus | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update the status of a purchase order. |
Rate shoppers2
Get rate shopper by IDgetRateShopperById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve a single rate shopper by its identifier. |
List rate shopperslistRateShoppers | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve rate shoppers for the authenticated seller. |
Rates4
Estimate ratesestimateRates | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get Rate Estimates |
Get bulk ratescompareBulkRates | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get Bulk Shipment Rates |
Get rate by IDgetRateById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve a previously queried rate by its ID |
Get shipping ratescalculateRates | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans It's not uncommon that you want to give your customer the choice... |
Service points2
Get service point by IDservicePointsGetById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Returns a carrier service point by using the service point id |
List service pointsservicePointsList | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans List carrier service points by location |
Shipments16
Add tag to shipmenttagShipment | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Add a tag to the shipment object |
Assign user to shipmentsassignUserToShipments | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Assigns a user to one or more shipments. |
Cancel a shipmentcancelShipments | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Mark a shipment cancelled, if it is no longer needed or being used... |
Create shipmentscreateShipments | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create one or more shipments |
Get shipment by external idgetShipmentByExternalId | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Query Shipments created using your own custom ID convention using... |
Get shipment by IDgetShipmentById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get an individual shipment based on its ID |
Get shipment rateslistShipmentRates | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get Rates for the shipment information associated with the... |
Get shipment tagsshipmentsListTags | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get Shipment tags based on its ID |
Hold a shipmentholdShipment | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Holds a shipment until a given date. |
Hold shipmentsholdShipments | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Holds one or more shipments until a given date. |
List shipmentslistShipments | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get list of Shipments |
Remove tag from shipmentuntagShipment | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Remove an existing tag from the Shipment object |
Restore a shipmentrestoreShipment | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Restores a shipment that is on hold. |
Restore shipmentsrestoreShipments | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Restores one or more shipments that are on hold. |
Update a shipmentupdateShipment | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update an existing shipment's details including addresses, package... |
Update internal notes for a shipmentupdateShipmentInternalNotes | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update the internal notes on a shipment. |
Suppliers4
Create a new suppliercreateSupplier | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create a new supplier with contact and address information. |
Get supplier detailsgetSupplier | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve detailed information about a specific supplier. |
List supplierslistSuppliers | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve a paginated list of all suppliers with optional filtering... |
Update a supplierupdateSupplier | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update an existing supplier's information. |
Tags5
Create a new tagcreateTag | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create a new tag for customizing how you track your shipments. |
Create a new tagcreateTagByName | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create a new Tag for customizing how you track your shipments |
Delete tagdeleteTag | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Delete a tag that is no longer needed |
Get tagslistTags | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get a list of all tags associated with an account. |
Update tag namerenameTag | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Change a tag name while still keeping the relevant shipments... |
Tokens1
Get ephemeral tokentokensGetEphemeralToken | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans This endpoint returns a token that can be passed to an application... |
Totes6
Create totes in batchcreateTotesBatch | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create multiple totes at once. |
Delete totedeleteTote | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Delete a tote by its ID. |
Get tote by IDgetToteById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve details of a specific tote. |
Get tote quantitiesgetToteQuantities | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get the number of totes in each warehouse. |
List toteslistTotes | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Get all totes for the seller, optionally filtered by warehouse. |
Update toteupdateTote | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update the name or barcode of an existing tote. |
Tracking3
Get tracking informationgetTrackingLog | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve package tracking information |
Start tracking a packagestartTracking | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Allows you to subscribe to tracking updates for a package. |
Stop tracking a packagestopTracking | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Unsubscribe from tracking updates for a package. |
Users1
List userslistUsers | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans |
Warehouses6
Create warehousecreateWarehouse | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create a warehouse location that you can use to create shipping... |
Delete warehouse by IDdeleteWarehouse | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Delete a warehouse by ID |
Get warehouse by IDgetWarehouseById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve warehouse data based on the warehouse ID |
List warehouseslistWarehouses | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve a list of warehouses associated with this account. |
Update warehouse by IDupdateWarehouse | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update Warehouse object information |
Update warehouse settingsupdateWarehouseSettings | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update Warehouse settings object information |
Webhooks5
Create a webhookcreateWebhook | POST | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Create a webhook for specific events in the environment. |
Delete webhook by IDdeleteWebhook | DELETE | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Delete a webhook |
Get webhook by IDgetWebhookById | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Retrieve individual webhook by an ID |
List webhookslistWebhooks | GET | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans List all webhooks currently enabled for the account. |
Update a webhookupdateWebhook | PUT | Products Plans Formerly ShipEngine Free Advanced Enterprise Free Starter Standard Premium Learn about products and plans Update the webhook url property |