Overview
- POST /carriers/addfunds
- GET /carriers/getcarrier
- GET /carriers
- GET /carriers/listpackages
- GET /carriers/listservices
- GET /customers
- GET /customers/{customerId}
- PARAMETERS /customers/{customerId}
- GET /fulfillments
- POST /orders/createorder
- POST /orders/createorders
- POST /orders/createlabelfororder
- POST /orders/assignuser
- POST /orders/addtag
- GET /orders
- GET /orders/listbytag
- GET /orders/{orderId}
- DELETE /orders/{orderId}
- PARAMETERS /orders/{orderId}
- POST /orders/holduntil
- POST /orders/markasshipped
- POST /orders/removetag
- POST /orders/restorefromhold
- POST /orders/unassignuser
- GET /products/{productId}
- PUT /products/{productId}
- PARAMETERS /products/{productId}
- GET /products
- POST /shipments/createlabel
- POST /shipments/getrates
- GET /shipments
- POST /shipments/voidlabel
- GET /stores
- GET /stores/{storeId}
- PUT /stores/{storeId}
- PARAMETERS /stores/{storeId}
- POST /stores/deactivate
- POST /stores/reactivate
- GET /stores/marketplaces
- POST /stores/refreshstore
- GET /stores/getrefreshstatus
- GET /users
- POST /warehouses/createwarehouse
- GET /warehouses
- GET /warehouses/{warehouseId}
- PUT /warehouses/{warehouseId}
- DELETE /warehouses/{warehouseId}
- PARAMETERS /warehouses/{warehouseId}
- GET /webhooks
- POST /webhooks/subscribe
- DELETE /webhooks/{webhookId}
- PARAMETERS /webhooks/{webhookId}
POST /carriers/addfunds
Summary: Add funds to carrier account
Adds funds to a carrier account using the payment information on file.
Requires approval from apisupport@shipstation.com before use.
OpenAPI snippet URL
GET /carriers/getcarrier
Summary: Get Carrier By Code
Retrieves the shipping carrier account details for the specified carrierCode. Use this method to determine a carrier’s account balance.
OpenAPI snippet URL
GET /carriers
Summary: List Carriers
List all shipping providers connected to this account.
OpenAPI snippet URL
GET /carriers/listpackages
Summary: List Packages
Retrieves a list of packages for the specified carrier.
OpenAPI snippet URL
GET /carriers/listservices
Summary: List Services
Retrieves the list of available shipping services provided by the specified carrier.
OpenAPI snippet URL
GET /customers
Summary: List Customers
Obtains a list of customers that match the specified criteria.
OpenAPI snippet URL
GET /customers/{customerId}
Summary: Get Customer
Get Customer with specific Id.
OpenAPI snippet URL
PARAMETERS /customers/{customerId}
OpenAPI snippet URL
GET /fulfillments
Summary: List Fulfillments
List Fulfillments
OpenAPI snippet URL
POST /orders/createorder
Summary: Create/Update Order
If the orderKey is specified, the method becomes idempotent and the existing order with that key will be updated. This call does not currently support partial updates; the entire resource must be provided in the body of the request.
Note: Only orders in an open status in ShipStation (awaiting_payment,awaiting_shipment, and on_hold) can be updated through this method. cancelled and shipped are locked from modification through the API. The body of this request should specify an Order object:
OpenAPI snippet URL
POST /orders/createorders
Summary: Create/Update Multiple Orders
This endpoint can be used to create or update multiple orders in one request. If the orderKey is specified in an order, the existing order with that key will be updated. This call does not currently support partial updates; the entire resource must be provided in the body of the request.
NOTE: You can only use this method to update orders in an open status in ShipStation (awaiting_payment,awaiting_shipment, and on_hold). Orders in cancelled and shipped statuse are locked from modification through the API.
OpenAPI snippet URL
POST /orders/createlabelfororder
Summary: Create Label for Order
Creates a shipping label for a given order. The labelData field returned in the response is a base64 encoded PDF value. Simply decode and save the output as a PDF file to retrieve a printable label. The body of this request should specify the following attributes:
OpenAPI snippet URL
POST /orders/assignuser
Summary: Assign User To Order
Assigns a user to an order. The body of this request should specify the following attributes:
- orderIds
- userId
OpenAPI snippet URL
POST /orders/addtag
Summary: Add Tag To Order
Adds a tag to an order. The body of this request should specify the following attributes:
orderIdtagId
OpenAPI snippet URL
GET /orders
Summary: List Orders
Obtains a list of orders that match the specified criteria.
All of the available filters are optional.
OpenAPI snippet URL
GET /orders/listbytag
Summary: List Orders By Tag
ists all orders that match the specified status and tag ID.
OpenAPI snippet URL
GET /orders/{orderId}
Summary: Get Order
Retrieve a single order from the database.
OpenAPI snippet URL
DELETE /orders/{orderId}
Summary: Delete Order
Removes order from ShipStation’s UI. Note this is a “soft” delete action so the order will still exist in the database, but will be set to inactive.
OpenAPI snippet URL
PARAMETERS /orders/{orderId}
OpenAPI snippet URL
POST /orders/holduntil
Summary: Hold Order Until
This method will change the status of the given order to On Hold until the date specified, when the status will automatically change to Awaiting Shipment.
OpenAPI snippet URL
POST /orders/markasshipped
Summary: Mark an Order as Shipped
Marks an order as shipped without creating a label in ShipStation.
OpenAPI snippet URL
POST /orders/removetag
Summary: Remove Tag from Order
Removes a tag from the specified order.
OpenAPI snippet URL
POST /orders/restorefromhold
Summary: Restore Order from On Hold
This method will change the status of the given order from On Hold to Awaiting Shipment. This endpoint is used when a holdUntil Date is attached to an order.
OpenAPI snippet URL
POST /orders/unassignuser
Summary: Unassign User from Order
Unassigns a user from an order.
OpenAPI snippet URL
GET /products/{productId}
Summary: Get a Product
Get a Product
OpenAPI snippet URL
PUT /products/{productId}
Summary: Update a Product
Updates an existing product. This call does not currently support partial updates. The entire resource must be provided in the body of the request.
OpenAPI snippet URL
PARAMETERS /products/{productId}
OpenAPI snippet URL
GET /products
Summary: List Products
Obtains a list of products that match the specified criteria. All of the available filters are optional. They do not need to be included in the URL.
OpenAPI snippet URL
POST /shipments/createlabel
Summary: Create Shipment Label
Creates a shipping label. The labelData field returned in the response is a base64 encoded PDF value. Simply decode and save the output as a PDF file to retrieve a printable label.
OpenAPI snippet URL
POST /shipments/getrates
Summary: Get Rates
Retrieves shipping rates for the specified shipping details.
OpenAPI snippet URL
GET /shipments
Summary: List Shipments
Obtains a list of shipments that match the specified criteria.
OpenAPI snippet URL
POST /shipments/voidlabel
Summary: Void Shipment Label
Voids the specified label by shipmentId.
OpenAPI snippet URL
GET /stores
Summary: List Stores
Retrieve the list of installed stores on the account.
OpenAPI snippet URL
GET /stores/{storeId}
Summary: Get Store
Get Store
OpenAPI snippet URL
PUT /stores/{storeId}
Summary: Update Store
Updates an existing store.
OpenAPI snippet URL
PARAMETERS /stores/{storeId}
OpenAPI snippet URL
POST /stores/deactivate
Summary: Deactivate Store
Deactivates the specified store.
OpenAPI snippet URL
POST /stores/reactivate
Summary: Reactivate Store
Reactivates the specified store.
OpenAPI snippet URL
GET /stores/marketplaces
Summary: List Marketplaces
Lists the marketplaces that can be integrated with ShipStation.
OpenAPI snippet URL
POST /stores/refreshstore
Summary: Refresh Store
Initiates a store refresh.
OpenAPI snippet URL
GET /stores/getrefreshstatus
Summary: Get Store Refresh status
Retrieves the refresh status of a given store.
OpenAPI snippet URL
GET /users
Summary: List Users
List Users
OpenAPI snippet URL
POST /warehouses/createwarehouse
Summary: Create Warehouse
Adds a Ship From Location (formerly known as warehouse) to your account.
OpenAPI snippet URL
GET /warehouses
Summary: List Warehouses
Retrieves a list of your Ship From Locations (formerly known as warehouses).
OpenAPI snippet URL
GET /warehouses/{warehouseId}
Summary: Get Warehouse
Returns a list of active Ship From Locations (formerly known as warehouses) on the ShipStation account.
OpenAPI snippet URL
PUT /warehouses/{warehouseId}
Summary: Update Warehouse
Updates an existing Ship From Location (formerly known as warehouse).
If a “returnAddress” object is not specified, your “originAddress” will be used as your “returnAddress”.
OpenAPI snippet URL
DELETE /warehouses/{warehouseId}
Summary: Delete a warehouse
Removes a warehouse from ShipStation’s UI.
OpenAPI snippet URL
PARAMETERS /warehouses/{warehouseId}
OpenAPI snippet URL
GET /webhooks
Summary: List Webhooks
Retrieves a list of registered webhooks for the account.
OpenAPI snippet URL
POST /webhooks/subscribe
Summary: Subscribe to Webhook
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. The event type that is passed in will determine what type of webhooks will be sent.
OpenAPI snippet URL
DELETE /webhooks/{webhookId}
Summary: Unsubscribe to Webhook
Unsubscribes from a certain webhook.
OpenAPI snippet URL
PARAMETERS /webhooks/{webhookId}
OpenAPI snippet URL