iF returns API

iF Returns Webhooks 1.2.1

Webhooks to allow the integration with merchants

Operations

RECEIVE return.created
The event is published when the return is requested from the portal or by API ivocation

Operation IDpublish
Accepts the following message:
Message IDReturnCreated
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

object
Return request object

id
string
format: uuid
Internal ID of the return order

shopCode
string
Shop code which belongs the return

name
string
Return Merchant Authorization (RMA) name

createdAt
string
format: date-time
Date when the return order was created

updatedAt
string
format: date-time
Date when the return order was updated

cancelledAt
string
format: date-time
Date when the return order was updated

status
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
totalReturnFee
number
format: float
Fee associated with the method of return

totalReturnAmount
number
format: float
Total amount of the all returned items

totalTax
number
format: float
Total tax of the all returned items

totalRefund
number
format: float
Total amount to be refund (totalReturnAmount - totalReturnFee)

currency
string
Transaction currency

baseTotalReturnFee
number
format: float
Fee associated with the method of return in shop base currency

baseTotalReturnAmount
number
format: float
Total amount of the all returned items in shop base currency

baseTotalTax
number
format: float
Total tax of the all returned items in shop base currency

baseTotalRefund
number
format: float
Total amount to be refund in shop base currency (baseTotalReturnAmount - baseTotalReturnFee)

baseCurrency
string
Shop base currency

object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
array<object>
List of returned items

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "id": "c5b6ba94-5b15-4911-90b0-e6dca0ffcd78", "time": "2018-04-05T17:31:02.735Z", "type": "return.created", "dataContentType": "application/json", "data": { "resource": { "id": "8e1b8c92-37a9-44c6-952a-b86bce1d8cfb", "shopCode": "marchelacolombine", "name": "R1-7848", "createdAt": "2022-11-17 12:01:02.735Z", "updatedAt": "2022-11-17 12:01:02.735Z", "cancelledAt": "2022-11-17 12:01:02.735Z", "status": "PENDING", "totalReturnFee": 5, "totalReturnAmount": 121, "totalTax": 21, "totalRefund": 116, "currency": "EUR", "baseTotalReturnFee": 5, "baseTotalReturnAmount": 121, "baseTotalTax": 21, "baseTotalRefund": 116, "baseCurrency": "EUR", "customer": { "fullName": "Juan Perez", "email": "customer@if.com", "phone": 34666666666, "address": { "line1": "Calle de Fortunate y Jacinta 12", "line2": "", "city": "Madrid", "postalCode": "28020", "region": "Madrid", "countryCode": "ES" } }, "ecommerceOrder": { "id": "4243234", "name": "7848", "customerId": "23423" }, "returnLineItems": [ { "id": "54048ad6-af97-417c-a8a6-7b19a154c135", "productName": "Camisa", "variantName": "XL Roja", "sku": "1234567", "barcode": "8893892", "vendor": "iFLastmile", "price": 141, "discount": 20, "paid": 121, "tax": 21, "returnAmount": 121, "currency": "EUR", "basePrice": 141, "baseDiscount": 20, "basePaid": 121, "baseTax": 21, "baseReturnAmount": 121, "baseCurrency": "EUR", "quantity": 1, "evidenceImgUrls": [ "https://ifreturns.com/imagen/producto_evidence1.jpg" ], "imageUrl": "https://ifreturns.com/imagen/producto.jpg", "ecommerceLineItem": { "lineItemId": "8e1b8c92", "productId": "1234", "variantId": "XS1234" }, "returnReason": { "code": "dont-like", "reason": "No me gusta", "additionalInfo": "Presenta un fallo en la cremallera" }, "refundType": "ORIGINAL_PAYMENT_METHOD", "refundMode": "PRE_VALIDATION", "exchangeLineItems": [ { "id": "8e1b8c92-37a9-44c6-952a-b86bce1d8cfb", "productName": "Product/12345", "variantName": "Blue Sweater XL Size", "sku": "1234557", "price": 120, "quantity": 1, "vendor": "iFLastmile", "ecommerceProductId": "1234", "ecommerceVariantId": "XL1234" } ] } ] } } }

This example has been generated automatically.
RECEIVE return.scheduled
The event is published when the transport for returned items has been scheduled (pick-up, delivery at drop-off point, etc.)

Operation IDpublish
Accepts the following message:
Message IDReturnScheduled
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

allOf
Event resource data

object
Return request object

id
string
format: uuid
Internal ID of the return order

shopCode
string
Shop code which belongs the return

name
string
Return Merchant Authorization (RMA) name

createdAt
string
format: date-time
Date when the return order was created

updatedAt
string
format: date-time
Date when the return order was updated

cancelledAt
string
format: date-time
Date when the return order was updated

status
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
totalReturnFee
number
format: float
Fee associated with the method of return

totalReturnAmount
number
format: float
Total amount of the all returned items

totalTax
number
format: float
Total tax of the all returned items

totalRefund
number
format: float
Total amount to be refund (totalReturnAmount - totalReturnFee)

currency
string
Transaction currency

baseTotalReturnFee
number
format: float
Fee associated with the method of return in shop base currency

baseTotalReturnAmount
number
format: float
Total amount of the all returned items in shop base currency

baseTotalTax
number
format: float
Total tax of the all returned items in shop base currency

baseTotalRefund
number
format: float
Total amount to be refund in shop base currency (baseTotalReturnAmount - baseTotalReturnFee)

baseCurrency
string
Shop base currency

object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
array<object>
List of returned items

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
required
array<object>
List of transportations scheduled

object
Transport scheduled to collect the return order

id
string
format: uuid
Internal ID of new item

returnId
string
format: uuid
Return ID associated to the transportation

createdAt
string
format: date-time
Date when the Transport was created

status
string
Status of the transport

Allowed values:
"REQUESTED"
"PICK_UP_IN_PROGRESS"
"PICK_UP_COMPLETED"
"SHIPPING_IN_PROGRESS"
"SHIPPING_COMPLETED"
"PICK_UP_FAILED"
"PICK_UP_CANCELLED"
"SHIPPING_FAILED"
"SHIPPING_CANCELLED"
currentActive
boolean
Flag to indicate which transport is active, in case a pickup has failed

serviceMessage
string
Name of the transport chosed by customer

serviceType
string
Type of transport chosed by customer

carrierCode
string
Carrier responsible for the transport

carrierServiceCode
string
Carrier service used for the transport

carrierLabel
string
URL to donwload the carrier label

carrierTrackingUrl
string
URL for tracking the shipment

carrierPickupReference
string
Pickup code generated by the carrier

carrierReference
string
Transport code generated by the carrier

clientReference
string
Internal code generated for the transport

pickupDate
string
Date when the return order will be picked up. Only available in case of home pickup has been scheduled by iF returns

object
Origin address for the transportation

fullName
string
Full name associated to the origin

email
string
Email associated to the origin

phone
string
Phone associated to the origin

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
restricted any
Destination address for the transportation

fullName
string
Full name of the destionation

email
string
Email associated to the destination

phone
string
Phone associated to the destination

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "id": "c5b6ba94-5b15-4911-90b0-e6dca0ffcd78", "time": "2018-04-05T17:31:02.735Z", "type": "return.scheduled", "dataContentType": "application/json", "data": { "resource": { "id": "8e1b8c92-37a9-44c6-952a-b86bce1d8cfb", "shopCode": "marchelacolombine", "name": "R1-7848", "createdAt": "2022-11-17 12:01:02.735Z", "updatedAt": "2022-11-17 12:01:02.735Z", "cancelledAt": "2022-11-17 12:01:02.735Z", "status": "PENDING", "totalReturnFee": 5, "totalReturnAmount": 121, "totalTax": 21, "totalRefund": 116, "currency": "EUR", "baseTotalReturnFee": 5, "baseTotalReturnAmount": 121, "baseTotalTax": 21, "baseTotalRefund": 116, "baseCurrency": "EUR", "customer": { "fullName": "Juan Perez", "email": "customer@if.com", "phone": 34666666666, "address": { "line1": "Calle de Fortunate y Jacinta 12", "line2": "", "city": "Madrid", "postalCode": "28020", "region": "Madrid", "countryCode": "ES" } }, "ecommerceOrder": { "id": "4243234", "name": "7848", "customerId": "23423" }, "returnLineItems": [ { "id": "54048ad6-af97-417c-a8a6-7b19a154c135", "productName": "Camisa", "variantName": "XL Roja", "sku": "1234567", "barcode": "8893892", "vendor": "iFLastmile", "price": 141, "discount": 20, "paid": 121, "tax": 21, "returnAmount": 121, "currency": "EUR", "basePrice": 141, "baseDiscount": 20, "basePaid": 121, "baseTax": 21, "baseReturnAmount": 121, "baseCurrency": "EUR", "quantity": 1, "evidenceImgUrls": [ "https://ifreturns.com/imagen/producto_evidence1.jpg" ], "imageUrl": "https://ifreturns.com/imagen/producto.jpg", "ecommerceLineItem": { "lineItemId": "8e1b8c92", "productId": "1234", "variantId": "XS1234" }, "returnReason": { "code": "dont-like", "reason": "No me gusta", "additionalInfo": "Presenta un fallo en la cremallera" }, "refundType": "ORIGINAL_PAYMENT_METHOD", "refundMode": "PRE_VALIDATION", "exchangeLineItems": [ { "id": "8e1b8c92-37a9-44c6-952a-b86bce1d8cfb", "productName": "Product/12345", "variantName": "Blue Sweater XL Size", "sku": "1234557", "price": 120, "quantity": 1, "vendor": "iFLastmile", "ecommerceProductId": "1234", "ecommerceVariantId": "XL1234" } ] } ], "transportations": [ { "id": "38885822-8d44-4819-8358-345b4d83be70", "returnId": "38885822-8d44-4819-8358-345b4d83be70", "createdAt": "2022-11-17 12:05:02.735Z", "status": "REQUESTED", "currentActive": true, "serviceMessage": "Recogida programada", "serviceType": "pickup", "carrierCode": "CORREOS-EXPRESS", "carrierServiceCode": "correos-epaq-24", "carrierLabel": "https://if.com/P1R1mlc7848.pdf", "carrierTrackingUrl": "https://if.com/tracking/3230006199506927", "carrierPickupReference": "125172899", "carrierReference": "3230006199506927", "clientReference": "P1R1mlc7848", "pickupDate": "2022-11-22", "origin": { "fullName": "Juan Perez", "email": "customer@if.com", "phone": 34666666666, "address": { "line1": "Calle de Fortunate y Jacinta 12", "line2": "", "city": "Madrid", "postalCode": "28020", "region": "Madrid", "countryCode": "ES" } }, "destination": { "fullName": "iF warehouse", "email": "warehouse@if.com", "phone": 34666666666, "address": { "line1": "Calle de Fortunate y Jacinta 12", "line2": "", "city": "Madrid", "postalCode": "28020", "region": "Madrid", "countryCode": "ES" } } } ] } } }

This example has been generated automatically.
RECEIVE return.cancelled
The event is published when the return is cancelled

Operation IDpublish
Accepts the following message:
Message IDReturnCancelled
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

object
Return request object

id
string
format: uuid
Internal ID of the return order

shopCode
string
Shop code which belongs the return

name
string
Return Merchant Authorization (RMA) name

createdAt
string
format: date-time
Date when the return order was created

updatedAt
string
format: date-time
Date when the return order was updated

cancelledAt
string
format: date-time
Date when the return order was updated

status
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
totalReturnFee
number
format: float
Fee associated with the method of return

totalReturnAmount
number
format: float
Total amount of the all returned items

totalTax
number
format: float
Total tax of the all returned items

totalRefund
number
format: float
Total amount to be refund (totalReturnAmount - totalReturnFee)

currency
string
Transaction currency

baseTotalReturnFee
number
format: float
Fee associated with the method of return in shop base currency

baseTotalReturnAmount
number
format: float
Total amount of the all returned items in shop base currency

baseTotalTax
number
format: float
Total tax of the all returned items in shop base currency

baseTotalRefund
number
format: float
Total amount to be refund in shop base currency (baseTotalReturnAmount - baseTotalReturnFee)

baseCurrency
string
Shop base currency

object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
array<object>
List of returned items

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "id": "c5b6ba94-5b15-4911-90b0-e6dca0ffcd78", "time": "2018-04-05T17:31:02.735Z", "type": "return.cancelled", "dataContentType": "application/json", "data": { "resource": { "id": "8e1b8c92-37a9-44c6-952a-b86bce1d8cfb", "shopCode": "marchelacolombine", "name": "R1-7848", "createdAt": "2022-11-17 12:01:02.735Z", "updatedAt": "2022-11-17 12:01:02.735Z", "cancelledAt": "2022-11-17 12:01:02.735Z", "status": "PENDING", "totalReturnFee": 5, "totalReturnAmount": 121, "totalTax": 21, "totalRefund": 116, "currency": "EUR", "baseTotalReturnFee": 5, "baseTotalReturnAmount": 121, "baseTotalTax": 21, "baseTotalRefund": 116, "baseCurrency": "EUR", "customer": { "fullName": "Juan Perez", "email": "customer@if.com", "phone": 34666666666, "address": { "line1": "Calle de Fortunate y Jacinta 12", "line2": "", "city": "Madrid", "postalCode": "28020", "region": "Madrid", "countryCode": "ES" } }, "ecommerceOrder": { "id": "4243234", "name": "7848", "customerId": "23423" }, "returnLineItems": [ { "id": "54048ad6-af97-417c-a8a6-7b19a154c135", "productName": "Camisa", "variantName": "XL Roja", "sku": "1234567", "barcode": "8893892", "vendor": "iFLastmile", "price": 141, "discount": 20, "paid": 121, "tax": 21, "returnAmount": 121, "currency": "EUR", "basePrice": 141, "baseDiscount": 20, "basePaid": 121, "baseTax": 21, "baseReturnAmount": 121, "baseCurrency": "EUR", "quantity": 1, "evidenceImgUrls": [ "https://ifreturns.com/imagen/producto_evidence1.jpg" ], "imageUrl": "https://ifreturns.com/imagen/producto.jpg", "ecommerceLineItem": { "lineItemId": "8e1b8c92", "productId": "1234", "variantId": "XS1234" }, "returnReason": { "code": "dont-like", "reason": "No me gusta", "additionalInfo": "Presenta un fallo en la cremallera" }, "refundType": "ORIGINAL_PAYMENT_METHOD", "refundMode": "PRE_VALIDATION", "exchangeLineItems": [ { "id": "8e1b8c92-37a9-44c6-952a-b86bce1d8cfb", "productName": "Product/12345", "variantName": "Blue Sweater XL Size", "sku": "1234557", "price": 120, "quantity": 1, "vendor": "iFLastmile", "ecommerceProductId": "1234", "ecommerceVariantId": "XL1234" } ] } ] } } }

This example has been generated automatically.
RECEIVE return.expired
The event is published when the return is expired

Operation IDpublish
Accepts the following message:
Message IDReturnExpired
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

object
Return request object

id
string
format: uuid
Internal ID of the return order

shopCode
string
Shop code which belongs the return

name
string
Return Merchant Authorization (RMA) name

createdAt
string
format: date-time
Date when the return order was created

updatedAt
string
format: date-time
Date when the return order was updated

cancelledAt
string
format: date-time
Date when the return order was updated

status
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
totalReturnFee
number
format: float
Fee associated with the method of return

totalReturnAmount
number
format: float
Total amount of the all returned items

totalTax
number
format: float
Total tax of the all returned items

totalRefund
number
format: float
Total amount to be refund (totalReturnAmount - totalReturnFee)

currency
string
Transaction currency

baseTotalReturnFee
number
format: float
Fee associated with the method of return in shop base currency

baseTotalReturnAmount
number
format: float
Total amount of the all returned items in shop base currency

baseTotalTax
number
format: float
Total tax of the all returned items in shop base currency

baseTotalRefund
number
format: float
Total amount to be refund in shop base currency (baseTotalReturnAmount - baseTotalReturnFee)

baseCurrency
string
Shop base currency

object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
array<object>
List of returned items

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "id": "c5b6ba94-5b15-4911-90b0-e6dca0ffcd78", "time": "2018-04-05T17:31:02.735Z", "type": "return.expired", "dataContentType": "application/json", "data": { "resource": { "id": "8e1b8c92-37a9-44c6-952a-b86bce1d8cfb", "shopCode": "marchelacolombine", "name": "R1-7848", "createdAt": "2022-11-17 12:01:02.735Z", "updatedAt": "2022-11-17 12:01:02.735Z", "cancelledAt": "2022-11-17 12:01:02.735Z", "status": "PENDING", "totalReturnFee": 5, "totalReturnAmount": 121, "totalTax": 21, "totalRefund": 116, "currency": "EUR", "baseTotalReturnFee": 5, "baseTotalReturnAmount": 121, "baseTotalTax": 21, "baseTotalRefund": 116, "baseCurrency": "EUR", "customer": { "fullName": "Juan Perez", "email": "customer@if.com", "phone": 34666666666, "address": { "line1": "Calle de Fortunate y Jacinta 12", "line2": "", "city": "Madrid", "postalCode": "28020", "region": "Madrid", "countryCode": "ES" } }, "ecommerceOrder": { "id": "4243234", "name": "7848", "customerId": "23423" }, "returnLineItems": [ { "id": "54048ad6-af97-417c-a8a6-7b19a154c135", "productName": "Camisa", "variantName": "XL Roja", "sku": "1234567", "barcode": "8893892", "vendor": "iFLastmile", "price": 141, "discount": 20, "paid": 121, "tax": 21, "returnAmount": 121, "currency": "EUR", "basePrice": 141, "baseDiscount": 20, "basePaid": 121, "baseTax": 21, "baseReturnAmount": 121, "baseCurrency": "EUR", "quantity": 1, "evidenceImgUrls": [ "https://ifreturns.com/imagen/producto_evidence1.jpg" ], "imageUrl": "https://ifreturns.com/imagen/producto.jpg", "ecommerceLineItem": { "lineItemId": "8e1b8c92", "productId": "1234", "variantId": "XS1234" }, "returnReason": { "code": "dont-like", "reason": "No me gusta", "additionalInfo": "Presenta un fallo en la cremallera" }, "refundType": "ORIGINAL_PAYMENT_METHOD", "refundMode": "PRE_VALIDATION", "exchangeLineItems": [ { "id": "8e1b8c92-37a9-44c6-952a-b86bce1d8cfb", "productName": "Product/12345", "variantName": "Blue Sweater XL Size", "sku": "1234557", "price": 120, "quantity": 1, "vendor": "iFLastmile", "ecommerceProductId": "1234", "ecommerceVariantId": "XL1234" } ] } ] } } }

This example has been generated automatically.
RECEIVE transportation.updated
The event is published when the transportation status of the return has changed.

Operation IDpublish
Accepts the following message:
Message IDTransportationUpdated
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

allOf
Event resource data

object
Transport scheduled to collect the return order

id
string
format: uuid
Internal ID of new item

returnId
string
format: uuid
Return ID associated to the transportation

createdAt
string
format: date-time
Date when the Transport was created

status
string
Status of the transport

Allowed values:
"REQUESTED"
"PICK_UP_IN_PROGRESS"
"PICK_UP_COMPLETED"
"SHIPPING_IN_PROGRESS"
"SHIPPING_COMPLETED"
"PICK_UP_FAILED"
"PICK_UP_CANCELLED"
"SHIPPING_FAILED"
"SHIPPING_CANCELLED"
currentActive
boolean
Flag to indicate which transport is active, in case a pickup has failed

serviceMessage
string
Name of the transport chosed by customer

serviceType
string
Type of transport chosed by customer

carrierCode
string
Carrier responsible for the transport

carrierServiceCode
string
Carrier service used for the transport

carrierLabel
string
URL to donwload the carrier label

carrierTrackingUrl
string
URL for tracking the shipment

carrierPickupReference
string
Pickup code generated by the carrier

carrierReference
string
Transport code generated by the carrier

clientReference
string
Internal code generated for the transport

pickupDate
string
Date when the return order will be picked up. Only available in case of home pickup has been scheduled by iF returns

object
Origin address for the transportation

fullName
string
Full name associated to the origin

email
string
Email associated to the origin

phone
string
Phone associated to the origin

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
restricted any
Destination address for the transportation

fullName
string
Full name of the destionation

email
string
Email associated to the destination

phone
string
Phone associated to the destination

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
array<object>
List of transportation tracking statuses

object
Detailed status of the transportation

id
string
format: uuid
Internal ID of the status history

status
string
Status of the transport

Allowed values:
"REQUESTED"
"PICK_UP_IN_PROGRESS"
"PICK_UP_COMPLETED"
"SHIPPING_IN_PROGRESS"
"SHIPPING_COMPLETED"
"PICK_UP_FAILED"
"PICK_UP_CANCELLED"
"SHIPPING_FAILED"
"SHIPPING_CANCELLED"
createdAt
string
Date when the carrier status was registered at iF

carrierStatusDate
string
format: date-time
Date when the status was registered by the carrier

carrierStatusCode
string
Status code registered by the carrier

carrierStatusDescription
string
Status description registered by the carrier

carrierIncidentDescription
string
Additional info in case of an issue with the transportation

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "id": "c5b6ba94-5b15-4911-90b0-e6dca0ffcd78", "time": "2018-04-05T17:31:02.735Z", "type": "transportation.updated", "dataContentType": "application/json", "data": { "resource": { "id": "38885822-8d44-4819-8358-345b4d83be70", "returnId": "38885822-8d44-4819-8358-345b4d83be70", "createdAt": "2022-11-17 12:05:02.735Z", "status": "REQUESTED", "currentActive": true, "serviceMessage": "Recogida programada", "serviceType": "pickup", "carrierCode": "CORREOS-EXPRESS", "carrierServiceCode": "correos-epaq-24", "carrierLabel": "https://if.com/P1R1mlc7848.pdf", "carrierTrackingUrl": "https://if.com/tracking/3230006199506927", "carrierPickupReference": "125172899", "carrierReference": "3230006199506927", "clientReference": "P1R1mlc7848", "pickupDate": "2022-11-22", "origin": { "fullName": "Juan Perez", "email": "customer@if.com", "phone": 34666666666, "address": { "line1": "Calle de Fortunate y Jacinta 12", "line2": "", "city": "Madrid", "postalCode": "28020", "region": "Madrid", "countryCode": "ES" } }, "destination": { "fullName": "iF warehouse", "email": "warehouse@if.com", "phone": 34666666666, "address": { "line1": "Calle de Fortunate y Jacinta 12", "line2": "", "city": "Madrid", "postalCode": "28020", "region": "Madrid", "countryCode": "ES" } }, "statusHistory": [ { "id": "38885822-8d44-4819-8358-345b4d83be70", "status": "REQUESTED", "createdAt": "2022-11-17 12:15:02.735Z", "carrierStatusDate": "2022-11-17 12:05:02.735Z", "carrierStatusCode": "01", "carrierStatusDescription": "RECEIVED AT THE OFFICE", "carrierIncidentDescription": "CUSTOMER DOES NOT HAVE READY THE PARCEL" } ] } } }

This example has been generated automatically.
RECEIVE refund.created
The event is published when the refund is created

Operation IDpublish
Accepts the following message:
Message IDRefundCreated
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

object
Refund object

id
string
format: GUID
Internal ID of the return

name
string
format: string
Return name associated with the refund

previousEcommerceOrder
string
In case of a return of an exchange (ROE), the name of the previous order

processedAt
string
format: date-time
Date when the refund was processed

returnModelKind
string
Kind of return requested by the customer

Allowed values:
"STANDARD"
"RETURN_OF_EXCHANGE"
"RETURN_BY_CANCELLATION"
"WARRANTY"
object
Data of the ecommerce order from which the return was created

customerId
string
ID of the customer

id
string
ID of the ecommercer order

name
string
Name of the customer

object
id
string
ID of the return in the ecommerce platform

name
string
Name of the return in the commercer platform

Additional properties are allowed.
Additional properties are allowed.
array<object>
object
id
number
ID of the refund

createdAt
string
format: date
Date when the Refund was created

amount
number
format: float
Amount refunded to the customer in ORIGINAL_PAYMENT_METHOD

currency
string
Currency in which the refund is made

baseAmount
number
format: float
Amount refunded to the customer in ORIGINAL_PAYMENT_METHOD in the shop base currency

baseCurrency
string
Shop base currency

approvedBy
string
User who approved the refund

exchangeAmountPaid
number
format: float
Amount paid by the customer for the exchange

baseExchangeAmountPaid
number
format: float
Amount paid by the customer for the exchange in the shop base currency

ecommerceDiscountCouponCode
string
Code of the discount (masked) created in the ecommerce platform when the refund type is STORE_CREDIT

ecommerceDiscountCouponId
string
ID of the discount created in the ecommerce platform when the refund type is STORE_CREDIT

ecommerceGiftCardCode
string
Code of the gift card (masked) created in the ecommerce platform when the refund type is GIFT_CARD

ecommerceGiftCardId
string
ID of the gift card (masked) created in the ecommerce platform when the refund type is GIFT_CARD

ecommerceExchangeOrderName
string
Name of the new order created created in the ecommerce platform when the refund type is EXCHANGE

ecommerceExchangeOrderId
string
ID of the new order created created in the ecommerce platform when the refund type is EXCHANGE

ecommerceRefundId
string
ID of the refund created in the ecommerce platform

mode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
type
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
subType
string
Refund sub type selected by customer for the returned item

Allowed values:
"OTHER_PRODUCT_SAME"
"OTHER_PRODUCT_HIGHER"
"OTHER_PRODUCT_LOWER"
"OTHER_VARIANT"
array<object>
List of line items included in the refund

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "id": "c5b6ba94-5b15-4911-90b0-e6dca0ffcd78", "time": "2018-04-05T17:31:02.735Z", "type": "refund.created", "dataContentType": "application/json", "data": { "resource": { "id": "ef4f03ce-ed26-4bf3-a4e3-3d9f1adf9bd8", "name": "R1-MC-9091", "previousEcommerceOrder": "MC-9090", "processedAt": "2022-11-17 12:05:02Z", "returnModelKind": "STANDARD", "ecommerceOrder": { "customerId": "8662555197771", "id": "6593099039051", "name": "MC-9091", "return": { "id": "13863289163", "name": "MC-9091-R1" } }, "refunds": [ { "id": "2025-03-06T14:27:11.481Z", "createdAt": "2025-03-06T14:27:11Z", "amount": 120, "currency": "EUR", "baseAmount": 120, "baseCurrency": "EUR", "approvedBy": "operator@ifeturns.com", "exchangeAmountPaid": 0, "baseExchangeAmountPaid": 0, "ecommerceDiscountCouponCode": null, "ecommerceDiscountCouponId": null, "ecommerceGiftCardCode": null, "ecommerceGiftCardId": "", "ecommerceExchangeOrderName": null, "ecommerceExchangeOrderId": null, "ecommerceRefundId": "1041273454923", "mode": "PRE_VALIDATION", "type": "ORIGINAL_PAYMENT_METHOD", "subType": "", "refundLineItems": [ { "id": "54048ad6-af97-417c-a8a6-7b19a154c135", "productName": "Camisa", "variantName": "XL Roja", "sku": "1234567", "barcode": "8893892", "vendor": "iFLastmile", "price": 141, "discount": 20, "paid": 121, "tax": 21, "returnAmount": 121, "currency": "EUR", "basePrice": 141, "baseDiscount": 20, "basePaid": 121, "baseTax": 21, "baseReturnAmount": 121, "baseCurrency": "EUR", "quantity": 1, "evidenceImgUrls": [ "https://ifreturns.com/imagen/producto_evidence1.jpg" ], "imageUrl": "https://ifreturns.com/imagen/producto.jpg", "ecommerceLineItem": { "lineItemId": "8e1b8c92", "productId": "1234", "variantId": "XS1234" }, "returnReason": { "code": "dont-like", "reason": "No me gusta", "additionalInfo": "Presenta un fallo en la cremallera" }, "refundType": "ORIGINAL_PAYMENT_METHOD", "refundMode": "PRE_VALIDATION", "exchangeLineItems": [ { "id": "8e1b8c92-37a9-44c6-952a-b86bce1d8cfb", "productName": "Product/12345", "variantName": "Blue Sweater XL Size", "sku": "1234557", "price": 120, "quantity": 1, "vendor": "iFLastmile", "ecommerceProductId": "1234", "ecommerceVariantId": "XL1234" } ] } ] } ] } } }

This example has been generated automatically.

Messages

#1
Message IDReturnScheduled
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

allOf
Event resource data

object
Return request object

id
string
format: uuid
Internal ID of the return order

shopCode
string
Shop code which belongs the return

name
string
Return Merchant Authorization (RMA) name

createdAt
string
format: date-time
Date when the return order was created

updatedAt
string
format: date-time
Date when the return order was updated

cancelledAt
string
format: date-time
Date when the return order was updated

status
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
totalReturnFee
number
format: float
Fee associated with the method of return

totalReturnAmount
number
format: float
Total amount of the all returned items

totalTax
number
format: float
Total tax of the all returned items

totalRefund
number
format: float
Total amount to be refund (totalReturnAmount - totalReturnFee)

currency
string
Transaction currency

baseTotalReturnFee
number
format: float
Fee associated with the method of return in shop base currency

baseTotalReturnAmount
number
format: float
Total amount of the all returned items in shop base currency

baseTotalTax
number
format: float
Total tax of the all returned items in shop base currency

baseTotalRefund
number
format: float
Total amount to be refund in shop base currency (baseTotalReturnAmount - baseTotalReturnFee)

baseCurrency
string
Shop base currency

object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
array<object>
List of returned items

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
required
array<object>
List of transportations scheduled

object
Transport scheduled to collect the return order

id
string
format: uuid
Internal ID of new item

returnId
string
format: uuid
Return ID associated to the transportation

createdAt
string
format: date-time
Date when the Transport was created

status
string
Status of the transport

Allowed values:
"REQUESTED"
"PICK_UP_IN_PROGRESS"
"PICK_UP_COMPLETED"
"SHIPPING_IN_PROGRESS"
"SHIPPING_COMPLETED"
"PICK_UP_FAILED"
"PICK_UP_CANCELLED"
"SHIPPING_FAILED"
"SHIPPING_CANCELLED"
currentActive
boolean
Flag to indicate which transport is active, in case a pickup has failed

serviceMessage
string
Name of the transport chosed by customer

serviceType
string
Type of transport chosed by customer

carrierCode
string
Carrier responsible for the transport

carrierServiceCode
string
Carrier service used for the transport

carrierLabel
string
URL to donwload the carrier label

carrierTrackingUrl
string
URL for tracking the shipment

carrierPickupReference
string
Pickup code generated by the carrier

carrierReference
string
Transport code generated by the carrier

clientReference
string
Internal code generated for the transport

pickupDate
string
Date when the return order will be picked up. Only available in case of home pickup has been scheduled by iF returns

object
Origin address for the transportation

fullName
string
Full name associated to the origin

email
string
Email associated to the origin

phone
string
Phone associated to the origin

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
restricted any
Destination address for the transportation

fullName
string
Full name of the destionation

email
string
Email associated to the destination

phone
string
Phone associated to the destination

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#2
Message IDReturnCreated
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

object
Return request object

id
string
format: uuid
Internal ID of the return order

shopCode
string
Shop code which belongs the return

name
string
Return Merchant Authorization (RMA) name

createdAt
string
format: date-time
Date when the return order was created

updatedAt
string
format: date-time
Date when the return order was updated

cancelledAt
string
format: date-time
Date when the return order was updated

status
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
totalReturnFee
number
format: float
Fee associated with the method of return

totalReturnAmount
number
format: float
Total amount of the all returned items

totalTax
number
format: float
Total tax of the all returned items

totalRefund
number
format: float
Total amount to be refund (totalReturnAmount - totalReturnFee)

currency
string
Transaction currency

baseTotalReturnFee
number
format: float
Fee associated with the method of return in shop base currency

baseTotalReturnAmount
number
format: float
Total amount of the all returned items in shop base currency

baseTotalTax
number
format: float
Total tax of the all returned items in shop base currency

baseTotalRefund
number
format: float
Total amount to be refund in shop base currency (baseTotalReturnAmount - baseTotalReturnFee)

baseCurrency
string
Shop base currency

object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
array<object>
List of returned items

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#3
Message IDReturnCancelled
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

object
Return request object

id
string
format: uuid
Internal ID of the return order

shopCode
string
Shop code which belongs the return

name
string
Return Merchant Authorization (RMA) name

createdAt
string
format: date-time
Date when the return order was created

updatedAt
string
format: date-time
Date when the return order was updated

cancelledAt
string
format: date-time
Date when the return order was updated

status
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
totalReturnFee
number
format: float
Fee associated with the method of return

totalReturnAmount
number
format: float
Total amount of the all returned items

totalTax
number
format: float
Total tax of the all returned items

totalRefund
number
format: float
Total amount to be refund (totalReturnAmount - totalReturnFee)

currency
string
Transaction currency

baseTotalReturnFee
number
format: float
Fee associated with the method of return in shop base currency

baseTotalReturnAmount
number
format: float
Total amount of the all returned items in shop base currency

baseTotalTax
number
format: float
Total tax of the all returned items in shop base currency

baseTotalRefund
number
format: float
Total amount to be refund in shop base currency (baseTotalReturnAmount - baseTotalReturnFee)

baseCurrency
string
Shop base currency

object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
array<object>
List of returned items

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#4
Message IDReturnExpired
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

object
Return request object

id
string
format: uuid
Internal ID of the return order

shopCode
string
Shop code which belongs the return

name
string
Return Merchant Authorization (RMA) name

createdAt
string
format: date-time
Date when the return order was created

updatedAt
string
format: date-time
Date when the return order was updated

cancelledAt
string
format: date-time
Date when the return order was updated

status
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
totalReturnFee
number
format: float
Fee associated with the method of return

totalReturnAmount
number
format: float
Total amount of the all returned items

totalTax
number
format: float
Total tax of the all returned items

totalRefund
number
format: float
Total amount to be refund (totalReturnAmount - totalReturnFee)

currency
string
Transaction currency

baseTotalReturnFee
number
format: float
Fee associated with the method of return in shop base currency

baseTotalReturnAmount
number
format: float
Total amount of the all returned items in shop base currency

baseTotalTax
number
format: float
Total tax of the all returned items in shop base currency

baseTotalRefund
number
format: float
Total amount to be refund in shop base currency (baseTotalReturnAmount - baseTotalReturnFee)

baseCurrency
string
Shop base currency

object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
array<object>
List of returned items

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#5
Message IDTransportationUpdated
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

allOf
Event resource data

object
Transport scheduled to collect the return order

id
string
format: uuid
Internal ID of new item

returnId
string
format: uuid
Return ID associated to the transportation

createdAt
string
format: date-time
Date when the Transport was created

status
string
Status of the transport

Allowed values:
"REQUESTED"
"PICK_UP_IN_PROGRESS"
"PICK_UP_COMPLETED"
"SHIPPING_IN_PROGRESS"
"SHIPPING_COMPLETED"
"PICK_UP_FAILED"
"PICK_UP_CANCELLED"
"SHIPPING_FAILED"
"SHIPPING_CANCELLED"
currentActive
boolean
Flag to indicate which transport is active, in case a pickup has failed

serviceMessage
string
Name of the transport chosed by customer

serviceType
string
Type of transport chosed by customer

carrierCode
string
Carrier responsible for the transport

carrierServiceCode
string
Carrier service used for the transport

carrierLabel
string
URL to donwload the carrier label

carrierTrackingUrl
string
URL for tracking the shipment

carrierPickupReference
string
Pickup code generated by the carrier

carrierReference
string
Transport code generated by the carrier

clientReference
string
Internal code generated for the transport

pickupDate
string
Date when the return order will be picked up. Only available in case of home pickup has been scheduled by iF returns

object
Origin address for the transportation

fullName
string
Full name associated to the origin

email
string
Email associated to the origin

phone
string
Phone associated to the origin

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
restricted any
Destination address for the transportation

fullName
string
Full name of the destionation

email
string
Email associated to the destination

phone
string
Phone associated to the destination

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
array<object>
List of transportation tracking statuses

object
Detailed status of the transportation

id
string
format: uuid
Internal ID of the status history

status
string
Status of the transport

Allowed values:
"REQUESTED"
"PICK_UP_IN_PROGRESS"
"PICK_UP_COMPLETED"
"SHIPPING_IN_PROGRESS"
"SHIPPING_COMPLETED"
"PICK_UP_FAILED"
"PICK_UP_CANCELLED"
"SHIPPING_FAILED"
"SHIPPING_CANCELLED"
createdAt
string
Date when the carrier status was registered at iF

carrierStatusDate
string
format: date-time
Date when the status was registered by the carrier

carrierStatusCode
string
Status code registered by the carrier

carrierStatusDescription
string
Status description registered by the carrier

carrierIncidentDescription
string
Additional info in case of an issue with the transportation

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#6
Message IDRefundCreated
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

object
Refund object

id
string
format: GUID
Internal ID of the return

name
string
format: string
Return name associated with the refund

previousEcommerceOrder
string
In case of a return of an exchange (ROE), the name of the previous order

processedAt
string
format: date-time
Date when the refund was processed

returnModelKind
string
Kind of return requested by the customer

Allowed values:
"STANDARD"
"RETURN_OF_EXCHANGE"
"RETURN_BY_CANCELLATION"
"WARRANTY"
object
Data of the ecommerce order from which the return was created

customerId
string
ID of the customer

id
string
ID of the ecommercer order

name
string
Name of the customer

object
id
string
ID of the return in the ecommerce platform

name
string
Name of the return in the commercer platform

Additional properties are allowed.
Additional properties are allowed.
array<object>
object
id
number
ID of the refund

createdAt
string
format: date
Date when the Refund was created

amount
number
format: float
Amount refunded to the customer in ORIGINAL_PAYMENT_METHOD

currency
string
Currency in which the refund is made

baseAmount
number
format: float
Amount refunded to the customer in ORIGINAL_PAYMENT_METHOD in the shop base currency

baseCurrency
string
Shop base currency

approvedBy
string
User who approved the refund

exchangeAmountPaid
number
format: float
Amount paid by the customer for the exchange

baseExchangeAmountPaid
number
format: float
Amount paid by the customer for the exchange in the shop base currency

ecommerceDiscountCouponCode
string
Code of the discount (masked) created in the ecommerce platform when the refund type is STORE_CREDIT

ecommerceDiscountCouponId
string
ID of the discount created in the ecommerce platform when the refund type is STORE_CREDIT

ecommerceGiftCardCode
string
Code of the gift card (masked) created in the ecommerce platform when the refund type is GIFT_CARD

ecommerceGiftCardId
string
ID of the gift card (masked) created in the ecommerce platform when the refund type is GIFT_CARD

ecommerceExchangeOrderName
string
Name of the new order created created in the ecommerce platform when the refund type is EXCHANGE

ecommerceExchangeOrderId
string
ID of the new order created created in the ecommerce platform when the refund type is EXCHANGE

ecommerceRefundId
string
ID of the refund created in the ecommerce platform

mode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
type
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
subType
string
Refund sub type selected by customer for the returned item

Allowed values:
"OTHER_PRODUCT_SAME"
"OTHER_PRODUCT_HIGHER"
"OTHER_PRODUCT_LOWER"
"OTHER_VARIANT"
array<object>
List of line items included in the refund

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.

Schemas

object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

object
Return request object

id
string
format: uuid
Internal ID of the return order

shopCode
string
Shop code which belongs the return

name
string
Return Merchant Authorization (RMA) name

createdAt
string
format: date-time
Date when the return order was created

updatedAt
string
format: date-time
Date when the return order was updated

cancelledAt
string
format: date-time
Date when the return order was updated

status
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
totalReturnFee
number
format: float
Fee associated with the method of return

totalReturnAmount
number
format: float
Total amount of the all returned items

totalTax
number
format: float
Total tax of the all returned items

totalRefund
number
format: float
Total amount to be refund (totalReturnAmount - totalReturnFee)

currency
string
Transaction currency

baseTotalReturnFee
number
format: float
Fee associated with the method of return in shop base currency

baseTotalReturnAmount
number
format: float
Total amount of the all returned items in shop base currency

baseTotalTax
number
format: float
Total tax of the all returned items in shop base currency

baseTotalRefund
number
format: float
Total amount to be refund in shop base currency (baseTotalReturnAmount - baseTotalReturnFee)

baseCurrency
string
Shop base currency

object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
array<object>
List of returned items

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

allOf
Event resource data

object
Return request object

id
string
format: uuid
Internal ID of the return order

shopCode
string
Shop code which belongs the return

name
string
Return Merchant Authorization (RMA) name

createdAt
string
format: date-time
Date when the return order was created

updatedAt
string
format: date-time
Date when the return order was updated

cancelledAt
string
format: date-time
Date when the return order was updated

status
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
totalReturnFee
number
format: float
Fee associated with the method of return

totalReturnAmount
number
format: float
Total amount of the all returned items

totalTax
number
format: float
Total tax of the all returned items

totalRefund
number
format: float
Total amount to be refund (totalReturnAmount - totalReturnFee)

currency
string
Transaction currency

baseTotalReturnFee
number
format: float
Fee associated with the method of return in shop base currency

baseTotalReturnAmount
number
format: float
Total amount of the all returned items in shop base currency

baseTotalTax
number
format: float
Total tax of the all returned items in shop base currency

baseTotalRefund
number
format: float
Total amount to be refund in shop base currency (baseTotalReturnAmount - baseTotalReturnFee)

baseCurrency
string
Shop base currency

object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
array<object>
List of returned items

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
required
array<object>
List of transportations scheduled

object
Transport scheduled to collect the return order

id
string
format: uuid
Internal ID of new item

returnId
string
format: uuid
Return ID associated to the transportation

createdAt
string
format: date-time
Date when the Transport was created

status
string
Status of the transport

Allowed values:
"REQUESTED"
"PICK_UP_IN_PROGRESS"
"PICK_UP_COMPLETED"
"SHIPPING_IN_PROGRESS"
"SHIPPING_COMPLETED"
"PICK_UP_FAILED"
"PICK_UP_CANCELLED"
"SHIPPING_FAILED"
"SHIPPING_CANCELLED"
currentActive
boolean
Flag to indicate which transport is active, in case a pickup has failed

serviceMessage
string
Name of the transport chosed by customer

serviceType
string
Type of transport chosed by customer

carrierCode
string
Carrier responsible for the transport

carrierServiceCode
string
Carrier service used for the transport

carrierLabel
string
URL to donwload the carrier label

carrierTrackingUrl
string
URL for tracking the shipment

carrierPickupReference
string
Pickup code generated by the carrier

carrierReference
string
Transport code generated by the carrier

clientReference
string
Internal code generated for the transport

pickupDate
string
Date when the return order will be picked up. Only available in case of home pickup has been scheduled by iF returns

object
Origin address for the transportation

fullName
string
Full name associated to the origin

email
string
Email associated to the origin

phone
string
Phone associated to the origin

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
restricted any
Destination address for the transportation

fullName
string
Full name of the destionation

email
string
Email associated to the destination

phone
string
Phone associated to the destination

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

object
Return request object

id
string
format: uuid
Internal ID of the return order

shopCode
string
Shop code which belongs the return

name
string
Return Merchant Authorization (RMA) name

createdAt
string
format: date-time
Date when the return order was created

updatedAt
string
format: date-time
Date when the return order was updated

cancelledAt
string
format: date-time
Date when the return order was updated

status
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
totalReturnFee
number
format: float
Fee associated with the method of return

totalReturnAmount
number
format: float
Total amount of the all returned items

totalTax
number
format: float
Total tax of the all returned items

totalRefund
number
format: float
Total amount to be refund (totalReturnAmount - totalReturnFee)

currency
string
Transaction currency

baseTotalReturnFee
number
format: float
Fee associated with the method of return in shop base currency

baseTotalReturnAmount
number
format: float
Total amount of the all returned items in shop base currency

baseTotalTax
number
format: float
Total tax of the all returned items in shop base currency

baseTotalRefund
number
format: float
Total amount to be refund in shop base currency (baseTotalReturnAmount - baseTotalReturnFee)

baseCurrency
string
Shop base currency

object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
array<object>
List of returned items

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

object
Return request object

id
string
format: uuid
Internal ID of the return order

shopCode
string
Shop code which belongs the return

name
string
Return Merchant Authorization (RMA) name

createdAt
string
format: date-time
Date when the return order was created

updatedAt
string
format: date-time
Date when the return order was updated

cancelledAt
string
format: date-time
Date when the return order was updated

status
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
totalReturnFee
number
format: float
Fee associated with the method of return

totalReturnAmount
number
format: float
Total amount of the all returned items

totalTax
number
format: float
Total tax of the all returned items

totalRefund
number
format: float
Total amount to be refund (totalReturnAmount - totalReturnFee)

currency
string
Transaction currency

baseTotalReturnFee
number
format: float
Fee associated with the method of return in shop base currency

baseTotalReturnAmount
number
format: float
Total amount of the all returned items in shop base currency

baseTotalTax
number
format: float
Total tax of the all returned items in shop base currency

baseTotalRefund
number
format: float
Total amount to be refund in shop base currency (baseTotalReturnAmount - baseTotalReturnFee)

baseCurrency
string
Shop base currency

object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
array<object>
List of returned items

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

allOf
Event resource data

object
Transport scheduled to collect the return order

id
string
format: uuid
Internal ID of new item

returnId
string
format: uuid
Return ID associated to the transportation

createdAt
string
format: date-time
Date when the Transport was created

status
string
Status of the transport

Allowed values:
"REQUESTED"
"PICK_UP_IN_PROGRESS"
"PICK_UP_COMPLETED"
"SHIPPING_IN_PROGRESS"
"SHIPPING_COMPLETED"
"PICK_UP_FAILED"
"PICK_UP_CANCELLED"
"SHIPPING_FAILED"
"SHIPPING_CANCELLED"
currentActive
boolean
Flag to indicate which transport is active, in case a pickup has failed

serviceMessage
string
Name of the transport chosed by customer

serviceType
string
Type of transport chosed by customer

carrierCode
string
Carrier responsible for the transport

carrierServiceCode
string
Carrier service used for the transport

carrierLabel
string
URL to donwload the carrier label

carrierTrackingUrl
string
URL for tracking the shipment

carrierPickupReference
string
Pickup code generated by the carrier

carrierReference
string
Transport code generated by the carrier

clientReference
string
Internal code generated for the transport

pickupDate
string
Date when the return order will be picked up. Only available in case of home pickup has been scheduled by iF returns

object
Origin address for the transportation

fullName
string
Full name associated to the origin

email
string
Email associated to the origin

phone
string
Phone associated to the origin

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
restricted any
Destination address for the transportation

fullName
string
Full name of the destionation

email
string
Email associated to the destination

phone
string
Phone associated to the destination

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
array<object>
List of transportation tracking statuses

object
Detailed status of the transportation

id
string
format: uuid
Internal ID of the status history

status
string
Status of the transport

Allowed values:
"REQUESTED"
"PICK_UP_IN_PROGRESS"
"PICK_UP_COMPLETED"
"SHIPPING_IN_PROGRESS"
"SHIPPING_COMPLETED"
"PICK_UP_FAILED"
"PICK_UP_CANCELLED"
"SHIPPING_FAILED"
"SHIPPING_CANCELLED"
createdAt
string
Date when the carrier status was registered at iF

carrierStatusDate
string
format: date-time
Date when the status was registered by the carrier

carrierStatusCode
string
Status code registered by the carrier

carrierStatusDescription
string
Status description registered by the carrier

carrierIncidentDescription
string
Additional info in case of an issue with the transportation

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
id
string
Event ID

time
string
format: date-time
Datetime when the event is generated

type
string
Event type

dataContentType
string
Event content type

object
Event payload

object
Refund object

id
string
format: GUID
Internal ID of the return

name
string
format: string
Return name associated with the refund

previousEcommerceOrder
string
In case of a return of an exchange (ROE), the name of the previous order

processedAt
string
format: date-time
Date when the refund was processed

returnModelKind
string
Kind of return requested by the customer

Allowed values:
"STANDARD"
"RETURN_OF_EXCHANGE"
"RETURN_BY_CANCELLATION"
"WARRANTY"
object
Data of the ecommerce order from which the return was created

customerId
string
ID of the customer

id
string
ID of the ecommercer order

name
string
Name of the customer

object
id
string
ID of the return in the ecommerce platform

name
string
Name of the return in the commercer platform

Additional properties are allowed.
Additional properties are allowed.
array<object>
object
id
number
ID of the refund

createdAt
string
format: date
Date when the Refund was created

amount
number
format: float
Amount refunded to the customer in ORIGINAL_PAYMENT_METHOD

currency
string
Currency in which the refund is made

baseAmount
number
format: float
Amount refunded to the customer in ORIGINAL_PAYMENT_METHOD in the shop base currency

baseCurrency
string
Shop base currency

approvedBy
string
User who approved the refund

exchangeAmountPaid
number
format: float
Amount paid by the customer for the exchange

baseExchangeAmountPaid
number
format: float
Amount paid by the customer for the exchange in the shop base currency

ecommerceDiscountCouponCode
string
Code of the discount (masked) created in the ecommerce platform when the refund type is STORE_CREDIT

ecommerceDiscountCouponId
string
ID of the discount created in the ecommerce platform when the refund type is STORE_CREDIT

ecommerceGiftCardCode
string
Code of the gift card (masked) created in the ecommerce platform when the refund type is GIFT_CARD

ecommerceGiftCardId
string
ID of the gift card (masked) created in the ecommerce platform when the refund type is GIFT_CARD

ecommerceExchangeOrderName
string
Name of the new order created created in the ecommerce platform when the refund type is EXCHANGE

ecommerceExchangeOrderId
string
ID of the new order created created in the ecommerce platform when the refund type is EXCHANGE

ecommerceRefundId
string
ID of the refund created in the ecommerce platform

mode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
type
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
subType
string
Refund sub type selected by customer for the returned item

Allowed values:
"OTHER_PRODUCT_SAME"
"OTHER_PRODUCT_HIGHER"
"OTHER_PRODUCT_LOWER"
"OTHER_VARIANT"
array<object>
List of line items included in the refund

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
Return request object

id
string
format: uuid
Internal ID of the return order

shopCode
string
Shop code which belongs the return

name
string
Return Merchant Authorization (RMA) name

createdAt
string
format: date-time
Date when the return order was created

updatedAt
string
format: date-time
Date when the return order was updated

cancelledAt
string
format: date-time
Date when the return order was updated

status
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
totalReturnFee
number
format: float
Fee associated with the method of return

totalReturnAmount
number
format: float
Total amount of the all returned items

totalTax
number
format: float
Total tax of the all returned items

totalRefund
number
format: float
Total amount to be refund (totalReturnAmount - totalReturnFee)

currency
string
Transaction currency

baseTotalReturnFee
number
format: float
Fee associated with the method of return in shop base currency

baseTotalReturnAmount
number
format: float
Total amount of the all returned items in shop base currency

baseTotalTax
number
format: float
Total tax of the all returned items in shop base currency

baseTotalRefund
number
format: float
Total amount to be refund in shop base currency (baseTotalReturnAmount - baseTotalReturnFee)

baseCurrency
string
Shop base currency

object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
array<object>
List of returned items

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
Customer who is requesting the return

fullName
string
Full name associated to the address

email
string
Email associated to the address

phone
string
Phone associated to the address

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order from where the return was requested

id
string
ID of the original order in the ecommerce platform

name
string
Name of the original order in the ecommerce platform

customerId
string
Customer ID associated to the original order in the ecommerce platform

Additional properties are allowed.
object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
object
Transport scheduled to collect the return order

id
string
format: uuid
Internal ID of new item

returnId
string
format: uuid
Return ID associated to the transportation

createdAt
string
format: date-time
Date when the Transport was created

status
string
Status of the transport

Allowed values:
"REQUESTED"
"PICK_UP_IN_PROGRESS"
"PICK_UP_COMPLETED"
"SHIPPING_IN_PROGRESS"
"SHIPPING_COMPLETED"
"PICK_UP_FAILED"
"PICK_UP_CANCELLED"
"SHIPPING_FAILED"
"SHIPPING_CANCELLED"
currentActive
boolean
Flag to indicate which transport is active, in case a pickup has failed

serviceMessage
string
Name of the transport chosed by customer

serviceType
string
Type of transport chosed by customer

carrierCode
string
Carrier responsible for the transport

carrierServiceCode
string
Carrier service used for the transport

carrierLabel
string
URL to donwload the carrier label

carrierTrackingUrl
string
URL for tracking the shipment

carrierPickupReference
string
Pickup code generated by the carrier

carrierReference
string
Transport code generated by the carrier

clientReference
string
Internal code generated for the transport

pickupDate
string
Date when the return order will be picked up. Only available in case of home pickup has been scheduled by iF returns

object
Origin address for the transportation

fullName
string
Full name associated to the origin

email
string
Email associated to the origin

phone
string
Phone associated to the origin

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
restricted any
Destination address for the transportation

fullName
string
Full name of the destionation

email
string
Email associated to the destination

phone
string
Phone associated to the destination

object
line1
string
Line 1 of the Address

line2
string
Line 2 data of the address

city
string
City name of the address

postalCode
string
Postal code of the address

region
string
Region name of the address

countryCode
string
Country ISO code of the address

Additional properties are allowed.
Additional properties are allowed.
object
Detailed status of the transportation

id
string
format: uuid
Internal ID of the status history

status
string
Status of the transport

Allowed values:
"REQUESTED"
"PICK_UP_IN_PROGRESS"
"PICK_UP_COMPLETED"
"SHIPPING_IN_PROGRESS"
"SHIPPING_COMPLETED"
"PICK_UP_FAILED"
"PICK_UP_CANCELLED"
"SHIPPING_FAILED"
"SHIPPING_CANCELLED"
createdAt
string
Date when the carrier status was registered at iF

carrierStatusDate
string
format: date-time
Date when the status was registered by the carrier

carrierStatusCode
string
Status code registered by the carrier

carrierStatusDescription
string
Status description registered by the carrier

carrierIncidentDescription
string
Additional info in case of an issue with the transportation

Additional properties are allowed.
object
Refund object

id
string
format: GUID
Internal ID of the return

name
string
format: string
Return name associated with the refund

previousEcommerceOrder
string
In case of a return of an exchange (ROE), the name of the previous order

processedAt
string
format: date-time
Date when the refund was processed

returnModelKind
string
Kind of return requested by the customer

Allowed values:
"STANDARD"
"RETURN_OF_EXCHANGE"
"RETURN_BY_CANCELLATION"
"WARRANTY"
object
Data of the ecommerce order from which the return was created

customerId
string
ID of the customer

id
string
ID of the ecommercer order

name
string
Name of the customer

object
id
string
ID of the return in the ecommerce platform

name
string
Name of the return in the commercer platform

Additional properties are allowed.
Additional properties are allowed.
array<object>
object
id
number
ID of the refund

createdAt
string
format: date
Date when the Refund was created

amount
number
format: float
Amount refunded to the customer in ORIGINAL_PAYMENT_METHOD

currency
string
Currency in which the refund is made

baseAmount
number
format: float
Amount refunded to the customer in ORIGINAL_PAYMENT_METHOD in the shop base currency

baseCurrency
string
Shop base currency

approvedBy
string
User who approved the refund

exchangeAmountPaid
number
format: float
Amount paid by the customer for the exchange

baseExchangeAmountPaid
number
format: float
Amount paid by the customer for the exchange in the shop base currency

ecommerceDiscountCouponCode
string
Code of the discount (masked) created in the ecommerce platform when the refund type is STORE_CREDIT

ecommerceDiscountCouponId
string
ID of the discount created in the ecommerce platform when the refund type is STORE_CREDIT

ecommerceGiftCardCode
string
Code of the gift card (masked) created in the ecommerce platform when the refund type is GIFT_CARD

ecommerceGiftCardId
string
ID of the gift card (masked) created in the ecommerce platform when the refund type is GIFT_CARD

ecommerceExchangeOrderName
string
Name of the new order created created in the ecommerce platform when the refund type is EXCHANGE

ecommerceExchangeOrderId
string
ID of the new order created created in the ecommerce platform when the refund type is EXCHANGE

ecommerceRefundId
string
ID of the refund created in the ecommerce platform

mode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
type
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
subType
string
Refund sub type selected by customer for the returned item

Allowed values:
"OTHER_PRODUCT_SAME"
"OTHER_PRODUCT_HIGHER"
"OTHER_PRODUCT_LOWER"
"OTHER_VARIANT"
array<object>
List of line items included in the refund

object
id
string
format: uuid
Internal ID of returned item

productName
string
Name of returned item

variantName
string
Specific variant of the returned item

sku
string
SKU of the returned item

barcode
string
Barcode of the returned item

vendor
string
Vendor name associated to returned item

price
number
format: float
Original price of the returned item including taxes

discount
number
format: float
Discount over the original price of the returned item

paid
number
format: float
Amount paid by the customer for the returned item (price - discount)

tax
number
format: float
Tax of the returned item

returnAmount
number
format: float
Amount to be returned to the customer

currency
string
Transaction currency

basePrice
number
format: float
Price of the returned item including taxes in shop base currency

baseDiscount
number
format: float
Discount over the original price of the returned item in shop base currency

basePaid
number
format: float
Amount paid by the customer for the returned item (basePrice - baseDiscount)

baseTax
number
format: float
Tax of the returned item in shop base currency

baseReturnAmount
number
format: float
Amount to be returned to the customer in shop base currency

baseCurrency
string
Shop base currency

quantity
number
format: int
Items units returned

array<string>
List of evidences images uploaded by the customer for the returned product

Items:
string
imageUrl
string
Url for the image of the returned item

object
Ecommerce order line item that is returned

lineItemId
string
ID of returned line item in the original order

productId
string
Product ID in the ecommerce platform

variantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
refundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
refundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
array<object>
Information about the new product in case of exchange

object
id
string
format: uuid
Internal ID of new item

productName
string
Product ID of the new item

variantName
string
Specific variant of the new item

sku
string
SKU of the new item

price
number
format: float
Price of the new item

quantity
number
format: int
Items units to be processed

vendor
string
Vendor name of the new item

ecommerceProductId
string
Product ID in the ecommerce platform

ecommerceVariantId
string
Variant ID in the ecommerce platform

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
code
string
Reason code why the customer returns the item

reason
string
Reason description why the customer returns the item

additionalInfo
string
Additional info about why the customer returns the item

Additional properties are allowed.
ReturnStatus
string
Status of the return order

Allowed values:
"PENDING"
"RECEPTION_IN_PROGRESS"
"RECEPTION_COMPLETED"
"RECEIVED"
"CHECKED"
"CLOSED"
"DISCARDED"
TransportationStatus
string
Status of the transport

Allowed values:
"REQUESTED"
"PICK_UP_IN_PROGRESS"
"PICK_UP_COMPLETED"
"SHIPPING_IN_PROGRESS"
"SHIPPING_COMPLETED"
"PICK_UP_FAILED"
"PICK_UP_CANCELLED"
"SHIPPING_FAILED"
"SHIPPING_CANCELLED"
RefundType
string
Refund type selected by customer for the returned item

Allowed values:
"ORIGINAL_PAYMENT_METHOD"
"STORE_CREDIT"
"EXCHANGE"
"GIFT_CARD"
RefundSubType
string
Refund sub type selected by customer for the returned item

Allowed values:
"OTHER_PRODUCT_SAME"
"OTHER_PRODUCT_HIGHER"
"OTHER_PRODUCT_LOWER"
"OTHER_VARIANT"
RefundMode
string
Mode in which the returned item will be refunded

Allowed values:
"PRE_VALIDATION"
"SHIPPING_COMPLETED"
"SHIPPING_IN_PROGRESS"
"POST_VALIDATION"
"MANUAL"
"INSTANT"
"DROP_OFF"
ReturnModelKind
string
Kind of return requested by the customer

Allowed values:
"STANDARD"
"RETURN_OF_EXCHANGE"
"RETURN_BY_CANCELLATION"
"WARRANTY"

Operations

RECEIVE return.created

Examples

This example has been generated automatically.

RECEIVE return.scheduled

Examples

This example has been generated automatically.

RECEIVE return.cancelled

Examples

This example has been generated automatically.

RECEIVE return.expired

Examples

This example has been generated automatically.

RECEIVE transportation.updated

Examples

This example has been generated automatically.

RECEIVE refund.created

Examples

This example has been generated automatically.

Messages

Schemas