Page Comparison

...

Code Block

breakoutMode	wide
language	json

{
  "parentOrderCode": "132PARENT-ORD-789",
  "locationCode": "Wid234WAREHOUSE-001",
  "orderCode": "H19304030003ORD-123456",
  "orderTime": "20202024-1002-16T2013T09:22:28.000+05:3045:00Z",
  "orderType": "SO/STO/RTVPO",
  "onHold": false,
  "dispatchByTimeisPriority": "2020-10-16T20:22:28.000+05:30"true,
  "startProcessingTimegift": "2020-10-16T20:22:28.000+05:30"true,
  "paymentMethodqcStatus": "CODPASS",
  "isSplitRequireddispatchByTime": false"2024-02-15T14:30:00Z",
  "taxBreakupFormsstartProcessingTime": [
    {
      "channelSkuId": "sky1",
    "2024-02-13T10:00:00Z",
  "baseSellingPricePerUnitpaymentMethod": 100.8,
"COD",
     "taxItemFormsshippingAddress": [
        {
          "type"name": "VATJane Smith",
     
    "rateline1": 1.2,
 "456 Oak Street",
        "taxPerUnitline2": 27.5
        }
      ]
    }"Suite 789",
  ],   "packTypeline3": "PIECETower D",
    "qcStatusphone": "PASS+1-555-987-6543",
 
"partnerCode": "partnerCode",   "partnerLocationCodeemail": "partnerLocationCodejane.smith@example.com",
  "orderItems": [
    {
      "channelSkuCode"city": "100005643Gotham",

     "orderItemCodestate": "item123NY",
      "quantityzip": 2,
      "sellerDiscountPerUnit10001": 75,
      "channelDiscountPerUnitcountry": 150,"United States"
  },
  "sellingPricePerUnitbillingAddress": 1500,
 {
    "shippingChargePerUnitname": 50,
      "minExpiry":John Doe"2021-08-11",
      "giftOptionsline1": {"123         "giftwrapRequired": false,
   Main Street",
    "giftMessageline2": "Apt 456",
   
    "giftChargePerUnitline3": "Building 0C",
        "giftDocumentphone": "abc+1-555-123-4567",
        "giftDocumentFormatemail": "PDF"
      }john.doe@example.com",
      "orderItemCustomAttributescity": {
"Metropolis",
       "attribute1state": "Value1CA",
   
    "attribute2zip": "Value290001",
        "attribute3country": "Value3United States",
    },
   "attribute4orderItems": "Value4",[
        "attribute5": "Value5",
 {
      "attribute6channelSkuCode": "Value6SKU-001",
 
      "attribute7orderItemCode": "Value7ITEM-001",
        "attribute8quantity": "Value8"2,
        "attribute9sellerDiscountPerUnit": "Value9",
 3.00,
      "attribute10channelDiscountPerUnit": "Value10"5.00,
        "channelMetadatasellingPricePerUnit": {
20.00,
         "totalCashOnDeliveryFeeshippingChargePerUnit": 0,
   8.00,
      "departmentgiftOptions": "HR",{
          "paymentMethodgiftwrapRequired": "ccavenue"true,
 
        "statusgiftMessage": "processing"
        }
      }
    }Happy Birthday!",
    {
      "channelSkuCodegiftChargePerUnit": "100005644",2.50,
        "orderItemCodegiftDocument": "item124gift_document.pdf",
      "quantity": 2,
      "sellerDiscountPerUnitgiftDocumentFormat": 50,
      "channelDiscountPerUnit": 100,"PDF"
       "sellingPricePerUnit": 1000},
      "shippingChargePerUnit": 40,
      "minExpiry": "20212025-0801-1101",
      "giftOptionsorderItemCustomAttributes": {
        "giftwrapRequiredattribute1": false"value1",
        "giftMessageattribute2": "value2",
        "giftChargePerUnitattribute3": 0"value3",
        "giftDocumentattribute4": "abcvalue4",
        "giftDocumentFormatattribute5": "PDFvalue5",
      },       "orderItemCustomAttributesattribute6": {"value6",
        "attribute1attribute7": "Value12value7",
        "attribute2attribute8": "Value22value8",
        "attribute3attribute9": "Value32value9",
        "attribute4attribute10": "Value42value10",
        "attribute5channelMetadata": {"Value52key",
        "attribute6": "Value62value",}
      }
 "attribute7": "Value72",  }
  ],
   "attribute8taxBreakupForms": "Value82", [
    {
      "attribute9channelSkuId": "Value92SKU-001",
        "attribute10baseSellingPricePerUnit": "Value102",
25.00,
       "channelMetadatataxItemForms": {[
          "totalCashOnDeliveryFee": 0,{
          "departmenttype": "HRVAT",
          "paymentMethodrate": "ccavenue"8.5,
          "statustaxPerUnit": "processing"2.13
        }
      }]
    }
  ],
  "orderCustomAttributespackType": {
    "attribute1": "Value1",
 PIECE",
  "attribute2isSplitRequired": "Value2"true,
 
  "attribute3orderCustomAttributes": "Value3",{
    "attribute4attribute1": "Value4value1",
    "attribute5attribute2": "Value5value2",
    "attribute6attribute3": "Value6value3",
    "attribute7attribute4": "Value7value4",
    "attribute8attribute5": "Value8value5",
    "attribute9attribute6": "Value9value6",
    "attribute10attribute7": "Value10value7",
    "channelMetadataattribute8": {
      "totalCashOnDeliveryFeevalue8": 0,
      "departmentattribute9": "HRvalue9",
 
    "paymentMethodattribute10": "ccavenuevalue10",

     "statuschannelMetadata": "processing"
    {},
    "currency": "INRUSD"
  }
}

Parameter Name	Data Type	Description	Mandatory
`parentOrderCode`	String	Represents code of parent order of the order	No
`locationCode`	String	Location code of warehouse from where this order will get fulfilled Note: Location code must be provided in case the isSplitRequired field is false	No
`orderCode`	String	Unique code used by channel to identify the order	Yes
`orderTime`	String	Time at which order got placed by customer	Yes
`orderType`	String	Possible values → SO (Sales Order) STO (Stock Transfer Order) RTV (Return To Vendor) RPO(Replacement)	Yes
`isPriority`	Boolean	This flag is true in case order is having High priority than normal orders.	No
`gift`	Boolean	This flag is true in case order is a gift and needs to be gift wrapped.	No
`onHold`	Boolean	This flag is true in case order has to be kept on hold. Processing starts only after call is made to unhold the order	Yes
`dispatchByTime`	String	Time by which the order is expected to get dispatched	Yes
`startProcessingTime`	String	Time by which the order processing is expected to get started	Yes
`paymentMethod`	String	Possible values → COD/NCOD	Yes
`isSplitRequired`	Boolean	This flag is true when WMS has to split the order. If this variable is TRUE , then LocationCode should be send as NULL	YesNo
`taxBreakupForms`	Object[ ]	Tax break up for the items (if this is sent, all the fields of the object should be sent)	No
`taxBreakupForms.channelSkuId`	StringChannel	SKU IDUnique code to identify SKU on channel	Yes
`taxBreakupForms.baseSellingPricePerUnit`	Double	Base selling price per unit of the SKU	Yes
`taxBreakupForms.taxItemForms`	Object[ ]	Distribution of tax with tax type	YesNo
`taxItemForms.type`	String	Type of tax applicable	Yes
`taxItemForms.rate`	Double	Tax rate for this tax type	Yes
`taxItemForms.taxPerUnit`	Double	Tax applicable for this type of tax per unit	Yes
`packType`	String	Possible values → PIECE/BULK	No
`qcStatus`	String	Possible values → PASS, FAIL By default value will be PASS	Yes
`shippingAddress`	Object	Shipping address of the customer	Yes
`shippingAddress.name`	String	Name of customer	YesNo
`shippingAddress.line1`	String	1st line of customer’s address	YesNo
`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	YesNo
`shippingAddress.state`	String	State of customer	YesNo
`shippingAddress.zip`	String	ZIP/Pin code of customer	Yes
`shippingAddress.country`	String	Country of customer	Yes
`shippingAddress.email`	String	Email of customer	YesNo
`shippingAddress.phone`	String	Phone Number of customer	No
`billingAddress`	Object	Billing address of the customer	Yes
`billingAddress.name`	String	Name of customer	YesNo
`billingAddress.line1`	String	1st line of customer’s address	YesNo
`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	YesNo
`billingAddress.state`	String	State of customer	YesNo
`billingAddress.zip`	String	ZIP/Pin code of customer	Yes
`billingAddress.country`	String	Country of customer	Yes
`billingAddress.email`	String	Email of customer	YesNo
`billingAddress.phone`	String	Phone Number of customer	No
`orderItems`	Object[]	List of items for which order is being placed	Yes
`orderItems.channelSkuCode`	String	SKU code of order item on channel	Yes
`orderItems.orderItemCode`	String	This is provided by the channel to uniquely identify each order item. This should be unique in an order	Yes
`orderItems.quantity`	Integer	Quantity of SKU in the order placed	Yes
`orderItems.sellerDiscountPerUnit`	Double	Discount given by seller on SKU per unit	No
`orderItems.channelDiscountPerUnit`	Double	Discount given by channel on SKU per unit	No
`orderItems.sellingPricePerUnit`	Double	Unit price of SKU including tax	Yes
`orderItems.shippingChargePerUnit`	Double	Shipping charge on item per unit	No
`orderItems.minExpiry`	String	Minimum expiry date for the item to be shipped	No
`orderItems.giftOptions`	Object	Contains gift details of the item	No
`giftOptions.giftwrapRequired`	Boolean	To specify if gift wrap is required	Yes
`giftOptions.giftMessage`	String	Gift message	No
`giftOptions.giftChargePerUnit`	Double	Gift charge on item per unit	No
`giftOptions.giftDocument`	String	Base64 encoded string	No
`giftOptions.giftDocumentFormat`	String	Possible values → PDF/ ZPL / PNG. (To be populated if document is present)	No
`orderItems.orderItemCustomAttributes`	Object	Custom attributes for an order Item	No
`orderItemCustomAttributes.attribute1`	String	Custom attribute 1	No
`orderItemCustomAttributes.attribute2`	String	Custom attribute 2	No
`orderItemCustomAttributes.attribute3`	String	Custom attribute 3	No
`orderItemCustomAttributes.attribute4`	String	Custom attribute 4	No
`orderItemCustomAttributes.attribute5`	String	Custom attribute 5	No
`orderItemCustomAttributes.attribute6`	String	Custom attribute 6	No
`orderItemCustomAttributes.attribute7`	String	Custom attribute 7	No
`orderItemCustomAttributes.attribute8`	String	Custom attribute 8	No
`orderItemCustomAttributes.attribute9`	String	Custom attribute 9	No
`orderItemCustomAttributes.attribute10`	String	Custom attribute 10	No
orderItemCustomAttributes.channelMetaData	Object	These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows	No
`orderCustomAttributes`	Object	Custom attributes for an 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.channelMetaData`	Object	These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows	No
`orderCustomAttributes.currency`	String	Currency	No

...

Versions Compared

Old Version 7

New Version 8

Key