Skip to end of banner
Go to start of banner

Search Custom Order Attributes API (Beta)

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Inbound | GET | /search/order

Summary

This API will return the custom order and order line item attribute details corresponding to an orderCode and locationCode

Description

This API will take orderCode and locationCode as input and return all custom order attributes.

Parameters

Parameter Name

Data Type

Description

Mandatory

orderCode

String

order code whose details needs to be fetched

Yes

locationCode

String

location to which that order belongs to

Yes

Response

{
  "locationCode": "string",
  "orderCode": "string",
  "orderCustomAttributes": {
    "attribute1": "test_4e10f67e0585",
    "attribute2": "test_df7f45161dbf",
    "attribute3": "test_511554245071",
    "attribute4": "test_285ab90a9a26",
    "attribute5": "test_c9902353bd62",
    "attribute6": "test_29bf877ad20e",
    "attribute7": "test_f05c5ee7bda0",
    "attribute9": "test_913b35f805f0",
    "attribute10": "test_e3af29b52cda",
    "channelMetadata": {
      "MetaDataTestExample1": "test_13669a9d0d24",
      "MetaDataTestExample2": "test_13669a9d0d25"
    },
    "currency": "test_ad35da54ae2f"
  },
  "orderItems": [
    {
      "cancelledQuantity": 0,
      "channelDiscountPerUnit": 0,
      "channelSkuCode": "string",
      "orderItemCode": "string",
      "orderedQuantity": 0,
      "sellerDiscountPerUnit": 0,
      "sellingPrice": 0,
      "orderItemCustomAttributes": {
        "attribute1": "test_9500ccd4855f",
        "attribute2": "test_957207fbdbb0",
        "attribute3": "test_e9c4494fc055",
        "attribute4": "test_2c6670838f48",
        "attribute5": "test_09156554f500",
        "attribute6": "test_20ab8d00c447",
        "attribute7": "test_f0c3e77287ae",
        "attribute9": "test_691c1f899bb8",
        "attribute10": "test_1e7511fe9fc8",
        "channelMetadata": {
          "MetaDataTestExample1": "test_13669a9d0d24",
          "MetaDataTestExample2": "test_13669a9d0d25"
        }
      },
    }
  ],
  "orderStatus": "CREATED"
}

Field

Data Type

Description

Mandatory?

locationCode

String

Location code of warehouse from where this order will get fulfilled

No

orderCode

String

Unique code used by channel to identify the order

No

orderStatus

String

Possible values → (CREATED, CANCELLED,DELIVERED)

No

orderCustomAttributes

Object

Custom attributes for an order

No

orderCustomAttributes.attribute1

String

Custom attribute 1

No

orderCustomAttributes.attribute2

String

Custom attribute 2

No

orderCustomAttributes.attribute3

String

Custom attribute 3

No

orderCustomAttributes.attribute4

String

Custom attribute 4

No

orderCustomAttributes.attribute5

String

Custom attribute 5

No

orderCustomAttributes.attribute6

String

Custom attribute 6

No

orderCustomAttributes.attribute7

String

Custom attribute 7

No

orderCustomAttributes.attribute8

String

Custom attribute 8

No

orderCustomAttributes.attribute9

String

Custom attribute 9

No

orderCustomAttributes.attribute10

String

Custom attribute 10

No

orderCustomAttributes.channel_metadata

Object

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

No

orderCustomAttributes.currency

String

Currency

No

orderItems

Object

List of items for which order is placed

No

orderItems.orderItemCode

String

This is provided by the channel to uniquely identify each order item.
This should be unique in an order

No

orderItems.channelSkuCode

String

SKU code of order item

No

orderItems.orderedQuantity

Integer

ordered quantity of ordered item

No

orderItems.cancelledQuantity

Integer

Cancelled quantity for this sku

No

orderItems.channelDiscountPerUnit

Double

Discount given by channel on SKU per unit

No

orderItems.sellerDiscountPerUnit

Double

Discount given by seller on SKU per unit

No

orderItems.sellingPrice

Double

Unit price of SKU including tax

No

orderItems.orderItemCustomAttributes

Object

Order Item custom attributes

No

orderItemCustomAttributes.attribute1

String

Custom attribute 1

No

orderItemCustomAttributes.attribute2

String

Custom attribute 2

No

orderItemCustomAttributes.attribute3

String

Custom attribute 3

No

orderItemCustomAttributes.attribute4

String

Custom attribute 4

No

orderItemCustomAttributes.attribute5

String

Custom attribute 5

No

orderItemCustomAttributes.attribute6

String

Custom attribute 6

No

orderItemCustomAttributes.attribute7

String

Custom attribute 7

No

orderItemCustomAttributes.attribute8

String

Custom attribute 8

No

orderItemCustomAttributes.attribute9

String

Custom attribute 9

No

orderItemCustomAttributes.attribute10

String

Custom attribute 10

No

  • No labels