commerce/checkouts/checkoutattributes

Use this resource to manage custom attributes attached to the Checkouts resource.

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
CreateCheckoutAttributes POST %7bcheckoutId%7d%2fattributes

Creates a custom attribute(s) on a checkout.

GetCheckoutAttributes GET %7bcheckoutId%7d%2fattributes

Retrieves the custom attributes for a checkout.

UpdateCheckoutAttribute PUT %7bcheckoutId%7d%2fattributes%3fremoveMissing%3d%7bremoveMissing%7d

Updates a custom attribute on a checkout.