action api2cart_product_add {
  label: "ProductAdd"
  description: "Add new product to store."
  provider: api2cart
  method: POST
  path: "/product.add.json"
  encoding: json
  input: {
    type: "object"
    required: ["description", "model", "name", "price"]
    properties: {
      attribute_name: {
        type: "string"
        description: "Defines product’s attribute name separated with a comma in Magento"
      }
      attribute_set_name: {
        type: "string"
        description: "Defines product’s attribute set name in Magento"
      }
      avail_from: {
        type: "string"
        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."
      }
      available_for_sale: {
        type: "boolean"
        description: "Specifies the set of visible/invisible products for sale"
      }
      available_for_view: {
        type: "boolean"
        description: "Specifies the set of visible/invisible products for users"
      }
      backorder_status: {
        type: "string"
        description: "Set backorder status"
      }
      barcode: {
        type: "string"
        description: "A barcode is a unique code composed of numbers used as a product identifier."
      }
      best_offer: {
        type: "array"
        description: "The price at which Best Offers are automatically accepted.<hr><div style=\"font-style:normal\">Param structure:<div style=\"margin-left: 2%;\"><code style=\"padding:0; background-color:#ffffff;font-size:85%;font-family:monospace;\">best_offer[<b>minimum_offer_price</b>] = decimal</br>best_offer[<b>auto_accept_price</b>] = decimal</br></code></div></div>"
        items: {
          type: "string"
        }
      }
      brand_name: {
        type: "string"
        description: "Retrieves brands specified by brand name"
      }
      categories_ids: {
        type: "string"
        description: "Defines product add that is specified by comma-separated categories id"
      }
      category_id: {
        type: "string"
        description: "Defines product add that is specified by category id"
      }
      clear_cache: {
        type: "boolean"
        description: "Is cache clear required"
      }
      condition: {
        type: "string"
        description: "The human-readable label for the condition (e.g., \"New\")."
      }
      cost_price: {
        type: "number"
        description: "Defines new product's cost price"
      }
      country_of_origin: {
        type: "string"
        description: "The country where the inventory item was made"
      }
      created_at: {
        type: "string"
        description: "Defines the date of entity creation"
      }
      description: {
        type: "string"
        description: "Defines product's description that has to be added"
      }
      downloadable: {
        type: "boolean"
        description: "Defines whether the product is downloadable"
      }
      ean: {
        type: "string"
        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."
      }
      files: {
        type: "array"
        description: "File Url"
        items: {
          type: "object"
          required: ["name", "url"]
          properties: {
            name: {
              type: "string"
            }
            url: {
              type: "string"
            }
          }
        }
      }
      group_prices: {
        type: "array"
        description: "Defines product's group prices"
        items: {
          type: "object"
          properties: {
            group_id: {
              type: "string"
            }
            price: {
              type: "number"
            }
          }
        }
      }
      gtin: {
        type: "string"
        description: "Global Trade Item Number. An GTIN is an identifier for trade items."
      }
      harmonized_system_code: {
        type: "string"
        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"
      }
      height: {
        type: "number"
        description: "Defines product's height"
      }
      image_name: {
        type: "string"
        description: "Defines image's name"
      }
      image_url: {
        type: "string"
        description: "Image Url"
      }
      isbn: {
        type: "string"
        description: "International Standard Book Number. An ISBN is a unique identifier for books."
      }
      lang_id: {
        type: "string"
        description: "Language id"
      }
      length: {
        type: "number"
        description: "Defines product's length"
      }
      listing_duration: {
        type: "string"
        description: "Describes the number of days the seller wants the listing to be active. Look at cart.info method response for allowed values."
      }
      listing_type: {
        type: "string"
        description: "Indicates the selling format of the marketplace listing."
      }
      manage_stock: {
        type: "boolean"
        description: "Defines inventory tracking for product"
      }
      manufacturer: {
        type: "string"
        description: "Defines product's manufacturer"
      }
      marketplace_item_properties: {
        type: "string"
        description: "String containing the JSON representation of the supplied data"
      }
      meta_description: {
        type: "string"
        description: "Defines unique meta description of a entity"
      }
      meta_keywords: {
        type: "string"
        description: "Defines unique meta keywords for each entity"
      }
      meta_title: {
        type: "string"
        description: "Defines unique meta title for each entity"
      }
      model: {
        type: "string"
        description: "Defines product's model that has to be added"
      }
      mpn: {
        type: "string"
        description: "Manufacturer Part Number. A MPN is an identifier of a particular part design or material used."
      }
      name: {
        type: "string"
        description: "Defines product's name that has to be added"
      }
      old_price: {
        type: "number"
        description: "Defines product's old price"
      }
      ordered_count: {
        type: "integer"
        description: "Defines how many times the product was ordered"
      }
      package_details: {
        type: "array"
        description: "If the seller is subscribed to \"Business Policies\", use the seller_profiles instead of the shipping_details, payment_methods and return_accepted params.<hr><div style=\"font-style:normal\">Param structure:<div style=\"margin-left: 2%;\"><code style=\"padding:0; background-color:#ffffff;font-size:85%;font-family:monospace;\">package_details[<b>measure_unit</b>] = string</br> Allowed measure_unit values: [English or Metric] </br> Default: Metric</br>package_details[<b>weigh_unit</b>] = string</br> Allowed weigh_unit values: [kg, g, lbs, oz]</br>package_details[<b>package_depth</b>] = decimal</br>package_details[<b>package_length</b>] = decimal</br>package_details[<b>package_width</b>] = decimal</br>package_details[<b>weight_major</b>] = decimal</br>package_details[<b>weight_minor</b>] = decimal</br>package_details[<b>shipping_package</b>] = string</br> See cart.info method, param `eBay_shipping_package_details`</code></div></div>"
        items: {
          type: "string"
        }
      }
      payment_methods: {
        type: "array"
        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.<hr><div style=\"font-style:normal\">Param structure:<div style=\"margin-left: 2%;\"><code style=\"padding:0; background-color:#ffffff;font-size:85%;font-family:monospace;\">payment_methods[0] = string</br>payment_methods[1] = string</br></code></div></div>"
        items: {
          type: "string"
        }
      }
      paypal_email: {
        type: "string"
        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."
      }
      price: {
        type: "number"
        description: "Defines product's price that has to be added"
      }
      product_class: {
        type: "string"
        description: "A categorization for the product"
      }
      quantity: {
        type: "number"
        description: "Defines product's quantity that has to be added"
      }
      return_accepted: {
        type: "boolean"
        description: "Indicates whether the seller allows the buyer to return the item."
      }
      sales_tax: {
        type: "array"
        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.<hr><div style=\"font-style:normal\">Param structure:<div style=\"margin-left: 2%;\"><code style=\"padding:0; background-color:#ffffff;font-size:85%;font-family:monospace;\">sales_tax[<b>tax_percent</b>] = decimal (##.###)</br>sales_tax[<b>tax_state</b>] = string</br>sales_tax[<b>shipping_inc_in_tax</b>] = bool</br></code></div></div>"
        items: {
          type: "string"
        }
      }
      search_keywords: {
        type: "string"
        description: "Defines unique search keywords"
      }
      seller_profiles: {
        type: "object"
        description: "If the seller is subscribed to \"Business Policies\", use the seller_profiles instead of the shipping_details, payment_methods and return_accepted params.<hr><div style=\"font-style:normal\">Param structure:<div style=\"margin-left: 2%;\"><code style=\"padding:0; background-color:#ffffff;font-size:85%;font-family:monospace;\">seller_profiles[<b>shipping_profile_id</b>] = integer</br>seller_profiles[<b>payment_profile_id</b>] = integer</br>seller_profiles[<b>return_profile_id</b>] = integer</br></code></div></div>"
        properties: {
          payment_profile_id: {
            type: "string"
          }
          return_profile_id: {
            type: "string"
          }
          shipping_profile_id: {
            type: "string"
          }
        }
      }
      seo_url: {
        type: "string"
        description: "Defines unique URL for SEO"
      }
      shipping_details: {
        type: "array"
        description: "The shipping details, including flat and calculated shipping costs and shipping insurance costs. Look at cart.info method response for allowed values.<hr><div style=\"font-style:normal\">Param structure:<div style=\"margin-left: 2%;\"><code style=\"padding:0; background-color:#ffffff;font-size:85%;font-family:monospace;\">shipping_details[0][<b>shipping_type</b>] = string </br>shipping_details[0][<b>shipping_service</b>] = string</br>shipping_details[0][<b>shipping_cost</b>] = decimal</br>shipping_details[1][<b>shipping_type</b>] = string </br>shipping_details[1][<b>shipping_service</b>] = string</br>shipping_details[1][<b>shipping_cost</b>] = decimal</br></code></div></div>"
        items: {
          type: "object"
          properties: {
            shipping_cost: {
              type: "number"
            }
            shipping_service: {
              type: "string"
            }
            shipping_type: {
              type: "string"
            }
          }
        }
      }
      shipping_template_id: {
        type: "integer"
        description: "The numeric ID of the shipping template associated with the products in Etsy."
      }
      short_description: {
        type: "string"
        description: "Defines short description"
      }
      sku: {
        type: "string"
        description: "Defines product's sku that has to be added"
      }
      special_price: {
        type: "number"
        description: "Defines product's model that has to be added"
      }
      specifics: {
        type: "array"
        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        <hr>\n        <div style=\"font-style:normal\">Param structure:\n          <div style=\"margin-left: 2%;\">\n            <code style=\"padding:0; background-color:#ffffff;font-size:85%;font-family:monospace;\">\n              specifics[int][<b>name</b>] = string</br>\n              specifics[int][<b>value</b>] = string</br>\n            </code>\n          </div>\n        </div>"
        items: {
          type: "string"
        }
      }
      sprice_create: {
        type: "string"
        description: "Defines the date of special price creation"
      }
      sprice_expire: {
        type: "string"
        description: "Defines the term of special price offer duration"
      }
      sprice_modified: {
        type: "string"
        description: "Defines the date of special price modification"
      }
      status: {
        type: "string"
        description: "Defines product's status"
      }
      store_id: {
        type: "string"
        description: "Store Id"
      }
      stores_ids: {
        type: "string"
        description: "Assign product to the stores that is specified by comma-separated stores' id"
      }
      tags: {
        type: "string"
        description: "Product tags"
      }
      tax_class_id: {
        type: "integer"
        description: "Defines tax classes where entity has to be added"
      }
      taxable: {
        type: "boolean"
        description: "Specifies whether a tax is charged"
      }
      tier_prices: {
        type: "array"
        description: "Defines product's tier prices"
        items: {
          type: "object"
          properties: {
            price: {
              type: "number"
            }
            quantity: {
              type: "number"
            }
          }
        }
      }
      type: {
        type: "string"
        description: "Defines product's type"
      }
      upc: {
        type: "string"
        description: "Universal Product Code. A UPC (UPC-A) is a commonly used identifer for many different products."
      }
      url: {
        type: "string"
        description: "Defines unique product's URL"
      }
      viewed_count: {
        type: "integer"
        description: "Specifies the number of product's reviews"
      }
      visible: {
        type: "string"
        description: "Set visibility status"
      }
      warehouse_id: {
        type: "string"
        description: "This parameter is used for selecting a warehouse where you need to set/modify a product quantity."
      }
      weight: {
        type: "number"
        description: "Weight"
      }
      weight_unit: {
        type: "string"
        description: "Weight Unit"
      }
      wholesale_price: {
        type: "number"
        description: "Defines product's sale price"
      }
      width: {
        type: "number"
        description: "Defines product's width"
      }
    }
  }
  output: {
    type: "object"
    properties: {
      result: {
        type: "object"
        properties: {
          product_id: {
            type: "string"
          }
        }
      }
      return_code: {
        type: "integer"
      }
      return_message: {
        type: "string"
      }
    }
  }
}