Inbound | POST | /orders/inward

Summary

This API is used to create inward orders in Increff Omni.

Description

This API will create inward orders in Increff Omni. One payload will create only one order and one SKU can be present only once.

<aside> ℹ️ Now you can also create the Inward Orders by passing some Custom attributes along with the order which can be stored and used in different ways in Increff system.

</aside>

<aside> 🗒️ 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.

</aside>

<aside> ⚠️ Note: Now while creating inward order, system can pass handlingType field as CROSS_DOCK if the inventory is to be cross docked. Earlier field Purpose was used which is now deprecated and will not be used in fut

</aside>

Request

{
    "isAsnExpected": true,
    "isSampleQcAllowed" : true,
    "minInspectPercent" : 30,
    "minPassPercent" : 10,
    "locationCode": "Loc-234",
    "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",
    "strategyName" : "Strategy 1",
    "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
`isSampleQcAllowed`	`Boolean`	Flag to determine sample-based quality checks are allowed for this inward order.	No
`minInspectPercent`	`Integer`	Specifies the minimum percentage of items that need to be inspected if sample QC is allowed.	No
`minPassPercent`	`Integer`	Defines the minimum percentage of inspected items that must pass the QC for the batch to be considered acceptable.	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`

Response

Empty Body

Http Status Code

200

<aside> ℹ️

Checklist to be completed before creating inward orders in Increff system

Steps

Create Vendor Master using Create Vendor Master API
Create location of the vendor using Add Vendor Location Master API
Create article master using Create Article Master API
Create an inward order using Create Inward Order API </aside>