Перейти к содержимому

Getting a list of order attributes 

You can pull a complete list of order attributes from ExpertSender. The response will only show attributes you’ve set up in Settings > Orders > Order attributes.

Want to learn more about setting these up? Check out our Order attributes guide.

GET method 

Use the GET method to grab all your current order attributes and their properties.

Endpoint

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

Request parameters

ParameterRequiredTypeUsed inDescription
x-api-keyyesstringheaderYour API key, which you can find in Settings > API.

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. 

Response codes

200: Success 

Your request worked perfectly. Sample response: 

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

401: Unauthorized 

Something went wrong with your authentication – either your API key is missing or you don’t have permission to access this data.

Sample response:

{
  "type": "string",
  "title": "string",
  "status": 0,
  "substatus": "CustomerInvalidModelState",
  "detail": "string",
  "instance": "string"
}
Privacy policy