event/push/subscriptions/deliveryattempts

Provides details for each attempted delivery of the event to the endpoint.

JSON Example

EventDeliverySummary Properties

Property Description
createDate

type: DateTime

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

deliveryAttempts

type: list of eventDeliveryAttempt

Details about each attempted delivery of the event to the endpoint

eventDeliveryAttempt.deliveryStatus

type: string

Status of the delivery process `EventDeliveryStatusType`. System-supplied and read-only.

eventDeliveryAttempt.errorType

type: string

Type of error that occurred, if the delivery was unsuccessful

eventDeliveryAttempt.executionDate

type: DateTime

The date that the delivery was attempted

eventDeliveryAttempt.httpStatus

type: httpStatus

Properties for the HTTP status for an event.

eventDeliveryAttempt.httpStatus.code

type: int

The unique identifier of the object.

eventDeliveryAttempt.httpStatus.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

eventDeliveryAttempt.message

type: string

The text of the change message, such as "This product is no longer available." System-supplied and read-only.

deliveryStatus

type: string

Status of the delivery process `EventDeliveryStatusType`. System-supplied and read-only.

eventSummary

type: eventSummary

Properties of events as a summary of actions, data, and responses.

eventSummary.catalogId

type: int

The unique identifier for the product catalog. Catalogs are part of a master catalog.

eventSummary.correlationId

type: string

The unique identifier of the API request associated with the event action, which might contain multiple actions.

eventSummary.createDate

type: DateTime

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

eventSummary.entityId

type: string

The unique identifier of the entity that caused the event. For example, if the event is "product.created", the entity ID value represents the product code of the product that was created.

eventSummary.eventId

type: string

Unique identifier for the event.

eventSummary.extendedProperties

type: list of eventExtendedProperty

Extended properties. Note: This is purposefully not a CollectionBase type wrapper so consumers start to get used to not having counts returned.

eventSummary.eventExtendedProperty.key

type: string

Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.

For search synonym definitions, refer to Synonym Expansion Types for more information about the key usage.

eventSummary.eventExtendedProperty.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

eventSummary.masterCatalogId

type: int

Unique identifier for the master catalog.

eventSummary.siteId

type: int

Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site.

eventSummary.tenantId

type: int

Unique identifier for the tenant.

eventSummary.topic

type: string

The type of event that was performed, such as "product.created" or "category.deleted".

id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

isRunning

type: bool

Indicates whether delivery of the event is currently being attempted at this moment in time

lastExecutionDate

type: DateTime

The date that the delivery was last attempted (either successfully or not)

nextExecutionDate

type: DateTime

The date that the delivery will next be attempted, if the event has not been successfully delivered yet and there are still retries remaining

retriesRemaining

type: int

Number of delivery attempts remaining

updateDate

type: DateTime

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

Operations

Operation Name Request URI Description
GetDeliveryAttemptSummaries GET %7bsubscriptionId%7d%2fdeliveryattempts%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a collection of data for delivery attempts of events and notifications. These are notifications sent to subscribing sites and tenants. A paged list is returned sorted and filtered per the entered parameters.

GetDeliveryAttemptSummary GET %7bsubscriptionId%7d%2fdeliveryattempts%2f%7bid%7d%3fresponseFields%3d%7bresponseFields%7d

This operation method is the external/public event entity used specifically in pull/poll event scenarios.