BAbagisto
Customer Return

Raise a new return (RMA) request

Changed on

Raises a return for one returnable order item. Send multipart/form-data to attach evidence images in images[]; a JSON body works without images. A JSON body, and GraphQL createCustomerReturn, take images as base64 data URIs in images, like the profile image.

post/returns

Request

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring
Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring
Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring
Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Request body

order_idinteger required
order_item_idinteger required
rma_qtyinteger required
resolution_type'return' | 'cancel_items' required
rma_reason_idinteger required
informationstring
package_condition'open' | 'packed'
custom_attributesobject
agreementboolean required
imagesstring[]

Evidence images as base64 data URIs, max 5 MB each.

Example request

{
  "order_id": 12,
  "order_item_id": 45,
  "rma_qty": 1,
  "resolution_type": "return",
  "rma_reason_id": 2,
  "information": "Item arrived damaged.",
  "package_condition": "open",
  "custom_attributes": {
    "1": "INV-9921",
    "2": [
      "morning",
      "evening"
    ]
  },
  "agreement": true,
  "images": [
    "data:image/png;base64,iVBORw0KGgo..."
  ]
}

Response

The created return request.

Changes

  • 63e385bd5442Revision changes
    • info

      added the new optional request property

  • 37a56692b7a4Revision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      the request property type was generalized from object to string