Create Marketplace SKU Mappings API (By ERP)

Inbound | POST | /master/sku-listings

Summary

This API is used to create barcode to Channel (marketplace) SKU mappings by passing the channel name, provided the SKU master are already created for the channel.

Description

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.

<aside> 🗒️ Note:

A single request can contain maximum of 5000 SKUs
ERP system can create the listings for ERP and POS type channel by passing Channel alias in the channelName field in the API request </aside>

Request

{
  "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 [ ]	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	SKU code of order item	Yes
`skuListings.channelSerialNo`	String	Unique code generated at channel side for that order item.	Yes
`skuListings.barcode`	String	Scannable code present on physical product that identifies an SKU uniquely	No
`skuListings.clientSkuCode`	String	Unique identifier for an sku at client’s end	Conditionally Optional
In case `barcode`is sent in the request body, this is optional
`skuListings.toleranceDays`	Integer	Days before getting expired upto which item can be used to fulfill orders created by ERP	No

Response

{
  "successChannelSkus": [
    "ChannelSku1"
  ],
  "failureSkuListingData": [
    {
      "channelSku": "ChannelSku2",
      "errorMessage": "Invalid Tolerance days"
    }
  ]
}

Parameter Name	Data Type	Description
`successChannelSkus`	Object	List of the SKUs for which listing creation is successful
`failureSkuListingCimsData`	Object	List of the SKUs for which listing creation is failed
`failureSkuListingCimsData.channelSku`	String	The SKUs for which listing creation failed
`failureSkuListingCimsData.errorMessage`	String	Reason for listing creation failure