This document catalogs every ShipStation endpoint the ShipStation integration calls, grouped by the workflow each one serves. Use it to check whether a published ShipStation deprecation notice affects the integration, to whitelist the correct hosts in your firewall, and as a reference when troubleshooting data flow.
API Endpoints Intro
The integration calls the ShipStation API V1, a REST API that exchanges JSON. All requests use HTTP Basic authentication, with your ShipStation API Key as the username and your ShipStation API Secret as the password.
The base URL is determined by the API Url value configured in your subscription settings. The standard ShipStation API V1 host is:
https://ssapi.shipstation.com
In the endpoint patterns below, [Base URL] stands in for that host. Replace it with the API Url from your subscription settings.
NOTE: This integration uses the ShipStation API V1 (the host beginning with ssapi). It does not use the ShipStation API V2.
Table of Contents
Order Endpoints
These endpoints support the order workflow that sends orders from iPaaS.com into ShipStation. The create endpoint carries the order, its line items, and its billing and shipping addresses in a single request.
Create or Update an Order (POST)
[Base URL]/orders/createorder
This single endpoint both creates a new order and updates an existing one. ShipStation matches the order by its order key, so re-sending the same order updates the existing record rather than creating a duplicate. Line items and addresses are included inline in this request; the integration does not make separate calls to write them.
Get an Order by Id (GET)
[Base URL]/orders/{id}Retrieves a single order by its ShipStation order id.
Shipment Endpoints
These endpoints support the inbound workflow that brings shipment records into iPaaS.com. Shipments are retrieved by polling on a schedule and by Manual Sync; the integration does not rely on live shipment webhooks.
Get Shipments (GET)
[Base URL]/shipments
Retrieves shipment records. The integration applies query parameters to scope and page the results, for example:
[Base URL]/shipments?includeShipmentItems=true&trackingNumber={trackingNumber}[Base URL]/shipments?createDateStart={ModifiedDate}&page={page}&pageSize={limit}includeShipmentItems: when set to
true, includes the items contained in each returned shipment.trackingNumber: returns the shipment with the specified tracking number. Shipments can also be filtered by orderId or orderNumber.
createDateStart: returns shipments created on or after the supplied date, used when polling for shipments created since the last successful run.
page and pageSize: page through large result sets.
Shipping Method Endpoints
These endpoints support the inbound workflow that brings carriers and their services into iPaaS.com as shipping methods. They run during Initialization and on Manual Sync.
Get Carriers (GET)
[Base URL]/carriers
Retrieves the list of carriers configured in the ShipStation account.
Get Carrier Services (GET)
[Base URL]/carriers/listservices?carrierCode={code}Retrieves the services available for a single carrier.
carrierCode: the code of the carrier whose services are being requested, taken from the carrier list returned by the Get Carriers endpoint above.
Authorization
The ShipStation API V1 uses HTTP Basic authentication on every request rather than a separate authorization or token endpoint. The integration sends your ShipStation API Key and API Secret (configured in your subscription settings) as the Basic auth credentials with each call listed above. There is no separate token-exchange URL to whitelist.