Skip to content
API Reference
/
Gradings of Return

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

Gradings of Return

Operations

Register validation of the returned items

Request

Allows to notify the result of validation process for returned items

Security
bearerAuth
Body
shopCodestring

Shop code which belongs the return request or RMA. This field is mandatory if the authorization token will be used by more than one shop. 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"
shipmentIdstringrequired

ID of the shipment. The ID must exist in the platform. API will use this value to search the shipment whose status will be updated.

Example: "R1-64231"
shipmentIdTypestringrequired

Type of ID that is being reported * RETURN_ID - ID of the return. The last active shipment/transport will be searched. This value is generated by iF at the moment the return request is created. It has the GUID format (f1844145-28a8-48d5-97b4-b00505e98cdc) * RETURN_NAME - Name of the return. The last active shipment/transport will be searched. This value is generated by iF at the moment the return request is created. It has the format R#-{ORDER_NAME} (R1-64231)

Enum"RETURN_ID""RETURN_NAME"
Example: "RETURN_NAME"
statusstring(GradingReturnStatus)required

Grading status of the return assigned after the validation

Enum"OK""INCIDENT"
Example: "OK"
itemsWithIncidentsArray of objects(GradedLineItemWithIncident)
curl -i -X POST \
  https://docs.ifreturns.com/_mock/apis/returns/gradings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/only-registered+json' \
  -d '{
    "shopCode": "marchelacolombine",
    "shipmentId": "R1-64231",
    "shipmentIdType": "RETURN_NAME",
    "status": "OK",
    "itemsWithIncidents": [
      {
        "sku": "1234567",
        "barcode": "8893892",
        "status": "DEFECT-ODOURS-OR-DIRTY",
        "note": "picking error",
        "validatedAt": "2022-11-17 12:01:00"
      }
    ]
  }'

Responses

Successful operation

Bodyapplication/json
statusCodestring
Example: "200"
descriptionstring
Example: "Your grading have been received correctly"
Response
application/json
{
  "statusCode": "200",
  "description": "Your grading have been received correctly"
}

Register validation of returns for an ecommere order

Request

Allows to notify the result of validation process of the returns received by the merchant operational teams

Security
bearerAuth
Path
order_namestring(uuid)required

Name of ecommerce order

Example: 8e1b8c92-37a9-44c6-952a-b86bce1d8cfb
Bodyapplication/new-items+json
shopCodestring

Shop code which belongs the return request or RMA. This field is mandatory if the authorization token will be used by more than one shop. 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"
returnNamestring

Name of the return that has been validated

Example: "R1-64231"
returnLineItemsArray of objects(GradedLineItem)required

List of items that have been graded

returnLineItems[].​skustringrequired

SKU of the graded item

returnLineItems[].​statusstring(GradingValidationStatus)required

Validation status assigned to the graded item

Enum"APPROVED""REJECTED"
Example: "APPROVED"
returnLineItems[].​notestring

Additional notes for the validation of the item

returnLineItems[].​validatedAtstring(date-time)

Date when the validation was performed (UTC)

Example: "2022-11-17 12:01:00"
returnLineItems[].​refundTypestring(RefundType)

Refund method the customer can select for the returned item

Enum"ORIGINAL_PAYMENT_METHOD""STORE_CREDIT""EXCHANGE""GIFT_CARD"
curl -i -X POST \
  https://docs.ifreturns.com/_mock/apis/returns/orders/8e1b8c92-37a9-44c6-952a-b86bce1d8cfb/return_gradings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/new-items+json' \
  -d '{
    "shopCode": "marchelacolombine",
    "returnName": "R1-64231",
    "returnLineItems": [
      {
        "sku": "string",
        "status": "APPROVED",
        "note": "string",
        "validatedAt": "2022-11-17 12:01:00",
        "refundType": "ORIGINAL_PAYMENT_METHOD"
      }
    ]
  }'

Responses

Successful operation

Bodyapplication/json
statusCodestring
Example: "200"
descriptionstring
Example: "Your grading have been received correctly"
Response
application/json
{
  "statusCode": "200",
  "description": "Your grading have been received correctly"
}

Transportations

Operations

Return Methods

Operations