What is WPML and How API2Cart Works with It
WordPress site owners, including merchants running stores on WooCommerce, often use WPML to make their sites multilingual.
WPML is made of a core plugin and add-ons. The API2Cart API returns data from the core plugin named WPML Multilingual CMS that manages the information organized by secondary modules like WPML Media, WPML Translation Management, and WPML String Translation.
Note: it is obligatory that all the plugins including WooCommerce Multilingual are activated. Otherwise, the WPML information (wpml_info) might not be returned or returned partly.
Practical tips
To see what languages are active on a WooCommerce store, call the cart.info API method together with the force_all parameter. In the response, you will see them listed in the store_languages array. If the seller uses WooCommerce mutisite, store_languages is returned for the stores that use WPML.
-
See an example response.
{ "return_code":0, "return_message":"", "result":{ "name":"Store 1", "url":"http://test.com", "version":"2.3.6", "db_prefix":"wp_", "stores_info":[ { "store_info":[ { "store_id":"2", "name":"Store 2", "language":"en", "store_languages":[ { "id":"1", "iso_code":"en", "name":"English" }, { "id":"41", "iso_code":"pl", "name":"Polish" }, { "id":"55", "iso_code":"uk", "name":"Ukrainian" } ], "currency":[ { "name":"", "iso3":"GBP", "symbol":"" } ], "timezone":"UTC+0", "country":"GB", "root_category_id":1, "multi_store_url":"http://test.com", "active":"True" }, { "store_id":"1", "name":"Store 1", "language":"en", "currency":[ { "name":"", "iso3":"GBP", "symbol":"" } ], "timezone":"UTC+0", "country":"GB", "root_category_id":1, "multi_store_url":"http://test.com", "active":"True" } ] } ], "shipping_zones":null } }
Use the product.list method to get all the products available on the store translated into all the languages supported. The number of languages an item is translated to determines the number of products in the response. In simple terms, if an item is translated into 3 languages, you will see three separate products.
-
See an example response.
{ "return_code":0, "return_message":"", "result":{ "products_count":3, "product":[ { "id":"255", "type":"simple", "u_model":"06137230ZU", "u_sku":null, "name":"Shirts Fruit of the loom 06137230ZU Valueweight XS 2 pcs White / Ultramarine", "description":"Fruit of the Loom - one of the most recognizable brands in the clothing market. Brand, who know, love and trusted by people around the world.", "short_description":"The brand, which is more than 160 years, remains a symbol of quality in the production of textiles.", "price":10, "quantity":9, "u_brand":null, "categories_ids":"12", "stores_ids":"", "url":"http://test.com/product=shirts-fruit-of-the-loom-06137230zu-valueweight-xs-2-pcs-white-ultramarine", "seo_url":null, "meta_title":"", "meta_keywords":"", "meta_description":"", "avail_sale":"True", "avail_view":"True", "weight":0, "sort_order":0, "backorders":"Do not allow", "manage_stock":"yes", "create_at":"2016-09-02 13:09:59", "modified_at":"2016-09-02 13:12:09", "special_price":[ { "value":0, "avail":"False", "created_at":null, "modified_at":null, "expired_at":null } ], "tier_price":null, "group_price":null, "images":[ { "item":[ { "http_path":"http://test.com/wp-content/uploads/sites/2/2016/09/fruit_06137230zu_xs_images_1637057972.jpg", "type":"IMAGE_TYPE_BASE", "mime-type":"image/jpeg", "alt":"Shirts Fruit of the loom 06137230ZU Valueweight XS 2 pcs White / Ultramarine", "avail":"True", "file_name":"fruit_06137230zu_xs_images_1637057972-300x300.jpg", "create_at":null, "modified_at":null, "size":null, "sort_order":0 } ] } ], "product_options":[ { "option":[ { "id":"pa_color", "product_option_id":null, "name":"Color", "type":"select", "required":"False", "option_value":[ { "value":[ { "id":"blue", "product_option_value_id":null, "name":"Blue", "price":"+0", "type_price":"value", "weight":"+0", "quantity":null }, { "id":"red", "product_option_value_id":null, "name":"Red", "price":"+0", "type_price":"value", "weight":"+0", "quantity":null } ] } ] } ] } ], "product_variants":null, "stores_info":null, "u_upc":null, "u_mpn":null, "categories":null, "related_products_ids":"", "viewed_count":0, "ordered_count":0, "tax_class":[ { "tax_class_id":"1", "name":"Standard", "created_at":null, "modified_at":null, "value":0, "avail":"False", "value_type":1, "tax_rates":null } ], "wpml_info":[ { "translation":[ { "product_id":"255", "language_id":"1" }, { "product_id":"259", "language_id":"41" }, { "product_id":"260", "language_id":"55" } ] } ], "length":"", "width":"", "height":"", "stock_status":"In stock", "custom_total_sales":"0", "custom_custom_field":"value" }, { "id":"259", "type":"simple", "u_model":"06137230ZU", "u_sku":null, "name":"Koszulki Fruit of-Tkhe Looma 06137230ZU Valueveight 2 XC DSP VNITI / ultramaryna", "description":"Fruit of the Loom - jedna z najbardziej rozpoznawalnych marek na rynku odzieżowym. Brand, którzy wiedzą, miłość i zaufanie ludzi na całym świecie.", "short_description":"Marka, która jest czymś więcej niż 160 lat, pozostaje symbolem jakości w produkcji tekstyliów.", "price":10, "quantity":9, "u_brand":null, "categories_ids":"33", "stores_ids":"", "url":"http://test.com/product=koszule-owoce-of-the-tkalni-06137230zu-valueweight-xs-2-szt-bialo-ultramaryna", "seo_url":null, "meta_title":"", "meta_keywords":"", "meta_description":"", "avail_sale":"True", "avail_view":"True", "weight":0, "sort_order":0, "backorders":"Do not allow", "manage_stock":"yes", "create_at":"2016-09-02 13:09:59", "modified_at":"2016-09-02 13:13:37", "special_price":[ { "value":0, "avail":"False", "created_at":null, "modified_at":null, "expired_at":null } ], "tier_price":null, "group_price":null, "images":[ { "item":[ { "http_path":"http://test.com//wp-content/uploads/sites/2/2016/09/fruit_06137230zu_xs_images_1637057972.jpg", "type":"IMAGE_TYPE_BASE", "mime-type":"image/jpeg", "alt":"Koszulki Fruit of-Tkhe Looma 06137230ZU Valueveight 2 XC DSP VNITI / ultramaryna", "avail":"True", "file_name":"fruit_06137230zu_xs_images_1637057972-300x300.jpg", "create_at":null, "modified_at":null, "size":null, "sort_order":0 } ] } ], "product_options":[ { "option":[ { "id":"pa_color", "product_option_id":null, "name":"Color", "type":"select", "required":"False", "option_value":[ { "value":[ { "id":"blue-pl", "product_option_value_id":null, "name":"Blue", "price":"+0", "type_price":"value", "weight":"+0", "quantity":null }, { "id":"red-pl", "product_option_value_id":null, "name":"Red", "price":"+0", "type_price":"value", "weight":"+0", "quantity":null } ] } ] } ] } ], "product_variants":null, "stores_info":null, "u_upc":null, "u_mpn":null, "categories":null, "related_products_ids":"", "viewed_count":0, "ordered_count":0, "tax_class":[ { "tax_class_id":"1", "name":"Standard", "created_at":null, "modified_at":null, "value":0, "avail":"False", "value_type":1, "tax_rates":null } ], "wpml_info":[ { "translation":[ { "product_id":"255", "language_id":"1" }, { "product_id":"259", "language_id":"41" }, { "product_id":"260", "language_id":"55" } ] } ], "length":"", "width":"", "height":"", "stock_status":"In stock", "custom_total_sales":"0", "custom_custom_field":"value" }, { "id":"260", "type":"simple", "u_model":"06137230ZU", "u_sku":null, "name":"Футболки Fruit of the loom 06137230ZU Valueweight XS 2 шт Біла / Ультрамарин", "description":"Fruit of the Loom - один з найбільш відомих брендів на ринку одягу. Бренд, який знають, люблять і якому довіряють люди по всьому світу.", "short_description":"Бренд, який понад 160 років залишається символом якості у виробництві текстилю.", "price":10, "quantity":9, "u_brand":null, "categories_ids":"34", "stores_ids":"", "url":"http://test.com/product=shirts-fruit-of-the-loom-06137230zu-valueweight-xs-2-pcs-white-ultramarine-ua", "seo_url":null, "meta_title":"", "meta_keywords":"", "meta_description":"", "avail_sale":"True", "avail_view":"True", "weight":0, "sort_order":0, "backorders":"Do not allow", "manage_stock":"yes", "create_at":"2016-09-02 13:09:59", "modified_at":"2016-09-02 13:15:17", "special_price":[ { "value":0, "avail":"False", "created_at":null, "modified_at":null, "expired_at":null } ], "tier_price":null, "group_price":null, "images":[ { "item":[ { "http_path":"http://test.com/wp-content/uploads/sites/2/2016/09/fruit_06137230zu_xs_images_1637057972.jpg", "type":"IMAGE_TYPE_BASE", "mime-type":"image/jpeg", "alt":"Футболки Fruit of the loom 06137230ZU Valueweight XS 2 шт Біла / Ультрамарин", "avail":"True", "file_name":"fruit_06137230zu_xs_images_1637057972-300x300.jpg", "create_at":null, "modified_at":null, "size":null, "sort_order":0 } ] } ], "product_options":[ { "option":[ { "id":"pa_color", "product_option_id":null, "name":"Color", "type":"select", "required":"False", "option_value":[ { "value":[ { "id":"blue-uk", "product_option_value_id":null, "name":"Blue", "price":"+0", "type_price":"value", "weight":"+0", "quantity":null }, { "id":"red-uk", "product_option_value_id":null, "name":"Red", "price":"+0", "type_price":"value", "weight":"+0", "quantity":null } ] } ] } ] } ], "product_variants":null, "stores_info":null, "u_upc":null, "u_mpn":null, "categories":null, "related_products_ids":"", "viewed_count":0, "ordered_count":0, "tax_class":[ { "tax_class_id":"1", "name":"Standard", "created_at":null, "modified_at":null, "value":0, "avail":"False", "value_type":1, "tax_rates":null } ], "wpml_info":[ { "translation":[ { "product_id":"255", "language_id":"1" }, { "product_id":"259", "language_id":"41" }, { "product_id":"260", "language_id":"55" } ] } ], "length":"", "width":"", "height":"", "stock_status":"In stock", "custom_total_sales":"0", "custom_custom_field":"value" } ] } }
The same applies to product variants that are returned in the response of the product.variant.list method.
You can filter products and variants by language using the language_id parameter.
-
See an example response.
{ "return_code":0, "return_message":"", "result":{ "variants_count":5, "variant":[ { "id":"148", "u_model":"2020012292109", "name":"Variation #136 of Bluzki Oodji", "price":59, "url":"http://test.com/unittest/post_type=product&p=147", "create_at":"2016-09-02 09:57:15", "wpml_info":[ { "translation":[ { "product_id":"141", "variant_id":"142", "language_id":"1" }, { "product_id":"135", "variant_id":"136", "language_id":"55" } ] } ] }, { "id":"149", "u_model":"2020012292109", "name":"Variation #137 of Bluzki Oodji", "price":54.9, "url":"http://test.com/post_type=product&p=147", "create_at":"2016-09-02 09:57:15", "wpml_info":[ { "translation":[ { "product_id":"141", "variant_id":"143", "language_id":"1" }, { "product_id":"135", "variant_id":"137", "language_id":"55" } ] } ] }, { "id":"150", "u_model":"2020012292109", "name":"Variation #138 of Bluzki Oodji", "price":69, "url":"http://test.com/post_type=product&p=147", "create_at":"2016-09-02 09:57:15", "wpml_info":[ { "translation":[ { "product_id":"141", "variant_id":"144", "language_id":"1" }, { "product_id":"135", "variant_id":"138", "language_id":"55" } ] } ] }, { "id":"151", "u_model":"2020012292109", "name":"Variation #139 of Bluzki Oodji", "price":69, "url":"http://test.com/post_type=product&p=147", "create_at":"2016-09-02 09:57:15", "wpml_info":[ { "translation":[ { "product_id":"141", "variant_id":"145", "language_id":"1" }, { "product_id":"135", "variant_id":"139", "language_id":"55" } ] } ] }, { "id":"152", "u_model":"2020012292109", "name":"Variation #140 of Bluzki Oodji", "price":0, "url":"http://test.com/post_type=product&p=147", "create_at":"2016-09-02 09:57:15", "wpml_info":[ { "translation":[ { "product_id":"141", "variant_id":"146", "language_id":"1" }, { "product_id":"135", "variant_id":"140", "language_id":"55" } ] } ] } ] } }
