Versions Compared

Old Version 1

changes.mady.by.user Raghav Mehta

Saved on

compared with

New Version 2

changes.mady.by.user Raghav Mehta

Saved on

Key

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

...

  • Since now external systems can push Outward order with custom attributes tagged to it which can be stored and used in Increff systems in multiple ways.

  • This API can be used to update the value of any Custom attribute which was passed with an Outward order during Outward order creation from external system.

Parameter

Name

Data type

Description

Mandatory

orderCode

String

order code

Yes

Request

Request Body

Code Block
languagejson
{
	"locationCode": "test_77847b22cdc5",
	"updateOrderAttributes": {
		"attribute1": "test_4e10f67e0585",
		"attribute2": "test_df7f45161dbf",
		"attribute3": "test_511554245071",
		"attribute4": "test_285ab90a9a26",
		"attribute5": "test_c9902353bd62",
		"attribute6": "test_29bf877ad20e",
		"attribute7": "test_f05c5ee7bda0",
		"attribute8": "test_f05c5ee7bda1",
		"attribute9": "test_913b35f805f0",
		"attribute10": "test_e3af29b52cda",
		"channelMetadata": {
			"totalCashOnDeliveryFee": 0.0,
			"department": "HR",
			"paymentMethod": "ccavenue",
			"status": "processing"
        },
		"currency": "test_ad35da54ae2f"
	},
	"updateOrderItemAttributes": [{
		"orderItemCode": "test_d40fb41b069b",
		"channelSkuCode": "test_0b7bd2e16c1f",
		"attribute1": "test_9500ccd4855f",
		"attribute2": "test_957207fbdbb0",
		"attribute3": "test_e9c4494fc055",
		"attribute4": "test_2c6670838f48",
		"attribute5": "test_09156554f500",
		"attribute6": "test_20ab8d00c447",
		"attribute7": "test_f0c3e77287ae",
		"attribute8": "test_f05c5ee7bda1",
		"attribute9": "test_691c1f899bb8",
		"attribute10": "test_1e7511fe9fc8",
        "channelMetadata": {
			"totalCashOnDeliveryFee": 0.0,
			"department": "HR",
			"paymentMethod": "ccavenue",
			"status": "processing"
        }
	}]
}

 

Parameter

Data type

Description

Mandatory

locationCode

String

Location code

Yes

updateOrderAttributes

Object

Custom attributes to update an outward order

No

updateOrderAttributes.attribute1

String

Custom attribute 1

No

updateOrderAttributes.attribute2

String

Custom attribute 2

No

updateOrderAttributes.attribute3

String

Custom attribute 3

No

updateOrderAttributes.attribute4

String

Custom attribute 4

No

updateOrderAttributes.attribute5

String

Custom attribute 5

No

updateOrderAttributes.attribute6

String

Custom attribute 6

No

updateOrderAttributes.attribute7

String

Custom attribute 7

No

updateOrderAttributes.attribute8

String

Custom attribute 8

No

updateOrderAttributes.attribute9

String

Custom attribute 9

No

updateOrderAttributes.attribute10

String

Custom attribute 10

No

updateOrderAttributes.channelMetadata

Object

meta data fields as an object which is to be parsed at the channel’s end

These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows

No

updateOrderAttributes.currency

String

Currency

No

updateOrderItemAttributes

Object[]

List of custom attributes for order items

No

updateOrderItemAttributes.orderItemCode

String

Code to uniquely identify an order item in an order

No

updateOrderItemAttributes.channelSkuCode

String

Code to uniquely identify an sku on channel’s end

No

updateOrderItemAttributes.attribute1

String

Custom attribute 1

No

updateOrderItemAttributes.attribute2

String

Custom attribute 2

No

updateOrderItemAttributes.attribute3

String

Custom attribute 3

No

updateOrderItemAttributes.attribute4

String

Custom attribute 4

No

updateOrderItemAttributes.attribute5

String

Custom attribute 5

No

updateOrderItemAttributes.attribute6

String

Custom attribute 6

No

updateOrderItemAttributes.attribute7

String

Custom attribute 7

No

updateOrderItemAttributes.attribute8

String

Custom attribute 8

No

updateOrderItemAttributes.attribute9

String

Custom attribute 9

No

updateOrderItemAttributes.attribute10

String

Custom attribute 10

No

updateOrderItemAttributes.channelMetaData

Object

meta data fields as an object which is to be parsed at the channel’s end

These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflowsme

No

Response

Code Block
Empty Body

...