action api2cart_order_add {
  label: "OrderAdd"
  description: "Add a new order to the cart."
  provider: api2cart
  method: POST
  path: "/order.add.json"
  encoding: json
  input: {
    type: "object"
    required: ["bill_address_1", "bill_city", "bill_country", "bill_first_name", "bill_last_name", "bill_postcode", "bill_state", "customer_email", "order_item", "order_status"]
    properties: {
      admin_comment: {
        type: "string"
        description: "Specifies admin's order comment"
      }
      admin_private_comment: {
        type: "string"
        description: "Specifies private admin's order comment"
      }
      bill_address_1: {
        type: "string"
        description: "Specifies first billing address"
      }
      bill_address_2: {
        type: "string"
        description: "Specifies second billing address"
      }
      bill_city: {
        type: "string"
        description: "Specifies billing city"
      }
      bill_company: {
        type: "string"
        description: "Specifies billing company"
      }
      bill_country: {
        type: "string"
        description: "Specifies billing country code"
      }
      bill_fax: {
        type: "string"
        description: "Specifies billing fax"
      }
      bill_first_name: {
        type: "string"
        description: "Specifies billing first name"
      }
      bill_last_name: {
        type: "string"
        description: "Specifies billing last name"
      }
      bill_phone: {
        type: "string"
        description: "Specifies billing phone"
      }
      bill_postcode: {
        type: "string"
        description: "Specifies billing postcode"
      }
      bill_state: {
        type: "string"
        description: "Specifies billing state code"
      }
      channel_id: {
        type: "string"
        description: "Channel ID"
      }
      clear_cache: {
        type: "boolean"
        description: "Is cache clear required"
      }
      comment: {
        type: "string"
        description: "Specifies order comment"
      }
      coupon_discount: {
        type: "number"
        description: "Specifies order's coupon discount"
      }
      coupons: {
        type: "array"
        description: "Coupons that will be applied to order"
        items: {
          type: "string"
        }
      }
      create_invoice: {
        type: "boolean"
        description: "Defines whether the invoice is created automatically along with the order"
      }
      currency: {
        type: "string"
        description: "Currency code of order"
      }
      customer_birthday: {
        type: "string"
        description: "Specifies customer’s birthday"
      }
      customer_email: {
        type: "string"
        description: "Defines the customer specified by email for whom order has to be created"
      }
      customer_fax: {
        type: "string"
        description: "Specifies customer’s fax"
      }
      customer_first_name: {
        type: "string"
        description: "Specifies customer's first name"
      }
      customer_last_name: {
        type: "string"
        description: "Specifies customer’s last name"
      }
      customer_phone: {
        type: "string"
        description: "Specifies customer’s phone"
      }
      date: {
        type: "string"
        description: "Specifies an order creation date in format Y-m-d H:i:s"
      }
      date_finished: {
        type: "string"
        description: "Specifies order's  finished date"
      }
      date_modified: {
        type: "string"
        description: "Specifies order's  modification date"
      }
      discount: {
        type: "number"
        description: "Specifies order's discount"
      }
      external_source: {
        type: "string"
        description: "Identifying the system used to generate the order"
      }
      financial_status: {
        type: "string"
        description: "Create order with financial status"
      }
      fulfillment_status: {
        type: "string"
        description: "Create order with fulfillment status"
      }
      gift_certificate_discount: {
        type: "number"
        description: "Discounts for order with gift certificates"
      }
      id: {
        type: "string"
        description: "Defines order's id"
      }
      inventory_behaviour: {
        type: "string"
        description: "The behaviour to use when updating inventory.<hr><div style=\"font-style:normal\">Values description:<div style=\"margin-left: 2%; padding-top: 2%\"><div style=\"font-size:85%\"><b>bypass</b> = Do not claim inventory </br></br><b>decrement_ignoring_policy</b> = Ignore the product's </br> inventory policy and claim amounts</br></br><b>decrement_obeying_policy</b> =  Obey the product's </br> inventory policy.</br></br></div></div></div>"
      }
      note_attributes: {
        type: "array"
        description: "Defines note attributes"
        items: {
          type: "object"
          properties: {
            name: {
              type: "string"
            }
            value: {
              type: "string"
            }
          }
        }
      }
      order_id: {
        type: "string"
        description: "Defines the order id if it is supported by the cart"
      }
      order_item: {
        type: "array"
        items: {
          type: "object"
          required: ["order_item_id", "order_item_name", "order_item_price", "order_item_quantity"]
          properties: {
            order_item_allow_refund_items_separately: {
              type: "boolean"
              description: "Indicates whether subitems of the grouped/bundle product can be refunded separately"
            }
            order_item_allow_ship_items_separately: {
              type: "boolean"
              description: "Indicates whether subitems of the grouped/bundle product can be shipped separately"
            }
            order_item_id: {
              type: "string"
              description: "Defines orders specified by order item id"
            }
            order_item_model: {
              type: "string"
              description: "Defines orders specified by order item model"
            }
            order_item_name: {
              type: "string"
              description: "Defines orders specified by order item name"
            }
            order_item_option: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  order_item_option_name: {
                    type: "string"
                    description: "Ordered Product Option Name. Where x is order item ID, y is order item option ID"
                  }
                  order_item_option_price: {
                    type: "number"
                    description: "Ordered product option price Where x is order item ID, y - order item option ID"
                  }
                  order_item_option_value: {
                    type: "string"
                    description: "Ordered product option value Where x is order item ID, y - order item option ID"
                  }
                }
              }
            }
            order_item_parent: {
              type: "integer"
              description: "Index of the parent grouped/bundle product"
            }
            order_item_parent_option_name: {
              type: "string"
              description: "Option name of the parent grouped/bundle product"
            }
            order_item_price: {
              type: "number"
              description: "Defines orders specified by order item price"
            }
            order_item_price_includes_tax: {
              type: "boolean"
              description: "Defines if item price includes tax"
            }
            order_item_property: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  order_item_property_name: {
                    type: "string"
                    description: "Ordered product property name. Where x is order item ID, y is order item property ID"
                  }
                  order_item_property_value: {
                    type: "string"
                    description: "Ordered product property value. Where x is order item ID, y - order item property ID"
                  }
                }
              }
            }
            order_item_quantity: {
              type: "integer"
              description: "Defines orders specified by order item quantity"
            }
            order_item_tax: {
              type: "number"
              description: "Percentage of tax for product order"
            }
            order_item_variant_id: {
              type: "string"
              description: "Ordered product variant. Where x is order item ID"
            }
            order_item_weight: {
              type: "number"
              description: "Defines orders specified by order item weight"
            }
          }
        }
      }
      order_payment_method: {
        type: "string"
        description: "Defines order payment method.<br/>Setting order_payment_method on Shopify will also change financial_status field value to 'paid'"
      }
      order_shipping_method: {
        type: "string"
        description: "Defines order shipping method"
      }
      order_status: {
        type: "string"
        description: "Defines order status."
      }
      prices_inc_tax: {
        type: "boolean"
        description: "Indicates whether prices and subtotal includes tax."
      }
      send_admin_notifications: {
        type: "boolean"
        description: "Notify admin when new order was created."
      }
      send_notifications: {
        type: "boolean"
        description: "Send notifications to customer after order was created"
      }
      shipp_address_1: {
        type: "string"
        description: "Specifies first shipping address"
      }
      shipp_address_2: {
        type: "string"
        description: "Specifies second address line of a shipping street address"
      }
      shipp_city: {
        type: "string"
        description: "Specifies shipping city"
      }
      shipp_company: {
        type: "string"
        description: "Specifies shipping company"
      }
      shipp_country: {
        type: "string"
        description: "Specifies shipping country code"
      }
      shipp_fax: {
        type: "string"
        description: "Specifies shipping fax"
      }
      shipp_first_name: {
        type: "string"
        description: "Specifies shipping first name"
      }
      shipp_last_name: {
        type: "string"
        description: "Specifies shipping last name"
      }
      shipp_phone: {
        type: "string"
        description: "Specifies shipping phone"
      }
      shipp_postcode: {
        type: "string"
        description: "Specifies shipping postcode"
      }
      shipp_state: {
        type: "string"
        description: "Specifies shipping state code"
      }
      shipping_price: {
        type: "number"
        description: "Specifies order's shipping price"
      }
      shipping_tax: {
        type: "number"
        description: "Specifies order's shipping price tax"
      }
      store_id: {
        type: "string"
        description: "Defines store id where the order should be assigned"
      }
      subtotal_price: {
        type: "number"
        description: "Total price of all ordered products multiplied by their number, excluding tax, shipping price and discounts"
      }
      tags: {
        type: "string"
        description: "Order tags"
      }
      tax_price: {
        type: "number"
        description: "The value of tax cost for order"
      }
      total_paid: {
        type: "number"
        description: "Defines total paid amount for the order"
      }
      total_price: {
        type: "number"
        description: "Defines order's total price"
      }
      total_weight: {
        type: "integer"
        description: "Defines the sum of all line item weights in grams for the order"
      }
      transaction_id: {
        type: "string"
        description: "Payment transaction id"
      }
    }
  }
  output: {
    type: "object"
    properties: {
      result: {
        type: "object"
        properties: {
          order_id: {
            type: "string"
          }
        }
      }
      return_code: {
        type: "integer"
      }
      return_message: {
        type: "string"
      }
    }
  }
}