Archive or restore an order

Testing

PATCH

https://sgtr-api.returning.ai/v1/purchase-histories/{purchaseHistoryID}/archive

Archive or restore a completed store order.

Accepts the public ORD purchase ID or Mongo _id in the URL.
Requires a community API key with purchase-history permission.

Archived orders are hidden from storefront history and remain accessible
to admins. The API records the API-key actor and reason in audit history.
Repeating the current archive state succeeds without another audit entry.

Order status, fulfillment, refunds and balances remain unchanged.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

cURL

Archive ExampleRestore Example

curl --location --request PATCH 'https://sgtr-api.returning.ai/v1/purchase-histories//archive?purchaseHistoryID=ORD20264161205561474' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
  "isArchived": true,
  "reason": "Duplicate receipt"
}'

Response Example

{
  "meta": {
    "status": "success",
    "statusCode": 200,
    "code": "PURCHASE_HISTORY_ARCHIVE_UPDATED"
  },
  "message": "Order archive state updated.",
  "data": {
    "_id": "6502c97314a3e564c5bbfa85",
    "purchaseID": "ORD202641612055614747",
    "communityID": "6502c97314a3e564c5bbfa84",
    "status": "complete",
    "isArchived": true,
    "updatedAt": "2026-09-30T03:00:00.000Z"
  }
}

Modified at 2026-10-05 10:38:09

Store catalog

Update redemption instructions or voucher details