Skip to main content

Import Orders

POST 
/api/shiphero/integration-instances/:integration_instance/orders/import

Queue a tracked background job that imports orders from ShipHero within a date window — treating ShipHero as an order source, not just a fulfillment target. Each imported order is FK-linked to its matching SKU entity by order_number (writing the real sku_fulfillment_order_id / sku_fulfillment_id); true orphans are imported unlinked.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Returns the tracked job log id so the frontend can poll progress (via Get Order Sync Progress).

If an import is already pending/processing for this instance, responds 409 ImportInProgress.

Request body (all optional):

  • mode — fetch mode: since_latest | from_start_date | date_range | all. Defaults to all (unbounded full re-sync of the entire order history).
  • date_from — ISO date; the window start for from_start_date and date_range.
  • date_to — ISO date; the window end for date_range.
  • date_method — created | updated. For date_range, selects which ShipHero timestamp the window filters on (default created).
  • latest_date — ISO date anchor for since_latest (falls back to the stored last-sync cursor).

Mode → window mapping: since_latest → updated_from = latest_date/cursor; from_start_date → order_date_from = date_from; date_range (created) → order_date_from/order_date_to; date_range (updated) → updated_from/updated_to; all → unbounded.

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type