Skip to content

Getting a list of order attributes 

You can download a complete list of order attributes from ExpertSender. It will only contain attributes defined by you in the Settings > Orders > Order attributes section. 

You can read more about it here: Order attributes.

GET method 

The GET method is used to obtain a list of all currently used order attributes along with their properties. 

Your GET query must contain: 

  1. Server address (endpoint): https://api.ecdp.app/orderattributes 
  1. API key: your API key, found in Settings > API. 

A valid API query for an order list looks like this: https://client.ecdp.app/orderattributes

What data will be included in the response? 

The response to a correctly submitted query contains the following data: 

Parameter Type Description 
id Integer($int32) Order attribute’s identification number visible under Settings > Orders > Order attributes. 
name string Order attribute’s name assigned by you in Settings > Orders > Order attributes. 
type string Attribute type with its properties: String, Text, Number, Money, Date, DateTime, SingleSelect, Boolean, Url. 

Query response codes

200: Success 

The query has been processed and the server has returned a response. Sample response syntax looks as follows: 

{
  "status": 0,
  "data": [
    {
      "id": 0,
      "name": "string",
      "type": "string"
    }
  ]
}

401: Unauthorized 

The request was missing an API key or you are requesting access to information that you do not have permission to access. Sample response syntax looks as follows: 

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
On this page
To top