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/info

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


                            Purchase Orders Info Data

                            Gets Purchase Orders info.
                            Filters
                            Filter the Purchase Orders into a list.
                            Parameter Type Rules Example
                            id int / array one id or multiple Lead Commerce purchase order ids
                            1 or array(3,8,9,45)

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

                            Response

                            Example JSON returned
                            {
                              "code": "200",
                              "data": {
                                "1": [
                                  {
                                    "id": "1",
                                    "display_id": "1",
                                    "total": "1790.00",
                                    "placed": "1436908691",
                                    "notes": "",
                                    "date_issued": "1436889600",
                                    "due_date": "1438358400",
                                    "fob": "112",
                                    "po_term": "1",
                                    "drop_ship": "1",
                                    "drop_ship_order": "2",
                                    "status": "3",
                                    "vendor": [
                                      {
                                        "id": "1",
                                        "name": "My Vendor"
                                      }
                                    ],
                                    "vendor_contact": [
                                      {
                                        "id": "1",
                                        "name": "Joe Smoe",
                                        "address_1": "1 World Trade Center",
                                        "address_2": "Suite 100",
                                        "city": "New York",
                                        "postal_code": "10007",
                                        "email": "joe237@gmail.com",
                                        "phone": "619-222-3333",
                                        "status": "1",
                                        "subregion": "New York",
                                        "region": "United States"
                                      }
                                    ],
                                    "term": [
                                      {
                                        "id": "3",
                                        "name": "T&C One"
                                      }
                                    ],
                                    "customer": [
                                      {
                                        "id": "1",
                                        "display_id": "1000",
                                        "first_name": "Bob",
                                        "last_name": "Smith",
                                        "email": "bob233@gmail.com",
                                        "phone": "619-233-2224",
                                        "fax": "619-233-2225"
                                      }
                                    ],
                                    "company": [
                                      {
                                        "id": "1",
                                        "name": "Bob's Pet Shop"
                                      }
                                    ],
                                    "attributes": [
                                      {
                                        "id": "7",
                                        "name": "BQ Code",
                                        "display_name": "BQ Code",
                                        "slug": "attr_bq_code",
                                        "value": "AAM"
                                      }
                                    ]
                                  }
                                ],
                                "2": [
                                  {
                                    "id": "2",
                                    "display_id": "2",
                                    "total": "44.75",
                                    "placed": "1436981692",
                                    "notes": "",
                                    "date_issued": "1436976000",
                                    "due_date": "1438358400",
                                    "fob": "AAW",
                                    "po_term": "1",
                                    "drop_ship": "0",
                                    "drop_ship_order": "",
                                    "status": "3",
                                    "vendor": [
                                      {
                                        "id": "1",
                                        "name": "My Vendor"
                                      }
                                    ],
                                    "vendor_contact": [
                                      {
                                        "id": "1",
                                        "name": "Joe Smoe",
                                        "address_1": "1 World Trade Center",
                                        "address_2": "Suite 100",
                                        "city": "New York",
                                        "postal_code": "10007",
                                        "email": "joe237@gmail.com",
                                        "phone": "619-222-3333",
                                        "status": "1",
                                        "subregion": "New York",
                                        "region": "United States"
                                      }
                                    ],
                                    "term": [
                                      {
                                        "id": "3",
                                        "name": "T&C One"
                                      }
                                    ],
                                    "customer": null,
                                    "company": null,
                                    "attributes": [
                                      {
                                        "id": "7",
                                        "name": "BQ Code",
                                        "display_name": "BQ Code",
                                        "slug": "attr_bq_code",
                                        "value": "AAQ"
                                      }
                                    ]
                                  }
                                ]
                              }
                            }
                            

                            Start your free, no-risk trial today.