Skip to end of banner
Go to start of banner

Search Custom Order Attributes Keys 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

« Previous Version 2 Next »

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

{
  "OrderAttributesData": [
    {
      "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

  • No labels