Versions Compared

Key

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

...

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

Summary

This API can be used by an ERP to update a certain inward order created in CIMS.

...

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

Request

...

Path Parameter

Parameter Name

Data Type

Description

Mandatory

orderCode

String

Code to uniquely identify of the order in consideration

yes

 

Request Body

Code Block
{
  "locationCode": "locationCode1",
  "orderItems": [
    {
      "orderItemCode": null,
      "channelSkuCode": "tshirt134",
      "orderedQuantity": 500,
      "costPrice": 230
    },
    {
      "orderItemCode": null,
      "channelSkuCode": "jeans123",
      "orderedQuantity": 500,
      "costPrice": 230
    }
  ],
"taxBreakUpForms": null
}

 

UpdateInwardOrderClientForm

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

code to identify a line item

Yes

orderItems.channelSkuCode

String

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

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

...

Response

Response Body

Code Block
Emtpy

...