Inbound | POST | /orders/outward

Summary

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

Description

This API will create outward orders in Increff Omni. 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.

Note: 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.

Request

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/RTV/RPOPO",
	  "isPriorityonHold": false,
  	"giftisPriority": falsetrue,
  	"onHoldgift": falsetrue,
	  "qcStatus": "PASS",
  	"dispatchByTime": "20202024-1002-16T2015T14:22:28.000+05:3030:00Z",
 	 "startProcessingTime": "20202024-1002-16T2013T10:22:28.000+05:3000:00Z",
  	"paymentMethod": "COD",
	"isSplitRequired": false, 	"taxBreakupFormsshippingAddress": [{
    		"channelSkuIdname": "sky1Jane Smith",
		"baseSellingPricePerUnit": 100.8, 		"taxItemForms": [{ 			"typeline1": "CGST456 Oak Street",
			"rate": 1.2,
			"taxPerUnit": 27.5
		}]
	}],
	"packType": "PIECE",
	"shippingAddress": {
		"name": "customerName",
		"line1": "address line 1",
		"line2": "address line 2",
		"line3": "address line 3",
		
    "line2": "Suite 789",
    "line3": "Tower D",
    "phone": "+1-555-987-6543",
    "email": "jane.smith@example.com",
    "city": "BengaluruGotham",
		    "state": "KarnatakaNY",
    		"zip": "56007610001",
		    "country": "INDIA",
		"email": "email.com",
		"phone": "9999999999"
	},
	United States"
  },
  "billingAddress": {
		    "name": "customerNameJohn Doe",
  		  "line1": "address123 lineMain 1Street",
		    "line2": "addressApt line 2456",
		    "line3": "addressBuilding line 3C",
    		"cityphone": "Bengaluru+1-555-123-4567",
		"state    "email": "Karnatakajohn.doe@example.com",
		"zip    "city": "560076Metropolis",
   		 "countrystate": "INDIACA",
    		"emailzip": "email.com90001",
    		"phonecountry": "9999999999United States"
 	 },
	  "orderItems": [
    {
			
      "channelSkuCode": "100005643SKU-001",
			
      "orderItemCode": "item123ITEM-001",
			
      "quantity": 2,
			      "sellerDiscountPerUnit": 753.00,
			      "channelDiscountPerUnit": 150,
			5.00,
      "sellingPricePerUnit": 150020.00,
			      "shippingChargePerUnit": 50,
			"minExpiry": "2021-08-11",
			8.00,
      "giftOptions": {
				
        "giftwrapRequired": falsetrue,
				        "giftMessage": "Happy Birthday!",
				        "giftChargePerUnit": 02.50,
				
        "giftDocument": "abcgift_document.pdf",
				        "giftDocumentFormat": "PDF"
			},
			
      },
      "minExpiry": "2025-01-01",
      "orderItemCustomAttributes": {
				
        "attribute1": "Value1value1",
				        "attribute2": "Value2value2",
				        "attribute3": "Value3value3",
				
        "attribute4": "Value4value4",
				
        "attribute5": "Value5value5",
				
        "attribute6": "Value6value6",
				
        "attribute7": "Value7value7",
				
        "attribute8": "Value8value8",
				
        "attribute9": "Value9value9",
				        "attribute10": "Value10"
			}
		},
		{
			"channelSkuCodevalue10",
        "channelMetadata": {"100005644key", 			"orderItemCode": "item124",
			"quantity": 2,
			"sellerDiscountPerUnit": 50,
			"channelDiscountPerUnit": 100,
			"sellingPricePerUnit": 1000,
			"shippingChargePerUnit": 50,
			"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"
			}
		}
	],
	"orderCustomAttributes": {
		"attribute1": "Value1",
		"attribute2": "Value2",
		"attribute3": "Value3",
		"attribute4": "Value4",
		"attribute5": "Value5",
		"attribute6": "Value6",
		"attribute7": "Value7",
		"attribute8": "Value8",
		"attribute9": "Value9",
		"attribute10": "Value10",
		"channelMetadata": "Sample Metadata",
		"currency": "INR"
	}
}value"}
      }
    }
  ],
  "taxBreakupForms": [
    {
      "channelSkuId": "SKU-001",
      "baseSellingPricePerUnit": 25.00,
      "taxItemForms": [
        {
          "type": "VAT",
          "rate": 8.5,
          "taxPerUnit": 2.13
        }
      ]
    }
  ],
  "packType": "PIECE",
  "isSplitRequired": true,
  "orderCustomAttributes": {
    "attribute1": "value1",
    "attribute2": "value2",
    "attribute3": "value3",
    "attribute4": "value4",
    "attribute5": "value5",
    "attribute6": "value6",
    "attribute7": "value7",
    "attribute8": "value8",
    "attribute9": "value9",
    "attribute10": "value10",
    "channelMetadata": {},
    "currency": "USD"
  }
}

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)

SALES PURCHASE STOCK_TRANSFER REPLACEMENT RETURN OPEN_PO OPEN_RETURN CROSS_DOCK	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

Yes
`dispatchByTime`	String	Time by which the order is expected to get dispatched

yes

Yes
`startProcessingTime`	String	Time by which the order processing is expected to get started

yes

Yes
`paymentMethod`	String	Possible values → COD/NCOD

yes

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

No

taxBreakupForms

Object[ ]

Tax break up for the items

(if this is sent, all the fields of the object should be sent)

noyes

No
`taxBreakupForms.channelSkuId`	String

Channel SKU ID

Unique code to identify SKU on channel	Yes
`taxBreakupForms.baseSellingPricePerUnit`	Double	Base selling price per unit of the SKU

yes

Yes
`taxBreakupForms.taxItemForms`	Object[ ]	Distribution of tax with tax type

yes

No
`taxItemForms.type`	String	Type of tax applicable

yes

Yes
`taxItemForms.rate`	Double	Tax rate for this tax type

yes

Yes
`taxItemForms.taxPerUnit`	Double	Tax applicable for this type of tax per unit

yes

Yes
`packType`	String	Possible values → PIECE/BULK

no

No

qcStatus

String

Possible values → PASS, FAIL

By default value will be PASS

Yes

shippingAddress

Object

Shipping address of the customer

yes

Yes
`shippingAddress.name`	String	Name of customer

yes

No
`shippingAddress.line1`	String	1st line of customer’s address

yes

No
`shippingAddress.line2`	String	2nd line of customer’s address

no

No
`shippingAddress.line3`	String	3rd line of customer’s address

no

No
`shippingAddress.city`	String	City of customer

yes

No
`shippingAddress.state`	String	State of customer

yes

No
`shippingAddress.zip`	String	ZIP/Pin code of customer

yes

Yes
`shippingAddress.country`	String	Country of customer

yes

Yes
`shippingAddress.email`	String	Email of customer

yes

No
`shippingAddress.phone`	String	Phone Number of customer

no

No
`billingAddress`	Object	Billing address of the customer

yes

Yes
`billingAddress.name`	String	Name of customer

yes

No
`billingAddress.line1`	String	1st line of customer’s address

yes

No
`billingAddress.line2`	String	2nd line of customer’s address

no

No
`billingAddress.line3`	String	3rd line of customer’s address

no

No
`billingAddress.city`	String	City of customer

yes

No
`billingAddress.state`	String	State of customer

yes

No
`billingAddress.zip`	String	ZIP/Pin code of customer

yes

Yes
`billingAddress.country`	String	Country of customer

yes

Yes
`billingAddress.email`	String	Email of customer

yes

No
`billingAddress.phone`	String	Phone Number of customer

no

No
`orderItems`	Object[]	List of items for which order is being placed

yes

Yes
`orderItems.channelSkuCode`	String	SKU code of order item on channel

yes

Yes
`orderItems.orderItemCode`	String	This is provided by the channel to uniquely identify each order item. This should be unique in an order

yes

Yes
`orderItems.quantity`	Integer	Quantity of SKU in the order placed

yes

Yes
`orderItems.sellerDiscountPerUnit`	Double	Discount given by seller on SKU per unit

no

No
`orderItems.channelDiscountPerUnit`	Double	Discount given by channel on SKU per unit

no

No
`orderItems.sellingPricePerUnit`	Double	Unit price of SKU including tax

yes

Yes
`orderItems.shippingChargePerUnit`	Double	Shipping charge on item per unit

no

No
`orderItems.minExpiry`	String	Minimum expiry date for the item to be shipped

no

No
`orderItems.giftOptions`	Object	Contains gift details of the item

no

No
`giftOptions.giftwrapRequired`	Boolean	To specify if gift wrap is required

yes

Yes
`giftOptions.giftMessage`	String	Gift message

no

No
`giftOptions.giftChargePerUnit`	Double	Gift charge on item per unit

no

No
`giftOptions.giftDocument`	String	Base64 encoded string

no

No

giftOptions.giftDocumentFormat

String

Possible values →

PDF/ ZPL / PNG.

(To be populated if document is present)

no

No
`orderItems.orderItemCustomAttributes`	Object	Custom attributes for an order Item

no

No
`orderItemCustomAttributes.attribute1`	String	Custom attribute 1

no

No
`orderItemCustomAttributes.attribute2`	String	Custom attribute 2

no

No
`orderItemCustomAttributes.attribute3`	String	Custom attribute 3

no

No
`orderItemCustomAttributes.attribute4`	String	Custom attribute 4

no

No
`orderItemCustomAttributes.attribute5`	String	Custom attribute 5

no

No
`orderItemCustomAttributes.attribute6`	String	Custom attribute 6

no

No
`orderItemCustomAttributes.attribute7`	String	Custom attribute 7

no

No
`orderItemCustomAttributes.attribute8`	String	Custom attribute 8

no

No
`orderItemCustomAttributes.attribute9`	String	Custom attribute 9

no

No
`orderItemCustomAttributes.attribute10`	String	Custom attribute 10

no

	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

No
`orderCustomAttributes.attribute1`	String	Custom attribute 1

no

No
`orderCustomAttributes.attribute2`	String	Custom attribute 2

no

No
`orderCustomAttributes.attribute3`	String	Custom attribute 3

no

No
`orderCustomAttributes.attribute4`	String	Custom attribute 4

no

No
`orderCustomAttributes.attribute5`	String	Custom attribute 5

no

No
`orderCustomAttributes.attribute6`	String	Custom attribute 6

no

No
`orderCustomAttributes.attribute7`	String	Custom attribute 7

no

No
`orderCustomAttributes.attribute8`	String	Custom attribute 8

no

No
`orderCustomAttributes.attribute9`	String	Custom attribute 9

no

No
`orderCustomAttributes.attribute10`	String	Custom attribute 10

nono

No

orderCustomAttributes.channelMetaData

String

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

No

Response

Empty Body

Versions Compared

Old Version 1

New Version Current

Key

Inbound | POST | /orders/outward

Summary

Description

Request

Response

HttpStatusCode

200

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Inbound | POST | /orders/outward

Summary

Description

Request

Response

HttpStatusCode

200