Inbound | POST | /orders/outward/partner-code

Summary

This API is used to create new outward orders in Increff Omni using partner codes.

Description

This API will create outward orders in Increff Omni using the partner codes provided in the payload. One payload will create only one order and one SKU can be present only once. The number of order items in an order should not be more than 2500.

<aside> 🗒️

Important Notes: Please note that the Custom Order or Order Item attribute key must be added in the OMS UI using screen Custom order/ line Item Attribute, else it can result into failure of order creation in Increff OMS system.
- In cases where the Custom order attribute key is not defined and custom order or order item attributes are part of the Inward/Outward order creation payloads then the order would move to FAILED status in CIMS.
The number of order items in an order should not be more than 2500. </aside>

Request

{
  "parentOrderCode": "132",
  "locationCode": "Wid234",
  "inventoryPool": "CommonInventory234",
  "orderCode": "H19304030003",
  "orderTime": "2020-10-16T20:22:28.000+05:30",
  "orderType": "SO",
  "onHold": false,
  "dispatchByTime": "2020-10-16T20:22:28.000+05:30",
  "startProcessingTime": "2020-10-16T20:22:28.000+05:30",
  "paymentMethod": "COD",
  "isSplitRequired": false,
  "taxBreakupForms": [
    {
      "channelSkuId": "sky1",
      "baseSellingPricePerUnit": 100.8,
      "taxItemForms": [
        {
          "type": "VAT",
          "rate": 1.2,
          "taxPerUnit": 27.5
        }
      ]
    }
  ],
  "packType": "BULK",
  "qcStatus": "PASS",
  "partnerCode": "partnerCode",
  "partnerLocationCode": "partnerLocationCode",
  "orderItems": [
    {
      "channelSkuCode": "100005643",
      "orderItemCode": "item123",
      "quantity": 2,
      "sellerDiscountPerUnit": 75,
      "channelDiscountPerUnit": 150,
      "sellingPricePerUnit": 1500,
      "shippingChargePerUnit": 50,
      "minExpiry": "2021-08-11",
      "giftOptions": {
        "giftwrapRequired": false,
        "giftMessage": "",
        "giftChargePerUnit": 0,
        "giftDocument": "abc",
        "giftDocumentFormat": "PDF"
      },
      "orderItemCustomAttributes": {
        "attribute1": "Value1",
        "attribute2": "Value2",
        "attribute3": "Value3",
        "attribute4": "Value4",
        "attribute5": "Value5",
        "attribute6": "Value6",
        "attribute7": "Value7",
        "attribute8": "Value8",
        "attribute9": "Value9",
        "attribute10": "Value10",
        "channelMetadata": {
          "totalCashOnDeliveryFee": 0,
          "department": "HR",
          "paymentMethod": "ccavenue",
          "status": "processing"
        }
      }
    },
    {
      "channelSkuCode": "100005644",
      "orderItemCode": "item124",
      "quantity": 2,
      "sellerDiscountPerUnit": 50,
      "channelDiscountPerUnit": 100,
      "sellingPricePerUnit": 1000,
      "shippingChargePerUnit": 40,
      "minExpiry": "2021-08-11",
      "giftOptions": {
        "giftwrapRequired": false,
        "giftMessage": "",
        "giftChargePerUnit": 0,
        "giftDocument": "abc",
        "giftDocumentFormat": "PDF"
      },
      "orderItemCustomAttributes": {
        "attribute1": "Value12",
        "attribute2": "Value22",
        "attribute3": "Value32",
        "attribute4": "Value42",
        "attribute5": "Value52",
        "attribute6": "Value62",
        "attribute7": "Value72",
        "attribute8": "Value82",
        "attribute9": "Value92",
        "attribute10": "Value102",
        "channelMetadata": {
          "totalCashOnDeliveryFee": 0,
          "department": "HR",
          "paymentMethod": "ccavenue",
          "status": "processing"
        }
      }
    }
  ],
  "orderCustomAttributes": {
    "attribute1": "Value1",
    "attribute2": "Value2",
    "attribute3": "Value3",
    "attribute4": "Value4",
    "attribute5": "Value5",
    "attribute6": "Value6",
    "attribute7": "Value7",
    "attribute8": "Value8",
    "attribute9": "Value9",
    "attribute10": "Value10",
    "channelMetadata": {
      "totalCashOnDeliveryFee": 0,
      "department": "HR",
      "paymentMethod": "ccavenue",
      "status": "processing"
    },
    "currency": "INR"
  }
}

Parameter Name	Data Type	Description	Mandatory
`parentOrderCode`	String	Represents code of parent order of the order	No
`locationCode`	String	Location code of warehouse/store from where this order will get fulfilled.
Location Code is non-mandatory when Increff OMS is doing splitting and routing of the orders , else it’s a mandatory field.	No
`inventoryPool`	String	Identifier for OMS Inventory pool where the outward order should be created for.	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	Denotes the type of order.
Possible values
• SO (Sales Order)
• STO (Stock Transfer Order)
• RTV (Return To Vendor)
• CRD (Cross Dock)	Yes
`partnerCode`	String	This represents the partner from which order will come.
If Order is of type PO/STO, this field represents vendor's code
If Order is of type RO, this field represents customer’s code	Yes
`partnerLocationCode`	String	This represents the partner’s location from which order will come.
If Order is of type PO/STO, this field represents vendor location’s code
If Order is of type RO, this field represents customer location’s code	Yes
`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	Yes
`taxBreakupForms`	Object[ ]	Tax break up for the items(if this is sent, al the fields of the object should be sent)	No
`taxBreakupForms.channelSkuId`	String	Channel Sku id	Yes
`taxBreakupForms.baseSellingPricePerUnit`	Double	Base selling price per unit of the Sku	Yes
`taxBreakupForms.taxItemForms`	Object[ ]	Distribution of tax with tax type	Yes
`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 : PASS	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.orderItemCode`	String	This is provided by the channel to uniquely identify each order item.
This should be unique in an order.	Yes
`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. Required only for Perishable SKUs. Don't send if SKU is non perishable.	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

Response

Empty Body

HttpStatus Code

200