Sign in

v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
BlanketOrder

Gets a single change message for a Blanket Order

Gets a single change message for a Blanket Order.

get/commerce/blanketorders/{blanketOrderId}/changemessages/{changeMessageId}

Path parameters

blanketOrderIdstring required
changeMessageIdstring required

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Response

OK

amountnumber double nullable

Monetary amount that pertains to the change if applicable

appIdstring nullable

App Id that identifies the user that performed the related change

appKeystring nullable

App Key

appNamestring nullable

App Name

attributesobject nullable

Additional Data. This property will be a Dictionary of objects.

correlationIdstring nullable

Correlation Id

createDatestring date-time nullable

When the message was created. System-supplied. Read-only.

idstring nullable

Unique identifier of the message. System-supplied. Read-only.

identifierstring nullable

Unique identifier to what the message pertains, which can be a cart item, cart or another generic entity. System-supplied. Read-only.

messagestring nullable

Human readable message. System-supplied. Read-only.

{"stackTrail":"components:schemas:CommerceRuntimeChangeMessage:properties:metadata","oasType":"schema","type":"unknown","description":"Data. This property will be a JSON array that will contain 0-N items, when there is 1 item it will still be an array containing only one item. System-supplied. Read-only.","nullable":true}
newValuestring nullable

Current price of the item. System-supplied. Read-only.

oldValuestring nullable

Original price of the item. System-supplied. Read-only.

subjectstring nullable

Text on the subject line of the message, for example, the product name. System-supplied. Read-only.

subjectTypestring nullable

Subject of the message, for example, "Product." System-supplied. Read-only.

successboolean nullable

Indicates if the message is related to a success or failure.

userFirstNamestring nullable

User First Name

userIdstring nullable

User Id that identifies the user that performed the related change

userLastNamestring nullable

User Last Name

userScopeTypestring nullable

User Type (e.g. Shopper, Admin, etc.)

verbstring nullable

Action applicable to the message. This can be "Increased," when the product price has increased, "Decreased," when the product price has decreased, and "Invalidated," when the product is no longer available. System-supplied. Read-only.