Page Comparison

Outbound | POST | {Client’s URL}

Summary

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

Description

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

Postings can be sent on below triggers

SUBORDEROUTWARD_ORDER_CREATE
SUBORDEROUTWARD_ORDER_CANCELSUBORDER
OUTWARD_COMPLETESUBORDERORDER_PARTIAL_CANCEL
OUTWARD_ORDER_SHIPMENT_DISPATCH
OUTWARD_ORDER_SHIPMENT_DELIVER
OUTWARD_ORDER_COMPLETE

Request

Code Block

language	json

{
  "billingAddresslocationCode": {"IN132",
  "messageId": 12345,
  "cityorderCode": "Bangaloreflipkart1234",
  "parentOrderCode": "flipkart1221",
  "countryorderTime": "IN2020-10-16T20:22:28.000+00:00",
  "orderType": "SO/STO/RTV",
  "emailpaymentMethod": "ad******@gmail.comCOD",
  "isPriority": false,
  "line1channelName": "flipkart"Shanti Nagar Kent,
  "channelType": "ERP/MARKETPLACE",
  "eventType": "OUTWARD_ORDER_COMPLETE",
  "line2eventTime": "South vihar colony","2020-10-16T20:22:28.000+00:00",
  "shippingCharges": 20,
  "orderCustomAttributes": {
        "line3attribute1": "stringtest_4e10f67e0585",
        "nameattribute10": "Abhinav Singh",test_e3af29b52cda",
        "attribute2": "test_df7f45161dbf",
        "phoneattribute3": "98******78test_511554245071",
        "stateattribute4": "KARNATAKAtest_285ab90a9a26",
        "zipattribute5": "560102"test_c9902353bd62",
     },   "channelNameattribute6": "NYKAAtest_29bf877ad20e",
        "channelTypeattribute7": "ERPtest_f05c5ee7bda0",
        "createdAtattribute9": "23-08-2023T12:07:18",test_913b35f805f0",
        "credentialschannelMetadata": {},
            "eventTimeMetaDataTestExample1": "23-08-2023T12:09:18",test_13669a9d0d24",
            "eventTypeMetaDataTestExample2": "SUBORDERtest_CANCEL",13669a9d0d25"
        },
    "isPriority": true,   "locationCodecurrency": "1120004561"test_ad35da54ae2f"
    },
  "messageIdvirtualSkuDefinitions": 786651,[
    {
      "omsSubOrderIdvirtualParentChannelSkuId": 128876"abc1",
      "orderCodevirtualParentBarcode": "NYK-128839-1992barcode1",
      "orderTimechildSkus": [
        {
          "channelSkuCode"23-08-2023T12:06:18",: "xyz",
          "orderTypeqty": "SALES",2,
          "parentOrderCodebarcode": "NYK-128839-1992",
  "paymentMethodbar1"
        },
        {
          "channelSkuCode": "CODxyz1",
  "shippingAddress": {        "qty": 1,
          "citybarcode": "Bangalore",bar2"
        }
      ]
    }
  ],
  "bundledSkuDefinitions": [
    "country{
       "bundledParentBarcode": "INstring",
       "emailbundledParentChannelSkuId": "ad******@gmail.comstring",
       "line1childSkus": "Shanti Nagar Kent", [
           {
               "line2barcode": "South vihar colony","string",
               "line3channelSkuCode": "string",
        "name": "Abhinav Singh",       "qty": 0
           }
       ]
     }
  ],
  "orderItems": [
    {
      "phoneorderItemCode": "98******78item123",
      "statechannelSkuCode": "KARNATAKA1000889888",
      "ziporderedQuantity": 2,
      "560102cancelledQuantity": 1,
 },     "shippingChargeschannelDiscount": 050,
      "subOrderItemssellingPricePerUnit": 500,
  [     {"giftChargePerUnit": 10,
      "barcodesellerDiscount": "BAR00091"5,
      "cancelledQuantityshippingCharge": 0,
      "channelDiscountorderItemCustomAttributes": 23.0, {
                "channelSkuCodeattribute1": "BAR00091test_9500ccd4855f",
       "fulfilledQuantity         "attribute10": 1,"test_1e7511fe9fc8",
                "giftChargePerUnitattribute2": 0,"test_957207fbdbb0",
          "hoppedQuantity      "attribute3": 0,"test_e9c4494fc055",
                "omsSubOrderItemIdattribute4": 16624"test_2c6670838f48",
      "orderItemCodes": [          "attribute5": "test_09156554f500",
                "attribute6": "ITEM001"test_20ab8d00c447",
         ],       "orderedQuantityattribute7": 1,"test_f0c3e77287ae",
                "sellerDiscountattribute9": 0,"test_691c1f899bb8",
                "sellingPricePerUnitchannelMetadata": 1200,{
                    "shippingChargeMetaDataTestExample1": 0,"test_13669a9d0d24",
                    "externalItemCodesMetaDataTestExample2": [ "test_13669a9d0d25"
               "BAR00091" }
     ]       }
    }
  ],
  "turnAroundTimeshippingAddress": {
    "name"23-10-2023T12:09:08: "Customer's Name",
    "virtualSkuDefinitionsline1": [ "Line Address 1",
     {
 "line2": "Line Address 2",
    "childSkusline3": [
   "Line Address 3",
    "city": "city",
     {"state": "state",
    "zip": "zip",
    "barcodecountry": "BAR00091country",
    "email": "abc@gmail.com",
    "channelSkuCodephone": "BAR000919999999999"
  },
  "billingAddress": {
    "name": "customer",
    "qtyline1": "address line 1",
    "line2": "address line 2",
}    "line3": "address line ]3",
    "city": "Bengaluru",
    "virtualParentBarcodestate": "BAR00091Karnataka",
    "zip": "560076",
 "virtualParentChannelSkuId   "country": "INDIA",
    "email": "BAR00091abc@gmail.com",
    } "phone": "9999999999"
  ]}
}

...

Parameter Name

Data Type

Description

Mandatory

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

omsSubOrderId

Long

Internal sub order id of OMS

yes

orderCode

String

order code from channel

yes

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


`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)	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
`isPriority`	Boolean	This flag is true in case order is HIGH priority than normal orders.	yes
`orderCustomAttributes`	Object	Custom attributes of order	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
`orderCustomAttributes.currency`	String	Currency	no
`orderCustomAttributes.channelMetaData`	Object	meta data fields as an object which is to be parsed at the channel’s end	no
`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
`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	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
`orderItems.orderItemCustomAttributes`	Object[]	Custom attributes of order item	no
`orderItems.orderItemCustomAttributes.attribute1`	String	Custom attribute 1	no
`orderItems.orderItemCustomAttributes.attribute2`	String	Custom attribute 2	no
`orderItems.orderItemCustomAttributes.attribute3`	String	Custom attribute 3	no
`orderItems.orderItemCustomAttributes.attribute4`	String	Custom attribute 4	no
`orderItems.orderItemCustomAttributes.attribute5`	String	Custom attribute 5	no
`orderItems.orderItemCustomAttributes.attribute6`	String	Custom attribute 6	no
`orderItems.orderItemCustomAttributes.attribute7`	String	Custom attribute 7	no
`orderItems.orderItemCustomAttributes.attribute8`	String	Custom attribute 8	no
`orderItems.orderItemCustomAttributes.attribute9`	String	Custom attribute 9	no
`orderItems.orderItemCustomAttributes.attribute10`	String	Custom attribute 10	no
`orderItemCustomAttributes.channelMetaData`	Object	meta data fields as an object which is to be parsed at the channel’s end	no
`eventType`	String	Possible values : { SUBORDER_CREATE, SUBORDER_PARTICAL_CANCEL, SUBORDER_CANCEL, OUTWARD_ORDER_SHIPMENT_DISPATCH, OUTWARD_ORDER_SHIPMENT_DELIVER, 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	no

Response

Code Block

language	json

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

...

HttpStatus : 200

Versions Compared

Old Version 10

New Version 11

Key

Outbound | POST | {Client’s URL}

Summary

Description

Request

Response