Archive ShipMyOrders Invoice
PUT/api/shipmyorders/invoices/:id/archive
Archives one ShipMyOrders invoice, hiding it from the default invoice list. Archiving does not unprocess it.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
If the invoice is already archived the call still succeeds (HTTP 200) with status: warning and code ShipMyOrdersInvoiceIsAlreadyArchived under warnings.id.
No body. Returns the invoice in the same shape as Get ShipMyOrders Invoice.
Requires the integrations.update permission.
Authentication: Bearer token (Personal Access 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
Response Headers
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.