Versions Compared

Old Version 13

changes.mady.by.user Alaf Azam Khan

Saved on

compared with

New Version 14

changes.mady.by.user Raghav Mehta

Saved on

Key

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

...

This API will call the channel with the details of sales orders which are completed in Increff Omni. This will be triggered at a certain frequency from Increff Omni to the channels.

List of Indian State Names: State Names (Indian)

Please implement idempotency on messageId and on shipmentCode

Info

One order can have multiple shipments. Once a shipment is invoiced, it will appear in all subsequent postings, so endure you capture the unique shipmentCode for idempotency at shipment level.

 

We can send these posting on these triggers

  • OUTWARD_ORDER_CREATE,

  • OUTWARD_ORDER_CANCEL,

  • OUTWARD_ORDER_PARTIAL_CANCEL,

  • OUTWARD_ORDER_COMPLETE ,

  • OUTWARD_ORDER_SHIPMENT_DISPATCH,

  • OUTWARD_ORDER_SHIPMENT_DELIVER

...

Code Block
languagejson
{
  "partnerCode": "1100013090",
  "partnerLocationCode": "9",
  "locationCode": "IN132",
  "orderCode": "flipkart1234",
  "parentOrderCode": "flipkart1221",
  "isPriority": false,
  "channelName": "flipkart",
  "orderTime": "2020-10-16T20:22:28.000+00:00",
  "orderType": "SO/STO/RTV",
  "messageId": 12345,
  "paymentMethod": "COD",
  "eventType": "OUTWARD_ORDER_COMPLETE",
  "eventTime": "2020-10-16T20:22:28.000+00:00",
  "omsOrderId": 1234,
  "turnAroundTime": "2020-10-16T20:22:28.000+00:00",
  "virtualSkuDefinitions": [
    {
      "virtualParentChannelSkuId": "abc1",
      "virtualParentBarcode": "bar1",
      "childSkus": [
        {
          "channelSkuCode": "xyz",
          "qty": 2,
          "barcode": "bar23"
        },
        {
          "channelSkuCode": "xyz1",
          "qty": 1,
          "barcode": "bar34"
        }
      ]
    }
  ],
  "isSplitRequiredbundledSkuDefinitions": "false",[
  "shippingCharges": 20,   "channelType": "ERP",   "orderItems": [   {
 {       "orderItemCode": "item123",            "channelSkuCodebundledParentBarcode": "1000889888string",
      "orderedQuantity": 2,       "cancelledQuantity": 1,
      "channelDiscountbundledParentChannelSkuId": 50"string",
      "sellingPricePerUnit": 500,       "giftChargePerUnit": 10,
      "sellerDiscountchildSkus": [
  5,       "shippingCharge": 0,       "omsItemId": 123,      {
"barcode": "barcode1",       "orderItemCustomAttributes": {         "attribute1": "Value1",         "attribute2barcode": "Value2string",
        "attribute3": "Value3",         "attribute4": "Value4",         "attribute5channelSkuCode": "Value5string",
        "attribute6": "Value6",         "attribute7": "Value7",         "attribute8qty": "Value8",0
        "attribute9": "Value9",         "channelMetadata": { 			"totalCashOnDeliveryFee": 0.0, 			"department": "HR",
			"paymentMethod": "ccavenue",
			"status": "processing" }
           },       ]
 "attribute10": "Value10"       }     }
  ],   "shipments": [     {    ],
  "shipmentCodeisSplitRequired": "UIfd897false",
  "shippingCharges": 20,
  "locationCodechannelType": "loc1ERP",
  "orderItems": [
    {
      "generatedInvoiceIdorderItemCode": "AR105044395item123",
      "generatedInvoiceDatechannelSkuCode": "2020-10-16T20:22:28.000+00:001000889888",
      "externalInvoiceIdorderedQuantity": "FK56556GH45"2,
      "externalInvoiceDatecancelledQuantity": "2020-10-16T20:22:28.000+00:00"1,
      "invoiceDocumentUrlchannelDiscount": "https://mybrand.com/invoice123.pdf"50,
      "shippingLabelDocumentUrlsellingPricePerUnit": "https://mybrand.com/sldoc.pdf"500,
      "irngiftChargePerUnit": "a429746e55b844c9d2cb2a6f68997d1c2af29987cc834f3b52da45d1b0bc97c9"10,
      "qrCodesellerDiscount": "eyJhbGciPiJSUzI1NiIsImtpZCI6IkI4RDYzRUNCMThFQTVFNkY0QUKDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGcifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFPQ001MzI2SjFaWVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUJDUjE3MThFMVpMXCIsXCJEb2NOb1wiOlwiTUVhajIyLTIzLzUwNTlcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTMvMTAvMjAyMlwiLFwiVG90SW52VmFsXCI6MTgxNy4wNCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjYyMTE0MjkwXCIsXCJJcm5cIjpcImE0Mjk3NDZlMzRkODQ0YzlkMmNiMmE2ZjY4OTk3ZDFjMmFmMjM5ODdjYzgzNGYzYjUyZGE0NWQxYjBiYzk3YzlcIixcIklybkR0XCI6XCIyMDIyLTEwLTEzIDEyOjAxOjAwXCJ9IiwiaXNzIjoiTklDIn0.wvB7b15AnpdQdX_d0VZEyj9dL1qWDaOFPLRPrlV0V2XIu3cE3aQ3YtsWLnTnyrmtUlokpbkkE4folBQNhfzkCPlnODNxRPfpO-Kz9eyNpqcIEp-8TqvcDKXZ3PrBRqmNmner00AG_fVmmqT1HLiyKB2sqOnhqtCfQaQF-PGnqIOhal3PDxIMVt0WAtaQOIwwDA75dsjjnFHaZFPl9tFPR8A6Wrw4NhQH-7xhABKW3Z961a_rGmO6M3XP7jPHyYPW-QWMfTqwNXwxNdFgFePL5FloPiUipt2-g4FIplgm-YcN1xMvEQ2irAfzQwbnxi7UKz-jwOgM0Zy2BbburYgDvQ"5,
      "shipmentStatusshippingCharge": "DELIVERED",0,
      "awbNumberomsItemId": "awb1"123,
      "shipmentItemsbarcode": ["barcode1",
       "orderItemCustomAttributes": {

         "channelSkuCodeattribute1": "100000789702Value1",

         "orderItemCodeattribute2": "item123Value2",

         "netTaxAmountPerUnitattribute3": 60"Value3",
          "netTaxAmountTotalattribute4": 120"Value4",
 
        "baseSellingPricePerUnitattribute5": 500"Value5",
          "baseSellingPriceTotalattribute6": 1000"Value6",
          "sellingPricePerUnitattribute7": 560"Value7",

         "sellingPriceTotalattribute8": 1120"Value8",
          "quantityattribute9": 2"Value9",
          "shippingChargePerUnitchannelMetadata": 36,
     {
			"totalCashOnDeliveryFee": 0.0,
			"department": "HR",
			"paymentMethod": "ccavenue",
			"status": "processing"
    "channelDiscount": 30,    },
        "taxItemsattribute10": ["Value10"
      }
    }
  {],
  "shipments": [
    {
      "typeshipmentCode": "SGSTUIfd897",
      "locationCode": "loc1",
      "rategeneratedInvoiceId": 6"AR105044395",
      "generatedInvoiceDate": "2020-10-16T20:22:28.000+00:00",
      "taxPerUnitexternalInvoiceId": 30"FK56556GH45",
      "externalInvoiceDate": "2020-10-16T20:22:28.000+00:00",
      "taxTotalinvoiceDocumentUrl": 60"https://mybrand.com/invoice123.pdf",
            }"shippingLabelDocumentUrl": "https://mybrand.com/sldoc.pdf",
      "irn": "a429746e55b844c9d2cb2a6f68997d1c2af29987cc834f3b52da45d1b0bc97c9",
    {  "qrCode": "eyJhbGciPiJSUzI1NiIsImtpZCI6IkI4RDYzRUNCMThFQTVFNkY0QUKDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGcifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFPQ001MzI2SjFaWVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUJDUjE3MThFMVpMXCIsXCJEb2NOb1wiOlwiTUVhajIyLTIzLzUwNTlcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTMvMTAvMjAyMlwiLFwiVG90SW52VmFsXCI6MTgxNy4wNCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjYyMTE0MjkwXCIsXCJJcm5cIjpcImE0Mjk3NDZlMzRkODQ0YzlkMmNiMmE2ZjY4OTk3ZDFjMmFmMjM5ODdjYzgzNGYzYjUyZGE0NWQxYjBiYzk3YzlcIixcIklybkR0XCI6XCIyMDIyLTEwLTEzIDEyOjAxOjAwXCJ9IiwiaXNzIjoiTklDIn0.wvB7b15AnpdQdX_d0VZEyj9dL1qWDaOFPLRPrlV0V2XIu3cE3aQ3YtsWLnTnyrmtUlokpbkkE4folBQNhfzkCPlnODNxRPfpO-Kz9eyNpqcIEp-8TqvcDKXZ3PrBRqmNmner00AG_fVmmqT1HLiyKB2sqOnhqtCfQaQF-PGnqIOhal3PDxIMVt0WAtaQOIwwDA75dsjjnFHaZFPl9tFPR8A6Wrw4NhQH-7xhABKW3Z961a_rGmO6M3XP7jPHyYPW-QWMfTqwNXwxNdFgFePL5FloPiUipt2-g4FIplgm-YcN1xMvEQ2irAfzQwbnxi7UKz-jwOgM0Zy2BbburYgDvQ",
           "typeshipmentStatus": "CGSTDELIVERED",
      "awbNumber": "awb1",
      "rateshipmentItems": 6,[
        {
          "taxPerUnitchannelSkuCode": 30,
  "100000789702",
           "taxTotalorderItemCode": 60"item123",
          "netTaxAmountPerUnit": 60,
}           ]
        },
        {
          "channelSkuCode": "100000734701",
          "orderItemCode": "item124",
          "netTaxAmountPerUnit": 60,
          ""netTaxAmountTotal": 120,
          "baseSellingPricePerUnit": 500,
          "baseSellingPriceTotal": 1000,
          "sellingPricePerUnit": 560,
          "sellingPriceTotal": 1120,
          "quantity": 2,
          "shippingChargePerUnit": 36,
          "channelDiscount": 30,
          "taxItems": [
            {
              "type": "SGST",
              "rate": 6,
              "taxPerUnit": 30,
              "taxTotal": 60
            },
            {
              "type": "CGST",
              "rate": 6,
              "taxPerUnit": 30,
              "taxTotal": 60
            }
          ]
        },
        ]{
    }   ],   "shipmentDetailschannelSkuCode": {"100000734701",
    "length": 30.0,     "breadthorderItemCode": 20.0"item124",
    "height": 10.0,     "weightnetTaxAmountPerUnit": 5.060,
    "shipmentId": 12345,     "totalItemQuantitynetTaxAmountTotal": 50120,
     "packboxDetailsList": [    "baseSellingPricePerUnit": 500,
 {         "lengthbaseSellingPriceTotal": 15.01000,
          "breadthsellingPricePerUnit": 10.0560,
          "heightsellingPriceTotal": 8.01120,
          "weightquantity": 2.0,
          "boxIdshippingChargePerUnit": 136,
          "awbNumberchannelDiscount": "AWB123"30,
          "packBoxRemarkstaxItems": "Fragile items", [
            {
   "skuQuantityDataList": [           {"type": "SGST",
              "globalSkuIdrate": 9876,
              "clientSkuIdtaxPerUnit": "SKU001"30,
              "counttaxTotal": 60
 10           },
            {
              "globalSkuIdtype": 876"CGST",
              "clientSkuIdrate": "SKU002"6,
              "counttaxPerUnit": 1530,
            }  "taxTotal": 60
     ]       }
    ]   },   "shippingAddress":]
{     "name": "Customer's Name", }
   "line1": "Line Address 1",]
    "line2": "Line Address 2",
 }
  ],
  "line3shipmentDetails": "Line{
Address 3",     "citylength": "city"30.0,
    "statebreadth": "state"20.0,
    "zipheight": "zip"10.0,
    "countryweight": "country"5.0,
    "emailshipmentId": "abc@gmail.com"12345,
    "phonetotalItemQuantity": "9999999999"50,
  },   "billingAddresspackboxDetailsList": [
    {  {
  "name": "customer",     "line1length": "address line 1",15.0,
        "line2breadth": "address line 2",10.0,
        "line3height": "address line 3", 8.0,
        "cityweight": "Bengaluru"2.0,
        "stateboxId": "Karnataka",1,
        "zipawbNumber": "560076AWB123",
        "countrypackBoxRemarks": "INDIAFragile items",
        "emailskuQuantityDataList": "abc@gmail.com",[
    "phone": "9999999999"   },  {
"orderCustomAttributes": {     "attribute1": "Value1",     "attribute2globalSkuId": "Value2"987,
     "attribute3": "Value3",       "attribute4clientSkuId": "Value4SKU001",
     "attribute5": "Value5",      "attribute6count": "Value6",10
    "attribute7": "Value7",     "attribute8": "Value8",},
     "attribute9": "Value9",    {
"attribute10": "Value10",     "channelMetadata": { 		"totalCashOnDeliveryFee": 0.0, 		"department": "HR", 		"paymentMethodglobalSkuId": "ccavenue"876,
 		"status": "processing"     },     "currencyclientSkuId": "INRSKU002",
  }
}

 More Request Samples

{
"partnerCode":
"1100013090",
   "
partnerLocationCode
count":
"9",
15
"locationCode":
"IN132",
"orderCode": "flipkart1234",
 }
"parentOrderCode":
"flipkart1221",
"isPriority":
false,
 ]
"channelName":
"flipkart",
"orderTime": "2020-10-16T20:22:28.000+00:00", "orderType": "SO/STO/RTV"
 }
    ]
  },
  "
messageId
shippingAddress": {
12345,
    "
paymentMethod
name": "
COD
Customer's Name",
    "
eventType
line1": "
OUTWARD_ORDER_COMPLETE
Line Address 1",
    "
eventTime
line2": "
2020-10-16T20:22:28.000+00:00",
Line Address 2",
    "
omsOrderId
line3":
1234,
"Line Address 3",
    "
turnAroundTime
city": "
2020-10-16T20:22:28.000+00:00
city",
    "
virtualSkuDefinitions
state":
[
"state",
{ 
"zip": "zip",
    
"
virtualParentChannelSkuId
country": "
abc1
country",

    "
virtualParentBarcode
email": "
bar1
abc@gmail.com",

    
"
childSkus
phone":
[
"9999999999"
  },
  
"billingAddress": 
{
    "name": "customer",
    "
channelSkuCode
line1": "
xyz
address line 1",
    "line2": "address line 2",
    "
qty
line3":
2,
"address 
line 3",
    "
barcode
city": "
bar23
Bengaluru",
}
"state": "Karnataka",
    "zip": "560076",
{
  
"country": "INDIA",
    "
channelSkuCode
email": "
xyz1
abc@gmail.com",
    "phone": "9999999999"
  },
  "
qty
orderCustomAttributes":
1,
{
    "attribute1": "Value1",
    "
barcode
attribute2": "
bar34
Value2",
} ] } ], "isSplitRequired
"attribute3": "Value3",
    "attribute4": "
false
Value4",
"shippingCharges":
20, 
 "
channelType
attribute5": "
ERP
Value5",
    "
orderItems
attribute6":
[ {
"Value6",
    
"
orderItemCode
attribute7": "
item123
Value7",
    
"
channelSkuCode
attribute8": "
1000889888
Value8",

    
"
orderedQuantity
attribute9":
2
"Value9",

    "
cancelledQuantity
attribute10":
1
"Value10",
    
"
channelDiscount
channelMetadata":
50, "sellingPricePerUnit
{
		"totalCashOnDeliveryFee":
500
0.0,
"giftChargePerUnit
		"department":
10, "sellerDiscount": 5, "shippingCharge": 0, "omsItemId": 123, "barcode
"HR",
		"paymentMethod": "ccavenue",
		"status": "
barcode1
processing"
,

    },
"orderItemCustomAttributes":
{
"attribute1
"currency": "
Value1", "attribute2": "Value2", "attribute3": "Value3", "attribute4": "Value4", "attribute5": "Value5", "attribute6": "Value6", "attribute7": "Value7", "attribute8": "Value8", "attribute9": "Value9", "channelMetadata": { "totalCashOnDeliveryFee": 0.0, "department": "HR", "paymentMethod": "ccavenue", "status": "processing" }, "attribute10": "Value10" } } ], "shipments": [ { "shipmentCode": "UIfd897", "locationCode": "loc1", "generatedInvoiceId": "AR105044395", "generatedInvoiceDate": "2020-10-16T20:22:28.000+00:00", "externalInvoiceId": "FK56556GH45", "externalInvoiceDate": "2020-10-16T20:22:28.000+00:00", "invoiceDocumentUrl": "https://mybrand.com/invoice123.pdf", "shippingLabelDocumentUrl": "https://mybrand.com/sldoc.pdf", "irn": "a429746e55b844c9d2cb2a6f68997d1c2af29987cc834f3b52da45d1b0bc97c9", "qrCode": "eyJhbGciPiJSUzI1NiIsImtpZCI6IkI4RDYzRUNCMThFQTVFNkY0QUKDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGcifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFPQ001MzI2SjFaWVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUJDUjE3MThFMVpMXCIsXCJEb2NOb1wiOlwiTUVhajIyLTIzLzUwNTlcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTMvMTAvMjAyMlwiLFwiVG90SW52VmFsXCI6MTgxNy4wNCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjYyMTE0MjkwXCIsXCJJcm5cIjpcImE0Mjk3NDZlMzRkODQ0YzlkMmNiMmE2ZjY4OTk3ZDFjMmFmMjM5ODdjYzgzNGYzYjUyZGE0NWQxYjBiYzk3YzlcIixcIklybkR0XCI6XCIyMDIyLTEwLTEzIDEyOjAxOjAwXCJ9IiwiaXNzIjoiTklDIn0.wvB7b15AnpdQdX_d0VZEyj9dL1qWDaOFPLRPrlV0V2XIu3cE3aQ3YtsWLnTnyrmtUlokpbkkE4folBQNhfzkCPlnODNxRPfpO-Kz9eyNpqcIEp-8TqvcDKXZ3PrBRqmNmner00AG_fVmmqT1HLiyKB2sqOnhqtCfQaQF-PGnqIOhal3PDxIMVt0WAtaQOIwwDA75dsjjnFHaZFPl9tFPR8A6Wrw4NhQH-7xhABKW3Z961a_rGmO6M3XP7jPHyYPW-QWMfTqwNXwxNdFgFePL5FloPiUipt2-g4FIplgm-YcN1xMvEQ2irAfzQwbnxi7UKz-jwOgM0Zy2BbburYgDvQ", "shipmentStatus": "DELIVERED", "awbNumber": "awb1", "shipmentItems": [ { "channelSkuCode": "100000789702", "orderItemCode": "item123", "netTaxAmountPerUnit": 60, "netTaxAmountTotal": 120, "baseSellingPricePerUnit": 500, "baseSellingPriceTotal": 1000, "sellingPricePerUnit": 560, "sellingPriceTotal": 1120, "quantity": 2, "shippingChargePerUnit": 36, "channelDiscount": 30, "taxItems": [ { "type": "SGST", "rate": 6, "taxPerUnit": 30, "taxTotal": 60 }, { "type": "CGST", "rate": 6, "taxPerUnit": 30, "taxTotal": 60 } ] }, { "channelSkuCode": "100000734701", "orderItemCode": "item124", "netTaxAmountPerUnit": 60, "netTaxAmountTotal": 120, "baseSellingPricePerUnit": 500, "baseSellingPriceTotal": 1000, "sellingPricePerUnit": 560, "sellingPriceTotal": 1120, "quantity": 2, "shippingChargePerUnit": 36, "channelDiscount": 30, "taxItems": [ { "type": "SGST", "rate": 6, "taxPerUnit": 30, "taxTotal": 60 }, { "type": "CGST", "rate": 6, "taxPerUnit": 30, "taxTotal": 60 } ] } ] } ], "shipmentDetails": { "length": 30.0, "breadth": 20.0, "height": 10.0, "weight": 5.0, "shipmentId": 12345, "totalItemQuantity": 50, "packboxDetailsList": [ { "length": 15.0, "breadth": 10.0, "height": 8.0, "weight": 2.0, "boxId": 1, "awbNumber": "AWB123", "packBoxRemarks": "Fragile items", "skuQuantityDataList": [ { "globalSkuId": 987, "clientSkuId": "SKU001", "count": 10 }, { "globalSkuId": 876, "clientSkuId": "SKU002", "count": 15 } ] } ] }, "shippingAddress": { "name": "Customer's Name", "line1": "Line Address 1", "line2": "Line Address 2", "line3": "Line Address 3", "city": "city", "state": "state", "zip": "zip", "country": "country", "email": "abc@gmail.com", "phone": "9999999999" }, "billingAddress": { "name": "customer", "line1": "address line 1", "line2": "address line 2", "line3": "address line 3", "city": "Bengaluru", "state": "Karnataka", "zip": "560076", "country": "INDIA", "email": "abc@gmail.com", "phone": "9999999999" }, "orderCustomAttributes": { "attribute1": "Value1", "attribute2": "Value2", "attribute3": "Value3", "attribute4": "Value4", "attribute5": "Value5", "attribute6": "Value6", "attribute7": "Value7", "attribute8": "Value8", "attribute9": "Value9", "attribute10": "Value10", "channelMetadata": { "totalCashOnDeliveryFee": 0.0, "department": "HR", "paymentMethod": "ccavenue", "status": "processing" }, "currency": "INR" } }
Expand
titleOUTWARD_ORDER_COMPLETE
Code Block
languagejson

Expand
titleOUTWARD_ORDER_CREATE
Code Block
{
  "partnerCode": "1100013090",
  "partnerLocationCode": "9",
  "locationCode": "IN132",
  "orderCode": "flipkart1234",
  "parentOrderCode": "flipkart1221",
  "isPriority": false,
  "channelName": "flipkart",
  "orderTime": "2020-10-16T20:22:28.000+00:00",
  "orderType": "SO/STO/RTV",
  "messageId": 12345,
  "paymentMethod": "COD",
  "eventType": "OUTWARD_ORDER_CREATE",
  "eventTime": "2020-10-16T20:22:28.000+00:00",
  "omsOrderId": 1234,
  "turnAroundTime": "2020-10-16T20:22:28.000+00:00",
  "virtualSkuDefinitions": [
    {
      "virtualParentChannelSkuId": "abc1",
      "virtualParentBarcode": "bar1",
      "childSkus": [
        {
          "channelSkuCode": "xyz",
          "qty": 2,
          "barcode": "bar23"
        },
        {
          "channelSkuCode": "xyz1",
          "qty": 1,
          "barcode": "bar34"
        }
      ]
    }
  ],
  "isSplitRequired": "false",
  "shippingCharges": 20,
  "channelType": "ERP",
  "orderItems": [
    {
      "orderItemCode": "item123",
      "channelSkuCode": "1000889888",
      "orderedQuantity": 2,
      "cancelledQuantity": 1,
      "channelDiscount": 50,
      "sellingPricePerUnit": 500,
      "giftChargePerUnit": 10,
      "sellerDiscount": 5,
      "shippingCharge": 0,
      "omsItemId": 123,
      "barcode": "barcode1",
      "orderItemCustomAttributes": {
        "attribute1": "Value1",
        "attribute2": "Value2",
        "attribute3": "Value3",
        "attribute4": "Value4",
        "attribute5": "Value5",
        "attribute6": "Value6",
        "attribute7": "Value7",
        "attribute8": "Value8",
        "attribute9": "Value9",
        "channelMetadata": {
			"totalCashOnDeliveryFee": 0.0,
			"department": "HR",
			"paymentMethod": "ccavenue",
			"status": "processing"
        },
        "attribute10": "Value10"
      }
    }
  ],
  "shipments": [
    {
      "shipmentCode": "UIfd897",
      "locationCode": "loc1",
      "generatedInvoiceId": "AR105044395",
      "generatedInvoiceDate": "2020-10-16T20:22:28.000+00:00",
      "externalInvoiceId": "FK56556GH45",
      "externalInvoiceDate": "2020-10-16T20:22:28.000+00:00",
      "invoiceDocumentUrl": "https://mybrand.com/invoice123.pdf",
      "shippingLabelDocumentUrl": "https://mybrand.com/sldoc.pdf",
      "irn": "a429746e55b844c9d2cb2a6f68997d1c2af29987cc834f3b52da45d1b0bc97c9",
      "qrCode": "eyJhbGciPiJSUzI1NiIsImtpZCI6IkI4RDYzRUNCMThFQTVFNkY0QUKDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGcifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFPQ001MzI2SjFaWVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUJDUjE3MThFMVpMXCIsXCJEb2NOb1wiOlwiTUVhajIyLTIzLzUwNTlcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTMvMTAvMjAyMlwiLFwiVG90SW52VmFsXCI6MTgxNy4wNCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjYyMTE0MjkwXCIsXCJJcm5cIjpcImE0Mjk3NDZlMzRkODQ0YzlkMmNiMmE2ZjY4OTk3ZDFjMmFmMjM5ODdjYzgzNGYzYjUyZGE0NWQxYjBiYzk3YzlcIixcIklybkR0XCI6XCIyMDIyLTEwLTEzIDEyOjAxOjAwXCJ9IiwiaXNzIjoiTklDIn0.wvB7b15AnpdQdX_d0VZEyj9dL1qWDaOFPLRPrlV0V2XIu3cE3aQ3YtsWLnTnyrmtUlokpbkkE4folBQNhfzkCPlnODNxRPfpO-Kz9eyNpqcIEp-8TqvcDKXZ3PrBRqmNmner00AG_fVmmqT1HLiyKB2sqOnhqtCfQaQF-PGnqIOhal3PDxIMVt0WAtaQOIwwDA75dsjjnFHaZFPl9tFPR8A6Wrw4NhQH-7xhABKW3Z961a_rGmO6M3XP7jPHyYPW-QWMfTqwNXwxNdFgFePL5FloPiUipt2-g4FIplgm-YcN1xMvEQ2irAfzQwbnxi7UKz-jwOgM0Zy2BbburYgDvQ",
      "shipmentStatus": "DELIVERED",
      "awbNumber": "awb1",
      "shipmentItems": [
        {
          "channelSkuCode": "100000789702",
          "orderItemCode": "item123",
          "netTaxAmountPerUnit": 60,
          "netTaxAmountTotal": 120,
          "baseSellingPricePerUnit": 500,
          "baseSellingPriceTotal": 1000,
          "sellingPricePerUnit": 560,
          "sellingPriceTotal": 1120,
          "quantity": 2,
          "shippingChargePerUnit": 36,
          "channelDiscount": 30,
          "taxItems": [
            {
              "type": "SGST",
              "rate": 6,
              "taxPerUnit": 30,
              "taxTotal": 60
            },
            {
              "type": "CGST",
              "rate": 6,
              "taxPerUnit": 30,
              "taxTotal": 60
            }
          ]
        },
        {
          "channelSkuCode": "100000734701",
          "orderItemCode": "item124",
          "netTaxAmountPerUnit": 60,
          "netTaxAmountTotal": 120,
          "baseSellingPricePerUnit": 500,
          "baseSellingPriceTotal": 1000,
          "sellingPricePerUnit": 560,
          "sellingPriceTotal": 1120,
          "quantity": 2,
          "shippingChargePerUnit": 36,
          "channelDiscount": 30,
          "taxItems": [
            {
              "type": "SGST",
              "rate": 6,
              "taxPerUnit": 30,
              "taxTotal": 60
            },
            {
              "type": "CGST",
              "rate": 6,
              "taxPerUnit": 30,
              "taxTotal": 60
            }
          ]
        }
      ]
    }
  ],
  "shipmentDetails": {
    "length": 30.0,
    "breadth": 20.0,
    "height": 10.0,
    "weight": 5.0,
    "shipmentId": 12345,
    "totalItemQuantity": 50,
    "packboxDetailsList": [
      {
        "length": 15.0,
        "breadth": 10.0,
        "height": 8.0,
        "weight": 2.0,
        "boxId": 1,
        "awbNumber": "AWB123",
        "packBoxRemarks": "Fragile items",
        "skuQuantityDataList": [
          {
            "globalSkuId": 987,
            "clientSkuId": "SKU001",
            "count": 10
          },
          {
            "globalSkuId": 876,
            "clientSkuId": "SKU002",
            "count": 15
          }
        ]
      }
    ]
  },
  "shippingAddress": {
    "name": "Customer's Name",
    "line1": "Line Address 1",
    "line2": "Line Address 2",
    "line3": "Line Address 3",
    "city": "city",
    "state": "state",
    "zip": "zip",
    "country": "country",
    "email": "abc@gmail.com",
    "phone": "9999999999"
  },
  "billingAddress": {
    "name": "customer",
    "line1": "address line 1",
    "line2": "address line 2",
    "line3": "address line 3",
    "city": "Bengaluru",
    "state": "Karnataka",
    "zip": "560076",
    "country": "INDIA",
    "email": "abc@gmail.com",
    "phone": "9999999999"
  },
  "orderCustomAttributes": {
    "attribute1": "Value1",
    "attribute2": "Value2",
    "attribute3": "Value3",
    "attribute4": "Value4",
    "attribute5": "Value5",
    "attribute6": "Value6",
    "attribute7": "Value7",
    "attribute8": "Value8",
    "attribute9": "Value9",
    "attribute10": "Value10",
    "channelMetadata": {
		"totalCashOnDeliveryFee": 0.0,
		"department": "HR",
		"paymentMethod": "ccavenue",
		"status": "processing"
    },
    "currency": "INR"
  }
}

...

INR"
  }
}

Parameter Name

Data Type

Description

Mandatory

partnerCode

String

This represents the partner to which order was shipped to.

If Order is of type SO/STO, this field represents customer’s code

If Order is of type RTV, this field represents vendor’s code

For Marketplaces Orders, this field will be having the erp channel name which is mapped in Increff Omni

yesYes

partnerLocationCode

String

This represents the partner’s location to which order was shipped to.

If Order is of type SO/STO, this field represents customer location’s code

If Order is of type RTV, this field represents vendor location’s code

yes

isPriority

Boolean

Flag to identify wether an order is of priority or not

yes

locationCode

String

Warehouse location from which order was fulfilled

Yes

 

orderCode

String

Unique code used by the channel to identify order

yes

parentOrderCode

String

Parent order code  which can be null or empty or some duplicate value across orders. 

no

channelName

String

Channel name of the marketplace.

yes

orderTime

String

Time at which order was placed at the channel in UNIX (UTC)

yes

orderType

String

Can be - SO(Sales Order)/STO(Stock Transfer Order)/RTV(Return To Vendor), RPO(Replacement)

yes

messageId

Long

Unique Identifier of a notification (for De-duplication)

Yes

paymentMethod

String

Possible values - COD, NCOD

yes

eventTime

String

Time of the event

yes

eventType

String

Postings can be sent on the below triggers

  • OUTWARD_ORDER_CREATE(creation of order),

  • OUTWARD_ORDER_CANCEL(cancellation of order),

  • OUTWARD_ORDER_PARTIAL_CANCEL(partial cancellation of order),

  • OUTWARD_ORDER_COMPLETE(completion of order) ,

  • OUTWARD_ORDER_SHIPMENT_DISPATCH(Shipment dispatch for order),

  • OUTWARD_ORDER_SHIPMENT_DELIVER(Shipment delivery for order)

yes

omsOrderId

Long

Internal order id of OMS

no

turnAroundTime

ZonedDateTime

Turnaround time

nolocation’s code

Yes

isPriority

Boolean

Flag to identify wether an order is of priority or not

Yes

locationCode

String

Warehouse location from which order was fulfilled

Yes

 

orderCode

String

Unique code used by the channel to identify order

Yes

parentOrderCode

String

Parent order code  which can be null or empty or some duplicate value across orders. 

No

channelName

String

Channel name of the marketplace.

Yes

orderTime

String

Time at which order was placed at the channel in UNIX (UTC)

Yes

orderType

String

Can be - SO(Sales Order)/STO(Stock Transfer Order)/RTV(Return To Vendor), RPO(Replacement)

Yes

messageId

Long

Unique Identifier of a notification (for De-duplication)

Yes

paymentMethod

String

Possible values - COD, NCOD

Yes

eventTime

String

Time of the event

Yes

eventType

String

Postings can be sent on the below triggers

  • OUTWARD_ORDER_CREATE(creation of order),

  • OUTWARD_ORDER_CANCEL(cancellation of order),

  • OUTWARD_ORDER_PARTIAL_CANCEL(partial cancellation of order),

  • OUTWARD_ORDER_COMPLETE(completion of order) ,

  • OUTWARD_ORDER_SHIPMENT_DISPATCH(Shipment dispatch for order),

  • OUTWARD_ORDER_SHIPMENT_DELIVER(Shipment delivery for order)

Yes

omsOrderId

Long

Internal order id of OMS

No

turnAroundTime

ZonedDateTime

Turnaround time

No

bundledSkuDefinitions

Object[]

List of bundled sku definitions

Yes

bundledSkuDefinitions.bundledParentBarcode

String

Unique barcode of bundled Sku

No

bundledSkuDefinitions.bundledParentChannelSkuId

String

Unique identifier of bundled Sku at channel

Yes

bundledSkuDefinitions.childSkus

Object[]

List of child SKUs

Yes

childSkus.barcode

String

Unique barcode of child sku

No

childSkus.channelSkuCode

String

Unique identifier of child sku at channel

No

childSkus.qty

Integer

child sku quantity

No

orderItems

Object[]

List of order items

yesYes

orderItems.orderItemCode

String

This is provided by the channel to uniquely identify each order item.

yesYes

orderItems.channelskuCode

String

SKU code of order item

yesYes

orderItems.orderedQuantity

int

Ordered Quantity

yesYes

orderItems.cancelledQuantity

int

cancelledQuantity

yesYes

orderItems.sellingPricePerUnit

double

sellingPricePerUnit

yesYes

orderItems.giftChargePerUnit

Double

giftChargePerUnit

noNo

orderItems.channelDiscount

Double

Discount provided by channel per unit

noNo

orderItems.sellerDiscount

Double

Discount provided by seller per unit

noNo

orderItems.omsItemId

Long

Internal item id of OMS

noNo

orderItems.barcode

String

Barcode to identify a product

yesYes

orderItems.orderItemCustomAttributes

Object

Custom attributes for order items

No

orderItemCustomAttributes.attribute1

String

Custom attribute 1

No

orderItemCustomAttributes.attribute2

String

Custom attribute 2

No

orderItemCustomAttributes.attribute3

String

Custom attribute 3

No

orderItemCustomAttributes.attribute4

String

Custom attribute 4

No

orderItemCustomAttributes.attribute5

String

Custom attribute 5

No

orderItemCustomAttributes.attribute6

String

Custom attribute 6

No

orderItemCustomAttributes.attribute7

String

Custom attribute 7

No

orderItemCustomAttributes.attribute8

String

Custom attribute 8

No

orderItemCustomAttributes.attribute9

String

Custom attribute 9

No

orderItemCustomAttributes.attribute10

String

Custom attribute 10

No

orderItemCustomAttributes.channelMetaData

Object

These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows

noNo

orderCustomAttributes

Object

Custom attributes for an order

No

orderCustomAttributes.channelMetaData

Objecg

These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows

No

orderCustomAttributes.currency

String

Currency

No

orderCustomAttributes.attribute1

String

Custom attribute 1

No

orderCustomAttributes.attribute2

String

Custom attribute 2

No

orderCustomAttributes.attribute3

String

Custom attribute 3

No

orderCustomAttributes.attribute4

String

Custom attribute 4

No

orderCustomAttributes.attribute5

String

Custom attribute 5

No

orderCustomAttributes.attribute6

String

Custom attribute 6

No

orderCustomAttributes.attribute7

String

Custom attribute 7

No

orderCustomAttributes.attribute8

String

Custom attribute 8

No

orderCustomAttributes.attribute9

String

Custom attribute 9

No

orderCustomAttributes.attribute10

String

Custom attribute 10

No

shipments.qrCode

String

QR code

noNo

shipments.shipmentStatus

String

Status of the shipment

noNo

shipments.awbNumber

String

AWB number of shipment

noNo

shipments.shipmentItems

Object[]

Items belonging to this shipment

yesYes

shipmentItems.channelSkuCode

String

SKU code of order item

yesYes

shipmentItems.locationCode

String

Fulfillment Location

yesYes

shipmentItems.orderItemCode

String

This is provided by the channel to uniquely identify each order item.

yesYes

shipmentItems.netTaxAmountPerUnit

Double

Per unit tax applicable for the SKU.

yesYes

shipmentItems.netTaxAmountTotal

Double

Total tax applicable for the SKU

yesYes

shipmentItems.baseSellingPricePerUnit

Double

Per unit base selling price of the SKU

yesYes

shipmentItems.baseSellingPriceTotal

Double

Total base selling price of SKU

yesYes

shipmentItems.sellingPricePerUnit

Double

Per unit selling price of the SKU including tax

yesYes

shipmentItems.sellingPriceTotal

Double

Total selling price of the SKU 

yesYes

shipmentItems.quantity

Integer

Quantity of the sku in the shipment item.

yesYes

shipmentItems.shippingChargePerUnit

Double

Shipping charge per unit for a shipment item

noNo

shipmentItems.channelDiscount

Double

Channel discount of item

noNo

shipmentItems.taxItems

Object

Distribution of tax with tax type

yesYes

shipments.shipmentDetails

Object

Shipment details

noNo

shipmentDetails.length

Double

Length of the shipment

noNo

shipmentDetails.breadth

Double

Breadth of the shipment

noNo

shipmentDetails.height

Double

Height of the shipment

noNo

shipmentDetails.weight

Double

Weight of the shipment

noNo

shipmentDetails.shipmentId

Long

Id to uniquely identify a shipment

noNo

shipmentDetails.totalItemQuantity

Integer

Count of all the items in the shipment

noNo

shipmentDetails.packboxDetailsList

Object[]

Details of pack boxes

noNo

packboxDetailsList.length

Double

Length of the pack box in consideration

noNo

packboxDetailsList.breadth

Double

Breadth of the pack box in consideration

noNo

packboxDetailsList.height

Double

Height of the pack box in consideration

noNo

packboxDetailsList.weight

Double

Weight of the pack box in consideration

noNo

packboxDetailsList.boxId

Long

Id to uniquely identify a box

noNo

packboxDetailsList.awbNumber

String

AWB number of the box

noNo

packboxDetailsList.packBoxRemarks

String

Remarks for the pack box

noNo

packboxDetailsList.skuQuantityDataList

Object[]

Details of skus in a box

noNo

skuQuantityDataList.globalSkuId

Long

Id to uniquely identify a sku in increff’s system

noNo

skuQuantityDataList.clientSkuId

String

Id to uniquely identify a sku on client’s end

noNo

skuQuantityDataList.count

Integer

Count of a particular sku in a box

noNo

irn

String

Irn generated on Govt. portal while e-invoicing

noNo

qrCode

String

QrCode generated on Govt. portal while e-invoicing

noNo

shipmentStatus

String

Possible values: {OPEN,CLOSED, INVOICED, MANIFESTED, DISPATCHED, CANCELLED, DELIVERED}

noNo

taxItems.type

String

Type of tax applicable

yesYes

taxItems.rate

Double

Tax rate for this tax type

yesYes

taxItems.taxPerUnit

Double

Tax applicable for this type of tax per unit

yesYes

taxItems.taxTotal

Double

Total tax applicable for this type of tax

yesYes

shippingAddress

Object

Shipping address of the customer

yesYes

shippingAddress.name

String

Name of customer

yesYes

shippingAddress.line1

String

1st line of customer’s address

yesYes

shippingAddress.line2

String

2nd line of customer’s address

noNo

shippingAddress.line3

String

3rd line of customer’s address

noNo

shippingAddress.city

String

City of customer

yesYes

shippingAddress.state

String

State of customer

yesYes

shippingAddress.zip

String

ZIP/Pin code of customer

yesYes

shippingAddress.country

String

Country of customer

yesYes

shippingAddress.email

String

Email of customer

noNo

shippingAddress.phone

String

Phone Number of customer

noNo

billingAddress

Object

Billing address of the customer

yesYes

billingAddress.name

String

Name of customer

yesYes

billingAddress.line1

String

1st line of customer’s address

yesYes

billingAddress.line2

String

2nd line of customer’s address

noNo

billingAddress.line3

String

3rd line of customer’s address

noNo

billingAddress.city

String

City of customer

yesYes

billingAddress.state

String

State of customer

yesYes

billingAddress.zip

String

ZIP/Pin code of customer

yesYes

billingAddress.country

String

Country of customer

yesYes

billingAddress.email

String

Email of customer

noNo

billingAddress.phone

String

Phone Number of customer

no

 

Response

Code Block
{
    "hasError": false,
    "errorMessage":"message"
}

 

...

No