For each event to be reported, here you will find the response that will trigger the webhook to your server.
HTTP Response
A callback will be successful if the HTTP response code, provided by the seller's system, is 200. The content of the response does not matter.
You can see general information about webhooks and their statuses in the Webhooks section in the introduction (Here)
1. Feed
Below you will find all events sent for the Feed entity and their payload definitions.
The Feed Created and Feed Completed events are only triggered for the following types:
- Product creation
- Product update
- Product deletion
- Image
Feed Created
{
"event": "onFeedCreated",
"payload": {
"Feed": "829a8d2a-d370-4fa6-8613-8554f43d5fed"
}
}
Campo | Tipo | Descripción |
---|---|---|
Feed | String | A feed identifier that will be used to obtain more details using the API. |
Feed completed
{
"event": "onFeedCompleted",
"payload": {
"Feed": "829a8d2a-d370-4fa6-8613-8554f43d5fed"
}
}
Field | Type | Description |
---|---|---|
Feed | String | A feed identifier that will be used to obtain more details using the API |
How to handle onFeedCompleted
- After receiving this event, call the API action FeedStatus to obtain the details.
- The event will only be triggered for a "Completed" feed, which will occur in most cases. If you do not receive a callback for a long time, call the API action FeedStatus to find out if the feed has obtained the status "Canceled" or "Error".
2. Product
Below you will find all events sent for the Product entity and their payload definitions.
Product Created (Product created)
{
"event": "onProductCreated",
"payload": {
"SellerSkus": [
"NI006ELAAGWDNAFAMZ-43340"
]
}
}
Campo | Tipo | Descripción |
---|---|---|
SellerSkus | String[] | Lista de skus del Seller que se utilizarán para obtener más detalles mediante la API |
Producto actualizado (Product Updated)
{
"event": "onProductUpdated",
"payload": {
"SellerSkus": [
"NI006ELAAGWDNAFAMZ-43340",
"NI006ELAAGWDNAFAMZ-43341",
"NI006ELAAGWDNAFAMZ-43342",
"NI006ELAAGWDNAFAMZ-43343"
]
}
}
Field | Type | Description |
---|---|---|
SellerSkus | String[] | List of seller SKUs that will be used to obtain more details via the API |
Product Quality Control Status Modified
{
"event": "onProductQcStatusChanged",
"payload": {
"SellerSkus": [
"NI006ELAAGWDNAFAMZ-43341",
"NI006ELAAGWDNAFAMZ-43342"
]
}
}
Field | Type | Other Possible Values |
---|---|---|
SellerSkus | String[] | List of seller SKUs that will be used to obtain more details via the API |
3. Order
Below you will find all events sent for the Order entity and their payload definitions.
Order Created (Pedido creado)
{
"event": "onOrderCreated",
"payload": {
"OrderId": 190
}
}
Field | Type | Description |
---|---|---|
Order | Int | Identifier of the order that will be used to obtain more details via the API |
Order Item Statuses Modified
{
"event": "onOrderItemsStatusChanged",
"payload": {
"OrderId": 190,
"OrderItemIds": [2, 3],
"NewStatus": "ready_to_ship"
}
}
Valid values for "New Status":
{
"Statuses":[
"shipped",
"returned",
"return_waiting_for_approval",
"return_shipped_by_customer",
"return_rejected",
"ready_to_ship",
"processing",
"pending",
"failed",
"delivered",
"canceled"
]
}
Field | Type | Description |
---|---|---|
OrderId | Int | Identifier of the order that will be used to obtain more details via the API |
OrderItemIds | Int[] | Identifiers of the order item that will be used to obtain more details using the API |
NewStatus | String | Status of the new item |
Below you will find all events sent for the Metrics entity and their payload definitions.
5. Statistics
Below you will find all events sent for the Statistics entity and their payload definitions.
Statistics Updated (Estadísticas actualizadas)
{
"event": "onStatisticsUpdated",
"payload": {}
}