commerce/orders/orderattributes

Use the Order Attributes resource to define how an order attribute definition applies to a specific order.

JSON Example

OrderAttribute Properties

Property Description
attributeDefinitionId

type: int

Unique identifier of the attribute definition.

auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

fullyQualifiedName

type: string

Fully qualified name of the attribute for the order or customer.

values

type: list of object

List of value data for objects.

Operations

Operation Name Request URI Description
CreateOrderAttributes POST %7borderId%7d%2fattributes

Applies a list of attributes to the order specified in the request and defines a value for each attribute in the request body.

GetOrderAttributes GET %7borderId%7d%2fattributes

Retrieves a list of the attributes defined for the order specified in the request.

UpdateOrderAttributes PUT %7borderId%7d%2fattributes%3fremoveMissing%3d%7bremoveMissing%7d

Updates one or more properties of an attribute defined for the order specified in the request.