1. Home
  2. ReturnsJini
  3. Integrations

Integrations

  • ReturnsJini only with 2 integrations can pull returns expectations from ERP (coming from warehouse to online system or store to online system) and push the processed returns details on ERP or any end point required. Manual upload and download is also possible in Excel in case you do not need integrations
  • Product masters & product image required to QC any returned product is also automatically pulled through the client’s ERP via API integrations or you can also manually upload via Excel file
  • Sometimes AWB no. changes for a given return of a sales channel. Hence an API to update this AWB no. (Tracking ID) is available

Overview

  • All values will be stored as uppercase in our system (except attributes) and will be sent in uppercase to the external system in case of integrations.
  • All fields maximum length is 255 characters.

Connecting with APIs

All APIs will use REST/JSON protocol.

Authentication

Each system needs to give following headers for authentications:

  • authDomainName
  • authUsername
  • authPassword

Increff will provide you with these values.

Status Codes

Following HTTP status codes need to be used, to identify any issues

200: OK

403: Unauthorized

400: Bad data

500: Internal System error

Base URL

 <baseUrl>: https://returnsjini.increff.com

Glossary

  • Returns Expectations: Expected returns from the channel (i.e. marketplace)
  • dataSource: This means the source sending the returns expectations (e.g. ERP, CHANNEL-INTEGRATION). When uploading returns expectations via the UI, this value will be defaulted to UI. 
  • clientId: This can be used to identify two different businesses in a multi-brand organization.
  • productBarcode: This means the barcode on the product (e.g. EAN)
  • channel: This means a source of  return expectation (E..g AMAZON, EBAY, FLIPKART, MYNTRA)
  • channelReturnType: Permissible values are
    • RTO: Return to origin
    • CR: Customer returned
    • MRTO: For manually created RTO

API Interfaces

Pushing Article Master to the System

[
  {
    "productId": "string",
    "brand": "string",
    "style": "string",
    "size": "string",
    "mrp": 0,
    "color": "string",
    "client": "string",
    "imageUrl": "string",
    "attr1": "string",
    "attr2": "string",
    "attr3": "string",
    "attr4": "string",
    "attr5": "string"
  },
  {
    "productId": "string",
    "brand": "string",
    "style": "string",
    "size": "string",
    "mrp": 0,
    "color": "string",
    "client": "string",
    "imageUrl": "string",
    "attr1": "string",
    "attr2": "string",
    "attr3": "string",
    "attr4": "string",
    "attr5": "string"
  }
]

Notes

  • Most of the fields are self explanatory. You can use fields attr1 to  attr5 to send any extra information that you may want about the product. E.g. category,  sub-category, season, name of style, variant etc.
  • imageUrl: You need to provide a publicly accessible URL of the product images, so that it can be shown in the UI.

Update Channel Tracking ID for existing ChannelReturnOrder

Request

URL: <baseUrl>/api/integration/return/tracking-id

{
  "channel": "string",
  "channelReturnOrderId": "string",
  "existingChannelTrackingId": "string",
  "newChannelTrackingId": "string"
}

Notes

  • All fields are mandatory.
  • Order with ‘newChannelTrackingId’ for the same channel should not exist.

Pushing Returns Expectations to ReturnsJini 

Request

URL: <baseUrl>/api/integration/return

{
	"dataSource": "string",
	"clientId": "string",
	"channel": "string",
	"returnCreationDate": "dd-mm-yyyy",
	"channelReturnType": "RTO/CR/MRTO",
	"channelForwardOrderDate": "string",
	"channelParentOrderId": "string",
	"channelForwardOrderId": "string",
	"channelReturnOrderId": "rod1",
	"channelTrackingId": "string",
	"channelTransporterName": "string",
	"channelReason": "string",
	"channelSubReason": "string",
	"channelLineItems": [{
			"productBarcode": "ean1 ",
			"channelSkuId": "string",
			"channelQuantity": 2,
			"channelReturnLineItemId": "string",
			"itemAttr1": "string",
                        "itemAttr2": "string",
                        "itemAttr3": "string",
                        "itemAttr4": "string"

		},
		{
			"productBarcode": "ean12 ",
			"channelSkuId": "string",
			"channelQuantity": 1,
			"channelReturnLineItemId": "string",
			"itemAttr1": "string",
                        "itemAttr2": "string",
                        "itemAttr3": "string",
                        "itemAttr4": "string"

		}
	],
	"attr1": "string",
	"attr2": "string",
	"attr3": "string",
	"attr4": "string",
	"attr5": "string",
        "attr6": "string",
        "attr7": "string",
}
 

Error Response 

HTTP status code: 400: 

{
  "message": "Return order already exists"
}

Notes

  • Following fields are mandatory
    • dataSource, clientId,channel, returnCreationDate,channelReturnType, channelForwardId, channelForwardOrderDate, channelReturnOrderId, 
    • productBarcode. channelSkuId,channelQuantity
  • Other fields should be sent if available
  • Most of the fields are self explanatory. You can use fields attr1 to  attr7 to send any order level extra information that you may want, for example, customer’s name, zip code etc.
  • You can use itemAttr1 to itemAttr4 to send any item level extra information

Pushing Returns Processed|Expired from the System

URL & Credentials

To be added by client in the ReturnsJini system settings

{
  "extra": "TRUE | FALSE",
  "conclusion": "processed|expired",
  "<strong>warehouseId</strong>": "string",
  "dataSource": "string",
  "clientId": "string",
  "returnCreationDate": "dd - mm - yyyy",
  "channel": "string",
  "channelForwarOrderDate": "string",
  "channelForwardOrderId": "string",
  "channelParentOrderId": "string",
  "channelReturnOrderId": "string",
  "channelReturnType": "RTO/CR/MRTO",
  "channelReturnReason": "string",
  "channelSubReason": "string",
  "channelTrackingId": "string",
  "channelTransporterName": "string",
  "attr1": "string",
  "attr2": "string",
  "attr3": "string",
  "attr4": "string",
  "attr5": "string",
  "attr6": "string",
  "attr7": "string",
  "qcDate": "dd-mm-yyyy",
  "qcLineItems": [
    {
      "productBarcode": "ean1 ",
      "channelReturnLineItemId": "string",
      "channelSkuId": "string",
      "qcLineItemId": 123123,
      "qcStatus": "string",
      "qcReason": "string",
      "qcComment": "string",
      "itemAttr1": "string",
      "itemAttr2": "string",
      "itemAttr3": "string",
      "itemAttr4": "string"

    },
    {
      "productBarcode": "ean1",
      "channelReturnLineItemId": "string",
      "channelSkuId": "string",
      "qcLineItemId": 123124,
      "qcStatus": "string",
      "qcReason": "string",
      "qcComment": "string",
      "itemAttr1": "string",
      "itemAttr2": "string",
      "itemAttr3": "string",
      "itemAttr4": "string"
    }
  ]
}

Notes

  • In case the system doesn’t have any value, it will be sent as NULL. This can occur in cases where the return expectation expired, or there were extra items etc.
  • conclusion: It means whether  the returns expectation was actually processed in the system, or it got expired after X no. of days. In case of expired, you will get NULL values for  fields like
    • qcReason, qcStatus, qcDate, warehouseId
  • qcLineItemId: The returns system line number for each and every piece. This is for any future data reconciliation with the system.
  • extra: This field can be TRUE|FALSE, depending on if it was an extra item in the packet or not.
  • In case it is extra items,
    •  The following fields will be NULL
      • channelReturnLineItemId, channelSkuId
    • You can receive multiple payloads for the same channelReturnOrderId (for non-extra items and extra items)
    • If extra item is non-branded, then you will not receive any information (because it is junk/scrap)

QC Label

System will print a label for every QC’d item. The above fields will look like this in the printed label

Increff LogoReturn
clientIdbrand
channelchannelReturnOrderId
qcStatusproductBarcode
qcReason
  • All fields will be truncated to 30 characters.
  • The brand value will be filled from the Article master uploaded in the system 
  • Labels will not be printed for extra items.
  • There will be an option to disable printing of QC_PASS items in the system settings.
Was this article helpful to you? Yes 3 No

How can we help?