Page Comparison

Outbound | POST | {Client’s URL}

Summary

This API will call notify the pos POS system with sales Sales order details after the order completion in Increff system.

Description

This API will call the pos POS system with the details of sales orders which are completed in OmniIncreff system. This will be triggered at a certain frequency from Omni Increff system to the channelsPOS system.

Postings can be sent on below triggers

OUTWARD_ORDERSUBORDER_CREATEOUTWARD
SUBORDER_ORDER_CANCELOUTWARD
SUBORDER_ORDER_COMPLETE
OUTWARDSUBORDER_ORDER_PARTIAL_CANCEL

Request

Code Block

language	json

{
  "locationCodebillingAddress": "IN132", {
    "messageIdcity": 12345"Bangalore",
    "orderCodecountry": "flipkart1234IN",
    "parentOrderCodeemail": "flipkart1221ad******@gmail.com",
    "orderTimeline1": "2020-10-16T20:22:28.000+00:00",Shanti Nagar Kent",
    "orderTypeline2": "SO/STO/RTVSouth vihar colony",
    "paymentMethodline3": "CODstring",
    "isPriorityname": "Abhinav falseSingh",
    "channelNamephone": "flipkart98******78",
    "channelTypestate": "ERP/MARKETPLACEKARNATAKA",
    "eventTypezip": "OUTWARD_ORDER_COMPLETE"560102"
  },
  "eventTimechannelName": "2020-10-16T20:22:28.000+00:00NYKAA",
  "shippingChargeschannelType": 20"ERP",
  "virtualSkuDefinitionscreatedAt": ["23-08-2023T12:07:18",
  "credentials":  {},
  "eventTime": "23-08-2023T12:09:18",
  "virtualParentChannelSkuIdeventType": "abc1SUBORDER_CANCEL",
  "isPriority": true,
  "virtualParentBarcodelocationCode": "barcode11120004561",
  "messageId": 786651,
  "childSkusomsSubOrderId": [128876,
  "orderCode": "NYK-128839-1992",
  "orderTime":  {
  "23-08-2023T12:06:18",
  "orderType": "SALES",
  "parentOrderCode": "NYK-128839-1992",
   "channelSkuCodepaymentMethod": "xyzCOD",
     "shippingAddress": {
    "qtycity": 2"Bangalore",
    "country": "IN",
    "barcodeemail": "bar1"ad******@gmail.com",
    "line1": "Shanti Nagar  }Kent",
    "line2": "South vihar colony",
{    "line3": "string",
     "channelSkuCodename": "xyz1Abhinav Singh",
    "phone": "98******78",
    "qtystate": 1"KARNATAKA",
          "barcode"zip": "bar2"
     560102"
  },
      ]
    }
  ]"shippingCharges": 0,
  "orderItemssubOrderItems": [
    {
      "orderItemCodebarcode": "item123BAR00091",
      "channelSkuCodecancelledQuantity": "1000889888"0,
      "orderedQuantitychannelDiscount": 223.0,
      "cancelledQuantitychannelSkuCode": 1"BAR00091",
      "channelDiscountfulfilledQuantity": 501,
      "sellingPricePerUnitgiftChargePerUnit": 5000,
      "giftChargePerUnithoppedQuantity": 100,
      "sellerDiscountomsSubOrderItemId": 516624,
      "shippingChargeorderItemCodes": 0
 [
        "ITEM001"
   }   ],
      "shippingAddressorderedQuantity": {1,
      "namesellerDiscount": "Customer's Name",0,
      "line1sellingPricePerUnit": "Line1200,
Address 1",     "line2shippingCharge": "Line0,
Address 2",     "line3externalItemCodes": [
"Line  Address 3",     "cityBAR00091":
 "city",     "state": "state",]
     "zip": "zip",
    "country": "country",}
  ],
  "emailturnAroundTime": "abc@gmail.com23-10-2023T12:09:08",
    "phonevirtualSkuDefinitions": "9999999999"[
  },  {
"billingAddress": {     "namechildSkus": "customer",[
    "line1": "address line 1", {
   "line2": "address line 2",     "line3barcode": "address line 3",BAR00091",
          "citychannelSkuCode": "BengaluruBAR00091",
          "stateqty": "Karnataka",1
        "zip": "560076",}
     "country": "INDIA", ],
      "emailvirtualParentBarcode": "abc@gmail.comBAR00091",
      "phonevirtualParentChannelSkuId": "9999999999BAR00091"
    }
  ]
}

Parameter

Name

	Data Type	Description	Mandatory

locationCode

String

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

channelType

String

Type of the channel.Possible values: ERP/MARKETPLACE

yes

orderTime

String

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


`billingAddress`	Object of type address	Billing Address	yes
`billingAddress.city`	String	City name	yes
`billingAddress.country`	String	Country Name	yes
`billingAddress.email`	String	email	yes
`billingAddress.line1`	String	address line 1	yes
`billingAddress.line2`	String	address line 2	no
`billingAddress.lone3`	String	address line 3	no
`billingAddress.name`	String	Name	yes
`billingAddress.state`	String	state name	yes
`billingAddress.zip`	String	zip code	yes
`billingAddress.phone`	String	phone number	yes
`channelName`	String	channel name	yes
`channelType`	“ERP”	channel type	yes
`createdAt`	String	created at time	yes
`credentials`	list of credentials	credentials	no
`eventTime`	String	time of the event	yes
eventType	String	Postings can be sent on below triggers SUBORDER_CREATE (creation of sub order) SUBORDER_CANCEL (cancellation of sub order) SUBORDER_COMPLETE (completion of suborder) SUBORDER_PARTIAL_CANCEL (partial cancellation of suborder)	yes
`orderType`	String	Can be - SO(Sales Order)/STO(Stock Transfer Order)/RTV(Return To Vendor), RPO(Replacement)	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
`messageId`	Long	Unique Identifier of a notification (for De-duplication)

Yes

yes

paymentMethodPossible values - COD, NCOD

omsSubOrderId

String

Long

Internal sub order id of OMS

yes

isPriority

orderCode

Boolean

This flag is true in case order is HIGH priority than normal orders.

String

order code from channel

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

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

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.shippingCharge

Double

Shipping charges on item

no

eventType

String

Possible values : { SUBORDER_CREATE, SUBORDER_PARTICAL_CANCEL, SUBORDER_CANCEL, SUBORDER_COMPLETE}

yes

eventTime

String

Time of event creation

yes

shippingAddress

Object

Shipping address of the customer

yes

shippingAddress.name

String

Name of customer

yes

shippingAddress.line1

String

1st line of customer’s address

yes

shippingAddress.line2

String

2nd line of customer’s address

no

shippingAddress.line3

String

3rd line of customer’s address

no

shippingAddress.city

String

City of customer

yes

shippingAddress.state

String

State of customer

yes

shippingAddress.zip

String

ZIP/Pin code of customer

yes

shippingAddress.country

String

Country of customer

yes

shippingAddress.email

String

Email of customer

no

shippingAddress.phone

String

Phone Number of customer

no

billingAddress

Object

Billing address of the customer

yes

billingAddress.name

String

Name of customer

yes

billingAddress.line1

String

1st line of customer’s address

yes

billingAddress.line2

String

2nd line of customer’s address

no

billingAddress.line3

String

3rd line of customer’s address

no

billingAddress.city

String

City of customer

yes

billingAddress.state

String

State of customer

yes

billingAddress.zip

String

ZIP/Pin code of customer

yes

billingAddress.country

String

Country of customer

yes

billingAddress.email

String

Email of customer

no

billingAddress.phone

String

Phone Number of customer

`parentOrderCode`	String	parent order code from channel	no
`paymentMethod`	String	possible values- COD/NCOD	yes
`shippingAddress`	Object of type Address	Address	yes
`shippingAddress.city`	String	City name	yes
`shippingAddress.country`	String	Country name	yes
`shippingAddress.line1`	String	address line 1	yes
`shippingAddress.line2`	String	address line 2	no
`shippingAddress.line3`	String	address line 3	no
`shippingAddress.name`	String	name	yes
`shippingAddress.state`	String	state name	yes
`shippingAddress.zip`	String	pin code	yes
`shippingAddress.email`	String	email address	yes
`shippingAddress.phone`	String	phone nymber	yes
`shippingCharges`	Double	Shipping charge	no
`subOrderItems`			yes
`subOrderItems.barcode`	String	barcode	yes
`subOrderItems`.`cancelledQuantity`	Integer	cancelled quantity	yes
`subOrderItems.channelDiscount`	Double	discount from the channel	no
`subOrderItems.channelSkuCode`	String	Sku Code on channel side	yes
`subOrderItems.fulfilledQuantity`	Long	fulfilled quantity	yes
`subOrderItems.giftChargePerUnit`	Double	`giftChargePerUnit`	no
`subOrderItems.hoppedQuantity`	Long	`hoppedQuantity`	yes
`subOrderItems.omsSubOrderItemId`	Long	sub order item id in oms	yes
`subOrderItems.orderItemCodes`	List<String>	list of order item codes	yes
`subOrderItems.orderedQuantity`	Long	ordered quantity	yes
`subOrderItems.sellerDiscount`	Double	seller discount	no
`subOrderItems.sellingPricePerUnit`	Double	selling price per item	no
`subOrderItems.shippingCharge`	Double	shipping charde	no
`subOrderItems.externalItemCodes`	List of String	list of item codes	no
`turnAroundTime`	String	turn around time	no
`virtualSkuDefinitions`			no
`virtualSkuDefinitions.childSkus`	List	List of child skus	no
`virtualSkuDefinitions.virtualParentBarcode`	String	Virtual Parent barcode	no
`virtualSkuDefinitions.virtualParentChannelSkuId`	String	Virtual Parent channel SKU id	yes
`virtualSkuDefinitions.childSkus.barcode`	String	barcode	no
`virtualSkuDefinitions.childSkus.qty`	Integer	quantity	no
`virtualSkuDefinitions.childSkus.channelSkuCode`	String	channel SKU code	no

Response

Code Block

language	json

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

HttpStatus : 200

Versions Compared

Old Version 9

New Version 10

Key

Outbound | POST | {Client’s URL}

Summary

Description

Request

Response