Get Order Import Info

GET 
/api/shiphero/integration-instances/:integration_instance/orders/import-info

Import UI metadata for the shared Refresh Orders modal:

• last_synced_at — the "since latest" anchor. Prefers the persisted import cursor, falling back to the most recently imported order's updated_at when no cursor has been recorded yet.
• latest_identifier — the most recently imported order's order_number (null when no orders exist).
• total_orders — total imported order count for the instance.

Not yet available to API tokens

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

Authentication: Requires Bearer token.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.