action api2cart_order_shipment_add {
  label: "OrderShipmentAdd"
  description: "Add a shipment to the order."
  provider: api2cart
  method: POST
  path: "/order.shipment.add.json"
  encoding: json
  input: {
    type: "object"
    properties: {
      adjust_stock: {
        type: "boolean"
        description: "This parameter is used for adjust stock."
      }
      enable_cache: {
        type: "boolean"
        description: "If the value is 'true' and order exist in our cache, we will use order.info from cache to prepare shipment items."
      }
      is_shipped: {
        type: "boolean"
        description: "Defines shipment's status"
      }
      items: {
        type: "array"
        description: "Defines items in the order that will be shipped"
        items: {
          type: "object"
          properties: {
            order_product_id: {
              type: "string"
            }
            quantity: {
              type: "number"
            }
          }
        }
      }
      order_id: {
        type: "string"
        description: "Defines the order for which the shipment will be created"
      }
      send_notifications: {
        type: "boolean"
        description: "Send notifications to customer after shipment was created"
      }
      shipment_provider: {
        type: "string"
        description: "Defines company name that provide tracking of shipment"
      }
      shipping_method: {
        type: "string"
        description: "Define shipping method"
      }
      store_id: {
        type: "string"
        description: "Store Id"
      }
      tracking_link: {
        type: "string"
        description: "Defines custom tracking link"
      }
      tracking_numbers: {
        type: "array"
        description: "Defines shipment's tracking numbers that have to be added</br> How set tracking numbers to appropriate carrier:<ul><li>tracking_numbers[]=a2c.demo1,a2c.demo2 - set default carrier</li><li>tracking_numbers[<b>carrier_id</b>]=a2c.demo - set appropriate carrier</li></ul>To get the list of carriers IDs that are available in your store, use the <a href = \"https://api2cart.com/docs/#/cart/CartInfo\">cart.info</a > method"
        items: {
          type: "object"
          properties: {
            carrier_id: {
              type: "string"
            }
            tracking_number: {
              type: "string"
            }
          }
        }
      }
      warehouse_id: {
        type: "string"
        description: "This parameter is used for selecting a warehouse where you need to set/modify a product quantity."
      }
    }
  }
  output: {
    type: "object"
    properties: {
      result: {
        type: "object"
        properties: {
          shipment_id: {
            type: "string"
          }
        }
      }
      return_code: {
        type: "integer"
      }
      return_message: {
        type: "string"
      }
    }
  }
}