Versions Compared

Key

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

Inbound | POST  | /orders/inward

...

Code Block
languagejson
{
    "parentOrderCode": "132",
    "orderTime": "2020-10-16T20:22:28.000+05:30",
    "orderType": "OPEN_PO",
    "orderCode": "sap123",
    "locationCode": "locationCode",
    "partnerCode": "partnerCode",
    "partnerLocationCode": "partnerLocationCode",
    "taxBreakupForms": [
        {
            "channelSkuId": "sky1",
            "baseSellingPricePerUnit": 100.8,
            "taxItemForms": [
                {
                    "type": "VAT",
                    "rate": 1.2,
                    "taxPerUnit": 27.5
                }
            ]
        }
    ],
    "orderItems": [
        {
            "channelSkuCode": "tshirt134",
            "quantity": 500,
            "sellingPricePerUnit": 230.00,
            "orderItemCode": "item1"
        },
        {
            "channelSkuCode": "jeans123",
            "quantity": 500,
            "sellingPricePerUnit": 230.00,
            "orderItemCode": "item2"
        }
    ]
}

 

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

Parameter Name

Data Type

Description

Mandatory

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

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

Response

Empty Body

HttpStatus Code

200

Steps to create Inward Order

...