...
SUBORDER_CREATE
SUBORDER_PARTIAL_CANCEL
SUBORDER_CANCEL
SUBORDER_COMPLETE
SUBORDER_PROPERTIES_UPDATE
The above listed events can be enabled or disabled from Increff’s CIMS user interface with help of Increff support team
...
| Code Block | ||
|---|---|---|
| ||
{
"locationCode": "IN132",
"messageId": 12345,
"orderCode": "flipkart1234",
"parentOrderCode": "flipkart1221",
"orderTime": "2020-10-16T20:22:28Z[UTC]",
"startProcessingTime": "2020-10-16T20:22:28Z[UTC]",
"requiredBy": "2020-10-16T20:22:28Z[UTC]",
"paymentMethod": "COD",
"isPriority": false,
"channelName": "flipkart",
"eventType": "SUBORDER_CREATE/SUBORDER_PARTIAL_CANCEL/SUBORDER_CANCEL/SUBORDER_COMPLETE",
"onHold": false,
"orderCustomAttributes": {
"attribute1": "test_4e10f67e0585",
"attribute2": "test_df7f45161dbf",
"attribute3": "test_511554245071",
"attribute4": "test_285ab90a9a26",
"attribute5": "test_c9902353bd62",
"attribute6": "test_29bf877ad20e",
"attribute7": "test_f05c5ee7bda0",
"attribute9": "test_913b35f805f0",
"attribute10": "test_e3af29b52cda",
"channelMetadata": {
"MetaDataTestExample1": "test_13669a9d0d24",
"MetaDataTestExample2": "test_13669a9d0d25"
},
"currency": "test_ad35da54ae2f"
},
"orderItems": [{
"clientSkuIdorderItemCodes": [
"1000889888"14974593958185"
],
"channelSkuCodeclientSkuId": "1000889888",
"orderedQuantitychannelSkuCode": 2"1000889888",
"cancelledQuantityorderedQuantity": 12,
"channelDiscountcancelledQuantity": 501,
"sellingPricePerUnitbarcode": 500"51100L",
"giftChargePerUnitcustomerCancelledQty": 10null,
"sellerDiscountsellerCancelledQty": 5null,
"shippingChargesellerRejectQty": 0null,
"isVirtualchannelDiscount": true50,
"orderItemCustomAttributessellingPricePerUnit": {500,
"attribute1giftChargePerUnit": "test_9500ccd4855f"10,
"attribute2hoppedQuantity": "test_957207fbdbb0"null,
"attribute3sellerDiscount": "test_e9c4494fc055"5,
"attribute4shippingCharge": "test_2c6670838f48",
0,
"attribute5isVirtual": "test_09156554f500"true,
"attribute6externalItemCodes": "test_20ab8d00c447"[
"A6D70B2DE36"],
"attribute7orderItemCustomAttributes": "test_f0c3e77287ae",{
"attribute9attribute1": "test_691c1f899bb89500ccd4855f",
"attribute10attribute2": "test_1e7511fe9fc8957207fbdbb0",
"channelMetadataattribute3": {"test_e9c4494fc055",
"MetaDataTestExample1attribute4": "test_13669a9d0d242c6670838f48",
"MetaDataTestExample2attribute5": "test_13669a9d0d2509156554f500",
}"attribute6": "test_20ab8d00c447",
}
"attribute7": "test_f0c3e77287ae",
}], "shippingAddressattribute9": {"test_691c1f899bb8",
"nameattribute10": "Customer's Nametest_1e7511fe9fc8",
"line1channelMetadata": "Line{
Address 1", "line2MetaDataTestExample1": "Linetest_13669a9d0d24",
Address 2", "line3MetaDataTestExample2": "test_13669a9d0d25"Line
Address 3", }
"city": "city", }
"state": "state"}],
"subOrderItems": [{
"ziporderItemCodes": "zip",[
"country": "country"14974593958185"
],
"emailclientSkuId": "abc@gmail.com1000889888",
"phonechannelSkuCode": "99999999991000889888",
}, "billingAddressorderedQuantity": {2,
"namecancelledQuantity": "customer"1,
"line1barcode": "address line 1"51100L",
"line2customerCancelledQty": "address line 2"null,
"line3sellerCancelledQty": "address line 3"null,
"citysellerRejectQty": "Bengaluru"null,
"statechannelDiscount": "Karnataka"50,
"zipsellingPricePerUnit": "560076"500,
"countrygiftChargePerUnit": "INDIA"10,
"emailhoppedQuantity": "abc@gmail.com"null,
"phonesellerDiscount": "9999999999"5,
}, "virtualSkuDefinitionsshippingCharge": [{0,
"virtualParentChannelSkuIdisVirtual": "sku_34"true,
"virtualParentBarcodeexternalItemCodes": [
"bar_43A6D70B2DE36"],
"childSkusorderItemCustomAttributes": [{
"channelSkuCodeattribute1": "chtest_sku_239500ccd4855f",
"barcode"attribute2": "bartest_32957207fbdbb0",
"qtyattribute3": 21
}]"test_e9c4494fc055",
}], "bundledSkuDefinitionsattribute4": ["test_2c6670838f48",
{
"childSkusattribute5": ["test_09156554f500",
{
"attribute6": "test_20ab8d00c447",
"barcodeattribute7": "stringtest_f0c3e77287ae",
"channelSkuCodeattribute9": "stringtest_691c1f899bb8",
"qtyattribute10": 0"test_1e7511fe9fc8",
}"channelMetadata": {
], "bundledParentBarcodeMetaDataTestExample1": "stringtest_13669a9d0d24",
"bundledParentChannelSkuIdMetaDataTestExample2": "string"test_13669a9d0d25"
}
}
}]
} |
...
Parameter Name
...
,
"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"
},
"virtualSkuDefinitions": [{
"virtualParentChannelSkuId": "sku_34",
"virtualParentBarcode": "bar_43",
"childSkus": [{
"channelSkuCode": "ch_sku_23",
"barcode": "bar_32",
"qty": 21
}]
}],
"bundledSkuDefinitions": [
{
"childSkus": [
{
"barcode": "string",
"channelSkuCode": "string",
"qty": 0
}
],
"bundledParentBarcode": "string",
"bundledParentChannelSkuId": "string"
}
]
} |
Parameter Name | Data Type | Description | Mandatory |
| String | Identifier of the location from which order is fulfilled | Yes
|
| String | Unique code used by the channel to identify order | Yes |
| String | Order identifier to map the parent order with child orders | No |
| String | Channel name of the marketplace | Yes |
| String | Time at which order was placed at the channel by customer (in UTC) | Yes |
| String | Time after which order processing is allowed in the fulfillment system(in UTC) | Yes |
| String | SLA time before which order processing is expected to be completed(in UTC) | Yes |
| Long | Unique Identifier of a notification(for De-duplication) | Yes |
| String | It signifies the payment mode using which customer has placed the order Possible values → | Yes |
| Boolean | This flag is | Yes |
| Boolean | Identifier to be used to decide whether an order should be kept onHold for processing or not. Possible Values |
true, false→ | Yes | ||
| String | Possible values:
| 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
orderItems
Object[]
no | |||
| Object[] | List of order items | Yes |
| String | Scannable barcode on the product | Yes |
| String | SKU identifier of channel | Yes |
| int | Ordered Quantity | Yes |
| int | Absolute cancelledQuantity | Yes |
|
String
Scannable barcode on the product
Yes
orderItems.channelskuCode
String
SKU identifier of channel
Yes
orderItems.orderedQuantity
int
Ordered Quantity
Yes
orderItems.cancelledQuantity
int
Absolute cancelledQuantity
| int | customer cancelled quantity | No |
| barcode | barcode | No |
| int | seller cancelled qty | No |
| int | seller rejected qty | No |
| int | fulfilled qty | No |
| int | hopped qty | No |
| 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 |
eventType
String
Possible values : { SUBORDER_CREATE,SUBORDER_PARTIAL_CANCEL,SUBORDER_CANCEL,SUBORDER_COMPLETE}
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
virtualSkuDefinitions
Object[]
List of virtual SKU definitions
No
virtualSkuDefinitions.virtualParentChannelSkuId
String
SKU code of virtual SKU
Yes if its being used
virtualSkuDefinitions.virtualParentBarcode
String
Barcode of parent SKU
| Object[] | List of order items | Yes |
| String | Scannable barcode on the product | Yes |
| String | SKU identifier of channel | Yes |
| int | Ordered Quantity | Yes |
| int | Absolute cancelledQuantity | Yes |
| int | customer cancelled quantity | No |
| barcode | barcode | No |
| int | seller cancelled qty | No |
| int | seller rejected qty | No |
| int | fulfilled qty | No |
| int | hopped qty | No |
| 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 |
| 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 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 |
Response
HttpStatus : 200