Skip to content
docs
ES
Carts & CheckoutCustomer

Request a return

The customer asks to return delivered items of their order, with a reason and up to three photos. The store reviews it in its returns.

POST/v1/customer/orders/{orderId}/return-request
Requires an access token.

Path Parameters

orderId*string

Identifier of the order.

Header Parameters

Authorization*string

OAuth 2.0 bearer token.

x-Store-Domain*string

Slug of the store or one of its configured domains, such as my-store.

Length1 <= length <= 253
X-Customer-Session?string

Customer session from POST /v1/customer/sessions. Send it instead of Authorization, never both.

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://storefront.ecomiq.pe/v1/customer/orders/7204558912004325350/return-request" \  -H "Authorization: Bearer <token>" \  -H "x-Store-Domain: my-store" \  -H "X-Customer-Session: <session-id>" \  -F reason="Reposición de stock." \  -F comment="Entregar después de las 18:00." \  -F items="Mi tienda" \  -F files="[    \"polo-de-algodon.webp\"  ]"
Empty