Inbound | PUT | /orders/inwards/{orderCode}

Summary

This API can be used by an ERP to update an inward order created in Increff.

To know more details, Please refer to PO Amendment Support in Increff Omni

Description

  1. This API can be used by an ERP to update Order line items for a certain Inward order

  2. The new Inward Order Line Items replace the existing Inward Order Line Items after some validations.

  3. Update for any Inward Order is allowed till the Inward Order is moved to LOCKED State.

  4. To move an Inward Order to Locked state, ERP can use

    Lock Inward Order API | Inbound-|PUT|/orders/inward/{orderCode}/{locationCode}

  5. Once an order is LOCKED , it can not be updated.

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.

Thus, Update Inward Order API would also need definition of Custom Order or Order Item attribute key in OMS beforehand.

Path Parameter

Parameter Name Data Type Description Mandatory
orderCode String Code to uniquely identify of the order in consideration Yes

Request Body

{
    "locationCode": "locationCode1",
    "orderItems": [
        {
            "orderItemCode": 123354353,
            "channelSkuCode": "tshirt134",
            "orderedQuantity": 500,
            "sellingPricePerUnit": 230,
            "orderItemCustomAttributes": {
                "attribute1": "value1",
                "attribute2": "value2",
                "attribute3": "value3",
                "attribute4": "value4",
                "attribute5": "value5",
                "attribute6": "value6",
                "attribute7": "value7",
                "attribute8": "value8",
                "attribute9": "value9",
                "attribute10": "value10",
                "channelMetadata": {
                    "key1": "value1"
                }
            }
        },
        {
            "orderItemCode": 32423544,
            "channelSkuCode": "jeans123",
            "orderedQuantity": 500,
            "sellingPricePerUnit": 230,
            "orderItemCustomAttributes": {
                "attribute1": "value1",
                "attribute2": "value2",
                "attribute3": "value3",
                "attribute4": "value4",
                "attribute5": "value5",
                "attribute6": "value6",
                "attribute7": "value7",
                "attribute8": "value8",
                "attribute9": "value9",
                "attribute10": "value10",
                "channelMetadata": {
                    "key1": "value1"
                }
            }
        }
    ],
    "taxBreakUpForms": null,
    "orderCustomAttributes": {
        "attribute1": "value1",
        "attribute2": "value2",
        "attribute3": "value3",
        "attribute4": "value4",
        "attribute5": "value5",
        "attribute6": "value6",
        "attribute7": "value7",
        "attribute8": "value8",
        "attribute9": "value9",
        "attribute10": "value10",
        "channelMetadata": {
            "key1": "value1"
        },
        "currency": "USD"
    }
}
Parameter Name Data Type Description Mandatory
locationCode String Location code of the warehouse where this order is created Yes
orderItems List<UpdateInwardOrderClientLineItemForm> List of all the line items in the order that is to be updated Yes
orderItems.orderItemCode String Item code to identify a line item Yes
orderItems.channelSkuCode String Channel SKU code to uniquely identify the product Yes
orderItems.orderedQuantity Integer Revised quantity of the line item in consideration Yes(min 1)
orderItems.sellingPricePerUnit Double Revised cost price of the line item in consideration Yes
orderItems.orderItemCustomAttributes Object Custom attributes for an order item No
orderItemCustomAttributes.attribute1 String A custom attribute for an item No
orderItemCustomAttributes.attribute2 String A custom attribute for an item No
orderItemCustomAttributes.attribute3 String A custom attribute for an item No
orderItemCustomAttributes.attribute4 String A custom attribute for an item No
orderItemCustomAttributes.attribute5 String A custom attribute for an item No
orderItemCustomAttributes.attribute6 String A custom attribute for an item No
orderItemCustomAttributes.attribute7 String A custom attribute for an item No
orderItemCustomAttributes.attribute8 String A custom attribute for an item No
orderItemCustomAttributes.attribute9 String A custom attribute for an item No
orderItemCustomAttributes.attribute10 String A custom attribute for an item No
orderItemCustomAttributes.channelMetaData Object Meta data for an order item on channel No
taxBreakupForms List<TaxBreakupClientForm> List of tax break ups. No
taxBreakupForms.channelSkuId String Code to uniquely identify an SKU. Yes
taxBreakupForms.baseSellingPricePerUnit Double Base selling price of an SKU. Yes
taxBreakupForms.taxItemForms List<SubTaxItemClientForm> List of forms containing tax details charged on a particular SKU. No
taxBreakupForms.taxItemForms.type String Type of tax being applied. Yes
taxBreakupForms.taxItemForms.rate Double Tax rate Yes
taxBreakupForms.taxItemForms.taxPerUnit Double Tax on a single SKU Yes
orderCustomAttributes Object Custom attributes for an order No
orderCustomAttributes.attribute1 String A custom attribute for an order No
orderCustomAttributes.attribute2 String A custom attribute for an order No
orderCustomAttributes.attribute3 String A custom attribute for an order No
orderCustomAttributes.attribute4 String A custom attribute for an order No
orderCustomAttributes.attribute5 String A custom attribute for an order No
orderCustomAttributes.attribute6 String A custom attribute for an order No
orderCustomAttributes.attribute7 String A custom attribute for an order No
orderCustomAttributes.attribute8 String A custom attribute for an order No
orderCustomAttributes.attribute9 String A custom attribute for an order No
orderCustomAttributes.attribute10 String A custom attribute for an order No
orderCustomAttributes.channelMetaData Object Meta data for an order on channel No
orderCustomAttributes.currency String Currency No

Response Body