Create Marketplace SKU Listings API (By Shopfront)

Inbound | POST | /master/sku-listings/channel

Summary

This API is used to create listing mappings between product barcodes to marketplace/shopfront SKU in Increff system provided that product masters are already present for the SKU barcodes in Increff OMS system.

Description

This API is designed to generate listings in Omni (SKU barcode to ChannelSku) mappings from Shopfront system
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:

A single request can contain maximum of 5000 SKUs
Shopfront system can create the listings for any channel using the base URL of passing channel created in Increff system. (Base URL will be shared by Increff support team)

Request

{
  "skuListings": [
    {
      "channelSkuCode": "ChannelSku1",
      "channelSerialNo": "ChannelSerialNo1",
      "barcode": "barcode1",
      "clientSkuCode" : "clientSkuCode1",
      "toleranceDays": 2
    },
    {
      "channelSkuCode": "ChannelSku2",
      "channelSerialNo": "ChannelSerialNo2",
      "barcode": "barcode2",
      "clientSkuCode" : "clientSkuCode2",
      "toleranceDays": null
    }
  ]
}

Parameter Name	Data Type	Description	Mandatory
`skuListings`	Object [ ]	Represents code of parent order of the order	No
`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 This is non-mandatory in case barcode is sent in the request body
`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 whose listings were successfully created
`failureSkuListingCimsData`	Object[]	List of the skus whose listing creation failed
`failureSkuListingCimsData.channelSku`	String	The sku whose listing creation failed
`failureSkuListingCimsData.errorMessage`	String	Reason for listing creation failure