Outbound | POST | {Client’s URL}
Summary
This API will notify call the POS system with Sales sales order details after the order completion in Increff system.
Description
This API will call the POS system with the details of sales orders which are completed in Increff system.
This API will be triggered at a certain frequency from Increff
...
system.
Postings can be sent on below triggersevents
SUBORDER_CREATESUBORDER_CANCELSUBORDER_COMPLETESUBORDER_PARTIAL_CANCELSUBORDER_PROPERTIES_UPDATE
Request
| Code Block | ||
|---|---|---|
| ||
{
"billingAddresslocationCode": {
"IN132",
"citymessageId": "Bangalore"12345,
"countryorderCode": "INflipkart1234",
"emailomsSubOrderId": "ad******@gmail.com"19011046,
"line1parentOrderCode": "Shanti Nagar Kentflipkart1221",
"line2orderTime": "South vihar colony",
2020-10-16T20:22:28.000+00:00",
"line3orderType": "stringSO/STO/RTV",
"namepaymentMethod": "Abhinav SinghCOD",
"phoneturnAroundTime": "98******78",2024-06-28T08:30:00.000+00:00",
"shipments": [
{
"stateshipmentCode": "KARNATAKA7982354179",
"ziplocationCode": "560102DLLJPT06",
}, "channelNameshipmentStatus": "NYKAADISPATCHED",
"channelTypegeneratedInvoiceId": "ERP17531870",
"createdAtgeneratedInvoiceDate": "232024-0806-2023T12:07:18",26T08:22:53.000+00:00",
"credentialsomsShipmentId": {},null,
"eventTimeinvoiceDocumentUrl": "23-08-2023T12:09:18https://mybrand.com/invoice123.pdf",
"eventType": "SUBORDER_CANCEL", "isPriorityirn": truenull,
"locationCode": "1120004561", "messageIdqrCode": 786651null,
"omsSubOrderId": 128876, "orderCodeshippingLabelDocumentUrl": "NYK-128839-1992",https://mybrand.com/sldoc.pdf",
"orderTimeexternalInvoiceId": "23-08-2023T12:06:18I0725ZP000000647",
"orderType": "SALES", "parentOrderCodeexternalInvoiceDate": "NYK2024-128839-1992",06-26T08:22:41.000+00:00",
"paymentMethodawbNumber": "CODawb1",
"shippingAddress": { "citytransporter": "BangaloreMyntra Logistics",
"countrypackageSku": "INpackageSku1",
"emailshipmentItems": "ad******@gmail.com", [
"line1": "Shanti Nagar Kent", {
"line2orderItemCode": "South vihar colony9982333122",
"line3": "string", "namechannelSkuCode": "Abhinav Singh35255XXL",
"phone": "98******78", "statenetTaxAmountPerUnit": "KARNATAKA"353.46,
"zip "netTaxAmountTotal": "560102" 353.46,
}, "shippingCharges": 0, "subOrderItemsbaseSellingPricePerUnit": [
2945.54,
{ "barcodebaseSellingPriceTotal": "BAR00091",2945.54,
"cancelledQuantitysellingPricePerUnit": 03299,
"channelDiscountsellingPriceTotal": 23.03299,
"channelSkuCodequantity": "BAR00091",1,
"fulfilledQuantityshippingChargePerUnit": 110.00,
"giftChargePerUnit": 0, "taxItems": [
"hoppedQuantity": 0, "omsSubOrderItemId": 16624, {
"orderItemCodes": [ "type": "ITEM001IGST",
], "orderedQuantityrate": 112,
"sellerDiscount": 0,
"sellingPricePerUnittaxPerUnit": 1200353.46,
"shippingCharge": 0, "externalItemCodestaxTotal": 353.46
[ "BAR00091" }
] ],
} ], "turnAroundTimebarcode": "23-10-2023T12:09:0835255XXL",
"virtualSkuDefinitions": [
{ "childSkusclientSkuCode": ["ClientSku1"
{}
],
"barcodeshipmentDetails": "BAR00091",
{
"channelSkuCodelength": "BAR00091",
30.0,
"qtybreadth": 120.0,
}
],"height": 10.0,
"virtualParentBarcodeweight": "BAR00091",5.0,
"virtualParentChannelSkuIdshipmentId": "BAR00091"12345,
}
]
} |
...
Parameter
...
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
...
...
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
...
"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
}
]
}
]
},
"deliveredAt": null
}
],
"isPriority": false,
"channelName": "flipkart",
"channelType": "ERP/MARKETPLACE",
"eventType": "SUBORDER_COMPLETE",
"eventTime": "2020-10-16T20:22:28.000+00:00",
"shippingCharges": 20,
"orderCustomAttributes": {
"attribute1": "test_4e10f67e0585",
"attribute10": "test_e3af29b52cda",
"attribute2": "test_df7f45161dbf",
"attribute3": "test_511554245071",
"attribute4": "test_285ab90a9a26",
"attribute5": "test_c9902353bd62",
"attribute6": "test_29bf877ad20e",
"attribute7": "test_f05c5ee7bda0",
"attribute9": "test_913b35f805f0",
"channelMetadata": {
"MetaDataTestExample1": "test_13669a9d0d24",
"MetaDataTestExample2": "test_13669a9d0d25"
},
"currency": "test_ad35da54ae2f"
},
"virtualSkuDefinitions": [
{
"virtualParentChannelSkuId": "abc1",
"virtualParentBarcode": "barcode1",
"virtualParentClientSkuCode": "VPClientSku1",
"childSkus": [
{
"channelSkuCode": "xyz",
"qty": 2,
"barcode": "bar1",
"clientSkuCode": "ClientSku1"
},
{
"channelSkuCode": "xyz1",
"qty": 1,
"barcode": "bar2",
"clientSkuCode" : null
}
]
}
],
"bundledSkuDefinitions": [
{
"bundledParentBarcode": "string",
"bundledParentChannelSkuId": "string",
"bundledParentClientSkuCode" : "BPClientSku1",
"childSkus": [
{
"barcode": "string",
"clientSkuCode": "ClientSku1",
"channelSkuCode": "string",
"qty": 0
}
]
}
],
"orderItems": [
{
"orderItemCodes": [
"item123"
],
"channelSkuCode": "1000889888",
"orderedQuantity": 2,
"cancelledQuantity": 1,
"customerCancelledQty": 0,
"sellerCancelledQty": 0,
"sellerRejectQty": 0,
"fulfilledQuantity": 1,
"hoppedQuantity": 0,
"barcode": "35255XXL",
"clientSkuCode": "ClientSku1",
"channelDiscount": 50,
"sellingPricePerUnit": 500,
"giftChargePerUnit": 10,
"sellerDiscount": 5,
"shippingCharge": 0,
"externalItemCodes": [
"externalCode1"
],
"orderItemCustomAttributes": {
"attribute1": "test_9500ccd4855f",
"attribute10": "test_1e7511fe9fc8",
"attribute2": "test_957207fbdbb0",
"attribute3": "test_e9c4494fc055",
"attribute4": "test_2c6670838f48",
"attribute5": "test_09156554f500",
"attribute6": "test_20ab8d00c447",
"attribute7": "test_f0c3e77287ae",
"attribute9": "test_691c1f899bb8",
"channelMetadata": {
"MetaDataTestExample1": "test_13669a9d0d24",
"MetaDataTestExample2": "test_13669a9d0d25"
}
}
}
],
"subOrderItems": [
{
"orderItemCodes": [
"item123"
],
"channelSkuCode": "1000889888",
"orderedQuantity": 2,
"cancelledQuantity": 1,
"customerCancelledQty": 0,
"sellerCancelledQty": 0,
"sellerRejectQty": 0,
"fulfilledQuantity": 1,
"hoppedQuantity": 0,
"barcode": "35255XXL",
"clientSkuCode": "ClientSku1",
"channelDiscount": 50,
"sellingPricePerUnit": 500,
"giftChargePerUnit": 10,
"sellerDiscount": 5,
"shippingCharge": 0,
"externalItemCodes": [
"externalCode1"
],
"orderItemCustomAttributes": {
"attribute1": "test_9500ccd4855f",
"attribute10": "test_1e7511fe9fc8",
"attribute2": "test_957207fbdbb0",
"attribute3": "test_e9c4494fc055",
"attribute4": "test_2c6670838f48",
"attribute5": "test_09156554f500",
"attribute6": "test_20ab8d00c447",
"attribute7": "test_f0c3e77287ae",
"attribute9": "test_691c1f899bb8",
"channelMetadata": {
"MetaDataTestExample1": "test_13669a9d0d24",
"MetaDataTestExample2": "test_13669a9d0d25"
}
}
}
],
"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"
}
} |
Note : subOrderItems has the same structure as orderItems
Parameter Name | Data Type | Description | Mandatory |
| String | Location from which order was fulfilled | Yes |
| String | Unique code used by the channel to identify order | yes |
| Long | Internal sub order id of OMS | No |
| String | Parent order code which can be null or empty or some duplicate value across orders. | no |
| String | Channel name of the marketplace. | yes |
| String | Type of the channel.Possible values: ERP/MARKETPLACE | yes |
| String | Time at which order was placed at the channel in UNIX (UTC) | yes |
| String | Can be - SO(Sales Order)/STO(Stock Transfer Order)/RTV(Return To Vendor), RPO(Replacement) | yes |
| Long | Unique Identifier of a notification(for De-duplication) | Yes |
| String | Possible values - COD, NCOD | yes |
| ZonedDateTime | Turnaround time | NO |
| Object[] | shipmets belonging to this posting | YES |
| String | Irn generated on Govt. portal while e-invoicing | No |
| String | QrCode generated on Govt. portal while e-invoicing | No |
| String | Possible values: {OPEN,CLOSED, INVOICED, MANIFESTED, DISPATCHED, CANCELLED, DELIVERED} | No |
| Object[] | Items belonging to this shipment | Yes |
| String | SKU code of order item | Yes |
| String | This is provided by the channel to uniquely identify each order item. | Yes |
| Double | Per unit tax applicable for the SKU. | Yes |
| String | Scannable code to identify an sku | no |
| String | Unique identifier for an sku at client end | no |
| Double | Total tax applicable for the SKU | Yes |
| Double | Per unit base selling price of the SKU | Yes |
| Double | Total base selling price of SKU | Yes |
| Double | Per unit selling price of the SKU including tax | Yes |
| Double | Total selling price of the SKU | Yes |
| Integer | Quantity of the sku in the shipment item. | Yes |
| Double | Shipping charge per unit for a shipment item | No |
| Object | Distribution of tax with tax type | Yes |
| Object | Shipment details | No |
| Double | Length of the shipment | No |
| Double | Breadth of the shipment | No |
| Double | Height of the shipment | No |
| Double | Weight of the shipment | No |
| Long | Id to uniquely identify a shipment | No |
| Integer | Count of all the items in the shipment | No |
| Object[] | Details of pack boxes | No |
| Double | Length of the pack box in consideration | No |
| Double | Breadth of the pack box in consideration | No |
| Double | Height of the pack box in consideration | No |
| Double | Weight of the pack box in consideration | No |
| Long | Id to uniquely identify a box | No |
| String | AWB number of the box | No |
| String | Remarks for the pack box | No |
| Object[] | Details of skus in a box | No |
| Long | Id to uniquely identify a sku in increff’s system | No |
| String | Id to uniquely identify a sku on client’s end | No |
| Integer | Count of a particular sku in a box | No |
| String | Type of tax applicable | Yes |
| Double | Tax rate for this tax type | Yes |
| Double | Tax applicable for this type of tax per unit | Yes |
| Double | Total tax applicable for this type of tax | Yes |
| Boolean | This flag is true in case order is HIGH priority than normal orders. | yes |
| Object | Custom attributes of order | no |
| String | Custom attribute 1 | no |
| String | Custom attribute 2 | no |
| String | Custom attribute 3 | no |
| String | Custom attribute 4 | no |
| String | Custom attribute 5 | no |
| String | Custom attribute 6 | no |
| String | Custom attribute 7 | no |
| String | Custom attribute 8 | no |
| String | Custom attribute 9 | no |
| String | Custom attribute 10 | no |
| String | Currency | no |
| Object | meta data fields as an object which is to be parsed at the channel’s end | no |
| Object | List of virtual SKU definitions | no |
| String | SKU code of virtual SKU | no |
| String | Barcode of parent SKU | no |
| String | Unique identifier for a virtual parent sku at client’s end | no |
| Object[] | List of child SKUs | no |
| String | SKU code of child SKU | no |
| Integer | Quantity of child SKU | no |
| String | Barcode of child SKU | no |
| Object[] | List of bundled sku definitions | yes |
| String | Unique barcode of bundled Sku | no |
| String | Unique identifier for a bundled parent sku at client’s end | no |
| String | Unique identifier of bundled Sku at channel | yes |
| Object[] | List of child SKUs | yes |
| String | Unique barcode of child sku | no |
| String | Unique identifier of child sku at channel | no |
| Integer | child sku quantity | no |
| Object[] | List of order items | yes |
| String[] | This is provided by the channel to uniquely identify each order item. | yes |
| String | SKU code of order item | yes |
| String | Scannable code to identify an sku | no |
| String | Unique identifier for an sku at client’s end | no |
| int | Ordered Quantity | yes |
| int | cancelledQuantity | yes |
| double | sellingPricePerUnit | no |
| Double | giftChargePerUnit | no |
| Double | Discount provided by channel per unit | no |
| Double | Discount provided by seller per unit | no |
| Double | Shipping charges on item | no |
| Object[] | Custom attributes of order item | no |
| String | Custom attribute 1 | no |
| String | Custom attribute 2 | no |
| String | Custom attribute 3 | no |
| String | Custom attribute 4 | no |
| String | Custom attribute 5 | no |
| String | Custom attribute 6 | no |
| String | Custom attribute 7 | no |
| String | Custom attribute 8 | no |
| String | Custom attribute 9 | no |
| String | Custom attribute 10 | no |
| Object | meta data fields as an object which is to be parsed at the channel’s end | no |
| String | Possible values
| yes |
| String | Time of event creation | yes |
| Object | Shipping address of the customer | yes |
| String | Name of customer | yes |
| String | 1st line of customer’s address | yes |
| String | 2nd line of customer’s address | no |
| String | 3rd line of customer’s address | no |
| String | City of customer | yes |
| String | State of customer | yes |
| String | ZIP/Pin code of customer | yes |
| String | Country of customer | yes |
| String | Email of customer | no |
| String | Phone Number of customer | no |
| Object | Billing address of the customer | yes |
| String | Name of customer | yes |
| String | 1st line of customer’s address | yes |
| String | 2nd line of customer’s address | no |
| String | 3rd line of customer’s address | no |
| String | City of customer | yes |
| String | State of customer | yes |
| String | ZIP/Pin code of customer | yes |
| String | Country of customer | yes |
| String | Email of customer | no |
| String | Phone Number of customer | no |
Response
| Code Block | ||
|---|---|---|
| ||
{
"hasError": false,
"errorMessage":"message"
} |
...
HttpStatus : 200