starshipit_list_unshipped_orders
List unshipped orders
List unshipped (new, not yet printed) orders with full details: addresses, items, packages, carrier. By default only orders updated in the last 24 hours; use since_order_date / since_last_updated to look further back. ids_only=true returns just the order ids. GET /api/orders/unshipped.
Parameterspagelimitids_onlysince_order_datesince_last_updated
starshipit_list_shipped_orders
List shipped orders
List shipped orders (label printed) with tracking number, tracking status, carrier, manifest and shipped date. By default only orders updated in the last 24 hours; use since_last_updated to look further back. Label files are not returned. GET /api/orders/shipped.
Parameterspagelimitids_onlysince_last_updated
starshipit_list_printed_orders
List printed or unmanifested orders
List orders whose label was recently printed, or printed but not yet manifested, with tracking numbers. GET /api/orders/shipments.
Parameterspagelimitstatussince_created_date
starshipit_list_delivered_orders
List delivered orders by reference
List delivered orders that carry a given order reference (the customer reference), with full order details. GET /api/orders/delivered.
Parametersorder_refrequired
starshipit_orders_summary
Orders summary by status
A compact list of orders in one status (new, printed, shipped, archived) with contact, country, carrier, weight, manifest and dates, plus account-wide counts (unprinted, printed, shipped, archived, invalid addresses, returns). Supports filters and sorting. GET /api/orders/summary.
Parameterspagesortfilterpage_sizeorder_statusrequiredsort_direction
starshipit_search_orders
Search orders
Search orders by order number, tracking number, customer reference or recipient name (phrase), optionally limited to unshipped or shipped orders. Returns id, number, date, name, carrier, tracking number and country. GET /api/orders/search.
Parameterspagelimitfieldsphraserequiredstatusinclude_child_accounts
starshipit_get_order
Get one order
One order by Starshipit order_id or by the order_number from the source platform. Use include to add sections (Items, Packages, Events, Metadatas, Shipping_Price, ...). Status defaults to Unshipped in Starshipit, so pass status=Shipped or Printed for orders already printed. Label files are not returned. GET /api/orders?order_id= or ?order_number=.
Parametersstatusincludeorder_idorder_number
starshipit_list_orders
List orders with filters
List full order details for one status (Unshipped by default, or Shipped / Printed), narrowed by a filter such as `Order:::1419,Country:::Australia` and sorted. Heavier than the summary: use starshipit_orders_summary for overviews. Label files are not returned. GET /api/orders (no id).
Parametersfilterstatusincludepage_sizepage_numbersort_columnsort_direction
starshipit_track_shipment
Track a shipment
Tracking details for a shipped order, by tracking number or by order number: status, carrier, tracking URL, shipment date and the carrier's tracking events. GET /api/track.
Parametersorder_numbertracking_number
starshipit_get_rates
Quote shipping rates
QUOTE ONLY: shipping rates (service name, code, price) for a destination and parcels from the couriers enabled in the account. Nothing is purchased, created or printed. The sender defaults to the account's pickup address. Needs at least one enabled courier. POST /api/rates.
Parameterssendercurrencypackagesrequireddestinationrequired
starshipit_list_delivery_services
List delivery services
QUOTE ONLY: the carrier delivery services available for a shipment (carrier, service name and code) and, with include_pricing, their prices and service options. Nothing is purchased, created or printed. POST /api/deliveryservices.
Parameterssenderpackagesrequireddestinationrequiredreturn_orderdeclared_valuedangerous_goodsinclude_pricinginsurance_valueauthority_to_leavesignature_required
starshipit_list_address_book
List address book
List contacts in the account's address book (name, company, address, phone, email), sorted by a column. GET /api/addressbook/filtered.
Parameterspagesortpage_sizesort_direction
starshipit_list_manifests
List manifests
List manifests already submitted to carriers (newest first): number, date, carrier, package and consignment counts. Read only; manifesting is not available here. GET /api/manifests.
Parameterspagelimit
starshipit_list_products
List product catalogue
List Product Catalogue records (SKU, title, weight, dimensions, HS code, bin location, price), optionally searching by SKU or title. GET /api/products.
Parameterspage_sizepage_numbersearch_termsort_columnsort_direction
starshipit_list_tags
List order tags
List the account's user-defined order tags, optionally filtered by tag name. GET /api/tags.
Parametersfilterpage_sizepage_number
starshipit_list_pickups
List booked pickups
List courier pickups already booked for the account. Read only; booking a pickup is not available here. GET /api/pickup.
Parameterspage_sizepage_number
starshipit_create_order
Create an unshipped order
WRITE: create ONE new UNSHIPPED order in Starshipit (order number, destination, optional items, parcels, sender). No label is printed, no shipment is booked and no postage is bought; staff still print the label in Starshipit. Not idempotent: creating the same order_number twice may create a duplicate, so check with starshipit_search_orders first. Starshipit rules configured in the account (carrier selection, validation) may run on the new order. POST /api/orders.
Parametersitemscarriercurrencypackagesreferencedestinationrequiredorder_numberrequiredreturn_ordersender_detailsshipping_methodsignature_requiredcarrier_service_code+1 more
starshipit_update_order
Update an order's details
WRITE: change details of ONE UNSHIPPED order by order_id (the order is read first and refused if it is already printed or shipped): addresses, shipping method/carrier/service, items, packages, reference or an internal note. This tool never sends status or manifest flags. It does not print a label or buy postage. Items/packages: include item_id / package_id (from starshipit_get_order with include=Items,Packages) to modify an existing line; a line without an id may be added. Nothing is deleted. Send only the fields you want to change. PUT /api/orders.
Parametersnoteitemscarriercurrencyorder_idrequiredpackagesreferencedestinationorder_numbersender_detailsshipping_methodsignature_required+2 more
starshipit_add_order_tags
Add tags to an order
WRITE: add up to 10 tags to ONE UNSHIPPED order (read first; refused if printed or shipped) (a tag that does not exist yet is created). Tags are used for filtering and can drive the account's automation rules. Adding a tag the order already has changes nothing. Tags are not removed. POST /api/tags/order.
Parameterstagsrequiredorder_idrequired