ShipStation is an ecommerce shipping software solution.Component key: shipstation
ShipStation is an e-commerce shipping solution that streamlines the order fulfillment process. This component allows you to list, create, update, and delete orders and shipments in your ShipStation account.
Documentation for the Axios client used in this component is available at Axios GitHub Repository.
A frequent integration pattern is to list orders or shipments from ShipStation and perform actions on the array of orders or shipments returned.
See our Looping Over Orders quickstart for details on how to create a loop over an array of orders.
ShipStation API Key
Prerequisites Before setting up a ShipStation connection, ensure you have:
ShipStation API Key ShipStation API Secret To acquire these, navigate to your ShipStation account dashboard and generate a new API Key and API Secret pair.
Setting up a ShipStation Connection in Your Application To interface with ShipStation, an API Key and API Secret are required for authentication.
Assign the User with Correct Permissions Make sure the API key you are using has the correct permissions to interact with the ShipStation API.
Generating API Credentials Go to your ShipStation account settings. Navigate to the 'API Settings' section. Generate or note down your API Key and API Secret. Adding API Credentials to Connection Once you have the API Key and API Secret, add these to your application’s ShipStation connection settings.
This will enable authenticated requests to ShipStation.
ShipStation Webhook Subscription Trigger
Handles incoming webhook subscriptions from ShipStation | key: shipStationWebhookTrigger
List and select from all of the carriers connected to this ShipStation account. | key: selectCarriers | type: picklist
List and select from all of the customers based on specified criteria in this ShipStation account. | key: selectCustomers | type: picklist
List and select from all of the packages provided by the specified carrier in this ShipStation account. | key: selectPackages | type: picklist
List and select from all of the services provided by the specified carrier in this ShipStation account. | key: selectServices | type: picklist
List and select from all of the installed stores in this ShipStation account. | key: selectStores | type: picklist
List and select from all of the users in this ShipStation account. | key: selectUsers | type: picklist
Create Label for Order
Creates a shipping label for a specified order. | key: createLabelForOrder
Create or Update Multiple Orders
Create or update multiple orders in one request. | key: createOrUpdateMultipleOrders
Create or Update Order
Create a new order or update an existing one. | key: createOrUpdateOrder
Create Shipment Label
Creates a shipping label. | key: createShipmentLabel
Adds a Ship From Location (formerly known as warehouse) to your account. | key: createWarehouse
Deactivates the specified store. | key: deactivateStore
Delete Instanced Webhooks
Deletes all webhooks that point to a flow in this instance. | key: deleteInstancedWebhooks
Soft delete an order from the database, setting it to inactive. | key: deleteOrder
Removes a warehouse (or Ship From location) from ShipStation's UI. Sets it to Inactive status. | key: deleteWarehouse
Retrieve a specific customer by their system generated identifier | key: getCustomer
Retrieve a single order from the database. | key: getOrder
Retrieve a specific product from the database by its ID. | key: getProduct
Retrieve detailed information about a specific store. | key: getStore
Retrieve detailed information about a specific Ship From Location (formerly known as warehouse). | key: getWarehouse
List all shipping providers connected to this ShipStation account. | key: listCarriers
Retrieve a list of customers based on specified criteria | key: listCustomers
Retrieve a list of fulfillments based on specified criteria | key: listFulfillments
Retrieve a list of orders based on specified criteria. | key: listOrders
Retrieves a list of packages for the specified carrier. | key: listPackages
Obtains a list of products that match the specified criteria. | key: listProducts
Retrieves the list of available shipping services provided by the specified carrier. | key: listServices
Obtains a list of shipments that match the specified criteria. | key: listShipments
Retrieve the list of installed stores on the account. | key: listStores
Retrieve the list of users on the account. | key: listUsers
Retrieves a list of your Ship From Locations (formerly known as warehouses). | key: listWarehouses
Retrieves a list of registered webhooks for the account. | key: listWebhooks
Send a raw HTTP request to the ShipStation API | key: rawRequest
Subscribe to Webhook
Subscribes to a specific type of webhook in ShipStation. | key: subscribeToWebhook
Unsubscribe to Webhook
Unsubscribes from a specific type of webhook in ShipStation. | key: unsubscribeToWebhook
Updates an existing product. | key: updateProduct
Updates an existing store. | key: updateStore
Updates an existing Ship From Location (formerly known as warehouse). | key: updateWarehouse