Skip to content
/
FindExchangeOrder

REVER Admin API (1.0.0)

Summary

Introduction

  • Overview: The REVER ADMIN API provides seamless integration for managing returns through three main categories: Reverse Logistics, Processes, and Settings.
  • Logistics: Handles all operations related to package returns, including shipment tracking, warehouse logistics, and return labels for items sent back to the eCommerce warehouse.
  • Processes: Manages return workflows, including return statuses, item inspections, and actions that can be taken on a return, such as refunds, exchanges, or inspections.
  • Settings: Contains configuration information REVER uses to execute return processes, including return rules, time limits, and warehouse preferences.

OpenAPI Specification

You can download the OpenAPI specification file here to generate your client code.

this API is meant to be used for returns that are already created or processed. The API is not meant to be used to start returns from the customer portal. For integrating with your own portal please take a look at the Storefront API.

E-commerce IDs and Groups

Most commonly, you will only need to use the e-commerce ID provided during onboarding. However, if you need to manage multiple e-commerce stores simultaneously, a group ID is required. An e-commerce group is an identifier that groups multiple e-commerce stores that are managed together. Typically, these are different brands belonging to the same parent company.

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. The 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

Rate Limiting

The API implements rate limiting. If you receive a 429 error response, please wait a few seconds before retrying.

Download OpenAPI description
admin.json
admin.yaml
Languages
Servers
https://api.byrever.com

Logistics

Collection of methods that provide logistics services including CRUD operations for logistics orders, pickups, etc. Also handles logistics-related files like shipping labels.

Operations

Processes

Collection of methods for managing return processes. It includes CRUD operations and status updates.

Operations

Settings

Collection of methods for managing e-commerce configurations. It includes GET operations for e-commerce stores, warehouses, and other settings.

Operations

FindBranding

Request

Endpoint for retrieving branding configuration

Security
API Key
Path
ecommerce_idstringrequired

The ID of the e-commerce store. Optional.

Query
slugstring

The URL path identifier for the e-commerce store. Optional.

groupstring

The group identifier for the e-commerce store. Multiple stores can share the same group. Optional.

curl -i -X GET \
  'https://api.byrever.com/v1/configs/branding/{ecommerce_id}?slug=string&group=string' \
  -H 'x-rever-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
background_image_urlstring

BackgroundImageUrl

background_text_colorstring

BackgroundTextColor

border_radiusstring

BorderRadius

ecommerce_idstring

EcommerceID

favicon_urlstring

FaviconUrl

full_catalog_product_image_ratiostring

FullCatalogProductImageRatio

input_variantstring

InputVariant

layout_design_valuesstring(enum)

LayoutDesignValues

Enum"DEFAULT""VERTICAL""SIMPLIFIED"
logo_height_desktopstring

LogoHeightDesktop

logo_height_mobilestring

LogoHeightMobile

logo_urlstring

LogoUrl

mail_logo_urlstring

MailLogoUrl

mail_main_colorstring

MailMainColor

persistent_logo_typestring(enum)

PersistentLogoType

Enum"PERSISTENT_LOGO_TYPE_UNSPECIFIED""PERSISTENT_LOGO_TYPE_ENABLED""PERSISTENT_LOGO_TYPE_DISABLED"
primary_theme_color_contrast_textstring

PrimaryThemeColorContrastText

primary_theme_color_darkstring

PrimaryThemeColorDark

primary_theme_color_lightstring

PrimaryThemeColorLight

primary_theme_color_mainstring

PrimaryThemeColorMain

secondary_theme_color_contrast_textstring

SecondaryThemeColorContrastText

secondary_theme_color_darkstring

SecondaryThemeColorDark

secondary_theme_color_lightstring

SecondaryThemeColorLight

secondary_theme_color_mainstring

SecondaryThemeColorMain

sloganstring

Slogan

titlestring

Title

Response
application/json
{
  "background_image_url": "string",
  "background_text_color": "string",
  "border_radius": "string",
  "ecommerce_id": "string",
  "favicon_url": "string",
  "full_catalog_product_image_ratio": "string",
  "input_variant": "string",
  "layout_design_values": "DEFAULT",
  "logo_height_desktop": "string",
  "logo_height_mobile": "string",
  "logo_url": "string",
  "mail_logo_url": "string",
  "mail_main_color": "string",
  "persistent_logo_type": "PERSISTENT_LOGO_TYPE_UNSPECIFIED",
  "primary_theme_color_contrast_text": "string",
  "primary_theme_color_dark": "string",
  "primary_theme_color_light": "string",
  "primary_theme_color_main": "string",
  "secondary_theme_color_contrast_text": "string",
  "secondary_theme_color_dark": "string",
  "secondary_theme_color_light": "string",
  "secondary_theme_color_main": "string",
  "slogan": "string",
  "title": "string"
}

FindExchangeConditions

Request

endpoint for finding ExchangeConditions model

Security
API Key
Path
ecommerce_idstringrequired

The id of the e-commerce. Optional.

Query
slugstring

The path of an URL identifying the e-commerce. Optional.

groupstring

The group of the e-commerce. Several e-commerces can have the same group. Optional.

curl -i -X GET \
  'https://api.byrever.com/v1/configs/exchangeconditions/{ecommerce_id}?slug=string&group=string' \
  -H 'x-rever-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
ecommerce_idstring

EcommerceID

exchange_flowstring(enum)

exchange flow

Enum"NO_EXCHANGE_FLOW""OPEN""ONE_ON_ONE""OPEN_WITH_GIFT_CARD""FULL"
platform_main_menu_idstring

PlatformMainMenuID

thresholdinteger(int32)

Threshold

Response
application/json
{
  "ecommerce_id": "string",
  "exchange_flow": "NO_EXCHANGE_FLOW",
  "platform_main_menu_id": "string",
  "threshold": 0
}

FindExchangeOrder

Request

endpoint for finding ExchangeOrder model

Security
API Key
Path
ecommerce_idstringrequired

The id of the e-commerce. Optional.

Query
slugstring

The path of an URL identifying the e-commerce. Optional.

groupstring

The group of the e-commerce. Several e-commerces can have the same group. Optional.

curl -i -X GET \
  'https://api.byrever.com/v1/configs/exchangeorders/{ecommerce_id}?slug=string&group=string' \
  -H 'x-rever-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
ecommerce_idstring

EcommerceID

payment_methodstring

PaymentMethod

pricestring

Price

shipping_linestring

ShippingLine

Response
application/json
{
  "ecommerce_id": "string",
  "payment_method": "string",
  "price": "string",
  "shipping_line": "string"
}

FindLogisticSetting

Request

endpoint for finding LogisticSetting model

Security
API Key
Path
ecommerce_idstringrequired

The id of the e-commerce. Optional.

Query
slugstring

The path of an URL identifying the e-commerce. Optional.

groupstring

The group of the e-commerce. Several e-commerces can have the same group. Optional.

curl -i -X GET \
  'https://api.byrever.com/v1/configs/logisticsetting/{ecommerce_id}?slug=string&group=string' \
  -H 'x-rever-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
delivery_note_typestring

DeliveryNoteType

ecommerce_idstring

EcommerceID

reminder_flowstring

ReminderFlow

return_logisticsArray of objects(pb.ReturnLogistics)

ReturnLogistics

store_list_urlstring

StoreListUrl

Response
application/json
{
  "delivery_note_type": "string",
  "ecommerce_id": "string",
  "reminder_flow": "string",
  "return_logistics": [
    { … }
  ],
  "store_list_url": "string"
}

FindRefundConfiguration

Request

FindRefundConfiguration

Security
API Key
Query
slugstring

The path of an URL identifying the e-commerce. Optional.

ecommerce_idstring

The id of the e-commerce. Optional.

groupstring

The group of the e-commerce. Several e-commerces can have the same group. Optional.

curl -i -X GET \
  'https://api.byrever.com/v1/configs/refunds?slug=string&ecommerce_id=string&group=string' \
  -H 'x-rever-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
action_configsArray of objects(pb.ActionConfig)

ActionConfig

carry_over_automatic_discounts_on_exchangesboolean

carry_over_automatic_discounts_on_exchanges

ecommerce_idstring

ecommerce id

payment_method_configsArray of objects(pb.PaymentMethodConfig)

PaymentMethodConfig

revoke_conditional_discountsboolean

revoke_conditional_discounts

round_promocodeboolean

round_promocode

Response
application/json
{
  "action_configs": [
    { … }
  ],
  "carry_over_automatic_discounts_on_exchanges": true,
  "ecommerce_id": "string",
  "payment_method_configs": [
    { … }
  ],
  "revoke_conditional_discounts": true,
  "round_promocode": true
}

FindReturnProcessConditions

Request

endpoint for finding LogisticsSettings model

Security
API Key
Path
ecommerce_idstringrequired

The id of the e-commerce. Optional.

Query
slugstring

The path of an URL identifying the e-commerce. Optional.

groupstring

The group of the e-commerce. Several e-commerces can have the same group. Optional.

curl -i -X GET \
  'https://api.byrever.com/v1/configs/returnconditions/{ecommerce_id}?slug=string&group=string' \
  -H 'x-rever-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
ecommerce_idstring

EcommerceID

keep_your_itemobject

Keep your item

max_days_to_send_packageinteger(int32)

MaxDaysToSendPackage

non_returnable_brand_idsArray of strings

NonReturnableBrandIds

non_returnable_category_idsArray of strings

NonReturnableCategoryIds

non_returnable_collection_idsArray of strings

NonReturnableCollectionIds

non_returnable_order_tag_idsArray of strings

NonReturnableOrderTagIds

non_returnable_product_idsArray of strings

NonReturnableProductIds

non_returnable_tag_idsArray of strings

NonReturnableTagIds

pay_for_logisticsobject

PayForLogistics

payments_enabledboolean

PaymentsEnabled

require_authorizationobject

RequireAuthorization

return_period_daysinteger(int32)

ReturnPeriodDays

review_auto_complete_daysinteger(int32)

Days to wait after the parcel reaches the warehouse before auto-completing a MANUAL-review process with no review, marking unreviewed items as MISSING. 0 disables auto-completion (the process waits indefinitely for a review).

review_flowstring

ReviewFlow

skip_fraud_detectionboolean

SkipFraudDetection

skip_workflow_activitiesArray of strings

List of workflow activities to skip (e.g., "GenerateLogisticOrder", "SendACKEmail") protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED

start_return_on_platform_timestring(enum)

StartReturnOnPlatformTime

Enum"START_RETURN_ON_PLATFORM_TIME_UNSPECIFIED""START_RETURN_ON_PLATFORM_TIME_ON_START""START_RETURN_ON_PLATFORM_TIME_ON_ITEM_VERIFICATION""START_RETURN_ON_PLATFORM_TIME_NEVER"
upload_documentsobject

UploadDocuments

Response
application/json
{
  "ecommerce_id": "string",
  "keep_your_item": {
    "enabled": true,
    "options": [ … ]
  },
  "max_days_to_send_package": 0,
  "non_returnable_brand_ids": [
    "string"
  ],
  "non_returnable_category_ids": [
    "string"
  ],
  "non_returnable_collection_ids": [
    "string"
  ],
  "non_returnable_order_tag_ids": [
    "string"
  ],
  "non_returnable_product_ids": [
    "string"
  ],
  "non_returnable_tag_ids": [
    "string"
  ],
  "pay_for_logistics": {
    "always": true,
    "options": [ … ]
  },
  "payments_enabled": true,
  "require_authorization": {
    "always": true,
    "options": [ … ]
  },
  "return_period_days": 0,
  "review_auto_complete_days": 0,
  "review_flow": "string",
  "skip_fraud_detection": true,
  "skip_workflow_activities": [
    "string"
  ],
  "start_return_on_platform_time": "START_RETURN_ON_PLATFORM_TIME_UNSPECIFIED",
  "upload_documents": {
    "always": true,
    "options": [ … ]
  }
}

FindWarehousesByEcommerce

Request

endpoint for finding Warehouses by ecommerce id

Security
API Key
Path
ecommerce_idstringrequired

The id of the e-commerce. Optional.

Query
slugstring

The path of an URL identifying the e-commerce. Optional.

groupstring

The group of the e-commerce. Several e-commerces can have the same group. Optional.

curl -i -X GET \
  'https://api.byrever.com/v1/configs/ecommerces/{ecommerce_id}/warehouses?slug=string&group=string' \
  -H 'x-rever-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
warehousesArray of objects(pb.Warehouse)

List of warehouses

Response
application/json
{
  "warehouses": [
    { … }
  ]
}

FindEcommerce

Request

endpoint for finding Ecommerce model

Security
API Key
Path
ecommerce_idstringrequired

The id of the e-commerce.

Query
slugstring

The path of an URL identifying the e-commerce. Optional.

groupstring

The group of the e-commerce. Several e-commerces can have the same group. Optional.

curl -i -X GET \
  'https://api.byrever.com/v1/configs/ecommerce/{ecommerce_id}?slug=string&group=string' \
  -H 'x-rever-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
are_partial_reviews_allowedboolean

Allows incrementally reviewing the line items of a process, that is, does not require to bring all of the line items at once

currency_codestring

CurrencyCode

ecommerce_idstring

EcommerceID

email_providerstring(enum)

EmailProvider

Enum"EMAIL_PROVIDER_UNSPECIFIED""EMAIL_PROVIDER_AWS_SES""EMAIL_PROVIDER_INDITEX"
external_return_policy_urlstring

external policy url

groupstring

Group

identification_flowstring(enum)

How shoppers identify their orders

Enum"IDENTIFICATION_FLOW_UNSPECIFIED""ORDER_ID_AND_EMAIL""ORDER_ID_AND_POSTAL_CODE"
is_enabledboolean

IsEnabled

is_testingboolean

IsTesting

mark_unreviewed_items_as_missingboolean

When a review brings fewer line items than expected, treat every unit not present in the review as MISSING instead of rejecting the review

namestring

name

orders_sync_disabledboolean

OrdersSyncDisabled

platformstring

Platform

restocking_enabledboolean

RestockingEnabled

slugstring

slug

store_idstring

StoreID

use_casestring

UseCase

website_urlstring

WebsiteURL

Response
application/json
{
  "are_partial_reviews_allowed": true,
  "currency_code": "string",
  "ecommerce_id": "string",
  "email_provider": "EMAIL_PROVIDER_UNSPECIFIED",
  "external_return_policy_url": "string",
  "group": "string",
  "identification_flow": "IDENTIFICATION_FLOW_UNSPECIFIED",
  "is_enabled": true,
  "is_testing": true,
  "mark_unreviewed_items_as_missing": true,
  "name": "string",
  "orders_sync_disabled": true,
  "platform": "string",
  "restocking_enabled": true,
  "slug": "string",
  "store_id": "string",
  "use_case": "string",
  "website_url": "string"
}

FindWarehouse

Request

endpoint for finding Warehouse model

Security
API Key
Path
idstringrequired

ID

curl -i -X GET \
  'https://api.byrever.com/v1/configs/warehouses/{id}' \
  -H 'x-rever-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
address_line1string

AddressLine1

address_line2string

AddressLine2

citystring

City

companystring

Company

countrystring

Country

country_codestring

CountryCode

ecommerce_idstring

EcommerceID

emailstring

Email

first_namestring

FirstName

idstring

ID

last_namestring

LastName

phonestring

Phone

postcodestring

Postcode

state_provincestring

StateProvince

state_province_codestring

StateProvinceCode

Response
application/json
{
  "address_line1": "string",
  "address_line2": "string",
  "city": "string",
  "company": "string",
  "country": "string",
  "country_code": "string",
  "ecommerce_id": "string",
  "email": "string",
  "first_name": "string",
  "id": "string",
  "last_name": "string",
  "phone": "string",
  "postcode": "string",
  "state_province": "string",
  "state_province_code": "string"
}

Returns

Public endpoints for creating/importing returns.

REVER all rights reserved.