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.
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 Platform | Enter this for Platform Parameter in API call |
|---|---|
| 3dcart | three_d_cart |
| AmeriCommerce | americommerce |
| Bigcommerce | bigcommerce |
| Commerce Guys | commerce_guys |
| CS-Cart | cscart |
| ebay | ebay |
| EC-CUBE | eccube |
| Lightspeed | seoshop |
| Magento | magento |
| OpenCart | opencart |
| PrestaShop | prestashop |
| Shopify | shopify |
| Shoplo | shoplo |
| Storenvy | storenvy |
| Volusion | volusion |
| WooCommerce | woocommerce |
| WP eCommerce | wp_ecommerce |
| Zepo | zepo |
| Any other platform | general |
Error Messages
| Parameter Name | Description |
|---|---|
order_id | The ID of the purchase |
field | The field where the error occurred |
error | Description 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-spectag 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_skucannot include the "/" symbol.