Create order

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

Product Metadata

If you want to send metadata with your order, please contact Yotpo support so we can turn this feature on for you.

Ecommerce Platforms

Your PlatformEnter this for Platform Parameter in API call
3dcartthree_d_cart
AmeriCommerceamericommerce
Bigcommercebigcommerce
Commerce Guyscommerce_guys
CS-Cartcscart
ebayebay
EC-CUBEeccube
Lightspeedseoshop
Magentomagento
OpenCartopencart
PrestaShopprestashop
Shopifyshopify
Shoploshoplo
Storenvystorenvy
Volusionvolusion
WooCommercewoocommerce
WP eCommercewp_ecommerce
Zepozepo
Any other platformgeneral

Error Messages

Parameter NameDescription
order_idThe ID of the purchase
fieldThe field where the error occurred
errorDescription of the error in the field

Product Specs

  • Universal Product Code upc: "upc value",
  • Manufacturer Part Number mpn: "mpn value",
  • Brand brand: "Yotpo",
  • International Standard Book Number isbn: "isbn value"
  • Stock-keeping unit sku: "sku value"
  • European Article Number ean: "ean value"
  • External stock-keeping unit external_sku: "external_sku value"
🚧

Note:

  • The data-product-spec tag must be in lower case.
  • Trailing spaces are automatically stripped in the product specification.
  • Any combination of leading zeros (“0”), leading spaces and leading dashes (“-“) are automatically stripped in the product specification.
  • The product specification value is case-sensitive.
  • The product specification value “N/A” is invalid in any case and is ignored.
  • The product specification only supports alphanumeric (a...z, A...Z, 0...9), "_" and "-" characters.
🚧

Note:

The product_sku cannot include the "/" symbol.

Path Params
string
required

Your Yotpo app key (store ID).

Body Params
string
required

The email address of the customer who made the order

string
required

The name of the customer who made the order

string
required

The unique order ID in your store.

string
required

Your eCommerce platform

string

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

date
required

The order date, as YYYY-MM-DD or an ISO 8601 date-time. Review request emails aren't sent for orders older than six months.

string

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

products
object
required

The ordered products, keyed by product ID (SKU). At least one product is required.

string

Your access token (utoken). Optional when you send it in the X-Yotpo-Token header, which is preferred. See Yotpo authentication.

customer
object

The customer info object

string

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

custom_properties
array of objects

Custom order properties as name-value pairs.

custom_properties
customer_properties
object

Legacy customer details. Prefer customer.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json