BAbagisto
Customer Return

Send a message on a return request

Changed on

Sends a message on a return. Attach one file in file (multipart) or as a base64 data URI in attachment (JSON).

post/return-messages

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

return_idinteger required
messagestring required
attachmentstring

Attachment as a base64 data URI, max 5 MB.

attachment_namestring

File name shown for the attachment.

Example request

{
  "return_id": 12,
  "message": "Any update on my return?",
  "attachment": "data:image/png;base64,iVBORw0KGgo...",
  "attachment_name": "zipper.png"
}

Response

The created message.

Changes