01.software Docs

updateReturn

Use the SDK for application integration. This read-only reference covers Commerce, Customer Auth, Membership and Events.

All HTTP operations
POST
/api/returns/update

Tenant-admin write; actual server Return lifecycle document, not a PublicOrder.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Public integration credentials: verified opaque sk01_ secret key or pat01_ personal access token; operation policy and read/write scopes still apply. These credentials are not Customer JWTs.

Request Body

application/json
  1. body
returnId*string|number
status*string
Value in"processing""approved""rejected""canceled""completed"
reasonCode?string
Value in"window_expired""used_or_damaged""non_returnable""other"
cancellationReasonCode?string
Value in"items_not_received""customer_withdrew""merchant_decision""other"
cancellationReasonDetail?string
Length1 <= length <= 2000

Response Body

Actual shaped success body

application/json
  1. response

Actual authenticated Payload Return document. Relationship depth and field access vary. This is server-only legacy wire, not the canonical public DTO or a browser discovery promise.

id*string
createdAt?string
updatedAt?string
order?string|number|
status?string
refundAmount?number|null
returnShippingFee?number|null
[key: string]?any

Examples may be generated from schemas; they are illustrative, not recorded successful API calls. Example snippets may omit required authentication headers.

Example Request
curl -X POST 'https://api.01.software/api/returns/update' \  -H 'Content-Type: application/json' \  -d '{  "returnId": "string",  "status": "processing"}'
Example Response
{  "id": "string",  "createdAt": "string",  "updatedAt": "string",  "order": "string",  "status": "string",  "refundAmount": 0,  "returnShippingFee": 0}