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_receivement

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


                            Purchase Orders Info Receivement Data

                            Gets Purchase Orders Receivement info.
                            Filters
                            Filter the Purchase Order Receivement 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": {
                                "3": [
                                  {
                                    "id": "3",
                                    "qty": "65",
                                    "num_line_items": "3",
                                    "received_on": "1434993722",
                                    "status": "3",
                                    "warehouse": [
                                      {
                                        "id": "1",
                                        "name": "La Mesa"
                                      }
                                    ],
                                    "items": {
                                      "1": [
                                        {
                                          "id": "21",
                                          "sku": "20001-0009",
                                          "received": "10",
                                          "product": [
                                            {
                                              "id": "2",
                                              "display_id": "20001",
                                              "name": "Fleece Curved Pocket Hoodie"
                                            }
                                          ]
                                        }
                                      ],
                                      "3": [
                                        {
                                          "id": "23",
                                          "sku": "20001-0011",
                                          "received": "20",
                                          "product": [
                                            {
                                              "id": "2",
                                              "display_id": "20001",
                                              "name": "Fleece Curved Pocket Hoodie"
                                            }
                                          ]
                                        }
                                      ],
                                      "4": [
                                        {
                                          "id": "24",
                                          "sku": "20001-0012",
                                          "received": "35",
                                          "product": [
                                            {
                                              "id": "2",
                                              "display_id": "20001",
                                              "name": "Fleece Curved Pocket Hoodie"
                                            }
                                          ]
                                        }
                                      ]
                                    }
                                  },
                                  {
                                    "id": "4",
                                    "qty": "135",
                                    "num_line_items": "3",
                                    "received_on": "1435003945",
                                    "status": "3",
                                    "warehouse": [
                                      {
                                        "id": "1",
                                        "name": "La Mesa"
                                      }
                                    ],
                                    "items": {
                                      "1": [
                                        {
                                          "id": "21",
                                          "sku": "20001-0009",
                                          "received": "40",
                                          "product": [
                                            {
                                              "id": "2",
                                              "display_id": "20001",
                                              "name": "Fleece Curved Pocket Hoodie"
                                            }
                                          ]
                                        }
                                      ],
                                      "3": [
                                        {
                                          "id": "23",
                                          "sku": "20001-0011",
                                          "received": "45",
                                          "product": [
                                            {
                                              "id": "2",
                                              "display_id": "20001",
                                              "name": "Fleece Curved Pocket Hoodie"
                                            }
                                          ]
                                        }
                                      ],
                                      "4": [
                                        {
                                          "id": "24",
                                          "sku": "20001-0012",
                                          "received": "50",
                                          "product": [
                                            {
                                              "id": "2",
                                              "display_id": "20001",
                                              "name": "Fleece Curved Pocket Hoodie"
                                            }
                                          ]
                                        }
                                      ]
                                    }
                                  }
                                ],
                                "6": [
                                  {
                                    "id": "6",
                                    "qty": "100",
                                    "num_line_items": "4",
                                    "received_on": "1435015752",
                                    "status": "3",
                                    "warehouse": [
                                      {
                                        "id": "1",
                                        "name": "La Mesa"
                                      }
                                    ],
                                    "items": {
                                      "1": [
                                        {
                                          "id": "17",
                                          "sku": "20001-0005",
                                          "received": "25",
                                          "product": [
                                            {
                                              "id": "2",
                                              "display_id": "20001",
                                              "name": "Fleece Curved Pocket Hoodie"
                                            }
                                          ]
                                        }
                                      ],
                                      "2": [
                                        {
                                          "id": "18",
                                          "sku": "20001-0006",
                                          "received": "25",
                                          "product": [
                                            {
                                              "id": "2",
                                              "display_id": "20001",
                                              "name": "Fleece Curved Pocket Hoodie"
                                            }
                                          ]
                                        }
                                      ],
                                      "3": [
                                        {
                                          "id": "19",
                                          "sku": "20001-0007",
                                          "received": "25",
                                          "product": [
                                            {
                                              "id": "2",
                                              "display_id": "20001",
                                              "name": "Fleece Curved Pocket Hoodie"
                                            }
                                          ]
                                        }
                                      ],
                                      "4": [
                                        {
                                          "id": "20",
                                          "sku": "20001-0008",
                                          "received": "25",
                                          "product": [
                                            {
                                              "id": "2",
                                              "display_id": "20001",
                                              "name": "Fleece Curved Pocket Hoodie"
                                            }
                                          ]
                                        }
                                      ]
                                    }
                                  }
                                ]
                              }
                            }
                            

                            Start your free, no-risk trial today.