Skip to end of banner
Go to start of banner

Create Outward Order API (Using Partner Codes)

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

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.

Request

{
	"parentOrderCode": "132",
	"locationCode": "Wid234",
	"orderCode": "H19304030003",
	"orderTime": "2020-10-16T20:22:28.000+05:30",
	"orderType": "SO/STO/RTV",
	"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": "PIECE",
	"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"
			}
		},
		{
			"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"
			}
		}
	],
	"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"
	}
}

 

Parameter Name

Data Type

Description

Mandatory

parentOrderCode

String

Represents the parent order of the order. This can be a additional identifier mapped to channelOrderCode

No

locationCode

String

Location code of warehouse 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

orderCode

String

Unique code used by channel to identify the order.

yes

orderTime

String

Time at which the Order got placed by customer or at the channel

yes

orderType

String

Possible value →

  • SO (Sales Order)

  • STO (Stock Transfer Order)

  • RTV (Return To Vendor)

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 from Store/Warehouse

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 sent 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 → Product identifier at channel

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

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

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/ZP/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

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

String

ChannelMetaData

no

orderCustomAttributes.currency

String

Currency

no

Response

Empty Body

HttpStatus Code

200

 

  • No labels