shipstation_* — ShipStation
The ShipStation tool namespace — creating orders and shipments, and looking them up by ID, order number, or external ID.
ShipStation is the shipping/fulfillment surface. The ESA order pipeline creates
ShipStation orders as part of fulfillment; these tools cover creating and
looking up orders and shipments. Payloads (ship_to, items) are object
structures, so when in doubt, fetch an existing order to see the shape.
Orders
shipstation_create_order
shipstation_create_order(order_number, ship_to, items,
order_status="awaiting_shipment", order_date=None,
customer_email=None, bill_to=None, store_id=None,
carrier_code=None, service_code=None)
| Param | Notes |
|---|---|
order_number | Required — your order identifier |
ship_to | Required — destination address object |
items | Required — list of line-item objects |
order_status | Defaults to awaiting_shipment |
store_id | Target a specific ShipStation store |
carrier_code / service_code | Pre-assign shipping method |
shipstation_get_order
shipstation_get_order(order_id)
By ShipStation’s internal order ID.
shipstation_search_orders
shipstation_search_orders(order_number=None, customer_name=None,
item_keyword=None, order_status=None,
create_date_start=None, create_date_end=None,
store_id=None, sort_by=None, sort_dir=None,
page=1, page_size=25)
Search by order number, customer, item keyword, status, or create-date range. Use this when you have the order number rather than the internal ID.
Shipments
shipstation_create_shipments
shipstation_create_shipments(shipments)
shipments is a list of shipment objects — supports creating several at once.
Shipment lookups
shipstation_get_shipment(...) # by ShipStation shipment ID
shipstation_get_shipment_by_external_id(...) # by your external ID
shipstation_search_shipments(...) # filtered search
shipstation_get_shipment_by_external_id is the one to use when you tracked the
shipment under your own identifier rather than ShipStation’s.
Related pages
- ESA Order Processing — the workflow that creates these orders
- ESA Order Processor — the native fulfillment module
- Tools — catalog overview and routing rules