Versions Compared

Version Old Version 1 New Version Current
Changes made by

Raghav Mehta

Raghav Mehta

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • This API is designed to generate listings in Omni (SKU barcode to ChannelSku) mappings, and it is pertinent for any ERP system that intends to push mapping for any channel.

  • Upon execution, the API will provide a response containing both the success and failure lists of SKUs. The success list will encompass the SKUs for which the listings have been successfully created in the Increff system, while the failure list will include those SKUs for which listings were not created in Increff system due to validation failures.

  • The error message in response body will clarify the issue with the listings. For such SKUs, listing creation should be retried after rectification.

Note:

  1. A single request can contain maximum of 5000 SKUs

  2. ERP system can create the listings for ERP and POS type channel by passing Channel alias in the channelName field in the API request

Request

Code Block
languagejson
{
  "channelName": "MarketplaceChannelAlias",
  "skuListings": [
    {
      "channelSkuCode": "ChannelSku1",
      "channelSerialNo": "ChannelSerialNo1",
      "barcode": "barcode1",
      "clientSkuCode":"ClientSku1",
      "toleranceDays": 2
    },
    {
      "channelSkuCode": "ChannelSku2",
      "channelSerialNo": "ChannelSerialNo2",
      "barcode": "barcode2",
      "clientSkuCode":"ClientSku2",
      "toleranceDays": null
    }
  ]
}

...

Parameter Name
Data Type
Description
Mandatory
skuListings
Object 
List of the SKUs whose listings is to be created
[ ]
Represents code of parent order of the order
No
channelName
String
Marketplace Channel Alias or ERP/POS channel alias configured in CIMS for which the Listings are pushed
Yes
skuListings.channelSkuCode
String
Unique identifier of SKU on channel’s end
SKU code of order item
Yes
skuListings.channelSerialNo
String
It’s the serial number of an SKU on channel 
Unique code generated at channel side for that order item.
Yes
skuListings.barcode
String
unique identifier of SKU on client’s end
Scannable code present on physical product that identifies an SKU uniquely
Yes
skuListings.
toleranceDays
channelName
String
Channel whose listing is to be created
Yes
clientSkuCode
Integer
Number of days the SKU is tolerant, it is used to set minExpiry of the SKU 
No
String
Unique identifier for an sku at client’s end
No
skuListings.toleranceDays
Integer
Days before getting expired upto which item can be used to fulfill orders created by ERP
No

Response
 Code Block
languagejson
{
  "successChannelSkus": [
    "ChannelSku1"
  ],
  "failureSkuListingCimsDatafailureSkuListingData": [
    {
      "channelSku": "ChannelSku2",
      "errorMessage": "Invalid Tolerance days"
    }
  ]
}
...
Parameter Name
Data Type
Description
successChannelSkus
Object
List of the skus whose listings were successfully createdSKUs for which listing creation is successful
failureSkuListingCimsData
Object
List of the skus whose SKUs for which listing creation is failed
failureSkuListingCimsData.channelSku
String
The sku whose SKUs for which listing creation failed
failureSkuListingCimsData.errorMessage
String
Reason for listing creation failure
...