XM

Retrieve Order-Level Attributes

Path:

GET https://{baseurl}/api-configuration/attribute/getAll/order-attributes
ibute

Enables you to add attribute to the cart.

Headers

Content-Type : application/json

x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }

Parameters []

Sample Request

Path:

GET https://{baseurl}/api-configuration/attribute/getAll/order-attributes
ibute

Response

Success Code: 200

Message: OK

Description: You'll see this message when all of the order attributes are retrieved.

{
"attributes": [
{
"_id": "60b12fc3a12cde00081b4f7f",
"price": "15",
"name": "Complete Order Gift Warp Large",
"type": "bool"
},
{
"_id": "60b12fdda12cde00081b4f80",
"price": "5",
"name": "Complete Order Gift Warp Small",
"type": "bool"
},
{
"_id": "60b13013a12cde00081b4f81",
"price": "0",
"name": "Order Level Messaging",
"type": "string"
}
]
}

Error Code: 404

Message: Not found

Description: You will see this error when no order-level attributes are found.

{
"code": "ATTRIBUTE_NOT_FOUND_ERROR",
"message": "Attributes Not Found"
}

Error Code: 403

Message: Forbidden

Description: You will see this error when the account number is incorrect in the x-site-context (for a multi-tenent client).

{
"message": "Forbidden"
}

Change Log

  • June - 2021 First updated