ShipStation integration

Validates an address or an array of addresses using ShipStation's address validation engine.

Retrieves a list of all carriers that have been added to this ShipStation account.

Retrieves details about a specific carrier by its carrier ID.

Disconnect a carrier from the account by its carrier ID.

Get a list of the advanced options available for a specific carrier.

List the package types associated with a specific carrier. Returns carrier-provided package types.

List the services associated with a specific carrier ID.

Register a carrier document against a label. Returns an upload target to which you upload the document file.

Retrieve the carrier documents registered against a label, including their processing status.

Delete a carrier document registered against a label. Documents already sent cannot be deleted.

Transmit all uploaded documents for a label to the carrier.

Download the file for a previously registered carrier document, returning it as a Base64 string.

Register a carrier document against a shipment. Returns an upload target.

Retrieve the carrier documents registered against a shipment.

Delete a carrier document registered against a shipment.

Retrieve each shipment associated with the given id, including its tracking number and registered carrier documents.

Download labels and other shipment-related documents by directory, subdirectory, and filename.

Retrieve a list of fulfillments based on various filter criteria like shipment details and tracking information.

Mark shipments as shipped with tracking information. This will notify customers and marketplaces according to your configuration.

Download a combined label file for up to 30 label IDs.

Returns a list of labels that you've created. You can optionally filter the results as well as control their sort order.

Generates a label natively using comprehensive shipment object details.

Generate a label without having to refill in the shipment information repeatedly by using a rate_id.

Purchase a label using a shipment ID that has already been created with the desired address and package info.

Purchase and print a shipping label using a Shipping Rule/Rate Shopper ID, automatically selecting the optimal carrier and service.

Returns the first label found with the specified external_shipment_id.

Retrieve a specific label by its label ID.

Retrieve the tracking details and carrier event history for a specific label.

Void a specific label using its label ID. This will also request a refund from the carrier if paid at creation.

Cancel a scheduled refund request for a label. Only labels with refund status 'request_scheduled' can be excluded.

List all pickups that have been scheduled for this carrier.

Schedules a pickup with a carrier for the specified labels and pickup window.

Get detailed information about a previously scheduled pickup by ID.

Cancels/deletes a pickup request that was previously scheduled.

Returns a list of products. You can optionally filter the results by SKU, name, or active status.

Get detailed information about a single product by its Product ID.

Create new products in your ShipStation account.

Update existing products. Each product requires the full object — partial updates are not supported.

Sets the active flag to false for the provided list of product IDs.

Retrieve a paginated list of purchase orders with optional filtering by status, warehouse, dates, and other criteria.

Create a new purchase order with products from a supplier.

Retrieve detailed information about a specific purchase order including all products.

Update an existing purchase order. Note: only allowed if status is 'draft'. Once moved to any other status, use specific endpoints.

Update shipping-related details for a purchase order in open status.

Update the status of a purchase order. Valid status transitions must be followed.

Record receipt of products from a purchase order. Updates inventory levels and may automatically change purchase order status.

Download a PDF document containing the purchase order summary (Base64).

Download a PDF document containing the received products summary for a PO (Base64).

Get multiple rate options based on carriers, package types, and services.

Get quick rate estimates between two locations based on weight/dimensions without creating a full shipment.

Retrieve a previously queried rate by its Rate ID.

Get a list of shipments in your account, optionally filtering by status, batch, tags, dates, and more.

Create one or more shipments manually.

You can assign a single user to up to 500 shipments at once.

Query Shipments created using your own custom ID convention (external shipment id).

Get an individual shipment based on its ShipStation Shipment ID.

Update an existing shipment's details including addresses, package info, carrier service, etc. (Before purchasing a label).

Mark a shipment cancelled, if it is no longer needed. Any label associated with the shipment needs to be voided first.

Get Rates for the shipment information associated with the specific shipment ID.

Get all tags currently associated with a specific shipment.

Categorize shipments by adding arbitrary string tags.

Remove an existing tag from the Shipment object.

You can either overwrite the existing notes entirely or append new text to the current notes.

Retrieve a paginated list of all suppliers with optional filtering by supplier name.

Create a new supplier with contact and address information.

Retrieve detailed information about a specific supplier by ID.

Update an existing supplier's information. Provide the Supplier ID and mapping for any fields to update.

Retrieve tracking details and event history for a package using its tracking number and carrier details.

Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number to receive notifications via webhooks whenever the shipping status changes.

Unsubscribe from automated webhook tracking updates for a specific package.