API Version 2
  • API V2 Overview
  • Category
    • Company
      • Customers
        • Orders
          • Pages
            • Page Templates
              • Products
                • Purchase Orders
                  • SKUs
                    • Support Tickets
                      • Tax Regions
                        • Vendors
                          • Warehouses
                            API Documentation

                            purchaseorders

                            Type List
                            List PurchaseOrders
                            URL http://{domain}/api/v2/purchaseorders.json
                            Accepts Filters Yes
                            Output Attributes
                            No


                            List Purchase Orders

                            Gets the filtered list of Purchase Orders.
                            Filters
                            Filter the Purchase Orders into a list. Purchase Order Attributes are available as a filter.
                            Parameter Type Rules Example
                            status int
                            1
                            display_id int The Display ID of the PO
                            2
                            vendor int The ID of the Vendor
                            2
                            warehouse int The ID of the Warehouse
                            1
                            drop_ship boolean Is this a drop ship or not false
                            total_max float Maximum total range 1000
                            total_min float Minimum total range 200
                            first_receivement_start date
                            1431377356
                            first_receivement_end date
                            1431377356
                            fully_received_start date
                            1431377356
                            fully_received_end date
                            1431377356
                            placed_start date
                            1431377356
                            placed_end date
                            1431377356
                            date_issued_start date
                            1431377356
                            date_issued_end date
                            1431377356
                            due_date_start date
                            1431377356
                            due_date_end date
                            1431377356
                            modify_start date
                            1431377356
                            modify_end date
                            1431377356
                            Pagination
                            Parameters can be added to the CURL call to paginate the List. The maximum limit is 250. By default, this limit is set to 100.
                            Parameter Type Default Example
                            limit int 1 2
                            page int 1 5

                            Purchase Order Status
                            1 Pending
                            2 Partially Received
                            3 Received
                            4 Draft
                            5 Canceled
                            6
                            Over Received

                            Response

                            Example JSON returned
                            {
                              "code": "200",
                              "data": [
                                {
                                  "id": "2",
                                  "display_id": "2",
                                  "total": "35800.00",
                                  "status": "3",
                                  "vendor": [
                                    {
                                      "id": "1",
                                      "name": "My Vendor"
                                    }
                                  ]
                                },
                                {
                                  "id": "1",
                                  "display_id": "1",
                                  "total": "63600.00",
                                  "status": "3",
                                  "vendor": [
                                    {
                                      "id": "1",
                                      "name": "My Vendor"
                                    }
                                  ]
                                }
                              ]
                            }
                            

                            Start your free, no-risk trial today.