# iF returns - Logistic API

API to allow the integration with merchants

Version: 1.4.2

## Servers

Development Server
```
https://api.dev.ifreturns.com/integration/v1
```

Staging Server
```
https://api.stg.ifreturns.com/integration/v1
```

Production Server
```
https://api.ifreturns.com/integration/v1
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[iF returns - Logistic API](https://docs.ifreturns.com/_bundle/apis/returns.yaml)

## Returns

### List all return requests

 - [GET /returns](https://docs.ifreturns.com/apis/returns/returns/getreturns.md): Allows to get the list of return requested through the iF returns channels (e.g. returns portal). Each return request contains the list of returned items, origin address, and associated transport data. In case any parameter is sent, the last 100 returns created will be returned

### Get a specific return request

 - [GET /returns/{return_id}](https://docs.ifreturns.com/apis/returns/returns/getreturn.md): Get detailed information of a single return based on its ID

### List all return transportations

 - [GET /returns/{return_id}/transportations](https://docs.ifreturns.com/apis/returns/returns/gettransportations.md): Get information of a transportations scheduled to receive the return items of an exchange/return request

### Get a specific return transportation

 - [GET /returns/{return_id}/transportations/{transportation_id}](https://docs.ifreturns.com/apis/returns/returns/gettransporation.md): Get detailed information of a scheduled transportation based on its ID

### List all the refunds of a return request

 - [GET /returns/{return_id}/refunds](https://docs.ifreturns.com/apis/returns/returns/getrefunds.md): Get information of the different refunds/resolutions executed for a return request

## Order Cancellation Returns

### Create a return and cancel the order

 - [POST /order_cancellation_returns](https://docs.ifreturns.com/apis/returns/order-cancellation-returns/createreturnandcancelorder.md): Create an return over an order that never was picked up by the customer. The return will cancel the order in the ecommerce platform regardless it was fulfilled or not

### Create a return and remove items

 - [POST /line_items_cancellation_returns](https://docs.ifreturns.com/apis/returns/order-cancellation-returns/createreturnandremoveitems.md): Create an return for those items that can not be fulfilled (e.g. out-of-stock of the item). In case all the items are reported, the ecommerce order will be cancelled

## Store Returns

### Register an in-store return

 - [POST /store_returns](https://docs.ifreturns.com/apis/returns/store-returns/createinstorereturn.md): Registering a new return made by the customer in a physical store of the merchant

## Gradings of Return

### Register validation of the returned items

 - [POST /gradings](https://docs.ifreturns.com/apis/returns/gradings-of-return/creategrading.md): Allows to notify the result of validation process for returned items

### Register validation of returns for an ecommere order

 - [POST /orders/{order_name}/return_gradings](https://docs.ifreturns.com/apis/returns/gradings-of-return/creategradingfororderreturn.md): Allows to notify the result of validation process of the returns received by the merchant operational teams

## Transportations

### Register tracking status

 - [POST /shipping_trackings](https://docs.ifreturns.com/apis/returns/transportations/createshippingtracking.md): It allows to update the tracking status of an active tranportation

### Create shipping label

 - [POST /shipping_labels](https://docs.ifreturns.com/apis/returns/transportations/createshippinglabel.md): Create a shipping label for the transportation of the items

### Get a shipping label

 - [GET /shipping_labels](https://docs.ifreturns.com/apis/returns/transportations/getshippinglabel.md): Get an existing shipping label

### Update the shipping label

 - [PUT /shipping_labels](https://docs.ifreturns.com/apis/returns/transportations/updateshippinglabel.md): It allows to update the shipping label of an existing transportation in the platform

### Calculate available PUDOs

 - [POST /pudos](https://docs.ifreturns.com/apis/returns/transportations/calculatepudosforreturn.md): Calculate the PUDOs can be used to ship the items. The PUDOs are calculated based on a reference address. Before call this endpoint, the list of avaiable return methods should be calculated in order to obtain the carrier data. It is mandatory to inform either the address or the geolocation data

## Return Methods

### Calculate the available return methods

 - [POST /return_methods](https://docs.ifreturns.com/apis/returns/return-methods/calculatereturnmethodsforreturn.md): Calculate the return methods the customer can use to ship the returned items. The available return methods are calculated based on the data of the ecoommerce order and the list of the returned items selected by the customer