The aggregated order info endpoint is available for Yotpo Reviews, Yotpo SMS & Email, and Yotpo Visual UGC.
- This endpoint works asynchronously. The status you receive in the response to the call will indicate the success or failure of adding the new order to the orders queue. To check if an order was registered successfully with Yotpo, please use the RESTful "Retrieve" endpoints.
- This endpoint can be used to update information about an existing order. Note that any fields you implicitly provide new values for will be overwritten. However, for nested arrays of objects, if you provide a new object, this will be added alongside the original one. For example, if you call the "Register purchase" endpoint with a new "fulfillment" object (with a unique external ID), this will result in an order with two nested fulfillment objects.
- To commit updates to existing entities, we recommend using the RESTful endpoints.
- Send aggregated order info - Send to Yotpo all relevant order information in one batch.
This endpoint contains the following entities: