Page Comparison

Sales Order Posting

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

...

OUTWARD_ORDER_CREATE,

...

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_COMPLETE ,CANCEL
OUTWARD_ORDER_PARTIAL_CANCEL

Superset of Request Body

...

OUTWARD_ORDER_COMPLETE
OUTWARD_ORDER_SHIPMENT_DISPATCH
OUTWARD_ORDER_SHIPMENT_DELIVER

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",
      "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     }   ],   "shipments": [     {
      "shipmentCode": "UIfd897",         "locationCode":"loc1",             "generatedInvoiceIdbarcode": "AR105044395string",
            "generatedInvoiceDate": "2020-10-16T20:22:28.000+00:00",       "externalInvoiceId": "FK56556GH45",       "externalInvoiceDatechannelSkuCode": "2020-10-16T20:22:28.000+00:00string",
      "invoiceDocumentUrl": "https://mybrand.com/invoice123.pdf",       "shippingLabelDocumentUrl": "https://mybrand.com/sldoc.pdf",       "irn": "a429746e55b844c9d2cb2a6f68997d1c2af29987cc834f3b52da45d1b0bc97c9",       "qrCodeqty": "eyJhbGciPiJSUzI1NiIsImtpZCI6IkI4RDYzRUNCMThFQTVFNkY0QUKDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGcifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFPQ001MzI2SjFaWVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUJDUjE3MThFMVpMXCIsXCJEb2NOb1wiOlwiTUVhajIyLTIzLzUwNTlcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTMvMTAvMjAyMlwiLFwiVG90SW52VmFsXCI6MTgxNy4wNCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjYyMTE0MjkwXCIsXCJJcm5cIjpcImE0Mjk3NDZlMzRkODQ0YzlkMmNiMmE2ZjY4OTk3ZDFjMmFmMjM5ODdjYzgzNGYzYjUyZGE0NWQxYjBiYzk3YzlcIixcIklybkR0XCI6XCIyMDIyLTEwLTEzIDEyOjAxOjAwXCJ9IiwiaXNzIjoiTklDIn0.wvB7b15AnpdQdX_d0VZEyj9dL1qWDaOFPLRPrlV0V2XIu3cE3aQ3YtsWLnTnyrmtUlokpbkkE4folBQNhfzkCPlnODNxRPfpO-Kz9eyNpqcIEp-8TqvcDKXZ3PrBRqmNmner00AG_fVmmqT1HLiyKB2sqOnhqtCfQaQF-PGnqIOhal3PDxIMVt0WAtaQOIwwDA75dsjjnFHaZFPl9tFPR8A6Wrw4NhQH-7xhABKW3Z961a_rGmO6M3XP7jPHyYPW-QWMfTqwNXwxNdFgFePL5FloPiUipt2-g4FIplgm-YcN1xMvEQ2irAfzQwbnxi7UKz-jwOgM0Zy2BbburYgDvQ",0
       "shipmentStatus":"DELIVERED",          "shipmentItems": [      }
  {           "channelSkuCode": "100000789702",    ]
      "orderItemCode": "item123",       }
   "netTaxAmountPerUnit": 60,        ],
  "netTaxAmountTotalisSplitRequired": 120"false",
  "shippingCharges": 20,
  "channelType": "ERP",
  "baseSellingPricePerUnitorderItems": 500,[
    {
      "baseSellingPriceTotalorderItemCode": 1000,
   "item123",
      "sellingPricePerUnitchannelSkuCode": 560"1000889888",
          "sellingPriceTotalorderedQuantity": 11202,

         "quantitycancelledQuantity": 21,
          "shippingChargePerUnitcustomerCancelledQty": 361,
   
      "channelDiscountsellerCancelledQty": 300,

         "taxItemssellerRejectQty": [0,
      "channelDiscount": 50,
    {  "sellingPricePerUnit": 500,
           "typegiftChargePerUnit": "SGST"10,
      "sellerDiscount": 5,
      "rateshippingCharge": 60,
      "omsItemId": 123,
      "taxPerUnitbarcode": 30"barcode1",
      "orderItemCustomAttributes": {
        "taxTotalattribute1": 60"Value1",
        "attribute2": "Value2",
  },      "attribute3": "Value3",
     {   "attribute4": "Value4",
          "typeattribute5": "CGSTValue5",
              "rate": 6"attribute6": "Value6",
              "taxPerUnit"attribute7": 30,
   "Value7",
          "taxTotalattribute8": 60"Value8",
        "attribute9": "Value9",
  }      "channelMetadata": {
			"totalCashOnDeliveryFee": 0.0,
 ]
        },
 			"department": "HR",
			"paymentMethod": "ccavenue",
			"status": "processing"
      {  },
        "channelSkuCodeattribute10": "100000734701Value10",
      }
   "orderItemCode": "item124", }
   ],
      "netTaxAmountPerUnitshipments": 60,[
    {
      "netTaxAmountTotalshipmentCode": 120"UIfd897",
 
        "baseSellingPricePerUnitlocationCode": 500"loc1",
          "baseSellingPriceTotal": 1000"generatedInvoiceId": "AR105044395",
          "sellingPricePerUnitgeneratedInvoiceDate": 560"2020-10-16T20:22:28.000+00:00",
          "sellingPriceTotalexternalInvoiceId": 1120,
  "FK56556GH45",
       "quantityexternalInvoiceDate": 2"2020-10-16T20:22:28.000+00:00",
          "shippingChargePerUnitinvoiceDocumentUrl": 36,"https://mybrand.com/invoice123.pdf",
          "channelDiscountshippingLabelDocumentUrl": 30"https://mybrand.com/sldoc.pdf",
          "taxItemsirn": ["a429746e55b844c9d2cb2a6f68997d1c2af29987cc834f3b52da45d1b0bc97c9",
      "qrCode": "eyJhbGciPiJSUzI1NiIsImtpZCI6IkI4RDYzRUNCMThFQTVFNkY0QUKDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGcifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFPQ001MzI2SjFaWVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUJDUjE3MThFMVpMXCIsXCJEb2NOb1wiOlwiTUVhajIyLTIzLzUwNTlcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTMvMTAvMjAyMlwiLFwiVG90SW52VmFsXCI6MTgxNy4wNCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjYyMTE0MjkwXCIsXCJJcm5cIjpcImE0Mjk3NDZlMzRkODQ0YzlkMmNiMmE2ZjY4OTk3ZDFjMmFmMjM5ODdjYzgzNGYzYjUyZGE0NWQxYjBiYzk3YzlcIixcIklybkR0XCI6XCIyMDIyLTEwLTEzIDEyOjAxOjAwXCJ9IiwiaXNzIjoiTklDIn0.wvB7b15AnpdQdX_d0VZEyj9dL1qWDaOFPLRPrlV0V2XIu3cE3aQ3YtsWLnTnyrmtUlokpbkkE4folBQNhfzkCPlnODNxRPfpO-Kz9eyNpqcIEp-8TqvcDKXZ3PrBRqmNmner00AG_fVmmqT1HLiyKB2sqOnhqtCfQaQF-PGnqIOhal3PDxIMVt0WAtaQOIwwDA75dsjjnFHaZFPl9tFPR8A6Wrw4NhQH-7xhABKW3Z961a_rGmO6M3XP7jPHyYPW-QWMfTqwNXwxNdFgFePL5FloPiUipt2-g4FIplgm-YcN1xMvEQ2irAfzQwbnxi7UKz-jwOgM0Zy2BbburYgDvQ",
    {  "shipmentStatus": "DELIVERED",
           "typeawbNumber": "SGSTawb1",
      "shipmentItems": [
      "rate": 6, {
             "taxPerUnitchannelSkuCode": 30,
   "100000789702",
          "taxTotalorderItemCode": 60"item123",
            }"netTaxAmountPerUnit": 60,
          "netTaxAmountTotal": 120,
{               "typebaseSellingPricePerUnit": "CGST"500,
          "baseSellingPriceTotal": 1000,
   "rate       "sellingPricePerUnit": 6560,
          "sellingPriceTotal": 1120,
          "taxPerUnitquantity": 302,
   
          "taxTotalshippingChargePerUnit": 6036,
          "channelDiscount": 30,
}          "taxItems": [
]         }   {
   ]     }   ],   "shippingAddresstype": {"SGST",
    "name": "Customer's Name",          "line1rate": "Line6,
Address 1",     "line2": "Line Address 2",     "line3taxPerUnit": "Line Address 3",30,
        "city": "city",     "statetaxTotal": "state",60
     "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",         "ziptaxTotal": "560076",60
    "country": "INDIA",     "email": "abc@gmail.com", }
   "phone": "9999999999"   } }

More request samples

{

"partnerCode":

"Increff_FASHION",

"partnerLocationCode": "2",

    },
        {
          "

locationCode

channelSkuCode": "

FMRW2021

100000734701",

"messageId": 19327,

orderCode

orderItemCode": "

16837253779671050215

item124",

"parentOrderCode

       "netTaxAmountPerUnit":

"NYK-12083161-5367312-1-1"

60,

"orderTime

        "netTaxAmountTotal":

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

120,

"orderType":

"SO",

"paymentMethod":

"COD",

isPriority

baseSellingPricePerUnit":

false

500,

"channelName":

"Increff_FASHION",

"channelType":

"MARKETPLACE",

orderItems

baseSellingPriceTotal":

[

1000,

{

orderItemCode

sellingPricePerUnit":

"23187157"

560,
          "

channelSkuCode

sellingPriceTotal":

"8904328664321",

1120,
          "

orderedQuantity

quantity":

1

2,
          "

cancelledQuantity

shippingChargePerUnit":

0

36,
          "channelDiscount":

1374

30,
          "

sellerDiscount

taxItems":

0,

"sellingPricePerUnit": 2499,

"giftChargePerUnit":

0,

shippingCharge

type":

0

 "SGST",

}

],

eventType

rate":

"OUTWARD_ORDER_COMPLETE"

6,

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

"shipments":

[

{

shipmentCode

taxPerUnit":

"26719"

30,

"generatedInvoiceId":

"16255",

generatedInvoiceDate

taxTotal":

"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

   "type":

null

"CGST",

"irn":

"",

qrCode

rate":

""

6,

"shipmentStatus":

"DISPATCHED",

shipmentItems

taxPerUnit":

[

30,

{

channelSkuCode

taxTotal": 60

"8904328664321",

"orderItemCode": "23187157",

"channelDiscount": 1374,

]
        }

"netTaxAmountPerUnit":

120.54,

   ]
    }
  ],
  "

netTaxAmountTotal

shipmentDetails":

120.54,

{
    "length": 30.0,
    "

baseSellingPricePerUnit

breadth":

2378

20.

46

0,
    "height": 10.0,
    "

baseSellingPriceTotal

weight":

2378

5.

46

0,
    "shipmentId": 12345,
    "

sellingPricePerUnit

totalItemQuantity":

2499

50,
    "packboxDetailsList":

"sellingPriceTotal":

2499,

  {
        "

quantity

length":

1

15.0,

shippingChargePerUnit

breadth": 10.0,

"taxItems

"height":

[

8.0,
        "weight": 2.0,

{

     "boxId": 1,
        "

type

awbNumber": "

IGST

AWB123",

"rate

"packBoxRemarks":

5.067985166872682

"Fragile items",

"taxPerUnit

"skuQuantityDataList":

120.54,

[
          {

"taxTotal":

120.54

"globalSkuId": 987,

}

]

"clientSkuId": "SKU001",

}

    "count": 10

],

"locationCode":

"FMRW2021"

},

}

],

"shippingAddress":

"name": "Customer's Name",

line1

globalSkuId":

"Line Address 1"

876,

"line2":

"Line

Address

2",

line3

clientSkuId": "

Line Address 3

SKU002",

"city": "city",

state

count":

"state",

15
          }

"zip":

"560076",

"country": "country",

"email":

"abc@gmail.com",

"phone": "9999999999"

 ]
  },
  "

billingAddress

shippingAddress": {
    "name": "

customer

Customer's Name",
    "line1": "

address

Line

line

Address 1",
    "line2": "

address

Line

line

Address 2",
    "line3": "

address

Line

line

Address 3",
    "city": "

Bengaluru

city",
    "state": "

Karnataka

state",
    "zip": "

560076

zip",
    "country": "

INDIA

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

virtualSkuDefinitions

billingAddress":

[],

{
    "

isSplitRequired

name":

false,

shippingCharges

customer"

:

null

}{

partnerCode

line1": "

MYNTRAV4

address line 1",
    "

partnerLocationCode

line2": "

206

address line 2",
    "

locationCode

line3": "

1100151058",

address line

"messageId": 5025311,

3",
    "

orderCode

city": "

149f61d9-29a3-4ea45e-8f19-199723116098

Bengaluru",
    "

parentOrderCode

state": "

149f61d9-29a3-4ea45e-8f19-199723116098

Karnataka",
    "

orderTime

zip": "

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

560076",
    "

orderType

country": "

SO

INDIA",
    "

paymentMethod

email": "

COD

abc@gmail.com",
    "

isPriority

phone":

false

"9999999999"
  },
  "

channelName

orderCustomAttributes":

"MYNTRAV4",

{
    "

channelType

attribute1": "

MARKETPLACE

Value1",
    "

orderItems

attribute2":

[

"Value2",

{

"attribute3": "Value3",
    "

orderItemCode

attribute4": "

9376627566

Value4",

channelSkuCode

attribute5": "

SG0453

Value5",

orderedQuantity

attribute6":

1

"Value6",

cancelledQuantity

attribute7":

0

"Value7",

channelDiscount

attribute8":

null

"Value8",

sellerDiscount

attribute9":

374

"Value9",

sellingPricePerUnit

attribute10":

1121

"Value10",
    "channelMetadata": {
		"

giftChargePerUnit

totalCashOnDeliveryFee": 0.0,
		"department": "HR",
		"paymentMethod":

"shippingCharge

"ccavenue",
		"status":

null

"processing"
    },

],

eventType

currency": "

OUTWARD_ORDER_CREATE

INR"

,

"eventTime": "2023-04-16T20:22:28.000+00:00", "shipments": [], "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 }

Expand

title	OUTWARD_ORDER_COMPLETE

Code Block

language	json

Expand

title	OUTWARD_ORDER_CREATE

Code Block

language	json

...

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 Assure

...

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

...

orderItems

...

Object[]

...

List of order items

...

yes

...

orderItems.orderItemCode

...

String

...

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

...

yes

...

orderItems.channelskuCode

...

String

...

SKU code of order item

...

yes

...

orderItems.orderedQuantity

...

int

...

Ordered Quantity

...

yes

...

orderItems.cancelledQuantity

...

int

...

cancelledQuantity

...

yes

...

orderItems.sellingPricePerUnit

...

double

...

sellingPricePerUnit

...

yes

...

orderItems.giftChargePerUnit

...

Double

...

giftChargePerUnit

...

no

...

orderItems.channelDiscount

...

Double

...

Discount provided by channel per unit

...

no

...

orderItems.sellerDiscount

...

Double

...

Discount provided by seller per unit

...

no

...

eventType

...

String

...

Possible values : { OUTWARD_ORDER_CREATE,

OUTWARD_ORDER_CANCEL, OUTWARD_ORDER_COMPLETE ,

OUTWARD_ORDER_PARTIAL_CANCEL}

...

yes

...

eventTime

...

String

...

Time of event creation

...

yes

...

virtualSkuDefinitions

...

Object [ ]

...

List of virtual SKU definitions

...

no

...

virtualSkuDefinitions.virtualParentChannelSkuId

...

String

...

SKU code of virtual SKU

...

no

...

virtualSkuDefinitions.virtualParentBarcode

...

String

...

Barcode of parent SKU

...

no

...

virtualSkuDefinitions.childSkus

...

Object [ ]

...

List of child SKUs

...

no

...

childSkus.channelSkuCode

...

String

...

SKU code of child SKU

...

no

...

childSkus.qty

...

Integer

...

Quantity of child SKU

...

no

...

childSkus.barcode

...

String

...

Barcode of child SKU

...

no

...

isSplitRequired

...

Boolean

...

Flag to identify wether WMS had to split the order

...

yes

...

channelType

...

String

...

Enum with possible values:ERP,MARKETPLACE

...

no

...

shippingCharges

...

Double

...

Shipping charges

...

no

...

shipments

...

Object[]

...

List of shipments

...

yes

...

shipments.shipmentCode

...

String

...

Shipment code

...

yes

...

shipments.locationCode

...

String

...

Warehouse location from which shipment was fulfilled

...

no

...

shipments.generatedInvoiceId

...

String

...

Invoice id for the shipment

...

no

...

shipments.generatedInvoiceDate

...

String

...

Invoice date in the sample format mentioned

...

no

...

shipments.externalInvoiceId

...

String

...

External invoice id

...

no

...

shipments.externalInvoiceDate

...

String

...

External invoice date

...

no

...

shipments.invoiceDocumentUrl

...

String

...

Url of the invoice document

...

no

...

shipments.shippingLabelDocumentUrl

...

String

...

Url of the shipping label document

...

no

...

shipments.irn

...

String

...

IRN code

...

no

...

shipments.qrCode

...

String

...

QR code

...

no

...

shipments.shipmentStatus

...

String

...

Status of the shipment

...

no

...

shipments.shipmentItems

...

Object[]

...

Items belonging to this shipment

...

yes

...

shipmentItems.channelSkuCode

...

String

...

SKU code of order item

...

yes

...

shipmentItems.locationCode

...

String

...

Fulfillment Location

...

yes

...

shipmentItems.orderItemCode

...

String

...

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

...

yes

...

shipmentItems.netTaxAmountPerUnit

...

Double

...

Per unit tax applicable for the SKU.

...

yes

...

shipmentItems.netTaxAmountTotal

...

Double

...

Total tax applicable for the SKU

...

yes

...

shipmentItems.baseSellingPricePerUnit

...

Double

...

Per unit base selling price of the SKU

...

yes

...

shipmentItems.baseSellingPriceTotal

...

Double

...

Total base selling price of SKU

...

yes

...

shipmentItems.sellingPricePerUnit

...

Double

...

Per unit selling price of the SKU including tax

...

yes

...

shipmentItems.sellingPriceTotal

...

Double

...

Total selling price of the SKU

...

yes

...

shipmentItems.quantity

...

Integer

...

Quantity of the sku in the shipment item.

...

yes

...

shipmentItems.shippingChargePerUnit

...

Double

...

Shipping charge per unit for a shipment item

...

no

...

shipmentItems.channelDiscount

...

Double

...

Channel discount of item

...

no

...

shipmentItems.taxItems

...

Object

...

Distribution of tax with tax type

...

}
}

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.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	Yes
`orderItems.orderItemCode`	String	This is provided by the channel to uniquely identify each order item.	Yes
`orderItems.channelskuCode`	String	SKU code of order item	Yes
`orderItems.orderedQuantity`	int	Ordered Quantity	Yes
`orderItems.cancelledQuantity`	int	cancelledQuantity	Yes
`orderItems.sellingPricePerUnit`	double	sellingPricePerUnit	Yes
`orderItems.customerCancelledQty`	Integer	Customer cancelled quantity	No
`orderItems.sellerCancelledQty`	Integer	Seller cancelled quantity	No
`orderItems.giftChargePerUnit`	Double	giftChargePerUnit	No
`orderItems.channelDiscount`	Double	Discount provided by channel per unit	No
`orderItems.sellerDiscount`	Double	Discount provided by seller per unit	No
`orderItems.omsItemId`	Long	Internal item id of OMS	No
`orderItems.barcode`	String	Barcode to identify a product	Yes
`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
`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
`shipments.omsShipmentId`	Integer	increff OMS shipment id	NO
`shipments.shipmentStatus`	String	Status of the shipment	No
`shipments.awbNumber`	String	AWB number of shipment	No
`shipments.shipmentItems`	Object[]	Items belonging to this shipment	Yes
`shipmentItems.channelSkuCode`	String	SKU code of order item	Yes
`shipmentItems.locationCode`	String	Fulfillment Location	Yes
`shipmentItems.orderItemCode`	String	This is provided by the channel to uniquely identify each order item.	Yes
`shipmentItems.netTaxAmountPerUnit`	Double	Per unit tax applicable for the SKU.	Yes
`shipmentItems.netTaxAmountTotal`	Double	Total tax applicable for the SKU	Yes
`shipmentItems.baseSellingPricePerUnit`	Double	Per unit base selling price of the SKU	Yes
`shipmentItems.baseSellingPriceTotal`	Double	Total base selling price of SKU	Yes
`shipmentItems.sellingPricePerUnit`	Double	Per unit selling price of the SKU including tax	Yes
`shipmentItems.sellingPriceTotal`	Double	Total selling price of the SKU	Yes
`shipmentItems.quantity`	Integer	Quantity of the sku in the shipment item.	Yes
`shipmentItems.shippingChargePerUnit`	Double	Shipping charge per unit for a shipment item	No
`shipmentItems.channelDiscount`	Double	Channel discount of item	No
`shipmentItems.taxItems`	Object	Distribution of tax with tax type	Yes
`shipments.shipmentDetails`	Object	Shipment details	No
`shipmentDetails.length`	Double	Length of the shipment	No
`shipmentDetails.breadth`	Double	Breadth of the shipment	No
`shipmentDetails.height`	Double	Height of the shipment	No
`shipmentDetails.weight`	Double	Weight of the shipment	No
`shipmentDetails.shipmentId`	Long	Id to uniquely identify a shipment	No
`shipmentDetails.totalItemQuantity`	Integer	Count of all the items in the shipment	No
`shipmentDetails.packboxDetailsList`	Object[]	Details of pack boxes	No
`packboxDetailsList.length`	Double	Length of the pack box in consideration	No
`packboxDetailsList.breadth`	Double	Breadth of the pack box in consideration	No
`packboxDetailsList.height`	Double	Height of the pack box in consideration	No
`packboxDetailsList.weight`	Double	Weight of the pack box in consideration	No
`packboxDetailsList.boxId`	Long	Id to uniquely identify a box	No
`packboxDetailsList.awbNumber`	String	AWB number of the box	No
`packboxDetailsList.packBoxRemarks`	String	Remarks for the pack box	No
`packboxDetailsList.skuQuantityDataList`	Object[]	Details of skus in a box	No
`skuQuantityDataList.globalSkuId`	Long	Id to uniquely identify a sku in increff’s system	No
`skuQuantityDataList.clientSkuId`	String	Id to uniquely identify a sku on client’s end	No
`skuQuantityDataList.count`	Integer	Count of a particular sku in a box	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

language	json

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

...

No

Versions Compared

Old Version 11

New Version Current

Key

Sales Order Posting

Outbound | POST | {Client’s URL}

Description

Description

Superset of Request Body

Request

More request samples

Response