event/push/subscriptions

The Subscriptions resource triggers a push service to sent immediate notifications to the subscribed tenants and applications when triggers. The resource sends messages regarding a subscription event tha occurs in the tenant or site.

JSON Example

Subscription Properties

Property Description
apiVersion

type: string

ApiVersion

appId

type: string

Unique identifier of an app available in your Kibo eCommerce tenant or within Kibo eCommerce Dev Center. This ID is unique across all apps installed, initialized, and enabled in the Admin and those in development through the Dev Center Console.

confirmed

type: bool

A boolean value that indicates if the subscription endpoint has been confirmed

contentType

type: string

Content type of the payload that will be delivered. This is utilized in combination with the notification delivery type. Example: A HTTP Post (notification delivery type) is performed with a JSON representation of the event data (content type).

createBy

type: string

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

createDate

type: DateTime

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

endpoint

type: string

The delivery endpoint that will receive notifications when events concerning the specified topics on the subscription occur. The format of the endpoint may differ depending on the notification type. For example, the endpoint may be a URL in some cases and an email address in others if multiple notification types are available.

id

type: string

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

isActive

type: bool

Indicates if the object or feature is active.

noCallback

type: bool

A boolean value that indicates if events should be delivered that resulted from an API call by the application. If true, any events that occur as a result of a direct API call by the same application will not be delivered. This can prevent an endless loop in certain scenarios.

notificationDeliveryType

type: string

Notification delivery type which is a string representation of an enumeration of values. Example: Http (this is case insensitive, so http may also be passed in)

subscribingTenants

type: list of subscribingTenant

This is a tenant that is associated with a subscription.

subscribingTenant.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.

subscribingTenant.auditInfo.createBy

type: string

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

subscribingTenant.auditInfo.createDate

type: DateTime

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

subscribingTenant.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

subscribingTenant.auditInfo.updateDate

type: DateTime

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

subscribingTenant.isActive

type: bool

Indicates if the object or feature is active.

subscribingTenant.subscribingContextLevelType

type: string

This specifies the type of subscribing context, which is derived from the state of the subscription. If any subscribing sites exist; for example, a subscription that is not at the tenant level, then the value will be 'site'.

subscribingTenant.subscribingSites

type: list of subscribingSite

This specifies the subscribing sites.

subscribingTenant.subscribingSite.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.

subscribingTenant.subscribingSite.auditInfo.createBy

type: string

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

subscribingTenant.subscribingSite.auditInfo.createDate

type: DateTime

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

subscribingTenant.subscribingSite.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

subscribingTenant.subscribingSite.auditInfo.updateDate

type: DateTime

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

subscribingTenant.subscribingSite.isActive

type: bool

Indicates if the object or feature is active.

subscribingTenant.subscribingSite.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.

subscribingTenant.tenantId

type: int

Unique identifier for the tenant.

topics

type: list of string

A list of topics that the subscription relates to

updateBy

type: string

Identifier of the user that updated the entity most recently.

updateDate

type: DateTime

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

Operations

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

Retrieves a list of events according to any specified filter criteria and sort options.