Skip to content
API Reference
/
Store Returns

iF returns - Inverse Logistic API (1.2.10)

API to allow the integration with merchants

Download OpenAPI description
returns.json
returns.yaml
Overview
E-mail

dev@ifreturns.com

Languages
Servers
Mock server

https://docs.ifreturns.com/_mock/apis/returns/

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/

iFreturns REST API

integration with merchants

Returns

Operations

Order Cancellation Returns

Operations

Store Returns

Operations

Register an in-store return

Request

Registering a new return made by the customer in a physical store of the merchant

Security
bearerAuth
Bodyapplication/json
shopCodestring

Shop code which belongs the return. In case this field is not informed, it will be obtained from security context. In case it is informed, it will be validated against the security context

Example: "marchelacolombine"
orderNamestringrequired

Ecommerce order name

Example: "7848"
customerEmailstringrequired

Email associated to the customer

Example: "customer@if.com"
customerPhonestring

Phone associated to the customer

Example: "+34666666666"
returnLineItemsArray of objects(StoreReturnLineItem)required

List of returned items

returnLineItems[].​barcodestringrequired

Barcode of the returned item

Example: "8893892"
returnLineItems[].​quantitynumber(int)

Items units returned

Example: 1
returnLineItems[].​refundTypestring(RefundType)required

Refund method the customer can select for the returned item

Enum"ORIGINAL_PAYMENT_METHOD""STORE_CREDIT""EXCHANGE""GIFT_CARD"
returnLineItems[].​refundModestring(RefundMode)required

Mode in which the returned item will be refunded

Enum"PRE_VALIDATION""SHIPPING_COMPLETED""SHIPPING_IN_PROGRESS""POST_VALIDATION""MANUAL""INSTANT""DROP_OFF"
curl -i -X POST \
  https://docs.ifreturns.com/_mock/apis/returns/store_returns \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "shopCode": "marchelacolombine",
    "orderName": "7848",
    "customerEmail": "customer@if.com",
    "customerPhone": "+34666666666",
    "returnLineItems": [
      {
        "barcode": "8893892",
        "quantity": 1,
        "refundType": "ORIGINAL_PAYMENT_METHOD",
        "refundMode": "PRE_VALIDATION"
      }
    ]
  }'

Responses

Successful operation

Bodyapplication/json
statusCodestring
Example: "200"
descriptionstring
Example: "Your return have been registered correctly"
returnobject
Response
application/json
{
  "statusCode": "200",
  "description": "Your return have been registered correctly",
  "return": {
    "id": "eaea3209-68c9-4493-9df5-415f1b52003a",
    "name": "R1-7848",
    "shopCode": "marchelacolombine"
  }
}

Gradings of Return

Operations

Transportations

Operations

Return Methods

Operations