get the custom attributes of an order

1min
GET
get the custom attributes of an order
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Query Parameters
version
integer
Responses
200
OK
GetOrderEntityAttributeResponse
error
Error
data
OrderEntityAttributeResponse
request
Request
400
Error Occurred
GetErrorResponse
error
Error
*
request
Request
*
data
object
401
Error Occurred
GetErrorResponse
error
Error
*
request
Request
*
data
object
404
Error Occurred
GetErrorResponse
error
Error
*
request
Request
*
data
object
Curl
JS
Ruby
Python
curl --location --globoff 'https://{base_url}/core/api/v1/orders/config/attributes' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{base_url}/core/api/v1/orders/config/attributes' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
404
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "data": {
    "attributes": [
      {
        "name": "",
        "description": "",
        "dataType": "",
        "defaultValue": {},
        "validation": {
          "range": {
            "": ""
          },
          "regex": "",
          "valueOneOf": [
            {}
          ],
          "required": false
        },
        "indexed": false,
        "delete": false,
        "securityLevel": ""
      }
    ],
    "schemaVersion": 0,
    "createdAt": 0,
    "updatedAt": 0,
    "createdBy": {
      "id": "",
      "name": "",
      "appId": ""
    },
    "updatedBy": {
      "id": "",
      "name": "",
      "appId": ""
    }
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "data": {
    "attributes": [
      {
        "name": "",
        "description": "",
        "dataType": "",
        "defaultValue": {},
        "validation": {
          "range": {
            "": ""
          },
          "regex": "",
          "valueOneOf": [
            {}
          ],
          "required": false
        },
        "indexed": false,
        "delete": false,
        "securityLevel": ""
      }
    ],
    "schemaVersion": 0,
    "createdAt": 0,
    "updatedAt": 0,
    "createdBy": {
      "id": "",
      "name": "",
      "appId": ""
    },
    "updatedBy": {
      "id": "",
      "name": "",
      "appId": ""
    }
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 03 Aug 2023
Did this page help you?
update order config
update state machine configuration for an order