Skip to content
/
Start a return intent for...

Storefront API (1.0.0)

REVER's Storefront Returns API is the solution to building your custom made returns storefront while leveraging the power of REVER's returns engine.

Quick Integration

  • RESTful architecture
  • OpenAPI specification with ready-to-use examples and client library generation

Features

  • Return initiation and validation
  • Smart exchange recommendations
  • Multiple refund options (store credit, bank transfer, gift cards)
  • Automated return logistics
  • Tracking and status updates
  • Risk Assesment

Technical Highlights

  • REST-based API with JSON payloads
  • Secure authentication via API keys
  • Sandbox environment for testing
  • Rate limiting with generous quotas

Get started quickly with our step-by-step integration guide. Our support team is ready to help you at every step of your integration journey.

Authentication

The REVER Admin API uses API key authentication.

Authenticating via API Key

This authentication method is primarily used for server-to-server (unattended) integrations. You must request an API key through your account manager.\nThe API key must be kept secure and confidential, do not share it with anyone.

To authenticate a request using an API key, include the header x-rever-api-key. Example: x-rever-api-key: 87bf223499abeef

Download OpenAPI description
storefront.json
storefront.yaml
Overview
URL
https://itsrever.com
REVER
developer@itsrever.com
Languages
Servers
Mock server
https://docs.itsrever.com/_mock/apis/storefront/

Return Request

Returns are a way to return items to the store.

Operations

Get active returns

Request

Get all active returns for a user

Query
order_idsArray of stringsrequired
curl -i -X GET \
  'https://docs.itsrever.com/_mock/apis/storefront/returns?order_ids=string'

Responses

Successful response

Bodyapplication/json
returnsArray of objects
Response
application/json
{
  "returns": [
    { … }
  ]
}

Start a return intent for a user

Request

Start a return intent for a user

Bodyapplication/jsonrequired
emailstring
order_numberstring
curl -i -X POST \
  https://docs.itsrever.com/_mock/apis/storefront/returns/intent/start \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "order_number": "string"
  }'

Responses

Order details to show in the portal

Bodyapplication/json
orderobject
Response
application/json
{
  "order": {
    "id": "string",
    "currency": "string",
    "line_items": [ … ],
    "return_id": "string",
    "customer_token": "string"
  }
}

Add an item to a return

Request

Add an item to a return

Path
return_idstringrequired
Query
line_item_idstring
curl -i -X POST \
  'https://docs.itsrever.com/_mock/apis/storefront/returns/{return_id}/save_client_preferences?line_item_id=string'

Responses

Successful response

Bodyapplication/json
return_idstring
pending_credit_to_useinteger
Example: 200
currencystring
Example: "EUR"
Response
application/json
{
  "return_id": "string",
  "pending_credit_to_use": 200,
  "currency": "EUR"
}

Exchange Options

Exchange options are the steps when the user decides to return an item. The first step is to get the available exchange options and try to get the best exchange option for the user.

Operations

Return Reasons

Return reasons are the reasons why the user wants to return an item available for the ecommerce.

Operations

Refund Options

Refund options are a way to refund items. A refund is not an exchange, the available refund options are BANK_TRANSFER, STORE_CREDIT, GIFT_CARD, ORIGINAL_PAYMENT_METHOD.

Operations

Return Options

Return options are a way to return items to the store.

Operations

Return Checkout

Checkout is the final step when the user decides to return an item. The user will be redirected to the checkout page to complete the return.

Operations

Tracking and Status

Tracking and status are a way to track and status of a return.

Operations
REVER all rights reserved.