...
OUTWARD_ORDER_CREATE,
OUTWARD_ORDER_CANCEL,
OUTWARD_ORDER_COMPLETE ,
OUTWARD_ORDER_PARTIAL_CANCEL
Request
| Code Block | ||
|---|---|---|
| ||
{
"partnerCode": "partner11100013090",
"partnerLocationCode": "partnerLocationCode9",
"locationCode": "Wid235IN132",
"messageIdorderCode": 1100"flipkart1234",
"orderCodeparentOrderCode": "flipkart1221",
"order1isPriority": false,
"parentOrderCodechannelName": null"flipkart",
"orderTime": "2020-10-16T20:22:28.000+0500:3000",
"orderType": "SO/STO/RTV",
"paymentMethodmessageId": "COD"12345,
"isPrioritypaymentMethod": true"COD",
"channelNameeventType": "channel1OUTWARD_ORDER_COMPLETE",
"channelTypeeventTime": "2020-10-16T20:22:28.000+00:00",
"omsOrderId": 1234,
"turnAroundTime": "MARKETPLACE2020-10-16T20:22:28.000+00:00",
"orderItemsvirtualSkuDefinitions": [
{
"orderItemCodevirtualParentChannelSkuId": "item1abc1",
"channelSkuCodevirtualParentBarcode": "sku1bar1",
"orderedQuantitychildSkus": 10,
[
"cancelledQuantity": 2, {
"channelDiscount": 1, "sellerDiscountchannelSkuCode": null,"xyz",
"sellingPricePerUnitqty": 302,
"giftChargePerUnitbarcode": 2.8, "bar23"
"shippingCharge": null},
"omsItemId": null,{
"barcodechannelSkuCode": "barcodeOrderItemxyz1",
} ], "eventTypeqty": "OUTWARD_ORDER_COMPLETE",1,
"eventTime": "2020-10-16T20:22:28.000+05:30", "shipmentsbarcode": ["bar34"
{ }
"shipmentCode": "shipment1", ]
"generatedInvoiceId }
],
"isSplitRequired": "invoiceId1false",
"shippingCharges": 20,
"generatedInvoiceDatechannelType": "2020-10-16T20:22:28.000+05:30",ERP",
"orderItems": [
{
"invoiceDocumentUrlorderItemCode": "https://storage.googleapis.com/dev-oltp-nextscm-com/1200027112/MANIFEST/77a9230b-c335-4d9c-b50b-c0d5a43ee24f.pdf"item123",
"channelSkuCode": "1000889888",
"shippingLabelDocumentUrlorderedQuantity": 2,
"cancelledQuantity"https://storage.googleapis.com/dev-oltp-nextscm-com/1200027112/MANIFEST/77a9230b-c335-4d9c-b50b-c0d5a43ee24f.pdf",
: 1,
"externalInvoiceIdchannelDiscount": "code1"50,
"externalInvoiceDatesellingPricePerUnit": "2020-10-16T20:22:28.000+05:30"500,
"irngiftChargePerUnit": "irn"10,
"qrCodesellerDiscount": 5,
"qrCodeshippingCharge": 0,
"shipmentStatusomsItemId": null123,
"shipmentItemsbarcode": ["barcode1",
"orderItemCustomAttributes": {
"channelSkuCodeattribute1": "sku1Value1",
"orderItemCodeattribute2": "item1Value2",
"channelDiscountattribute3": 1"Value3",
"netTaxAmountPerUnitattribute4": 1"Value4",
"netTaxAmountTotalattribute5": 10"Value5",
"baseSellingPricePerUnitattribute6": 29"Value6",
"baseSellingPriceTotalattribute7": 290"Value7",
"sellingPricePerUnitattribute8": 30"Value8",
"sellingPriceTotalattribute9": 300"Value9",
"quantitychannelMetadata": 10,
"{'key1':'value1','key2':'value2'}",
"shippingChargePerUnitattribute10": null,"Value10"
}
"taxItems": [}
],
"shipments": [
{
"shipmentCode": "UIfd897",
"typelocationCode": "Taxloc1",
"generatedInvoiceId": "AR105044395",
"rategeneratedInvoiceDate": 3"2020-10-16T20:22:28.000+00:00",
"externalInvoiceId": "FK56556GH45",
"taxPerUnitexternalInvoiceDate": 1"2020-10-16T20:22:28.000+00:00",
"invoiceDocumentUrl": "https://mybrand.com/invoice123.pdf",
"taxTotalshippingLabelDocumentUrl": 10"https://mybrand.com/sldoc.pdf",
"irn": "a429746e55b844c9d2cb2a6f68997d1c2af29987cc834f3b52da45d1b0bc97c9",
} "qrCode": "eyJhbGciPiJSUzI1NiIsImtpZCI6IkI4RDYzRUNCMThFQTVFNkY0QUKDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGcifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFPQ001MzI2SjFaWVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUJDUjE3MThFMVpMXCIsXCJEb2NOb1wiOlwiTUVhajIyLTIzLzUwNTlcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTMvMTAvMjAyMlwiLFwiVG90SW52VmFsXCI6MTgxNy4wNCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjYyMTE0MjkwXCIsXCJJcm5cIjpcImE0Mjk3NDZlMzRkODQ0YzlkMmNiMmE2ZjY4OTk3ZDFjMmFmMjM5ODdjYzgzNGYzYjUyZGE0NWQxYjBiYzk3YzlcIixcIklybkR0XCI6XCIyMDIyLTEwLTEzIDEyOjAxOjAwXCJ9IiwiaXNzIjoiTklDIn0.wvB7b15AnpdQdX_d0VZEyj9dL1qWDaOFPLRPrlV0V2XIu3cE3aQ3YtsWLnTnyrmtUlokpbkkE4folBQNhfzkCPlnODNxRPfpO-Kz9eyNpqcIEp-8TqvcDKXZ3PrBRqmNmner00AG_fVmmqT1HLiyKB2sqOnhqtCfQaQF-PGnqIOhal3PDxIMVt0WAtaQOIwwDA75dsjjnFHaZFPl9tFPR8A6Wrw4NhQH-7xhABKW3Z961a_rGmO6M3XP7jPHyYPW-QWMfTqwNXwxNdFgFePL5FloPiUipt2-g4FIplgm-YcN1xMvEQ2irAfzQwbnxi7UKz-jwOgM0Zy2BbburYgDvQ",
],
"shipmentStatus": "DELIVERED",
"barcodeawbNumber": "BarcodeShipmentItemawb1",
"shipmentItems": [
} ], {
"locationCode": null, "awbNumberchannelSkuCode": null,"100000789702",
"transporterorderItemCode": "transporteritem123",
"packageSkunetTaxAmountPerUnit": "packageSKU1",60,
"deliveredAtnetTaxAmountTotal": "2020-10-16T20:22:28.000+05:30"120,
} ], "shippingAddressbaseSellingPricePerUnit": {500,
"name": "name", "line1baseSellingPriceTotal": "address line 11", 1000,
"line2sellingPricePerUnit": "address line 21", 560,
"line3sellingPriceTotal": "address line 31", 1120,
"phonequantity": "9012345678"2,
"email": "email2@gmail.com", "cityshippingChargePerUnit": "Bengaluru"36,
"state": "Karnataka", "zipchannelDiscount": "560075"30,
"country": "India" }, "billingAddresstaxItems": {[
"name": "name", "line1": "address line{
1", "line2": "address line 2", "line3type": "SGST"address,
line 3", "phone": "9876543210", "emailrate": "email@gmail.com",
6,
"city": "Bengaluru", "state": "Karnataka", "ziptaxPerUnit": "560076"30,
"country": "India" }, "virtualSkuDefinitionstaxTotal": [], 60
},
{
"isSplitRequired": null, "shippingCharges": null, "omsOrderId": null, "turnAroundTimetype": "2020-10-18T20:22:28.000+05:30"
} |
...
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
...
omsOrderId
...
Long
...
Internal order id of OMS
...
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.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.shippingCharge
...
Double
...
Shipping charge
...
No
...
orderItems.barcode
...
String
...
Barcode
...
Yes
...
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.awbNumber
...
String
...
AWB number of shipment
...
No
...
shipments.shipmentItems
...
Object[]
...
Items belonging to this shipment
...
Yes
...
shipments.transporter
...
String
...
Transporter
...
No
...
shipments.packageSku
...
String
...
Package SKU
...
No
...
shipments.deliveredAt
...
String
...
Delivered Time
...
No
...
shipmentItems.channelSkuCode
...
String
...
SKU code of order item
...
Yes
...
shipments.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
...
shipmentItems.barcode
...
String
...
Barcode
...
"CGST",
"rate": 6,
"taxPerUnit": 30,
"taxTotal": 60
}
]
},
{
"channelSkuCode": "100000734701",
"orderItemCode": "item124",
"netTaxAmountPerUnit": 60,
"netTaxAmountTotal": 120,
"baseSellingPricePerUnit": 500,
"baseSellingPriceTotal": 1000,
"sellingPricePerUnit": 560,
"sellingPriceTotal": 1120,
"quantity": 2,
"shippingChargePerUnit": 36,
"channelDiscount": 30,
"taxItems": [
{
"type": "SGST",
"rate": 6,
"taxPerUnit": 30,
"taxTotal": 60
},
{
"type": "CGST",
"rate": 6,
"taxPerUnit": 30,
"taxTotal": 60
}
]
}
]
}
],
"shipmentDetails": {
"length": 30.0,
"breadth": 20.0,
"height": 10.0,
"weight": 5.0,
"shipmentId": 12345,
"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
}
]
}
]
},
"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"
},
"orderCustomAttributes": {
"attribute1": "Value1",
"attribute2": "Value2",
"attribute3": "Value3",
"attribute4": "Value4",
"attribute5": "Value5",
"attribute6": "Value6",
"attribute7": "Value7",
"attribute8": "Value8",
"attribute9": "Value9",
"attribute10": "Value10",
"channelMetadata": "{'totalCashOnDeliveryFee':'value1','paymentMethod':'value2'}",
"currency": "INR"
}
} |
Parameter Name | Data Type | Description | Mandatory |
| 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 |
| 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 |
| Boolean | Flag to identify wether an order is of priority or not | yes |
| String | Warehouse location from which order was fulfilled | Yes
|
| String | Unique code used by the channel to identify order | yes |
| 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 | 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 |
| Long | Internal order id of OMS | no |
| ZonedDateTime | Turnaround time | 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 |
| int | Ordered Quantity | yes |
| int | cancelledQuantity | yes |
| double | sellingPricePerUnit | yes |
| Double | giftChargePerUnit | no |
| Double | Discount provided by channel per unit | no |
| Double | Discount provided by seller per unit | no |
| Long | Internal item id of OMS | no |
| String | Barcode to identify a product | yes |
| Object | Custom attributes for order items | 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 | Custom attributes for an order | No |
| String | This is a string which contain the map of metadata(some extra attributes the ERP system wants in response) | No |
| String | Currency | 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 | QR code | no |
| String | Status of the shipment | no |
| String | AWB number of shipment | no |
| Object[] | Items belonging to this shipment | yes |
| String | SKU code of order item | yes |
| String | Fulfillment Location | yes |
| String | This is provided by the channel to uniquely identify each order item. | yes |
| Double | Per unit tax applicable for the SKU. | yes |
| 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 |
| Double | Channel discount of 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 | 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 | ||
| 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 | ||
| 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
turnAroundTime
String
Turn around time
no |
Response
| Code Block | language | json
|---|
{
"hasError": false,
"errorMessage":"message"
} |
HttpStatus : 200