Versions Compared

Version Old Version 5 New Version Current
Changes made by

Raghav Mehta

Alaf Azam Khan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 failre 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.

Note

Note: Now while creating inward order, system can pass handlingType feild as CROSS_DOCK if the inventory is to be cross docked. Before it was on box level as field Purpose which is now deprecated and will not be used.

Request

Code Block
languagejson
{
    "isAsnExpected": true,
    "locationCode": "Wid234",
    "orderCode": "H19304030003",
    "handlingType": "STORAGE"
    "orderItems": [
        {
            "channelSkuCode": "100005643",
            "orderItemCode": "item123",
            "orderItemCustomAttributes": {
                "attribute1": "Value1",
                "attribute2": "Value2",
                "attribute3": "Value3",
                "attribute4": "Value4",
                "attribute5": "Value5",
                "attribute6": "Value6",
                "attribute7": "Value7",
                "attribute8": "Value8",
                "attribute9": "Value9",
                "attribute10": "Value10",
                "channelMetadata": {
                    "custom_keys": "value"
                }
            },
            "quantity": 2,
            "sellingPricePerUnit": 1500
        }
    ],
    "orderTime": "2020-10-16T20:22:28.000+05:30",
    "orderType": "SO/STO/RTV/RPO",
    "parentOrderCode": "132",
    "partnerCode": "PUSH112",
    "partnerLocationCode": "UIH786",
    "taxBreakupForms": [
        {
            "channelSkuId": "sky1",
            "baseSellingPricePerUnit": 100.8,
            "taxItemForms": [
                {
                    "type": "CGST",
                    "rate": 1.2,
                    "taxPerUnit": 27.5
                }
            ]
        }
    ],
    "orderCustomAttributes": {
        "attribute1": "Value1",
        "attribute2": "Value2",
        "attribute3": "Value3",
        "attribute4": "Value4",
        "attribute5": "Value5",
        "attribute6": "Value6",
        "attribute7": "Value7",
        "attribute8": "Value8",
        "attribute9": "Value9",
        "attribute10": "Value10",
        "channelMetadata": {
            "custom_keys": "value"
        },
        "currency": "INR"
    }
}

 

Parameter Name

Data Type

Description

Mandatory

isAsnExpected

Boolean

Flag to determine if an ASN is expected against an inward order

No

parentOrderCode

String

Represents code of parent order of the order

No

orderTime

String

Time at which order got placed by customer

Yes

orderType

String

Possible values

  • PO (Purchase Order)

  • STO (Stock Transfer Order)

  • RO (Return Order)

  • OPEN_PO

  • OPEN_RO

Yes

orderCode

String

Unique code used by channel to identify the order

Yes

locationCode

String

Location code of the warehouse from where the order will get fulfilled

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

handlingType

String

CROSS_DOCK, STORAGE

Default : Storage

if this inventory is to be crossdocked then handling type cross dock has to be used.

taxBreakupForms

Object[ ]

Tax break up for the items

(if object is sent, all 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

orderItems

Object[ ]

Order Items list

if order type is OPEN_PO or OPEN_RO then non mandatory else mandatory

If this object is sent then all children fields must also be sent.

Conditional

orderItems.channelSkuCode

String

Channel SKUs expected to arrive

Yes

orderItems.quantity

Int

qty expected to arrive

Yes

orderItems.sellingPricePerUnit

Double

price per unit

Yes

orderItems.orderItemCode

String

Unique order item code of the item(This should be unique in an order)

Yes

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

This is an object of extra metadata fields which can be used in subsequent flows

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

This is an object of extra metadata fields which can be used in subsequent flows

No

orderCustomAttributes.currency

String

Currency

No

Response

Empty Body

HttpStatus Code

200

Steps to

...

Create Inward Order

Steps

  1. Create Vendor Master using Create Vendor Master API

  2. Create location of the vendor using Add Vendor Location Master API

  3. Create article master using Create Article Master API

...