| B2bEdition |
- Type
- string
- Properties
- Create, Nillable
- Description
- The edition of B2B Commerce. The edition can include
Lightning (LB2B), CCRZ, or future flavors. This field is
available in API version 51.0 and later.
|
| B2bVersion |
- Type
- string
- Properties
- Create, Nillable
- Description
- This field is optional. For a managed package,
B2BVersion includes Major,
Minor, Patch revision numbers. For Lightning,
B2BVersion includes the
optional service version. This field is available in API
version 51.0 and later.
|
| BrowswerDeviceType |
- Type
- int
- Properties
- Create, Nillable
- Description
- A code used to identify the browser and device type.
This field is available in API version 51.0 and
later.
The code is in the format “BBVVVXYZ,” with
the following signification:
- BB — Two digits that indicate the
browser type.
- INTERNET_EXPLORER: “10”
- CHROME: "13"
- FIREFOX: "11"
- SAFARI: "14"
- OPERA: "15"
- ANDROID_WEBKIT: "16"
- NETSCAPE: "17"
- OTHER_WEBKIT: "18"
- OTHER_GECKO: "19"
- OTHER_KHTML: "20"
- OTHER_MOBILE: "21"
- SALESFORCE_DESKTOP: "22"
- BLACKBERRY: "23"
- GOOD_ACCESS: "24"
- EDGE: "25"
- SALESFORCE_MOBILE: "26"
- VVV—Three digits that indicate version,
with leading zeroes.
- XYZ—Browser-type specific flags or
options. Each digit in XYZ represents a different
flag depending on the BrowserType:
- X=1: If the parser recognizes a "touch"
browser. Here, touch means the older touch native
client, not that the device supports touch.
- Y=1: If the parser recognizes a browser in
compatibility mode. Only for IE.
- Z=1: If the browser is recognized as MOBILE.
- Z=2: If the browser is recognized as PHONE.
- Z=3: If the browser is recognized as TABLET.
- Z=4: If the browser is a recognized as MEDIA PLAYER.
- Z=6: Only for Opera Mini.
|
| ContextId |
- Type
- string
- Properties
- Create, Nillable
- Description
- The Key Business Domain Value in which the operation is
done. For example, for Cart, the
ContextId is
cartId.
|
| ContextId2 |
- Type
- string
- Properties
- Create, Nillable
- Description
- Another field used to identify a context ID for a given
operation.
|
| ContextMap |
- Type
- string
- Properties
- Create, Nillable
- Description
- A JSON string that captures extra operational context or
other diagnostic information.
|
| CorrelationId |
- Type
- string
- Properties
- Create, Nillable
- Description
- Used to correlate client and server calls, and other
async calls to Commerce subsystems. Calls can take place
across several services and operations.
|
| Count |
- Type
- int
- Properties
- Create, Nillable
- Description
- The number of records impacted by an operation.
|
| EffectiveAccountId |
- Type
- string
- Properties
- Create, Nillable
- Description
- The Commerce Effective Account ID in the context of an
operation.
|
| ErrorCode |
- Type
- string
- Properties
- Create, Nillable
- Description
- The API error code that appears when an operation
fails.
|
| ErrorMessage |
- Type
- string
- Properties
- Create, Nillable
- Description
- The user-friendly error message that appears when an
operation fails.
|
| EventDate |
- Type
- dateTime
- Properties
- Create, Nillable
- Description
- The date when the event occurred.
|
| EventIdentifier |
- Type
- string
- Properties
- Create, Nillable
- Description
- The unique ID of the event, which is shared with the
corresponding object. For example, 0a4779b0-0da1-4619-a373-0a36991dff90. Use
this field value to correlate the event with its
corresponding object.
|
| EventUuid |
- Type
- string
- Properties
- Nillable
- Description
- A universally unique identifier (UUID) that identifies
a platform event message. This field is available in API version 52.0 and
later.
|
| IsRetry |
- Type
- boolean
- Properties
- Create, Defaulted on create
- Description
- Describes whether an event occurred during a retried
operation (true),
or not (false).
Default value is false.
|
| Operation |
- Type
- string
- Properties
- Create, Nillable
- Description
- The operation where the event originated. For example,
CreateCart,
EditCart, and
CreateOrder.
|
| OperationStage |
- Type
- string
- Properties
- Create, Nillable
- Description
- The stage of the operation where the event originated.
This value varies depending on the operation.
|
| OperationStatus |
- Type
- string
- Properties
- Create, Nillable
- Description
- The status of the operation. Values include:
- Success
- SystemError
- AdminError
- UserError
- DependencyError
|
| OperationTime |
- Type
- string
- Properties
- Create, Nillable
- Description
- Duration of the operation in minutes and/or
seconds.
|
| OsVersion |
- Type
- int
- Properties
- Create, Nillable
- Description
- Code used to identify the operating system and version.
OsVersion is equal to 9999 for
an unknown platform. This field is available in API
version 51.0 and later.
|
| RelatedEventIdentifier |
- Type
- string
- Properties
- Create, Nillable
- Description
- EventIdentifier (UUID) of the related event.
|
| ReplayId |
- Type
- string
- Properties
- Nillable
- Description
- Represents an ID value that is populated by the system
and refers to the position of the event in the event stream. Replay ID values
aren’t guaranteed to be contiguous for consecutive events. A subscriber can
store a replay ID value and use it on resubscription to retrieve missed events
that are within the retention window.
|
| ServiceName |
- Type
- string
- Properties
- Create, Nillable
- Description
- The service where the event originated. When Commerce
generates the event, possible values include:
- BuyerGroup
- BuyerAccount
- BuyerManagement
- Cart
- CartAsync
- Checkout
- Entitlements
- Order
- Pricing
- ProductEtl
- Products
- ReOrder
- Search
- Storefront
- Integration
- Wishlist
- ExternalManagedAccouts
- EffectiveAccountService
- EffectiveAccountUIService
|
| UserId |
- Type
- string
- Properties
- Create, Nillable
- Description
- The ID of the user associated with this event.
|
| Username |
- Type
- string
- Properties
- Create, Nillable
- Description
- Reserved for future use.
|
| WebStoreId |
- Type
- string
- Properties
- Create, Nillable
- Description
- The ID of the Webstore associated with this event.
|
| WebStoreType |
- Type
- string
- Properties
- Create, Nillable
- Description
- The type of webstore. For example: B2B, B2C, and OMS. This field is
available in API version 51.0 and later.
|
j
