ShipStation (v1 Legacy)

Adds funds to a carrier account using the payment information on file. **IMPORTANT:** Requires approval from [email protected] before use.

Adds a tag to an order

Assigns a user to an order. If ANY of the orders within the array are not found, no orders will have a user assigned to them.

Creates a shipping label for an existing order. The `labelData` field returned in the response is a base64 encoded PDF value. You can decode and save the output as a PDF file to retrieve a printable label. **IMPORTANT:** You must have at least one active Manual Store on your ShipStation account to create labels with this endpoint.

Creates a shipping label. The `labelData` field returned in the response is a base64 encoded PDF value. You can decode and save the output as a PDF file to retrieve a printable label. **IMPORTANT:** You must have at least one active Manual Store on your ShipStation account to create labels with this endpoint.

Create or update multiple orders in one request. If the `orderKey` is specified, ShipStation will attempt to locate the order with that key. If found, the existing order will be updated. If not found, a new order will be created. For split orders, the `orderKey` is always required when creating or updating orders, and the `orderId` is always required for updates. This call does not currently support partial updates; the entire resource must be provided in the body of the request. Only orders in an open status (`awaiting_payment`, `awaiting_shipment`, `pending_fulfillment`, `on_hold`) can be updated. Orders in `cancelled` or `shipped` status may not be updated.

Create a new order or update an existing order. If the `orderKey` is specified, ShipStation will attempt to locate the order with that key. If found, the existing order will be updated. If not found, a new order will be created with that `orderKey`. **Note:** This call does not currently support partial updates. The entire resource must be provided in the body of the request. Only orders in an open status (`awaiting_payment`, `awaiting_shipment`, `on_hold`) can be updated. Orders in `cancelled` and `shipped` states may not be updated.

Adds a Ship From Location (formerly known as warehouse) to your account. **Note:** In the API, the endpoint is called warehouse, but the process actually affects Ship From Locations in the UI.

Deactivates the specified store

Removes order from ShipStation's UI. This is a "soft" delete action so the order will still exist in the database, but will be set to inactive.

Removes a warehouse from ShipStation's UI and sets it to Inactive status. This is a "soft" delete action. **Note:** In the API, the endpoint is called warehouse, but the process actually affects Ship From Locations in the UI.

Retrieves the shipping carrier account details for the specified carrierCode. Use this method to determine a carrier's account balance.

Retrieves a single customer by ID

Retrieves a single order by its ID

Retrieves a single product by its ID

Retrieves shipping rates for the specified shipping details. Use this endpoint to compare rates across different carriers and services before creating a label.

Retrieves information for a specific store by its ID

Retrieves the refresh status of a given store

Returns a specific Ship From Location (formerly known as warehouse). **Note:** In the API, the endpoint is called warehouse, but the process actually affects Ship From Locations in the UI.

Changes the status of the order to On Hold until the specified date, when the status will automatically change to Awaiting Shipment.

List all tags defined for this account

List all shipping providers connected to this account

Obtains a list of customers that match the specified criteria

Obtains a list of fulfillments that match the specified criteria. **Note:** Orders that have been marked as shipped either through the UI or API will appear in the response as they are considered fulfillments.

Lists the marketplaces that can be integrated with ShipStation

Obtains a list of orders that match the specified criteria. All filters are optional. If no filters are provided, recent orders will be returned.

Obtains a list of orders that have been tagged with the specified tagId

Retrieves a list of packages for the specified carrier

Obtains a list of products that match the specified criteria

Retrieves the list of available shipping services provided by the specified carrier

Obtains a list of shipments that match the specified criteria. **Note:** Only valid shipments with labels generated in ShipStation will be returned. Orders that have been marked as Shipped through the UI or API will not appear as they are considered external shipments.

Retrieve the list of installed stores on the account

Retrieves a list of users for the account

Retrieves a list of your Ship From Locations (formerly known as warehouses). **Note:** In the API, the endpoint is called warehouse, but the process actually affects Ship From Locations in the UI.

Retrieves a list of registered webhooks for the account

Marks an order as Shipped without creating a label in ShipStation

Reactivates the specified store. **Note:** Stores are active by default.

Initiates a store refresh. If storeId is not specified, a store refresh will be initiated for all refreshable stores on that account.

Removes a tag from the specified order

Changes the status of the order from On Hold to Awaiting Shipment. This endpoint is used when a holdUntilDate is attached to an order.

Subscribes to a specific type of webhook. If a store_id is passed in, the webhooks will only be triggered for that specific store_id. **Note:** Webhooks can only be modified through the ShipStation UI under Account Settings.

Unassigns a user from an order. If ANY of the orders within the array are not found, no orders will have their users unassigned.

Unsubscribes from a certain webhook

Updates an existing product. This call does not currently support partial updates. The entire resource must be provided in the body of the request.

Updates an existing store. This call does not currently support partial updates. The entire resource must be provided in the body of the request.

Updates an existing Ship From Location (formerly known as warehouse). **Note:** In the API, the endpoint is called warehouse, but the process actually affects Ship From Locations in the UI.

Voids the specified label by shipmentId