Payload Definitions

January 01, 0001

HTTP Response

A callback will be successful, if the response http code, given by the seller system, is 200. The response content doesn't matter.

Feed

Find bellow all the events sent for Feed entity and its payload definitions.

The Feed Created and Feed Completed events are only triggered for the following types:

Product create
Product update
Product remove
Image

Feed Created

{
	"event": "onFeedCreated",
  "payload": {
  	"Feed": "829a8d2a-d370-4fa6-8613-8554f43d5fed"	
  }
}

Field	Type	Description
Feed	String	A feed identifier to be used to get more details using the API.

Feed Completed

{
	"event": "onFeedCompleted",
  "payload": {
  	"Feed": "829a8d2a-d370-4fa6-8613-8554f43d5fed"
  }
}

Field	Type	Description
Feed	String	A feed identifier to be used to get more details using the API.

How to handle onFeedCompleted

1) After receiving this event, please call FeedStatus API action to get details. 2) The event will only be triggered for a "Finished" feed, which will happen for most cases. If you do not receive a callback for long time, please call FeedStatus API action to discover if the Feed got status "Canceled" or "Error"

Product

Find bellow all the events sent for Product entity and its payload definitions.

Product Created

{
	"event": "onProductCreated",
  "payload": {
  	"SellerSkus": [
      "NI006ELAAGWDNAFAMZ-43340"
    ]
  }
}

Field	Type	Description
SellerSkus	String[]	List of seller skus to be used to get more details using the API.

Product Updated

{
	"event": "onProductUpdated",
  "payload": {
  	"SellerSkus": [
      "NI006ELAAGWDNAFAMZ-43340",
      "NI006ELAAGWDNAFAMZ-43341",
      "NI006ELAAGWDNAFAMZ-43342",
      "NI006ELAAGWDNAFAMZ-43343"
    ]
  }
}

Field	Type	Description
SellerSkus	String[]	List of seller skus to be used to get more details using the API.

Product QC Status Changed

{
	"event": "onProductQcStatusChanged",
  "payload": {
  	"SellerSkus": [
      "NI006ELAAGWDNAFAMZ-43341",
      "NI006ELAAGWDNAFAMZ-43342"
    ]
  }
}

Field	Type	Possible Other Values
SellerSkus	String[]	List of seller skus to be used to get more details using the API.

Order

Find bellow all the events sent for Order entity and its payload definitions.

Order Created

{
	"event": "onOrderCreated",
  "payload": {
  	"OrderId": 190	
  }
}

Field	Type	Description
Order	Int	Order identifier to be used to get more details using the API.

Order Items Status Changed

{
	"event": "onOrderItemsStatusChanged",
  "payload": {
  	"OrderId": 190,
    "OrderItemIds": [2, 3],
    "NewStatus": "shipped"
  }
}

Field	Type	Description
OrderId	Int	Order identifier to be used to get more details using the API.
OrderItemIds	Int[]	Order Item identifiers to be used to get more details using the API.
NewStatus	String	New status of the Order items (e. g. readytoship, shipped, delivered)

Metrics

Find bellow all the events sent for Metrics entity and its payload definitions.

Metrics Updated

{
	"event": "onMetricsUpdated",
  "payload": {}
}

Statistics

Find bellow all the events sent for Statistics entity and its payload definitions.

Statistics Updated

{
	"event": "onStatisticsUpdated",
  "payload": {}
}