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_product

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


                            Purchase Orders Info Product Data

                            Gets Purchase Orders Product info.
                            Filters
                            Filter the Purchase Order Products 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": {
                                "5": [
                                  {
                                    "id": "1",
                                    "sku": "20000-0001-1",
                                    "qty": "10",
                                    "cost": "8.95",
                                    "total": "89.50",
                                    "received": "0",
                                    "overlay_sku": "",
                                    "overlay_product": "",
                                    "overlay_variation": "",
                                    "overlay_qty": "",
                                    "overlay_status": "",
                                    "status": "4",
                                    "drop_ship": "0",
                                    "product": [
                                      {
                                        "id": "1",
                                        "display_id": "20000",
                                        "name": "Modern-Fit Vest"
                                      }
                                    ],
                                    "ship_to": [
                                      {
                                        "id": "1",
                                        "name": "Bob Smith",
                                        "business_name": "San Jose",
                                        "address_1": "101 Main St",
                                        "address_2": "Ste 222",
                                        "city": "San Jose",
                                        "postal_code": "92001",
                                        "phone": "2069238660",
                                        "subregion": "California",
                                        "region": "United States"
                                      }
                                    ]
                                  },
                                  {
                                    "id": "2",
                                    "sku": "20000-0002-1",
                                    "qty": "10",
                                    "cost": "8.95",
                                    "total": "89.50",
                                    "received": "0",
                                    "overlay_sku": "",
                                    "overlay_product": "",
                                    "overlay_variation": "",
                                    "overlay_qty": "",
                                    "overlay_status": "",
                                    "status": "4",
                                    "drop_ship": "0",
                                    "product": [
                                      {
                                        "id": "1",
                                        "display_id": "20000",
                                        "name": "Modern-Fit Vest"
                                      }
                                    ],
                                    "ship_to": [
                                      {
                                        "id": "1",
                                        "name": "Bob Smith",
                                        "business_name": "San Jose",
                                        "address_1": "101 Main St",
                                        "address_2": "Ste 222",
                                        "city": "San Jose",
                                        "postal_code": "92001",
                                        "phone": "2069238660",
                                        "subregion": "California",
                                        "region": "United States"
                                      }
                                    ]
                                  }
                                ],
                                "6": [
                                  {
                                    "id": "1",
                                    "sku": "20001-0005-1",
                                    "qty": "1",
                                    "cost": "6.95",
                                    "total": "6.95",
                                    "received": "2",
                                    "overlay_sku": "",
                                    "overlay_product": "",
                                    "overlay_variation": "",
                                    "overlay_qty": "",
                                    "overlay_status": "",
                                    "status": "4",
                                    "drop_ship": "1",
                                    "product": [
                                      {
                                        "id": "2",
                                        "display_id": "20001",
                                        "name": "Fleece Curved Pocket Hoodie"
                                      }
                                    ],
                                    "ship_to": [
                                      {
                                        "id": "5",
                                        "name": "Jane Doe",
                                        "business_name": "Jane's Pet Shop",
                                        "address_1": "5008 Telegraph Ave",
                                        "address_2": "Ste 2342",
                                        "city": "Oakland",
                                        "postal_code": "94609",
                                        "phone": "858-343-8767",
                                        "status": "1",
                                        "subregion": "California",
                                        "region": "United States"
                                      }
                                    ]
                                  }
                                ]
                              }
                            }
                            

                            Start your free, no-risk trial today.