Create order

post

https://api.yotpo.com/apps/app_key/purchases/

Creates an order in your Yotpo store.

Please note that it is not possible to send automatic review request emails for orders that are older than six months.

Body Params

string

required

The email address of the customer who made the order

customer_name

string

required

The name of the customer who made the order

order_id

string

required

The unique order ID. Orders using the same order_id will not be created.

platform

string

required

Your eCommerce platform

user_reference

string

Only used as an external reference for the Points and Rewards feature

order_date

date

required

The date of the order in the format YYYY-MM-DD. If this is not provided, the time of the request will be used as the order date. It is not possible to send a MAP emails for orders older than six months.

currency_iso

string

The ISO code of the currency in which the order was made. Must be three characters long. See Country Currency Codes.

products

object

Products object containing the product ID and associated product metadata

utoken

string

required

Your Yotpo account access token. See Yotpo Authentication to learn how to generate your utoken.

app_key

string

required

The store ID

customer

object

The customer info object

delivery_type

string

The type of shipping/delivery chosen for this order e.g. same_day, express, standard

custom_properties

object

The custom property object

customer_properties

object

Responses

Language

Response

Choose an example:

application/json

200200

400400