Search Orders
POST/api/magento1/instances/:integrationInstance/orders/search
Live-search the connected Magento 1 store for orders by increment id or customer email. Returns shallow matches, each flagged with whether it already exists in SKU.io.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body: search_by — increment_id or email. query — the search term (string, max 255).
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.