Skip to content

Orders – get a list of product attributes

This GET method retrieves a complete list of product attributes configured in your business unit in Settings > Orders > Product attributes.

Endpoint

The endpoint for GET requests is: https://api.ecdp.app/productattributes

Request parameters

ParameterLocationTypeRequiredDescriptionAllowed values / Notes
x-api-keyheaderstringyesYour ECDP API key for authenticationLocated in Settings > API

This endpoint does not require any query parameters or request body. The response returns all product attributes configured in your account.

Response

ParameterTypeDescription
statusintegerResponse status code. Returns 0 for successful requests.
dataarrayArray of product attribute data. Empty array if no attributes are configured. See Order attributes structure below.

Product attributes

Each product attribute data in the data array represents a single product attribute with the following para,eters:

ParameterTypeDescription
idinteger (int32)Unique identifier for the product attribute. Corresponds to the ID shown in Settings > Orders > Product attributes.
namestringThe display name assigned to the attribute when it was created. Max 256 characters.
typestringThe data type of the attribute. Determines what values can be stored and how they are validated. See data types table

Data types

The type field contains one of the following values:

TypeDescription
StringShort text value, typically up to 255 characters
TextLong-form text content
NumberNumeric value (integer or decimal)
MoneyCurrency value with decimal precision
DateDate value without time component (YYYY-MM-DD)
DateTimeDate and time value in ISO-8601 format
SingleSelectSingle selection from a predefined list of options
BooleanTrue/false value
UrlValid URL string

Response codes#

CodeStatusDescription
200SuccessRequest processed successfully. Response body contains attribute data.
401UnauthorizedAPI key is missing, invalid, or lacks permission for this resource.
500Internal Server ErrorAn unexpected error occurred on the server.

Example requests and responses

Get all product attributes

Request:

GET /productattributes

Response (200 OK):

{
  "status": 0,
  "data": [
    {
      "id": 1,
      "name": "Manufacturer",
      "type": "String"
    },
    {
      "id": 2,
      "name": "Seasonal product",
      "type": "Boolean"
    },
    {
      "id": 3,
      "name": "Launch date",
      "type": "Date"
    },
    {
      "id": 4,
      "name": "Wholesalep rice",
      "type": "Money"
    }
  ]
}

Response when no attributes are configured

Response (200 OK):

{
  "status": 0,
  "data": []
}

Validation and behavior rules

  • This endpoint returns all product attributes configured in the current business unit in Settings > Orders > Product attributes.
  • Attribute IDs are stable and do not change after creation.
  • An empty data array indicates no product attributes have been configured.

Reference documentation

Swagger – Product attributes

https://api.ecdp.app/swagger/index.html