{ "openapi": "3.1.1", "info": { "title": "API2Cart OpenAPI", "version": "1.1", "description": "API2Cart", "termsOfService": "https://api2cart.com/terms-service", "contact": { "email": "contact@api2cart.com" } }, "servers": [ { "url": "https://api.api2cart.com/v1.1", "description": "API2Cart Production Server" } ], "tags": [ { "name": "account" }, { "name": "cart" }, { "name": "product" }, { "name": "marketplace" }, { "name": "category" }, { "name": "order" }, { "name": "customer" }, { "name": "attribute" }, { "name": "tax" }, { "name": "webhook" }, { "name": "batch" } ], "paths": {"/account.failed_webhooks.json":{"get":{"tags":["account"],"summary":"account.failed_webhooks","description":"If the callback of your service for some reason could not accept webhooks from API2Cart, then with the help of this method you can get a list of missed webhooks to perform synchronization again using entity_id. Please note that we keep such records for 24 hours.","security":[{"ApiKeyAuth":[]}],"operationId":"AccountFailedWebhooks","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"all_failed_webhook":{"type":"string"},"webhook":{"type":"array","items":{"type":"object","properties":{"webhook_id":{"type":"integer"},"entity_id":{"type":"string"},"time":{"$ref":"#/components/schemas/A2CDateTime"}}}}}}}}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"ids","description":"List of \u0441omma-separated webhook ids","schema":{"type":"string"},"example":"3,14,25","in":"query","required":false}]}},"/account.supported_platforms.json":{"get":{"tags":["account"],"summary":"account.supported_platforms","description":"Use this method to retrieve a list of supported platforms and the sets of parameters required for connecting to each of them. Note: some platforms may have multiple connection methods so that the response will contain multiple sets of parameters.","security":[{"ApiKeyAuth":[]}],"operationId":"AccountSupportedPlatforms","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"supported_platforms":{"type":"array","items":{"type":"object","properties":{"cart_id":{"type":"string"},"cart_name":{"type":"string"},"cart_versions":{"type":"string"},"cart_method":{"type":"string"},"params":{"type":"object","properties":{"required":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}},"additional":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}}}}}}}}}}},"parameters":[]}},"/account.cart.list.json":{"get":{"tags":["account"],"summary":"account.cart.list","description":"This method lets you get a list of online stores connected to your API2Cart account. You can get the number of API requests to each store if you specify a period using parameters (request_from_date, request_to_date). The total_calls field is displayed only if there are parameters (request_from_date, request_to_date).","security":[{"ApiKeyAuth":[]}],"operationId":"AccountCartList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"carts_count":{"type":"integer"},"carts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"store_key":{"type":"string"},"cart_id":{"type":"string"},"custom_label":{"type":"string"},"bridge_version":{"type":"string"},"total_calls":{"type":"string"}}}}}}}}}}}},"parameters":[{"name":"store_url","description":"A web address of a store","schema":{"type":"string"},"example":"http://mystore.com","in":"query","required":false},{"name":"store_key","description":"Find store by store key","schema":{"type":"string"},"example":"ab37fc230bc5df63a5be1b11220949be","in":"query","required":false},{"name":"request_from_date","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29","in":"query","required":false},{"name":"request_to_date","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29","in":"query","required":false},{"name":"custom_label","description":"Defines a custom label for the store in the app","schema":{"type":"string"},"example":"This is test store","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all"},"example":"url,store_key","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"url,store_key","in":"query","required":false}]}},"/account.cart.add.json":{"post":{"tags":["account"],"summary":"account.cart.add","description":"Use this method to automate the process of connecting stores to API2Cart. The list of parameters will vary depending on the platform. To get a list of parameters that are specific to a particular shopping platform, you need to execute the account.supported_platforms.json method.","security":[{"ApiKeyAuth":[]}],"operationId":"AccountCartAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"store_key":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCartAdd"}}}}}},"/account.config.update.json":{"put":{"tags":["account"],"summary":"account.config.update","description":"Use this method to automate the change of credentials used to connect online stores. The list of supported parameters differs depending on the platform.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AccountConfigUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated_items":{"type":"integer"}}}}}}}}},"parameters":[{"name":"replace_parameters","description":"Identifies if there is a necessity to replace parameters","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"new_store_url","description":"The web address of the store you want to update to connect to API2Cart","schema":{"type":"string"},"example":"http://mystore.com","in":"query","required":false},{"name":"new_store_key","description":"Update store key","schema":{"type":"string"},"example":"b636495648de3086f6f57b1bd4be548f","in":"query","required":false},{"name":"custom_label","description":"Defines a custom label for the store in the app","schema":{"type":"string"},"example":"This is test store","in":"query","required":false},{"name":"bridge_url","description":"This parameter allows to set up store with custom bridge url (also you must use store_root parameter if a bridge folder is not in the root folder of the store)","schema":{"type":"string"},"example":"https://your-store.com/custom/bridge/path/bridge.php","in":"query","required":false},{"name":"store_root","description":"Absolute path to the store root directory (used with \"bridge_url\" parameter)","schema":{"type":"string"},"example":"/home/www/stores/magento1922","in":"query","required":false},{"name":"db_tables_prefix","description":"DB tables prefix","schema":{"type":"string"},"example":"oc_","in":"query","required":false},{"name":"user_agent","description":"This parameter allows you to set your custom user agent, which will be used in requests to the store. Please use it cautiously, as the store's firewall may block specific values.","schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0","in":"query","required":false},{"name":"3dcart_private_key","description":"3DCart Private Key","schema":{"type":"string"},"example":"7dba81f90bdbe25e7000e73214ca51b","in":"query","required":false},{"name":"3dcart_access_token","description":"3DCart Token","schema":{"type":"string"},"example":"4Grr_ZCLNNoSUuhAjesKuchxo9SL","in":"query","required":false},{"name":"3dcartapi_api_key","description":"3DCart API Key","schema":{"type":"string"},"example":"82cc921c6a5c67082cc921c6a5c6707e1d6e6862ba3201a","in":"query","required":false},{"name":"amazon_sp_client_id","description":"Amazon SP API app client id","schema":{"type":"string"},"example":"amzn1.application-oa2-client.11e000e1f47d4998aca3733716d3b5a4","in":"query","required":false},{"name":"amazon_sp_client_secret","description":"Amazon SP API app client secret","schema":{"type":"string"},"example":"2c987428209f235443221255bde064f4bdf8a65165a80f5d22760a83cb","in":"query","required":false},{"name":"amazon_sp_refresh_token","description":"Amazon SP API OAuth refresh token","schema":{"type":"string"},"example":"Atzr|IwEBIPUI-bwRTdDgKNQ_g56C30wGqymtx30c9MdDC7Emwmojhs20k5BBG2hHtJiGZ_7OfG7khd1RuQr6KEst4qyWbo_eXi5S_T_VOxzJUuksG1cFOGFpFK-cnhReNzAeZIpZeJT7_ROy1csEFlQfC8FJS3bsbSkkbTz2ZcTN7_7ey0HVlhyfFizgROeSeOI24Wjs9l_KKzZW0jvi_oC2cxlIcyknnHLK6KMNz2rTXqQJWRtlK9xPJDdbcUa5STA8MQru91cxNBpSkZN_cq9OOELhbsIGKD75y7nZ3yJU4uHQC_9iBQQoFm0biKgi-kEQwOhwws8","in":"query","required":false},{"name":"amazon_sp_aws_region","description":"Amazon AWS Region","schema":{"type":"string"},"example":"us-east-1","in":"query","required":false},{"name":"amazon_sp_api_environment","description":"Amazon SP API environment","schema":{"type":"string","default":"production"},"example":"sandbox","in":"query","required":false},{"name":"amazon_seller_id","description":"Amazon Seller ID (Merchant token)","schema":{"type":"string"},"example":"13P636B2M1N4WR","in":"query","required":false},{"name":"aspdotnetstorefront_api_user","description":"It's a AspDotNetStorefront account for which API is available","schema":{"type":"string"},"example":"admin","in":"query","required":false},{"name":"aspdotnetstorefront_api_pass","description":"AspDotNetStorefront API Password","schema":{"type":"string"},"example":"f6471ef78f72b41849a8b8b67791b0b5","in":"query","required":false},{"name":"americommerce_app_id","description":"Americommerce App ID","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"americommerce_app_secret","description":"Americommerce App Secret","schema":{"type":"string"},"example":"9fd3d282d65a007a2b9d541b5e0e410b2cecd6199632db53503b93637b8a6000","in":"query","required":false},{"name":"americommerce_access_token","description":"Americommerce Access Token","schema":{"type":"string"},"example":"1e721f59b610e2666caea03094600765","in":"query","required":false},{"name":"americommerce_refresh_token","description":"Americommerce Refresh Token","schema":{"type":"string"},"example":"520c011444af41d916543cdda859a5114","in":"query","required":false},{"name":"bigcommerceapi_admin_account","description":"It's a BigCommerce account for which API is enabled","schema":{"type":"string"},"example":"admin","in":"query","required":false},{"name":"bigcommerceapi_api_path","description":"BigCommerce API URL","schema":{"type":"string"},"example":"http://mystore.bigcommerce.com/api/v1","in":"query","required":false},{"name":"bigcommerceapi_api_key","description":"Bigcommerce API Key","schema":{"type":"string"},"example":"6b89704cd75738cb0f9f6468d5462aba","in":"query","required":false},{"name":"bigcommerceapi_client_id","description":"Client ID of the requesting app","schema":{"type":"string"},"example":"p1r37bt131z86675nofv9xmhietoe4t","in":"query","required":false},{"name":"bigcommerceapi_access_token","description":"Access token authorizing the app to access resources on behalf of a user","schema":{"type":"string"},"example":"igse8e4rdmzkxdi937qe69d59en1imw","in":"query","required":false},{"name":"bigcommerceapi_context","description":"API Path section unique to the store","schema":{"type":"string"},"example":"stores/etplnf8o8v","in":"query","required":false},{"name":"bol_api_key","description":"Bol API Key","schema":{"type":"string"},"example":"51369628-feee-11ed-be56-0242ac120002","in":"query","required":false},{"name":"bol_api_secret","description":"Bol API Secret","schema":{"type":"string"},"example":"8fGzEsbEP5z2MNZubmIil87m-sWzTkj?KDQKrmzmU!fA6aAUNMdKRp7LMWHwE!G37UMfnWByHBGSXJHkAG?QcuYTO2uklv4idIHwUMLHK!OO1yfRlWh!","in":"query","required":false},{"name":"bol_retailer_id","description":"Bol Retailer ID","schema":{"type":"integer"},"example":"145001","in":"query","required":false},{"name":"demandware_client_id","description":"Demandware client id","schema":{"type":"string"},"example":"b849eb85-v8b9-1dw8-9fe2-97e1d6ffc7b0","in":"query","required":false},{"name":"demandware_api_password","description":"Demandware api password","schema":{"type":"string"},"example":"testpassword","in":"query","required":false},{"name":"demandware_user_name","description":"Demandware user name","schema":{"type":"string"},"example":"admin","in":"query","required":false},{"name":"demandware_user_password","description":"Demandware user password","schema":{"type":"string"},"example":"12345","in":"query","required":false},{"name":"ebay_client_id","description":"Application ID (AppID).","schema":{"type":"string"},"example":"a9psel85v1wy5faeyjw03y0r","in":"query","required":false},{"name":"ebay_client_secret","description":"Shared Secret from eBay application","schema":{"type":"string"},"example":"gmz3iz45x2","in":"query","required":false},{"name":"ebay_runame","description":"The RuName value that eBay assigns to your application.","schema":{"type":"string"},"example":"gmz3iz45x2","in":"query","required":false},{"name":"ebay_access_token","description":"Used to authenticate API requests.","schema":{"type":"string"},"example":"v^1.1#i ... AjRV4yNjA=","in":"query","required":false},{"name":"ebay_refresh_token","description":"Used to renew the access token.","schema":{"type":"string"},"example":"v^1.1#i ... rAewqVasdA=","in":"query","required":false},{"name":"ebay_environment","description":"eBay environment","schema":{"type":"string"},"example":"sandbox","in":"query","required":false},{"name":"ebay_site_id","description":"eBay global ID","schema":{"type":"integer","default":0},"example":"101","in":"query","required":false},{"name":"ecwid_acess_token","description":"Access token authorizing the app to access resources on behalf of a user","schema":{"type":"string"},"example":"igse8e4rdmzkxdi937qe69d59en1imw","in":"query","required":false},{"name":"ecwid_store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lazada_app_id","description":"Lazada App ID","schema":{"type":"string"},"example":"112577","in":"query","required":false},{"name":"lazada_app_secret","description":"Lazada App Secret","schema":{"type":"string"},"example":"er33raICJ79Q5b0EsR9stmRnjE9XQ2WH","in":"query","required":false},{"name":"lazada_refresh_token","description":"Lazada Refresh Token","schema":{"type":"string"},"example":"EAAPP06rM2n8BO4mZBuMPnu9zS0MaMbN7ue8aUkcxw4zewU337mVVb5br","in":"query","required":false},{"name":"lazada_region","description":"Lazada API endpoint Region","schema":{"type":"string"},"example":"Malaysia","in":"query","required":false},{"name":"etsy_keystring","description":"Etsy keystring","schema":{"type":"string"},"example":"a9psel85v1wy5faeyjw03y0r","in":"query","required":false},{"name":"etsy_shared_secret","description":"Etsy shared secret","schema":{"type":"string"},"example":"gmz3iz45x2","in":"query","required":false},{"name":"etsy_access_token","description":"Access token authorizing the app to access resources on behalf of a user","schema":{"type":"string"},"example":"igse8e4rdmzkxdi937qe69d59en1imw","in":"query","required":false},{"name":"etsy_token_secret","description":"Secret token authorizing the app to access resources on behalf of a user","schema":{"type":"string"},"example":"igse8e4rdmzkxdi937qe69d59en1imw","in":"query","required":false},{"name":"etsy_client_id","description":"Etsy Client Id","schema":{"type":"string"},"example":"w0fi0igk2w29bjcd7ydr2s35","in":"query","required":false},{"name":"etsy_refresh_token","description":"Etsy Refresh token","schema":{"type":"string"},"example":"223577551.L07_RE-y7unmKf2dox4djsHkVxwpUfs1ikG_uQmHhF-aASEReNn_Qns1Wqn3dDa0ZMxrt9CIael3dgudeDZb31ZUdS","in":"query","required":false},{"name":"facebook_app_id","description":"Facebook App ID","schema":{"type":"string"},"example":"6516912365277570","in":"query","required":false},{"name":"facebook_app_secret","description":"Facebook App Secret","schema":{"type":"string"},"example":"737cf6bd2879cb6c7e5a8ff9cd63f3d46b0b5b7b","in":"query","required":false},{"name":"facebook_access_token","description":"Facebook Access Token","schema":{"type":"string"},"example":"EAAPP06rM2n8BO4mZBuMPnu9zS0MaMbN7ue8aUAhqbS58clzJwyp1rYRMpP31QJGziqtYbKypdVx3Cs0RpuufoUeLsbfX195XIB8VTlkcxw4zewU337mVVb5br","in":"query","required":false},{"name":"facebook_business_id","description":"Facebook Business ID","schema":{"type":"string"},"example":"294042786906655","in":"query","required":false},{"name":"neto_api_key","description":"Neto API Key","schema":{"type":"string"},"example":"bbca57d8ff3c3677128112c15556d9e3","in":"query","required":false},{"name":"neto_api_username","description":"Neto User Name","schema":{"type":"string"},"example":"mylogin","in":"query","required":false},{"name":"shopline_access_token","description":"Shopline APP Key","schema":{"type":"string"},"example":"igse8e4rdmzkxdi937qe69d59en1imw","in":"query","required":false},{"name":"shopline_app_key","description":"Shopline APP Key","schema":{"type":"string"},"example":"737cf6bd2879cb6c7e5a8ff9cd63f3d46b0b5b7b","in":"query","required":false},{"name":"shopline_app_secret","description":"Shopline App Secret","schema":{"type":"string"},"example":"1701d123bb5cc14cd2732dcaed90638316c0a09","in":"query","required":false},{"name":"shopline_shared_secret","description":"Shopline Shared Secret","schema":{"type":"string"},"example":"1701d123bb5cc14cd2732dcaed90638316c0a09","in":"query","required":false},{"name":"shopify_access_token","description":"Access token authorizing the app to access resources on behalf of a user","schema":{"type":"string"},"example":"igse8e4rdmzkxdi937qe69d59en1imw","in":"query","required":false},{"name":"shopify_client_id","description":"Shopify Client ID","schema":{"type":"string"},"example":"b5defe55db3f6836fb4e0e6624ff9577","in":"query","required":false},{"name":"shopify_api_key","description":"Shopify API Key","schema":{"type":"string"},"example":"bbca57d8ff3c3677128112c15556d9e3","in":"query","required":false},{"name":"shopify_api_password","description":"Shopify API Password","schema":{"type":"string"},"example":"860f3a6fc87632301a42cd88e4b5ab3d","in":"query","required":false},{"name":"shopify_shared_secret","description":"Shared secret","schema":{"type":"string"},"example":"gmz3iz45x2","in":"query","required":false},{"name":"shopee_partner_id","description":"Shopee Partner ID","schema":{"type":"string"},"example":"1276777","in":"query","required":false},{"name":"shopee_partner_key","description":"Shopee Partner Key","schema":{"type":"string"},"example":"6a46494b4d746576554646626775617a577542774850636375464d6a736d5598","in":"query","required":false},{"name":"shopee_shop_id","description":"Shopee SHOP ID","schema":{"type":"string"},"example":"137968","in":"query","required":false},{"name":"shopee_refresh_token","description":"Shopee Refresh Token","schema":{"type":"string"},"example":"EAAPP06rM2n8BO4mZBuMPnu9zS0MaMbN7ue8aUkcxw4zewU987mVVb5br","in":"query","required":false},{"name":"shopee_region","description":"Shopee API endpoint Region. Use for Chinese Mainland or Brazil.","schema":{"type":"string"},"example":"CN","in":"query","required":false},{"name":"shopee_environment","description":"Shopee Environment","schema":{"type":"string"},"example":"sandbox","in":"query","required":false},{"name":"shoplazza_access_token","description":"Access token authorizing the app to access resources on behalf of a user","schema":{"type":"string"},"example":"igse8e4rdmzkxdi937qe69d59en1imw","in":"query","required":false},{"name":"shoplazza_shared_secret","description":"Shared secret","schema":{"type":"string"},"example":"gmz3iz45x2","in":"query","required":false},{"name":"miva_access_token","description":"Miva access token","schema":{"type":"string"},"example":"227cbe434a1e358d72db0de993x9d9fd","in":"query","required":false},{"name":"miva_signature","description":"Miva signature","schema":{"type":"string"},"example":"1hpkrebfdsObGTor/0Gk9XcNBUQohrxrw67Sg9AM9ps=","in":"query","required":false},{"name":"mirakl_api_key","description":"Mirakl API Key","schema":{"type":"string"},"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","in":"query","required":false},{"name":"shopware_access_key","description":"Shopware access key","schema":{"type":"string"},"example":"SWSCS3O1RJBSRNBYQLFIYJN2ZQ","in":"query","required":false},{"name":"unas_api_key","description":"UNAS API Key","schema":{"type":"string"},"example":"c238908e29ceb6e6ad3df15f89a6234709d3f000","in":"query","required":false},{"name":"shopware_api_key","description":"Shopware api key","schema":{"type":"string"},"example":"SWSCS3O1RJBSRNBYQLFIYJN2ZQ","in":"query","required":false},{"name":"shopware_api_secret","description":"Shopware client secret access key","schema":{"type":"string"},"example":"V3NYNWg2b1dZdHBUWDN1cmdKdGhnenp5enVJYlJ0WlJvOFF2bnQ","in":"query","required":false},{"name":"bigcartel_user_name","description":"Subdomain of store","schema":{"type":"string"},"example":"subdomain","in":"query","required":false},{"name":"bigcartel_password","description":"BigCartel account password","schema":{"type":"string"},"example":"4GrrZCLNNoSUuhAjesKuchxo9SL","in":"query","required":false},{"name":"bricklink_consumer_key","description":"Bricklink Consumer Key","schema":{"type":"string"},"example":"26F6CDA087D9444EAA71AC09E7A1D39A","in":"query","required":false},{"name":"bricklink_consumer_secret","description":"Bricklink Consumer Secret","schema":{"type":"string"},"example":"a46abc3kxyinlbggy06i9g975xqo6gjq","in":"query","required":false},{"name":"bricklink_token","description":"Bricklink Access Token","schema":{"type":"string"},"example":"ktv4n9rgrj0evjuy2t6p2xlb1f8u5pmy","in":"query","required":false},{"name":"bricklink_token_secret","description":"Bricklink Access Token Secret","schema":{"type":"string"},"example":"a46abc3kxyinlbggy06i9g975xqo6gjq","in":"query","required":false},{"name":"nopcommerce_token","description":"Access token authorizing the app to access resources on behalf of a user","schema":{"type":"string"},"example":"igse8e4rdmzkxdi937qe69d59en1imw","in":"query","required":false},{"name":"volusion_login","description":"It's a Volusion account for which API is enabled","schema":{"type":"string"},"example":"admin","in":"query","required":false},{"name":"volusion_password","description":"Volusion API Password","schema":{"type":"string"},"example":"7943CA5F3990E00D9A4CCF0BD998211F","in":"query","required":false},{"name":"walmart_client_id","description":"Walmart client ID. For the region 'ca' use Consumer ID","schema":{"type":"string"},"example":"423f6A24-123z-8654-989u-6fa96478289","in":"query","required":false},{"name":"walmart_client_secret","description":"Walmart client secret. For the region 'ca' use Private Key","schema":{"type":"string"},"example":"1gf85fea-8974-2648-w12w-rt54284tdf54","in":"query","required":false},{"name":"walmart_environment","description":"Walmart environment","schema":{"type":"string","default":"production"},"example":"production","in":"query","required":false},{"name":"walmart_channel_type","description":"Walmart WM_CONSUMER.CHANNEL.TYPE header","schema":{"type":"string"},"example":"0f3e4dd4-0514-4346-b39d-af0e00ea066d","in":"query","required":false},{"name":"walmart_region","description":"Walmart region","schema":{"type":"string","default":"us"},"example":"us","in":"query","required":false},{"name":"square_client_id","description":"Square (Weebly) Client ID","schema":{"type":"string"},"example":"sq0idp-qwer_1pvuTYe9cAf1lmxyQ","in":"query","required":false},{"name":"square_client_secret","description":"Square (Weebly) Client Secret","schema":{"type":"string"},"example":"c8d7077fce7b2b111111111898170695a01473a2ad","in":"query","required":false},{"name":"square_refresh_token","description":"Square (Weebly) Refresh Token","schema":{"type":"string"},"example":"EQAAlquVXMr6xIcPu7qPkIEAZ0thqChhQuowrvZIqOlwhOwhtmyh4ZRfesdRc434","in":"query","required":false},{"name":"squarespace_api_key","description":"Squarespace API Key","schema":{"type":"string"},"example":"8f7849d5-1411-47f2-9722-aa81c2a48d95","in":"query","required":false},{"name":"squarespace_client_id","description":"Squarespace Connector Client ID","schema":{"type":"string"},"example":"9UGbUtS2V96BxRGmfOjsGAhTdsr9Vxxx","in":"query","required":false},{"name":"squarespace_client_secret","description":"Squarespace Connector Client Secret","schema":{"type":"string"},"example":"GPZkUFkIKWg0KLE6rajsFMMYA9ma0udaaq2bYwBDXXX=","in":"query","required":false},{"name":"squarespace_access_token","description":"Squarespace access token","schema":{"type":"string"},"example":"SWSCS3O1RJBSRNBYQLFIYJN2ZQ","in":"query","required":false},{"name":"squarespace_refresh_token","description":"Squarespace refresh token","schema":{"type":"string"},"example":"def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d","in":"query","required":false},{"name":"hybris_client_id","description":"Omni Commerce Connector Client ID","schema":{"type":"string"},"example":"api_client_1","in":"query","required":false},{"name":"hybris_client_secret","description":"Omni Commerce Connector Client Secret","schema":{"type":"string"},"example":"secret_phrase_1","in":"query","required":false},{"name":"hybris_username","description":"User Name","schema":{"type":"string"},"example":"admin","in":"query","required":false},{"name":"hybris_password","description":"User password","schema":{"type":"string"},"example":"nimda","in":"query","required":false},{"name":"hybris_websites","description":"Websites to stores mapping data","schema":{"type":"array","items":{"type":"string"}},"example":"hybris_websites[0][uid]=apparel-website&hybris_websites[0][url]=https://apparel.local/yacceleratorstorefront&hybris_websites[0][storeIds][0]=apparel-de&hybris_websites[0][storeIds][1]=apparel-uk","in":"query","required":false},{"name":"lightspeed_api_key","description":"LightSpeed api key","schema":{"type":"string"},"example":"cf5444729c2abd6b6a5d983691767cb5","in":"query","required":false},{"name":"lightspeed_api_secret","description":"LightSpeed api secret","schema":{"type":"string"},"example":"2620ee52a8bc942f9d5d3a575f4d363e","in":"query","required":false},{"name":"commercehq_api_key","description":"CommerceHQ api key","schema":{"type":"string"},"example":"sJrD-LM0eddhe63rfgfva0dDydXfre4","in":"query","required":false},{"name":"commercehq_api_password","description":"CommerceHQ api password","schema":{"type":"string"},"example":"4Grr_ZCLNNoSUuhAjesKuchxo9SL","in":"query","required":false},{"name":"wc_consumer_key","description":"Woocommerce consumer key","schema":{"type":"string"},"example":"ck_26d8e2ad604f3917e429df6961722282bdcf109d","in":"query","required":false},{"name":"wc_consumer_secret","description":"Woocommerce consumer secret","schema":{"type":"string"},"example":"cs_931ced666118a15c5f7b4a33a15gf5589cbeba55","in":"query","required":false},{"name":"magento_consumer_key","description":"Magento Consumer Key","schema":{"type":"string"},"example":"ktv4n9rgrj0evjuy2t6p2xlb1f8u5pmy","in":"query","required":false},{"name":"magento_consumer_secret","description":"Magento Consumer Secret","schema":{"type":"string"},"example":"a46abc3kxyinlbggy06i9g975xqo6gjq","in":"query","required":false},{"name":"magento_access_token","description":"Magento Access Token","schema":{"type":"string"},"example":"igse8e4rdmzkxdi937qe69d59en1imw","in":"query","required":false},{"name":"magento_token_secret","description":"Magento Token Secret","schema":{"type":"string"},"example":"igse8e4rdmzkxdi937qe69d59en1imw","in":"query","required":false},{"name":"prestashop_webservice_key","description":"Prestashop webservice key","schema":{"type":"string"},"example":"CKJ1ZEWRJWRLTPVBQJ9FGGRORD4AGS96","in":"query","required":false},{"name":"wix_app_id","description":"Wix App ID","schema":{"type":"string"},"example":"6b0b5b7b-7d87-45b5-bf34-ac6b438e63da","in":"query","required":false},{"name":"wix_app_secret_key","description":"Wix App Secret Key","schema":{"type":"string"},"example":"316c0a09-f195-42be-74f6-a02cebb9cae6","in":"query","required":false},{"name":"wix_instance_id","description":"Wix Instance ID","schema":{"type":"string"},"example":"58b893a4-6b16-5c2f-qt78-qa3r61t32rt8","in":"query","required":false},{"name":"wix_refresh_token","description":"Wix refresh token","schema":{"type":"string"},"example":"\n OAUTH2.eyJraWQiOiJkZ0x3cjNRMCIsImFsZyI6IkhTMjU2In0.\n eyJkYXRhIjoie1wiaWRcIjpcImJlZjM3MmRmLTUyNGItNDI3NS05M2RkL\n Tg4NDBlOTU3ZWU2OFwifSIsImlhdCI6MTY0ODA0NTEyNiwiZXhwIjoxNzExMTE3MTI2fQ.\n VRR2lGSbcTVmaArtmyyhy6o4WRDwTn-nlDCQpZ97eYw\n ","in":"query","required":false},{"name":"mercado_libre_app_id","description":"Mercado Libre App ID","schema":{"type":"string"},"example":"211188015100135","in":"query","required":false},{"name":"mercado_libre_app_secret_key","description":"Mercado Libre App Secret Key","schema":{"type":"string"},"example":"e2qoG2zklLlfP7cEngEJ94YjhkejkjAm","in":"query","required":false},{"name":"mercado_libre_refresh_token","description":"Mercado Libre Refresh Token","schema":{"type":"string"},"example":"TG-63h13529vb5464110188d2x9-703754376","in":"query","required":false},{"name":"zid_client_id","description":"Zid Client ID","schema":{"type":"integer"},"example":1234,"in":"query","required":false},{"name":"zid_client_secret","description":"Zid Client Secret","schema":{"type":"string"},"example":"nl5l1lE0vxgv6cV111fHsdlOOIfb0Ms5IR7l4Igs","in":"query","required":false},{"name":"zid_access_token","description":"Zid Access Token","schema":{"type":"string"},"example":"def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d","in":"query","required":false},{"name":"zid_authorization","description":"Zid Authorization","schema":{"type":"string"},"example":"def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d","in":"query","required":false},{"name":"zid_refresh_token","description":"Zid refresh token","schema":{"type":"string"},"example":"def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d","in":"query","required":false},{"name":"jumpseller_client_id","description":"Jumpseller OAuth2 Client ID","schema":{"type":"string"},"example":"your_client_id","in":"query","required":false},{"name":"jumpseller_client_secret","description":"Jumpseller OAuth2 Client Secret","schema":{"type":"string"},"example":"your_client_secret","in":"query","required":false},{"name":"jumpseller_refresh_token","description":"Jumpseller OAuth2 refresh token","schema":{"type":"string"},"example":"your_oauth_refresh_token","in":"query","required":false},{"name":"jumpseller_login","description":"Jumpseller API login","schema":{"type":"string"},"example":"your_login","in":"query","required":false},{"name":"jumpseller_authtoken","description":"Jumpseller API auth token","schema":{"type":"string"},"example":"your_auth_token","in":"query","required":false},{"name":"flipkart_client_id","description":"Flipkart Client ID","schema":{"type":"string"},"example":"19414773883a13a850b6a52350b7246499a24","in":"query","required":false},{"name":"flipkart_client_secret","description":"Flipkart Client Secret","schema":{"type":"string"},"example":"nl5l1lE0vxgv6cV111fHsdlOOIfb0Ms5IR7l4Igs","in":"query","required":false},{"name":"allegro_client_id","description":"Allegro Client ID","schema":{"type":"string"},"example":"2915e189ce3d23d23d2327d204ae6a0bd","in":"query","required":false},{"name":"allegro_client_secret","description":"Allegro Client Secret","schema":{"type":"string"},"example":"DNHtqdL2WPIefeUhQWYgtXPS23fgbfgasdsGHHJGhg3RTFDQWFGZmVoFRT5IfkQj1E7eR5","in":"query","required":false},{"name":"allegro_access_token","description":"Allegro Access Token","schema":{"type":"string"},"example":"eyJhbGciOiJSUzI1NiIsInR5cCI6IsfddfdfdeyJ1c2VyX25hbWUiOiI5NDUxMzE1MSIsInNjb3BlIjpbImFsbGVncm86YXBpOm9yZGVyczpyZWFkIiwiYWxsZWdybzphcGk6cHJvZmlsZTp3cml0ZSIsImFsbGVncm86YXBpOnNhbGU6b2ZmZXJzOndyaXRlIiwiYWxsZWdybzphcGk6YmlsbGluZzpyZWFkIiwiYWxsZWdybzphcGk6Y2FtcGFpZ25zIiwiYWxsZWdybzphcGk6ZGlzcHV0ZXMiLCJhbGxlZ3JvOmFwaTpzYWxlOm9mZmVyczpyZWFkIiwiYWxsZWdybzphcGk6YmlkcyIsImFsbGVncm86YXBpOm9yZGVyczp3cml0ZSIsImFsbGVncm86YXBpOnBheW1lbnRzOndyaXRlIiwiYWxsZWdybzphcGk6c2FsZTpzZXR0aW5nczp3cml0ZSIsImFsbGVncm86YXBpOnByb2ZpbGU6cmVhZCIsImFsbGVncm86YXBpOnJhdGluZ3MiLCJhbGxlZ3JvOmFwaTpzYWxlOnNldHRpbmdzOnJlYWQiLCJhbGxlZ3JvOmFwaTpwYXltZW50czpyZWFkIiwiYWxsZWdybzphcGk6bWVzc2FnaW5nIl0sI","in":"query","required":false},{"name":"allegro_refresh_token","description":"Allegro Refresh Token","schema":{"type":"string"},"example":"eyJhbGciOiJSUzI1NiIsInR5cCI6IsfddfdfdeyJ1c2VyX25hbWUiOiI5NDUxMzE1MSIsInNjb3BlIjpbImFsbGVncm86YXBpOm9yZGVyczpyZWFkIiwiYWxsZWdybzphcGk6cHJvZmlsZTp3cml0ZSIsImFsbGVncm86YXBpOnNhbGU6b2ZmZXJzOndyaXRlIiwiYWxsZWdybzphcGk6YmlsbGluZzpyZWFkIiwiYWxsZWdybzphcGk6Y2FtcGFpZ25zIiwiYWxsZWdybzphcGk6ZGlzcHV0ZXMiLCJhbGxlZ3JvOmFwaTpzYWxlOm9mZmVyczpyZWFkIiwiYWxsZWdybzphcGk6YmlkcyIsImFsbGVncm86YXBpOm9yZGVyczp3cml0ZSIsImFsbGVncm86YXBpOnBheW1lbnRzOndyaXRlIiwiYWxsZWdybzphcGk6c2FsZTpzZXR0aW5nczp3cml0ZSIsImFsbGVncm86YXBpOnByb2ZpbGU6cmVhZCIsImFsbGVncm86YXBpOnJhdGluZ3MiLCJhbGxlZ3JvOmFwaTpzYWxlOnNldHRpbmdzOnJlYWQiLCJhbGxlZ3JvOmFwaTpwYXltZW50czpyZWFkIiwiYWxsZWdybzphcGk6bWVzc2FnaW5nIl0sI","in":"query","required":false},{"name":"allegro_environment","description":"Allegro Environment","schema":{"type":"string","default":"production"},"example":"sandbox","in":"query","required":false},{"name":"zoho_client_id","description":"Zoho Client ID","schema":{"type":"string"},"example":"1000.FLCHGI2LS1111111TOR4OGB697W4IX","in":"query","required":false},{"name":"zoho_client_secret","description":"Zoho Client Secret","schema":{"type":"string"},"example":"c8d7077fce7b2b111111111898170695a01473a2ad","in":"query","required":false},{"name":"zoho_refresh_token","description":"Zoho Refresh Token","schema":{"type":"string"},"example":"1000.11111111111111111111111111111111.1b3ca6f054341a111118abf928beb33b","in":"query","required":false},{"name":"zoho_region","description":"Zoho API endpoint Region","schema":{"type":"string"},"example":"Europe","in":"query","required":false},{"name":"tiendanube_user_id","description":"Tiendanube User ID","schema":{"type":"integer"},"example":1234,"in":"query","required":false},{"name":"tiendanube_access_token","description":"Tiendanube Access Token","schema":{"type":"string"},"example":"75bde7bb0b437475423e7e87c142c06052f80199","in":"query","required":false},{"name":"tiendanube_client_secret","description":"Tiendanube Client Secret","schema":{"type":"string"},"example":"5e3588f514a5ae0d0fa063d1b556531e25c83fa7e47472ed","in":"query","required":false},{"name":"otto_client_id","description":"Otto Client ID","schema":{"type":"string"},"example":"911a3dbf-d261-4763-cc81-052876465b55","in":"query","required":false},{"name":"otto_client_secret","description":"Otto Client Secret","schema":{"type":"string"},"example":"9887a82a-2879-421e-a6wc-54e986b3458c","in":"query","required":false},{"name":"otto_app_id","description":"Otto App ID","schema":{"type":"string"},"example":"6eaef6a3-822e-425b-8mc9-53750063e34d","in":"query","required":false},{"name":"otto_refresh_token","description":"Otto Refresh Token","schema":{"type":"string"},"example":"eyJhbGciOiJSUzI1NiIsInR5cCI6IsfddfdfdeyJ1c2VyX25hbWUiOiI5NDUxMzE1MSIsInNjb3BlIjpbImFsbGVncm86YXBpOm9yZGVyczpyZWFkIiwiYWxsZWdybzphcGk6cHJvZmlsZTp3cml0ZSIsImFsbGVncm86YXBpOnNhbGU6b2ZmZXJzOndyaXRlIiwiYWxsZWdybzphcGk6YmlsbGluZzpyZWFkIiwiYWxsZWdybzphcGk6Y2FtcGFpZ25zIiwiYWxsZWdybzphcGk6ZGlzcHV0ZXMiLCJhbGxlZ3JvOmFwaTpzYWxlOm9mZmVyczpyZWFkIiwiYWxsZWdybzphcGk6YmlkcyIsImFsbGVncm86YXBpOm9yZGVyczp3cml0ZSIsImFsbGVncm86YXBpOnBheW1lbnRzOndyaXRlIiwiYWxsZWdybzphcGk6c2FsZTpzZXR0aW5nczp3cml0ZSIsImFsbGVncm86YXBpOnByb2ZpbGU6cmVhZCIsImFsbGVncm86YXBpOnJhdGluZ3MiLCJhbGxlZ3JvOmFwaTpzYWxlOnNldHRpbmdzOnJlYWQiLCJhbGxlZ3JvOmFwaTpwYXltZW50czpyZWFkIiwiYWxsZWdybzphcGk6bWVzc2FnaW5nIl0sI","in":"query","required":false},{"name":"otto_environment","description":"Otto Environment","schema":{"type":"string"},"example":"sandbox","in":"query","required":false},{"name":"otto_access_token","description":"Otto Access Token","schema":{"type":"string"},"example":"eyJhbGciOiJS34535f45f54f5656deyJ1c2VyX25hbWUiOiI5NDUxMzE1MSIsInNjb3BlIjpbImFsbGVncm86YXBpOm9yZGVyczpyZWFkIiwiYWxsZWdybzphcGk6cHJvZmlsZTp3cml0ZSIsImFsbGVncm86YXBpOnNhbGU6b2ZmZXJzOndyaXRlIiwiYWxsZWdybzphcGk6YmlsbGluZzpyZWFkIiwiYWxsZWdybzphcGk6Y2FtcGFpZ25zIiwiYWxsZWdybzphcGk6ZGlzcHV0ZXMiLCJhbGxlZ3JvOmFwaTpzYWxlOm9mZmVyczpyZWFkIiwiYWxsZWdybzphcGk6YmlkcyIsImFsbGVncm86YXBpOm9yZGVyczp3cml0ZSIsImFsbGVncm86YXBpOnBheW1lbnRzOndyaXRlIiwiYWxsZWdybzphcGk6c2FsZTpzZXR0aW5nczp3cml0ZSIsImFsbGVncm86YXBpOnByb2ZpbGU6cmVhZCIsImFsbGVncm86YXBpOnJhdGluZ3MiLCJhbGxlZ3JvOmFwaTpzYWxlOnNldHRpbmdzOnJlYWQiLCJhbGxlZ3JvOmFwaTpwYXltZW50czpyZWFkIiwiYWxsZWdybzphcGk6bWVzc2FnaW5nIl0sI","in":"query","required":false},{"name":"tiktokshop_app_key","description":"TikTok Shop App Key","schema":{"type":"string"},"example":"6arbhkzno8nbv","in":"query","required":false},{"name":"tiktokshop_app_secret","description":"TikTok Shop App Secret","schema":{"type":"string"},"example":"d95820a05a0cd54fb394fcd26fgat63999b183bc","in":"query","required":false},{"name":"tiktokshop_refresh_token","description":"TikTok Shop Refresh Token","schema":{"type":"string"},"example":"TTP_NTUxZTNhYTQ2ZDk2YmRmZWNmYWY2YWY12345NGYwNjQ3YjkzYTllYjA0YmNlMw","in":"query","required":false},{"name":"tiktokshop_access_token","description":"TikTok Shop Access Token","schema":{"type":"string"},"example":"TTP_Fw8r12345kW03FYd09DG-9INtpw361hWthei12345iPJ5AUv99fLSCYD9-Uu12345TgNRzKZxi5-tfFMtdWqglEt5_iCk","in":"query","required":false},{"name":"salla_client_id","description":"Salla Client ID","schema":{"type":"string"},"example":"1bxxxcf9-5xx4-xxx-bxxf-929b8xxxxe11","in":"query","required":false},{"name":"salla_client_secret","description":"Salla Client Secret","schema":{"type":"string"},"example":"8x88axxxc25e1fxxxa1c06fxxx150xx5","in":"query","required":false},{"name":"salla_refresh_token","description":"Salla Refresh Token","schema":{"type":"string"},"example":"oxy_rt_zxxxxiY2xxZWWxxxxlU-tROxxxxx2JzS2fwzxxxxxkU.p3xxxkCIyFexxxxP50WwZYfhw5_wg1xxxxV5F-8xxXc","in":"query","required":false},{"name":"salla_access_token","description":"Salla Access Token","schema":{"type":"string"},"example":"oxy_rt_zxxxxiY2xxZWWxxxxlU-tROxxxxx2JzS2fwzxxxxxkU.p3xxxkCIyFexxxxP50WwZYfhw5_wg1xxxxV5F-8xxXc","in":"query","required":false},{"name":"temu_app_key","description":"Temu App Key","schema":{"type":"string"},"example":"4ebbc9190ae410443d65b4c2faca9811","in":"query","required":false},{"name":"temu_app_secret","description":"Temu App Secret","schema":{"type":"string"},"example":"4782d2d827276688bf4758bed55dbdd4bbe79a78","in":"query","required":false},{"name":"temu_access_token","description":"Temu Access Token","schema":{"type":"string"},"example":"uplv3hfyt5kcwoymrgnajnbl1ow5qxlz4sqhev6hl3xosz5dejrtyl2jre6","in":"query","required":false},{"name":"temu_region","description":"Temu API endpoint Region.","schema":{"type":"string"},"example":"US","in":"query","required":false},{"name":"scapi_client_id","description":"Salesforce Commerce API Client ID","schema":{"type":"string"},"example":"b941ec85-v6b2-1dw8-9fe2-98e1d6eec7b1","in":"query","required":false},{"name":"scapi_client_secret","description":"Salesforce Commerce API Client Secret","schema":{"type":"string"},"example":"testpassword","in":"query","required":false},{"name":"scapi_organization_id","description":"Salesforce Commerce Organization ID","schema":{"type":"string"},"example":"f_ecom_xxxx_001","in":"query","required":false},{"name":"scapi_short_code","description":"Salesforce Commerce Short Code","schema":{"type":"string"},"example":"zs5ksm25","in":"query","required":false},{"name":"scapi_scopes","description":"Salesforce Commerce API Scopes","schema":{"type":"string"},"example":"sfcc.catalogs,sfcc.orders,sfcc.products","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/attribute.info.json":{"get":{"tags":["attribute"],"summary":"attribute.info","description":"Get information about a specific global attribute by its ID.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeInfo","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"$ref":"#/components/schemas/StoreAttribute"}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"attribute_set_id","description":"Attribute set id","schema":{"type":"string"},"example":"4","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all"},"example":"force_all","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"name","in":"query","required":false}]}},"/attribute.count.json":{"get":{"tags":["attribute"],"summary":"attribute.count","description":"Get attributes count","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeCount","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"attributes_count":{"type":"integer"}}}}}}}}},"parameters":[{"name":"type","description":"Defines attribute's type","schema":{"type":"string"},"example":"text","in":"query","required":false},{"name":"attribute_set_id","description":"Filter items by attribute set id","schema":{"type":"string"},"example":"4","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"visible","description":"Filter items by visibility status","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"required","description":"Defines if the option is required","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"system","description":"True if attribute is system","schema":{"type":"boolean"},"example":false,"in":"query","required":false}]}},"/attribute.list.json":{"get":{"tags":["attribute"],"summary":"attribute.list","description":"Get a list of global attributes.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Attribute_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"attribute_ids","description":"Filter attributes by ids","schema":{"type":"string"},"example":"1,2,3","in":"query","required":false},{"name":"attribute_set_id","description":"Filter items by attribute set id","schema":{"type":"string"},"example":"4","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Retrieves attributes on specified language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"type","description":"Defines attribute's type","schema":{"type":"string"},"example":"text","in":"query","required":false},{"name":"visible","description":"Filter items by visibility status","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"required","description":"Defines if the option is required","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"system","description":"True if attribute is system","schema":{"type":"boolean"},"example":false,"in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,return_message,pagination,result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,code,type"},"example":"id,name","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"id,name","in":"query","required":false}]}},"/attribute.add.json":{"post":{"tags":["attribute"],"summary":"attribute.add","description":"Add new attribute","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"parameters":[{"name":"type","description":"Defines attribute's type","schema":{"type":"string","enum":["text","select","media","color","textarea","date","price","multiselect","boolean"]},"example":"text","in":"query","required":true},{"name":"name","description":"Defines attributes's name","schema":{"type":"string"},"example":"Specification","in":"query","required":true},{"name":"code","description":"Entity code","schema":{"type":"string"},"example":"code","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"visible","description":"Set visibility status","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"required","description":"Defines if the option is required","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"position","description":"Attribute`s position","schema":{"type":"integer","default":0},"example":5,"in":"query","required":false},{"name":"attribute_group_id","description":"Filter by attribute_group_id","schema":{"type":"string"},"example":"202","in":"query","required":false},{"name":"is_global","description":"Attribute saving scope","schema":{"type":"string","default":"Store"},"example":"Global","in":"query","required":false},{"name":"is_searchable","description":"Use attribute in Quick Search","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false},{"name":"is_filterable","description":"Use In Layered Navigation","schema":{"type":"string","default":"No"},"example":"No","in":"query","required":false},{"name":"is_comparable","description":"Comparable on Front-end","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"is_html_allowed_on_front","description":"Allow HTML Tags on Frontend","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"is_filterable_in_search","description":"Use In Search Results Layered Navigation","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"is_configurable","description":"Use To Create Configurable Product","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"is_visible_in_advanced_search","description":"Use in Advanced Search","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"is_used_for_promo_rules","description":"Use for Promo Rule Conditions","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"used_in_product_listing","description":"Used in Product Listing","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"used_for_sort_by","description":"Used for Sorting in Product Listing","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"apply_to","description":"Types of products which can have this attribute","schema":{"type":"string","default":"all_types"},"example":"Global","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/attribute.update.json":{"put":{"tags":["attribute"],"summary":"attribute.update","description":"Update attribute data","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"name","description":"Defines new attributes's name","schema":{"type":"string"},"example":"Test name","in":"query","required":false},{"name":"visible","description":"Set visibility status","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"position","description":"Attribute`s position","schema":{"type":"integer","default":0},"example":5,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/attribute.delete.json":{"delete":{"tags":["attribute"],"summary":"attribute.delete","description":"Delete attribute from store","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"string"}}}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/attribute.assign.group.json":{"post":{"tags":["attribute"],"summary":"attribute.assign.group","description":"Assign attribute to the group","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeAssignGroup","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"assigned":{"type":"string"}}}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"group_id","description":"Attribute group_id","schema":{"type":"string"},"example":3,"in":"query","required":true},{"name":"attribute_set_id","description":"Attribute set id","schema":{"type":"string"},"example":"4","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/attribute.assign.set.json":{"post":{"tags":["attribute"],"summary":"attribute.assign.set","description":"Assign attribute to the attribute set","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeAssignSet","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"assigned":{"type":"string"}}}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"group_id","description":"Attribute group_id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"attribute_set_id","description":"Attribute set id","schema":{"type":"string"},"example":"4","in":"query","required":true},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/attribute.attributeset.list.json":{"get":{"tags":["attribute"],"summary":"attribute.attributeset.list","description":"Get attribute_set list","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeAttributesetList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Attribute_Attributeset_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name"},"example":"id,name","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"id,name","in":"query","required":false}]}},"/attribute.group.list.json":{"get":{"tags":["attribute"],"summary":"attribute.group.list","description":"Get attribute group list","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeGroupList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Attribute_Group_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"attribute_set_id","description":"Attribute set id","schema":{"type":"string"},"example":"4","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name"},"example":"id,name","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"id,name","in":"query","required":false}]}},"/attribute.type.list.json":{"get":{"tags":["attribute"],"summary":"attribute.type.list","description":"Get list of supported attributes types","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeTypeList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"attribute_type":{"type":"array","items":{"type":"string"}}}}}}}}}},"parameters":[]}},"/attribute.unassign.group.json":{"post":{"tags":["attribute"],"summary":"attribute.unassign.group","description":"Unassign attribute from group","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeUnassignGroup","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"unassigned":{"type":"string"}}}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"group_id","description":"Customer group_id","schema":{"type":"string"},"example":3,"in":"query","required":true},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/attribute.unassign.set.json":{"post":{"tags":["attribute"],"summary":"attribute.unassign.set","description":"Unassign attribute from attribute set","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeUnassignSet","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"unassigned":{"type":"string"}}}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"attribute_set_id","description":"Attribute set id","schema":{"type":"string"},"example":"4","in":"query","required":true},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/attribute.value.add.json":{"post":{"tags":["attribute"],"summary":"attribute.value.add","description":"Add new value to attribute.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeValueAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"parameters":[{"name":"attribute_id","description":"Attribute Id","schema":{"type":"string"},"example":"156","in":"query","required":true},{"name":"name","description":"Defines attribute value's name","schema":{"type":"string"},"example":"Test name","in":"query","required":true},{"name":"code","description":"Entity code","schema":{"type":"string"},"example":"code","in":"query","required":false},{"name":"description","description":"Defines attribute value's description","schema":{"type":"string"},"example":"Test value","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/attribute.value.update.json":{"put":{"tags":["attribute"],"summary":"attribute.value.update","description":"Update attribute value.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeValueUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"id","description":"Defines attribute value's id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"attribute_id","description":"Attribute Id","schema":{"type":"string"},"example":"156","in":"query","required":true},{"name":"name","description":"Defines attribute value's name","schema":{"type":"string"},"example":"Test name","in":"query","required":false},{"name":"description","description":"Defines new attribute value's description","schema":{"type":"string"},"example":"Test value","in":"query","required":false},{"name":"code","description":"Entity code","schema":{"type":"string"},"example":"code","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/attribute.value.delete.json":{"delete":{"tags":["attribute"],"summary":"attribute.value.delete","description":"Delete attribute value.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"AttributeValueDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"attribute_id","description":"Attribute Id","schema":{"type":"string"},"example":"156","in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/basket.info.json":{"get":{"tags":["basket"],"summary":"basket.info","description":"Retrieve basket information.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"BasketInfo","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"$ref":"#/components/schemas/Basket"}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/basket.item.add.json":{"post":{"tags":["basket"],"summary":"basket.item.add","description":"Add item to basket","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"BasketItemAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"added":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"customer_id","description":"Retrieves orders specified by customer id","schema":{"type":"string"},"example":"5","in":"query","required":true},{"name":"product_id","description":"Defines id of the product which should be added to the basket","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"variant_id","description":"Defines product's variants specified by variant id","schema":{"type":"string"},"example":45,"in":"query","required":false},{"name":"quantity","description":"Defines new items quantity","schema":{"type":"number","default":0},"example":6,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/basket.live_shipping_service.list.json":{"get":{"tags":["basket"],"summary":"basket.live_shipping_service.list","description":"Retrieve a list of live shipping rate services.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"BasketLiveShippingServiceList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"live_shipping_services":{"type":"array","items":{"$ref":"#/components/schemas/Basket_LiveShippingService"}}}}}}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/basket.live_shipping_service.create.json":{"post":{"tags":["basket"],"summary":"basket.live_shipping_service.create","description":"Create live shipping rate service.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"BasketLiveShippingServiceCreate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"integer"}}}}}}}}},"parameters":[{"name":"name","description":"Shipping Service Name","schema":{"type":"string"},"example":"BestDelivery","in":"query","required":true},{"name":"callback","description":"Callback url that returns shipping rates. It should be able to accept POST requests with json data.","schema":{"type":"string"},"example":"https://example.com/callback","in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/basket.live_shipping_service.delete.json":{"delete":{"tags":["basket"],"summary":"basket.live_shipping_service.delete","description":"Delete live shipping rate service.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"BasketLiveShippingServiceDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"status":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"integer"},"example":5,"in":"query","required":true}]}},"/batch.job.list.json":{"get":{"tags":["batch"],"summary":"batch.job.list","description":"Get list of recent jobs","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"BatchJobList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Batch_Job_List"}}}}},"parameters":[{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"ids","description":"Filter batch jobs by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"processed_from","description":"Retrieve entities according to their processing datetime","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"processed_to","description":"Retrieve entities according to their processing datetime","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"{return_code,return_message,pagination,result}"},"example":"{result}","in":"query","required":false}]}},"/batch.job.result.json":{"get":{"tags":["batch"],"summary":"batch.job.result","description":"Get job result data","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"BatchJobResult","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response_Batch_Job_Result"}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true}]}},"/bridge.download.file":{"get":{"tags":["bridge"],"summary":"bridge.download","description":"Download bridge for store.
Please note that the method would not work if you call it from Swagger UI.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"BridgeDownload","responses":{"200":{"description":"successful operation","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}}},"parameters":[{"name":"whitelabel","description":"Identifies if there is a necessity to download whitelabel bridge.","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false}]}},"/bridge.update.json":{"post":{"tags":["bridge"],"summary":"bridge.update","description":"Update bridge in the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"BridgeUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated":{"type":"boolean"}}}}}}}}},"parameters":[]}},"/bridge.delete.json":{"post":{"tags":["bridge"],"summary":"bridge.delete","description":"Delete bridge from the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"BridgeDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}}}},"parameters":[]}},"/cart.info.json":{"get":{"tags":["cart"],"summary":"cart.info","description":"This method allows you to get various information about the store, including a list of stores (in the case of a multistore configuration), a list of supported languages, currencies, carriers, warehouses, and many other information. This information contains data that is relatively stable and rarely changes, so API2Cart can cache certain data to reduce the load on the store and speed up the execution of the request. We also recommend that you cache the response of this method on your side to save requests. If you need to clear the cache for a specific store, then use the cart.validate method.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartInfo","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"$ref":"#/components/schemas/Cart"}}}}}}},"parameters":[{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{name,url,stores_info{store_id,name,currency{id,iso3},store_owner_info}}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"store_name,store_url,db_prefix"},"example":"name,url","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"name,url","in":"query","required":false}]}},"/cart.validate.json":{"get":{"tags":["cart"],"summary":"cart.validate","description":"This method clears the cache in API2Cart for a particular store and checks whether the connection to the store is available. Use this method if there have been any changes in the settings on the stor\u0435, for example, if a new plugin has been installed or removed.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartValidate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"status":{"type":"string"}}}}}}}}},"parameters":[{"name":"validate_version","description":"Specify if api2cart should validate cart version","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false}]}},"/cart.list.json":{"get":{"tags":["cart"],"summary":"cart.list","description":"Get list of supported carts","security":[{"ApiKeyAuth":[]}],"operationId":"CartList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"supported_carts":{"type":"array","items":{"type":"object","properties":{"cart_id":{"type":"string"},"cart_name":{"type":"string"},"cart_versions":{"type":"string"},"params":{"type":"array","items":{"type":"string"}}}}}}}}}}}}},"deprecated":true,"parameters":[]}},"/cart.bridge.json":{"get":{"tags":["cart"],"summary":"cart.bridge","description":"Get bridge key and store key","security":[{"ApiKeyAuth":[]}],"operationId":"CartBridge","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"store_key":{"type":"string"},"bridge":{"type":"string"}}}}}}}}},"deprecated":true,"parameters":[]}},"/cart.disconnect.json":{"get":{"tags":["cart"],"summary":"cart.disconnect","description":"Disconnect with the store and clear store session data.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartDisconnect","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"connection":{"type":"string"}}}}}}}}},"deprecated":true,"parameters":[{"name":"delete_bridge","description":"Identifies if there is a necessity to delete bridge","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false}]}},"/cart.methods.json":{"get":{"tags":["cart"],"summary":"cart.methods","description":"Returns a list of supported API methods.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartMethods","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"method":{"type":"array","items":{"type":"string"}}}}}}}}}},"parameters":[]}},"/cart.config.json":{"get":{"tags":["cart"],"summary":"cart.config","description":"Get list of cart configs","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartConfig","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"store_name":{"type":"string"},"store_url":{"type":"string"},"db_prefix":{"type":"string"}}}}}}}}},"deprecated":true,"parameters":[{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"store_name,store_url,db_prefix"},"example":"store_name,store_url,db_prefix","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"store_name,store_url,db_prefix","in":"query","required":false}]}},"/cart.clear_cache.json":{"post":{"tags":["cart"],"summary":"cart.clear_cache","description":"Clear cache on store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartClearCache","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"cache_cleared":{"type":"string"}}}}}}}}},"deprecated":true,"parameters":[{"name":"cache_type","description":"Defines which cache should be cleared.","schema":{"type":"string"},"example":"storage_cache","in":"query","required":true}]}},"/cart.create.json":{"post":{"tags":["cart"],"summary":"cart.create","description":"Add store to the account","security":[{"ApiKeyAuth":[]}],"operationId":"CartCreate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"store_key":{"type":"string"}}}}}}}}},"deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartCreate"}}}}}},"/cart.delete.json":{"delete":{"tags":["cart"],"summary":"cart.delete","description":"Remove store from API2Cart","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"store":{"type":"string"}}}}}}}}},"parameters":[{"name":"delete_bridge","description":"Identifies if there is a necessity to delete bridge","schema":{"type":"boolean","default":true},"example":true,"in":"query","required":false}]}},"/cart.catalog_price_rules.count.json":{"get":{"tags":["cart"],"summary":"cart.catalog_price_rules.count","description":"Get count of cart catalog price rules discounts.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartCatalogPriceRulesCount","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"catalog_price_rules_count":{"type":"integer"}}}}}}}}},"parameters":[]}},"/cart.catalog_price_rules.list.json":{"get":{"tags":["cart"],"summary":"cart.catalog_price_rules.list","description":"Get cart catalog price rules discounts.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartCatalogPriceRulesList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Cart_Catalog_PriceRules_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"ids","description":"Retrieves catalog_price_rules by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{catalog_price_rules_count,catalog_price_rules{id,type,name,avail,usage_count,actions,conditions}}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,description"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/cart.config.update.json":{"put":{"tags":["cart"],"summary":"cart.config.update","description":"Use this API method to update custom data in client database.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartConfigUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object"}}}}}}},"deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartConfigUpdate"}}}}}},"/cart.coupon.count.json":{"get":{"tags":["cart"],"summary":"cart.coupon.count","description":"This method allows you to get the number of coupons. On some platforms, you can filter the coupons by the date they were active.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartCouponCount","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"coupons_count":{"type":"integer"}}}}}}}}},"parameters":[{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"avail","description":"Defines category's visibility status","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"date_start_from","description":"Filter entity by date_start (greater or equal)","schema":{"type":"string"},"example":"2016-12-29 16:44:30","in":"query","required":false},{"name":"date_start_to","description":"Filter entity by date_start (less or equal)","schema":{"type":"string"},"example":"2016-12-29 16:44:30","in":"query","required":false},{"name":"date_end_from","description":"Filter entity by date_end (greater or equal)","schema":{"type":"string"},"example":"2016-12-29 16:44:30","in":"query","required":false},{"name":"date_end_to","description":"Filter entity by date_end (less or equal)","schema":{"type":"string"},"example":"2016-12-29 16:44:30","in":"query","required":false}]}},"/cart.coupon.list.json":{"get":{"tags":["cart"],"summary":"cart.coupon.list","description":"Get cart coupon discounts.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartCouponList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Cart_Coupon_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"coupons_ids","description":"Filter coupons by ids","schema":{"type":"string"},"example":"1,2,3","in":"query","required":false},{"name":"store_id","description":"Filter coupons by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"avail","description":"Filter coupons by avail status","schema":{"type":"boolean"},"example":false,"in":"query","required":false},{"name":"status","description":"Defines coupon's status","schema":{"type":"string"},"example":"disabled","in":"query","required":false},{"name":"date_start_from","description":"Filter entity by date_start (greater or equal)","schema":{"type":"string"},"example":"2016-12-29 16:44:30","in":"query","required":false},{"name":"date_start_to","description":"Filter entity by date_start (less or equal)","schema":{"type":"string"},"example":"2016-12-29 16:44:30","in":"query","required":false},{"name":"date_end_from","description":"Filter entity by date_end (greater or equal)","schema":{"type":"string"},"example":"2016-12-29 16:44:30","in":"query","required":false},{"name":"date_end_to","description":"Filter entity by date_end (less or equal)","schema":{"type":"string"},"example":"2016-12-29 16:44:30","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{pagination,result{coupon_count,coupon{id,code,name,conditions,actions{scope,amount,conditions{id,value,sub-conditions}},date_start,avail}}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,code,name,description"},"example":"id,code,type,amount","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"usage_history,type","in":"query","required":false}]}},"/cart.coupon.add.json":{"post":{"tags":["cart"],"summary":"cart.coupon.add","description":"Use this method to create a coupon with specified conditions.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartCouponAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"coupon_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartCouponAdd"}}}}}},"/cart.coupon.delete.json":{"delete":{"tags":["cart"],"summary":"cart.coupon.delete","description":"Delete coupon","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartCouponDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"string"}}}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/cart.coupon.condition.add.json":{"post":{"tags":["cart"],"summary":"cart.coupon.condition.add","description":"Use this method to add additional conditions for coupon application.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartCouponConditionAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"status":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"coupon_id","description":"Coupon Id","schema":{"type":"string"},"example":"45845","in":"query","required":true},{"name":"entity","description":"Defines condition entity type","schema":{"type":"string","enum":["order","order_shipping_address","product","customer"]},"example":"order","in":"query","required":true},{"name":"key","description":"Defines condition entity attribute key","schema":{"type":"string","enum":["total","subtotal","shipping_total","total_quantity","total_weight","country","product_id","variant_id","category_id","customer_id","item_price","item_total_price","item_quantity","carrier_id"]},"example":"subtotal","in":"query","required":true},{"name":"operator","description":"Defines condition operator","schema":{"type":"string"},"example":"==","in":"query","required":true},{"name":"value","description":"Defines condition value, can be comma separated according to the operator.","schema":{"type":"string"},"example":"2","in":"query","required":true},{"name":"target","description":"Defines condition operator","schema":{"type":"string","default":"coupon_prerequisite"},"example":"coupon_action","in":"query","required":false},{"name":"include_tax","description":"Indicates whether to apply a discount for taxes.","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"include_shipping","description":"Indicates whether to apply a discount for shipping.","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/cart.giftcard.count.json":{"get":{"tags":["cart"],"summary":"cart.giftcard.count","description":"Get gift cards count.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartGiftcardCount","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"gift_cards_count":{"type":"integer"}}}}}}}}},"parameters":[{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/cart.giftcard.list.json":{"get":{"tags":["cart"],"summary":"cart.giftcard.list","description":"Get gift cards list.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartGiftcardList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Cart_GiftCard_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{pagination,result{gift_card{id,code,amount,status}}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,code,name"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/cart.giftcard.add.json":{"post":{"tags":["cart"],"summary":"cart.giftcard.add","description":"Use this method to create a gift card for a specified amount.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartGiftcardAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"}}}}}}}}},"parameters":[{"name":"amount","description":"Defines the gift card amount value.","schema":{"type":"number"},"example":15.5,"in":"query","required":true},{"name":"code","description":"Gift card code","schema":{"type":"string"},"example":"GFT1 A4S5 AA11 RD61","in":"query","required":false},{"name":"owner_email","description":"Gift card owner email","schema":{"type":"string"},"example":"jubari@hannsgroup.com","in":"query","required":false},{"name":"recipient_email","description":"Gift card recipient email","schema":{"type":"string"},"example":"jubari@hannsgroup.com","in":"query","required":false},{"name":"recipient_name","description":"Gift card recipient name","schema":{"type":"string"},"example":"John Doe","in":"query","required":false},{"name":"owner_name","description":"Gift card owner name","schema":{"type":"string"},"example":"John Doe","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/cart.giftcard.delete.json":{"delete":{"tags":["cart"],"summary":"cart.giftcard.delete","description":"Delete giftcard","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartGiftcardDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"string"}}}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true}]}},"/cart.meta_data.list.json":{"get":{"tags":["cart"],"summary":"cart.meta_data.list","description":"Using this method, you can get a list of metadata for various entities (products, options, customers, orders). Usually this is data created by third-party plugins.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartMetaDataList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Cart_MetaData_List"}}}}},"parameters":[{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"entity_id","description":"Entity Id","schema":{"type":"string"},"example":"1","in":"query","required":true},{"name":"entity","description":"Entity","schema":{"type":"string","default":"product"},"example":"order","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"key","description":"Key","schema":{"type":"string"},"example":"subtotal","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{items{key,value}}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"key,value"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/cart.meta_data.set.json":{"post":{"tags":["cart"],"summary":"cart.meta_data.set","description":"Set meta data for a specific entity","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartMetaDataSet","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"parameters":[{"name":"entity_id","description":"Entity Id","schema":{"type":"string"},"example":"1","in":"query","required":true},{"name":"key","description":"Key","schema":{"type":"string"},"example":"subtotal","in":"query","required":true},{"name":"value","description":"Value","schema":{"type":"string"},"example":"2","in":"query","required":true},{"name":"namespace","description":"Metafield namespace","schema":{"type":"string"},"example":"order","in":"query","required":true},{"name":"entity","description":"Entity","schema":{"type":"string","default":"product"},"example":"order","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/cart.meta_data.unset.json":{"delete":{"tags":["cart"],"summary":"cart.meta_data.unset","description":"Unset meta data for a specific entity","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartMetaDataUnset","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"status":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"entity_id","description":"Entity Id","schema":{"type":"string"},"example":"1","in":"query","required":true},{"name":"key","description":"Key","schema":{"type":"string"},"example":"subtotal","in":"query","required":true},{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"entity","description":"Entity","schema":{"type":"string","default":"product"},"example":"order","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/cart.plugin.list.json":{"get":{"tags":["cart"],"summary":"cart.plugin.list","description":"Get a list of third-party plugins installed on the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartPluginList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"all_plugins":{"type":"integer"},"plugins":{"type":"array","items":{"$ref":"#/components/schemas/PluginList"}}}}}}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/cart.script.list.json":{"get":{"tags":["cart"],"summary":"cart.script.list","description":"Get scripts installed to the storefront","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartScriptList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Cart_Script_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"script_ids","description":"Retrieves only scripts with specific ids","schema":{"type":"string"},"example":"34023324,34024032","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{pagination,result{total_count,scripts{id,name,src,created_time{value}}}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,description"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/cart.script.add.json":{"post":{"tags":["cart"],"summary":"cart.script.add","description":"Add new script to the storefront","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartScriptAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"script_id":{"type":"string"}}}}}}}}},"parameters":[{"name":"name","description":"The user-friendly script name","schema":{"type":"string"},"example":"jQuery Minimized","in":"query","required":false},{"name":"description","description":"The user-friendly description","schema":{"type":"string"},"example":"The Write Less, Do More, JavaScript Library","in":"query","required":false},{"name":"html","description":"An html string containing exactly one `script` tag.","schema":{"type":"string"},"example":"<script>alert('foo')</script>","in":"query","required":false},{"name":"src","description":"The URL of the remote script","schema":{"type":"string"},"example":"https://js-aplenty.com/foo.js","in":"query","required":false},{"name":"load_method","description":"The load method to use for the script","schema":{"type":"string"},"example":"async","in":"query","required":false},{"name":"scope","description":"The page or pages on the online store where the script should be included","schema":{"type":"string","default":"storefront"},"example":"all","in":"query","required":false},{"name":"events","description":"Event for run scripts","schema":{"type":"string"},"example":"purchase_event","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/cart.script.delete.json":{"delete":{"tags":["cart"],"summary":"cart.script.delete","description":"Remove script from the storefront","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartScriptDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"string"}}}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/cart.shipping_zones.list.json":{"get":{"tags":["cart"],"summary":"cart.shipping_zones.list","description":"Get list of shipping zones","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CartShippingZonesList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Cart_ShippingZones_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{id,name,enabled,countries,shipping_methods{name,rates}}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,enabled"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/category.info.json":{"get":{"tags":["category"],"summary":"category.info","description":"Get category info about category ID*** or specify other category ID.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CategoryInfo","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"$ref":"#/components/schemas/Category"}}}}}}},"parameters":[{"name":"id","description":"Retrieves category's info specified by category id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Retrieves category info specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Retrieves category info specified by language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"schema_type","description":"The name of the requirements set for the provided schema.","schema":{"type":"string"},"example":"LISTING","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{id,name,parent_id,modified_at{value},images}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,parent_id,name,description"},"example":"id,parent_id,name","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"id,parent_id,name","in":"query","required":false},{"name":"report_request_id","description":"Report request id","schema":{"type":"string"},"example":"105245017661","in":"query","required":false},{"name":"disable_report_cache","description":"Disable report cache for current request","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false},{"name":"use_latest_api_version","description":"Use the latest platform API version","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false}]}},"/category.count.json":{"get":{"tags":["category"],"summary":"category.count","description":"Count categories in store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CategoryCount","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"categories_count":{"type":"integer"}}}}}}}}},"parameters":[{"name":"parent_id","description":"Counts categories specified by parent id","schema":{"type":"string"},"example":6,"in":"query","required":false},{"name":"store_id","description":"Counts category specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Counts category specified by language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"avail","description":"Defines category's visibility status","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"product_type","description":"A categorization for the product","schema":{"type":"string"},"example":"BICYCLE","in":"query","required":false},{"name":"find_value","description":"Entity search that is specified by some value","schema":{"type":"string"},"example":"Demo category 1","in":"query","required":false},{"name":"find_where","description":"Counts categories that are searched specified by field","schema":{"type":"string"},"example":"email","in":"query","required":false},{"name":"report_request_id","description":"Report request id","schema":{"type":"string"},"example":"105245017661","in":"query","required":false},{"name":"disable_report_cache","description":"Disable report cache for current request","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false}]}},"/category.list.json":{"get":{"tags":["category"],"summary":"category.list","description":"Get list of categories from store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CategoryList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Category_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"store_id","description":"Retrieves categories specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Retrieves categorys specified by language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"parent_id","description":"Retrieves categories specified by parent id","schema":{"type":"string"},"example":6,"in":"query","required":false},{"name":"avail","description":"Defines category's visibility status","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"product_type","description":"A categorization for the product","schema":{"type":"string"},"example":"BICYCLE","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"find_value","description":"Entity search that is specified by some value","schema":{"type":"string"},"example":"Demo category 1","in":"query","required":false},{"name":"find_where","description":"Category search that is specified by field","schema":{"type":"string"},"example":"name","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{categories_count,category{id,parent_id,modified_at{value},images}}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,parent_id,name,description"},"example":"id,parent_id,name","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"id,parent_id,name","in":"query","required":false},{"name":"report_request_id","description":"Report request id","schema":{"type":"string"},"example":"105245017661","in":"query","required":false},{"name":"disable_report_cache","description":"Disable report cache for current request","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false},{"name":"disable_cache","description":"Disable cache for current request","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false},{"name":"use_latest_api_version","description":"Use the latest platform API version","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false}]}},"/category.find.json":{"get":{"tags":["category"],"summary":"category.find","description":"Search category in store. \"Laptop\" is specified here by default.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CategoryFind","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"category":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}}}}}}}}}}},"parameters":[{"name":"find_value","description":"Entity search that is specified by some value","schema":{"type":"string"},"example":"Demo category 1","in":"query","required":true},{"name":"find_where","description":"Entity search that is specified by the comma-separated unique fields","schema":{"type":"string","default":"name"},"example":"name","in":"query","required":false},{"name":"find_params","description":"Entity search that is specified by comma-separated parameters","schema":{"type":"string","default":"whole_words"},"example":"regex","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false}]}},"/category.assign.json":{"post":{"tags":["category"],"summary":"category.assign","description":"Assign category to product","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CategoryAssign","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object"}}}}}}},"parameters":[{"name":"category_id","description":"Defines category assign, specified by category id","schema":{"type":"string"},"example":6,"in":"query","required":true},{"name":"product_id","description":"Defines category assign to the product, specified by product id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/category.unassign.json":{"post":{"tags":["category"],"summary":"category.unassign","description":"Unassign category to product","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CategoryUnassign","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object"}}}}}}},"parameters":[{"name":"category_id","description":"Defines category unassign, specified by category id","schema":{"type":"string"},"example":6,"in":"query","required":true},{"name":"product_id","description":"Defines category unassign to the product, specified by product id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/category.add.json":{"post":{"tags":["category"],"summary":"category.add","description":"Add new category in store","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CategoryAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"category_id":{"type":"string"}}}}}}}}},"parameters":[{"name":"name","description":"Defines category's name that has to be added","schema":{"type":"string"},"example":"Shoes","in":"query","required":true},{"name":"description","description":"Defines category's description","schema":{"type":"string"},"example":"Test category","in":"query","required":false},{"name":"short_description","description":"Defines short description","schema":{"type":"string"},"example":"Short description. This is very short description","in":"query","required":false},{"name":"parent_id","description":"Adds categories specified by parent id","schema":{"type":"string"},"example":6,"in":"query","required":false},{"name":"avail","description":"Defines category's visibility status","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"created_time","description":"Entity's date creation","schema":{"type":"string"},"example":"2014-01-30 15:58:41","in":"query","required":false},{"name":"modified_time","description":"Entity's date modification","schema":{"type":"string"},"example":"2014-07-30 15:58:41","in":"query","required":false},{"name":"sort_order","description":"Sort number in the list","schema":{"type":"integer","default":0},"example":2,"in":"query","required":false},{"name":"meta_title","description":"Defines unique meta title for each entity","schema":{"type":"string"},"example":"category,test","in":"query","required":false},{"name":"meta_description","description":"Defines unique meta description of a entity","schema":{"type":"string"},"example":"category,test","in":"query","required":false},{"name":"meta_keywords","description":"Defines unique meta keywords for each entity","schema":{"type":"string"},"example":"category,test","in":"query","required":false},{"name":"seo_url","description":"Defines unique category's URL for SEO","schema":{"type":"string"},"example":"category,test","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"stores_ids","description":"Create category in the stores that is specified by comma-separated stores' id","schema":{"type":"string"},"example":"1,2","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/category.add.batch.json":{"post":{"tags":["category"],"summary":"category.add.batch","description":"Add new categories to the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CategoryAddBatch","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"job_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryAddBatch"}}}}}},"/category.update.json":{"put":{"tags":["category"],"summary":"category.update","description":"Update category in store","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CategoryUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated_items":{"type":"integer"}}}}}}}}},"parameters":[{"name":"id","description":"Defines category update specified by category id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"name","description":"Defines new category\u2019s name","schema":{"type":"string"},"example":"NEW Shoes","in":"query","required":false},{"name":"description","description":"Defines new category's description","schema":{"type":"string"},"example":"New test category","in":"query","required":false},{"name":"short_description","description":"Defines short description","schema":{"type":"string"},"example":"Short description. This is very short description","in":"query","required":false},{"name":"parent_id","description":"Defines new parent category id","schema":{"type":"string"},"example":6,"in":"query","required":false},{"name":"avail","description":"Defines category's visibility status","schema":{"type":"boolean"},"example":false,"in":"query","required":false},{"name":"sort_order","description":"Sort number in the list","schema":{"type":"integer"},"example":2,"in":"query","required":false},{"name":"modified_time","description":"Entity's date modification","schema":{"type":"string"},"example":"2014-07-30 15:58:41","in":"query","required":false},{"name":"meta_title","description":"Defines unique meta title for each entity","schema":{"type":"string"},"example":"category,test","in":"query","required":false},{"name":"meta_description","description":"Defines unique meta description of a entity","schema":{"type":"string"},"example":"category,test","in":"query","required":false},{"name":"meta_keywords","description":"Defines unique meta keywords for each entity","schema":{"type":"string"},"example":"category,test","in":"query","required":false},{"name":"seo_url","description":"Defines unique category's URL for SEO","schema":{"type":"string"},"example":"category,test","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"stores_ids","description":"Update category in the stores that is specified by comma-separated stores' id","schema":{"type":"string"},"example":"1,2","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/category.delete.json":{"delete":{"tags":["category"],"summary":"category.delete","description":"Delete category in store","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CategoryDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"delete_items":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"id","description":"Defines category removal, specified by category id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/category.delete.batch.json":{"post":{"tags":["category"],"summary":"category.delete.batch","description":"Delete categories from the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CategoryDeleteBatch","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"job_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryDeleteBatch"}}}}}},"/category.image.add.json":{"post":{"tags":["category"],"summary":"category.image.add","description":"Add image to category","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CategoryImageAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"image_path":{"type":"string"}}}}}}}}},"parameters":[{"name":"category_id","description":"Defines category id where the image should be added","schema":{"type":"string"},"example":6,"in":"query","required":true},{"name":"image_name","description":"Defines image's name","schema":{"type":"string"},"example":"bag-gray.png","in":"query","required":true},{"name":"url","description":"Defines URL of the image that has to be added","schema":{"type":"string"},"example":"http://docs.api2cart.com/img/logo.png","in":"query","required":true},{"name":"type","description":"Defines image's types that are specified by comma-separated list","schema":{"type":"string","enum":["base","thumbnail"]},"example":"base","in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"label","description":"Defines alternative text that has to be attached to the picture","schema":{"type":"string"},"example":"This cool image","in":"query","required":false},{"name":"mime","description":"Mime type of image http://en.wikipedia.org/wiki/Internet_media_type.","schema":{"type":"string"},"example":"image/jpeg","in":"query","required":false},{"name":"position","description":"Defines image\u2019s position in the list","schema":{"type":"integer","default":0},"example":5,"in":"query","required":false},{"name":"apply_to_translations","description":"Defines whether to add image to all category translations","schema":{"type":"boolean","default":true},"example":true,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/category.image.delete.json":{"delete":{"tags":["category"],"summary":"category.image.delete","description":"Delete image","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CategoryImageDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"string"}}}}}}}}},"parameters":[{"name":"category_id","description":"Defines category id where the image should be deleted","schema":{"type":"string"},"example":6,"in":"query","required":true},{"name":"image_id","description":"Define image id","schema":{"type":"string"},"example":"82950b84f468edff480680f99cedbe0d","in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"apply_to_translations","description":"Defines whether to delete image from all category translations","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false}]}},"/customer.info.json":{"get":{"tags":["customer"],"summary":"customer.info","description":"Get customers' details from store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CustomerInfo","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"$ref":"#/components/schemas/Customer"}}}}}}},"parameters":[{"name":"id","description":"Retrieves customer's info specified by customer id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Retrieves customer info specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{id,parent_id,sku,upc,images,combination}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,email,first_name,last_name"},"example":"id,email","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"id,email","in":"query","required":false}]}},"/customer.count.json":{"get":{"tags":["customer"],"summary":"customer.count","description":"Get number of customers from store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CustomerCount","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"customers_count":{"type":"integer"}}}}}}}}},"parameters":[{"name":"ids","description":"Counts customers specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"since_id","description":"Retrieve entities starting from the specified id.","schema":{"type":"string"},"example":"56","in":"query","required":false},{"name":"customer_list_id","description":"The numeric ID of the customer list in Demandware.","schema":{"type":"string"},"example":"exampleListId","in":"query","required":false},{"name":"group_id","description":"Customer group_id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"store_id","description":"Counts customer specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"avail","description":"Defines category's visibility status","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"include_guests","description":"Indicates whether to include guest customers in the total count.","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"find_value","description":"Entity search that is specified by some value","schema":{"type":"string"},"example":"mail@gmail.com","in":"query","required":false},{"name":"find_where","description":"Counts customers that are searched specified by field","schema":{"type":"string"},"example":"email","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false}]}},"/customer.list.json":{"get":{"tags":["customer"],"summary":"customer.list","description":"Get list of customers from store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CustomerList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Customer_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"ids","description":"Retrieves customers specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"since_id","description":"Retrieve entities starting from the specified id.","schema":{"type":"string"},"example":"56","in":"query","required":false},{"name":"customer_list_id","description":"The numeric ID of the customer list in Demandware.","schema":{"type":"string"},"example":"exampleListId","in":"query","required":false},{"name":"group_id","description":"Customer group_id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"store_id","description":"Retrieves customers specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"avail","description":"Defines category's visibility status","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"include_guests","description":"Indicates whether to include guest customers in the list results.","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"find_value","description":"Entity search that is specified by some value","schema":{"type":"string"},"example":"mail@gmail.com","in":"query","required":false},{"name":"find_where","description":"Customer search that is specified by field","schema":{"type":"string"},"example":"email","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"sort_by","description":"Set field to sort by","schema":{"type":"string","default":"created_time"},"example":"value_id","in":"query","required":false},{"name":"sort_direction","description":"Set sorting direction","schema":{"type":"string","default":"asc"},"example":"asc","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{customer}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,email,first_name,last_name"},"example":"id,email","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"id,email","in":"query","required":false}]}},"/customer.find.json":{"get":{"tags":["customer"],"summary":"customer.find","description":"Find customers in store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CustomerFind","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}}}}}}}}},"parameters":[{"name":"find_value","description":"Entity search that is specified by some value","schema":{"type":"string"},"example":"mail@gmail.com","in":"query","required":true},{"name":"find_where","description":"Entity search that is specified by the comma-separated unique fields","schema":{"type":"string","default":"email"},"example":"email","in":"query","required":false},{"name":"find_params","description":"Entity search that is specified by comma-separated parameters","schema":{"type":"string","default":"whole_words"},"example":"regex","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"include_guests","description":"Indicates whether to search among guest customers when looking up a customer.","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false}]}},"/customer.add.json":{"post":{"tags":["customer"],"summary":"customer.add","description":"Add customer into store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CustomerAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"customer_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAdd"}}}}}},"/customer.update.json":{"put":{"tags":["customer"],"summary":"customer.update","description":"Update information of customer in store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CustomerUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated_items":{"type":"integer"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerUpdate"}}}}}},"/customer.delete.json":{"delete":{"tags":["customer"],"summary":"customer.delete","description":"Delete customer from store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CustomerDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"delete_items":{"type":"integer"}}}}}}}}},"parameters":[{"name":"id","description":"Identifies customer specified by the id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/customer.address.add.json":{"post":{"tags":["customer"],"summary":"customer.address.add","description":"Add customer address.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CustomerAddressAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressAdd"}}}}}},"/customer.attribute.list.json":{"get":{"tags":["customer"],"summary":"customer.attribute.list","description":"Get attributes for specific customer","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CustomerAttributeList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Customer_Attribute_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"customer_id","description":"Retrieves orders specified by customer id","schema":{"type":"string"},"example":"5","in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,return_message,pagination,result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/customer.group.list.json":{"get":{"tags":["customer"],"summary":"customer.group.list","description":"Get list of customers groups.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CustomerGroupList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Customer_Group_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"group_ids","description":"Groups that will be assigned to a customer","schema":{"type":"string"},"example":"1,2,3","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,return_message,pagination,result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,additional_fields"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false},{"name":"disable_cache","description":"Disable cache for current request","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false}]}},"/customer.group.add.json":{"post":{"tags":["customer"],"summary":"customer.group.add","description":"Create customer group.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CustomerGroupAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"group_id":{"type":"string"}}}}}}}}},"parameters":[{"name":"name","description":"Customer group name","schema":{"type":"string"},"example":"new_group","in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"stores_ids","description":"Assign customer group to the stores that is specified by comma-separated stores' id","schema":{"type":"string"},"example":"1,2","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/customer.wishlist.list.json":{"get":{"tags":["customer"],"summary":"customer.wishlist.list","description":"Get a Wish List of customer from the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"CustomerWishlistList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Customer_Wishlist_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"customer_id","description":"Retrieves orders specified by customer id","schema":{"type":"string"},"example":"5","in":"query","required":true},{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"{return_code,return_message,pagination,result}"},"example":"{return_code,return_message,pagination,result}","in":"query","required":false}]}},"/marketplace.product.find.json":{"get":{"tags":["marketplace"],"summary":"marketplace.product.find","description":"Search product in global catalog.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"MarketplaceProductFind","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Marketplace_Product_Find"}}}}},"parameters":[{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"keyword","description":"Defines search keyword","schema":{"type":"string"},"example":"T-shirt","in":"query","required":false},{"name":"categories_ids","description":"Defines product add that is specified by comma-separated categories id","schema":{"type":"string"},"example":"23,56","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"asin","description":"Amazon Standard Identification Number.","schema":{"type":"string"},"example":"97703178470","in":"query","required":false},{"name":"ean","description":"European Article Number. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products.","schema":{"type":"string"},"example":"5901234123457","in":"query","required":false},{"name":"gtin","description":"Global Trade Item Number. An GTIN is an identifier for trade items.","schema":{"type":"string"},"example":"12345678912345","in":"query","required":false},{"name":"upc","description":"Universal Product Code. A UPC (UPC-A) is a commonly used identifer for many different products.","schema":{"type":"string"},"example":"9770317847001","in":"query","required":false},{"name":"mpn","description":"Manufacturer Part Number. A MPN is an identifier of a particular part design or material used.","schema":{"type":"string"},"example":"9770317847001","in":"query","required":false},{"name":"isbn","description":"International Standard Book Number. An ISBN is a unique identifier for books.","schema":{"type":"string"},"example":"9783161484100","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/order.info.json":{"get":{"tags":["order"],"summary":"order.info","description":"Info about a specific order by ID","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderInfo","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"$ref":"#/components/schemas/Order"}}}}}}},"parameters":[{"name":"id","description":"Retrieves order info specified by id","schema":{"type":"string"},"example":10,"in":"query","required":false},{"name":"order_id","description":"Retrieves order\u2019s info specified by order id","schema":{"type":"string"},"example":25,"in":"query","required":false},{"name":"store_id","description":"Defines store id where the order should be found","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"order_id,customer,totals,address,items,bundles,status"},"example":"order_id,totals,status","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{order_id,customer,totals,address,items,bundles,status}}","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"order_id,totals,status","in":"query","required":false},{"name":"enable_cache","description":"If the value is 'true' and order exist in our cache, we will return order.info response from cache","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"use_latest_api_version","description":"Use the latest platform API version","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"rounding_precision","description":"

Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).

Supported values range from 1 to 6.

The default rounding precision may vary depending on the platform. You can retrieve the default value using the cart.info method in the default_rounding_precision field.

Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.

","schema":{"type":"integer"},"example":3,"in":"query","required":false},{"name":"allow_user_defined_order_statuses","description":"Indicates whether custom (user-defined) order statuses should be included in the response.","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false}]}},"/order.count.json":{"get":{"tags":["order"],"summary":"order.count","description":"Count orders in store","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderCount","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"orders_count":{"type":"integer"}}}}}}}}},"parameters":[{"name":"order_ids","description":"Counts orders specified by order ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"ids","description":"Counts orders specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"customer_id","description":"Counts orders quantity specified by customer id","schema":{"type":"string"},"example":"5","in":"query","required":false},{"name":"store_id","description":"Counts orders quantity specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"customer_email","description":"Counts orders quantity specified by customer email","schema":{"type":"string"},"example":"jubari@hannsgroup.com","in":"query","required":false},{"name":"order_status","description":"Counts orders quantity specified by order status","schema":{"type":"string"},"example":"Completed","in":"query","required":false},{"name":"order_status_ids","description":"Retrieves orders specified by order statuses","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"in":"query","required":false},{"name":"ebay_order_status","description":"Counts orders quantity specified by order status","schema":{"type":"string"},"example":"Active","in":"query","required":false},{"name":"financial_status","description":"Counts orders quantity specified by financial status","schema":{"type":"string"},"example":"paid","in":"query","required":false},{"name":"financial_status_ids","description":"Retrieves orders count specified by financial status ids","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"in":"query","required":false},{"name":"fulfillment_channel","description":"Retrieves order with a fulfillment channel","schema":{"type":"string"},"example":"local","in":"query","required":false},{"name":"fulfillment_status","description":"Create order with fulfillment status","schema":{"type":"string"},"example":"fulfilled","in":"query","required":false},{"name":"shipping_method","description":"Retrieve entities according to shipping method","schema":{"type":"string"},"example":"flatrate_flatrate","in":"query","required":false},{"name":"delivery_method","description":"Retrieves order with delivery method","schema":{"type":"string"},"example":"local","in":"query","required":false},{"name":"tags","description":"Order tags","schema":{"type":"string"},"example":"tag1,tag2","in":"query","required":false},{"name":"ship_node_type","description":"Retrieves order with ship node type","schema":{"type":"string"},"example":"SellerFulfilled","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"use_latest_api_version","description":"Use the latest platform API version","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"vendor_id","description":"Counts orders specified by vendor id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/order.list.json":{"get":{"tags":["order"],"summary":"order.list","description":"Get list of orders from store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Order_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve orders via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"ids","description":"Retrieves orders specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"order_ids","description":"Retrieves orders specified by order ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"since_id","description":"Retrieve entities starting from the specified id.","schema":{"type":"string"},"example":"56","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"vendor_id","description":"Retrieves orders specified by vendor id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"customer_id","description":"Retrieves orders specified by customer id","schema":{"type":"string"},"example":"5","in":"query","required":false},{"name":"customer_email","description":"Retrieves orders specified by customer email","schema":{"type":"string"},"example":"jubari@hannsgroup.com","in":"query","required":false},{"name":"basket_id","description":"Retrieves order\u2019s info specified by basket id.","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"currency_id","description":"Currency Id","schema":{"type":"string"},"example":"usd","in":"query","required":false},{"name":"phone","description":"Filter orders by customer's phone number","schema":{"type":"string"},"example":"56686868654","in":"query","required":false},{"name":"order_status","description":"Retrieves orders specified by order status","schema":{"type":"string"},"example":"Completed","in":"query","required":false},{"name":"order_status_ids","description":"Retrieves orders specified by order statuses","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"in":"query","required":false},{"name":"ebay_order_status","description":"Retrieves orders specified by order status","schema":{"type":"string"},"example":"Active","in":"query","required":false},{"name":"financial_status","description":"Retrieves orders specified by financial status","schema":{"type":"string"},"example":"paid","in":"query","required":false},{"name":"financial_status_ids","description":"Retrieves orders specified by financial status ids","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"in":"query","required":false},{"name":"fulfillment_status","description":"Create order with fulfillment status","schema":{"type":"string"},"example":"fulfilled","in":"query","required":false},{"name":"return_status","description":"Retrieves orders specified by return status","schema":{"type":"string"},"example":"RETURNED","in":"query","required":false},{"name":"fulfillment_channel","description":"Retrieves order with a fulfillment channel","schema":{"type":"string"},"example":"local","in":"query","required":false},{"name":"shipping_method","description":"Retrieve entities according to shipping method","schema":{"type":"string"},"example":"flatrate_flatrate","in":"query","required":false},{"name":"skip_order_ids","description":"Skipped orders by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"is_deleted","description":"Filter deleted orders","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"shipping_country_iso3","description":"Retrieve entities according to shipping country","schema":{"type":"string"},"example":"DEU","in":"query","required":false},{"name":"delivery_method","description":"Retrieves order with delivery method","schema":{"type":"string"},"example":"local","in":"query","required":false},{"name":"ship_node_type","description":"Retrieves order with ship node type","schema":{"type":"string"},"example":"SellerFulfilled","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"tags","description":"Order tags","schema":{"type":"string"},"example":"tag1,tag2","in":"query","required":false},{"name":"sort_by","description":"Set field to sort by","schema":{"type":"string","default":"order_id"},"example":"modified_at","in":"query","required":false},{"name":"sort_direction","description":"Set sorting direction","schema":{"type":"string","default":"asc"},"example":"asc","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"order_id,customer,totals,address,items,bundles,status"},"example":"order_id,totals,status","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,pagination,result{order{order_id,customer,totals,address,items,bundles,status}}}","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"order_id,totals,status","in":"query","required":false},{"name":"enable_cache","description":"If the value is 'true', we will cache orders for a 15 minutes in order to increase speed and reduce requests throttling for some methods and shoping platforms (for example order.shipment.add)","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"use_latest_api_version","description":"Use the latest platform API version","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"rounding_precision","description":"

Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).

Supported values range from 1 to 6.

The default rounding precision may vary depending on the platform. You can retrieve the default value using the cart.info method in the default_rounding_precision field.

Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.

","schema":{"type":"integer"},"example":3,"in":"query","required":false},{"name":"allow_user_defined_order_statuses","description":"Indicates whether custom (user-defined) order statuses should be included in the response.","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false}]}},"/order.find.json":{"get":{"tags":["order"],"summary":"order.find","description":"This method is deprecated and won't be supported in the future. Please use \"order.list\" instead.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderFind","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"order":{"type":"array","items":{"$ref":"#/components/schemas/Order"}}}}}}}}}},"deprecated":true,"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"customer_id","description":"Retrieves orders specified by customer id","schema":{"type":"string"},"example":"5","in":"query","required":false},{"name":"customer_email","description":"Retrieves orders specified by customer email","schema":{"type":"string"},"example":"jubari@hannsgroup.com","in":"query","required":false},{"name":"order_status","description":"Retrieves orders specified by order status","schema":{"type":"string"},"example":"Completed","in":"query","required":false},{"name":"financial_status","description":"Retrieves orders specified by financial status","schema":{"type":"string"},"example":"paid","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"rounding_precision","description":"

Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).

Supported values range from 1 to 6.

The default rounding precision may vary depending on the platform. You can retrieve the default value using the cart.info method in the default_rounding_precision field.

Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.

","schema":{"type":"integer"},"example":3,"in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"order_id,customer,totals,address,items,bundles,status"},"example":"order_id,totals,status","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"order_id,totals,status","in":"query","required":false}]}},"/order.calculate.json":{"post":{"tags":["order"],"summary":"order.calculate","description":"

Calculates the total cost of an order for a given customer and a set of products, as well as the available shipping methods based on the specified address. The calculation takes into account store product prices, discounts, taxes, shipping costs, and other store settings. The result includes a detailed breakdown of the final order cost by its components.

Note that the final totals, taxes, and other amounts must include the corresponding values for the selected shipping method.

The result of this method can be used when creating an order using the order.add method.

","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderCalculate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"$ref":"#/components/schemas/Order_Calculate"}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCalculate"}}}}}},"/order.add.json":{"post":{"tags":["order"],"summary":"order.add","description":"Add a new order to the cart.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"order_id":{"type":"string"},"id":{"type":["string","null"]},"customer_id":{"type":["string","null"]}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderAdd"}}}}}},"/order.update.json":{"put":{"tags":["order"],"summary":"order.update","description":"Update existing order.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated_items":{"type":"integer"}}}}}}}}},"parameters":[{"name":"order_id","description":"Defines the orders specified by order id","schema":{"type":"string"},"example":25,"in":"query","required":true},{"name":"store_id","description":"Defines store id where the order should be found","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"order_status","description":"Defines new order's status","schema":{"type":"string"},"example":"Completed","in":"query","required":false},{"name":"financial_status","description":"Update order financial status to specified","schema":{"type":"string"},"example":"paid","in":"query","required":false},{"name":"fulfillment_status","description":"Create order with fulfillment status","schema":{"type":"string"},"example":"fulfilled","in":"query","required":false},{"name":"cancellation_reason","description":"Defines the cancellation reason when the order will be canceled","schema":{"type":"string"},"example":"ORDER_UNPAID","in":"query","required":false},{"name":"order_payment_method","description":"Defines order payment method.
Setting order_payment_method on Shopify will also change financial_status field value to 'paid'","schema":{"type":"string"},"example":"PayPal","in":"query","required":false},{"name":"comment","description":"Specifies order comment","schema":{"type":"string"},"example":"This coole order","in":"query","required":false},{"name":"admin_comment","description":"Specifies admin's order comment","schema":{"type":"string"},"example":"Test admin comment","in":"query","required":false},{"name":"admin_private_comment","description":"Specifies private admin's order comment","schema":{"type":"string"},"example":"Test admin private comment","in":"query","required":false},{"name":"invoice_admin_comment","description":"Specifies admin's order invoice comment","schema":{"type":"string"},"example":"Test admin comment","in":"query","required":false},{"name":"date_modified","description":"Specifies order's modification date","schema":{"type":"string"},"example":"2014-05-05 05:05:00","in":"query","required":false},{"name":"date_finished","description":"Specifies order's finished date","schema":{"type":"string"},"example":"2014-06-05 05:05:00","in":"query","required":false},{"name":"send_notifications","description":"Send notifications to customer after order was created","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"create_invoice","description":"Determines whether an invoice should be created if it has not already been created","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"origin","description":"The source of the order","schema":{"type":"string"},"example":"newsletter","in":"query","required":false},{"name":"tags","description":"Order tags","schema":{"type":"string"},"example":"tag1,tag2","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/order.abandoned.list.json":{"get":{"tags":["order"],"summary":"order.abandoned.list","description":"Get list of orders that were left by customers before completing the order.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderAbandonedList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Order_Abandoned_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"customer_id","description":"Retrieves orders specified by customer id","schema":{"type":"string"},"example":"5","in":"query","required":false},{"name":"customer_email","description":"Retrieves orders specified by customer email","schema":{"type":"string"},"example":"jubari@hannsgroup.com","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"skip_empty_email","description":"Filter empty emails","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"rounding_precision","description":"

Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).

Supported values range from 1 to 6.

The default rounding precision may vary depending on the platform. You can retrieve the default value using the cart.info method in the default_rounding_precision field.

Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.

","schema":{"type":"integer"},"example":3,"in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,pagination,result{order{id,customer{email},created_at,totals{total},order_products}}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"customer,totals,items"},"example":"force_all","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"customer","in":"query","required":false}]}},"/order.financial_status.list.json":{"get":{"tags":["order"],"summary":"order.financial_status.list","description":"Retrieve list of financial statuses","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderFinancialStatusList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"order_financial_statuses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}}}}},"parameters":[]}},"/order.fulfillment_status.list.json":{"get":{"tags":["order"],"summary":"order.fulfillment_status.list","description":"Retrieve list of fulfillment statuses","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderFulfillmentStatusList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"order_fulfillment_statuses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}}}}},"parameters":[{"name":"action","description":"Available statuses for the specified action.","schema":{"type":"string"},"example":"add","in":"query","required":false}]}},"/order.preestimate_shipping.list.json":{"post":{"tags":["order"],"summary":"order.preestimate_shipping.list","description":"Retrieve list of order preestimated shipping methods","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderPreestimateShippingList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Order_PreestimateShipping_List"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderPreestimateShippingList"}}}}}},"/order.refund.add.json":{"post":{"tags":["order"],"summary":"order.refund.add","description":"Add a refund to the order.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderRefundAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"refund_id":{"type":"string"},"additional_refund_ids":{"type":["string","null"]}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRefundAdd"}}}}}},"/order.return.add.json":{"post":{"tags":["order"],"summary":"order.return.add","description":"Create new return request.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderReturnAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"return_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderReturnAdd"}}}}}},"/order.return.update.json":{"put":{"tags":["order"],"summary":"order.return.update","description":"Update order's shipment information.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderReturnUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated_items":{"type":"integer"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderReturnUpdate"}}}}}},"/order.return.delete.json":{"delete":{"tags":["order"],"summary":"order.return.delete","description":"Delete return.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderReturnDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"return_id","description":"Return ID","schema":{"type":"string"},"example":"200000002","in":"query","required":true},{"name":"order_id","description":"Defines the order id","schema":{"type":"string"},"example":25,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/order.shipment.info.json":{"get":{"tags":["order"],"summary":"order.shipment.info","description":"Get information of shipment.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderShipmentInfo","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"$ref":"#/components/schemas/Shipment"}}}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"order_id","description":"Defines the order id","schema":{"type":"string"},"example":25,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{id,order_id,shipment_provider,tracking_numbers{tracking_number},items{product_id,quantity}}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,order_id,items,tracking_numbers"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/order.shipment.list.json":{"get":{"tags":["order"],"summary":"order.shipment.list","description":"Get list of shipments per order.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderShipmentList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Order_Shipment_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"order_id","description":"Retrieves shipments specified by order id","schema":{"type":"string"},"example":25,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{status_code,pagination,result{shipment{id,order_id,shipment_provider,tracking_numbers{tracking_number},items{product_id,quantity}}}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,order_id,items,tracking_numbers"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/order.shipment.add.json":{"post":{"tags":["order"],"summary":"order.shipment.add","description":"Add a shipment to the order.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderShipmentAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"shipment_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderShipmentAdd"}}}}}},"/order.shipment.add.batch.json":{"post":{"tags":["order"],"summary":"order.shipment.add.batch","description":"Add a shipments to the orders.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderShipmentAddBatch","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"job_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderShipmentAddBatch"}}}}}},"/order.shipment.update.json":{"put":{"tags":["order"],"summary":"order.shipment.update","description":"Update order's shipment information.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderShipmentUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated_items":{"type":"integer"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderShipmentUpdate"}}}}}},"/order.shipment.delete.json":{"delete":{"tags":["order"],"summary":"order.shipment.delete","description":"Delete order's shipment.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderShipmentDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted_items":{"type":"integer"}}}}}}}}},"parameters":[{"name":"shipment_id","description":"Shipment id indicates the number of delivery","schema":{"type":"string"},"example":"200000002","in":"query","required":true},{"name":"order_id","description":"Defines the order for which the shipment will be deleted","schema":{"type":"string"},"example":25,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/order.shipment.event.list.json":{"get":{"tags":["order"],"summary":"order.shipment.event.list","description":"Get list of shipment tracking events.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderShipmentEventList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Order_Shipment_Event_List"}}}}},"parameters":[{"name":"shipment_id","description":"Defines the shipment for which tracking events will be retrieved","schema":{"type":"string"},"example":"200000002","in":"query","required":true},{"name":"order_id","description":"Defines the order to which the shipment belongs","schema":{"type":"string"},"example":25,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result}","in":"query","required":false}]}},"/order.shipment.event.add.json":{"post":{"tags":["order"],"summary":"order.shipment.event.add","description":"Add a tracking event to the shipment.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderShipmentEventAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderShipmentEventAdd"}}}}}},"/order.shipment.tracking.add.json":{"post":{"tags":["order"],"summary":"order.shipment.tracking.add","description":"Add order shipment's tracking info.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderShipmentTrackingAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"shipment_tracking_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderShipmentTrackingAdd"}}}}}},"/order.status.list.json":{"get":{"tags":["order"],"summary":"order.status.list","description":"Retrieve list of statuses","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderStatusList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Order_Status_List"}}}}},"parameters":[{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"action","description":"Available statuses for the specified action.","schema":{"type":"string"},"example":"add","in":"query","required":false},{"name":"allow_user_defined_order_statuses","description":"Indicates whether custom (user-defined) order statuses should be included in the response.","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,return_message,result}","in":"query","required":false}]}},"/order.transaction.list.json":{"get":{"tags":["order"],"summary":"order.transaction.list","description":"Retrieve list of order transaction","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"OrderTransactionList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Order_Transaction_List"}}}}},"parameters":[{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"order_ids","description":"Retrieves order transactions specified by order ids","schema":{"type":"string"},"example":"24,25","in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,order_id,amount,description"},"example":"id,model,price,images","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,pagination,result{transactions_count,transactions{id,transaction_id,status,description,settlement_amount,gateway,card_brand,card_last_four}}}","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/product.info.json":{"get":{"tags":["product"],"summary":"product.info","description":"Get information about a specific product by its ID. In the case of a multistore configuration, use the store_id filter to get a response in the context of a specific store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductInfo","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"$ref":"#/components/schemas/Product"}}}}}}},"parameters":[{"name":"id","description":"Retrieves product's info specified by product id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Retrieves product info specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"vendor_id","description":"Vendor Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Retrieves product info specified by language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"currency_id","description":"Currency Id","schema":{"type":"string"},"example":"usd","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{id,name,price,images}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,description,price,categories_ids"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false},{"name":"report_request_id","description":"Report request id","schema":{"type":"string"},"example":"105245017661","in":"query","required":false},{"name":"disable_report_cache","description":"Disable report cache for current request","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false},{"name":"use_latest_api_version","description":"Use the latest platform API version","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false}]}},"/product.count.json":{"get":{"tags":["product"],"summary":"product.count","description":"Count products in store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductCount","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"products_count":{"type":"integer"}}}}}}}}},"parameters":[{"name":"sku","description":"Filter by product's sku","schema":{"type":"string"},"example":"bag_01","in":"query","required":false},{"name":"product_ids","description":"Counts products specified by product ids","schema":{"type":"string"},"example":"4,5","in":"query","required":false},{"name":"since_id","description":"Retrieve entities starting from the specified id.","schema":{"type":"string"},"example":"56","in":"query","required":false},{"name":"categories_ids","description":"Defines product add that is specified by comma-separated categories id","schema":{"type":"string"},"example":"23,56","in":"query","required":false},{"name":"category_id","description":"Counts products specified by category id","schema":{"type":"string"},"example":6,"in":"query","required":false},{"name":"store_id","description":"Counts products specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"vendor_id","description":"Counts products specified by vendor id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Counts products specified by language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"avail_view","description":"Specifies the set of visible/invisible products","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"avail_sale","description":"Specifies the set of available/not available products for sale","schema":{"type":"boolean"},"example":false,"in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"brand_name","description":"Retrieves brands specified by brand name","schema":{"type":"string"},"example":"Abidas","in":"query","required":false},{"name":"manufacturer_id","description":"Defines product's manufacturer by manufacturer_id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"product_attributes","description":"Defines product attributes","schema":{"type":"array","items":{"type":"string"}},"example":"product_attributes[0][attribute_id]=132&product_attributes[0][values][0]=custom value 1&product_attributes[0][values][1]=custom value 2","in":"query","required":false},{"name":"status","description":"Defines product's status","schema":{"type":"string"},"example":"disabled","in":"query","required":false},{"name":"type","description":"Defines products's type","schema":{"type":"string"},"example":"simple","in":"query","required":false},{"name":"visible","description":"Filter items by visibility status","schema":{"type":"string","default":"everywhere"},"example":"everywhere","in":"query","required":false},{"name":"find_value","description":"Entity search that is specified by some value","schema":{"type":"string"},"example":"Phone","in":"query","required":false},{"name":"find_where","description":"Counts products that are searched specified by field","schema":{"type":"string"},"example":"name","in":"query","required":false},{"name":"report_request_id","description":"Report request id","schema":{"type":"string"},"example":"105245017661","in":"query","required":false},{"name":"return_global","description":"Determines the type of products to be returned. If set to 'true', only global products will be returned; if set to 'false', only local products will be returned.","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false},{"name":"disable_report_cache","description":"Disable report cache for current request","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false},{"name":"use_latest_api_version","description":"Use the latest platform API version","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false}]}},"/product.list.json":{"get":{"tags":["product"],"summary":"product.list","description":"Get list of products from your store. Returns 10 products by default.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Product_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve products via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"product_ids","description":"Retrieves products specified by product ids","schema":{"type":"string"},"example":"4,5","in":"query","required":false},{"name":"since_id","description":"Retrieve entities starting from the specified id.","schema":{"type":"string"},"example":"56","in":"query","required":false},{"name":"categories_ids","description":"Retrieves products specified by categories ids","schema":{"type":"string"},"example":"23,56","in":"query","required":false},{"name":"category_id","description":"Retrieves products specified by category id","schema":{"type":"string"},"example":6,"in":"query","required":false},{"name":"store_id","description":"Retrieves products specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"vendor_id","description":"Retrieves products specified by vendor id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Retrieves products specified by language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"currency_id","description":"Currency Id","schema":{"type":"string"},"example":"usd","in":"query","required":false},{"name":"avail_view","description":"Specifies the set of visible/invisible products","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"avail_sale","description":"Specifies the set of available/not available products for sale","schema":{"type":"boolean"},"example":false,"in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"sku","description":"Filter by product's sku","schema":{"type":"string"},"example":"bag_01","in":"query","required":false},{"name":"brand_name","description":"Retrieves brands specified by brand name","schema":{"type":"string"},"example":"Abidas","in":"query","required":false},{"name":"product_attributes","description":"Defines product attributes","schema":{"type":"array","items":{"type":"string"}},"example":"product_attributes[0][attribute_id]=132&product_attributes[0][values][0]=custom value 1&product_attributes[0][values][1]=custom value 2","in":"query","required":false},{"name":"manufacturer_id","description":"Defines product's manufacturer by manufacturer_id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"status","description":"Defines product's status","schema":{"type":"string"},"example":"disabled","in":"query","required":false},{"name":"type","description":"Defines products's type","schema":{"type":"string"},"example":"simple","in":"query","required":false},{"name":"visible","description":"Filter items by visibility status","schema":{"type":"string","default":"everywhere"},"example":"everywhere","in":"query","required":false},{"name":"find_value","description":"Entity search that is specified by some value","schema":{"type":"string"},"example":"Phone","in":"query","required":false},{"name":"find_where","description":"Product search that is specified by field","schema":{"type":"string"},"example":"name","in":"query","required":false},{"name":"return_global","description":"Determines the type of products to be returned. If set to 'true', only global products will be returned; if set to 'false', only local products will be returned.","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,description,price,categories_ids"},"example":"id,model,price,images","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,pagination,result{product{id,name,price,images}}}","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false},{"name":"sort_by","description":"Set field to sort by","schema":{"type":"string","default":"id"},"example":"value_id","in":"query","required":false},{"name":"sort_direction","description":"Set sorting direction","schema":{"type":"string","default":"asc"},"example":"asc","in":"query","required":false},{"name":"report_request_id","description":"Report request id","schema":{"type":"string"},"example":"105245017661","in":"query","required":false},{"name":"disable_cache","description":"Disable cache for current request","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false},{"name":"disable_report_cache","description":"Disable report cache for current request","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false},{"name":"use_latest_api_version","description":"Use the latest platform API version","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"product_type","description":"A categorization for the product","schema":{"type":"string"},"example":"BICYCLE","in":"query","required":false}]}},"/product.find.json":{"get":{"tags":["product"],"summary":"product.find","description":"Search product in store catalog. \"Apple\" is specified here by default.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductFind","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"product":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"price":{"type":"number"}}}}}}}}}}}},"parameters":[{"name":"find_value","description":"Entity search that is specified by some value","schema":{"type":"string"},"example":"Simple","in":"query","required":true},{"name":"find_where","description":"Entity search that is specified by the comma-separated unique fields","schema":{"type":"string","default":"name"},"example":"name","in":"query","required":false},{"name":"find_params","description":"Entity search that is specified by comma-separated parameters","schema":{"type":"string","default":"whole_words"},"example":"regex","in":"query","required":false},{"name":"find_what","description":"Parameter's value specifies the entity that has to be found","schema":{"type":"string","default":"product"},"example":"each","in":"query","required":false},{"name":"lang_id","description":"Search products specified by language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/product.fields.json":{"get":{"tags":["product"],"summary":"product.fields","description":"Retrieve all available fields for product item in store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductFields","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object"}}}}}}},"deprecated":true,"parameters":[]}},"/product.add.json":{"post":{"tags":["product"],"summary":"product.add","description":"Add new product to store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"product_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductAdd"}}}}}},"/product.add.batch.json":{"post":{"tags":["product"],"summary":"product.add.batch","description":"Add new products to the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductAddBatch","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"job_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductAddBatch"}}}}}},"/product.update.json":{"put":{"tags":["product"],"summary":"product.update","description":"This method can be used to update certain product data. The list of supported parameters depends on the specific platform. Please transmit only those parameters that are supported by the particular platform. Please note that to update the product quantity, it is recommended to use relative parameters (increase_quantity or reduce_quantity) to avoid unexpected overwrites on heavily loaded stores.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated_items":{"type":"integer"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductUpdate"}}}}}},"/product.update.batch.json":{"post":{"tags":["product"],"summary":"product.update.batch","description":"Update products on the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductUpdateBatch","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"job_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductUpdateBatch"}}}}}},"/product.delete.json":{"delete":{"tags":["product"],"summary":"product.delete","description":"Product delete","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"delete_items":{"type":"integer"}}}}}}}}},"parameters":[{"name":"id","description":"Product id that will be removed","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/product.delete.batch.json":{"post":{"tags":["product"],"summary":"product.delete.batch","description":"Remove product from the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductDeleteBatch","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"job_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDeleteBatch"}}}}}},"/product.attribute.list.json":{"get":{"tags":["product"],"summary":"product.attribute.list","description":"Get list of attributes and values.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductAttributeList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Product_Attribute_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"product_id","description":"Retrieves attributes specified by product id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"attribute_id","description":"Retrieves info for specified attribute_id","schema":{"type":"string"},"example":"156","in":"query","required":false},{"name":"variant_id","description":"Defines product's variants specified by variant id","schema":{"type":"string"},"example":45,"in":"query","required":false},{"name":"attribute_group_id","description":"Filter by attribute_group_id","schema":{"type":"string"},"example":"202","in":"query","required":false},{"name":"lang_id","description":"Retrieves attributes specified by language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"store_id","description":"Retrieves attributes specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"set_name","description":"Retrieves attributes specified by set_name in Magento","schema":{"type":"string"},"example":"Shoes","in":"query","required":false},{"name":"sort_by","description":"Set field to sort by","schema":{"type":"string","default":"attribute_id"},"example":"value","in":"query","required":false},{"name":"sort_direction","description":"Set sorting direction","schema":{"type":"string","default":"asc"},"example":"asc","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{pagination,result{attribute}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"attribute_id,name"},"example":"attribute_id,name","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"attribute_id,name","in":"query","required":false}]}},"/product.attribute.value.set.json":{"post":{"tags":["product"],"summary":"product.attribute.value.set","description":"Set attribute value to product.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductAttributeValueSet","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"product_id":{"type":"string"},"attribute_id":{"type":"string"},"value_id":{"type":"string"}}}}}}}}},"parameters":[{"name":"product_id","description":"Defines product id where the attribute should be added","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"attribute_id","description":"Filter by attribute_id","schema":{"type":"string"},"example":"156","in":"query","required":false},{"name":"attribute_group_id","description":"Filter by attribute_group_id","schema":{"type":"string"},"example":"202","in":"query","required":false},{"name":"attribute_name","description":"Define attribute name","schema":{"type":"string"},"example":"Color","in":"query","required":false},{"name":"value","description":"Define attribute value","schema":{"type":"string"},"example":"Red","in":"query","required":false},{"name":"value_id","description":"Define attribute value id","schema":{"type":"integer"},"example":22,"in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/product.attribute.value.unset.json":{"post":{"tags":["product"],"summary":"product.attribute.value.unset","description":"Removes attribute value for a product.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductAttributeValueUnset","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"product_id","description":"Product id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"attribute_id","description":"Attribute Id","schema":{"type":"string"},"example":"156","in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"include_default","description":"Boolean, whether or not to unset default value of the attribute, if applicable","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"reindex","description":"Is reindex required","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"clear_cache","description":"Is cache clear required","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/product.brand.list.json":{"get":{"tags":["product"],"summary":"product.brand.list","description":"Get list of brands from your store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductBrandList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Product_Brand_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"brand_ids","description":"Retrieves brands specified by brand ids","schema":{"type":"string"},"example":"4,5","in":"query","required":false},{"name":"category_id","description":"Retrieves product brands specified by category id","schema":{"type":"string"},"example":6,"in":"query","required":false},{"name":"parent_id","description":"Retrieves brands specified by parent id","schema":{"type":"string"},"example":6,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"find_where","description":"Entity search that is specified by the comma-separated unique fields","schema":{"type":"string"},"example":"name","in":"query","required":false},{"name":"find_value","description":"Entity search that is specified by some value","schema":{"type":"string"},"example":"Phone","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"avail","description":"Defines category's visibility status","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,return_message,pagination,result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,short_description,active,url"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/product.child_item.info.json":{"get":{"tags":["product"],"summary":"product.child_item.info","description":"Get child for specific product.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductChildItemInfo","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"$ref":"#/components/schemas/Child"}}}}}}},"parameters":[{"name":"product_id","description":"Filter by parent product id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"currency_id","description":"Currency Id","schema":{"type":"string"},"example":"usd","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{id,parent_id,sku,upc,images,combination}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false},{"name":"use_latest_api_version","description":"Use the latest platform API version","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false}]}},"/product.child_item.list.json":{"get":{"tags":["product"],"summary":"product.child_item.list","description":"Get a list of a product's child items, such as variants or bundle components. The total_count field in the response indicates the total number of items in the context of the current filter.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductChildItemList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Product_ChildItem_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve products child items via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"product_id","description":"Filter by parent product id","schema":{"type":"string"},"example":10,"in":"query","required":false},{"name":"product_ids","description":"Filter by parent product ids","schema":{"type":"string"},"example":"4,5","in":"query","required":false},{"name":"sku","description":"Filter by products variant's sku","schema":{"type":"string"},"example":"bag_01","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"currency_id","description":"Currency Id","schema":{"type":"string"},"example":"usd","in":"query","required":false},{"name":"avail_sale","description":"Specifies the set of available/not available products for sale","schema":{"type":"boolean"},"example":false,"in":"query","required":false},{"name":"find_value","description":"Entity search that is specified by some value","schema":{"type":"string"},"example":"bundled-item-123-","in":"query","required":false},{"name":"find_where","description":"Child products search that is specified by field","schema":{"type":"string"},"example":"sku","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"return_global","description":"Determines the type of products to be returned. If set to 'true', only global products will be returned; if set to 'false', only local products will be returned.","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{children{id,parent_id,sku,upc,images,combination}}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false},{"name":"report_request_id","description":"Report request id","schema":{"type":"string"},"example":"105245017661","in":"query","required":false},{"name":"disable_report_cache","description":"Disable report cache for current request","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false},{"name":"use_latest_api_version","description":"Use the latest platform API version","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false}]}},"/product.child_item.find.json":{"get":{"tags":["product"],"summary":"product.child_item.find","description":"Search product child item (bundled item or configurable product variant) in store catalog.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductChildItemFind","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"children":{"items":{"$ref":"#/components/schemas/Child"}}}}}}}}}},"parameters":[{"name":"find_value","description":"Entity search that is specified by some value","schema":{"type":"string"},"example":"bundled-item-123-","in":"query","required":false},{"name":"find_where","description":"Entity search that is specified by the comma-separated unique fields","schema":{"type":"string"},"example":"sku","in":"query","required":false},{"name":"find_params","description":"Entity search that is specified by comma-separated parameters","schema":{"type":"string","default":"whole_words"},"example":"regex","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/product.currency.list.json":{"get":{"tags":["product"],"summary":"product.currency.list","description":"Get list of currencies","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductCurrencyList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Product_Currency_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"default","description":"Specifies the set of default/not default currencies","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"avail","description":"Specifies the set of available/not available currencies","schema":{"type":"boolean"},"example":false,"in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_message,pagination,result{currency}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"name,iso3,default,avail"},"example":"name,iso3,default,avail","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"name,iso3,default,avail","in":"query","required":false}]}},"/product.currency.add.json":{"post":{"tags":["product"],"summary":"product.currency.add","description":"Add currency and/or set default in store","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductCurrencyAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"currency_id":{"type":"string"}}}}}}}}},"parameters":[{"name":"iso3","description":"Specifies standardized currency code","schema":{"type":"string"},"example":"USD","in":"query","required":true},{"name":"rate","description":"Defines the numerical identifier against to the major currency","schema":{"type":"number"},"example":1,"in":"query","required":true},{"name":"name","description":"Defines currency's name","schema":{"type":"string"},"example":"US Dollar","in":"query","required":false},{"name":"avail","description":"Specifies whether the currency is available","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"symbol_left","description":"Defines the symbol that is located before the currency","schema":{"type":"string"},"example":"$","in":"query","required":false},{"name":"symbol_right","description":"Defines the symbol that is located after the currency","schema":{"type":"string"},"example":"\u0433\u0440\u043d","in":"query","required":false},{"name":"default","description":"Specifies currency's default meaning","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/product.image.add.json":{"post":{"tags":["product"],"summary":"product.image.add","description":"Add image to product","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductImageAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"},"image_path":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductImageAdd"}}}}}},"/product.image.update.json":{"put":{"tags":["product"],"summary":"product.image.update","description":"Update details of image","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductImageUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated":{"type":"string"}}}}}}}}},"parameters":[{"name":"product_id","description":"Defines product id where the image should be updated","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"id","description":"Defines image update specified by image id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"variant_ids","description":"Defines product's variants ids","schema":{"type":"string"},"example":"1,2,3,4,5","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"image_name","description":"Defines image's name","schema":{"type":"string"},"example":"data/product/main/product_69_bag-gray.png","in":"query","required":false},{"name":"type","description":"Defines image's types that are specified by comma-separated list","schema":{"type":"string","default":"additional"},"example":"thumbnail","in":"query","required":false},{"name":"label","description":"Defines alternative text that has to be attached to the picture","schema":{"type":"string"},"example":"This cool image","in":"query","required":false},{"name":"position","description":"Defines image\u2019s position in the list","schema":{"type":"integer"},"example":5,"in":"query","required":false},{"name":"hidden","description":"Define is hide image","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/product.image.delete.json":{"delete":{"tags":["product"],"summary":"product.image.delete","description":"Delete image","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductImageDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"string"}}}}}}}}},"parameters":[{"name":"product_id","description":"Defines product id where the image should be deleted","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/product.manufacturer.add.json":{"post":{"tags":["product"],"summary":"product.manufacturer.add","description":"Add manufacturer to store and assign to product","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductManufacturerAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"manufacturer_id":{"type":"string"}}}}}}}}},"parameters":[{"name":"product_id","description":"Defines products specified by product id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"manufacturer","description":"Defines product\u2019s manufacturer's name","schema":{"type":"string"},"example":"Samsung","in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"description","description":"Defines manufacturer's description","schema":{"type":"string"},"example":"Acme Corporation \u2014 premium tools brand","in":"query","required":false},{"name":"meta_title","description":"Defines unique meta title for each entity","schema":{"type":"string"},"example":"category,test","in":"query","required":false},{"name":"meta_keywords","description":"Defines unique meta keywords for each entity","schema":{"type":"string"},"example":"category,test","in":"query","required":false},{"name":"meta_description","description":"Defines unique meta description of a entity","schema":{"type":"string"},"example":"category,test","in":"query","required":false},{"name":"search_keywords","description":"Defines unique search keywords","schema":{"type":"string"},"example":"key1,key2,key3","in":"query","required":false},{"name":"image_url","description":"Image Url","schema":{"type":"string"},"example":"https://docs.api2cart.com/img/logo.png","in":"query","required":false},{"name":"seo_url","description":"Defines unique URL for SEO","schema":{"type":"string"},"example":"some seo url","in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/product.option.list.json":{"get":{"tags":["product"],"summary":"product.option.list","description":"Get list of options.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductOptionList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Product_Option_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"product_id","description":"Retrieves products' options specified by product id","schema":{"type":"string"},"example":10,"in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,return_message,pagination,result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,description"},"example":"id,name,sort_order","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"id,name,sort_order","in":"query","required":false}]}},"/product.option.assign.json":{"post":{"tags":["product"],"summary":"product.option.assign","description":"Assign option from product.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductOptionAssign","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"product_option_id":{"type":"string"}}}}}}}}},"parameters":[{"name":"product_id","description":"Defines product id where the option should be assigned","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"option_id","description":"Defines option id which has to be assigned","schema":{"type":"string"},"example":5,"in":"query","required":true},{"name":"required","description":"Defines if the option is required","schema":{"type":"boolean","default":false},"example":true,"in":"query","required":false},{"name":"sort_order","description":"Sort number in the list","schema":{"type":"integer","default":0},"example":2,"in":"query","required":false},{"name":"option_values","description":"Defines option values that has to be assigned","schema":{"type":"string"},"example":"green,black,yellow","in":"query","required":false},{"name":"clear_cache","description":"Is cache clear required","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/product.option.add.json":{"post":{"tags":["product"],"summary":"product.option.add","description":"Add product option from store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductOptionAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"option_id":{"type":["string","null"]},"product_option_id":{"type":"string"},"product_value_ids":{"type":["string","null"]}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOptionAdd"}}}}}},"/product.option.delete.json":{"delete":{"tags":["product"],"summary":"product.option.delete","description":"Product option delete.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductOptionDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"string"}}}}}}}}},"parameters":[{"name":"option_id","description":"Defines option id that should be deleted","schema":{"type":"string"},"example":5,"in":"query","required":true},{"name":"product_id","description":"Defines product id where the option should be deleted","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/product.option.value.assign.json":{"post":{"tags":["product"],"summary":"product.option.value.assign","description":"Assign product option item from product.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductOptionValueAssign","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"product_option_value_id":{"type":"string"}}}}}}}}},"parameters":[{"name":"product_option_id","description":"Defines product's option id where the value has to be assigned","schema":{"type":"integer"},"example":5,"in":"query","required":true},{"name":"option_value_id","description":"Defines value id that has to be assigned","schema":{"type":"string"},"example":45,"in":"query","required":true},{"name":"clear_cache","description":"Is cache clear required","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/product.option.value.add.json":{"post":{"tags":["product"],"summary":"product.option.value.add","description":"Add product option item from option.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductOptionValueAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"option_value_id":{"type":"string"}}}}}}}}},"parameters":[{"name":"product_id","description":"Defines product id where the option value should be added","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"option_id","description":"Defines option id where the value has to be added","schema":{"type":"string"},"example":5,"in":"query","required":true},{"name":"option_value","description":"Defines option value that has to be added","schema":{"type":"string"},"example":"green","in":"query","required":false},{"name":"sort_order","description":"Sort number in the list","schema":{"type":"integer","default":0},"example":2,"in":"query","required":false},{"name":"display_value","description":"Defines the value that will be displayed for the option value","schema":{"type":"string"},"example":"value","in":"query","required":false},{"name":"is_default","description":"Defines as a default","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"clear_cache","description":"Is cache clear required","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/product.option.value.update.json":{"put":{"tags":["product"],"summary":"product.option.value.update","description":"Update product option item from option.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductOptionValueUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated_items":{"type":"integer"}}}}}}}}},"parameters":[{"name":"product_id","description":"Defines product id where the option value should be updated","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"option_id","description":"Defines option id where the value has to be updated","schema":{"type":"string"},"example":5,"in":"query","required":true},{"name":"option_value_id","description":"Defines value id that has to be assigned","schema":{"type":"string"},"example":45,"in":"query","required":true},{"name":"option_value","description":"Defines option value that has to be added","schema":{"type":"string"},"example":"green","in":"query","required":false},{"name":"price","description":"Defines new product option price","schema":{"type":"number"},"example":99.9,"in":"query","required":false},{"name":"quantity","description":"Defines new products' options quantity","schema":{"type":"number"},"example":6,"in":"query","required":false},{"name":"display_value","description":"Defines the value that will be displayed for the option value","schema":{"type":"string"},"example":"value","in":"query","required":false},{"name":"clear_cache","description":"Is cache clear required","schema":{"type":"boolean","default":true},"example":false,"in":"query","required":false},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/product.option.value.delete.json":{"delete":{"tags":["product"],"summary":"product.option.value.delete","description":"Product option value delete.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductOptionValueDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"string"}}}}}}}}},"parameters":[{"name":"option_id","description":"Defines option id where the value should be deleted","schema":{"type":"string"},"example":5,"in":"query","required":true},{"name":"option_value_id","description":"Defines option value id that should be deleted","schema":{"type":"string"},"example":45,"in":"query","required":true},{"name":"product_id","description":"Defines product id where the option value should be deleted","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/product.price.add.json":{"post":{"tags":["product"],"summary":"product.price.add","description":"Add some prices to the product.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductPriceAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"status":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductPriceAdd"}}}}}},"/product.price.update.json":{"put":{"tags":["product"],"summary":"product.price.update","description":"Update some prices of the product.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductPriceUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated_items":{"type":"integer"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductPriceUpdate"}}}}}},"/product.price.delete.json":{"delete":{"tags":["product"],"summary":"product.price.delete","description":"Delete some prices of the product","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductPriceDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"string"}}}}}}}}},"parameters":[{"name":"product_id","description":"Defines the product where the price has to be deleted","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"group_prices","description":"Defines product's group prices","schema":{"type":"string"},"example":"group_prices=5,8,9","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/product.review.list.json":{"get":{"tags":["product"],"summary":"product.review.list","description":"Get reviews of a specific product.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductReviewList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Product_Review_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"product_id","description":"Product id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"ids","description":"Retrieves reviews specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"status","description":"Defines status","schema":{"type":"string"},"example":"disabled","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"customer_id","description":"Retrieves orders specified by customer id","schema":{"type":"string"},"example":"5","in":"query","required":false},{"name":"sort_by","description":"Set field to sort by","schema":{"type":"string","default":"id"},"example":"value_id","in":"query","required":false},{"name":"sort_direction","description":"Set sorting direction","schema":{"type":"string","default":"asc"},"example":"asc","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,return_message,pagination,result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,customer_id,email,message,status,product_id,nick_name,summary,rating,ratings,status,created_time"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/product.store.assign.json":{"post":{"tags":["product"],"summary":"product.store.assign","description":"Assign product to store","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductStoreAssign","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated_items":{"type":"integer"}}}}}}}}},"parameters":[{"name":"product_id","description":"Defines id of the product which should be assigned to a store","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Defines id of the store product should be assigned to","schema":{"type":"string"},"example":"1","in":"query","required":true},{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","schema":{"type":"string"},"example":"098f6bcd4621d373cade4e832627b4f6","in":"query","required":false}]}},"/product.tax.add.json":{"post":{"tags":["product"],"summary":"product.tax.add","description":"Add tax class and tax rate to store and assign to product.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductTaxAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"tax_class_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductTaxAdd"}}}}}},"/product.variant.info.json":{"get":{"tags":["product"],"summary":"product.variant.info","description":"Get variant info. This method is deprecated, and its development is stopped. Please use \"product.child_item.info\" instead.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantInfo","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"$ref":"#/components/schemas/Product"}}}}}}},"deprecated":true,"parameters":[{"name":"id","description":"Retrieves variant's info specified by variant id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Retrieves variant info specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,description,price"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/product.variant.count.json":{"get":{"tags":["product"],"summary":"product.variant.count","description":"Get count variants.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantCount","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"variants_count":{"type":"integer"}}}}}}}}},"deprecated":true,"parameters":[{"name":"product_id","description":"Retrieves products' variants specified by product id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"category_id","description":"Counts products\u2019 variants specified by category id","schema":{"type":"string"},"example":6,"in":"query","required":false},{"name":"store_id","description":"Retrieves variants specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false}]}},"/product.variant.list.json":{"get":{"tags":["product"],"summary":"product.variant.list","description":"Get a list of variants. This method is deprecated, and its development is stopped. Please use \"product.child_item.list\" instead.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"variant":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}}}}}}}}},"deprecated":true,"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"product_id","description":"Retrieves products' variants specified by product id","schema":{"type":"string"},"example":10,"in":"query","required":false},{"name":"category_id","description":"Retrieves products\u2019 variants specified by category id","schema":{"type":"string"},"example":6,"in":"query","required":false},{"name":"store_id","description":"Retrieves variants specified by store id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,description,price"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/product.variant.add.json":{"post":{"tags":["product"],"summary":"product.variant.add","description":"Add variant to product.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"product_variant_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVariantAdd"}}}}}},"/product.variant.add.batch.json":{"post":{"tags":["product"],"summary":"product.variant.add.batch","description":"Add new product variants to the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantAddBatch","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"job_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVariantAddBatch"}}}}}},"/product.variant.update.json":{"put":{"tags":["product"],"summary":"product.variant.update","description":"Update variant.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated_items":{"type":"integer"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVariantUpdate"}}}}}},"/product.variant.update.batch.json":{"post":{"tags":["product"],"summary":"product.variant.update.batch","description":"Update products variants on the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantUpdateBatch","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"job_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVariantUpdateBatch"}}}}}},"/product.variant.delete.json":{"delete":{"tags":["product"],"summary":"product.variant.delete","description":"Delete variant.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"id","description":"Defines variant removal, specified by variant id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"product_id","description":"Defines product's id where the variant has to be deleted","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/product.variant.delete.batch.json":{"post":{"tags":["product"],"summary":"product.variant.delete.batch","description":"Remove product variants from the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantDeleteBatch","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"job_id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVariantDeleteBatch"}}}}}},"/product.variant.image.add.json":{"post":{"tags":["product"],"summary":"product.variant.image.add","description":"Add image to product","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantImageAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":["string","null"]},"image_path":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVariantImageAdd"}}}}}},"/product.variant.image.delete.json":{"delete":{"tags":["product"],"summary":"product.variant.image.delete","description":"Delete image to product","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantImageDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"string"}}}}}}}}},"parameters":[{"name":"product_id","description":"Defines product id where the variant image should be deleted","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"product_variant_id","description":"Defines product's variants specified by variant id","schema":{"type":"string"},"example":45,"in":"query","required":true},{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/product.variant.price.add.json":{"post":{"tags":["product"],"summary":"product.variant.price.add","description":"Add some prices to the product variant.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantPriceAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"status":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVariantPriceAdd"}}}}}},"/product.variant.price.update.json":{"put":{"tags":["product"],"summary":"product.variant.price.update","description":"Update some prices of the product variant.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantPriceUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated_items":{"type":"integer"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVariantPriceUpdate"}}}}}},"/product.variant.price.delete.json":{"delete":{"tags":["product"],"summary":"product.variant.price.delete","description":"Delete some prices of the product variant.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ProductVariantPriceDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"string"}}}}}}}}},"parameters":[{"name":"id","description":"Defines the variant where the price has to be deleted","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"product_id","description":"Product id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"group_prices","description":"Defines variants's group prices","schema":{"type":"string"},"example":"group_prices=6,8,9","in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/return.info.json":{"get":{"tags":["return"],"summary":"return.info","description":"Retrieve return information.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ReturnInfo","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"$ref":"#/components/schemas/Return"}}}}}}},"parameters":[{"name":"id","description":"Entity id","schema":{"type":"string"},"example":10,"in":"query","required":true},{"name":"order_id","description":"Defines the order id","schema":{"type":"string"},"example":25,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,return_message,result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,order_products"},"example":"id,order_products","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"id,order_id","in":"query","required":false}]}},"/return.count.json":{"get":{"tags":["return"],"summary":"return.count","description":"Count returns in store","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ReturnCount","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"returns_count":{"type":"integer"}}}}}}}}},"parameters":[{"name":"order_ids","description":"Counts return requests specified by order ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"customer_id","description":"Counts return requests quantity specified by customer id","schema":{"type":"string"},"example":"5","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"status","description":"Defines status","schema":{"type":"string"},"example":"disabled","in":"query","required":false},{"name":"return_type","description":"Retrieves returns specified by return type","schema":{"type":"string"},"example":"FBA","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"report_request_id","description":"Report request id","schema":{"type":"string"},"example":"105245017661","in":"query","required":false},{"name":"disable_report_cache","description":"Disable report cache for current request","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false}]}},"/return.list.json":{"get":{"tags":["return"],"summary":"return.list","description":"Get list of return requests from store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ReturnList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Return_List"}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"order_id","description":"Defines the order id","schema":{"type":"string"},"example":25,"in":"query","required":false},{"name":"order_ids","description":"Retrieves return requests specified by order ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"customer_id","description":"Retrieves return requests specified by customer id","schema":{"type":"string"},"example":"5","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"status","description":"Defines status","schema":{"type":"string"},"example":"disabled","in":"query","required":false},{"name":"return_type","description":"Retrieves returns specified by return type","schema":{"type":"string"},"example":"FBA","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,return_message,pagination,result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,order_products"},"example":"id,order_products","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"id,order_id","in":"query","required":false},{"name":"report_request_id","description":"Report request id","schema":{"type":"string"},"example":"105245017661","in":"query","required":false},{"name":"disable_report_cache","description":"Disable report cache for current request","schema":{"type":"boolean","default":false},"example":false,"in":"query","required":false}]}},"/return.action.list.json":{"get":{"tags":["return"],"summary":"return.action.list","description":"Retrieve list of return actions","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ReturnActionList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"return_actions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}}}}},"parameters":[]}},"/return.reason.list.json":{"get":{"tags":["return"],"summary":"return.reason.list","description":"Retrieve list of return reasons","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ReturnReasonList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"return_reasons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}}}}},"parameters":[{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/return.status.list.json":{"get":{"tags":["return"],"summary":"return.status.list","description":"Retrieve list of statuses","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"ReturnStatusList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"return_statuses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}}}}},"parameters":[]}},"/subscriber.list.json":{"get":{"tags":["subscriber"],"summary":"subscriber.list","description":"Get subscribers list","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"SubscriberList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Subscriber_List"}}}}},"parameters":[{"name":"ids","description":"Retrieves subscribers specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"subscribed","description":"Filter by subscription status","schema":{"type":"boolean"},"example":false,"in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"email","description":"Filter subscribers by email","schema":{"type":"string"},"example":"mail@example.com","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{return_code,return_message,pagination,result}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all"},"example":"id,model,price,images","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":false,"in":"query","required":false}]}},"/tax.class.info.json":{"get":{"tags":["tax"],"summary":"tax.class.info","description":"Use this method to get information about a tax class and its rates. It allows you to calculate the tax percentage for a specific customer's address. This information contains relatively static data that rarely changes, so API2Cart may cache certain data to reduce the load on the store and speed up request execution. We also recommend that you cache the response of this method on your side to save requests. If you need to clear the cache for a specific store, use the cart.validate method.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"TaxClassInfo","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Tax_Class_Info"}}}}},"parameters":[{"name":"tax_class_id","description":"Retrieves taxes specified by class id","schema":{"type":"string"},"example":9,"in":"query","required":true},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"lang_id","description":"Language id","schema":{"type":"string"},"example":3,"in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string"},"example":"{result{id,name,tax,tax_rates{id,countries{id,name,states},cities,address,zip_codes{is_range,range,fields}}}}","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"tax_class_id,name,avail"},"example":"tax_class_id,tax","in":"query","required":false},{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string"},"example":"tax_class_id,tax","in":"query","required":false}]}},"/tax.class.list.json":{"get":{"tags":["tax"],"summary":"tax.class.list","description":"Get list of tax classes from your store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"TaxClassList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Tax_Class_List"}}}}},"parameters":[{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"store_id","description":"Store Id","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"find_value","description":"Entity search that is specified by some value","schema":{"type":"string"},"example":"tax","in":"query","required":false},{"name":"find_where","description":"Tax class search that is specified by field","schema":{"type":"string"},"example":"name","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"{return_code,return_message,pagination,result}"},"example":"{result}","in":"query","required":false}]}},"/webhook.count.json":{"get":{"tags":["webhook"],"summary":"webhook.count","description":"Count registered webhooks on the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"WebhookCount","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"webhook_count":{"type":"integer"}}}}}}}}},"parameters":[{"name":"entity","description":"The entity you want to filter webhooks by (e.g. order or product)","schema":{"type":"string"},"example":"product","in":"query","required":false},{"name":"action","description":"The action you want to filter webhooks by (e.g. order or product)","schema":{"type":"string"},"example":"add","in":"query","required":false},{"name":"active","description":"The webhook status you want to filter webhooks by","schema":{"type":"boolean"},"example":true,"in":"query","required":false}]}},"/webhook.list.json":{"get":{"tags":["webhook"],"summary":"webhook.list","description":"List registered webhook on the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"WebhookList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"webhook":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}}}}}}}}}},"parameters":[{"name":"start","description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0},"example":0,"in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"entity","description":"The entity you want to filter webhooks by (e.g. order or product)","schema":{"type":"string"},"example":"product","in":"query","required":false},{"name":"action","description":"The action you want to filter webhooks by (e.g. add, update, or delete)","schema":{"type":"string"},"example":"add","in":"query","required":false},{"name":"active","description":"The webhook status you want to filter webhooks by","schema":{"type":"boolean"},"example":true,"in":"query","required":false},{"name":"ids","description":"List of \u0441omma-separated webhook ids","schema":{"type":"string"},"example":"3,14,25","in":"query","required":false},{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,entity,action,callback"},"example":"id,entity,callback,fields","in":"query","required":false}]}},"/webhook.events.json":{"get":{"tags":["webhook"],"summary":"webhook.events","description":"List all Webhooks that are available on this store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"WebhookEvents","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"webhook_name":{"type":"string"},"entity":{"type":"string"},"action":{"type":"string"},"filterable_fields":{"type":"object"}}}}}}}}}}}},"parameters":[]}},"/webhook.create.json":{"post":{"tags":["webhook"],"summary":"webhook.create","description":"Create webhook on the store and subscribe to it.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"WebhookCreate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"integer"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreate"}}}}}},"/webhook.update.json":{"put":{"tags":["webhook"],"summary":"webhook.update","description":"Update Webhooks parameters.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"WebhookUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdate"}}}}}},"/webhook.delete.json":{"delete":{"tags":["webhook"],"summary":"webhook.delete","description":"Delete registered webhook on the store.","security":[{"ApiKeyAuth":[],"StoreKeyAuth":[]}],"operationId":"WebhookDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"string"}}}}}}}}},"parameters":[{"name":"id","description":"Webhook id","schema":{"type":"string"},"example":"25","in":"query","required":true}]}}}, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "name": "x-api-key", "in": "header" }, "StoreKeyAuth": { "type": "apiKey", "name": "x-store-key", "in": "header" } }, "schemas": {"A2CDateTime":{"type":"object","properties":{"value":{"type":["string","null"]},"format":{"type":"string"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"AccountCartAdd":{"type":"object","properties":{"cart_id":{"name":"cart_id","description":"Store\u2019s identifier which you can get from cart_list method","example":"Opencart14","type":"string","enum":["3DCart","3DCartApi","AceShop","AmazonSP","Americommerce","AspDotNetStorefront","BigCartel","Bricklink","BigcommerceApi","Bol","CommerceHQ","Creloaded","Cscart","Cubecart","Demandware","EBay","Ecwid","EtsyAPIv3","Facebook","Flipkart","Gambio","Hybris","JooCart","Jumpseller","Lazada","LightSpeed","Magento1212","Magento2Api","MercadoLibre","MijoShop","Miva","Neto","Opencart14","Oscmax2","Oscommerce22ms2","Otto","Oxid","Pinnacle","Prestashop","PrestashopApi","Salla","SCAPI","Shopify","Shopee","Shoplazza","Shopline","Shopware","ShopwareApi","Square","Squarespace","Temu","Tiendanube","TikTokShop","Tomatocart","Ubercart","Unas","Virtuemart","Volusion","WPecommerce","Walmart","Wix","Woocommerce","WoocommerceApi","Xcart","Xtcommerce","XtcommerceVeyton","Zencart137","Zid","Zoey","Zoho"]},"store_url":{"name":"store_url","description":"A web address of a store that you would like to connect to API2Cart","example":"http://mystore.com","type":"string"},"bridge_url":{"name":"bridge_url","description":"This parameter allows to set up store with custom bridge url (also you must use store_root parameter if a bridge folder is not in the root folder of the store)","example":"https://your-store.com/custom/bridge/path/bridge.php","type":"string"},"store_root":{"name":"store_root","description":"Absolute path to the store root directory (used with \"bridge_url\" parameter)","example":"/home/www/stores/magento1922","type":"string"},"store_key":{"name":"store_key","description":"Set this parameter if bridge is already uploaded to store","example":"ab37fc230bc5df63a5be1b11220949be","type":"string"},"label":{"name":"label","description":"Defines alternative text that has to be attached to the picture","example":"This cool image","type":"string"},"custom_label":{"name":"custom_label","description":"Defines a custom label for the store in the app","example":"This is test store","type":"string"},"validate_version":{"name":"validate_version","description":"Specify if api2cart should validate cart version","example":true,"type":"boolean","default":false},"verify":{"name":"verify","description":"Enables or disables cart's verification","example":false,"type":"boolean","default":true},"db_tables_prefix":{"name":"db_tables_prefix","description":"DB tables prefix","example":"oc_","type":"string"},"user_agent":{"name":"user_agent","description":"This parameter allows you to set your custom user agent, which will be used in requests to the store. Please use it cautiously, as the store's firewall may block specific values.","example":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0","type":"string"},"ftp_host":{"name":"ftp_host","description":"FTP connection host","example":"ftp.mystore.com","type":"string"},"ftp_user":{"name":"ftp_user","description":"FTP User","example":"user","type":"string"},"ftp_password":{"name":"ftp_password","description":"FTP Password","example":"G4}q215D4_H9$Be","type":"string"},"ftp_port":{"name":"ftp_port","description":"FTP Port","example":22,"type":"integer"},"ftp_store_dir":{"name":"ftp_store_dir","description":"FTP Store dir","example":"/public","type":"string"},"3dcart_private_key":{"name":"3dcart_private_key","description":"3DCart Private Key","example":"7dba81f90bdbe25e7000e73214ca51b","type":"string"},"3dcart_access_token":{"name":"3dcart_access_token","description":"3DCart Token","example":"4Grr_ZCLNNoSUuhAjesKuchxo9SL","type":"string"},"3dcartapi_api_key":{"name":"3dcartapi_api_key","description":"3DCart API Key","example":"82cc921c6a5c67082cc921c6a5c6707e1d6e6862ba3201a","type":"string"},"amazon_sp_client_id":{"name":"amazon_sp_client_id","description":"Amazon SP API app client id","example":"amzn1.application-oa2-client.11e000e1f47d4998aca3733716d3b5a4","type":"string"},"amazon_sp_client_secret":{"name":"amazon_sp_client_secret","description":"Amazon SP API app client secret","example":"2c987428209f235443221255bde064f4bdf8a65165a80f5d22760a83cb","type":"string"},"amazon_sp_refresh_token":{"name":"amazon_sp_refresh_token","description":"Amazon SP API OAuth refresh token","example":"Atzr|IwEBIPUI-bwRTdDgKNQ_g56C30wGqymtx30c9MdDC7Emwmojhs20k5BBG2hHtJiGZ_7OfG7khd1RuQr6KEst4qyWbo_eXi5S_T_VOxzJUuksG1cFOGFpFK-cnhReNzAeZIpZeJT7_ROy1csEFlQfC8FJS3bsbSkkbTz2ZcTN7_7ey0HVlhyfFizgROeSeOI24Wjs9l_KKzZW0jvi_oC2cxlIcyknnHLK6KMNz2rTXqQJWRtlK9xPJDdbcUa5STA8MQru91cxNBpSkZN_cq9OOELhbsIGKD75y7nZ3yJU4uHQC_9iBQQoFm0biKgi-kEQwOhwws8","type":"string"},"amazon_sp_aws_region":{"name":"amazon_sp_aws_region","description":"Amazon AWS Region","example":"us-east-1","type":"string"},"amazon_sp_api_environment":{"name":"amazon_sp_api_environment","description":"Amazon SP API environment","example":"sandbox","type":"string","default":"production"},"amazon_seller_id":{"name":"amazon_seller_id","description":"Amazon Seller ID (Merchant token)","example":"13P636B2M1N4WR","type":"string"},"aspdotnetstorefront_api_user":{"name":"aspdotnetstorefront_api_user","description":"It's a AspDotNetStorefront account for which API is available","example":"admin","type":"string"},"aspdotnetstorefront_api_pass":{"name":"aspdotnetstorefront_api_pass","description":"AspDotNetStorefront API Password","example":"f6471ef78f72b41849a8b8b67791b0b5","type":"string"},"americommerce_app_id":{"name":"americommerce_app_id","description":"Americommerce App ID","example":"1","type":"string"},"americommerce_app_secret":{"name":"americommerce_app_secret","description":"Americommerce App Secret","example":"9fd3d282d65a007a2b9d541b5e0e410b2cecd6199632db53503b93637b8a6000","type":"string"},"americommerce_access_token":{"name":"americommerce_access_token","description":"Americommerce Access Token","example":"1e721f59b610e2666caea03094600765","type":"string"},"americommerce_refresh_token":{"name":"americommerce_refresh_token","description":"Americommerce Refresh Token","example":"520c011444af41d916543cdda859a5114","type":"string"},"bigcommerceapi_admin_account":{"name":"bigcommerceapi_admin_account","description":"It's a BigCommerce account for which API is enabled","example":"admin","type":"string"},"bigcommerceapi_api_path":{"name":"bigcommerceapi_api_path","description":"BigCommerce API URL","example":"http://mystore.bigcommerce.com/api/v1","type":"string"},"bigcommerceapi_api_key":{"name":"bigcommerceapi_api_key","description":"Bigcommerce API Key","example":"6b89704cd75738cb0f9f6468d5462aba","type":"string"},"bigcommerceapi_client_id":{"name":"bigcommerceapi_client_id","description":"Client ID of the requesting app","example":"p1r37bt131z86675nofv9xmhietoe4t","type":"string"},"bigcommerceapi_access_token":{"name":"bigcommerceapi_access_token","description":"Access token authorizing the app to access resources on behalf of a user","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"bigcommerceapi_context":{"name":"bigcommerceapi_context","description":"API Path section unique to the store","example":"stores/etplnf8o8v","type":"string"},"bol_api_key":{"name":"bol_api_key","description":"Bol API Key","example":"51369628-feee-11ed-be56-0242ac120002","type":"string"},"bol_api_secret":{"name":"bol_api_secret","description":"Bol API Secret","example":"8fGzEsbEP5z2MNZubmIil87m-sWzTkj?KDQKrmzmU!fA6aAUNMdKRp7LMWHwE!G37UMfnWByHBGSXJHkAG?QcuYTO2uklv4idIHwUMLHK!OO1yfRlWh!","type":"string"},"bol_retailer_id":{"name":"bol_retailer_id","description":"Bol Retailer ID","example":"145001","type":"integer"},"bigcartel_user_name":{"name":"bigcartel_user_name","description":"Subdomain of store","example":"subdomain","type":"string"},"bigcartel_password":{"name":"bigcartel_password","description":"BigCartel account password","example":"4GrrZCLNNoSUuhAjesKuchxo9SL","type":"string"},"bricklink_consumer_key":{"name":"bricklink_consumer_key","description":"Bricklink Consumer Key","example":"26F6CDA087D9444EAA71AC09E7A1D39A","type":"string"},"bricklink_consumer_secret":{"name":"bricklink_consumer_secret","description":"Bricklink Consumer Secret","example":"a46abc3kxyinlbggy06i9g975xqo6gjq","type":"string"},"bricklink_token":{"name":"bricklink_token","description":"Bricklink Access Token","example":"ktv4n9rgrj0evjuy2t6p2xlb1f8u5pmy","type":"string"},"bricklink_token_secret":{"name":"bricklink_token_secret","description":"Bricklink Access Token Secret","example":"a46abc3kxyinlbggy06i9g975xqo6gjq","type":"string"},"nopcommerce_token":{"name":"nopcommerce_token","description":"Access token authorizing the app to access resources on behalf of a user","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"demandware_client_id":{"name":"demandware_client_id","description":"Demandware client id","example":"b849eb85-v8b9-1dw8-9fe2-97e1d6ffc7b0","type":"string"},"demandware_api_password":{"name":"demandware_api_password","description":"Demandware api password","example":"testpassword","type":"string"},"demandware_user_name":{"name":"demandware_user_name","description":"Demandware user name","example":"admin","type":"string"},"demandware_user_password":{"name":"demandware_user_password","description":"Demandware user password","example":"12345","type":"string"},"ebay_client_id":{"name":"ebay_client_id","description":"Application ID (AppID).","example":"a9psel85v1wy5faeyjw03y0r","type":"string"},"ebay_client_secret":{"name":"ebay_client_secret","description":"Shared Secret from eBay application","example":"gmz3iz45x2","type":"string"},"ebay_runame":{"name":"ebay_runame","description":"The RuName value that eBay assigns to your application.","example":"gmz3iz45x2","type":"string"},"ebay_access_token":{"name":"ebay_access_token","description":"Used to authenticate API requests.","example":"v^1.1#i ... AjRV4yNjA=","type":"string"},"ebay_refresh_token":{"name":"ebay_refresh_token","description":"Used to renew the access token.","example":"v^1.1#i ... rAewqVasdA=","type":"string"},"ebay_environment":{"name":"ebay_environment","description":"eBay environment","example":"sandbox","type":"string","default":"production"},"ebay_site_id":{"name":"ebay_site_id","description":"eBay global ID","example":"101","type":"integer","default":0},"walmart_client_id":{"name":"walmart_client_id","description":"Walmart client ID. For the region 'ca' use Consumer ID","example":"423f6A24-123z-8654-989u-6fa96478289","type":"string"},"walmart_client_secret":{"name":"walmart_client_secret","description":"Walmart client secret. For the region 'ca' use Private Key","example":"1gf85fea-8974-2648-w12w-rt54284tdf54","type":"string"},"walmart_environment":{"name":"walmart_environment","description":"Walmart environment","example":"production","type":"string","default":"production"},"walmart_channel_type":{"name":"walmart_channel_type","description":"Walmart WM_CONSUMER.CHANNEL.TYPE header","example":"0f3e4dd4-0514-4346-b39d-af0e00ea066d","type":"string"},"walmart_region":{"name":"walmart_region","description":"Walmart region","example":"us","type":"string","default":"us"},"ecwid_acess_token":{"name":"ecwid_acess_token","description":"Access token authorizing the app to access resources on behalf of a user","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"ecwid_store_id":{"name":"ecwid_store_id","description":"Store Id","example":"1","type":"string"},"lazada_app_id":{"name":"lazada_app_id","description":"Lazada App ID","example":"112577","type":"string"},"lazada_app_secret":{"name":"lazada_app_secret","description":"Lazada App Secret","example":"er33raICJ79Q5b0EsR9stmRnjE9XQ2WH","type":"string"},"lazada_refresh_token":{"name":"lazada_refresh_token","description":"Lazada Refresh Token","example":"EAAPP06rM2n8BO4mZBuMPnu9zS0MaMbN7ue8aUkcxw4zewU337mVVb5br","type":"string"},"lazada_region":{"name":"lazada_region","description":"Lazada API endpoint Region","example":"Malaysia","type":"string"},"lightspeed_api_key":{"name":"lightspeed_api_key","description":"LightSpeed api key","example":"cf5444729c2abd6b6a5d983691767cb5","type":"string"},"lightspeed_api_secret":{"name":"lightspeed_api_secret","description":"LightSpeed api secret","example":"2620ee52a8bc942f9d5d3a575f4d363e","type":"string"},"etsy_keystring":{"name":"etsy_keystring","description":"Etsy keystring","example":"a9psel85v1wy5faeyjw03y0r","type":"string"},"etsy_shared_secret":{"name":"etsy_shared_secret","description":"Etsy shared secret","example":"gmz3iz45x2","type":"string"},"etsy_access_token":{"name":"etsy_access_token","description":"Access token authorizing the app to access resources on behalf of a user","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"etsy_token_secret":{"name":"etsy_token_secret","description":"Secret token authorizing the app to access resources on behalf of a user","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"etsy_client_id":{"name":"etsy_client_id","description":"Etsy Client Id","example":"w0fi0igk2w29bjcd7ydr2s35","type":"string"},"etsy_refresh_token":{"name":"etsy_refresh_token","description":"Etsy Refresh token","example":"223577551.L07_RE-y7unmKf2dox4djsHkVxwpUfs1ikG_uQmHhF-aASEReNn_Qns1Wqn3dDa0ZMxrt9CIael3dgudeDZb31ZUdS","type":"string"},"facebook_app_id":{"name":"facebook_app_id","description":"Facebook App ID","example":"6516912365277570","type":"string"},"facebook_app_secret":{"name":"facebook_app_secret","description":"Facebook App Secret","example":"737cf6bd2879cb6c7e5a8ff9cd63f3d46b0b5b7b","type":"string"},"facebook_access_token":{"name":"facebook_access_token","description":"Facebook Access Token","example":"EAAPP06rM2n8BO4mZBuMPnu9zS0MaMbN7ue8aUAhqbS58clzJwyp1rYRMpP31QJGziqtYbKypdVx3Cs0RpuufoUeLsbfX195XIB8VTlkcxw4zewU337mVVb5br","type":"string"},"facebook_business_id":{"name":"facebook_business_id","description":"Facebook Business ID","example":"294042786906655","type":"string"},"neto_api_key":{"name":"neto_api_key","description":"Neto API Key","example":"bbca57d8ff3c3677128112c15556d9e3","type":"string"},"neto_api_username":{"name":"neto_api_username","description":"Neto User Name","example":"mylogin","type":"string"},"shopline_access_token":{"name":"shopline_access_token","description":"Shopline APP Key","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"shopline_app_key":{"name":"shopline_app_key","description":"Shopline APP Key","example":"737cf6bd2879cb6c7e5a8ff9cd63f3d46b0b5b7b","type":"string"},"shopline_app_secret":{"name":"shopline_app_secret","description":"Shopline App Secret","example":"1701d123bb5cc14cd2732dcaed90638316c0a09","type":"string"},"shopline_shared_secret":{"name":"shopline_shared_secret","description":"Shopline Shared Secret","example":"1701d123bb5cc14cd2732dcaed90638316c0a09","type":"string"},"shopify_access_token":{"name":"shopify_access_token","description":"Access token authorizing the app to access resources on behalf of a user","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"shopify_client_id":{"name":"shopify_client_id","description":"Shopify Client ID","example":"b5defe55db3f6836fb4e0e6624ff9577","type":"string"},"shopify_api_key":{"name":"shopify_api_key","description":"Shopify API Key","example":"bbca57d8ff3c3677128112c15556d9e3","type":"string"},"shopify_api_password":{"name":"shopify_api_password","description":"Shopify API Password","example":"860f3a6fc87632301a42cd88e4b5ab3d","type":"string"},"shopify_shared_secret":{"name":"shopify_shared_secret","description":"Shared secret","example":"gmz3iz45x2","type":"string"},"shopee_partner_id":{"name":"shopee_partner_id","description":"Shopee Partner ID","example":"1276777","type":"string"},"shopee_partner_key":{"name":"shopee_partner_key","description":"Shopee Partner Key","example":"6a46494b4d746576554646626775617a577542774850636375464d6a736d5598","type":"string"},"shopee_shop_id":{"name":"shopee_shop_id","description":"Shopee SHOP ID","example":"137968","type":"string"},"shopee_refresh_token":{"name":"shopee_refresh_token","description":"Shopee Refresh Token","example":"EAAPP06rM2n8BO4mZBuMPnu9zS0MaMbN7ue8aUkcxw4zewU987mVVb5br","type":"string"},"shopee_region":{"name":"shopee_region","description":"Shopee API endpoint Region. Use for Chinese Mainland or Brazil.","example":"CN","type":"string"},"shopee_environment":{"name":"shopee_environment","description":"Shopee Environment","example":"sandbox","type":"string","default":"production"},"shoplazza_access_token":{"name":"shoplazza_access_token","description":"Access token authorizing the app to access resources on behalf of a user","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"shoplazza_shared_secret":{"name":"shoplazza_shared_secret","description":"Shared secret","example":"gmz3iz45x2","type":"string"},"shopware_access_key":{"name":"shopware_access_key","description":"Shopware access key","example":"SWSCS3O1RJBSRNBYQLFIYJN2ZQ","type":"string"},"unas_api_key":{"name":"unas_api_key","description":"UNAS API Key","example":"c238908e29ceb6e6ad3df15f89a6234709d3f000","type":"string"},"shopware_api_key":{"name":"shopware_api_key","description":"Shopware api key","example":"SWSCS3O1RJBSRNBYQLFIYJN2ZQ","type":"string"},"shopware_api_secret":{"name":"shopware_api_secret","description":"Shopware client secret access key","example":"V3NYNWg2b1dZdHBUWDN1cmdKdGhnenp5enVJYlJ0WlJvOFF2bnQ","type":"string"},"miva_access_token":{"name":"miva_access_token","description":"Miva access token","example":"227cbe434a1e358d72db0de993x9d9fd","type":"string"},"miva_signature":{"name":"miva_signature","description":"Miva signature","example":"1hpkrebfdsObGTor/0Gk9XcNBUQohrxrw67Sg9AM9ps=","type":"string"},"mirakl_api_key":{"name":"mirakl_api_key","description":"Mirakl API Key","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","type":"string"},"tiendanube_user_id":{"name":"tiendanube_user_id","description":"Tiendanube User ID","example":1234,"type":"integer"},"tiendanube_access_token":{"name":"tiendanube_access_token","description":"Tiendanube Access Token","example":"75bde7bb0b437475423e7e87c142c06052f80199","type":"string"},"tiendanube_client_secret":{"name":"tiendanube_client_secret","description":"Tiendanube Client Secret","example":"5e3588f514a5ae0d0fa063d1b556531e25c83fa7e47472ed","type":"string"},"volusion_login":{"name":"volusion_login","description":"It's a Volusion account for which API is enabled","example":"admin","type":"string"},"volusion_password":{"name":"volusion_password","description":"Volusion API Password","example":"7943CA5F3990E00D9A4CCF0BD998211F","type":"string"},"hybris_client_id":{"name":"hybris_client_id","description":"Omni Commerce Connector Client ID","example":"api_client_1","type":"string"},"hybris_client_secret":{"name":"hybris_client_secret","description":"Omni Commerce Connector Client Secret","example":"secret_phrase_1","type":"string"},"hybris_username":{"name":"hybris_username","description":"User Name","example":"admin","type":"string"},"hybris_password":{"name":"hybris_password","description":"User password","example":"nimda","type":"string"},"hybris_websites":{"type":"array","minItems":1,"items":{"type":"object","properties":{"uid":{"type":"string"},"url":{"type":"string"},"storeIds":{"type":"array","minItems":1,"items":{"type":"string"}}},"required":["uid","url","storeIds"]},"description":"Websites to stores mapping data"},"square_client_id":{"name":"square_client_id","description":"Square (Weebly) Client ID","example":"sq0idp-qwer_1pvuTYe9cAf1lmxyQ","type":"string"},"square_client_secret":{"name":"square_client_secret","description":"Square (Weebly) Client Secret","example":"c8d7077fce7b2b111111111898170695a01473a2ad","type":"string"},"square_refresh_token":{"name":"square_refresh_token","description":"Square (Weebly) Refresh Token","example":"EQAAlquVXMr6xIcPu7qPkIEAZ0thqChhQuowrvZIqOlwhOwhtmyh4ZRfesdRc434","type":"string"},"squarespace_api_key":{"name":"squarespace_api_key","description":"Squarespace API Key","example":"8f7849d5-1411-47f2-9722-aa81c2a48d95","type":"string"},"squarespace_client_id":{"name":"squarespace_client_id","description":"Squarespace Connector Client ID","example":"9UGbUtS2V96BxRGmfOjsGAhTdsr9Vxxx","type":"string"},"squarespace_client_secret":{"name":"squarespace_client_secret","description":"Squarespace Connector Client Secret","example":"GPZkUFkIKWg0KLE6rajsFMMYA9ma0udaaq2bYwBDXXX=","type":"string"},"squarespace_access_token":{"name":"squarespace_access_token","description":"Squarespace access token","example":"SWSCS3O1RJBSRNBYQLFIYJN2ZQ","type":"string"},"squarespace_refresh_token":{"name":"squarespace_refresh_token","description":"Squarespace refresh token","example":"def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d","type":"string"},"commercehq_api_key":{"name":"commercehq_api_key","description":"CommerceHQ api key","example":"sJrD-LM0eddhe63rfgfva0dDydXfre4","type":"string"},"commercehq_api_password":{"name":"commercehq_api_password","description":"CommerceHQ api password","example":"4Grr_ZCLNNoSUuhAjesKuchxo9SL","type":"string"},"wc_consumer_key":{"name":"wc_consumer_key","description":"Woocommerce consumer key","example":"ck_26d8e2ad604f3917e429df6961722282bdcf109d","type":"string"},"wc_consumer_secret":{"name":"wc_consumer_secret","description":"Woocommerce consumer secret","example":"cs_931ced666118a15c5f7b4a33a15gf5589cbeba55","type":"string"},"magento_consumer_key":{"name":"magento_consumer_key","description":"Magento Consumer Key","example":"ktv4n9rgrj0evjuy2t6p2xlb1f8u5pmy","type":"string"},"magento_consumer_secret":{"name":"magento_consumer_secret","description":"Magento Consumer Secret","example":"a46abc3kxyinlbggy06i9g975xqo6gjq","type":"string"},"magento_access_token":{"name":"magento_access_token","description":"Magento Access Token","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"magento_token_secret":{"name":"magento_token_secret","description":"Magento Token Secret","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"prestashop_webservice_key":{"name":"prestashop_webservice_key","description":"Prestashop webservice key","example":"CKJ1ZEWRJWRLTPVBQJ9FGGRORD4AGS96","type":"string"},"wix_app_id":{"name":"wix_app_id","description":"Wix App ID","example":"6b0b5b7b-7d87-45b5-bf34-ac6b438e63da","type":"string"},"wix_app_secret_key":{"name":"wix_app_secret_key","description":"Wix App Secret Key","example":"316c0a09-f195-42be-74f6-a02cebb9cae6","type":"string"},"wix_instance_id":{"name":"wix_instance_id","description":"Wix Instance ID","example":"58b893a4-6b16-5c2f-qt78-qa3r61t32rt8","type":"string"},"wix_refresh_token":{"name":"wix_refresh_token","description":"Wix refresh token","example":"\n OAUTH2.eyJraWQiOiJkZ0x3cjNRMCIsImFsZyI6IkhTMjU2In0.\n eyJkYXRhIjoie1wiaWRcIjpcImJlZjM3MmRmLTUyNGItNDI3NS05M2RkL\n Tg4NDBlOTU3ZWU2OFwifSIsImlhdCI6MTY0ODA0NTEyNiwiZXhwIjoxNzExMTE3MTI2fQ.\n VRR2lGSbcTVmaArtmyyhy6o4WRDwTn-nlDCQpZ97eYw\n ","type":"string"},"mercado_libre_app_id":{"name":"mercado_libre_app_id","description":"Mercado Libre App ID","example":"211188015100135","type":"string"},"mercado_libre_app_secret_key":{"name":"mercado_libre_app_secret_key","description":"Mercado Libre App Secret Key","example":"e2qoG2zklLlfP7cEngEJ94YjhkejkjAm","type":"string"},"mercado_libre_refresh_token":{"name":"mercado_libre_refresh_token","description":"Mercado Libre Refresh Token","example":"TG-63h13529vb5464110188d2x9-703754376","type":"string"},"zid_client_id":{"name":"zid_client_id","description":"Zid Client ID","example":1234,"type":"integer"},"zid_client_secret":{"name":"zid_client_secret","description":"Zid Client Secret","example":"nl5l1lE0vxgv6cV111fHsdlOOIfb0Ms5IR7l4Igs","type":"string"},"zid_access_token":{"name":"zid_access_token","description":"Zid Access Token","example":"def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d","type":"string"},"zid_authorization":{"name":"zid_authorization","description":"Zid Authorization","example":"def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d","type":"string"},"zid_refresh_token":{"name":"zid_refresh_token","description":"Zid refresh token","example":"def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d","type":"string"},"jumpseller_client_id":{"name":"jumpseller_client_id","description":"Jumpseller OAuth2 Client ID","example":"your_client_id","type":"string"},"jumpseller_client_secret":{"name":"jumpseller_client_secret","description":"Jumpseller OAuth2 Client Secret","example":"your_client_secret","type":"string"},"jumpseller_refresh_token":{"name":"jumpseller_refresh_token","description":"Jumpseller OAuth2 refresh token","example":"your_oauth_refresh_token","type":"string"},"jumpseller_login":{"name":"jumpseller_login","description":"Jumpseller API login","example":"your_login","type":"string"},"jumpseller_authtoken":{"name":"jumpseller_authtoken","description":"Jumpseller API auth token","example":"your_auth_token","type":"string"},"flipkart_client_id":{"name":"flipkart_client_id","description":"Flipkart Client ID","example":"19414773883a13a850b6a52350b7246499a24","type":"string"},"flipkart_client_secret":{"name":"flipkart_client_secret","description":"Flipkart Client Secret","example":"nl5l1lE0vxgv6cV111fHsdlOOIfb0Ms5IR7l4Igs","type":"string"},"allegro_client_id":{"name":"allegro_client_id","description":"Allegro Client ID","example":"2915e189ce3d23d23d2327d204ae6a0bd","type":"string"},"allegro_client_secret":{"name":"allegro_client_secret","description":"Allegro Client Secret","example":"DNHtqdL2WPIefeUhQWYgtXPS23fgbfgasdsGHHJGhg3RTFDQWFGZmVoFRT5IfkQj1E7eR5","type":"string"},"allegro_access_token":{"name":"allegro_access_token","description":"Allegro Access Token","example":"eyJhbGciOiJSUzI1NiIsInR5cCI6IsfddfdfdeyJ1c2VyX25hbWUiOiI5NDUxMzE1MSIsInNjb3BlIjpbImFsbGVncm86YXBpOm9yZGVyczpyZWFkIiwiYWxsZWdybzphcGk6cHJvZmlsZTp3cml0ZSIsImFsbGVncm86YXBpOnNhbGU6b2ZmZXJzOndyaXRlIiwiYWxsZWdybzphcGk6YmlsbGluZzpyZWFkIiwiYWxsZWdybzphcGk6Y2FtcGFpZ25zIiwiYWxsZWdybzphcGk6ZGlzcHV0ZXMiLCJhbGxlZ3JvOmFwaTpzYWxlOm9mZmVyczpyZWFkIiwiYWxsZWdybzphcGk6YmlkcyIsImFsbGVncm86YXBpOm9yZGVyczp3cml0ZSIsImFsbGVncm86YXBpOnBheW1lbnRzOndyaXRlIiwiYWxsZWdybzphcGk6c2FsZTpzZXR0aW5nczp3cml0ZSIsImFsbGVncm86YXBpOnByb2ZpbGU6cmVhZCIsImFsbGVncm86YXBpOnJhdGluZ3MiLCJhbGxlZ3JvOmFwaTpzYWxlOnNldHRpbmdzOnJlYWQiLCJhbGxlZ3JvOmFwaTpwYXltZW50czpyZWFkIiwiYWxsZWdybzphcGk6bWVzc2FnaW5nIl0sI","type":"string"},"allegro_refresh_token":{"name":"allegro_refresh_token","description":"Allegro Refresh Token","example":"eyJhbGciOiJSUzI1NiIsInR5cCI6IsfddfdfdeyJ1c2VyX25hbWUiOiI5NDUxMzE1MSIsInNjb3BlIjpbImFsbGVncm86YXBpOm9yZGVyczpyZWFkIiwiYWxsZWdybzphcGk6cHJvZmlsZTp3cml0ZSIsImFsbGVncm86YXBpOnNhbGU6b2ZmZXJzOndyaXRlIiwiYWxsZWdybzphcGk6YmlsbGluZzpyZWFkIiwiYWxsZWdybzphcGk6Y2FtcGFpZ25zIiwiYWxsZWdybzphcGk6ZGlzcHV0ZXMiLCJhbGxlZ3JvOmFwaTpzYWxlOm9mZmVyczpyZWFkIiwiYWxsZWdybzphcGk6YmlkcyIsImFsbGVncm86YXBpOm9yZGVyczp3cml0ZSIsImFsbGVncm86YXBpOnBheW1lbnRzOndyaXRlIiwiYWxsZWdybzphcGk6c2FsZTpzZXR0aW5nczp3cml0ZSIsImFsbGVncm86YXBpOnByb2ZpbGU6cmVhZCIsImFsbGVncm86YXBpOnJhdGluZ3MiLCJhbGxlZ3JvOmFwaTpzYWxlOnNldHRpbmdzOnJlYWQiLCJhbGxlZ3JvOmFwaTpwYXltZW50czpyZWFkIiwiYWxsZWdybzphcGk6bWVzc2FnaW5nIl0sI","type":"string"},"allegro_environment":{"name":"allegro_environment","description":"Allegro Environment","example":"sandbox","type":"string","default":"production"},"zoho_client_id":{"name":"zoho_client_id","description":"Zoho Client ID","example":"1000.FLCHGI2LS1111111TOR4OGB697W4IX","type":"string"},"zoho_client_secret":{"name":"zoho_client_secret","description":"Zoho Client Secret","example":"c8d7077fce7b2b111111111898170695a01473a2ad","type":"string"},"zoho_refresh_token":{"name":"zoho_refresh_token","description":"Zoho Refresh Token","example":"1000.11111111111111111111111111111111.1b3ca6f054341a111118abf928beb33b","type":"string"},"zoho_region":{"name":"zoho_region","description":"Zoho API endpoint Region","example":"Europe","type":"string"},"otto_client_id":{"name":"otto_client_id","description":"Otto Client ID","example":"911a3dbf-d261-4763-cc81-052876465b55","type":"string"},"otto_client_secret":{"name":"otto_client_secret","description":"Otto Client Secret","example":"9887a82a-2879-421e-a6wc-54e986b3458c","type":"string"},"otto_app_id":{"name":"otto_app_id","description":"Otto App ID","example":"6eaef6a3-822e-425b-8mc9-53750063e34d","type":"string"},"otto_refresh_token":{"name":"otto_refresh_token","description":"Otto Refresh Token","example":"eyJhbGciOiJSUzI1NiIsInR5cCI6IsfddfdfdeyJ1c2VyX25hbWUiOiI5NDUxMzE1MSIsInNjb3BlIjpbImFsbGVncm86YXBpOm9yZGVyczpyZWFkIiwiYWxsZWdybzphcGk6cHJvZmlsZTp3cml0ZSIsImFsbGVncm86YXBpOnNhbGU6b2ZmZXJzOndyaXRlIiwiYWxsZWdybzphcGk6YmlsbGluZzpyZWFkIiwiYWxsZWdybzphcGk6Y2FtcGFpZ25zIiwiYWxsZWdybzphcGk6ZGlzcHV0ZXMiLCJhbGxlZ3JvOmFwaTpzYWxlOm9mZmVyczpyZWFkIiwiYWxsZWdybzphcGk6YmlkcyIsImFsbGVncm86YXBpOm9yZGVyczp3cml0ZSIsImFsbGVncm86YXBpOnBheW1lbnRzOndyaXRlIiwiYWxsZWdybzphcGk6c2FsZTpzZXR0aW5nczp3cml0ZSIsImFsbGVncm86YXBpOnByb2ZpbGU6cmVhZCIsImFsbGVncm86YXBpOnJhdGluZ3MiLCJhbGxlZ3JvOmFwaTpzYWxlOnNldHRpbmdzOnJlYWQiLCJhbGxlZ3JvOmFwaTpwYXltZW50czpyZWFkIiwiYWxsZWdybzphcGk6bWVzc2FnaW5nIl0sI","type":"string"},"otto_environment":{"name":"otto_environment","description":"Otto Environment","example":"sandbox","type":"string","default":"production"},"otto_access_token":{"name":"otto_access_token","description":"Otto Access Token","example":"eyJhbGciOiJS34535f45f54f5656deyJ1c2VyX25hbWUiOiI5NDUxMzE1MSIsInNjb3BlIjpbImFsbGVncm86YXBpOm9yZGVyczpyZWFkIiwiYWxsZWdybzphcGk6cHJvZmlsZTp3cml0ZSIsImFsbGVncm86YXBpOnNhbGU6b2ZmZXJzOndyaXRlIiwiYWxsZWdybzphcGk6YmlsbGluZzpyZWFkIiwiYWxsZWdybzphcGk6Y2FtcGFpZ25zIiwiYWxsZWdybzphcGk6ZGlzcHV0ZXMiLCJhbGxlZ3JvOmFwaTpzYWxlOm9mZmVyczpyZWFkIiwiYWxsZWdybzphcGk6YmlkcyIsImFsbGVncm86YXBpOm9yZGVyczp3cml0ZSIsImFsbGVncm86YXBpOnBheW1lbnRzOndyaXRlIiwiYWxsZWdybzphcGk6c2FsZTpzZXR0aW5nczp3cml0ZSIsImFsbGVncm86YXBpOnByb2ZpbGU6cmVhZCIsImFsbGVncm86YXBpOnJhdGluZ3MiLCJhbGxlZ3JvOmFwaTpzYWxlOnNldHRpbmdzOnJlYWQiLCJhbGxlZ3JvOmFwaTpwYXltZW50czpyZWFkIiwiYWxsZWdybzphcGk6bWVzc2FnaW5nIl0sI","type":"string"},"tiktokshop_app_key":{"name":"tiktokshop_app_key","description":"TikTok Shop App Key","example":"6arbhkzno8nbv","type":"string"},"tiktokshop_app_secret":{"name":"tiktokshop_app_secret","description":"TikTok Shop App Secret","example":"d95820a05a0cd54fb394fcd26fgat63999b183bc","type":"string"},"tiktokshop_refresh_token":{"name":"tiktokshop_refresh_token","description":"TikTok Shop Refresh Token","example":"TTP_NTUxZTNhYTQ2ZDk2YmRmZWNmYWY2YWY12345NGYwNjQ3YjkzYTllYjA0YmNlMw","type":"string"},"tiktokshop_access_token":{"name":"tiktokshop_access_token","description":"TikTok Shop Access Token","example":"TTP_Fw8r12345kW03FYd09DG-9INtpw361hWthei12345iPJ5AUv99fLSCYD9-Uu12345TgNRzKZxi5-tfFMtdWqglEt5_iCk","type":"string"},"salla_client_id":{"name":"salla_client_id","description":"Salla Client ID","example":"1bxxxcf9-5xx4-xxx-bxxf-929b8xxxxe11","type":"string"},"salla_client_secret":{"name":"salla_client_secret","description":"Salla Client Secret","example":"8x88axxxc25e1fxxxa1c06fxxx150xx5","type":"string"},"salla_refresh_token":{"name":"salla_refresh_token","description":"Salla Refresh Token","example":"oxy_rt_zxxxxiY2xxZWWxxxxlU-tROxxxxx2JzS2fwzxxxxxkU.p3xxxkCIyFexxxxP50WwZYfhw5_wg1xxxxV5F-8xxXc","type":"string"},"salla_access_token":{"name":"salla_access_token","description":"Salla Access Token","example":"oxy_rt_zxxxxiY2xxZWWxxxxlU-tROxxxxx2JzS2fwzxxxxxkU.p3xxxkCIyFexxxxP50WwZYfhw5_wg1xxxxV5F-8xxXc","type":"string"},"temu_app_key":{"name":"temu_app_key","description":"Temu App Key","example":"4ebbc9190ae410443d65b4c2faca9811","type":"string"},"temu_app_secret":{"name":"temu_app_secret","description":"Temu App Secret","example":"4782d2d827276688bf4758bed55dbdd4bbe79a78","type":"string"},"temu_access_token":{"name":"temu_access_token","description":"Temu Access Token","example":"uplv3hfyt5kcwoymrgnajnbl1ow5qxlz4sqhev6hl3xosz5dejrtyl2jre6","type":"string"},"temu_region":{"name":"temu_region","description":"Temu API endpoint Region.","example":"US","type":"string"},"scapi_client_id":{"name":"scapi_client_id","description":"Salesforce Commerce API Client ID","example":"b941ec85-v6b2-1dw8-9fe2-98e1d6eec7b1","type":"string"},"scapi_client_secret":{"name":"scapi_client_secret","description":"Salesforce Commerce API Client Secret","example":"testpassword","type":"string"},"scapi_organization_id":{"name":"scapi_organization_id","description":"Salesforce Commerce Organization ID","example":"f_ecom_xxxx_001","type":"string"},"scapi_short_code":{"name":"scapi_short_code","description":"Salesforce Commerce Short Code","example":"zs5ksm25","type":"string"},"scapi_scopes":{"name":"scapi_scopes","description":"Salesforce Commerce API Scopes","example":"sfcc.catalogs,sfcc.orders,sfcc.products","type":"string"}},"required":["cart_id"]},"StoreAttribute":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":["string","null"]},"type":{"type":"string"},"name":{"type":"string"},"default_values":{"type":"array","items":{"type":"string"}},"position":{"type":["integer","null"]},"visible":{"type":["boolean","null"]},"required":{"type":["boolean","null"]},"system":{"type":["boolean","null"]},"values":{"type":"array","items":{"type":"string"}},"store_id":{"type":["string","null"]},"lang_id":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Attribute_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Attribute_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Pagination":{"type":"object","properties":{"previous":{"type":["string","null"]},"next":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Attribute_List_Result":{"type":"object","properties":{"attributes_count":{"type":["integer","null"]},"attribute":{"type":"array","items":{"$ref":"#/components/schemas/StoreAttribute"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Attribute_Attributeset_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Attribute_Attributeset_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Attribute_Attributeset_List_Result":{"type":"object","properties":{"attribute_set":{"type":"array","items":{"$ref":"#/components/schemas/StoreAttribute_AttributeSet"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"StoreAttribute_AttributeSet":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"assigned_attribute_ids":{"type":"array","items":{"type":"string"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Attribute_Group_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Attribute_Group_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Attribute_Group_List_Result":{"type":"object","properties":{"group":{"type":"array","items":{"$ref":"#/components/schemas/StoreAttribute_Group"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"StoreAttribute_Group":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"position":{"type":["integer","null"]},"attribute_set_id":{"type":["string","null"]},"assigned_attribute_ids":{"type":"array","items":{"type":"string"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Basket":{"type":"object","properties":{"id":{"type":"string"},"customer":{"$ref":"#/components/schemas/BaseCustomer"},"basket_url":{"type":["string","null"]},"created_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"currency":{"$ref":"#/components/schemas/Currency"},"basket_products":{"type":"array","items":{"$ref":"#/components/schemas/Basket_Item"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"BaseCustomer":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"first_name":{"type":["string","null"]},"last_name":{"type":["string","null"]},"phone":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Currency":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"iso3":{"type":"string"},"symbol_left":{"type":"string"},"symbol_right":{"type":["string","null"]},"rate":{"type":["number","null"]},"avail":{"type":["boolean","null"]},"default":{"type":["boolean","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Basket_Item":{"type":"object","properties":{"id":{"type":["string","null"]},"parent_id":{"type":["string","null"]},"product_id":{"type":"string"},"variant_id":{"type":["string","null"]},"sku":{"type":["string","null"]},"name":{"type":"string"},"price":{"type":"number"},"tax":{"type":["number","null"]},"quantity":{"type":["number","null"]},"weight_unit":{"type":["string","null"]},"weight":{"type":["number","null"]},"options":{"type":"array","items":{"$ref":"#/components/schemas/Basket_Item_Option"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Basket_Item_Option":{"type":"object","properties":{"id":{"type":["string","null"]},"value_id":{"type":["string","null"]},"name":{"type":["string","null"]},"value":{"type":["string","null"]},"used_in_combination":{"type":["boolean","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Basket_LiveShippingService":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"callback":{"type":"string"},"callback_err_cnt":{"type":["integer","null"]},"enabled_on_store":{"type":["boolean","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Batch_Job_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Batch_Job_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Batch_Job_List_Result":{"type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/Batch_Job"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Batch_Job":{"type":"object","properties":{"id":{"type":"string"},"method":{"type":"string"},"status":{"type":"string"},"created_time":{"$ref":"#/components/schemas/A2CDateTime"},"processed_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Batch_Job_Result":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"result":{"anyOf":[{"$ref":"#/components/schemas/Batch_Job_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Batch_Job_Result":{"type":"object","properties":{"job_id":{"type":"integer"},"job_name":{"type":"string"},"items_processed":{"type":"integer"},"items_succeed":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Batch_Job_Result_Item"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Batch_Job_Result_Item":{"type":"object","properties":{"id":{"type":"integer"},"status":{"type":"string"},"entity_id":{"type":["string","null"]},"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Cart":{"type":"object","properties":{"name":{"type":["string","null"]},"url":{"type":["string","null"]},"version":{"type":["string","null"]},"bridge_version":{"type":["string","null"]},"default_rounding_precision":{"type":["integer","null"]},"db_prefix":{"type":["string","null"]},"stores_info":{"type":"array","items":{"$ref":"#/components/schemas/Cart_StoreInfo"}},"warehouses":{"type":"array","items":{"$ref":"#/components/schemas/Cart_Warehouse"}},"shipping_zones":{"type":"array","items":{"$ref":"#/components/schemas/Cart_ShippingZone"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Cart_StoreInfo":{"type":"object","properties":{"store_id":{"type":"string"},"name":{"type":["string","null"]},"language":{"type":["string","null"]},"store_languages":{"type":"array","items":{"$ref":"#/components/schemas/Language"}},"currency":{"$ref":"#/components/schemas/Currency"},"store_currencies":{"type":"array","items":{"$ref":"#/components/schemas/Currency"}},"timezone":{"type":["string","null"]},"country":{"type":["string","null"]},"root_category_id":{"type":["string","null"]},"multi_store_url":{"type":["string","null"]},"active":{"type":["boolean","null"]},"weight_unit":{"type":["string","null"]},"dimension_unit":{"type":["string","null"]},"prices_include_tax":{"type":["boolean","null"]},"carrier_info":{"type":"array","items":{"$ref":"#/components/schemas/Carrier"}},"store_owner_info":{"anyOf":[{"$ref":"#/components/schemas/Info"},{"type":"null"}]},"default_warehouse_id":{"type":["string","null"]},"channels":{"type":"array","items":{"$ref":"#/components/schemas/Cart_Channel"}},"pickup_locations":{"type":"array","items":{"$ref":"#/components/schemas/Cart_PickupLocation"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Language":{"type":"object","properties":{"id":{"type":"string"},"iso_code":{"type":"string"},"name":{"type":"string"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Carrier":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"shipping_methods":{"type":"array","items":{"$ref":"#/components/schemas/Order_ShippingMethod"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_ShippingMethod":{"type":"object","properties":{"name":{"type":"string"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Info":{"type":"object","properties":{"owner":{"type":["string","null"]},"country":{"type":["string","null"]},"state":{"type":["string","null"]},"state_code":{"type":["string","null"]},"city":{"type":["string","null"]},"street_address":{"type":["string","null"]},"street_address_line_2":{"type":["string","null"]},"zip_code":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Cart_Channel":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"platform":{"type":["string","null"]},"is_enabled":{"type":["boolean","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Cart_PickupLocation":{"type":"object","properties":{"id":{"type":["string","null"]},"name":{"type":["string","null"]},"avail":{"type":["boolean","null"]},"address":{"anyOf":[{"$ref":"#/components/schemas/Customer_Address"},{"type":"null"}]},"pickup_instructions":{"type":["string","null"]},"expected_ready_time":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Customer_Address":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"first_name":{"type":["string","null"]},"last_name":{"type":["string","null"]},"postcode":{"type":"string"},"address1":{"type":"string"},"address2":{"type":["string","null"]},"phone":{"type":["string","null"]},"phone_mobile":{"type":["string","null"]},"city":{"type":"string"},"country":{"$ref":"#/components/schemas/Country"},"state":{"anyOf":[{"$ref":"#/components/schemas/State"},{"type":"null"}]},"company":{"type":["string","null"]},"fax":{"type":["string","null"]},"website":{"type":["string","null"]},"gender":{"type":["string","null"]},"region":{"type":["string","null"]},"default":{"type":"boolean"},"tax_id":{"type":["string","null"]},"identification_number":{"type":["string","null"]},"alias":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Country":{"type":"object","properties":{"code2":{"type":"string"},"code3":{"type":"string"},"name":{"type":"string"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"State":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Cart_Warehouse":{"type":"object","properties":{"id":{"type":["string","null"]},"name":{"type":["string","null"]},"description":{"type":["string","null"]},"avail":{"type":["boolean","null"]},"address":{"anyOf":[{"$ref":"#/components/schemas/Customer_Address"},{"type":"null"}]},"carriers_ids":{"type":"array","items":{"type":"string"}},"stores_ids":{"type":"array","items":{"type":"string"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Cart_ShippingZone":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":["string","null"]},"name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_iso2_codes":{"type":"array","items":{"type":"string"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"CartCreate":{"type":"object","properties":{"cart_id":{"name":"cart_id","description":"Store\u2019s identifier which you can get from cart_list method","example":"Opencart14","type":"string","enum":["3DCart","3DCartApi","AceShop","AmazonSP","Americommerce","AspDotNetStorefront","BigCartel","Bricklink","BigcommerceApi","Bol","CommerceHQ","Creloaded","Cscart","Cubecart","Demandware","EBay","Ecwid","EtsyAPIv3","Facebook","Flipkart","Gambio","Hybris","JooCart","Jumpseller","Lazada","LightSpeed","Magento1212","Magento2Api","MercadoLibre","MijoShop","Miva","Neto","Opencart14","Oscmax2","Oscommerce22ms2","Otto","Oxid","Pinnacle","Prestashop","PrestashopApi","Salla","SCAPI","Shopify","Shopee","Shoplazza","Shopline","Shopware","ShopwareApi","Square","Squarespace","Temu","Tiendanube","TikTokShop","Tomatocart","Ubercart","Unas","Virtuemart","Volusion","WPecommerce","Walmart","Wix","Woocommerce","WoocommerceApi","Xcart","Xtcommerce","XtcommerceVeyton","Zencart137","Zid","Zoey","Zoho"]},"store_url":{"name":"store_url","description":"A web address of a store that you would like to connect to API2Cart","example":"http://mystore.com","type":"string"},"bridge_url":{"name":"bridge_url","description":"This parameter allows to set up store with custom bridge url (also you must use store_root parameter if a bridge folder is not in the root folder of the store)","example":"https://your-store.com/custom/bridge/path/bridge.php","type":"string"},"store_root":{"name":"store_root","description":"Absolute path to the store root directory (used with \"bridge_url\" parameter)","example":"/home/www/stores/magento1922","type":"string"},"store_key":{"name":"store_key","description":"Set this parameter if bridge is already uploaded to store","example":"ab37fc230bc5df63a5be1b11220949be","type":"string"},"shared_secret":{"name":"shared_secret","description":"Shared secret","example":"gmz3iz45x2","type":"string"},"validate_version":{"name":"validate_version","description":"Specify if api2cart should validate cart version","example":true,"type":"boolean","default":false},"verify":{"name":"verify","description":"Enables or disables cart's verification","example":false,"type":"boolean","default":true},"db_tables_prefix":{"name":"db_tables_prefix","description":"DB tables prefix","example":"oc_","type":"string"},"user_agent":{"name":"user_agent","description":"This parameter allows you to set your custom user agent, which will be used in requests to the store. Please use it cautiously, as the store's firewall may block specific values.","example":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0","type":"string"},"ftp_host":{"name":"ftp_host","description":"FTP connection host","example":"ftp.mystore.com","type":"string"},"ftp_user":{"name":"ftp_user","description":"FTP User","example":"user","type":"string"},"ftp_password":{"name":"ftp_password","description":"FTP Password","example":"G4}q215D4_H9$Be","type":"string"},"ftp_port":{"name":"ftp_port","description":"FTP Port","example":22,"type":"integer"},"ftp_store_dir":{"name":"ftp_store_dir","description":"FTP Store dir","example":"/public","type":"string"},"apiKey_3dcart":{"name":"apiKey_3dcart","description":"3DCart API Key","example":"82cc921c6a5c67082cc921c6a5c6707e1d6e6862ba3201a","type":"string"},"AdminAccount":{"name":"AdminAccount","description":"It's a BigCommerce account for which API is enabled","example":"admin","type":"string"},"ApiPath":{"name":"ApiPath","description":"BigCommerce API URL","example":"http://mystore.bigcommerce.com/api/v1","type":"string"},"ApiKey_Bigcommerce":{"name":"ApiKey_Bigcommerce","description":"Bigcommerce API Key","example":"6b89704cd75738cb0f9f6468d5462aba","type":"string"},"client_id":{"name":"client_id","description":"Client ID of the requesting app","example":"p1r37bt131z86675nofv9xmhietoe4t","type":"string"},"accessToken":{"name":"accessToken","description":"Access token authorizing the app to access resources on behalf of a user","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"context":{"name":"context","description":"API Path section unique to the store","example":"stores/etplnf8o8v","type":"string"},"access_token":{"name":"access_token","description":"Access token authorizing the app to access resources on behalf of a user","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"apiKey_shopify":{"name":"apiKey_shopify","description":"Shopify API Key","example":"bbca57d8ff3c3677128112c15556d9e3","type":"string"},"apiPassword":{"name":"apiPassword","description":"Shopify API Password","example":"860f3a6fc87632301a42cd88e4b5ab3d","type":"string"},"accessToken_shopify":{"name":"accessToken_shopify","description":"Access token authorizing the app to access resources on behalf of a user","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"shopify_client_id":{"name":"shopify_client_id","description":"Shopify Client ID","example":"b5defe55db3f6836fb4e0e6624ff9577","type":"string"},"apiKey":{"name":"apiKey","description":"Neto API Key","example":"bbca57d8ff3c3677128112c15556d9e3","type":"string"},"apiUsername":{"name":"apiUsername","description":"Neto User Name","example":"mylogin","type":"string"},"EncryptedPassword":{"name":"EncryptedPassword","description":"Volusion API Password","example":"7943CA5F3990E00D9A4CCF0BD998211F","type":"string"},"Login":{"name":"Login","description":"It's a Volusion account for which API is enabled","example":"admin","type":"string"},"apiUser_adnsf":{"name":"apiUser_adnsf","description":"It's a AspDotNetStorefront account for which API is available","example":"admin","type":"string"},"apiPass":{"name":"apiPass","description":"AspDotNetStorefront API Password","example":"f6471ef78f72b41849a8b8b67791b0b5","type":"string"},"privateKey":{"name":"privateKey","description":"3DCart Application Private Key","example":"2xo0m9ib5ty7rv84num9uic3e9mio0cy73nsdey7e5270","type":"string"},"appToken":{"name":"appToken","description":"3DCart Token from Application","example":"82cc921c6a5c67082cc921c6a5c6707e1d6e6862ba3201a","type":"string"},"etsy_keystring":{"name":"etsy_keystring","description":"Etsy keystring","example":"a9psel85v1wy5faeyjw03y0r","type":"string"},"etsy_shared_secret":{"name":"etsy_shared_secret","description":"Etsy shared secret","example":"gmz3iz45x2","type":"string"},"tokenSecret":{"name":"tokenSecret","description":"Secret token authorizing the app to access resources on behalf of a user","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"etsy_client_id":{"name":"etsy_client_id","description":"Etsy Client Id","example":"w0fi0igk2w29bjcd7ydr2s35","type":"string"},"etsy_refresh_token":{"name":"etsy_refresh_token","description":"Etsy Refresh token","example":"223577551.L07_RE-y7unmKf2dox4djsHkVxwpUfs1ikG_uQmHhF-aASEReNn_Qns1Wqn3dDa0ZMxrt9CIael3dgudeDZb31ZUdS","type":"string"},"ebay_client_id":{"name":"ebay_client_id","description":"Application ID (AppID).","example":"a9psel85v1wy5faeyjw03y0r","type":"string"},"ebay_client_secret":{"name":"ebay_client_secret","description":"Shared Secret from eBay application","example":"gmz3iz45x2","type":"string"},"ebay_runame":{"name":"ebay_runame","description":"The RuName value that eBay assigns to your application.","example":"gmz3iz45x2","type":"string"},"ebay_access_token":{"name":"ebay_access_token","description":"Used to authenticate API requests.","example":"v^1.1#i ... AjRV4yNjA=","type":"string"},"ebay_refresh_token":{"name":"ebay_refresh_token","description":"Used to renew the access token.","example":"v^1.1#i ... rAewqVasdA=","type":"string"},"ebay_environment":{"name":"ebay_environment","description":"eBay environment","example":"sandbox","type":"string","default":"production"},"ebay_site_id":{"name":"ebay_site_id","description":"eBay global ID","example":"101","type":"integer","default":0},"dw_client_id":{"name":"dw_client_id","description":"Demandware client id","example":"b849eb85-v8b9-1dw8-9fe2-97e1d6ffc7b0","type":"string"},"dw_api_pass":{"name":"dw_api_pass","description":"Demandware api password","example":"testpassword","type":"string"},"demandware_user_name":{"name":"demandware_user_name","description":"Demandware user name","example":"admin","type":"string"},"demandware_user_password":{"name":"demandware_user_password","description":"Demandware user password","example":"12345","type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"seller_id":{"name":"seller_id","description":"Seller Id","example":"A9PSDFGFGHFOQD","type":"string"},"environment":{"name":"environment","description":"","example":"sandbox","type":"string","default":"production"},"hybris_client_id":{"name":"hybris_client_id","description":"Omni Commerce Connector Client ID","example":"api_client_1","type":"string"},"hybris_client_secret":{"name":"hybris_client_secret","description":"Omni Commerce Connector Client Secret","example":"secret_phrase_1","type":"string"},"hybris_username":{"name":"hybris_username","description":"User Name","example":"admin","type":"string"},"hybris_password":{"name":"hybris_password","description":"User password","example":"nimda","type":"string"},"hybris_websites":{"type":"array","minItems":1,"items":{"type":"object","properties":{"uid":{"type":"string"},"url":{"type":"string"},"storeIds":{"type":"array","minItems":1,"items":{"type":"string"}}},"required":["uid","url","storeIds"]},"description":"Websites to stores mapping data"},"walmart_client_id":{"name":"walmart_client_id","description":"Walmart client ID. For the region 'ca' use Consumer ID","example":"423f6A24-123z-8654-989u-6fa96478289","type":"string"},"walmart_client_secret":{"name":"walmart_client_secret","description":"Walmart client secret. For the region 'ca' use Private Key","example":"1gf85fea-8974-2648-w12w-rt54284tdf54","type":"string"},"walmart_environment":{"name":"walmart_environment","description":"Walmart environment","example":"production","type":"string","default":"production"},"walmart_channel_type":{"name":"walmart_channel_type","description":"Walmart WM_CONSUMER.CHANNEL.TYPE header","example":"0f3e4dd4-0514-4346-b39d-af0e00ea066d","type":"string"},"walmart_region":{"name":"walmart_region","description":"Walmart region","example":"us","type":"string","default":"us"},"lightspeed_api_key":{"name":"lightspeed_api_key","description":"LightSpeed api key","example":"cf5444729c2abd6b6a5d983691767cb5","type":"string"},"lightspeed_api_secret":{"name":"lightspeed_api_secret","description":"LightSpeed api secret","example":"2620ee52a8bc942f9d5d3a575f4d363e","type":"string"},"shoplazza_access_token":{"name":"shoplazza_access_token","description":"Access token authorizing the app to access resources on behalf of a user","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"shoplazza_shared_secret":{"name":"shoplazza_shared_secret","description":"Shared secret","example":"gmz3iz45x2","type":"string"},"shopware_access_key":{"name":"shopware_access_key","description":"Shopware access key","example":"SWSCS3O1RJBSRNBYQLFIYJN2ZQ","type":"string"},"unas_api_key":{"name":"unas_api_key","description":"UNAS API Key","example":"c238908e29ceb6e6ad3df15f89a6234709d3f000","type":"string"},"shopware_api_key":{"name":"shopware_api_key","description":"Shopware api key","example":"SWSCS3O1RJBSRNBYQLFIYJN2ZQ","type":"string"},"shopware_api_secret":{"name":"shopware_api_secret","description":"Shopware client secret access key","example":"V3NYNWg2b1dZdHBUWDN1cmdKdGhnenp5enVJYlJ0WlJvOFF2bnQ","type":"string"},"commercehq_api_key":{"name":"commercehq_api_key","description":"CommerceHQ api key","example":"sJrD-LM0eddhe63rfgfva0dDydXfre4","type":"string"},"commercehq_api_password":{"name":"commercehq_api_password","description":"CommerceHQ api password","example":"4Grr_ZCLNNoSUuhAjesKuchxo9SL","type":"string"},"3dcart_private_key":{"name":"3dcart_private_key","description":"3DCart Private Key","example":"7dba81f90bdbe25e7000e73214ca51b","type":"string"},"3dcart_access_token":{"name":"3dcart_access_token","description":"3DCart Token","example":"4Grr_ZCLNNoSUuhAjesKuchxo9SL","type":"string"},"wc_consumer_key":{"name":"wc_consumer_key","description":"Woocommerce consumer key","example":"ck_26d8e2ad604f3917e429df6961722282bdcf109d","type":"string"},"wc_consumer_secret":{"name":"wc_consumer_secret","description":"Woocommerce consumer secret","example":"cs_931ced666118a15c5f7b4a33a15gf5589cbeba55","type":"string"},"magento_consumer_key":{"name":"magento_consumer_key","description":"Magento Consumer Key","example":"ktv4n9rgrj0evjuy2t6p2xlb1f8u5pmy","type":"string"},"magento_consumer_secret":{"name":"magento_consumer_secret","description":"Magento Consumer Secret","example":"a46abc3kxyinlbggy06i9g975xqo6gjq","type":"string"},"magento_access_token":{"name":"magento_access_token","description":"Magento Access Token","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"magento_token_secret":{"name":"magento_token_secret","description":"Magento Token Secret","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"prestashop_webservice_key":{"name":"prestashop_webservice_key","description":"Prestashop webservice key","example":"CKJ1ZEWRJWRLTPVBQJ9FGGRORD4AGS96","type":"string"},"wix_app_id":{"name":"wix_app_id","description":"Wix App ID","example":"6b0b5b7b-7d87-45b5-bf34-ac6b438e63da","type":"string"},"wix_app_secret_key":{"name":"wix_app_secret_key","description":"Wix App Secret Key","example":"316c0a09-f195-42be-74f6-a02cebb9cae6","type":"string"},"wix_instance_id":{"name":"wix_instance_id","description":"Wix Instance ID","example":"58b893a4-6b16-5c2f-qt78-qa3r61t32rt8","type":"string"},"wix_refresh_token":{"name":"wix_refresh_token","description":"Wix refresh token","example":"\n OAUTH2.eyJraWQiOiJkZ0x3cjNRMCIsImFsZyI6IkhTMjU2In0.\n eyJkYXRhIjoie1wiaWRcIjpcImJlZjM3MmRmLTUyNGItNDI3NS05M2RkL\n Tg4NDBlOTU3ZWU2OFwifSIsImlhdCI6MTY0ODA0NTEyNiwiZXhwIjoxNzExMTE3MTI2fQ.\n VRR2lGSbcTVmaArtmyyhy6o4WRDwTn-nlDCQpZ97eYw\n ","type":"string"},"mercado_libre_app_id":{"name":"mercado_libre_app_id","description":"Mercado Libre App ID","example":"211188015100135","type":"string"},"mercado_libre_app_secret_key":{"name":"mercado_libre_app_secret_key","description":"Mercado Libre App Secret Key","example":"e2qoG2zklLlfP7cEngEJ94YjhkejkjAm","type":"string"},"mercado_libre_refresh_token":{"name":"mercado_libre_refresh_token","description":"Mercado Libre Refresh Token","example":"TG-63h13529vb5464110188d2x9-703754376","type":"string"},"zid_client_id":{"name":"zid_client_id","description":"Zid Client ID","example":1234,"type":"integer"},"zid_client_secret":{"name":"zid_client_secret","description":"Zid Client Secret","example":"nl5l1lE0vxgv6cV111fHsdlOOIfb0Ms5IR7l4Igs","type":"string"},"zid_access_token":{"name":"zid_access_token","description":"Zid Access Token","example":"def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d","type":"string"},"zid_authorization":{"name":"zid_authorization","description":"Zid Authorization","example":"def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d","type":"string"},"zid_refresh_token":{"name":"zid_refresh_token","description":"Zid refresh token","example":"def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d","type":"string"},"flipkart_client_id":{"name":"flipkart_client_id","description":"Flipkart Client ID","example":"19414773883a13a850b6a52350b7246499a24","type":"string"},"flipkart_client_secret":{"name":"flipkart_client_secret","description":"Flipkart Client Secret","example":"nl5l1lE0vxgv6cV111fHsdlOOIfb0Ms5IR7l4Igs","type":"string"},"allegro_client_id":{"name":"allegro_client_id","description":"Allegro Client ID","example":"2915e189ce3d23d23d2327d204ae6a0bd","type":"string"},"allegro_client_secret":{"name":"allegro_client_secret","description":"Allegro Client Secret","example":"DNHtqdL2WPIefeUhQWYgtXPS23fgbfgasdsGHHJGhg3RTFDQWFGZmVoFRT5IfkQj1E7eR5","type":"string"},"allegro_access_token":{"name":"allegro_access_token","description":"Allegro Access Token","example":"eyJhbGciOiJSUzI1NiIsInR5cCI6IsfddfdfdeyJ1c2VyX25hbWUiOiI5NDUxMzE1MSIsInNjb3BlIjpbImFsbGVncm86YXBpOm9yZGVyczpyZWFkIiwiYWxsZWdybzphcGk6cHJvZmlsZTp3cml0ZSIsImFsbGVncm86YXBpOnNhbGU6b2ZmZXJzOndyaXRlIiwiYWxsZWdybzphcGk6YmlsbGluZzpyZWFkIiwiYWxsZWdybzphcGk6Y2FtcGFpZ25zIiwiYWxsZWdybzphcGk6ZGlzcHV0ZXMiLCJhbGxlZ3JvOmFwaTpzYWxlOm9mZmVyczpyZWFkIiwiYWxsZWdybzphcGk6YmlkcyIsImFsbGVncm86YXBpOm9yZGVyczp3cml0ZSIsImFsbGVncm86YXBpOnBheW1lbnRzOndyaXRlIiwiYWxsZWdybzphcGk6c2FsZTpzZXR0aW5nczp3cml0ZSIsImFsbGVncm86YXBpOnByb2ZpbGU6cmVhZCIsImFsbGVncm86YXBpOnJhdGluZ3MiLCJhbGxlZ3JvOmFwaTpzYWxlOnNldHRpbmdzOnJlYWQiLCJhbGxlZ3JvOmFwaTpwYXltZW50czpyZWFkIiwiYWxsZWdybzphcGk6bWVzc2FnaW5nIl0sI","type":"string"},"allegro_refresh_token":{"name":"allegro_refresh_token","description":"Allegro Refresh Token","example":"eyJhbGciOiJSUzI1NiIsInR5cCI6IsfddfdfdeyJ1c2VyX25hbWUiOiI5NDUxMzE1MSIsInNjb3BlIjpbImFsbGVncm86YXBpOm9yZGVyczpyZWFkIiwiYWxsZWdybzphcGk6cHJvZmlsZTp3cml0ZSIsImFsbGVncm86YXBpOnNhbGU6b2ZmZXJzOndyaXRlIiwiYWxsZWdybzphcGk6YmlsbGluZzpyZWFkIiwiYWxsZWdybzphcGk6Y2FtcGFpZ25zIiwiYWxsZWdybzphcGk6ZGlzcHV0ZXMiLCJhbGxlZ3JvOmFwaTpzYWxlOm9mZmVyczpyZWFkIiwiYWxsZWdybzphcGk6YmlkcyIsImFsbGVncm86YXBpOm9yZGVyczp3cml0ZSIsImFsbGVncm86YXBpOnBheW1lbnRzOndyaXRlIiwiYWxsZWdybzphcGk6c2FsZTpzZXR0aW5nczp3cml0ZSIsImFsbGVncm86YXBpOnByb2ZpbGU6cmVhZCIsImFsbGVncm86YXBpOnJhdGluZ3MiLCJhbGxlZ3JvOmFwaTpzYWxlOnNldHRpbmdzOnJlYWQiLCJhbGxlZ3JvOmFwaTpwYXltZW50czpyZWFkIiwiYWxsZWdybzphcGk6bWVzc2FnaW5nIl0sI","type":"string"},"allegro_environment":{"name":"allegro_environment","description":"Allegro Environment","example":"sandbox","type":"string","default":"production"},"bricklink_consumer_key":{"name":"bricklink_consumer_key","description":"Bricklink Consumer Key","example":"26F6CDA087D9444EAA71AC09E7A1D39A","type":"string"},"bricklink_consumer_secret":{"name":"bricklink_consumer_secret","description":"Bricklink Consumer Secret","example":"a46abc3kxyinlbggy06i9g975xqo6gjq","type":"string"},"bricklink_token":{"name":"bricklink_token","description":"Bricklink Access Token","example":"ktv4n9rgrj0evjuy2t6p2xlb1f8u5pmy","type":"string"},"bricklink_token_secret":{"name":"bricklink_token_secret","description":"Bricklink Access Token Secret","example":"a46abc3kxyinlbggy06i9g975xqo6gjq","type":"string"},"nopcommerce_token":{"name":"nopcommerce_token","description":"Access token authorizing the app to access resources on behalf of a user","example":"igse8e4rdmzkxdi937qe69d59en1imw","type":"string"},"jumpseller_client_id":{"name":"jumpseller_client_id","description":"Jumpseller OAuth2 Client ID","example":"your_client_id","type":"string"},"jumpseller_client_secret":{"name":"jumpseller_client_secret","description":"Jumpseller OAuth2 Client Secret","example":"your_client_secret","type":"string"},"jumpseller_refresh_token":{"name":"jumpseller_refresh_token","description":"Jumpseller OAuth2 refresh token","example":"your_oauth_refresh_token","type":"string"},"jumpseller_login":{"name":"jumpseller_login","description":"Jumpseller API login","example":"your_login","type":"string"},"jumpseller_authtoken":{"name":"jumpseller_authtoken","description":"Jumpseller API auth token","example":"your_auth_token","type":"string"}},"required":["cart_id","store_id"]},"Model_Response_Cart_Catalog_PriceRules_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Cart_CatalogPriceRules_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Cart_CatalogPriceRules_List_Result":{"type":"object","properties":{"catalog_price_rules_count":{"type":["integer","null"]},"catalog_price_rules":{"type":"array","items":{"$ref":"#/components/schemas/CatalogPriceRule"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"CatalogPriceRule":{"type":"object","properties":{"id":{"type":"string"},"gid":{"type":["string","null"]},"type":{"type":["string","null"]},"name":{"type":["string","null"]},"description":{"type":["string","null"]},"short_description":{"type":["string","null"]},"avail":{"type":["boolean","null"]},"actions":{"type":"array","items":{"$ref":"#/components/schemas/CatalogPriceRule_Action"}},"created_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"date_start":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"date_end":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"usage_count":{"type":["number","null"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Coupon_Condition"}},"uses_per_order_limit":{"type":["integer","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"CatalogPriceRule_Action":{"type":"object","properties":{"scope":{"type":"string"},"apply_to":{"type":"string"},"type":{"type":"string"},"quantity":{"type":["number","null"]},"value":{"type":"number"},"currency_code":{"type":["string","null"]},"include_tax":{"type":["boolean","null"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Coupon_Condition"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Coupon_Condition":{"type":"object","properties":{"id":{"type":"string"},"entity":{"type":"string"},"match_items":{"type":["string","null"]},"key":{"type":["string","null"]},"operator":{"type":["string","null"]},"value":{"type":["string","null"]},"logic_operator":{"type":["string","null"]},"sub-conditions":{"type":"array","items":{"$ref":"#/components/schemas/Coupon_Condition"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"CartConfigUpdate":{"type":"object","properties":{"db_tables_prefix":{"name":"db_tables_prefix","description":"This parameter is deprecated for this method. Please, use this parameter in method account.config.update","example":"oc_","type":"string"},"custom_fields":{"type":"object","description":"This parameter sets the list of params to the shopping cart."},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"user_agent":{"name":"user_agent","description":"This parameter allows you to set your custom user agent, which will be used in requests to the store. Please use it cautiously, as the store's firewall may block specific values.","example":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0","type":"string"}}},"Model_Response_Cart_Coupon_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Cart_Coupon_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Cart_Coupon_List_Result":{"type":"object","properties":{"coupon_count":{"type":["integer","null"]},"coupon":{"type":"array","items":{"$ref":"#/components/schemas/Coupon"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Coupon":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":["string","null"]},"codes":{"type":"array","items":{"$ref":"#/components/schemas/Coupon_Code"}},"name":{"type":["string","null"]},"description":{"type":["string","null"]},"actions":{"type":"array","items":{"$ref":"#/components/schemas/Coupon_Action"}},"date_start":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"date_end":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"avail":{"type":["boolean","null"]},"priority":{"type":["integer","null"]},"used_times":{"type":["integer","null"]},"usage_limit":{"type":["integer","null"]},"usage_limit_per_customer":{"type":["integer","null"]},"logic_operator":{"type":["string","null"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Coupon_Condition"}},"usage_history":{"type":"array","items":{"$ref":"#/components/schemas/Coupon_History"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Coupon_Code":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"used_times":{"type":["integer","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Coupon_Action":{"type":"object","properties":{"scope":{"type":"string"},"apply_to":{"type":"string"},"amount":{"type":"number"},"currency_code":{"type":["string","null"]},"include_tax":{"type":["boolean","null"]},"type":{"type":"string"},"discounted_quantity":{"type":["number","null"]},"discount_quantity_step":{"type":["integer","null"]},"logic_operator":{"type":["string","null"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Coupon_Condition"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Coupon_History":{"type":"object","properties":{"order_id":{"type":"string"},"amount":{"type":"number"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"CartCouponAdd":{"type":"object","properties":{"code":{"name":"code","description":"Coupon code","example":"000_BIG_SALE_000","type":"string"},"action_type":{"name":"action_type","description":"Coupon discount type","example":"percent","type":"string","enum":["percent","fixed"]},"action_apply_to":{"name":"action_apply_to","description":"Defines where discount should be applied","example":"order_total","type":"string","enum":["order_total","item_price","shipping"]},"action_scope":{"name":"action_scope","description":"Specify how discount should be applied. If scope=matching_items, then discount will be applied to each of the items that match action conditions. Scope order means that discount will be applied once.","example":"matching_items","type":"string","enum":["order","matching_items"]},"action_amount":{"name":"action_amount","description":"Defines the discount amount value.","example":15.5,"type":"number"},"codes":{"name":"codes","description":"Entity codes","example":"codes[0]=000_BIG_SALE_000&codes[1]=000_BIG_SALE_001&codes[2]=000_BIG_SALE_002","type":"array","items":{"type":"string"}},"name":{"name":"name","description":"Coupon name","example":"Sale! -30%","type":"string"},"date_start":{"name":"date_start","description":"Date start","example":"2019-12-29 06:44:30","type":"string","default":"now"},"date_end":{"name":"date_end","description":"Defines when discount code will be expired.","example":"2020-01-05 01:00:00","type":"string"},"usage_limit":{"name":"usage_limit","description":"Usage limit for coupon.","example":99,"type":"integer"},"usage_limit_per_customer":{"name":"usage_limit_per_customer","description":"Usage limit per customer.","example":1,"type":"integer"},"action_condition_entity":{"name":"action_condition_entity","description":"Defines entity for action condition.","example":"order","type":"string"},"action_condition_key":{"name":"action_condition_key","description":"Defines entity attribute code for action condition.","example":"product_id","type":"string"},"action_condition_operator":{"name":"action_condition_operator","description":"Defines condition operator.","example":"ONE_OF","type":"string"},"action_condition_value":{"name":"action_condition_value","description":"Defines condition attribute value/s. Can be comma separated string.","example":"17834222,45466663","type":"string"},"include_tax":{"name":"include_tax","description":"Indicates whether to apply a discount for taxes.","example":true,"type":"boolean","default":false},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"free_cash_on_delivery":{"name":"free_cash_on_delivery","description":"Defines whether the coupon provides free cash on delivery","example":true,"type":"boolean"},"customer_id":{"name":"customer_id","description":"Retrieves orders specified by customer id","example":"5","type":"string"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["code","action_type","action_apply_to","action_scope","action_amount"]},"Model_Response_Cart_GiftCard_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Cart_Giftcard_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Cart_Giftcard_List_Result":{"type":"object","properties":{"gift_card":{"type":"array","items":{"$ref":"#/components/schemas/GiftCard"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"GiftCard":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"name":{"type":["string","null"]},"type":{"type":"string"},"currency_code":{"type":["string","null"]},"amount":{"type":"number"},"initial_amount":{"type":"number"},"status":{"type":"string"},"created_at":{"type":["string","null"]},"avail_to":{"type":["string","null"]},"free_product_ids":{"type":["string","null"]},"message":{"type":["string","null"]},"issuer_email":{"type":["string","null"]},"recipient_email":{"type":["string","null"]},"issuer_name":{"type":["string","null"]},"recipient_name":{"type":["string","null"]},"usage_history":{"type":"array","items":{"$ref":"#/components/schemas/Coupon_History"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Cart_MetaData_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Cart_MetaData_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Cart_MetaData_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/Cart_MetaData"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Cart_MetaData":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":["string","null"]},"value":{"type":["string","null"]},"namespace":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"PluginList":{"type":"object","properties":{"all_plugins":{"type":["integer","null"]},"plugins":{"type":"array","items":{"$ref":"#/components/schemas/Plugin"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Plugin":{"type":"object","properties":{"name":{"type":"string"},"code":{"type":["string","null"]},"active":{"type":["boolean","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Cart_Script_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Cart_Script_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Cart_Script_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"scripts":{"type":"array","items":{"$ref":"#/components/schemas/Script"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Script":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"description":{"type":["string","null"]},"src":{"type":["string","null"]},"scope":{"type":["string","null"]},"event":{"type":["string","null"]},"load_method":{"type":["string","null"]},"html":{"type":["string","null"]},"created_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Cart_ShippingZones_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Cart_ShippingZones_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Cart_ShippingZones_List_Result":{"type":"object","properties":{"shipping_zone":{"type":"array","items":{"$ref":"#/components/schemas/Cart_ShippingZone2"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Cart_ShippingZone2":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"enabled":{"type":["boolean","null"]},"countries":{"type":"array","items":{"$ref":"#/components/schemas/Country"}},"shipping_methods":{"type":"array","items":{"$ref":"#/components/schemas/Cart_ShippingMethod"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Cart_ShippingMethod":{"type":"object","properties":{"name":{"type":["string","null"]},"handling_fee":{"type":["string","null"]},"handling_enabled":{"type":["string","null"]},"handling_type":{"type":["string","null"]},"default_price":{"type":["string","null"]},"default_price_type":{"type":["string","null"]},"type":{"type":["string","null"]},"enabled":{"type":["string","null"]},"min_order_amount":{"type":["string","null"]},"rates":{"type":"array","items":{"$ref":"#/components/schemas/Cart_ShippingMethod_Rate"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Cart_ShippingMethod_Rate":{"type":"object","properties":{"min_weight":{"type":["string","null"]},"max_weight":{"type":["string","null"]},"min_order_amount":{"type":["string","null"]},"max_order_amount":{"type":["string","null"]},"min_items_count":{"type":["string","null"]},"max_items_count":{"type":["string","null"]},"price":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Category":{"type":"object","properties":{"id":{"type":"string"},"parent_id":{"type":["string","null"]},"created_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"name":{"type":"string"},"short_description":{"type":["string","null"]},"description":{"type":["string","null"]},"stores_ids":{"type":"array","items":{"type":"string"}},"keywords":{"type":["string","null"]},"meta_description":{"type":["string","null"]},"meta_title":{"type":["string","null"]},"avail":{"type":"boolean"},"path":{"type":["string","null"]},"seo_url":{"type":["string","null"]},"sort_order":{"type":["integer","null"]},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Image":{"type":"object","properties":{"id":{"type":["string","null"]},"http_path":{"type":"string"},"file_name":{"type":["string","null"]},"mime-type":{"type":["string","null"]},"size":{"type":["integer","null"]},"create_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"alt":{"type":["string","null"]},"avail":{"type":"boolean"},"sort_order":{"type":["integer","null"]},"type":{"type":"string"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Category_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Category_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Category_List_Result":{"type":"object","properties":{"categories_count":{"type":["integer","null"]},"category":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"CategoryAddBatch":{"type":"object","properties":{"payload":{"type":"array","minItems":1,"maxItems":250,"description":"Contains an array of categories objects. The list of properties may vary depending on the specific platform.","items":{"type":"object","properties":{"name":{"type":"string"},"avail":{"type":"boolean"},"description":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_keywords":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"parent_id":{"type":"string"},"sort_order":{"type":"integer"},"seo_url":{"type":"string"},"store_id":{"type":"string"},"images":{"type":"array","maxItems":1,"items":{"type":"object","properties":{"url":{"type":"string"},"image_name":{"type":"string"},"type":{"type":"string"},"label":{"type":"string"}},"required":["url"]}},"stores_ids":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"}}},"required":["name"]}},"idempotency_key":{"type":"string","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes."}},"required":["payload"]},"CategoryDeleteBatch":{"type":"object","properties":{"payload":{"type":"array","minItems":1,"maxItems":250,"description":"Contains an array of category IDs to delete.","items":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}},"required":["payload"]},"Customer":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"first_name":{"type":["string","null"]},"last_name":{"type":["string","null"]},"phone":{"type":["string","null"]},"created_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"group":{"type":"array","items":{"$ref":"#/components/schemas/Customer_Group"}},"login":{"type":["string","null"]},"last_login":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"birth_day":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"status":{"type":["string","null"]},"is_guest":{"type":["boolean","null"]},"news_letter_subscription":{"type":["boolean","null"]},"consents":{"type":"array","items":{"$ref":"#/components/schemas/Customer_Consent"}},"gender":{"type":["string","null"]},"stores_ids":{"type":"array","items":{"type":"string"}},"website":{"type":["string","null"]},"fax":{"type":["string","null"]},"company":{"type":["string","null"]},"ip_address":{"type":["string","null"]},"address_book":{"type":"array","items":{"$ref":"#/components/schemas/Customer_Address"}},"lang_id":{"type":["string","null"]},"orders_count":{"type":["integer","null"]},"last_order_id":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Customer_Group":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Customer_Consent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":["string","null"]},"status":{"type":["string","null"]},"source":{"type":["string","null"]},"opt_in_level":{"type":["string","null"]},"modified_time":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Customer_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Customer_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Customer_List_Result":{"type":"object","properties":{"customers_count":{"type":["integer","null"]},"customer":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"CustomerAdd":{"type":"object","properties":{"email":{"name":"email","description":"Defines customer's email","example":"mail@example.com","type":"string"},"first_name":{"name":"first_name","description":"Defines customer's first name","example":"John","type":"string"},"last_name":{"name":"last_name","description":"Defines customer's last name","example":"Smith","type":"string"},"password":{"name":"password","description":"Defines customer's unique password","example":"fd5gfd5g75fd","type":"string"},"group":{"name":"group","description":"Defines the group where the customer","example":"Register","type":"string"},"group_id":{"name":"group_id","description":"Customer group_id","example":3,"type":"string"},"group_ids":{"name":"group_ids","description":"Groups that will be assigned to a customer","example":"1,2,3","type":"string"},"status":{"name":"status","description":"Defines customer's status","example":"disabled","type":"string","default":"enabled"},"created_time":{"name":"created_time","description":"Entity's date creation","example":"2014-01-30 15:58:41","type":"string"},"modified_time":{"name":"modified_time","description":"Entity's date modification","example":"2014-07-30 15:58:41","type":"string"},"login":{"name":"login","description":"Specifies customer's login name","example":"makaka","type":"string"},"last_login":{"name":"last_login","description":"Defines customer's last login time","example":"2013-02-26 15:00:00","type":"string"},"birth_day":{"name":"birth_day","description":"Defines customer's birthday","example":"2013-02-26 15:00:00","type":"string"},"news_letter_subscription":{"name":"news_letter_subscription","description":"Defines whether the newsletter subscription is available for the user","example":true,"type":"boolean"},"consents":{"type":"array","minItems":1,"items":{"type":"object","properties":{"type":{"type":"string","enum":["email","sms"]},"status":{"type":"string"},"opt_in_level":{"type":"string"}},"required":["type","status","opt_in_level"]},"description":"Defines consents to notifications"},"gender":{"name":"gender","description":"Defines customer's gender","example":"male","type":"string"},"website":{"name":"website","description":"Link to customer website","example":"http://api2cart.com","type":"string"},"fax":{"name":"fax","description":"Defines customer's fax","example":"54545787","type":"string"},"company":{"name":"company","description":"Defines customer's company","example":"Apple","type":"string"},"phone":{"name":"phone","description":"Defines customer's phone number","example":"56686868654","type":"string"},"note":{"name":"note","description":"The customer note.","example":"Customer note","type":"string"},"country":{"name":"country","description":"Specifies ISO code or name of country","example":"US","type":"string"},"currency_id":{"name":"currency_id","description":"Currency Id","example":"usd","type":"string"},"is_tax_exempt":{"name":"is_tax_exempt","description":"Marks a customer as tax-exempt (B2B/wholesale).","example":false,"type":"boolean"},"vendor_id":{"name":"vendor_id","description":"Assigns vendor id to the customer","example":"1","type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"},"address":{"type":"array","items":{"type":"object","properties":{"address_book_type":{"name":"address_book_type_{x}","description":"Specifies customer's address type","example":"billing","type":"string"},"address_book_first_name":{"name":"address_book_first_name_{x}","description":"Specifies customer's first name in the address book","example":"John","type":"string"},"address_book_last_name":{"name":"address_book_last_name_{x}","description":"Specifies customer's last name in the address book","example":"Smith","type":"string"},"address_book_company":{"name":"address_book_company_{x}","description":"Specifies customer's company name in the address book","example":"Samsung","type":"string"},"address_book_fax":{"name":"address_book_fax_{x}","description":"Specifies customer's fax in the address book","example":"5758787","type":"string"},"address_book_phone":{"name":"address_book_phone_{x}","description":"Specifies customer's phone number in the address book","example":"5758787","type":"string"},"address_book_phone_mobile":{"name":"address_book_phone_mobile_{x}","description":"Specifies customer's mobile phone number in the address book","example":"5758787","type":"string"},"address_book_website":{"name":"address_book_website_{x}","description":"Specifies customer's website in the address book","example":"http://api2cart.com","type":"string"},"address_book_address1":{"name":"address_book_address1_{x}","description":"Specifies customer's first address in the address book","example":"Green str. 35","type":"string"},"address_book_address2":{"name":"address_book_address2_{x}","description":"Specifies customer's second address in the address book","example":"Green str. 35","type":"string"},"address_book_city":{"name":"address_book_city_{x}","description":"Specifies customer's city in the address book","example":"Chicago","type":"string"},"address_book_country":{"name":"address_book_country_{x}","description":"ISO code or name of country","example":"US","type":"string"},"address_book_state":{"name":"address_book_state_{x}","description":"ISO code or name of state.","example":"IL","type":"string"},"address_book_postcode":{"name":"address_book_postcode_{x}","description":"Specifies customer's postcode","example":"12345","type":"string"},"address_book_gender":{"name":"address_book_gender_{x}","description":"Specifies customer's gender","example":"male","type":"string"},"address_book_region":{"name":"address_book_region_{x}","description":"Specifies customer's region","example":"Alabama","type":"string"},"address_book_default":{"name":"address_book_default_{x}","description":"Defines whether the address is used by default","example":true,"type":"boolean"},"address_book_tax_id":{"name":"address_book_tax_id_{x}","description":"Add Tax Id","example":"`12345678`","type":"string"},"address_book_identification_number":{"name":"address_book_identification_number_{x}","description":"The national ID card number of this person, or a unique tax identification number.","example":"`123-456-7890`","type":"string"},"address_book_alias":{"name":"address_book_alias_{x}","description":"Specifies customer's alias in the address book","example":"Address alias","type":"string"}}}}},"required":["email"]},"CustomerUpdate":{"type":"object","properties":{"id":{"name":"id","description":"Entity id","example":10,"type":"string"},"group_id":{"name":"group_id","description":"Customer group_id","example":3,"type":"string"},"group_ids":{"name":"group_ids","description":"Groups that will be assigned to a customer","example":"1,2,3","type":"string"},"group":{"name":"group","description":"Defines the group where the customer","example":"Register","type":"string"},"email":{"name":"email","description":"Defines customer's email","example":"mail@example.com","type":"string"},"phone":{"name":"phone","description":"Defines customer's phone number","example":"56686868654","type":"string"},"first_name":{"name":"first_name","description":"Defines customer's first name","example":"John","type":"string"},"last_name":{"name":"last_name","description":"Defines customer's last name","example":"Smith","type":"string"},"birth_day":{"name":"birth_day","description":"Defines customer's birthday","example":"2013-02-26 15:00:00","type":"string"},"news_letter_subscription":{"name":"news_letter_subscription","description":"Defines whether the newsletter subscription is available for the user","example":true,"type":"boolean"},"consents":{"type":"array","minItems":1,"items":{"type":"object","properties":{"type":{"type":"string","enum":["email","sms"]},"status":{"type":"string"},"opt_in_level":{"type":"string"}},"required":["type","status","opt_in_level"]},"description":"Defines consents to notifications"},"tags":{"name":"tags","description":"Customer tags","example":"tag1,tag2","type":"string"},"gender":{"name":"gender","description":"Defines customer's gender","example":"male","type":"string"},"note":{"name":"note","description":"The customer note.","example":"Customer note","type":"string"},"status":{"name":"status","description":"Defines customer's status","example":"disabled","type":"string"},"password":{"name":"password","description":"Defines customer's unique password","example":"fd5gfd5g75fd","type":"string"},"currency_id":{"name":"currency_id","description":"Currency Id","example":"usd","type":"string"},"company":{"name":"company","description":"Defines customer's company","example":"Apple","type":"string"},"country":{"name":"country","description":"Specifies ISO code or name of country","example":"US","type":"string"},"fax":{"name":"fax","description":"Defines customer's fax","example":"54545787","type":"string"},"tax_id":{"name":"tax_id","description":"Add Tax Id","example":"`12345678`","type":"string"},"is_tax_exempt":{"name":"is_tax_exempt","description":"Marks a customer as tax-exempt (B2B/wholesale).","example":false,"type":"boolean"},"vendor_id":{"name":"vendor_id","description":"Updates vendor id of the customer","example":"1","type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"},"address":{"type":"array","items":{"type":"object","properties":{"address_book_id":{"name":"address_book_id_{x}","description":"The ID of the address.","example":"7805807034473","type":"string"},"address_book_first_name":{"name":"address_book_first_name_{x}","description":"Specifies customer's first name in the address book","example":"John","type":"string"},"address_book_last_name":{"name":"address_book_last_name_{x}","description":"Specifies customer's last name in the address book","example":"Smith","type":"string"},"address_book_company":{"name":"address_book_company_{x}","description":"Specifies customer's company name in the address book","example":"Samsung","type":"string"},"address_book_fax":{"name":"address_book_fax_{x}","description":"Specifies customer's fax in the address book","example":"5758787","type":"string"},"address_book_phone":{"name":"address_book_phone_{x}","description":"Specifies customer's phone number in the address book","example":"5758787","type":"string"},"address_book_phone_mobile":{"name":"address_book_phone_mobile_{x}","description":"Specifies customer's mobile phone number in the address book","example":"5758787","type":"string"},"address_book_address1":{"name":"address_book_address1_{x}","description":"Specifies customer's first address in the address book","example":"Green str. 35","type":"string"},"address_book_address2":{"name":"address_book_address2_{x}","description":"Specifies customer's second address in the address book","example":"Green str. 35","type":"string"},"address_book_city":{"name":"address_book_city_{x}","description":"Specifies customer's city in the address book","example":"Chicago","type":"string"},"address_book_country":{"name":"address_book_country_{x}","description":"ISO code or name of country","example":"US","type":"string"},"address_book_state":{"name":"address_book_state_{x}","description":"ISO code or name of state.","example":"IL","type":"string"},"address_book_postcode":{"name":"address_book_postcode_{x}","description":"Specifies customer's postcode","example":"12345","type":"string"},"address_book_tax_id":{"name":"address_book_tax_id_{x}","description":"Add Tax Id","example":"`12345678`","type":"string"},"address_book_identification_number":{"name":"address_book_identification_number_{x}","description":"The national ID card number of this person, or a unique tax identification number.","example":"`123-456-7890`","type":"string"},"address_book_gender":{"name":"address_book_gender_{x}","description":"Specifies customer's gender","example":"male","type":"string"},"address_book_region":{"name":"address_book_region_{x}","description":"Specifies customer's region","example":"Alabama","type":"string"},"address_book_alias":{"name":"address_book_alias_{x}","description":"Specifies customer's alias in the address book","example":"Address alias","type":"string"},"address_book_type":{"name":"address_book_type_{x}","description":"Specifies customer's address type","example":"billing","type":"string"},"address_book_default":{"name":"address_book_default_{x}","description":"Defines whether the address is used by default","example":true,"type":"boolean"}}}}}},"CustomerAddressAdd":{"type":"object","properties":{"customer_id":{"name":"customer_id","description":"Defines customer id","example":"5","type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"first_name":{"name":"first_name","description":"Defines customer's address first name","example":"John","type":"string"},"last_name":{"name":"last_name","description":"Defines customer's address last name","example":"Smith","type":"string"},"company":{"name":"company","description":"Defines customer's address company","example":"Apple","type":"string"},"address1":{"name":"address1","description":"Specifies customer's address address1","example":"Green str. 35","type":"string"},"address2":{"name":"address2","description":"Specifies customer's address address2","example":"Green str. 35","type":"string"},"city":{"name":"city","description":"Specifies customer's address city","example":"Chicago","type":"string"},"country":{"name":"country","description":"Specifies customer's address ISO code or name of country","example":"US","type":"string"},"state":{"name":"state","description":"Specifies customer's address ISO code or name of state","example":"IL","type":"string"},"postcode":{"name":"postcode","description":"Specifies customer's address postcode","example":"12345","type":"string"},"identification_number":{"name":"identification_number","description":"Specifies the national ID card number of this person, or a unique tax identification number for customer's address","example":"`123-456-7890`","type":"string"},"types":{"name":"types","description":"Specifies customer's address types","example":"types[0]=billing&types[1]=shipping","type":"array","items":{"type":"string"}},"default":{"name":"default","description":"Specifies whether the customer's address is used by default","example":true,"type":"boolean"},"phone":{"name":"phone","description":"Defines customer's address phone number","example":"56686868654","type":"string"},"phone_mobile":{"name":"phone_mobile","description":"Defines customer's address mobile phone number","example":"56686868654","type":"string"},"fax":{"name":"fax","description":"Defines customer's address fax","example":"54545787","type":"string"},"website":{"name":"website","description":"Defines Link to customer's address website","example":"http://api2cart.com","type":"string"},"gender":{"name":"gender","description":"Defines customer's address gender","example":"male","type":"string"},"tax_id":{"name":"tax_id","description":"Add Tax Id","example":"`12345678`","type":"string"},"alias":{"name":"alias","description":"Specifies customer's alias in the address book","example":"Address alias","type":"string"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["customer_id","address1","city","country","postcode"]},"Model_Response_Customer_Attribute_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Customer_Attribute_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Customer_Attribute_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/Customer_Attribute"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Customer_Attribute":{"type":"object","properties":{"attribute_id":{"type":["string","null"]},"code":{"type":["string","null"]},"name":{"type":["string","null"]},"type":{"type":["string","null"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/Customer_Attribute_Value"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Customer_Attribute_Value":{"type":"object","properties":{"id":{"type":["string","null"]},"value":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Customer_Group_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Customer_Group_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Customer_Group_List_Result":{"type":"object","properties":{"group_count":{"type":["integer","null"]},"group":{"type":"array","items":{"$ref":"#/components/schemas/Customer_Group"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Customer_Wishlist_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Customer_Wishlist_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Customer_Wishlist_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"wish_lists":{"type":"array","items":{"$ref":"#/components/schemas/Customer_WishList"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Customer_WishList":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"description":{"type":["string","null"]},"is_public":{"type":["string","null"]},"created_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"products":{"type":"array","items":{"$ref":"#/components/schemas/Customer_WishList_Item"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Customer_WishList_Item":{"type":"object","properties":{"id":{"type":["string","null"]},"product_id":{"type":"string"},"child_id":{"type":["string","null"]},"created_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Marketplace_Product_Find":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Marketplace_Product_Find_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Marketplace_Product_Find_Result":{"type":"object","properties":{"marketplace_products_count":{"type":["integer","null"]},"marketplace_product":{"type":"array","items":{"$ref":"#/components/schemas/Marketplace_Product"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Marketplace_Product":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":["string","null"]},"u_asin":{"type":["string","null"]},"u_ean":{"type":["string","null"]},"u_gtin":{"type":["string","null"]},"u_isbn":{"type":["string","null"]},"u_mpn":{"type":["string","null"]},"u_upc":{"type":["string","null"]},"name":{"type":["string","null"]},"description":{"type":["string","null"]},"url":{"type":["string","null"]},"price":{"type":["number","null"]},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"}},"product_options":{"type":"array","items":{"$ref":"#/components/schemas/Product_Option"}},"manufacturer":{"type":["string","null"]},"brand":{"type":["string","null"]},"weight":{"type":["number","null"]},"weight_unit":{"type":["string","null"]},"dimensions_unit":{"type":["string","null"]},"width":{"type":["number","null"]},"height":{"type":["number","null"]},"length":{"type":["number","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Product_Option":{"type":"object","properties":{"id":{"type":"string"},"product_option_id":{"type":["string","null"]},"name":{"type":"string"},"description":{"type":["string","null"]},"sort_order":{"type":["integer","null"]},"type":{"type":"string"},"required":{"type":["boolean","null"]},"available":{"type":["boolean","null"]},"used_in_combination":{"type":["boolean","null"]},"option_items":{"type":"array","items":{"$ref":"#/components/schemas/Product_Option_Item"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Product_Option_Item":{"type":"object","properties":{"id":{"type":"string"},"product_option_item_id":{"type":["string","null"]},"name":{"type":"string"},"sort_order":{"type":["integer","null"]},"price":{"type":["number","null"]},"weight":{"type":["number","null"]},"quantity":{"type":["integer","null"]},"type_price":{"type":["string","null"]},"sku":{"type":["string","null"]},"is_default":{"type":["boolean","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order":{"type":"object","properties":{"id":{"type":"string"},"order_id":{"type":"string"},"basket_id":{"type":["string","null"]},"channel_id":{"type":["string","null"]},"customer":{"$ref":"#/components/schemas/BaseCustomer"},"create_at":{"$ref":"#/components/schemas/A2CDateTime"},"currency":{"anyOf":[{"$ref":"#/components/schemas/Currency"},{"type":"null"}]},"shipping_address":{"anyOf":[{"$ref":"#/components/schemas/Customer_Address"},{"type":"null"}]},"billing_address":{"anyOf":[{"$ref":"#/components/schemas/Customer_Address"},{"type":"null"}]},"payment_method":{"anyOf":[{"$ref":"#/components/schemas/Order_PaymentMethod"},{"type":"null"}]},"shipping_method":{"anyOf":[{"$ref":"#/components/schemas/Order_ShippingMethod"},{"type":"null"}]},"shipping_methods":{"type":"array","items":{"$ref":"#/components/schemas/Order_ShippingMethod"}},"status":{"$ref":"#/components/schemas/Order_Status"},"totals":{"anyOf":[{"$ref":"#/components/schemas/Order_Totals"},{"type":"null"}]},"total":{"anyOf":[{"$ref":"#/components/schemas/Order_Total"},{"type":"null"}]},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Order_Totals_NewDiscount"}},"order_products":{"type":"array","items":{"$ref":"#/components/schemas/Order_Item"}},"bundles":{"type":"array","items":{"$ref":"#/components/schemas/Order_Item"}},"modified_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"finished_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"comment":{"type":["string","null"]},"store_id":{"type":["string","null"]},"warehouses_ids":{"type":"array","items":{"type":"string"}},"refunds":{"type":"array","items":{"$ref":"#/components/schemas/Order_Refund"}},"gift_message":{"type":["string","null"]},"order_details_url":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_PaymentMethod":{"type":"object","properties":{"name":{"type":"string"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Status":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"history":{"type":"array","items":{"$ref":"#/components/schemas/Order_Status_HistoryItem"}},"refund_info":{"anyOf":[{"$ref":"#/components/schemas/Order_Status_Refund"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Status_HistoryItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"modified_time":{"$ref":"#/components/schemas/A2CDateTime"},"notify":{"type":["boolean","null"]},"comment":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Status_Refund":{"type":"object","properties":{"shipping":{"type":["number","null"]},"fee":{"type":["number","null"]},"tax":{"type":["number","null"]},"total_refunded":{"type":["number","null"]},"time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"comment":{"type":["string","null"]},"refunded_items":{"type":"array","items":{"$ref":"#/components/schemas/Order_Status_Refund_Item"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Status_Refund_Item":{"type":"object","properties":{"product_id":{"type":["string","null"]},"variant_id":{"type":["string","null"]},"order_product_id":{"type":["string","null"]},"qty":{"type":["number","null"]},"refund":{"type":["number","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Totals":{"type":"object","properties":{"total":{"type":"number"},"subtotal":{"type":"number"},"shipping":{"type":"number"},"tax":{"type":["number","null"]},"discount":{"type":["number","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Total":{"type":"object","properties":{"subtotal_ex_tax":{"type":"number"},"wrapping_ex_tax":{"type":["number","null"]},"shipping_ex_tax":{"type":"number"},"total_discount":{"type":"number"},"total_tax":{"type":"number"},"total":{"type":"number"},"total_paid":{"type":["number","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Totals_NewDiscount":{"type":"object","properties":{"code":{"type":["string","null"]},"value":{"type":"number"},"type":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Item":{"type":"object","properties":{"product_id":{"type":["string","null"]},"order_product_id":{"type":["string","null"]},"model":{"type":["string","null"]},"name":{"type":"string"},"price":{"type":"number"},"price_inc_tax":{"type":["number","null"]},"quantity":{"type":["number","null"]},"discount_amount":{"type":["number","null"]},"total_price":{"type":["number","null"]},"tax_percent":{"type":["number","null"]},"tax_value":{"type":["number","null"]},"tax_value_after_discount":{"type":["number","null"]},"options":{"type":"array","items":{"$ref":"#/components/schemas/Order_Item_Option"}},"variant_id":{"type":["string","null"]},"weight_unit":{"type":["string","null"]},"weight":{"type":["number","null"]},"barcode":{"type":["string","null"]},"parent_order_product_id":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Item_Option":{"type":"object","properties":{"option_id":{"type":["string","null"]},"name":{"type":"string"},"value":{"type":"string"},"price":{"type":"number"},"weight":{"type":["number","null"]},"type":{"type":["string","null"]},"product_option_value_id":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Refund":{"type":"object","properties":{"id":{"type":["string","null"]},"shipping":{"type":["number","null"]},"fee":{"type":["number","null"]},"tax":{"type":["number","null"]},"total":{"type":["number","null"]},"modified_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"comment":{"type":["string","null"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/Order_Status_Refund_Item"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Order_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Order_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Order_List_Result":{"type":"object","properties":{"orders_count":{"type":["integer","null"]},"order":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Calculate":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/BaseCustomer"},"subtotal":{"$ref":"#/components/schemas/Order_Calculate_Subtotal"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Order_Calculate_Item"}},"bundles":{"type":"array","items":{"$ref":"#/components/schemas/Order_Calculate_Bundle"}},"currency":{"anyOf":[{"$ref":"#/components/schemas/Currency"},{"type":"null"}]},"shipping_rates":{"type":"array","items":{"$ref":"#/components/schemas/Order_Calculate_ShippingRate"}},"tax_lines":{"type":"array","items":{"$ref":"#/components/schemas/Order_Calculate_Tax"}},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Order_Calculate_Discount"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Calculate_Subtotal":{"type":"object","properties":{"value":{"type":"number"},"tax":{"type":"number"},"discount":{"type":"number"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Calculate_Item":{"type":"object","properties":{"product_id":{"type":"string"},"sku":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"integer"},"price":{"type":"number"},"price_inc_tax":{"type":"number"},"tax_rate":{"type":"number"},"unit_discount":{"type":"number"},"weight":{"type":["number","null"]},"weight_unit":{"type":["string","null"]},"barcode":{"type":["string","null"]},"variant_id":{"type":["string","null"]},"bundle_product_id":{"type":["string","null"]},"options":{"type":"array","items":{"$ref":"#/components/schemas/Order_Item_Option"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Calculate_Bundle":{"type":"object","properties":{"product_id":{"type":"string"},"sku":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"integer"},"price":{"type":"number"},"price_inc_tax":{"type":"number"},"tax_rate":{"type":"number"},"unit_discount":{"type":"number"},"weight":{"type":["number","null"]},"weight_unit":{"type":["string","null"]},"barcode":{"type":["string","null"]},"variant_id":{"type":["string","null"]},"options":{"type":"array","items":{"$ref":"#/components/schemas/Order_Item_Option"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Calculate_ShippingRate":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"price_inc_tax":{"type":"number"},"tax":{"type":"number"},"tax_rate":{"type":"number"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Calculate_Tax":{"type":"object","properties":{"code":{"type":"string"},"rate":{"type":"number"},"value":{"type":"number"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Calculate_Discount":{"type":"object","properties":{"code":{"type":["string","null"]},"value":{"type":"number"},"type":{"type":["string","null"]},"free_shipping":{"type":["boolean","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"OrderCalculate":{"type":"object","properties":{"customer_email":{"name":"customer_email","description":"Defines the customer specified by email for whom the order needs to be calculated","example":"jubari@hannsgroup.com","type":"string"},"currency_id":{"name":"currency_id","description":"Currency Id","example":"usd","type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"coupons":{"type":"array","minItems":1,"items":{"type":"string"},"description":"Coupons that will be applied to order. If the order isn't eligible for any given discount code or there is no discount with such a code it will be skipped during calculation"},"rounding_precision":{"name":"rounding_precision","description":"

Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).

Supported values range from 1 to 6.

The default rounding precision may vary depending on the platform. You can retrieve the default value using the cart.info method in the default_rounding_precision field.

Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.

","example":3,"type":"integer"},"shipp_first_name":{"name":"shipp_first_name","description":"Specifies shipping first name","example":"John","type":"string"},"shipp_last_name":{"name":"shipp_last_name","description":"Specifies shipping last name","example":"Smith","type":"string"},"shipp_address_1":{"name":"shipp_address_1","description":"Specifies first shipping address","example":"Green str. 35","type":"string"},"shipp_address_2":{"name":"shipp_address_2","description":"Specifies second address line of a shipping street address","example":"Green str. 35","type":"string"},"shipp_city":{"name":"shipp_city","description":"Specifies shipping city","example":"Chicago","type":"string"},"shipp_postcode":{"name":"shipp_postcode","description":"Specifies shipping postcode","example":"24545","type":"string"},"shipp_state":{"name":"shipp_state","description":"Specifies shipping state code","example":"IL","type":"string"},"shipp_country":{"name":"shipp_country","description":"Specifies shipping country code","example":"US","type":"string"},"shipp_company":{"name":"shipp_company","description":"Specifies shipping company","example":"Apple","type":"string"},"shipp_phone":{"name":"shipp_phone","description":"Specifies shipping phone","example":"880086544564","type":"string"},"bill_first_name":{"name":"bill_first_name","description":"Specifies billing first name","example":"Adam","type":"string"},"bill_last_name":{"name":"bill_last_name","description":"Specifies billing last name","example":"Smith","type":"string"},"bill_address_1":{"name":"bill_address_1","description":"Specifies first billing address","example":"Green str. 35","type":"string"},"bill_address_2":{"name":"bill_address_2","description":"Specifies second billing address","example":"Red str, 2","type":"string"},"bill_city":{"name":"bill_city","description":"Specifies billing city","example":"Chicago","type":"string"},"bill_postcode":{"name":"bill_postcode","description":"Specifies billing postcode","example":"12345","type":"string"},"bill_state":{"name":"bill_state","description":"Specifies billing state code","example":"IL","type":"string"},"bill_country":{"name":"bill_country","description":"Specifies billing country code","example":"US","type":"string"},"bill_company":{"name":"bill_company","description":"Specifies billing company","example":"Apple","type":"string"},"bill_phone":{"name":"bill_phone","description":"Specifies billing phone","example":"8 800 5659 6896","type":"string"},"response_fields":{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","example":"{result}","type":"string"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"},"order_item":{"type":"array","items":{"type":"object","properties":{"order_item_id":{"name":"order_item_id_{x}","description":"Defines orders specified by order item id","example":"125, where {x} - 1,2,3,... etc","type":"string"},"order_item_quantity":{"name":"order_item_quantity_{x}","description":"Defines orders specified by order item quantity","example":"5, where {x} - 1,2,3,... etc","type":"integer"},"order_item_variant_id":{"name":"order_item_variant_id_{x}","description":"Ordered product variant. Where x is order item ID","example":52,"type":"string"},"order_item_parent":{"name":"order_item_parent_{x}","description":"Index of the parent grouped/bundle product","example":2,"type":"integer"},"order_item_parent_option_name":{"name":"order_item_parent_option_name_{x}","description":"Option name of the parent grouped/bundle product","example":"Internal Memory Storage","type":"string"},"order_item_option":{"type":"array","items":{"type":"object","properties":{"order_item_option_name":{"name":"order_item_option_name_{x}_{y}","description":"Ordered Product Option Name. Where x is order item ID, y is order item option ID","example":"Color","type":"string"},"order_item_option_value":{"name":"order_item_option_value_{x}_{y}","description":"Ordered product option value Where x is order item ID, y - order item option ID","example":"green","type":"string"}}}}},"required":["order_item_id","order_item_quantity"]}}},"required":["customer_email","shipp_first_name","shipp_last_name","shipp_address_1","shipp_city","shipp_postcode","shipp_country","order_item"]},"OrderAdd":{"type":"object","properties":{"id":{"name":"id","description":"Defines order's id","example":10,"type":"string"},"order_id":{"name":"order_id","description":"Defines the order id if it is supported by the cart","example":25,"type":"string"},"store_id":{"name":"store_id","description":"Defines store id where the order should be assigned","example":"1","type":"string"},"channel_id":{"name":"channel_id","description":"Channel ID","example":"1","type":"string"},"order_status":{"name":"order_status","description":"Defines order status.","example":"Completed","type":"string"},"fulfillment_status":{"name":"fulfillment_status","description":"Create order with fulfillment status","example":"fulfilled","type":"string"},"financial_status":{"name":"financial_status","description":"Create order with financial status","example":"paid","type":"string"},"customer_email":{"name":"customer_email","description":"Defines the customer specified by email for whom order has to be created","example":"jubari@hannsgroup.com","type":"string"},"customer_first_name":{"name":"customer_first_name","description":"Specifies customer's first name","example":"John","type":"string"},"customer_last_name":{"name":"customer_last_name","description":"Specifies customer\u2019s last name","example":"Smith","type":"string"},"customer_phone":{"name":"customer_phone","description":"Specifies customer\u2019s phone","example":"88008547457","type":"string"},"customer_country":{"name":"customer_country","description":"Specifies customer's address ISO code or name of country","example":"US","type":"string"},"customer_birthday":{"name":"customer_birthday","description":"Specifies customer\u2019s birthday","example":"1990-12-03","type":"string"},"customer_fax":{"name":"customer_fax","description":"Specifies customer\u2019s fax","example":"5656598","type":"string"},"is_guest":{"name":"is_guest","description":"Indicates whether the customer is a guest customer","example":true,"type":"boolean","default":false},"order_payment_method":{"name":"order_payment_method","description":"Defines order payment method.
Setting order_payment_method on Shopify will also change financial_status field value to 'paid'","example":"PayPal","type":"string"},"transaction_id":{"name":"transaction_id","description":"Payment transaction id","example":"d41d8cd98f00b204e9800998ecf8427e","type":"string"},"currency":{"name":"currency","description":"Currency code of order","example":"USD","type":"string"},"date":{"name":"date","description":"Specifies an order creation date in format Y-m-d H:i:s","example":"2012-09-25 19:40:00","type":"string"},"date_modified":{"name":"date_modified","description":"Specifies order's modification date","example":"2014-05-05 05:05:00","type":"string"},"date_finished":{"name":"date_finished","description":"Specifies order's finished date","example":"2014-06-05 05:05:00","type":"string"},"bill_first_name":{"name":"bill_first_name","description":"Specifies billing first name","example":"Adam","type":"string"},"bill_last_name":{"name":"bill_last_name","description":"Specifies billing last name","example":"Smith","type":"string"},"bill_address_1":{"name":"bill_address_1","description":"Specifies first billing address","example":"Green str. 35","type":"string"},"bill_address_2":{"name":"bill_address_2","description":"Specifies second billing address","example":"Red str, 2","type":"string"},"bill_city":{"name":"bill_city","description":"Specifies billing city","example":"Chicago","type":"string"},"bill_postcode":{"name":"bill_postcode","description":"Specifies billing postcode","example":"12345","type":"string"},"bill_state":{"name":"bill_state","description":"Specifies billing state code","example":"IL","type":"string"},"bill_country":{"name":"bill_country","description":"Specifies billing country code","example":"US","type":"string"},"bill_company":{"name":"bill_company","description":"Specifies billing company","example":"Apple","type":"string"},"bill_phone":{"name":"bill_phone","description":"Specifies billing phone","example":"8 800 5659 6896","type":"string"},"bill_fax":{"name":"bill_fax","description":"Specifies billing fax","example":"545 45878","type":"string"},"shipp_first_name":{"name":"shipp_first_name","description":"Specifies shipping first name","example":"John","type":"string"},"shipp_last_name":{"name":"shipp_last_name","description":"Specifies shipping last name","example":"Smith","type":"string"},"shipp_address_1":{"name":"shipp_address_1","description":"Specifies first shipping address","example":"Green str. 35","type":"string"},"shipp_address_2":{"name":"shipp_address_2","description":"Specifies second address line of a shipping street address","example":"Green str. 35","type":"string"},"shipp_city":{"name":"shipp_city","description":"Specifies shipping city","example":"Chicago","type":"string"},"shipp_postcode":{"name":"shipp_postcode","description":"Specifies shipping postcode","example":"24545","type":"string"},"shipp_state":{"name":"shipp_state","description":"Specifies shipping state code","example":"IL","type":"string"},"shipp_country":{"name":"shipp_country","description":"Specifies shipping country code","example":"US","type":"string"},"shipp_company":{"name":"shipp_company","description":"Specifies shipping company","example":"Apple","type":"string"},"shipp_phone":{"name":"shipp_phone","description":"Specifies shipping phone","example":"880086544564","type":"string"},"shipp_fax":{"name":"shipp_fax","description":"Specifies shipping fax","example":"556868","type":"string"},"subtotal_price":{"name":"subtotal_price","description":"Total price of all ordered products multiplied by their number, excluding tax, shipping price and discounts","example":563.23,"type":"number"},"tax_price":{"name":"tax_price","description":"The value of tax cost for order","example":5.5,"type":"number","default":0},"total_price":{"name":"total_price","description":"Defines order's total price","example":23.56,"type":"number"},"total_paid":{"name":"total_paid","description":"Defines total paid amount for the order","example":23.56,"type":"number"},"total_weight":{"name":"total_weight","description":"Defines the sum of all line item weights in grams for the order","example":23,"type":"integer"},"prices_inc_tax":{"name":"prices_inc_tax","description":"Indicates whether prices and subtotal include tax.","example":true,"type":"boolean","default":false},"shipping_price":{"name":"shipping_price","description":"Specifies order's shipping price","example":5.5,"type":"number","default":0},"shipping_tax":{"name":"shipping_tax","description":"Specifies order's shipping price tax","example":5.5,"type":"number"},"discount":{"name":"discount","description":"Specifies order's discount","example":5.5,"type":"number"},"coupon_discount":{"name":"coupon_discount","description":"Specifies order's coupon discount","example":5.5,"type":"number"},"gift_certificate_discount":{"name":"gift_certificate_discount","description":"Discounts for order with gift certificates","example":5.5,"type":"number"},"order_shipping_method":{"name":"order_shipping_method","description":"Defines order shipping method","example":"UPS Ground","type":"string"},"carrier_id":{"name":"carrier_id","description":"Defines tracking carrier id","example":"USPS","type":"string"},"warehouse_id":{"name":"warehouse_id","description":"This parameter is used for selecting a warehouse where you need to set/modify a product quantity.","example":"1","type":"string"},"coupons":{"type":"array","minItems":1,"items":{"type":"string"},"description":"Coupons that will be applied to order"},"tags":{"name":"tags","description":"Order tags","example":"tag1,tag2","type":"string"},"comment":{"name":"comment","description":"Specifies order comment","example":"This coole order","type":"string"},"admin_comment":{"name":"admin_comment","description":"Specifies admin's order comment","example":"Test admin comment","type":"string"},"admin_private_comment":{"name":"admin_private_comment","description":"Specifies private admin's order comment","example":"Test admin private comment","type":"string"},"send_notifications":{"name":"send_notifications","description":"Send notifications to customer after order was created","example":true,"type":"boolean","default":false},"send_admin_notifications":{"name":"send_admin_notifications","description":"Notify admin when new order was created.","example":true,"type":"boolean","default":false},"external_source":{"name":"external_source","description":"Identifying the system used to generate the order","example":"POS","type":"string"},"inventory_behaviour":{"name":"inventory_behaviour","description":"The behaviour to use when updating inventory.
Values description:
bypass = Do not claim inventory

decrement_ignoring_policy = Ignore the product's
inventory policy and claim amounts

decrement_obeying_policy = Obey the product's
inventory policy.

","example":"decrement_ignoring_policy","type":"string","default":"bypass"},"create_invoice":{"name":"create_invoice","description":"Defines whether the invoice is created automatically along with the order","example":true,"type":"boolean","default":false},"note_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"description":"Defines note attributes"},"clear_cache":{"name":"clear_cache","description":"Is cache clear required","example":false,"type":"boolean","default":true},"origin":{"name":"origin","description":"The source of the order","example":"newsletter","type":"string"},"fee_price":{"name":"fee_price","description":"Specifies refund's fee price","example":5.5,"type":"number"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"},"order_item":{"type":"array","items":{"type":"object","properties":{"order_item_id":{"name":"order_item_id_{x}","description":"Defines orders specified by order item id","example":"125, where {x} - 1,2,3,... etc","type":"string"},"order_item_name":{"name":"order_item_name_{x}","description":"Defines orders specified by order item name","example":"Product 1, where {x} - 1,2,3,... etc","type":"string"},"order_item_model":{"name":"order_item_model_{x}","description":"Defines orders specified by order item model","example":"sku_1, where {x} - 1,2,3,... etc","type":"string"},"order_item_price":{"name":"order_item_price_{x}","description":"Defines orders specified by order item price","example":"1.32, where {x} - 1,2,3,... etc","type":"number"},"order_item_quantity":{"name":"order_item_quantity_{x}","description":"Defines orders specified by order item quantity","example":"5, where {x} - 1,2,3,... etc","type":"integer"},"order_item_weight":{"name":"order_item_weight_{x}","description":"Defines orders specified by order item weight","example":"5, where {x} - 1,2,3,... etc","type":"number"},"order_item_variant_id":{"name":"order_item_variant_id_{x}","description":"Ordered product variant. Where x is order item ID","example":52,"type":"string"},"order_item_tax":{"name":"order_item_tax_{x}","description":"Percentage of tax for product order","example":5.5,"type":"number","default":0},"order_item_tax_class":{"name":"order_item_tax_class_{x}","description":"Id of the tax class of product.","example":"standard","type":"string"},"order_item_price_includes_tax":{"name":"order_item_price_includes_tax_{x}","description":"Defines if item price includes tax","example":null,"type":"boolean","default":false},"order_item_parent":{"name":"order_item_parent_{x}","description":"Index of the parent grouped/bundle product","example":2,"type":"integer"},"order_item_parent_option_name":{"name":"order_item_parent_option_name_{x}","description":"Option name of the parent grouped/bundle product","example":"Internal Memory Storage","type":"string"},"order_item_allow_refund_items_separately":{"name":"order_item_allow_refund_items_separately_{x}","description":"Indicates whether subitems of the grouped/bundle product can be refunded separately","example":true,"type":"boolean"},"order_item_allow_ship_items_separately":{"name":"order_item_allow_ship_items_separately_{x}","description":"Indicates whether subitems of the grouped/bundle product can be shipped separately","example":true,"type":"boolean"},"order_item_option":{"type":"array","items":{"type":"object","properties":{"order_item_option_name":{"name":"order_item_option_name_{x}_{y}","description":"Ordered Product Option Name. Where x is order item ID, y is order item option ID","example":"Color","type":"string"},"order_item_option_value":{"name":"order_item_option_value_{x}_{y}","description":"Ordered product option value Where x is order item ID, y - order item option ID","example":"green","type":"string"},"order_item_option_price":{"name":"order_item_option_price_{x}_{y}","description":"Ordered product option price Where x is order item ID, y - order item option ID","example":2.3,"type":"number"}}}},"order_item_property":{"type":"array","items":{"type":"object","properties":{"order_item_property_name":{"name":"order_item_property_name_{x}_{y}","description":"Ordered product property name. Where x is order item ID, y is order item property ID","example":"Engraving","type":"string"},"order_item_property_value":{"name":"order_item_property_value_{x}_{y}","description":"Ordered product property value. Where x is order item ID, y - order item property ID","example":"lorem ipsum","type":"string"}}}}},"required":["order_item_id","order_item_name","order_item_price","order_item_quantity"]}}},"required":["order_status","customer_email","bill_first_name","bill_last_name","bill_address_1","bill_city","bill_postcode","bill_state","bill_country","order_item"]},"Model_Response_Order_Abandoned_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Order_Abandoned_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Order_Abandoned_List_Result":{"type":"object","properties":{"order":{"type":"array","items":{"$ref":"#/components/schemas/OrderAbandoned"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"OrderAbandoned":{"type":"object","properties":{"id":{"type":"string"},"customer":{"$ref":"#/components/schemas/BaseCustomer"},"basket_id":{"type":["string","null"]},"basket_url":{"type":["string","null"]},"created_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"currency":{"$ref":"#/components/schemas/Currency"},"totals":{"$ref":"#/components/schemas/Order_Totals"},"order_products":{"type":"array","items":{"$ref":"#/components/schemas/Order_Item"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Order_PreestimateShipping_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Order_PreestimateShipping_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Order_PreestimateShipping_List_Result":{"type":"object","properties":{"preestimate_shippings_count":{"type":["integer","null"]},"preestimate_shippings":{"type":"array","items":{"$ref":"#/components/schemas/Order_PreestimateShipping"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_PreestimateShipping":{"type":"object","properties":{"method_code":{"type":"string"},"method_name":{"type":["string","null"]},"carrier_code":{"type":["string","null"]},"carrier_name":{"type":["string","null"]},"description":{"type":["string","null"]},"price":{"type":["number","null"]},"price_inc_tax":{"type":["number","null"]},"delivery_time":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"OrderPreestimateShippingList":{"type":"object","properties":{"warehouse_id":{"name":"warehouse_id","description":"This parameter is used for selecting a warehouse where you need to set/modify a product quantity.","example":"1","type":"string"},"customer_id":{"name":"customer_id","description":"Retrieves orders specified by customer id","example":"5","type":"string"},"customer_email":{"name":"customer_email","description":"Retrieves orders specified by customer email","example":"jubari@hannsgroup.com","type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"shipp_address_1":{"name":"shipp_address_1","description":"Specifies first shipping address","example":"Green str. 35","type":"string"},"shipp_city":{"name":"shipp_city","description":"Specifies shipping city","example":"Chicago","type":"string"},"shipp_postcode":{"name":"shipp_postcode","description":"Specifies shipping postcode","example":"24545","type":"string"},"shipp_state":{"name":"shipp_state","description":"Specifies shipping state code","example":"IL","type":"string"},"shipp_country":{"name":"shipp_country","description":"Specifies shipping country code","example":"US","type":"string"},"params":{"name":"params","description":"Set this parameter in order to choose which entity fields you want to retrieve","example":"id,model,price,images","type":"string","default":"force_all"},"exclude":{"name":"exclude","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","example":false,"type":"string"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"},"order_item":{"type":"array","items":{"type":"object","properties":{"order_item_id":{"name":"order_item_id_{x}","description":"Defines orders specified by order item id","example":"125, where {x} - 1,2,3,... etc","type":"string"},"order_item_model":{"name":"order_item_model_{x}","description":"Defines orders specified by order item model","example":"sku_1, where {x} - 1,2,3,... etc","type":"string"},"order_item_quantity":{"name":"order_item_quantity_{x}","description":"Defines orders specified by order item quantity","example":"5, where {x} - 1,2,3,... etc","type":"integer"},"order_item_weight":{"name":"order_item_weight_{x}","description":"Defines orders specified by order item weight","example":"5, where {x} - 1,2,3,... etc","type":"number"},"order_item_variant_id":{"name":"order_item_variant_id_{x}","description":"Ordered product variant. Where x is order item ID","example":52,"type":"string"},"order_item_option":{"type":"array","items":{"type":"object","properties":{"order_item_option_name":{"name":"order_item_option_name_{x}_{y}","description":"Ordered Product Option Name. Where x is order item ID, y is order item option ID","example":"Color","type":"string"},"order_item_option_id":{"name":"order_item_option_id_{x}_{y}","description":"Product Option ID. Where x is order item ID, y is order item option ID","example":"12","type":"string"},"order_item_option_value":{"name":"order_item_option_value_{x}_{y}","description":"Ordered product option value Where x is order item ID, y - order item option ID","example":"green","type":"string"},"order_item_option_value_id":{"name":"order_item_option_value_id_{x}_{y}","description":"Product option value ID, where x is order item ID, y - order item option ID","example":"13","type":"string"},"order_item_option_used_in_combinations":{"name":"order_item_option_used_in_combinations_{x}_{y}","description":"Product option used in combinations flag, where x is order item ID, y - order item option ID","example":null,"type":"boolean"}}}}},"required":["order_item_id","order_item_quantity"]}}},"required":["shipp_country","order_item"]},"OrderRefundAdd":{"type":"object","properties":{"order_id":{"name":"order_id","description":"Defines the order for which the refund will be created.","example":25,"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"order_product_id":{"type":"string"},"quantity":{"type":"integer"},"price":{"type":"number"}}},"description":"Defines items in the order that will be refunded"},"total_price":{"name":"total_price","description":"Defines order refund amount.","example":23.56,"type":"number"},"shipping_price":{"name":"shipping_price","description":"Defines refund shipping amount.","example":5.5,"type":"number"},"fee_price":{"name":"fee_price","description":"Specifies refund's fee price","example":5.5,"type":"number"},"message":{"name":"message","description":"Refund reason, or some else message which assigned to refund.","example":"Received item is not like in the photo, get my money back.","type":"string"},"item_restock":{"name":"item_restock","description":"Boolean, whether or not to add the line items back to the store inventory.","example":true,"type":"boolean","default":false},"send_notifications":{"name":"send_notifications","description":"Send notifications to customer after refund was created","example":true,"type":"boolean","default":false},"date":{"name":"date","description":"Specifies an order creation date in format Y-m-d H:i:s","example":"2012-09-25 19:40:00","type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"is_online":{"name":"is_online","description":"Indicates whether refund type is online","example":false,"type":"boolean","default":false},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}}},"OrderReturnAdd":{"type":"object","properties":{"order_id":{"name":"order_id","description":"Defines the order id","example":25,"type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"return_status_id":{"name":"return_status_id","description":"Defines return request status","example":"RETURNED","type":"string"},"return_action_id":{"name":"return_action_id","description":"Defines return request action","example":"RETURNED","type":"string"},"return_reason_id":{"name":"return_reason_id","description":"Defines return request reason","example":"broken","type":"string"},"return_action":{"name":"return_action","description":"Defines return request action","example":"refund","type":"string"},"return_reason":{"name":"return_reason","description":"Defines return request reason","example":"broken","type":"string"},"item_restock":{"name":"item_restock","description":"Boolean, whether or not to add the line items back to the store inventory.","example":true,"type":"boolean","default":false},"staff_note":{"name":"staff_note","description":"Specifies staff note","example":"Test","type":"string"},"comment":{"name":"comment","description":"Specifies return comment","example":"This coole order","type":"string"},"send_notifications":{"name":"send_notifications","description":"Send notifications to customer after order was created","example":true,"type":"boolean","default":false},"reject_reason":{"name":"reject_reason","description":"Defines return reject reason","example":"ORDER_UNPAID","type":"string"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"},"order_products":{"type":"array","items":{"type":"object","properties":{"order_product_id":{"name":"order_product_id_{x}","description":"Defines which products from the order should be returned","example":"125, where {x} - 1,2,3,... etc","type":"string"},"order_product_quantity":{"name":"order_product_quantity_{x}","description":"Defines how many product units from the order should be returned","example":"1, where {x} - 1,2,3,... etc","type":"integer"},"order_product_reason_id":{"name":"order_product_reason_id_{x}","description":"Defines the ID of the return reason","example":"DEFECTIVE, where {x} - 1,2,3,... etc","type":"string"},"order_product_action_id":{"name":"order_product_action_id_{x}","description":"Defines the ID of the return action","example":"REFUND, where {x} - 1,2,3,... etc","type":"string"},"order_product_customer_comment":{"name":"order_product_customer_comment_{x}","description":"Defines the customer's comment for return","example":"I need a bigger size, where {x} - 1,2,3,... etc","type":"string"},"order_product_handling_status":{"name":"order_product_handling_status_{x}","description":"Defines handling status","example":"123456","type":"string"},"order_product_condition":{"name":"order_product_condition_{x}","description":"Defines the product condition","example":"Broken, where {x} - 1,2,3,... etc","type":"string"},"order_product_reason":{"name":"order_product_reason_{x}","description":"Defines return reason","example":"123456","type":"string"},"order_product_status":{"name":"order_product_status_{x}","description":"Defines product return status","example":"pending","type":"string"}},"required":["order_product_id","order_product_quantity","order_product_reason_id","order_product_action_id"]}}},"required":["return_status_id","return_action_id","return_reason_id","order_products"]},"OrderReturnUpdate":{"type":"object","properties":{"return_id":{"name":"return_id","description":"Return ID","example":"200000002","type":"string"},"order_id":{"name":"order_id","description":"Defines the order id","example":25,"type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"item_restock":{"name":"item_restock","description":"Boolean, whether or not to add the line items back to the store inventory.","example":true,"type":"boolean","default":false},"return_status_id":{"name":"return_status_id","description":"Defines return request status","example":"RETURNED","type":"string"},"staff_note":{"name":"staff_note","description":"Specifies staff note","example":"Test","type":"string"},"comment":{"name":"comment","description":"Specifies return comment","example":"This coole order","type":"string"},"send_notifications":{"name":"send_notifications","description":"Send notifications to customer after order was created","example":true,"type":"boolean","default":false},"reject_reason":{"name":"reject_reason","description":"Defines return reject reason","example":"ORDER_UNPAID","type":"string"},"return_action":{"name":"return_action","description":"Defines return request action","example":"refund","type":"string"},"return_reason":{"name":"return_reason","description":"Defines return request reason","example":"broken","type":"string"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"},"order_products":{"type":"array","items":{"type":"object","properties":{"order_product_id":{"name":"order_product_id_{x}","description":"Defines which products from the order should be returned","example":"125, where {x} - 1,2,3,... etc","type":"string"},"order_product_quantity":{"name":"order_product_quantity_{x}","description":"Defines how many product units from the order should be returned","example":"1, where {x} - 1,2,3,... etc","type":"integer"},"order_product_status":{"name":"order_product_status_{x}","description":"Defines product return status","example":"pending","type":"string"},"order_product_action_id":{"name":"order_product_action_id_{x}","description":"Defines the ID of the return action","example":"REFUND, where {x} - 1,2,3,... etc","type":"string"}},"required":["order_product_id","order_product_quantity","order_product_action_id"]}}},"required":["return_id","order_products"]},"Shipment":{"type":"object","properties":{"id":{"type":"string"},"order_id":{"type":"string"},"name":{"type":["string","null"]},"warehouse_id":{"type":["string","null"]},"shipment_provider":{"type":["string","null"]},"tracking_numbers":{"type":"array","items":{"$ref":"#/components/schemas/Shipment_TrackingNumber"}},"created_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"items":{"type":"array","items":{"$ref":"#/components/schemas/Shipment_Item"}},"is_shipped":{"type":["boolean","null"]},"delivered_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Shipment_TrackingNumber":{"type":"object","properties":{"carrier_id":{"type":["string","null"]},"tracking_number":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Shipment_Item":{"type":"object","properties":{"order_product_id":{"type":["string","null"]},"product_id":{"type":["string","null"]},"variant_id":{"type":["string","null"]},"model":{"type":["string","null"]},"name":{"type":["string","null"]},"price":{"type":["number","null"]},"quantity":{"type":["number","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Order_Shipment_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Order_Shipment_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Order_Shipment_List_Result":{"type":"object","properties":{"shipment_count":{"type":["integer","null"]},"shipment":{"type":"array","items":{"$ref":"#/components/schemas/Shipment"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"OrderShipmentAdd":{"type":"object","properties":{"order_id":{"name":"order_id","description":"Defines the order for which the shipment will be created","example":25,"type":"string"},"warehouse_id":{"name":"warehouse_id","description":"This parameter is used for selecting a warehouse where you need to set/modify a product quantity.","example":"1","type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"shipment_provider":{"name":"shipment_provider","description":"Defines company name that provide tracking of shipment","example":"UPS","type":"string"},"shipping_method":{"name":"shipping_method","description":"Define shipping method","example":"flatrate_flatrate","type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"order_product_id":{"type":"string"},"quantity":{"type":"number"}}},"description":"Defines items in the order that will be shipped"},"tracking_numbers":{"type":"array","items":{"type":"object","properties":{"carrier_id":{"type":"string"},"tracking_number":{"type":"string"}}},"description":"Defines shipment's tracking numbers that have to be added
How set tracking numbers to appropriate carrier:To get the list of carriers IDs that are available in your store, use the cart.info method"},"tracking_link":{"name":"tracking_link","description":"Defines custom tracking link","example":"http://example.com?someParam=value","type":"string"},"is_shipped":{"name":"is_shipped","description":"Defines shipment's status","example":true,"type":"boolean","default":true},"send_notifications":{"name":"send_notifications","description":"Send notifications to customer after shipment was created","example":true,"type":"boolean","default":false},"adjust_stock":{"name":"adjust_stock","description":"This parameter is used for adjust stock.","example":true,"type":"boolean","default":false},"enable_cache":{"name":"enable_cache","description":"If the value is 'true' and order exist in our cache, we will use order.info from cache to prepare shipment items.","example":true,"type":"boolean","default":false},"check_process_status":{"name":"check_process_status","description":"Disable or enable check process status. Please note that the response will be slower due to additional requests to the store.","example":false,"type":"boolean","default":false},"tracking_provider":{"name":"tracking_provider","description":"Defines name of the company which provides shipment tracking","example":"Custom tracker","type":"string"},"use_latest_api_version":{"name":"use_latest_api_version","description":"Use the latest platform API version","example":true,"type":"boolean","default":false},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}}},"OrderShipmentAddBatch":{"type":"object","properties":{"payload":{"type":"array","minItems":1,"maxItems":250,"description":"Contains an array of order shipment objects. The list of properties may vary depending on the specific platform.","items":{"type":"object","properties":{"order_id":{"type":"string"},"store_id":{"type":"string"},"warehouse_id":{"type":"string"},"carrier_id":{"type":"string","x-conflictWith":["carrier_name","tracking_link"]},"carrier_name":{"type":"string","x-conflictWith":["carrier_id"]},"tracking_number":{"type":"string"},"tracking_link":{"type":"string","x-conflictWith":["carrier_id"]},"shipment_provider":{"type":"string"},"items":{"type":"array","minItems":1,"items":{"type":"object","properties":{"order_product_id":{"type":"string"},"quantity":{"type":"number"}},"required":["order_product_id","quantity"]}},"send_notifications":{"type":"boolean"}},"required":["order_id","tracking_number"]}},"idempotency_key":{"type":"string","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes."}},"required":["payload"]},"OrderShipmentUpdate":{"type":"object","properties":{"shipment_id":{"name":"shipment_id","description":"Shipment id indicates the number of delivery","example":"200000002","type":"string"},"order_id":{"name":"order_id","description":"Defines the order that will be updated","example":25,"type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"shipment_provider":{"name":"shipment_provider","description":"Defines company name that provide tracking of shipment","example":"UPS","type":"string"},"tracking_numbers":{"type":"array","items":{"type":"object","properties":{"carrier_id":{"type":"string"},"tracking_number":{"type":"string"}}},"description":"Defines shipment's tracking numbers that have to be added
How set tracking numbers to appropriate carrier:To get the list of carriers IDs that are available in your store, use the cart.info method"},"tracking_link":{"name":"tracking_link","description":"Defines custom tracking link","example":"http://example.com?someParam=value","type":"string"},"is_shipped":{"name":"is_shipped","description":"Defines shipment's status","example":true,"type":"boolean","default":true},"delivered_at":{"name":"delivered_at","description":"Defines the date of delivery","example":"2024-08-25T23:56:12+00:00","type":"string"},"replace":{"name":"replace","description":"Allows rewrite tracking numbers","example":false,"type":"boolean","default":true},"send_notifications":{"name":"send_notifications","description":"Send notifications to customer after order was created","example":true,"type":"boolean","default":false},"tracking_provider":{"name":"tracking_provider","description":"Defines name of the company which provides shipment tracking","example":"Custom tracker","type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"order_product_id":{"type":"string"},"quantity":{"type":"number"}}},"description":"Defines items in the order that will be shipped"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["shipment_id"]},"Model_Response_Order_Shipment_Event_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Order_Shipment_Event_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Order_Shipment_Event_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"events":{"type":"array","items":{"$ref":"#/components/schemas/Shipment_Event"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Shipment_Event":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"created_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"estimated_delivery_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"message":{"type":["string","null"]},"address":{"anyOf":[{"$ref":"#/components/schemas/Customer_Address"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"OrderShipmentEventAdd":{"type":"object","properties":{"shipment_id":{"name":"shipment_id","description":"Defines the shipment to which the tracking event will be added","example":"200000002","type":"string"},"order_id":{"name":"order_id","description":"Defines the order to which the shipment belongs","example":25,"type":"string"},"status":{"name":"status","description":"Defines the tracking event status (e.g. in_transit, delivered, out_for_delivery)","example":"disabled","type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"address_1":{"name":"address_1","description":"Specifies the street address of the event location","example":"1234 Main St","type":"string"},"city":{"name":"city","description":"Specifies city","example":"Chicago","type":"string"},"country":{"name":"country","description":"Specifies ISO code or name of country","example":"US","type":"string"},"state":{"name":"state","description":"Specifies ISO code or name of state","example":"IL","type":"string"},"postcode":{"name":"postcode","description":"Specifies postcode","example":"12345","type":"string"},"message":{"name":"message","description":"Defines a message associated with the tracking event.","example":"Package has arrived at the sorting facility.","type":"string"},"latitude":{"name":"latitude","description":"Latitude coordinate of the event location.","example":"-34.6037","type":"number"},"longitude":{"name":"longitude","description":"Longitude coordinate of the event location.","example":"-58.3816","type":"number"},"created_at":{"name":"created_at","description":"Defines the date of entity creation","example":"2014-08-09 13:13:13","type":"string"},"estimated_delivery_at":{"name":"estimated_delivery_at","description":"Estimated delivery date and time in ISO 8601 format.","example":"2025-03-15T10:00:00-03:00","type":"string"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["shipment_id","status"]},"OrderShipmentTrackingAdd":{"type":"object","properties":{"order_id":{"name":"order_id","description":"Defines the order id","example":25,"type":"string"},"shipment_id":{"name":"shipment_id","description":"Shipment id indicates the number of delivery","example":"200000002","type":"string"},"carrier_id":{"name":"carrier_id","description":"Defines tracking carrier id","example":"USPS","type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"tracking_provider":{"name":"tracking_provider","description":"Defines name of the company which provides shipment tracking","example":"Custom tracker","type":"string"},"tracking_number":{"name":"tracking_number","description":"Defines tracking number","example":"1\u04106745","type":"string"},"tracking_link":{"name":"tracking_link","description":"Defines custom tracking link","example":"http://example.com?someParam=value","type":"string"},"send_notifications":{"name":"send_notifications","description":"Send notifications to customer after tracking was created","example":true,"type":"boolean","default":false},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["shipment_id","tracking_number"]},"Model_Response_Order_Status_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Order_Status_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Order_Status_List_Result":{"type":"object","properties":{"cart_order_statuses":{"type":"array","items":{"$ref":"#/components/schemas/Status"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Status":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Order_Transaction_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Order_Transaction_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Order_Transaction_List_Result":{"type":"object","properties":{"transactions_count":{"type":["integer","null"]},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Order_Transaction"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Order_Transaction":{"type":"object","properties":{"id":{"type":"string"},"transaction_id":{"type":["string","null"]},"order_id":{"type":"string"},"parent_id":{"type":["string","null"]},"description":{"type":["string","null"]},"status":{"type":["string","null"]},"gateway":{"type":["string","null"]},"reference_number":{"type":["string","null"]},"currency":{"type":["string","null"]},"amount":{"type":["number","null"]},"created_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"settlement_currency":{"type":["string","null"]},"settlement_amount":{"type":["number","null"]},"settlement_created_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"card_brand":{"type":["string","null"]},"card_bin":{"type":["string","null"]},"card_last_four":{"type":["string","null"]},"avs_street_resp_code":{"type":["string","null"]},"avs_postal_resp_code":{"type":["string","null"]},"avs_message":{"type":["string","null"]},"cvv_code":{"type":["string","null"]},"cvv_message":{"type":["string","null"]},"is_test_mode":{"type":["boolean","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Product":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":["string","null"]},"u_model":{"type":["string","null"]},"u_sku":{"type":["string","null"]},"name":{"type":["string","null"]},"description":{"type":["string","null"]},"short_description":{"type":["string","null"]},"price":{"type":["number","null"]},"advanced_price":{"type":"array","items":{"$ref":"#/components/schemas/Product_AdvancedPrice"}},"cost_price":{"type":["number","null"]},"unit_price":{"type":["number","null"]},"measure_unit":{"type":["string","null"]},"quantity":{"type":["number","null"]},"inventory":{"type":"array","items":{"$ref":"#/components/schemas/Product_Inventory"}},"group_items":{"type":"array","items":{"$ref":"#/components/schemas/Product_GroupItem"}},"u_brand_id":{"type":["string","null"]},"u_brand":{"type":["string","null"]},"categories_ids":{"type":"array","items":{"type":"string"}},"stores_ids":{"type":"array","items":{"type":"string"}},"url":{"type":["string","null"]},"seo_url":{"type":["string","null"]},"meta_title":{"type":["string","null"]},"meta_keywords":{"type":["string","null"]},"meta_description":{"type":["string","null"]},"avail_sale":{"type":["boolean","null"]},"avail_view":{"type":["boolean","null"]},"is_virtual":{"type":["boolean","null"]},"is_downloadable":{"type":["boolean","null"]},"weight":{"type":["number","null"]},"weight_unit":{"type":["string","null"]},"sort_order":{"type":["integer","null"]},"in_stock":{"type":["boolean","null"]},"backorders":{"type":["string","null"]},"manage_stock":{"type":["string","null"]},"is_stock_managed":{"type":["boolean","null"]},"on_sale":{"type":["boolean","null"]},"create_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"tax_class_id":{"type":["string","null"]},"special_price":{"anyOf":[{"$ref":"#/components/schemas/SpecialPrice"},{"type":"null"}]},"tier_price":{"type":"array","items":{"$ref":"#/components/schemas/Product_TierPrice"}},"group_price":{"type":"array","items":{"$ref":"#/components/schemas/Product_GroupPrice"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"}},"product_options":{"type":"array","items":{"$ref":"#/components/schemas/Product_Option"}},"u_upc":{"type":["string","null"]},"u_mpn":{"type":["string","null"]},"u_gtin":{"type":["string","null"]},"u_isbn":{"type":["string","null"]},"u_ean":{"type":["string","null"]},"related_products_ids":{"type":"array","items":{"type":"string"}},"up_sell_products_ids":{"type":"array","items":{"type":"string"}},"cross_sell_products_ids":{"type":"array","items":{"type":"string"}},"dimensions_unit":{"type":["string","null"]},"width":{"type":["number","null"]},"height":{"type":["number","null"]},"length":{"type":["number","null"]},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Product_AdvancedPrice":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"number"},"avail":{"type":["boolean","null"]},"group_id":{"type":["string","null"]},"quantity_from":{"type":["number","null"]},"start_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"expire_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Product_Inventory":{"type":"object","properties":{"warehouse_id":{"type":"string"},"quantity":{"type":"number"},"in_stock":{"type":["boolean","null"]},"priority":{"type":["integer","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Product_GroupItem":{"type":"object","properties":{"child_item_id":{"type":["string","null"]},"product_id":{"type":"string"},"default_qty_in_pack":{"type":"number"},"is_qty_in_pack_fixed":{"type":["boolean","null"]},"price":{"type":["number","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"SpecialPrice":{"type":"object","properties":{"value":{"type":"number"},"avail":{"type":"boolean"},"created_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"expired_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Product_TierPrice":{"type":"object","properties":{"qty":{"type":"number"},"price":{"type":"number"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Product_GroupPrice":{"type":"object","properties":{"id":{"type":["string","null"]},"group_id":{"type":"string"},"price":{"type":"number"},"store_id":{"type":["string","null"]},"quantity":{"type":["number","null"]},"start_time":{"type":["string","null"]},"expire_time":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Discount":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"modifier_type":{"type":"string"},"value":{"type":"number"},"from_time":{"type":["string","null"]},"to_time":{"type":["string","null"]},"customer_group_ids":{"type":["string","null"]},"sort_order":{"type":["integer","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Product_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Product_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Product_List_Result":{"type":"object","properties":{"products_count":{"type":["integer","null"]},"product":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"ProductAdd":{"type":"object","properties":{"name":{"name":"name","description":"Defines product's name that has to be added","example":"Bag","type":"string"},"model":{"name":"model","description":"Defines product's model that has to be added","example":"bag_01","type":"string"},"description":{"name":"description","description":"Defines product's description that has to be added","example":"Product description","type":"string"},"price":{"name":"price","description":"Defines product's price that has to be added","example":99.9,"type":"number"},"sku":{"name":"sku","description":"Defines product's sku that has to be added","example":"bag_01","type":"string"},"short_description":{"name":"short_description","description":"Defines short description","example":"Short description. This is very short description","type":"string"},"type":{"name":"type","description":"Defines product's type","example":"configurable","type":"string","default":"simple"},"status":{"name":"status","description":"Defines product's status","example":"disabled","type":"string"},"visible":{"name":"visible","description":"Set visibility status","example":"search","type":"string"},"category_id":{"name":"category_id","description":"Defines product add that is specified by category id","example":6,"type":"string"},"categories_ids":{"name":"categories_ids","description":"Defines product add that is specified by comma-separated categories id","example":"23,56","type":"string"},"product_class":{"name":"product_class","description":"A categorization for the product","example":"Shirts","type":"string"},"product_type":{"name":"product_type","description":"A categorization for the product","example":"BICYCLE","type":"string"},"is_virtual":{"name":"is_virtual","description":"Defines whether the product is virtual","example":false,"type":"boolean","default":false},"downloadable":{"name":"downloadable","description":"Defines whether the product is downloadable","example":true,"type":"boolean","default":false},"is_supply":{"name":"is_supply","description":"If true, it indicates the product as a supply, otherwise it indicates that it is a finished product.","example":false,"type":"boolean","default":true},"available_for_view":{"name":"available_for_view","description":"Specifies the set of visible/invisible products for users","example":false,"type":"boolean","default":true},"available_for_sale":{"name":"available_for_sale","description":"Specifies the set of visible/invisible products for sale","example":false,"type":"boolean","default":true},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"stores_ids":{"name":"stores_ids","description":"Assign product to the stores that is specified by comma-separated stores' id","example":"1,2","type":"string"},"lang_id":{"name":"lang_id","description":"Language id","example":3,"type":"string"},"old_price":{"name":"old_price","description":"Defines product's old price","example":99.9,"type":"number"},"special_price":{"name":"special_price","description":"Defines product's model that has to be added","example":56.9,"type":"number"},"wholesale_price":{"name":"wholesale_price","description":"This parameter is deprecated. Please use the old_price parameter instead.","example":56.12,"type":"number"},"cost_price":{"name":"cost_price","description":"Defines new product's cost price","example":65.9,"type":"number"},"fixed_cost_shipping_price":{"name":"fixed_cost_shipping_price","description":"Specifies product's fixed cost shipping price","example":5.5,"type":"number"},"tier_prices":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"number"},"price":{"type":"number"}}},"description":"Defines product's tier prices"},"group_prices":{"type":"array","items":{"type":"object","properties":{"group_id":{"type":"string"},"price":{"type":"number"},"qty":{"type":"integer"}}},"description":"Defines product's group prices"},"buyitnow_price":{"name":"buyitnow_price","description":"Defines buy it now value","example":65.9,"type":"number"},"reserve_price":{"name":"reserve_price","description":"Defines reserve price value","example":65.9,"type":"number"},"measure_unit":{"name":"measure_unit","description":"Unit for the price per unit. Must be in allowed list","example":"Piece","type":"string"},"unit_price":{"name":"unit_price","description":"Defines new product's unit price","example":10.5,"type":"number"},"prices_inc_tax":{"name":"prices_inc_tax","description":"Indicates whether prices include tax.","example":true,"type":"boolean","default":false},"retail_price":{"name":"retail_price","description":"Defines new product's retail price","example":6.9,"type":"number"},"quantity":{"name":"quantity","description":"Defines product's quantity that has to be added","example":6,"type":"number","default":0},"in_stock":{"name":"in_stock","description":"Set stock status","example":true,"type":"boolean"},"manage_stock":{"name":"manage_stock","description":"Defines inventory tracking for product","example":false,"type":"boolean"},"warehouse_id":{"name":"warehouse_id","description":"This parameter is used for selecting a warehouse where you need to set/modify a product quantity.","example":"1","type":"string"},"backorder_status":{"name":"backorder_status","description":"Set backorder status","example":"true","type":"string"},"min_order_quantity":{"name":"min_order_quantity","description":"The minimum quantity an order must contain, to be eligible to purchase this product.","example":1,"type":"number"},"max_order_quantity":{"name":"max_order_quantity","description":"The maximum quantity an order can contain when purchasing the product.","example":1,"type":"number"},"low_stock_threshold":{"name":"low_stock_threshold","description":"Specify the quantity threshold below which the product is considered low in stock","example":1,"type":"number"},"weight":{"name":"weight","description":"Weight","example":23.69,"type":"number","default":0},"weight_unit":{"name":"weight_unit","description":"Weight Unit","example":"lb","type":"string"},"width":{"name":"width","description":"Defines product's width","example":56.12,"type":"number"},"height":{"name":"height","description":"Defines product's height","example":56.12,"type":"number"},"length":{"name":"length","description":"Defines product's length","example":56.12,"type":"number"},"dimensions_unit":{"name":"dimensions_unit","description":"Weight Unit","example":"cm","type":"string"},"barcode":{"name":"barcode","description":"A barcode is a unique code composed of numbers used as a product identifier.","example":"9770317847001","type":"string"},"upc":{"name":"upc","description":"Universal Product Code. A UPC (UPC-A) is a commonly used identifer for many different products.","example":"9770317847001","type":"string"},"ean":{"name":"ean","description":"European Article Number. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products.","example":"5901234123457","type":"string"},"isbn":{"name":"isbn","description":"International Standard Book Number. An ISBN is a unique identifier for books.","example":"9783161484100","type":"string"},"gtin":{"name":"gtin","description":"Global Trade Item Number. An GTIN is an identifier for trade items.","example":"12345678912345","type":"string"},"mpn":{"name":"mpn","description":"Manufacturer Part Number. A MPN is an identifier of a particular part design or material used.","example":"9770317847001","type":"string"},"asin":{"name":"asin","description":"Amazon Standard Identification Number.","example":"97703178470","type":"string"},"product_reference":{"name":"product_reference","description":"Groups all variations, that you want to combine into one product.","example":"5901234123457","type":"string"},"external_product_link":{"name":"external_product_link","description":"External product link","example":"http://example.com/t-shirt","type":"string"},"harmonized_system_code":{"name":"harmonized_system_code","description":"Harmonized System Code. An HSC is a 6-digit identifier that allows participating countries to classify traded goods on a common basis for customs purposes","example":"123456","type":"string"},"country_of_origin":{"name":"country_of_origin","description":"The country where the inventory item was made","example":"123456","type":"string"},"manufacturer":{"name":"manufacturer","description":"Defines product's manufacturer","example":"Samsung","type":"string"},"manufacturer_id":{"name":"manufacturer_id","description":"Defines product's manufacturer by manufacturer_id","example":"1","type":"string"},"manufacturer_info":{"type":"object","properties":{"name":{"type":"string","description":"Defines manufacturer`s name","minLength":1},"address":{"type":"string","description":"Defines manufacturer`s address","minLength":1},"phone":{"type":"string","description":"Defines manufacturer`s phone","minLength":1},"email":{"type":"string","description":"Defines manufacturer`s email","minLength":1}},"description":"Manufacturer information."},"brand_name":{"name":"brand_name","description":"Defines product brand name","example":"Abidas","type":"string"},"image_url":{"name":"image_url","description":"Image Url","example":"https://docs.api2cart.com/img/logo.png","type":"string"},"image_name":{"name":"image_name","description":"Defines image's name","example":"abibas.png","type":"string"},"additional_image_urls":{"type":"array","items":{"type":"string","format":"uri"},"description":"Image Url"},"files":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"required":["name","url"]},"description":"File Url"},"size_chart":{"type":"object","properties":{"id":{"type":"string","description":"Defines a pre-generated size chart template","x-conflictWith":["url"],"minLength":1},"url":{"type":"string","description":"Defines a size chart image URL","x-conflictWith":["id"],"minLength":1}},"description":"A size chart for the product. Only one property is supported."},"related_products_ids":{"name":"related_products_ids","description":"Defines product's related products ids that has to be added","example":"4,5","type":"string"},"up_sell_products_ids":{"name":"up_sell_products_ids","description":"Defines product's up-sell products ids that has to be added","example":"4,5","type":"string"},"cross_sell_products_ids":{"name":"cross_sell_products_ids","description":"Defines product's cross-sell products ids that has to be added","example":"4,5","type":"string"},"attribute_set_name":{"name":"attribute_set_name","description":"Defines product\u2019s attribute set name in Magento","example":"Shoes","type":"string","default":"Default"},"attribute_name":{"name":"attribute_name","description":"Defines product\u2019s attribute name separated with a comma in Magento","example":"Color,Manufacturer","type":"string"},"search_keywords":{"name":"search_keywords","description":"Defines unique search keywords","example":"key1,key2,key3","type":"string"},"tags":{"name":"tags","description":"Product tags","example":"tag1,tag2","type":"string"},"materials":{"name":"materials","description":"A list of material strings for materials used in the product.","example":"materials[0]=Aluminum&materials[1]=Brass","type":"array","items":{"type":"string"}},"certifications":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Certification ID","type":"string"},"images":{"description":"Certification images","type":"array","items":{"type":"object","properties":{"url":{"description":"Image URL","type":"string"}},"required":["url"]}},"files":{"description":"Certification files","type":"array","items":{"type":"object","properties":{"url":{"description":"File URL","type":"string"}},"required":["url"]}}},"required":["id"]},"description":"An array of product certifications. The list of possible certifications can be obtained using the \"category.info\" method (additional_fields->rules->product_certifications)."},"specifics":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string","x-conflictWith":["values"]},"values":{"type":"array","minItems":1,"items":{"type":"string"},"x-conflictWith":["value"]},"used_for_variations":{"type":"boolean","default":false},"scale_id":{"type":["integer","null"],"default":null},"input_value":{"type":["string","null"],"default":null},"food_details":{"type":"object","properties":{"calories":{"type":"number"}},"required":["calories"]},"group_products_details":{"type":"array","minItems":1,"items":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"integer","minimum":1}},"required":["id","quantity"]}},"booking_details":{"type":"object","properties":{"location":{"minLength":1,"type":"string"},"type":{"type":"string","enum":["date","date_time"]},"session_duration":{"type":"integer"},"session_gap":{"type":"integer"},"sessions_count":{"type":"integer"},"time_strict_value":{"type":"number"},"time_strict_type":{"type":"string","enum":["days","hours","minutes"],"default":"days"},"availabilities":{"type":"array","minItems":1,"items":{"type":"object","properties":{"day":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"]},"is_available":{"type":"boolean","default":true},"times":{"type":"array","minItems":1,"items":{"type":"object","properties":{"from":{"description":"The starting time of the of available booking slot in 24 hours format. Required if type=date_time","type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$"},"to":{"description":"The ending time of the of available booking slot in 24 hours format. Required if type=date_time","type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$"}},"required":["from","to"]}}},"required":["day"]}},"overrides":{"type":"array","minItems":1,"items":{"type":"object","properties":{"day":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"]},"date":{"type":"string","pattern":"^(19|20)\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"}},"required":["day","date"]}}},"required":["location","type","sessions_count","time_strict_type","time_strict_value","availabilities"]}}},"description":"An array of Item Specific Name/Value pairs used by the seller to provide descriptive details of an item in a structured manner.\n The list of possible specifications can be obtained using the category.info method (additional_fields->product_specifics).\n The structure of the parameter is different for specific platforms."},"avail_from":{"name":"avail_from","description":"Allows to schedule a time in the future that the item becomes available. The value should be greater than the current date and time.","example":"2029-10-25T15:54:37-0500","type":"string"},"sprice_create":{"name":"sprice_create","description":"Defines the date of special price creation","example":"2018-08-25 23:56:12","type":"string"},"sprice_modified":{"name":"sprice_modified","description":"Defines the date of special price modification","example":"2018-12-05 13:46:20","type":"string"},"sprice_expire":{"name":"sprice_expire","description":"Defines the term of special price offer duration","example":"2018-08-25 23:56:12","type":"string"},"created_at":{"name":"created_at","description":"Defines the date of entity creation","example":"2014-08-09 13:13:13","type":"string"},"auto_renew":{"name":"auto_renew","description":"When true, automatically renews a listing upon its expiration.","example":false,"type":"boolean","default":false},"when_made":{"name":"when_made","description":"An enumerated string for the era in which the maker made the product.","example":"2020_2025","type":"string","default":"made_to_order"},"meta_title":{"name":"meta_title","description":"Defines unique meta title for each entity","example":"category,test","type":"string"},"meta_keywords":{"name":"meta_keywords","description":"Defines unique meta keywords for each entity","example":"category,test","type":"string"},"meta_description":{"name":"meta_description","description":"Defines unique meta description of a entity","example":"category,test","type":"string"},"url":{"name":"url","description":"Defines unique product's URL","example":"/product_slug","type":"string"},"seo_url":{"name":"seo_url","description":"Defines unique URL for SEO","example":"some seo url","type":"string"},"tax_class_id":{"name":"tax_class_id","description":"Defines tax classes where entity has to be added","example":9,"type":"string"},"taxable":{"name":"taxable","description":"Specifies whether a tax is charged","example":false,"type":"boolean","default":true},"sales_tax":{"type":"object","properties":{"tax_percent":{"type":"number"},"tax_state":{"type":"string"},"shipping_inc_in_tax":{"type":"boolean"}},"description":"Percent of an item's price to be charged as the sales tax for the order. Look at cart.info method response for allowed values.
Param structure:
sales_tax[tax_percent] = decimal (##.###)
sales_tax[tax_state] = string
sales_tax[shipping_inc_in_tax] = bool
"},"condition":{"name":"condition","description":"The human-readable label for the condition (e.g., \"New\").","example":"Like New","type":"string"},"condition_description":{"name":"condition_description","description":"Detailed description of the product condition.","example":"Almost perfect condition, a few scratches","type":"string"},"allow_display_condition":{"name":"allow_display_condition","description":"Flag used to determine whether the product condition is shown to the customer on the product page.","example":false,"type":"boolean"},"payment_methods":{"name":"payment_methods","description":"Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. Look at cart.info method response for allowed values.
Param structure:
payment_methods[0] = string
payment_methods[1] = string
","example":"payment_methods[0]=CashOnPickup&payment_methods[1]=PayPal","type":"array","items":{"type":"string"}},"paypal_email":{"name":"paypal_email","description":"Valid PayPal email address for the PayPal account that the seller will use if they offer PayPal as a payment method for the listing.","example":"paypall@mail.com","type":"string"},"shipping_template_id":{"name":"shipping_template_id","description":"The numeric ID of the shipping template associated with the products in Etsy. You can find possible values in the \"cart.info\" API method response, in the field shipping_zones[]->id.","example":40256592690,"type":"integer","default":0},"processing_profile_id":{"name":"processing_profile_id","description":"The numeric ID of the processing profile (readiness state) for physical products in Etsy. You can find possible values in the \"cart.info\" API method response, in the field processing_profiles[]->readiness_state_id.","example":"`12345678`","type":"integer"},"shipping_details":{"type":"array","items":{"type":"object","properties":{"shipping_type":{"type":"string"},"shipping_service":{"type":"string"},"shipping_cost":{"type":"number"}}},"description":"The shipping details, including flat and calculated shipping costs and shipping insurance costs. Look at cart.info method response for allowed values.
Param structure:
shipping_details[0][shipping_type] = string
shipping_details[0][shipping_service] = string
shipping_details[0][shipping_cost] = decimal
shipping_details[1][shipping_type] = string
shipping_details[1][shipping_service] = string
shipping_details[1][shipping_cost] = decimal
"},"is_free_shipping":{"name":"is_free_shipping","description":"Specifies product's free shipping flag that has to be added","example":true,"type":"boolean"},"delivery_code":{"name":"delivery_code","description":"The delivery promise that applies to offer","example":"24uurs-23","type":"string"},"delivery_type":{"name":"delivery_type","description":"Defines the type of the delivery.","example":"PARCEL","type":"string"},"delivery_time":{"name":"delivery_time","description":"Defines delivery time in days.","example":1,"type":"integer"},"delivery_option_ids":{"name":"delivery_option_ids","description":"Defines delivery options for product by ids.","example":"6956548250505111111,6956548250505111112","type":"string"},"package_details":{"type":"object","properties":{"measure_unit":{"type":"string"},"weigh_unit":{"type":"string"},"package_depth":{"type":"number"},"package_length":{"type":"number"},"package_width":{"type":"number"},"weight_major":{"type":"number"},"weight_minor":{"type":"number"},"shipping_package":{"type":"string"}},"description":"If the seller is subscribed to \"Business Policies\", use the seller_profiles instead of the shipping_details, payment_methods and return_accepted params.
Param structure:
package_details[measure_unit] = string
Allowed measure_unit values: [English or Metric]
Default: Metric
package_details[weigh_unit] = string
Allowed weigh_unit values: [kg, g, lbs, oz]
package_details[package_depth] = decimal
package_details[package_length] = decimal
package_details[package_width] = decimal
package_details[weight_major] = decimal
package_details[weight_minor] = decimal
package_details[shipping_package] = string
See cart.info method, param `eBay_shipping_package_details`
"},"logistic_info":{"type":"array","items":{"type":"object","properties":{"logistic_id":{"type":"number"},"is_free":{"type":"boolean"},"shipping_fee":{"type":"number"},"size_id":{"type":"number"}},"required":["logistic_id"]},"description":"Defines product's logistic channel settings"},"listing_duration":{"name":"listing_duration","description":"Describes the number of days the seller wants the listing to be active. Look at cart.info method response for allowed values.","example":"Days_3","type":"string"},"listing_type":{"name":"listing_type","description":"Indicates the selling format of the marketplace listing.","example":"Auction","type":"string","default":"FixedPrice"},"category_type":{"name":"category_type","description":"Specifies the type of category (e.g., apparel or other) for the product being added.","example":"Apparel","type":"string"},"return_accepted":{"name":"return_accepted","description":"Indicates whether the seller allows the buyer to return the item.","example":true,"type":"boolean"},"seller_profiles":{"type":"object","properties":{"shipping_profile_id":{"type":"string"},"payment_profile_id":{"type":"string"},"return_profile_id":{"type":"string"}},"description":"If the seller is subscribed to \"Business Policies\", use the seller_profiles instead of the shipping_details, payment_methods and return_accepted params.
Param structure:
seller_profiles[shipping_profile_id] = string
seller_profiles[payment_profile_id] = string
seller_profiles[return_profile_id] = string
"},"auction_confidentiality_level":{"name":"auction_confidentiality_level","description":"This allows buyers to remain anonymous when the bid or buy an item.","example":"public","type":"string"},"best_offer":{"type":"object","properties":{"minimum_offer_price":{"type":"number"},"auto_accept_price":{"type":"number"}},"description":"The price at which Best Offers are automatically accepted.
Param structure:
best_offer[minimum_offer_price] = decimal
best_offer[auto_accept_price] = decimal
"},"production_partner_ids":{"name":"production_partner_ids","description":"Defines product's production partner ids that has to be added","example":"4,5","type":"string"},"marketplace_item_properties":{"name":"marketplace_item_properties","description":"String containing the JSON representation of the supplied data","example":"{\"color\":[\"Silver\"],\"manufacturer\":\"Philips\",\"features\":[\"3 way\"],\"countPerPack\":1,\"watts\":{\"unit\":\"W\",\"measure\":40}}","type":"string"},"clear_cache":{"name":"clear_cache","description":"Is cache clear required","example":false,"type":"boolean","default":true},"viewed_count":{"name":"viewed_count","description":"Specifies the number of product's reviews","example":9,"type":"integer","default":0},"ordered_count":{"name":"ordered_count","description":"Defines how many times the product was ordered","example":15,"type":"integer","default":0},"vendor_id":{"name":"vendor_id","description":"Vendor Id","example":"1","type":"string"},"shop_section_id":{"name":"shop_section_id","description":"Add Shop Section Id","example":12345678,"type":"integer"},"return_policy_id":{"name":"return_policy_id","description":"Add Return Policy Id","example":"`12345678`","type":"integer"},"personalization_details":{"type":"object","properties":{"is_personalizable":{"type":"boolean"},"personalization_is_required":{"type":"boolean"},"personalization_char_count_max":{"type":"integer","minValue":1,"maxValue":1024},"personalization_instructions":{"type":"string","minLength":1,"maxLength":256}},"required":["is_personalizable"],"description":"Deprecated. Use personalization_questions instead for setting personalization questions. Defines legacy personalization settings for the listing. To enable personalization, is_personalizable must be set to true. When enabled, additional fields may be used to configure the personalization experience, including whether it is required (personalization_is_required), the maximum character limit (personalization_char_count_max), and buyer instructions (personalization_instructions). All related fields are only applicable if personalization is enabled."},"personalization_questions":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"object","properties":{"question_text":{"type":"string","minLength":1,"maxLength":45},"instructions":{"type":"string","minLength":1,"maxLength":120},"question_type":{"type":"string","enum":["text_input","dropdown","unlabeled_upload","labeled_upload"]},"required":{"type":"boolean"},"max_allowed_characters":{"type":["integer","null"],"minimum":1,"maximum":1024},"max_allowed_files":{"type":["integer","null"],"minimum":1,"maximum":10},"options":{"type":["array","null"],"minItems":1,"maxItems":30,"items":{"type":"string","minLength":1,"maxLength":45}}},"required":["question_text","question_type","required"]},"description":"Defines personalization questions for the listing as an array of question objects. Each question object supports the following fields: question_id (integer, nullable), question_text (string, 1-45 chars), instructions (string, nullable), question_type (string), required (boolean), max_allowed_characters (integer, nullable), max_allowed_files (integer, nullable), options (array, nullable). Cannot be used together with personalization_details."},"manufacturer_ids":{"name":"manufacturer_ids","description":"A comma-separated list of manufacturer IDs. Retrieve the IDs from the cart.info method.","example":"1,2,3","type":"string"},"responsible_person_ids":{"name":"responsible_person_ids","description":"A comma-separated list of responsible person IDs. Retrieve the IDs from the cart.info method.","example":"1,2,3","type":"string"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["name","model","description","price"]},"ProductAddBatch":{"type":"object","properties":{"nested_items_update_behaviour":{"type":"string","default":"replace","description":" Determines how updates to nested items should be handled.
Values description:
replace: This option indicates that the nested items should be completely replaced with the new data provided.
merge: With this option, updates to nested items are merged with the existing data.
","enum":["replace","merge"]},"clear_cache":{"type":"boolean","default":false},"reindex":{"type":"boolean","default":false},"payload":{"type":"array","minItems":1,"maxItems":250,"description":"Contains an array of product objects. The list of properties may vary depending on the specific platform.","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"short_description":{"type":"string"},"sku":{"type":"string"},"model":{"type":"string"},"asin":{"type":"string"},"upc":{"type":"string"},"ean":{"type":"string"},"gtin":{"type":"string"},"mpn":{"type":"string"},"isbn":{"type":"string"},"barcode":{"type":"string"},"price":{"type":"number"},"old_price":{"type":"number"},"cost_price":{"type":"number"},"special_price":{"type":"number"},"sprice_create":{"type":"string"},"sprice_expire":{"type":"string"},"avail_from":{"type":"string"},"advanced_prices":{"type":"array","items":{"type":"object","properties":{"value":{"type":"number"},"group_id":{"type":"integer"},"quantity":{"type":"number"},"start_time":{"type":"string"},"expire_time":{"type":"string"}},"required":["value","quantity"]}},"fixed_cost_shipping_price":{"type":"number"},"buyitnow_price":{"type":"number"},"reserve_price":{"type":"number"},"best_offer":{"type":"number"},"quantity":{"type":"number"},"manage_stock":{"type":"boolean"},"product_type":{"type":"string"},"marketplace_item_properties":{"type":"object"},"specifics":{"type":"object"},"is_free_shipping":{"type":"boolean"},"taxable":{"type":"boolean"},"status":{"type":"string"},"condition":{"type":"string"},"condition_description":{"type":"string"},"visible":{"type":"string"},"available_for_view":{"type":"boolean"},"available_for_sale":{"type":"boolean"},"is_virtual":{"type":"boolean"},"in_stock":{"type":"boolean"},"type":{"type":"string"},"listing_type":{"type":"string"},"listing_duration":{"type":"string"},"downloadable":{"type":"boolean"},"weight":{"type":"number"},"length":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"weight_unit":{"type":"string"},"dimensions_unit":{"type":"string"},"store_id":{"type":"string"},"lang_id":{"type":"string"},"category_id":{"type":"string"},"warehouse_id":{"type":"string"},"categories_ids":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"}},"related_products_ids":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"}},"up_sell_products_ids":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"}},"cross_sell_products_ids":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"}},"stores_ids":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"}},"tax_class_id":{"type":"string"},"sales_tax":{"type":"object","properties":{"tax_percent":{"type":"number","minimum":0},"taxable":{"type":"boolean"}}},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_keywords":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"search_keywords":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"harmonized_system_code":{"type":"string"},"url":{"type":"string"},"seo_url":{"type":"string"},"external_product_link":{"type":"string"},"manufacturer":{"type":"string"},"manufacturer_id":{"type":"string"},"backorder_status":{"type":"string"},"images":{"type":"array","minItems":1,"items":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer"}},"required":["url"]}},"tags":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"files":{"type":"array","minItems":1,"items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}},"required":["url","name"]}}}}},"idempotency_key":{"type":"string","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes."}},"required":["payload"]},"ProductUpdate":{"type":"object","properties":{"id":{"name":"id","description":"Defines product id that has to be updated","example":10,"type":"string"},"model":{"name":"model","description":"Defines product model that has to be updated","example":"bag_01","type":"string"},"sku":{"name":"sku","description":"Defines new product's sku","example":"bag_01","type":"string"},"name":{"name":"name","description":"Defines product's name that has to be updated","example":"Pancil","type":"string"},"description":{"name":"description","description":"Defines new product's description","example":"New product description","type":"string"},"short_description":{"name":"short_description","description":"Defines short description","example":"Short description. This is very short description","type":"string"},"prices_inc_tax":{"name":"prices_inc_tax","description":"Indicates whether prices include tax.","example":true,"type":"boolean","default":false},"price":{"name":"price","description":"Defines new product's price","example":99.9,"type":"number"},"old_price":{"name":"old_price","description":"Defines product's old price","example":99.9,"type":"number"},"special_price":{"name":"special_price","description":"Defines new product's special price","example":56.9,"type":"number"},"sprice_create":{"name":"sprice_create","description":"Defines the date of special price creation","example":"2018-08-25 23:56:12","type":"string"},"sprice_expire":{"name":"sprice_expire","description":"Defines the term of special price offer duration","example":"2018-08-25 23:56:12","type":"string"},"cost_price":{"name":"cost_price","description":"Defines new product's cost price","example":65.9,"type":"number"},"fixed_cost_shipping_price":{"name":"fixed_cost_shipping_price","description":"Specifies product's fixed cost shipping price","example":5.5,"type":"number"},"retail_price":{"name":"retail_price","description":"Defines new product's retail price","example":6.9,"type":"number"},"tier_prices":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"number"},"price":{"type":"number"}}},"description":"Defines product's tier prices"},"reserve_price":{"name":"reserve_price","description":"Defines reserve price value","example":65.9,"type":"number"},"buyitnow_price":{"name":"buyitnow_price","description":"Defines buy it now value","example":65.9,"type":"number"},"taxable":{"name":"taxable","description":"Specifies whether a tax is charged","example":false,"type":"boolean"},"tax_class_id":{"name":"tax_class_id","description":"Defines tax classes where entity has to be added","example":9,"type":"string"},"type":{"name":"type","description":"Defines product's type","example":"simple","type":"string"},"status":{"name":"status","description":"Defines product's status","example":"disabled","type":"string"},"condition":{"name":"condition","description":"The human-readable label for the condition (e.g., \"New\").","example":"Like New","type":"string"},"visible":{"name":"visible","description":"Set visibility status","example":"search","type":"string"},"in_stock":{"name":"in_stock","description":"Set stock status","example":true,"type":"boolean"},"avail":{"name":"avail","description":"Defines category's visibility status","example":false,"type":"boolean","default":true},"avail_from":{"name":"avail_from","description":"Allows to schedule a time in the future that the item becomes available. The value should be greater than the current date and time.","example":"2029-10-25T15:54:37-0500","type":"string"},"product_class":{"name":"product_class","description":"A categorization for the product","example":"Shirts","type":"string"},"brand_name":{"name":"brand_name","description":"Retrieves brands specified by brand name","example":"Abidas","type":"string"},"available_for_view":{"name":"available_for_view","description":"Specifies the set of visible/invisible products for users","example":false,"type":"boolean"},"measure_unit":{"name":"measure_unit","description":"Unit for the price per unit. Must be in allowed list","example":"Piece","type":"string"},"unit_price":{"name":"unit_price","description":"Defines new product's unit price","example":10.5,"type":"number"},"stores_ids":{"name":"stores_ids","description":"Assign product to the stores that is specified by comma-separated stores' id","example":"1,2","type":"string"},"store_id":{"name":"store_id","description":"Defines store id where the product should be found","example":"1","type":"string"},"lang_id":{"name":"lang_id","description":"Language id","example":3,"type":"string"},"quantity":{"name":"quantity","description":"Defines new product's quantity","example":6,"type":"number"},"reserve_quantity":{"name":"reserve_quantity","description":"This parameter allows to reserve/unreserve product quantity.","example":"1","type":"number"},"manage_stock":{"name":"manage_stock","description":"Defines inventory tracking for product","example":false,"type":"boolean"},"backorder_status":{"name":"backorder_status","description":"Set backorder status","example":"true","type":"string"},"increase_quantity":{"name":"increase_quantity","description":"Defines the incremental changes in product quantity","example":4,"type":"number"},"reduce_quantity":{"name":"reduce_quantity","description":"Defines the decrement changes in product quantity","example":4,"type":"number"},"low_stock_threshold":{"name":"low_stock_threshold","description":"Specify the quantity threshold below which the product is considered low in stock","example":1,"type":"number"},"min_order_quantity":{"name":"min_order_quantity","description":"The minimum quantity an order must contain, to be eligible to purchase this product.","example":1,"type":"number"},"max_order_quantity":{"name":"max_order_quantity","description":"The maximum quantity an order can contain when purchasing the product.","example":1,"type":"number"},"warehouse_id":{"name":"warehouse_id","description":"This parameter is used for selecting a warehouse where you need to set/modify a product quantity.","example":"1","type":"string"},"weight":{"name":"weight","description":"Weight","example":23.69,"type":"number"},"weight_unit":{"name":"weight_unit","description":"Weight Unit","example":"lb","type":"string"},"height":{"name":"height","description":"Defines product's height","example":56.12,"type":"number"},"length":{"name":"length","description":"Defines product's length","example":56.12,"type":"number"},"width":{"name":"width","description":"Defines product's width","example":56.12,"type":"number"},"dimensions_unit":{"name":"dimensions_unit","description":"Weight Unit","example":"cm","type":"string"},"is_virtual":{"name":"is_virtual","description":"Defines whether the product is virtual","example":false,"type":"boolean","default":false},"is_free_shipping":{"name":"is_free_shipping","description":"Specifies product free shipping flag that has to be updated","example":true,"type":"boolean"},"gtin":{"name":"gtin","description":"Global Trade Item Number. An GTIN is an identifier for trade items.","example":"12345678912345","type":"string"},"upc":{"name":"upc","description":"Universal Product Code. A UPC (UPC-A) is a commonly used identifer for many different products.","example":"9770317847001","type":"string"},"mpn":{"name":"mpn","description":"Manufacturer Part Number. A MPN is an identifier of a particular part design or material used.","example":"9770317847001","type":"string"},"ean":{"name":"ean","description":"European Article Number. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products.","example":"5901234123457","type":"string"},"isbn":{"name":"isbn","description":"International Standard Book Number. An ISBN is a unique identifier for books.","example":"9783161484100","type":"string"},"barcode":{"name":"barcode","description":"A barcode is a unique code composed of numbers used as a product identifier.","example":"9770317847001","type":"string"},"manufacturer":{"name":"manufacturer","description":"Defines product's manufacturer","example":"Samsung","type":"string"},"manufacturer_id":{"name":"manufacturer_id","description":"Defines product's manufacturer by manufacturer_id","example":"1","type":"string"},"vendor_id":{"name":"vendor_id","description":"Vendor Id","example":"1","type":"string"},"categories_ids":{"name":"categories_ids","description":"Defines product add that is specified by comma-separated categories id","example":"23,56","type":"string"},"related_products_ids":{"name":"related_products_ids","description":"Defines product related products ids that has to be updated","example":"4,5","type":"string"},"up_sell_products_ids":{"name":"up_sell_products_ids","description":"Defines product up-sell products ids that has to be updated","example":"4,5","type":"string"},"cross_sell_products_ids":{"name":"cross_sell_products_ids","description":"Defines product cross-sells products ids that has to be updated","example":"4,5","type":"string"},"meta_title":{"name":"meta_title","description":"Defines unique meta title for each entity","example":"category,test","type":"string"},"meta_keywords":{"name":"meta_keywords","description":"Defines unique meta keywords for each entity","example":"category,test","type":"string"},"meta_description":{"name":"meta_description","description":"Defines unique meta description of a entity","example":"category,test","type":"string"},"seo_url":{"name":"seo_url","description":"Defines unique URL for SEO","example":"some seo url","type":"string"},"search_keywords":{"name":"search_keywords","description":"Defines unique search keywords","example":"key1,key2,key3","type":"string"},"tags":{"name":"tags","description":"Product tags","example":"tag1,tag2","type":"string"},"delivery_code":{"name":"delivery_code","description":"The delivery promise that applies to offer","example":"24uurs-23","type":"string"},"package_details":{"type":"object","properties":{"measure_unit":{"type":"string"},"weigh_unit":{"type":"string"},"package_depth":{"type":"number"},"package_length":{"type":"number"},"package_width":{"type":"number"},"weight_major":{"type":"number"},"weight_minor":{"type":"number"},"shipping_package":{"type":"string"}},"description":"If the seller is subscribed to \"Business Policies\", use the seller_profiles instead of the shipping_details, payment_methods and return_accepted params.
Param structure:
package_details[measure_unit] = string
Allowed measure_unit values: [English or Metric]
Default: Metric
package_details[weigh_unit] = string
Allowed weigh_unit values: [kg, g, lbs, oz]
package_details[package_depth] = decimal
package_details[package_length] = decimal
package_details[package_width] = decimal
package_details[weight_major] = decimal
package_details[weight_minor] = decimal
package_details[shipping_package] = string
See cart.info method, param `eBay_shipping_package_details`
"},"country_of_origin":{"name":"country_of_origin","description":"The country where the inventory item was made","example":"123456","type":"string"},"harmonized_system_code":{"name":"harmonized_system_code","description":"Harmonized System Code. An HSC is a 6-digit identifier that allows participating countries to classify traded goods on a common basis for customs purposes","example":"123456","type":"string"},"shipping_template_id":{"name":"shipping_template_id","description":"The numeric ID of the shipping template associated with the products in Etsy. You can find possible values in the \"cart.info\" API method response, in the field shipping_zones[]->id.","example":40256592690,"type":"integer","default":0},"processing_profile_id":{"name":"processing_profile_id","description":"The numeric ID of the processing profile (readiness state) for physical products in Etsy. You can find possible values in the \"cart.info\" API method response, in the field processing_profiles[]->readiness_state_id.","example":"`12345678`","type":"integer"},"when_made":{"name":"when_made","description":"An enumerated string for the era in which the maker made the product.","example":"2020_2025","type":"string","default":"made_to_order"},"is_supply":{"name":"is_supply","description":"If true, it indicates the product as a supply, otherwise it indicates that it is a finished product.","example":false,"type":"boolean","default":true},"downloadable":{"name":"downloadable","description":"Defines whether the product is downloadable","example":true,"type":"boolean","default":false},"materials":{"name":"materials","description":"A list of material strings for materials used in the product.","example":"materials[0]=Aluminum&materials[1]=Brass","type":"array","items":{"type":"string"}},"auto_renew":{"name":"auto_renew","description":"When true, automatically renews a listing upon its expiration.","example":false,"type":"boolean","default":false},"on_sale":{"name":"on_sale","description":"Set whether the product on sale","example":false,"type":"boolean","default":false},"production_partner_ids":{"name":"production_partner_ids","description":"Defines product production partner ids that has to be updated","example":"4,5","type":"string"},"manufacturer_info":{"type":"object","properties":{"name":{"type":"string","description":"Defines manufacturer`s name","minLength":1},"address":{"type":"string","description":"Defines manufacturer`s address","minLength":1},"phone":{"type":"string","description":"Defines manufacturer`s phone","minLength":1},"email":{"type":"string","description":"Defines manufacturer`s email","minLength":1}},"description":"Manufacturer information."},"report_request_id":{"name":"report_request_id","description":"Report request id","example":"105245017661","type":"string"},"disable_report_cache":{"name":"disable_report_cache","description":"Disable report cache for current request","example":false,"type":"boolean","default":false},"reindex":{"name":"reindex","description":"Is reindex required","example":false,"type":"boolean","default":true},"clear_cache":{"name":"clear_cache","description":"Is cache clear required","example":false,"type":"boolean","default":true},"check_process_status":{"name":"check_process_status","description":"Disable or enable check process status. Please note that the response will be slower due to additional requests to the store.","example":false,"type":"boolean","default":false},"specifics":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string","x-conflictWith":["values"]},"values":{"type":"array","minItems":1,"items":{"type":"string"},"x-conflictWith":["value"]},"used_for_variations":{"type":"boolean","default":false},"scale_id":{"type":["integer","null"],"default":null},"input_value":{"type":["string","null"],"default":null},"food_details":{"type":"object","properties":{"calories":{"type":"number"}},"required":["calories"]},"group_products_details":{"type":"array","minItems":1,"items":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"integer","minimum":1}},"required":["id","quantity"]}},"booking_details":{"type":"object","properties":{"location":{"minLength":1,"type":"string"},"type":{"type":"string","enum":["date","date_time"]},"session_duration":{"type":"integer"},"session_gap":{"type":"integer"},"sessions_count":{"type":"integer"},"time_strict_value":{"type":"number"},"time_strict_type":{"type":"string","enum":["days","hours","minutes"],"default":"days"},"availabilities":{"type":"array","minItems":1,"items":{"type":"object","properties":{"day":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"]},"is_available":{"type":"boolean","default":true},"times":{"type":"array","minItems":1,"items":{"type":"object","properties":{"from":{"description":"The starting time of the of available booking slot in 24 hours format. Required if type=date_time","type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$"},"to":{"description":"The ending time of the of available booking slot in 24 hours format. Required if type=date_time","type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$"}},"required":["from","to"]}}},"required":["day"]}},"overrides":{"type":"array","minItems":1,"items":{"type":"object","properties":{"day":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"]},"date":{"type":"string","pattern":"^(19|20)\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"}},"required":["day","date"]}}},"required":["location","type","sessions_count","time_strict_type","time_strict_value","availabilities"]}}},"description":"An array of Item Specific Name/Value pairs used by the seller to provide descriptive details of an item in a structured manner.\n The list of possible specifications can be obtained using the category.info method (additional_fields->product_specifics).\n The structure of the parameter is different for specific platforms."},"shop_section_id":{"name":"shop_section_id","description":"Add Shop Section Id","example":12345678,"type":"integer"},"personalization_details":{"type":"object","properties":{"is_personalizable":{"type":"boolean"},"personalization_is_required":{"type":"boolean"},"personalization_char_count_max":{"type":"integer","minValue":1,"maxValue":1024},"personalization_instructions":{"type":"string","minLength":1,"maxLength":256}},"required":["is_personalizable"],"description":"Deprecated. Use personalization_questions instead for setting personalization questions. Defines legacy personalization settings for the listing. To enable personalization, is_personalizable must be set to true. When enabled, additional fields may be used to configure the personalization experience, including whether it is required (personalization_is_required), the maximum character limit (personalization_char_count_max), and buyer instructions (personalization_instructions). All related fields are only applicable if personalization is enabled."},"personalization_questions":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"object","properties":{"question_text":{"type":"string","minLength":1,"maxLength":45},"instructions":{"type":"string","minLength":1,"maxLength":120},"question_type":{"type":"string","enum":["text_input","dropdown","unlabeled_upload","labeled_upload"]},"required":{"type":"boolean"},"max_allowed_characters":{"type":["integer","null"],"minimum":1,"maximum":1024},"max_allowed_files":{"type":["integer","null"],"minimum":1,"maximum":10},"options":{"type":["array","null"],"minItems":1,"maxItems":30,"items":{"type":"string","minLength":1,"maxLength":45}}},"required":["question_text","question_type","required"]},"description":"Defines personalization questions for the listing as an array of question objects. Each question object supports the following fields: question_id (integer, nullable), question_text (string, 1-45 chars), instructions (string, nullable), question_type (string), required (boolean), max_allowed_characters (integer, nullable), max_allowed_files (integer, nullable), options (array, nullable). Cannot be used together with personalization_details."},"external_product_link":{"name":"external_product_link","description":"External product link","example":"http://example.com/t-shirt","type":"string"},"marketplace_item_properties":{"name":"marketplace_item_properties","description":"String containing the JSON representation of the supplied data","example":"{\"color\":[\"Silver\"],\"manufacturer\":\"Philips\",\"features\":[\"3 way\"],\"countPerPack\":1,\"watts\":{\"unit\":\"W\",\"measure\":40}}","type":"string"},"manufacturer_ids":{"name":"manufacturer_ids","description":"A comma-separated list of manufacturer IDs. Retrieve the IDs from the cart.info method.","example":"1,2,3","type":"string"},"responsible_person_ids":{"name":"responsible_person_ids","description":"A comma-separated list of responsible person IDs. Retrieve the IDs from the cart.info method.","example":"1,2,3","type":"string"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}}},"ProductUpdateBatch":{"type":"object","properties":{"nested_items_update_behaviour":{"type":"string","default":"replace","description":" Determines how updates to nested items should be handled.
Values description:
replace: This option indicates that the nested items should be completely replaced with the new data provided.
merge: With this option, updates to nested items are merged with the existing data.
","enum":["replace","merge"]},"clear_cache":{"type":"boolean","default":false},"reindex":{"type":"boolean","default":false},"payload":{"type":"array","minItems":1,"maxItems":250,"description":"Contains an array of product objects. The list of properties may vary depending on the specific platform.","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"short_description":{"type":"string"},"sku":{"type":"string"},"model":{"type":"string"},"price":{"type":"number"},"special_price":{"type":"number"},"sprice_create":{"type":"string"},"sprice_expire":{"type":"string"},"cost_price":{"type":"number"},"old_price":{"type":"number"},"fixed_cost_shipping_price":{"type":"number"},"advanced_prices":{"description":"If an empty array is passed, all entries will be deleted when the 'nested_items_update_behaviour' parameter is set to 'replace'.","type":"array","items":{"type":"object","properties":{"value":{"type":"number"},"group_id":{"type":"integer"},"quantity":{"type":"number"}},"required":["value","quantity"]}},"quantity":{"type":"number"},"increase_quantity":{"type":"number"},"reduce_quantity":{"type":"number"},"reserve_quantity":{"type":"number"},"store_id":{"type":"string"},"lang_id":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"condition":{"type":"string"},"condition_description":{"type":"string"},"visible":{"type":"string"},"available_for_view":{"type":"boolean"},"available_for_sale":{"type":"boolean"},"avail_from":{"type":"string"},"weight":{"type":"number"},"length":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"dimensions_unit":{"type":"string"},"weight_unit":{"type":"string"},"manage_stock":{"type":"boolean"},"in_stock":{"type":"boolean"},"backorder_status":{"type":"string"},"is_free_shipping":{"type":"boolean"},"is_virtual":{"type":"boolean"},"taxable":{"type":"boolean"},"downloadable":{"type":"boolean"},"warehouse_id":{"type":"string"},"tax_class_id":{"type":"string"},"categories_ids":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"}},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_keywords":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"}},"url":{"type":"string"},"seo_url":{"type":"string"},"manufacturer":{"type":"string"},"manufacturer_id":{"type":"string"},"mpn":{"type":"string"},"gtin":{"type":"string"},"upc":{"type":"string"},"isbn":{"type":"string"},"ean":{"type":"string"},"barcode":{"type":"string"},"images":{"type":"array","description":"Property 'nested_items_update_behaviour' does not apply. Specified items will be added to existing product images","minItems":1,"items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"},"type":{"type":"string"}},"required":["url"]}},"related_products_ids":{"description":"If an empty array is passed, all entries will be deleted when the 'nested_items_update_behaviour' parameter is set to 'replace'.","type":"array","items":{"type":"string"}},"up_sell_products_ids":{"description":"If an empty array is passed, all entries will be deleted when the 'nested_items_update_behaviour' parameter is set to 'replace'.","type":"array","items":{"type":"string"}},"cross_sell_products_ids":{"description":"If an empty array is passed, all entries will be deleted when the 'nested_items_update_behaviour' parameter is set to 'replace'.","type":"array","items":{"type":"string"}},"tags":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"search_keywords":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"harmonized_system_code":{"type":"string"}},"required":["id"]}},"idempotency_key":{"type":"string","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes."}},"required":["payload"]},"ProductDeleteBatch":{"type":"object","properties":{"payload":{"type":"array","minItems":1,"maxItems":250,"description":"Contains an array of product deletion requests, each including the product ID.","items":{"type":"object","properties":{"id":{"type":"string"},"store_id":{"type":"string"}}}},"idempotency_key":{"type":"string","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes."}},"required":["payload"]},"Model_Response_Product_Attribute_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Product_Attribute_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Product_Attribute_List_Result":{"type":"object","properties":{"attribute":{"type":"array","items":{"$ref":"#/components/schemas/Product_Attribute"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Product_Attribute":{"type":"object","properties":{"attribute_id":{"type":"string"},"code":{"type":"string"},"name":{"type":"string"},"lang_id":{"type":["string","null"]},"store_id":{"type":["string","null"]},"value":{"type":["string","null"]},"required":{"type":["boolean","null"]},"visible":{"type":["boolean","null"]},"type":{"type":["string","null"]},"position":{"type":["integer","null"]},"attribute_group_id":{"type":["string","null"]},"product_id":{"type":["string","null"]},"variant_id":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Product_Brand_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Product_Brand_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Product_Brand_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"brands":{"type":"array","items":{"$ref":"#/components/schemas/Brand"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Brand":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"created_time":{"type":["string","null"]},"modified_time":{"type":["string","null"]},"full_description":{"type":["string","null"]},"short_description":{"type":["string","null"]},"stores_ids":{"type":"array","items":{"type":"string"}},"active":{"type":"boolean"},"url":{"type":"string"},"meta_title":{"type":["string","null"]},"meta_keywords":{"type":["string","null"]},"meta_description":{"type":["string","null"]},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Child":{"type":"object","properties":{"id":{"type":"string"},"parent_id":{"type":"string"},"sku":{"type":["string","null"]},"upc":{"type":["string","null"]},"ean":{"type":["string","null"]},"mpn":{"type":["string","null"]},"gtin":{"type":["string","null"]},"isbn":{"type":["string","null"]},"url":{"type":["string","null"]},"seo_url":{"type":["string","null"]},"sort_order":{"type":["integer","null"]},"created_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"name":{"type":["string","null"]},"short_description":{"type":["string","null"]},"full_description":{"type":["string","null"]},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"}},"combination":{"type":"array","items":{"$ref":"#/components/schemas/Product_ChildItem_Combination"}},"default_price":{"type":["number","null"]},"cost_price":{"type":["number","null"]},"unit_price":{"type":["number","null"]},"measure_unit":{"type":["string","null"]},"list_price":{"type":["number","null"]},"wholesale_price":{"type":["number","null"]},"advanced_price":{"type":"array","items":{"$ref":"#/components/schemas/Product_AdvancedPrice"}},"tax_class_id":{"type":["string","null"]},"avail_for_sale":{"type":["boolean","null"]},"allow_backorders":{"type":["boolean","null"]},"in_stock":{"type":["boolean","null"]},"on_sale":{"type":["boolean","null"]},"manage_stock":{"type":["boolean","null"]},"inventory_level":{"type":["number","null"]},"inventory":{"type":"array","items":{"$ref":"#/components/schemas/Product_Inventory"}},"min_quantity":{"type":["number","null"]},"low_stock_threshold":{"type":["number","null"]},"default_qty_in_pack":{"type":["number","null"]},"is_qty_in_pack_fixed":{"type":["boolean","null"]},"weight_unit":{"type":["string","null"]},"weight":{"type":["number","null"]},"dimensions_unit":{"type":["string","null"]},"width":{"type":["number","null"]},"height":{"type":["number","null"]},"length":{"type":["number","null"]},"meta_title":{"type":["string","null"]},"meta_description":{"type":["string","null"]},"meta_keywords":{"type":["string","null"]},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"is_virtual":{"type":["boolean","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Product_ChildItem_Combination":{"type":"object","properties":{"option_id":{"type":"string"},"option_value_id":{"type":"string"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Product_ChildItem_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Product_ChildItem_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Product_ChildItem_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"children":{"type":"array","items":{"$ref":"#/components/schemas/Child"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Product_Currency_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Product_Currency_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Product_Currency_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"currency":{"type":"array","items":{"$ref":"#/components/schemas/Currency"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"ProductImageAdd":{"type":"object","properties":{"type":{"name":"type","description":"Defines image's types that are specified by comma-separated list","example":"base,small","type":"string","enum":["small","base","additional","thumbnail"]},"image_name":{"name":"image_name","description":"Defines image's name","example":"bag-gray.png","type":"string"},"product_id":{"name":"product_id","description":"Defines product id where the image should be added","example":10,"type":"string"},"product_variant_id":{"name":"product_variant_id","description":"Defines product's variants specified by variant id","example":45,"type":"string"},"variant_ids":{"name":"variant_ids","description":"Defines product's variants ids","example":"1,2,3,4,5","type":"string"},"option_value_ids":{"name":"option_value_ids","description":"Defines product's option values ids","example":"1,2,3,4,5","type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"lang_id":{"name":"lang_id","description":"Add product image on specified language id","example":3,"type":"string"},"url":{"name":"url","description":"Defines URL of the image that has to be added","example":"http://docs.api2cart.com/img/logo.png","type":"string"},"content":{"name":"content","description":"Content(body) encoded in base64 of image file","example":"/9j/4AAQSkZ...gD/2Q==","type":"string"},"label":{"name":"label","description":"Defines alternative text that has to be attached to the picture","example":"This cool image","type":"string"},"mime":{"name":"mime","description":"Mime type of image http://en.wikipedia.org/wiki/Internet_media_type.","example":"image/jpeg","type":"string"},"position":{"name":"position","description":"Defines image\u2019s position in the list","example":5,"type":"integer","default":0},"use_latest_api_version":{"name":"use_latest_api_version","description":"Use the latest platform API version","example":true,"type":"boolean","default":false},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["type","image_name"]},"Model_Response_Product_Option_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Product_Option_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Product_Option_List_Result":{"type":"object","properties":{"option":{"type":"array","items":{"$ref":"#/components/schemas/Product_Option"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"ProductOptionAdd":{"type":"object","properties":{"name":{"name":"name","description":"Defines option's name","example":"Color","type":"string"},"type":{"name":"type","description":"Defines option's type that has to be added","example":"option_type_select","type":"string","enum":["option_type_select","option_type_text","option_type_radio","option_type_checkbox","option_type_textarea","option_type_readonly","option_type_multiselect","option_type_multicheckbox","option_type_file","option_type_date","option_type_datetime","option_type_time"]},"product_id":{"name":"product_id","description":"Defines product id where the option should be added","example":10,"type":"string"},"default_option_value":{"name":"default_option_value","description":"Defines default option value that has to be added","example":"green","type":"string"},"option_values":{"name":"option_values","description":"Defines option values that has to be added","example":"green,black,yellow","type":"string"},"description":{"name":"description","description":"Defines option's description","example":"Product option","type":"string"},"avail":{"name":"avail","description":"Defines whether the option is available","example":false,"type":"boolean","default":true},"sort_order":{"name":"sort_order","description":"Sort number in the list","example":2,"type":"integer","default":0},"required":{"name":"required","description":"Defines if the option is required","example":true,"type":"boolean","default":false},"values":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","minLength":1},"display_value":{"type":"string","minLength":1},"is_default":{"type":"boolean","default":false}},"required":["value"]},"description":"An array of option values."},"clear_cache":{"name":"clear_cache","description":"Is cache clear required","example":false,"type":"boolean","default":true},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["name","type"]},"ProductPriceAdd":{"type":"object","properties":{"product_id":{"name":"product_id","description":"Defines the product to which the price has to be added","example":10,"type":"string"},"group_prices":{"type":"array","items":{"type":"object","properties":{"group_id":{"type":"string"},"price":{"type":"number"},"qty":{"type":"integer"}}},"description":"Defines product's group prices"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}}},"ProductPriceUpdate":{"type":"object","properties":{"product_id":{"name":"product_id","description":"Defines the product where the price has to be updated","example":10,"type":"string"},"group_prices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"group_id":{"type":"string"},"price":{"type":"number"},"qty":{"type":"integer"}}},"description":"Defines product's group prices"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}}},"Model_Response_Product_Review_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Product_Review_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Product_Review_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"reviews":{"type":"array","items":{"$ref":"#/components/schemas/Product_Review"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Product_Review":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":["string","null"]},"customer_id":{"type":["string","null"]},"nick_name":{"type":["string","null"]},"email":{"type":["string","null"]},"summary":{"type":["string","null"]},"message":{"type":["string","null"]},"rating":{"type":["number","null"]},"ratings":{"type":"array","items":{"$ref":"#/components/schemas/Product_Review_Rating"}},"status":{"type":["string","null"]},"created_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_time":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"medias":{"type":"array","items":{"$ref":"#/components/schemas/Media"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Product_Review_Rating":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"value":{"type":"integer"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Media":{"type":"object","properties":{"id":{"type":["string","null"]},"http_path":{"type":"string"},"file_name":{"type":["string","null"]},"type":{"type":"string"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"ProductTaxAdd":{"type":"object","properties":{"product_id":{"name":"product_id","description":"Defines products specified by product id","example":10,"type":"string"},"name":{"name":"name","description":"Defines tax class name where tax has to be added","example":"ECO-Tax","type":"string"},"tax_rates":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"number"}}},"description":"Defines tax rates of specified tax classes"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["name","tax_rates"]},"ProductVariantAdd":{"type":"object","properties":{"product_id":{"name":"product_id","description":"Defines product's id where the variant has to be added","example":10,"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"attribute_name":{"type":"string"},"attribute_value":{"type":"string"},"attribute_price":{"type":"number"},"attribute_weight":{"type":"number"}}},"description":"Defines variant's attributes list with optional per-option price and weight modifiers"},"name":{"name":"name","description":"Defines variant's name that has to be added","example":"Bag Green XXL","type":"string"},"model":{"name":"model","description":"Specifies variant's model that has to be added","example":"bag_01","type":"string"},"description":{"name":"description","description":"Specifies variant's description","example":"Product variant","type":"string"},"short_description":{"name":"short_description","description":"Defines short description","example":"Short description. This is very short description","type":"string"},"available_for_view":{"name":"available_for_view","description":"Specifies the set of visible/invisible product's variants for users","example":false,"type":"boolean","default":true},"available_for_sale":{"name":"available_for_sale","description":"Specifies the set of visible/invisible product's variants for sale","example":false,"type":"boolean","default":true},"status":{"name":"status","description":"Defines status","example":"disabled","type":"string"},"is_virtual":{"name":"is_virtual","description":"Defines whether the product is virtual","example":false,"type":"boolean","default":false},"is_default":{"name":"is_default","description":"Defines as a default variant","example":true,"type":"boolean"},"store_id":{"name":"store_id","description":"Add variants specified by store id","example":"1","type":"string"},"stores_ids":{"name":"stores_ids","description":"Assign variant to the stores that is specified by comma-separated stores' id","example":"1,2","type":"string"},"lang_id":{"name":"lang_id","description":"Language id","example":3,"type":"string"},"price":{"name":"price","description":"Defines new product's variant price","example":99.9,"type":"number"},"old_price":{"name":"old_price","description":"Defines product's old price","example":99.9,"type":"number"},"cost_price":{"name":"cost_price","description":"Defines new product's cost price","example":65.9,"type":"number"},"special_price":{"name":"special_price","description":"Specifies variant's model that has to be added","example":56.9,"type":"number"},"sprice_create":{"name":"sprice_create","description":"Defines the date of special price creation","example":"2018-08-25 23:56:12","type":"string"},"sprice_modified":{"name":"sprice_modified","description":"Defines the date of special price modification","example":"2018-12-05 13:46:20","type":"string"},"sprice_expire":{"name":"sprice_expire","description":"Defines the term of special price offer duration","example":"2018-08-25 23:56:12","type":"string"},"tier_prices":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"number"},"price":{"type":"number"}}},"description":"Defines product's tier prices"},"measure_unit":{"name":"measure_unit","description":"Unit for the price per unit. Must be in allowed list","example":"Piece","type":"string"},"unit_price":{"name":"unit_price","description":"Defines new product's unit price","example":10.5,"type":"number"},"prices_inc_tax":{"name":"prices_inc_tax","description":"Indicates whether prices include tax.","example":true,"type":"boolean","default":false},"quantity":{"name":"quantity","description":"Defines product variant's quantity that has to be added","example":6,"type":"number","default":0},"warehouse_id":{"name":"warehouse_id","description":"This parameter is used for selecting a warehouse where you need to set/modify a product quantity.","example":"1","type":"string"},"in_stock":{"name":"in_stock","description":"Set stock status","example":true,"type":"boolean"},"backorder_status":{"name":"backorder_status","description":"Set backorder status","example":"true","type":"string"},"manage_stock":{"name":"manage_stock","description":"Defines inventory tracking for product variant","example":false,"type":"boolean"},"low_stock_threshold":{"name":"low_stock_threshold","description":"Specify the quantity threshold below which the product is considered low in stock","example":1,"type":"number"},"weight":{"name":"weight","description":"Weight","example":23.69,"type":"number","default":0},"width":{"name":"width","description":"Defines product's width","example":56.12,"type":"number"},"height":{"name":"height","description":"Defines product's height","example":56.12,"type":"number"},"length":{"name":"length","description":"Defines product's length","example":56.12,"type":"number"},"weight_unit":{"name":"weight_unit","description":"Weight Unit","example":"lb","type":"string"},"sku":{"name":"sku","description":"Defines variant's sku that has to be added","example":"bag_01","type":"string"},"barcode":{"name":"barcode","description":"A barcode is a unique code composed of numbers used as a product identifier.","example":"9770317847001","type":"string"},"gtin":{"name":"gtin","description":"Global Trade Item Number. An GTIN is an identifier for trade items.","example":"12345678912345","type":"string"},"upc":{"name":"upc","description":"Universal Product Code. A UPC (UPC-A) is a commonly used identifer for many different products.","example":"9770317847001","type":"string"},"ean":{"name":"ean","description":"European Article Number. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products.","example":"5901234123457","type":"string"},"mpn":{"name":"mpn","description":"Manufacturer Part Number. A MPN is an identifier of a particular part design or material used.","example":"9770317847001","type":"string"},"isbn":{"name":"isbn","description":"International Standard Book Number. An ISBN is a unique identifier for books.","example":"9783161484100","type":"string"},"seo_url":{"name":"seo_url","description":"Defines unique URL for SEO","example":"some seo url","type":"string"},"manufacturer":{"name":"manufacturer","description":"Specifies the product variant's manufacturer","example":"Samsung","type":"string"},"created_at":{"name":"created_at","description":"Defines the date of entity creation","example":"2014-08-09 13:13:13","type":"string"},"meta_title":{"name":"meta_title","description":"Defines unique meta title for each entity","example":"category,test","type":"string"},"meta_keywords":{"name":"meta_keywords","description":"Defines unique meta keywords for each entity","example":"category,test","type":"string"},"meta_description":{"name":"meta_description","description":"Defines unique meta description of a entity","example":"category,test","type":"string"},"url":{"name":"url","description":"Defines unique product variant's URL","example":"/product_variant_slug","type":"string"},"tax_class_id":{"name":"tax_class_id","description":"Defines tax classes where entity has to be added","example":9,"type":"string"},"taxable":{"name":"taxable","description":"Specifies whether a tax is charged","example":false,"type":"boolean","default":true},"fixed_cost_shipping_price":{"name":"fixed_cost_shipping_price","description":"Specifies fixed cost shipping price","example":5.5,"type":"number"},"is_free_shipping":{"name":"is_free_shipping","description":"Specifies variant's free shipping flag that has to be added","example":true,"type":"boolean"},"country_of_origin":{"name":"country_of_origin","description":"The country where the inventory item was made","example":"123456","type":"string"},"harmonized_system_code":{"name":"harmonized_system_code","description":"Harmonized System Code. An HSC is a 6-digit identifier that allows participating countries to classify traded goods on a common basis for customs purposes","example":"123456","type":"string"},"processing_profile_id":{"name":"processing_profile_id","description":"The numeric ID of the processing profile (readiness state) for physical products in Etsy. You can find possible values in the \"cart.info\" API method response, in the field processing_profiles[]->readiness_state_id.","example":"`12345678`","type":"integer"},"marketplace_item_properties":{"name":"marketplace_item_properties","description":"String containing the JSON representation of the supplied data","example":"{\"color\":[\"Silver\"],\"manufacturer\":\"Philips\",\"features\":[\"3 way\"],\"countPerPack\":1,\"watts\":{\"unit\":\"W\",\"measure\":40}}","type":"string"},"clear_cache":{"name":"clear_cache","description":"Is cache clear required","example":false,"type":"boolean","default":true},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["model"]},"ProductVariantAddBatch":{"type":"object","properties":{"clear_cache":{"type":"boolean","default":false},"reindex":{"type":"boolean","default":false},"payload":{"type":"array","minItems":1,"maxItems":250,"description":"Contains an array of product variants objects. The list of properties may vary depending on the specific platform.","items":{"type":"object","properties":{"product_id":{"type":"string"},"combination":{"type":"array","description":"A unique combination that contains an array of options and their values, which form a variation.","minItems":1,"items":{"type":"object","properties":{"option_name":{"type":"string"},"option_value_name":{"type":"string"}},"required":["option_name","option_value_name"]}},"name":{"type":"string"},"description":{"type":"string"},"short_description":{"type":"string"},"sku":{"type":"string"},"model":{"type":"string"},"price":{"type":"number"},"old_price":{"type":"number"},"cost_price":{"type":"number"},"special_price":{"type":"number"},"sprice_create":{"type":"string"},"sprice_expire":{"type":"string"},"advanced_prices":{"type":"array","minItems":1,"items":{"type":"object","properties":{"value":{"type":"number"},"group_id":{"type":"integer"},"quantity":{"type":"number"}},"required":["value","quantity"]}},"meta_title":{"type":"number"},"meta_description":{"type":"number"},"meta_keywords":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"categories_ids":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"stores_ids":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"weight":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight_unit":{"type":"string"},"warehouse_id":{"type":"string"},"quantity":{"type":"number"},"manage_stock":{"type":"boolean"},"in_stock":{"type":"boolean"},"store_id":{"type":"string"},"lang_id":{"type":"string"},"tax_class_id":{"type":"string"},"backorder_status":{"type":"string"},"status":{"type":"string"},"visible":{"type":"string"},"is_virtual":{"type":"boolean"},"downloadable":{"type":"boolean"},"is_default":{"type":"boolean"},"upc":{"type":"string"},"isbn":{"type":"string"},"mpn":{"type":"string"},"ean":{"type":"string"},"barcode":{"type":"string"},"available_for_sale":{"type":"boolean"},"is_free_shipping":{"type":"boolean"},"taxable":{"type":"boolean"},"seo_url":{"type":"string"},"manufacturer_id":{"type":"string"},"harmonized_system_code":{"type":"string"},"marketplace_item_properties":{"type":"object"},"images":{"type":"array","maxItems":1,"items":{"type":"object","properties":{"url":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer"},"type":{"type":"string"}},"required":["url"]}},"product_images_ids":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"},"x-conflictWith":["images"]},"related_products_ids":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"}},"up_sell_products_ids":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"}},"cross_sell_products_ids":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"}}},"required":["product_id","sku","combination"]}},"idempotency_key":{"type":"string","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes."}},"required":["payload"]},"ProductVariantUpdate":{"type":"object","properties":{"id":{"name":"id","description":"Defines variant update specified by variant id","example":10,"type":"string"},"product_id":{"name":"product_id","description":"Defines product's id where the variant has to be updated","example":10,"type":"string"},"store_id":{"name":"store_id","description":"Defines store id where the variant should be found","example":"1","type":"string"},"lang_id":{"name":"lang_id","description":"Language id","example":3,"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"option_name":{"type":"string"},"option_value":{"type":"string"}}},"description":"Defines variant's options list"},"name":{"name":"name","description":"Defines variant's name that has to be updated","example":"Bag Green L","type":"string"},"description":{"name":"description","description":"Specifies variant's description","example":"Product variant","type":"string"},"short_description":{"name":"short_description","description":"Defines short description","example":"Short description. This is very short description","type":"string"},"model":{"name":"model","description":"Specifies variant's model that has to be added","example":"bag_01","type":"string"},"sku":{"name":"sku","description":"Defines new product's variant sku","example":"bag_01","type":"string"},"visible":{"name":"visible","description":"Set visibility status","example":"catalog","type":"string"},"status":{"name":"status","description":"Defines product variant's status","example":"disabled","type":"string"},"backorder_status":{"name":"backorder_status","description":"Set backorder status","example":"true","type":"string"},"low_stock_threshold":{"name":"low_stock_threshold","description":"Specify the quantity threshold below which the product is considered low in stock","example":1,"type":"number"},"available_for_sale":{"name":"available_for_sale","description":"Specifies the set of visible/invisible product's variants for sale","example":false,"type":"boolean","default":true},"avail":{"name":"avail","description":"Defines category's visibility status","example":false,"type":"boolean","default":true},"is_default":{"name":"is_default","description":"Defines as a default variant","example":true,"type":"boolean"},"is_free_shipping":{"name":"is_free_shipping","description":"Specifies variant's free shipping flag that has to be added","example":true,"type":"boolean"},"taxable":{"name":"taxable","description":"Specifies whether a tax is charged","example":false,"type":"boolean"},"tax_class_id":{"name":"tax_class_id","description":"Defines tax classes where entity has to be added","example":9,"type":"string"},"is_virtual":{"name":"is_virtual","description":"Defines whether the product is virtual","example":false,"type":"boolean","default":false},"manage_stock":{"name":"manage_stock","description":"Defines inventory tracking for product variant","example":false,"type":"boolean"},"in_stock":{"name":"in_stock","description":"Set stock status","example":true,"type":"boolean"},"warehouse_id":{"name":"warehouse_id","description":"This parameter is used for selecting a warehouse where you need to set/modify a product quantity.","example":"1","type":"string"},"reserve_quantity":{"name":"reserve_quantity","description":"This parameter allows to reserve/unreserve product variants quantity.","example":"1","type":"number"},"quantity":{"name":"quantity","description":"Defines new products' variants quantity","example":6,"type":"number"},"increase_quantity":{"name":"increase_quantity","description":"Defines the incremental changes in product quantity","example":4,"type":"number","default":0},"reduce_quantity":{"name":"reduce_quantity","description":"Defines the decrement changes in product quantity","example":4,"type":"number","default":0},"prices_inc_tax":{"name":"prices_inc_tax","description":"Indicates whether prices include tax.","example":true,"type":"boolean","default":false},"price":{"name":"price","description":"Defines new product's variant price","example":99.9,"type":"number"},"special_price":{"name":"special_price","description":"Defines new product's variant special price","example":56.9,"type":"number"},"retail_price":{"name":"retail_price","description":"Defines new product's retail price","example":6.9,"type":"number"},"old_price":{"name":"old_price","description":"Defines product's old price","example":99.9,"type":"number"},"cost_price":{"name":"cost_price","description":"Defines new product's cost price","example":65.9,"type":"number"},"fixed_cost_shipping_price":{"name":"fixed_cost_shipping_price","description":"Specifies fixed cost shipping price","example":5.5,"type":"number"},"sprice_create":{"name":"sprice_create","description":"Defines the date of special price creation","example":"2018-08-25 23:56:12","type":"string"},"sprice_expire":{"name":"sprice_expire","description":"Defines the term of special price offer duration","example":"2018-08-25 23:56:12","type":"string"},"measure_unit":{"name":"measure_unit","description":"Unit for the price per unit. Must be in allowed list","example":"Piece","type":"string"},"unit_price":{"name":"unit_price","description":"Defines new product's unit price","example":10.5,"type":"number"},"weight":{"name":"weight","description":"Weight","example":23.69,"type":"number","default":0},"barcode":{"name":"barcode","description":"A barcode is a unique code composed of numbers used as a product identifier.","example":"9770317847001","type":"string"},"width":{"name":"width","description":"Defines product's width","example":56.12,"type":"number"},"weight_unit":{"name":"weight_unit","description":"Weight Unit","example":"lb","type":"string"},"height":{"name":"height","description":"Defines product's height","example":56.12,"type":"number"},"length":{"name":"length","description":"Defines product's length","example":56.12,"type":"number"},"gtin":{"name":"gtin","description":"Global Trade Item Number. An GTIN is an identifier for trade items.","example":"12345678912345","type":"string"},"upc":{"name":"upc","description":"Universal Product Code. A UPC (UPC-A) is a commonly used identifer for many different products.","example":"9770317847001","type":"string"},"mpn":{"name":"mpn","description":"Manufacturer Part Number. A MPN is an identifier of a particular part design or material used.","example":"9770317847001","type":"string"},"ean":{"name":"ean","description":"European Article Number. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products.","example":"5901234123457","type":"string"},"isbn":{"name":"isbn","description":"International Standard Book Number. An ISBN is a unique identifier for books.","example":"9783161484100","type":"string"},"harmonized_system_code":{"name":"harmonized_system_code","description":"Harmonized System Code. An HSC is a 6-digit identifier that allows participating countries to classify traded goods on a common basis for customs purposes","example":"123456","type":"string"},"country_of_origin":{"name":"country_of_origin","description":"The country where the inventory item was made","example":"123456","type":"string"},"meta_title":{"name":"meta_title","description":"Defines unique meta title for each entity","example":"category,test","type":"string"},"meta_description":{"name":"meta_description","description":"Defines unique meta description of a entity","example":"category,test","type":"string"},"meta_keywords":{"name":"meta_keywords","description":"Defines unique meta keywords for each entity","example":"category,test","type":"string"},"manufacturer":{"name":"manufacturer","description":"Specifies the product variant's manufacturer","example":"Samsung","type":"string"},"reindex":{"name":"reindex","description":"Is reindex required","example":false,"type":"boolean","default":true},"clear_cache":{"name":"clear_cache","description":"Is cache clear required","example":false,"type":"boolean","default":true},"processing_profile_id":{"name":"processing_profile_id","description":"The numeric ID of the processing profile (readiness state) for physical products in Etsy. You can find possible values in the \"cart.info\" API method response, in the field processing_profiles[]->readiness_state_id.","example":"`12345678`","type":"integer"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}}},"ProductVariantUpdateBatch":{"type":"object","properties":{"nested_items_update_behaviour":{"type":"string","default":"replace","description":" Determines how updates to nested items should be handled.
Values description:
replace: This option indicates that the nested items should be completely replaced with the new data provided.
merge: With this option, updates to nested items are merged with the existing data.
","enum":["replace","merge"]},"clear_cache":{"type":"boolean","default":false},"reindex":{"type":"boolean","default":false},"payload":{"type":"array","minItems":1,"maxItems":250,"description":"Contains an array of product objects. The list of properties may vary depending on the specific platform.","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"short_description":{"type":"string"},"sku":{"type":"string"},"upc":{"type":"string"},"mpn":{"type":"string"},"gtin":{"type":"string"},"isbn":{"type":"string"},"status":{"type":"string"},"price":{"type":"number"},"special_price":{"type":"number"},"cost_price":{"type":"number"},"retail_price":{"type":"number"},"advanced_prices":{"description":"If an empty array is passed, all entries will be deleted when the 'nested_items_update_behaviour' parameter is set to 'replace'.","type":"array","items":{"type":"object","properties":{"value":{"type":"number"},"group_id":{"type":"integer"},"quantity":{"type":"number"}},"required":["value","quantity"]}},"quantity":{"type":"number"},"reserve_quantity":{"type":"number"},"increase_quantity":{"type":"number"},"reduce_quantity":{"type":"number"},"warehouse_id":{"type":"string"},"manufacturer_id":{"type":"string"},"weight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"width":{"type":"number"},"store_id":{"type":"string"},"lang_id":{"type":"string"},"tax_class_id":{"type":"string"},"backorder_status":{"type":"string"},"visible":{"type":"string"},"is_default":{"type":"boolean"},"in_stock":{"type":"boolean"},"is_virtual":{"type":"boolean"},"downloadable":{"type":"boolean"},"manage_stock":{"type":"boolean"},"is_free_shipping":{"type":"boolean"},"seo_url":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_keywords":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"categories_ids":{"type":"array","description":"If an empty array is passed, all entries will be deleted when the 'nested_items_update_behaviour' parameter is set to 'replace'.","items":{"type":"string"}},"stores_ids":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"}},"images":{"type":"array","minItems":1,"description":"The passed items will completely replace the original items","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer"}},"required":["url"]}},"product_images_ids":{"type":"array","minItems":1,"items":{"minLength":1,"type":"string"},"x-conflictWith":["images"]},"related_products_ids":{"description":"If an empty array is passed, all entries will be deleted when the 'nested_items_update_behaviour' parameter is set to 'replace'.","type":"array","items":{"pattern":"^\\d+$","type":"string"}},"up_sell_products_ids":{"description":"If an empty array is passed, all entries will be deleted when the 'nested_items_update_behaviour' parameter is set to 'replace'.","type":"array","items":{"pattern":"^\\d+$","type":"string"}},"cross_sell_products_ids":{"description":"If an empty array is passed, all entries will be deleted when the 'nested_items_update_behaviour' parameter is set to 'replace'.","type":"array","items":{"pattern":"^\\d+$","type":"string"}}},"required":["id","product_id"]}},"idempotency_key":{"type":"string","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes."}},"required":["payload"]},"ProductVariantDeleteBatch":{"type":"object","properties":{"clear_cache":{"type":"boolean","default":false},"reindex":{"type":"boolean","default":false},"payload":{"type":"array","minItems":1,"maxItems":250,"description":"Contains an array of product variant deletion requests, each including the product ID and variant ID. The list of properties may vary depending on the specific platform.","items":{"type":"object","properties":{"product_id":{"type":"string"},"id":{"type":"string"},"store_id":{"type":"string"}},"required":["product_id","id"]}},"idempotency_key":{"type":"string","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes."}},"required":["payload"]},"ProductVariantImageAdd":{"type":"object","properties":{"product_id":{"name":"product_id","description":"Defines product id where the variant image has to be added","example":10,"type":"string"},"product_variant_id":{"name":"product_variant_id","description":"Defines product's variants specified by variant id","example":45,"type":"string"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"},"image_name":{"name":"image_name","description":"Defines image's name","example":"abibas.png","type":"string"},"type":{"name":"type","description":"Defines image's types that are specified by comma-separated list","example":"base","type":"string","enum":["small","base","additional","thumbnail"],"default":"base"},"url":{"name":"url","description":"Defines URL of the image that has to be added","example":"http://docs.api2cart.com/img/logo.png","type":"string"},"content":{"name":"content","description":"Content(body) encoded in base64 of image file","example":"/9j/4AAQSkZ...gD/2Q==","type":"string"},"label":{"name":"label","description":"Defines alternative text that has to be attached to the picture","example":"This cool image","type":"string"},"mime":{"name":"mime","description":"Mime type of image http://en.wikipedia.org/wiki/Internet_media_type.","example":"image/jpeg","type":"string"},"position":{"name":"position","description":"Defines image\u2019s position in the list","example":5,"type":"integer","default":0},"option_id":{"name":"option_id","description":"Defines option id of the product variant for which the image will be added","example":5,"type":"string"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["product_variant_id","image_name","type"]},"ProductVariantPriceAdd":{"type":"object","properties":{"id":{"name":"id","description":"Defines the variant to which the price has to be added","example":10,"type":"string"},"product_id":{"name":"product_id","description":"Product id","example":10,"type":"string"},"group_prices":{"type":"array","items":{"type":"object","properties":{"group_id":{"type":"string"},"price":{"type":"number"},"qty":{"type":"integer"}}},"description":"Defines variants's group prices"},"store_id":{"name":"store_id","description":"Store Id","example":"1","type":"string"}},"required":["group_prices"]},"ProductVariantPriceUpdate":{"type":"object","properties":{"id":{"name":"id","description":"Defines the variant where the price has to be updated","example":10,"type":"string"},"product_id":{"name":"product_id","description":"Product id","example":10,"type":"string"},"group_prices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"group_id":{"type":"string"},"price":{"type":"number"},"qty":{"type":"integer"}}},"description":"Defines variants's group prices"},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["group_prices"]},"Return":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"order_id":{"type":["string","null"]},"customer_id":{"type":["string","null"]},"store_id":{"type":["string","null"]},"created_at":{"type":["string","null"]},"modified_at":{"type":["string","null"]},"status":{"$ref":"#/components/schemas/Return_Status"},"order_products":{"type":"array","items":{"$ref":"#/components/schemas/Return_OrderProduct"}},"comment":{"type":["string","null"]},"staff_note":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Return_Status":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Return_OrderProduct":{"type":"object","properties":{"product_id":{"type":["string","null"]},"order_product_id":{"type":"string"},"sku":{"type":["string","null"]},"name":{"type":["string","null"]},"quantity":{"type":"integer"},"reason":{"$ref":"#/components/schemas/Return_Reason"},"action":{"anyOf":[{"$ref":"#/components/schemas/Return_Action"},{"type":"null"}]},"condition":{"type":["string","null"]},"customer_comment":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Return_Reason":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Return_Action":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Return_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Return_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Return_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"returns":{"type":"array","items":{"$ref":"#/components/schemas/Return"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Subscriber_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Subscriber_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Subscriber_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"subscribers":{"type":"array","items":{"$ref":"#/components/schemas/Subscriber"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Subscriber":{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":["string","null"]},"email":{"type":["string","null"]},"subscribed":{"type":["boolean","null"]},"first_name":{"type":["string","null"]},"last_name":{"type":["string","null"]},"stores_ids":{"type":"array","items":{"type":"string"}},"created_time":{"type":["string","null"]},"modified_time":{"type":["string","null"]},"lang_id":{"type":["string","null"]},"gender":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Tax_Class_Info":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Tax_Class_Info_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Tax_Class_Info_Result":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"avail":{"type":["boolean","null"]},"tax":{"type":["number","null"]},"tax_type":{"type":["integer","null"]},"created_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"tax_rates":{"type":"array","items":{"$ref":"#/components/schemas/TaxClass_Rate"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"TaxClass_Rate":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"tax":{"type":"number"},"tax_type":{"type":"integer"},"tax_based_on":{"type":"string"},"countries":{"type":"array","items":{"$ref":"#/components/schemas/TaxClass_Countries"}},"cities":{"type":"array","items":{"type":"string"}},"address":{"type":"array","items":{"type":"string"}},"zip_codes":{"type":"array","items":{"$ref":"#/components/schemas/TaxClass_ZipCodes"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"TaxClass_Countries":{"type":"object","properties":{"id":{"type":["string","null"]},"name":{"type":"string"},"code":{"type":"string"},"tax":{"type":"number"},"tax_type":{"type":"integer"},"states":{"type":"array","items":{"$ref":"#/components/schemas/TaxClass_States"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"TaxClass_States":{"type":"object","properties":{"id":{"type":["string","null"]},"tax":{"type":"number"},"tax_type":{"type":"integer"},"name":{"type":"string"},"code":{"type":"string"},"zip_codes":{"type":"array","items":{"$ref":"#/components/schemas/TaxClass_ZipCodes"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"TaxClass_ZipCodes":{"type":"object","properties":{"is_range":{"type":"boolean"},"range":{"type":"array","items":{"type":"string"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/TaxClass_ZipCodes_Range"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"TaxClass_ZipCodes_Range":{"type":"object","properties":{"from":{"type":["string","null"]},"to":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Model_Response_Tax_Class_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Tax_Class_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Tax_Class_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"tax_classes":{"type":"array","items":{"$ref":"#/components/schemas/TaxClass"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"TaxClass":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"avail":{"type":["boolean","null"]},"tax":{"type":["number","null"]},"tax_type":{"type":["integer","null"]},"created_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"modified_at":{"anyOf":[{"$ref":"#/components/schemas/A2CDateTime"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Webhook":{"type":"object","properties":{"id":{"type":["integer","null"]},"label":{"type":["string","null"]},"store_id":{"type":["string","null"]},"lang_id":{"type":["string","null"]},"active":{"type":["boolean","null"]},"callback":{"type":["string","null"]},"fields":{"type":["string","null"]},"response_fields":{"type":["string","null"]},"created_at":{"type":["string","null"]},"updated_at":{"type":["string","null"]},"entity":{"type":["string","null"]},"action":{"type":["string","null"]},"filtering_conditions":{"type":["object","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"WebhookCreate":{"type":"object","properties":{"entity":{"name":"entity","description":"Specify the entity that you want to enable webhooks for (e.g product, order, customer, category)","example":"product","type":"string"},"action":{"name":"action","description":"Specify what action (event) will trigger the webhook (e.g add, delete, or update)","example":"add","type":"string"},"callback":{"name":"callback","description":"Callback url that returns shipping rates. It should be able to accept POST requests with json data.","example":"https://example.com/callback","type":"string"},"label":{"name":"label","description":"The name you give to the webhook","example":"Super webhook","type":"string"},"fields":{"name":"fields","description":"Fields the webhook should send","example":"id, name, description","type":"string","default":"force_all"},"response_fields":{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","example":"{result}","type":"string"},"active":{"name":"active","description":"Webhook status","example":true,"type":"boolean","default":true},"lang_id":{"name":"lang_id","description":"Language id","example":3,"type":"string"},"store_id":{"name":"store_id","description":"Defines store id where the webhook should be assigned","example":"1","type":"string"},"filtering_conditions":{"name":"filtering_conditions","description":"

Defines the logic for filtering webhooks based on the entity's data. If provided, the webhook will only be sent if the entity matches the specified conditions. Pass null to disable filtering and receive all webhooks (for webhook.update method).

The filter accepts a recursive JSON object. The maximum nesting level is 5. Exceeding this will result in a validation error.

Strict Rule: Each level of the object must contain exactly one of the following keys:


Logical Operators:


Condition Object:


The list of available fields for filtering is returned by the webhook.events method in the filterable_fields property. The available fields depend on the webhook entity. If the list for a specific webhook is empty, it means that filtering is not supported for this entity or action.

The system validates operators against the field type defined in the entity schema.


Operators:


Please note: the filter is universal for all platforms; however, for some platforms, certain fields may never be populated. Before defining a filter, make sure that the field is populated for the specific platform. Otherwise, a webhook configured with such a filter may never be triggered.


","$ref":"#/components/schemas/ParamDefinition_FilteringConditions_FilterCondition","example":{"and":[{"field":"sku","operator":"eq","value":"sku123"},{"field":"price","operator":"gt","value":123}]}},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["entity","action"]},"ParamDefinition_FilteringConditions_FilterCondition":{"type":"object","oneOf":[{"description":"The object must match the structure defined by the 'ParamDefinition_FilteringConditions_FilterCondition' model.","$ref":"#/components/schemas/ParamDefinition_FilteringConditions_FilterGroup"},{"$ref":"#/components/schemas/ParamDefinition_FilteringConditions_FilterRule"}]},"ParamDefinition_FilteringConditions_FilterGroup":{"type":"object","properties":{"and":{"type":"array","items":{"type":"object"}},"or":{"type":"array","items":{"type":"object"}},"not":{"type":["object","null"]}}},"ParamDefinition_FilteringConditions_FilterRule":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"oneOf":[{"type":["string","null"]},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}}},"WebhookUpdate":{"type":"object","properties":{"id":{"name":"id","description":"Webhook id","example":"25","type":"string"},"callback":{"name":"callback","description":"Callback url that returns shipping rates. It should be able to accept POST requests with json data.","example":"https://example.com/callback","type":"string"},"label":{"name":"label","description":"The name you give to the webhook","example":"Super webhook","type":"string"},"fields":{"name":"fields","description":"Fields the webhook should send","example":"id, name, description","type":"string"},"response_fields":{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","example":"{result}","type":"string"},"active":{"name":"active","description":"Webhook status","example":true,"type":"boolean"},"lang_id":{"name":"lang_id","description":"Language id","example":3,"type":"string"},"filtering_conditions":{"name":"filtering_conditions","description":"

Defines the logic for filtering webhooks based on the entity's data. If provided, the webhook will only be sent if the entity matches the specified conditions. Pass null to disable filtering and receive all webhooks (for webhook.update method).

The filter accepts a recursive JSON object. The maximum nesting level is 5. Exceeding this will result in a validation error.

Strict Rule: Each level of the object must contain exactly one of the following keys:


Logical Operators:


Condition Object:


The list of available fields for filtering is returned by the webhook.events method in the filterable_fields property. The available fields depend on the webhook entity. If the list for a specific webhook is empty, it means that filtering is not supported for this entity or action.

The system validates operators against the field type defined in the entity schema.


Operators:


Please note: the filter is universal for all platforms; however, for some platforms, certain fields may never be populated. Before defining a filter, make sure that the field is populated for the specific platform. Otherwise, a webhook configured with such a filter may never be triggered.


","$ref":"#/components/schemas/ParamDefinition_FilteringConditions_FilterCondition","example":{"and":[{"field":"sku","operator":"eq","value":"sku123"},{"field":"price","operator":"gt","value":123}]}},"idempotency_key":{"name":"idempotency_key","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes.","example":"098f6bcd4621d373cade4e832627b4f6","type":"string"}},"required":["id"]}} }, "externalDocs": { "description": "Find out more about API2Cart", "url": "http://docs.api2cart.com" } }