Skip to content
ExtensionsStorefronts
extensions / Commerce extension
POST/__runtime/rma/create

Create Create

Creates a public return (RMA) request for an order item, supporting guest submissions validated by email.

POST

Authentication

Requirement
Not specified
Credential type
Not specified
Scopes
Not specified

Permissions

  • Public endpoint; guest submissions are validated by the order email, and authenticated storefront sessions are used when present.

Headers

NameRequiredTypeDetails
CookieYesNot specified
Description: Value used by this operation.
AuthorizationYesNot specified
Description: Bearer credential used to authenticate the request.

Path Parameters

This operation has no path parameters.

Query Parameters

This operation does not accept query parameters.

Request Body

Schema: RuntimeRmaPublicCreateRequest

FieldRequiredTypeDetails
project_idYesinteger
Description: Target project identifier.
order_numberYesstring
Description: Text value.
order_item_idYesinteger
Description: Identifier for order item.
requested_qtyNonumber
Description: Numeric value.
reasonNostring
Description: Text value.
descriptionNostring
Description: Long-form description text.
emailNostring
Description: Text value.

Response Body

Example 200 response

json
{
  "success": [],
  "message": "string",
  "debug_error": "string",
  "requires_email": "user@example.com",
  "eligibility": "string",
  "policy": "string",
  "rma_number": "string",
  "status": "active",
  "requested_qty": "string",
  "remaining_qty": "string"
}

Errors

400 BAD_REQUEST404 NOT_FOUND500 INTERNAL_SERVER_ERROR

Availability

Available in
v0.1.0
Available since
v0.1.0
Implementation
Available
Deprecation
Not specified
Rate limits
Not specified