# REVER Admin API ## 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](https://api.byrever.com/v1/docs/openapi.yaml) 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. Version: 1.0.0 ## Security ### BasicAuth Type: http Scheme: basic ### BearerAuth Type: http Scheme: bearer ### ApiKeyAuth Type: apiKey In: header Name: X-API-Key ## Download OpenAPI description [REVER Admin API](https://docs.itsrever.com/_bundle/apis/admin.yaml) ## Logistics Collection of methods that provide logistics services including CRUD operations for logistics orders, pickups, etc. Also handles logistics-related files like shipping labels. ### UpdateLKSS - [POST /v1/processes/{process_id}/shipping_status](https://docs.itsrever.com/apis/admin/logistics/updatelkss.md) ### GetLabelURL - [GET /v1/processes/{process_id}/label](https://docs.itsrever.com/apis/admin/logistics/getlabelurl.md): GetLabelURL creates a URL to download the label file associated to the given process_id ### GetReverseDeliveryInfo - [GET /v1/processes/{process_id}/logistics](https://docs.itsrever.com/apis/admin/logistics/getreversedeliveryinfo.md): Get the reverse delivery information of a Return Process ### CreatePickup - [POST /v1/processes/{process_id}/pickup](https://docs.itsrever.com/apis/admin/logistics/createpickup.md): Creates a pickup for a given process_id, customer and address A logistic order must be created prior requesting a pickup Must specify the provider and carrier to be used to create the pickup: - Returns UNIMPLEMENTED (gRPC code 12) if the provider is OPS, meaning it didn't generated any action. - Returns InvalidArgument (gRPC code 3) if the combination of return-method, providerand carrier is not supported. ### CreateReverseDelivery - [POST /v1/processes/{process_id}/logistics/](https://docs.itsrever.com/apis/admin/logistics/createreversedelivery.md): SaveManuallyCreatedLogisticOrder creates a logistic order associated to a given process_id, and saves the label file in the database ### CreateOrderV2 - [PUT /v1/processes/{process_id}/logistics/](https://docs.itsrever.com/apis/admin/logistics/createorderv2.md): Creates a logistic order for a given process_id, customer and address. Must specify the provider and carrier to be used to create the pickup. - Returns UNIMPLEMENTED (gRPC code 12) if the provider is OPS, meaning it didn't generated any action. - Returns InvalidArgument (gRPC code 3) if the combination of return-method, providerand carrier is not supported. ## Processes Collection of methods for managing return processes. It includes CRUD operations and status updates. ### SearchReturnProcesses - [GET /v1/processes/search](https://docs.itsrever.com/apis/admin/processes/searchreturnprocesses.md): Search for return processes ### GetReturnSummary - [GET /v1/processes/{process_id}](https://docs.itsrever.com/apis/admin/processes/getreturnsummary.md): Get a Return Summary ### PatchReturnProcess - [PATCH /v1/processes/{process_id}/patch](https://docs.itsrever.com/apis/admin/processes/patchreturnprocess.md): Updates a return process via a PATCH (updating only certain fields) ### MarkAsRefunded - [POST /v1/processes/{process_id}/mark-as-refunded](https://docs.itsrever.com/apis/admin/processes/markasrefunded.md): Marks the line items of the request as refunded ### AddReview - [POST /v1/processes/{process_id}/reviews/](https://docs.itsrever.com/apis/admin/processes/addreview.md): Adds a review (approve/decline/missing) to a given process ### Creates a Return - [POST /v1/public/returns/{ecommerce_id}/import_return](https://docs.itsrever.com/apis/admin/processes/importreturn.md): Creates a new return record using a valid reason name obtained from the 'Get Return Reasons' endpoint. ### Submit reviews for all items in a return process - [POST /v1/ops/ecommerce/review](https://docs.itsrever.com/apis/admin/processes/submitprocessreviews.md): Notify REVER when a return has been reviewed. Reviews must cover every line item of the process. Notes: - Reviews of a return process must be done in full; unreviewed items will block processing. - If an expected item was not received, set status: "MISSING". - Optionally override the refund amount with refund_override. ### UpdateLogistics - [POST /v1/processes/{process_id}/logistics](https://docs.itsrever.com/apis/admin/processes/updatelogistics.md): Updates the logistics fields associated to a given return process ### GetReturnDocuments - [GET /v1/processes/{process_id}/documents](https://docs.itsrever.com/apis/admin/processes/getreturndocuments.md): Returns all the documents uploaded for a given return process ### AuthorizeReturnProcess - [POST /v1/processes/{process_id}/authorize](https://docs.itsrever.com/apis/admin/processes/authorizereturnprocess.md) ### GetAuthorizationStatus - [GET /v1/processes/{process_id}/authorization/status](https://docs.itsrever.com/apis/admin/processes/getauthorizationstatus.md): GetAuthorizationStatus returns the authorization status and details of a process ## Settings Collection of methods for managing e-commerce configurations. It includes GET operations for e-commerce stores, warehouses, and other settings. ### FindBranding - [GET /v1/configs/branding/{ecommerce_id}](https://docs.itsrever.com/apis/admin/settings/findbranding.md): Endpoint for retrieving branding configuration ### FindEcommerce - [GET /v1/configs/ecommerces/{ecommerce_id}](https://docs.itsrever.com/apis/admin/settings/findecommerce.md): endpoint for finding Ecommerce model ### FindExchangeConditions - [GET /v1/configs/ecommerces/{ecommerce_id}/exchangesconditions/](https://docs.itsrever.com/apis/admin/settings/findexchangeconditions.md): endpoint for finding ExchangeConditions model ### FindExchangeOrder - [GET /v1/configs/ecommerces/{ecommerce_id}/exchangeorders/](https://docs.itsrever.com/apis/admin/settings/findexchangeorder.md): endpoint for finding ExchangeOrder model ### FindLogisticSetting - [GET /v1/configs/ecommerces/{ecommerce_id}/logistics/](https://docs.itsrever.com/apis/admin/settings/findlogisticsetting.md): endpoint for finding LogisticSetting model ### FindRefundConfiguration - [GET /v1/configs/ecommerces/{ecommerce_id}/refunds](https://docs.itsrever.com/apis/admin/settings/findrefundconfiguration.md): FindRefundConfiguration ### FindReturnProcessConditions - [GET /v1/configs/ecommerces/{ecommerce_id}/returnconditions/](https://docs.itsrever.com/apis/admin/settings/findreturnprocessconditions.md): endpoint for finding LogisticsSettings model ### FindWarehousesByEcommerce - [GET /v1/configs/ecommerces/{ecommerce_id}/warehouses](https://docs.itsrever.com/apis/admin/settings/findwarehousesbyecommerce.md): endpoint for finding Warehouses by ecommerce id ### FindWarehouse - [GET /v1/configs/ecommerces/{ecommerce_id}/warehouses/{id}](https://docs.itsrever.com/apis/admin/settings/findwarehouse.md): endpoint for finding Warehouse model