Get event types

This API provides a list of event types and resource names to which you can subscribe. Notifications will be triggered only for the event types that you subscribe to.

Event types are workflow events that are triggered when status or conditions change. Some examples are an offer moving from published to unpublished status, an order being auto-canceled by Walmart, or a change in the buy box price or winner.

Resource Names are functional API categories that group similar event types. They can be Items, Prices, Orders, or Inventory. The permissions to subscribe to an Event Type are defined by the Resource Name, which is mapped to permissions in Delegated Access.

API specifications

• API Version: V3
• URL For Production
  REST – GET: https://marketplace.walmartapis.com/v3/webhooks/eventTypes
• URL Sample
  GET /v3/webhooks/eventTypes HTTP/1.1

Sample header

<<Authentication Headers>> Content-Type: application/json Accept: application/json Host: marketplace.walmartapis.com

Header parameter description

For authentication headers, refer to this Authentication help article.

"data": [ {
"Name": "Content-type",
"Description": "The data format in the API payload",
"Required": "No",
"Example": "application/json"
},
{
"Name": "Accept",
"Description": "The returned data format in the response",
"Required": "Yes",
"Example": "application/json"
} ]

Sample requests

{
"resourceName": "ITEM",
"eventType": "OFFER_PUBLISHED",
"eventVersion": "V1",
"description": "Notification for published offers"
}

Request parameter description

Sample response 1

{ "events": [
{
"resourceName": "ITEM",
"eventType": "OFFER_UNPUBLISHED",
"eventVersion": "V1",
"description": "Notification for unpublished offers"
}, {
"resourceName": "PRICE",
"eventType": "BUY_BOX_CHANGED",
"eventVersion": "V1",
"description": "Notification for change in buy box"
}, {
"resourceName": "ORDER",
"eventType": "PO_CREATED",
"eventVersion": "V1",
"description": "Notification for new purchase order created"
}, {
"resourceName": "ORDER",
"eventType": "PO_LINE_AUTOCANCELLED",
"eventVersion": "V1",
"description": "Notification for purchase order line auto-cancelled"
}, {
"resourceName": "REPORTS",
"eventType": "REPORT_STATUS",
"eventVersion": "V1",
"description": "Notification for report status"
}, {
"resourceName": "INVENTORY",
"eventType": "INVENTORY_OOS",
"eventVersion": "V1",
"description": "Notification for inventory out of stock"
}, { "resourceName": "ITEM", "eventType": "OFFER_PUBLISHED", "eventVersion": "V1", "description": "Notification for published offers" } ]

Sample response 2

"data": [ {
"Name": "events",
"Description": "List of events", "Type": "Array"
}, {
"Name": "eventType",
"Description": "Event that you want to subscribe to.",
"Type": "String"
},
{
"Name": "eventVersion",
"Description": "Version of the specific event type",
"Type": "String"
},
{
"Name": "resourceName",
"Description": "Delegated access scope that event type is mapped to.",
"Type": "String"
},
{
"Name": "description",
"Description": "Description of the specific event type",
"Type": "String"
} ]