Country codes for
customer.country
param:To comply with Google Seller Ratings conventions, the
customer.country
param requires
two-letter uppercase country code values from this list of compatible codes. Default country code:US
Note:
Remember to take advantage of your Kickstart Credits. We recommend sending us past orders from the last two to 4 months (make sure you don't exceed your Kickstart Credit limit).
See the Kickstart Credits guide for more information.
Important:
It is not possible to send a MAP emails for orders older than six months.
Note:
Yotpo recommends passing batches of 200 orders per request
e-Commerce 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 |
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:
- 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 only supports alphanumeric (a...z, A...Z, 0...9), "_" and "-" characters.
- The product specification value is case-sensitive.
- The product specification value “N/A” is invalid in any case and is ignored.
Note:
For a list of ISO currency codes, go to http://www.currency-iso.org/en/home/tables/table-a1.html
Note:
The product ID only supports alphanumeric (a...z, A...Z, 0...9), "_" and "-" characters without spaces.
Sending an invalid character in the product ID will cause the transaction to be ignored with
no indication of failure.
Error Messages
If there is an error in the data that you submit, you receive an errors object in the response with the following information:
Parameter Name | Description |
---|---|
order_num | The position of the purchase (order) in the list that you submitted. |
order_id | The ID of the purchase |
field | The field where the error occurred. In the example below, the field is the user email. |
error | Description of the error in the field. |
Note:
The
product_tag
parameter can only be a single string.