Versions Compared

Key

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

Inbound | GET | /master/custom-attributes/search

Summary

This API will return the key values defined for custom order attributes in our system.

Description

This API will return the key values defined for custom order attributes in our system.


Request Parameters

Parameter Name

Data Type

Description

Mandatory

orderAttributeType

Enum

Attribute type, whose values is to be fetched

Possible values:

  • OUTWARD_ORDER

  • OUTWARD_ORDER_ITEM

  • INWARD_ORDER

  • INWARD_ORDER_ITEM

Yes

Response

Code Block
languagejson
{
  "OrderAttributesDataorderAttributesDataList": [
    {
      "attributeKey": "Attribute1",
      "attributeValue": "test_1bd271cb334c2",
      "type": "OUTWARD_ORDER"
    }
  ]
}

Parameter Name

Data Type

Description

attributeKey

String

Custom attribute key for an order

attributeValue

String

Value of the attribute

type

ENUM

  • OUTWARD_ORDER

  • OUTWARD_ORDER_ITEM

  • INWARD_ORDER

  • INWARD_ORDER_ITEM

type of attribute