Page Comparison

...

Outbound | POST | {Client’s URL}

...

Description

This API will call share the channel with sales order details.

Description

This API will call the channel Outward Order data with the ERP system with the details of sales orders which are completed in Increff Omni. This
The API calls will be triggered sent at a certain frequency from Increff Omni system to the channels.

List of Indian State Names: State Names (Indian)

We can send these posting on these triggers

ERP system.

ERP system is advised to implement idempotency on messageId and shipmentCode fields.

Info
One order can have multiple shipments. Once a shipment is invoiced, it will appear in all subsequent posting Hence it should be ensured to capture the unique `shipmentCode` for idempotency at shipment level.

Postings can be triggered on below event types:

OUTWARD_ORDER_CREATE,
OUTWARD_ORDER_CANCEL
OUTWARD_ORDER_PARTIAL_CANCEL,
OUTWARD_ORDER_COMPLETE ,
OUTWARD_ORDER_SHIPMENT_DISPATCH
OUTWARD_ORDER_PARTIALSHIPMENT_CANCELDELIVER

Request

Code Block

language	json

{
  "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",
      "virtualParentClientSkuCode": "VPClientSku1",
      "childSkus": [
        {
          "channelSkuCode": "xyz",
          "qty": 2,
          "barcode": "bar23",
        },  "clientSkuCode": "ClientSku1"
     {   },
       "channelSkuCode": " {
          "channelSkuCode": "xyz1",
          "qty": 1,
          "barcode": "bar34",
        }  "clientSkuCode" : null
   ]     }
  ],   "isSplitRequired": "false", ]
  "shippingCharges": 20, }
 "channelType": "ERP" ],
  "orderItemsbundledSkuDefinitions": [
    {       "orderItemCode": "item123",  {
    "channelSkuCode": "1000889888",       "orderedQuantity": 2,       "cancelledQuantitybundledParentBarcode": 1"string",
      "channelDiscount": 50,              "sellingPricePerUnitbundledParentChannelSkuId": 500"string",
      "giftChargePerUnit": 10,       "sellerDiscount": 5,       "shippingChargebundledParentClientSkuCode": 0"BPClientSku1",

     "omsItemId": 123,       "barcode": "barcode1",       "orderItemCustomAttributeschildSkus": {[
         "attribute1": "Value1",         "attribute2": "Value2",    {
    "attribute3": "Value3",         "attribute4": "Value4",              "attribute5barcode": "Value5string",
        "attribute6": "Value6",         "attribute7": "Value7",         "attribute8clientSkuCode": "Value8ClientSku1",
           "attribute9": "Value9",             "channelMetadata": { 			"totalCashOnDeliveryFee": 0.0, 			"departmentchannelSkuCode": "HRstring",
			"paymentMethod": "ccavenue",
			"status": "processing"                  },         "attribute10qty": 0
"Value10"       }     }   ],   "shipments": [     {}
      "shipmentCode": "UIfd897",       "locationCode": "loc1",   ]
   "generatedInvoiceId": "AR105044395",       "generatedInvoiceDate": "2020-10-16T20:22:28.000+00:00",  }
    "externalInvoiceId        ],
  "isSplitRequired": "FK56556GH45false",
  "shippingCharges": 20,
  "externalInvoiceDatechannelType": "2020-10-16T20:22:28.000+00:00ERP",
  "orderItems": [
   "invoiceDocumentUrl": "https://mybrand.com/invoice123.pdf", {
      "shippingLabelDocumentUrlorderItemCode": "https://mybrand.com/sldoc.pdfitem123",
      "irnchannelSkuCode": "a429746e55b844c9d2cb2a6f68997d1c2af29987cc834f3b52da45d1b0bc97c91000889888",
      "qrCodeorderedQuantity": "eyJhbGciPiJSUzI1NiIsImtpZCI6IkI4RDYzRUNCMThFQTVFNkY0QUKDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGcifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFPQ001MzI2SjFaWVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUJDUjE3MThFMVpMXCIsXCJEb2NOb1wiOlwiTUVhajIyLTIzLzUwNTlcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTMvMTAvMjAyMlwiLFwiVG90SW52VmFsXCI6MTgxNy4wNCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjYyMTE0MjkwXCIsXCJJcm5cIjpcImE0Mjk3NDZlMzRkODQ0YzlkMmNiMmE2ZjY4OTk3ZDFjMmFmMjM5ODdjYzgzNGYzYjUyZGE0NWQxYjBiYzk3YzlcIixcIklybkR0XCI6XCIyMDIyLTEwLTEzIDEyOjAxOjAwXCJ9IiwiaXNzIjoiTklDIn0.wvB7b15AnpdQdX_d0VZEyj9dL1qWDaOFPLRPrlV0V2XIu3cE3aQ3YtsWLnTnyrmtUlokpbkkE4folBQNhfzkCPlnODNxRPfpO-Kz9eyNpqcIEp-8TqvcDKXZ3PrBRqmNmner00AG_fVmmqT1HLiyKB2sqOnhqtCfQaQF-PGnqIOhal3PDxIMVt0WAtaQOIwwDA75dsjjnFHaZFPl9tFPR8A6Wrw4NhQH-7xhABKW3Z961a_rGmO6M3XP7jPHyYPW-QWMfTqwNXwxNdFgFePL5FloPiUipt2-g4FIplgm-YcN1xMvEQ2irAfzQwbnxi7UKz-jwOgM0Zy2BbburYgDvQ"2,
      "shipmentStatuscancelledQuantity": "DELIVERED"1,
      "awbNumbercustomerCancelledQty": "awb1"1,
      "shipmentItemssellerCancelledQty": [0,
      "sellerRejectQty": 0,
   {   "channelDiscount": 50,
      "channelSkuCodesellingPricePerUnit": "100000789702"500,
          "orderItemCodegiftChargePerUnit": "item123"10,
       "sellerDiscount": 5,
      "netTaxAmountPerUnitshippingCharge": 600,
   
      "netTaxAmountTotalomsItemId": 120123,
   
      "baseSellingPricePerUnitbarcode": 500"barcode1",
      "clientSkuCode"   : "baseSellingPriceTotalClientSku1": 1000,
   
      "sellingPricePerUnitorderItemCustomAttributes": 560,{
          "sellingPriceTotalattribute1": 1120"Value1",
          "quantityattribute2": 2"Value2",
          "shippingChargePerUnitattribute3": 36"Value3",
          "channelDiscountattribute4": 30"Value4",
         "attribute5": "taxItemsValue5":,
[        "attribute6": "Value6",
   {     "attribute7": "Value7",
        "typeattribute8": "SGSTValue8",
              "rate"attribute9": 6"Value9",
        "channelMetadata":      "taxPerUnit{
			"totalCashOnDeliveryFee": 30,
              "taxTotal": 60
   0.0,
			"department": "HR",
			"paymentMethod": "ccavenue",
			"status": "processing"
        },
        "attribute10": "Value10"
  {    }
    }
  ],
  "typeshipments": "CGST",[
      {
       "rateshipmentCode": 6"UIfd897",
      "locationCode": "loc1",
      "taxPerUnitgeneratedInvoiceId": 30,
  "AR105044395",
           "taxTotalgeneratedInvoiceDate": 60
   "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",
        "channelSkuCodeqrCode": "100000734701",
  eyJhbGciPiJSUzI1NiIsImtpZCI6IkI4RDYzRUNCMThFQTVFNkY0QUKDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGcifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFPQ001MzI2SjFaWVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUJDUjE3MThFMVpMXCIsXCJEb2NOb1wiOlwiTUVhajIyLTIzLzUwNTlcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTMvMTAvMjAyMlwiLFwiVG90SW52VmFsXCI6MTgxNy4wNCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjYyMTE0MjkwXCIsXCJJcm5cIjpcImE0Mjk3NDZlMzRkODQ0YzlkMmNiMmE2ZjY4OTk3ZDFjMmFmMjM5ODdjYzgzNGYzYjUyZGE0NWQxYjBiYzk3YzlcIixcIklybkR0XCI6XCIyMDIyLTEwLTEzIDEyOjAxOjAwXCJ9IiwiaXNzIjoiTklDIn0.wvB7b15AnpdQdX_d0VZEyj9dL1qWDaOFPLRPrlV0V2XIu3cE3aQ3YtsWLnTnyrmtUlokpbkkE4folBQNhfzkCPlnODNxRPfpO-Kz9eyNpqcIEp-8TqvcDKXZ3PrBRqmNmner00AG_fVmmqT1HLiyKB2sqOnhqtCfQaQF-PGnqIOhal3PDxIMVt0WAtaQOIwwDA75dsjjnFHaZFPl9tFPR8A6Wrw4NhQH-7xhABKW3Z961a_rGmO6M3XP7jPHyYPW-QWMfTqwNXwxNdFgFePL5FloPiUipt2-g4FIplgm-YcN1xMvEQ2irAfzQwbnxi7UKz-jwOgM0Zy2BbburYgDvQ",
       "orderItemCodeshipmentStatus": "item124DELIVERED",
          "netTaxAmountPerUnitawbNumber": 60"awb1",

         "netTaxAmountTotalshipmentItems": 120,[
        {
 "baseSellingPricePerUnit": 500,           "baseSellingPriceTotalchannelSkuCode": 1000"100000789702",
          "sellingPricePerUnitorderItemCode": 560"item123",
          "sellingPriceTotalnetTaxAmountPerUnit": 112060,
          "quantitynetTaxAmountTotal": 2120,
          "shippingChargePerUnitbaseSellingPricePerUnit": 36500,
          "channelDiscountbaseSellingPriceTotal": 301000,
          "taxItemssellingPricePerUnit": [560,
          "sellingPriceTotal":  {
    1120,
          "typequantity": "SGST"2,
 
            "rateshippingChargePerUnit": 636,
              "taxPerUnitchannelDiscount": 30,
          "barcode"   : "taxTotalbarcode1":,
60          "clientSkuCode" :  }"ClientSku1",
          "taxItems": [
{            {
              "type": "CGSTSGST",
              "rate": 6,
              "taxPerUnit": 30,
              "taxTotal": 60
            },
          ]  {
      }       ] "type": "CGST",
  }   ],   "shipmentDetails": {     "lengthrate": 30.06,
    "breadth": 20.0,     "height": 10.0,     "weighttaxPerUnit": 5.030,
    "shipmentId": 12345,     "totalItemQuantity": 50,
    "packboxDetailsListtaxTotal": [60
      {      }
  "length": 15.0,       ]
 "breadth": 10.0,      },
  "height": 8.0,     {
   "weight": 2.0,         "boxIdchannelSkuCode": 1"100000734701",
          "awbNumberorderItemCode": "AWB123item124",
          "packBoxRemarksnetTaxAmountPerUnit": 60,
"Fragile items",         "skuQuantityDataListnetTaxAmountTotal": [120,
          {
"baseSellingPricePerUnit": 500,
           "globalSkuIdbaseSellingPriceTotal": 9871000,
            "clientSkuIdsellingPricePerUnit": "SKU001"560,
            "countsellingPriceTotal": 101120,
          "quantity": }2,
          {
"shippingChargePerUnit": 36,
           "globalSkuIdchannelDiscount": 87630,
            "clientSkuIdbarcode": "SKU002barcode2",
           "clientSkuCode": "countClientSkuCode":,
15          "taxItems": }[
        ]    {
  }      ]   },   "shippingAddresstype": { "SGST",
       "name": "Customer's Name",     "line1rate": "Line6,
Address 1",     "line2": "Line Address 2",     "line3taxPerUnit": 30,
 "Line Address 3",     "city": "city",     "statetaxTotal": 60
"state",     "zip": "zip",     "country": "country", },
     "email": "abc@gmail.com",     "phone": "9999999999" {
  },   "billingAddress": {         "nametype": "customerCGST",
    "line1": "address line 1",          "line2rate": "address6,
line 2",     "line3": "address line 3",     "citytaxPerUnit": "Bengaluru"30,
    "state": "Karnataka",
    "zip": "560076",     "countrytaxTotal": "INDIA",60
    "email": "abc@gmail.com",     "phone": "9999999999"  }
    },   "orderCustomAttributes": {  ]
  "attribute1": "Value1",     "attribute2": "Value2",}
     "attribute3": "Value3", ]
    "attribute4": "Value4",}
  ],
  "attribute5shipmentDetails": "Value5",{
    "attribute6length": "Value6"30.0,
    "attribute7breadth": "Value7"20.0,
    "attribute8height": "Value8"10.0,
    "attribute9weight": "Value9"5.0,
    "attribute10shipmentId": "Value10"12345,
    "channelMetadatatotalItemQuantity": 50,
   { 		"totalCashOnDeliveryFeepackboxDetailsList": 0.0,
		"department": "HR",
		"paymentMethod": "ccavenue",
		"status": "processing"
[
      {
   },     "currencylength": "INR"15.0,
      } }

More Request Samples

{

partnerCode

breadth":

"Increff_FASHION"

10.0,

"partnerLocationCode

      "height":

"2"

8.0,

"locationCode

      "weight":

"FMRW2021",

2.0,
        "

messageId

boxId":

19327

1,

"omsOrderId": 123456,

orderCode

awbNumber": "

16837253779671050215

AWB123",

"parentOrderCode": "NYK-12083161-5367312-1-1",

orderTime

packBoxRemarks": "

2023-04-16T20:22:28.000+00:00", "orderType": "SO", "paymentMethod": "COD",

Fragile items",
        "

isPriority

skuQuantityDataList":

false,

"channelName":

"Increff_FASHION",

"channelType":

"MARKETPLACE",

"orderItems":

[

{

barcode

globalSkuId":

"barcodeOrderItem"

987,

"orderItemCode

      "clientSkuId": "

23187157

SKU001",
            "

omsItemId

count": 10

null,

"channelSkuCode": "8904328664321"

},

"orderedQuantity": 1,

"cancelledQuantity":

0,

channelDiscount

globalSkuId":

1374

876,

"sellerDiscount":

0,

sellingPricePerUnit

clientSkuId":

2499

"SKU002",

"giftChargePerUnit":

0,

shippingCharge

count":

0

}

],

"eventType":

"OUTWARD_ORDER_COMPLETE",

"eventTime":

"2023-04-16T20:22:28.000+00:00",

"shipments":

[

{

 ]
  },
  "

awbNumber

shippingAddress":

null,

deliveredAt

name": "

2020-10-16T20:22:28.000+05:30

Customer's Name",

shipmentCode

line1": "

26719

Line Address 1",

generatedInvoiceId

line2": "

16255

Line Address 2",

generatedInvoiceDate

line3": "

2023-04-16T20:22:28.000+00:00",

Line Address 3",

invoiceDocumentUrl

city": "

https://storage.googleapis.com/some_folder/INVOICE_AND_SHIPPING_LABEL/some_hash.pdf

city",

shippingLabelDocumentUrl

state":

"https://storage.googleapis.com/some_folder/INVOICE_AND_SHIPPING_LABEL/some_hash.pdf",

"state",

externalInvoiceId

zip": "

26719

zip",

externalInvoiceDate

country":

null

"country",

irn

email": "abc@gmail.com",

packageSku

phone": "

packageSKU1

9999999999"

,

},

qrCode

billingAddress":

"",

shipmentStatus

name": "

DISPATCHED

customer",

shipmentItems

line1":

[

"address line 1",
    "line2": "address

{

line 2",
    "line3": "address line 3",
    "

barcode

city": "

BarcodeShipmentItem

Bengaluru",
    "state": "Karnataka",
    "

channelSkuCode

zip": "

8904328664321

560076",
    "country": "INDIA",
    "

orderItemCode

email": "

23187157

abc@gmail.com",
    "phone": "9999999999"
  },
  "

channelDiscount

orderCustomAttributes":

1374,

{
    "attribute1": "Value1",
    "

netTaxAmountPerUnit

attribute2":

120.54

"Value2",

"attribute3": "Value3",
    "

netTaxAmountTotal

attribute4":

120.54

"Value4",
    "attribute5": "Value5",
    "

baseSellingPricePerUnit

attribute6":

2378.46

"Value6",
    "attribute7": "Value7",
    "

baseSellingPriceTotal

attribute8":

2378.46

"Value8",

"sellingPricePerUnit

"attribute9":

2499,

"Value9",

sellingPriceTotal

attribute10":

2499

"Value10",
    "channelMetadata":

"quantity

{
		"totalCashOnDeliveryFee":

1

0.0,
		"department":

"shippingChargePerUnit

"HR",
		"paymentMethod":

0, "taxItems

"ccavenue",
		"status":

[

"processing"

{

},

type

currency": "

IGST

INR"

,

"rate": 5.067985166872682, "taxPerUnit": 120.54, "taxTotal": 120.54 } ] } ], "locationCode": "FMRW2021", "transporter": "transporter" } ], "shippingAddress": { "name": "Customer's Name", "line1": "Line Address 1", "line2": "Line Address 2", "line3": "Line Address 3", "city": "city", "state": "state", "zip": "560076", "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" }, "virtualSkuDefinitions": [], "isSplitRequired": false, "shippingCharges": null, "turnAroundTime": "2020-10-18T20:22:28.000+05:30" }

Expand

title	OUTWARD_ORDER_COMPLETE

Code Block

language	json

Expand

title	OUTWARD_ORDER_CREATE

Code Block

{
  "partnerCode": "Increff_FASHION",
  "partnerLocationCode": "2",
  "locationCode": "FMRW2021",
  "messageId": 19327,
  "omsOrderId": 123456,
  "orderCode": "16837253779671050215",
  "parentOrderCode": "NYK-12083161-5367312-1-1",
  "orderTime": "2023-04-16T20:22:28.000+00:00",
  "orderType": "SO",
  "paymentMethod": "COD",
  "isPriority": false,
  "channelName": "Increff_FASHION",
  "channelType": "MARKETPLACE",
  "orderItems": [
    {
      "barcode": "barcodeOrderItem",
      "orderItemCode": "23187157",
      "omsItemId": null,
      "channelSkuCode": "8904328664321",
      "orderedQuantity": 1,
      "cancelledQuantity": 0,
      "channelDiscount": 1374,
      "sellerDiscount": 0,
      "sellingPricePerUnit": 2499,
      "giftChargePerUnit": 0,
      "shippingCharge": 0
    }
  ],
  "eventType": "OUTWARD_ORDER_CREATE",
  "eventTime": "2023-04-16T20:22:28.000+00:00",
  "shipments": [
    {
      "awbNumber": null,
      "deliveredAt": "2020-10-16T20:22:28.000+05:30",
      "shipmentCode": "26719",
      "generatedInvoiceId": "16255",
      "generatedInvoiceDate": "2023-04-16T20:22:28.000+00:00",
      "invoiceDocumentUrl": "https://storage.googleapis.com/some_folder/INVOICE_AND_SHIPPING_LABEL/some_hash.pdf",
      "shippingLabelDocumentUrl": "https://storage.googleapis.com/some_folder/INVOICE_AND_SHIPPING_LABEL/some_hash.pdf",
      "externalInvoiceId": "26719",
      "externalInvoiceDate": null,
      "irn": "",
      "packageSku": "packageSKU1",
      "qrCode": "",
      "shipmentStatus": "DISPATCHED",
      "shipmentItems": [
        {
          "barcode": "BarcodeShipmentItem",
          "channelSkuCode": "8904328664321",
          "orderItemCode": "23187157",
          "channelDiscount": 1374,
          "netTaxAmountPerUnit": 120.54,
          "netTaxAmountTotal": 120.54,
          "baseSellingPricePerUnit": 2378.46,
          "baseSellingPriceTotal": 2378.46,
          "sellingPricePerUnit": 2499,
          "sellingPriceTotal": 2499,
          "quantity": 1,
          "shippingChargePerUnit": 0,
          "taxItems": [
            {
              "type": "IGST",
              "rate": 5.067985166872682,
              "taxPerUnit": 120.54,
              "taxTotal": 120.54
            }
          ]
        }
      ],
      "locationCode": "FMRW2021",
      "transporter": "transporter"    }
  ],
  "shippingAddress": {
    "name": "Customer's Name",
    "line1": "Line Address 1",
    "line2": "Line Address 2",
    "line3": "Line Address 3",
    "city": "city",
    "state": "state",
    "zip": "560076",
    "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"
  },
  "virtualSkuDefinitions": [],
  "isSplitRequired": false,
  "shippingCharges": null,
  "turnAroundTime": "2020-10-18T20:22:28.000+05:30"
}

...

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

...

yes

...

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

...

omsOrderId

...

Long

...

Internal order id of OMS

...

no

...

turnAroundTime

...

ZonedDateTime

...

Turnaround time

...

}
}

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	Yes
`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	No
`bundledSkuDefinitions`	Object[]	List of bundled sku definitions	No
`bundledSkuDefinitions.bundledParentBarcode`	String	Unique barcode of bundled Sku	No
`bundledSkuDefinitions.bundledParentChannelSkuId`	String	Unique identifier of bundled Sku at channel	Yes
`bundledSkuDefinitions.bundledParentClientSkuCode`	String	Unique identifier for bundled parent sku code at client’s end	no
`bundledSkuDefinitions.childSkus`	Object[]	List of child SKUs	Yes
`childSkus.barcode`	String	Unique barcode of child sku	No
`childSkus.clientSkuCode`	String	Unique identifier for a child sku at client’s end.	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

yes

Yes
`orderItems.orderItemCode`	String	This is provided by the channel to uniquely identify each order item.

yes

Yes
`orderItems.channelskuCode`	String	SKU code of order item

yes

Yes
`orderItems.orderedQuantity`	int	Ordered Quantity

yes

Yes
`orderItems.cancelledQuantity`	int	cancelledQuantity

yes

Yes
`orderItems.sellingPricePerUnit`	double	sellingPricePerUnit

yes

	Yes
`orderItems.customerCancelledQty`	Integer	Customer cancelled quantity	No
`orderItems.sellerCancelledQty`	Integer	Seller cancelled quantity	No
`orderItems.giftChargePerUnit`	Double	giftChargePerUnit

no

No
`orderItems.channelDiscount`	Double	Discount provided by channel per unit

no

No
`orderItems.sellerDiscount`	Double	Discount provided by seller per unit

no

No
`orderItems.omsItemId`	Long	Internal item id of OMS

no

No
`orderItems.barcode`	String	Barcode to identify a

productyes

product	no
`orderItems.clientSkuCode`	String	Code to uniquely identify an sku at client’s end	no
`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

no

No
`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

no

No
`shipments.omsShipmentId`	Integer	increff OMS shipment id	NO
`shipments.shipmentStatus`	String	Status of the shipment

no

No
`shipments.awbNumber`	String	AWB number of shipment

no

No
`shipments.shipmentItems`	Object[]	Items belonging to this shipment

yes

Yes
`shipmentItems.channelSkuCode`	String	SKU code of order item

yes

Yes

shipmentItems.

locationCode

String

Fulfillment Location

yes

shipmentItems.

orderItemCode

String

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

yes

Yes
`shipmentItems.netTaxAmountPerUnit`	Double	Per unit tax applicable for the SKU.

yes

Yes
`shipmentItems.netTaxAmountTotal`	Double	Total tax applicable for the SKU

yes

Yes
`shipmentItems.baseSellingPricePerUnit`	Double	Per unit base selling price of the SKU

yes

Yes
`shipmentItems.baseSellingPriceTotal`	Double	Total base selling price of SKU

yes

Yes
`shipmentItems.sellingPricePerUnit`	Double	Per unit selling price of the SKU including tax

yes

Yes
`shipmentItems.sellingPriceTotal`	Double	Total selling price of the SKU

yes

Yes
`shipmentItems.quantity`	Integer	Quantity of the sku in the shipment item.

yes

Yes
`shipmentItems.shippingChargePerUnit`	Double	Shipping

charge per unit for a shipment item

charge per unit for a shipment item	No
`shipmentItems.channelDiscount`	Double	Channel discount of item	No
`shipmentItems.barcode`	String	Scannable code to uniquely identify an sku	no
`shipmentItems.`

channelDiscountChannel discount of item

clientSkuCode

Double

String	Unique identifier for an sku at client’s end	no
`shipmentItems.taxItems`	Object	Distribution of tax with tax type

yes

Yes
`shipments.shipmentDetails`	Object	Shipment details

no

No
`shipmentDetails.length`	Double	Length of the shipment

no

No
`shipmentDetails.breadth`	Double	Breadth of the shipment

no

No
`shipmentDetails.height`	Double	Height of the shipment

no

No
`shipmentDetails.weight`	Double	Weight of the shipment

no

No
`shipmentDetails.shipmentId`	Long	Id to uniquely identify a shipment

no

No
`shipmentDetails.totalItemQuantity`	Integer	Count of all the items in the shipment

no

No
`shipmentDetails.packboxDetailsList`	Object[]	Details of pack boxes

no

No
`packboxDetailsList.length`	Double	Length of the pack box in consideration

no

No
`packboxDetailsList.breadth`	Double	Breadth of the pack box in consideration

no

No
`packboxDetailsList.height`	Double	Height of the pack box in consideration

no

No
`packboxDetailsList.weight`	Double	Weight of the pack box in consideration

no

No
`packboxDetailsList.boxId`	Long	Id to uniquely identify a box

no

No
`packboxDetailsList.awbNumber`	String	AWB number of the box

no

No
`packboxDetailsList.packBoxRemarks`	String	Remarks for the pack box

no

No
`packboxDetailsList.skuQuantityDataList`	Object[]	Details of skus in a box

no

No
`skuQuantityDataList.globalSkuId`	Long	Id to uniquely identify a sku in increff’s system

no

No
`skuQuantityDataList.clientSkuId`	String	Id to uniquely identify a sku on client’s end

no

No
`skuQuantityDataList.count`	Integer	Count of a particular sku in a box

no

No
`irn`	String	Irn generated on Govt. portal while e-invoicing

no

No
`qrCode`	String	QrCode generated on Govt. portal while e-invoicing

no

No
`shipmentStatus`	String	Possible values: {OPEN,CLOSED, INVOICED, MANIFESTED, DISPATCHED, CANCELLED, DELIVERED}

no

No
`taxItems.type`	String	Type of tax applicable

yes

Yes
`taxItems.rate`	Double	Tax rate for this tax type

yes

Yes
`taxItems.taxPerUnit`	Double	Tax applicable for this type of tax per unit

yes

Yes
`taxItems.taxTotal`	Double	Total tax applicable for this type of tax

yes

Yes
`shippingAddress`	Object	Shipping address of the customer

yes

Yes
`shippingAddress.name`	String	Name of customer

yes

Yes
`shippingAddress.line1`	String	1st line of customer’s address

yes

Yes
`shippingAddress.line2`	String	2nd line of customer’s address

no

No
`shippingAddress.line3`	String	3rd line of customer’s address

no

No
`shippingAddress.city`	String	City of customer

yes

Yes
`shippingAddress.state`	String	State of customer

yes

Yes
`shippingAddress.zip`	String	ZIP/Pin code of customer

yes

Yes
`shippingAddress.country`	String	Country of customer

yes

Yes
`shippingAddress.email`	String	Email of customer

no

No
`shippingAddress.phone`	String	Phone Number of customer

no

No
`billingAddress`	Object	Billing address of the customer

yes

Yes
`billingAddress.name`	String	Name of customer

yes

Yes
`billingAddress.line1`	String	1st line of customer’s address

yes

Yes
`billingAddress.line2`	String	2nd line of customer’s address

no

No
`billingAddress.line3`	String	3rd line of customer’s address

no

No
`billingAddress.city`	String	City of customer

yes

Yes
`billingAddress.state`	String	State of customer

yes

Yes
`billingAddress.zip`	String	ZIP/Pin code of customer

yes

Yes
`billingAddress.country`	String	Country of customer

yes

Yes
`billingAddress.email`	String	Email of customer

no

No
`billingAddress.phone`	String	Phone Number of customer

no

Response

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

...

No

Versions Compared

Old Version 9

New Version Current

Key

Outbound | POST | {Client’s URL}

Description

Description

Request

Response