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)
                            show_lot show lot information
                            1

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

                            Request

                            Example cURL sent
                            curl --location --request POST 'https://{yoursite}/api/v2/orders/info_fulfillments.json' 
                            -H '{yourkey}' 
                            -H 'Content-Type: application/x-www-form-urlencoded' 
                            --form 'id[0]="2"' 
                            --form 'show_lot="1"'
                            

                            Response

                            Example JSON returned
                            {
                                "code": "200",
                                "data": {
                                    "2": [
                                        {
                                            "id": "1",
                                            "qty": "4.52140000",
                                            "num_line_items": "2",
                                            "received_on": "1525802044",
                                            "status": "3",
                                            "warehouse": [
                                                {
                                                    "id": "1",
                                                    "name": "San Diego"
                                                }
                                            ],
                                            "items": {
                                                "1": [
                                                    {
                                                        "id": "3",
                                                        "sku": "450-0003-1",
                                                        "received": "2",
                                                        "product": [
                                                            {
                                                                "id": "1",
                                                                "display_id": "450",
                                                                "name": "Modern-Fit Vest"
                                                            }
                                                        ],
                                                        "lots": {
                                                            "27": {
                                                                "lot": "27",
                                                                "custom_lot": "",
                                                                "condition": "New",
                                                                "qty": "2",
                                                                "serial_number": "",
                                                                "dom": "",
                                                                "expiration": ""
                                                            }
                                                        }
                                                    }
                                                ],
                                                "2": [
                                                    {
                                                        "id": "41",
                                                        "sku": "powerranger",
                                                        "received": "7.0428",
                                                        "product": [
                                                            {
                                                                "id": "15",
                                                                "display_id": "powerranger",
                                                                "name": "Power Ranger"
                                                            }
                                                        ],
                                                        "lots": {
                                                            "28": {
                                                                "lot": "28",
                                                                "custom_lot": "28",
                                                                "condition": "New",
                                                                "qty": "7.0428",
                                                                "serial_number": "",
                                                                "dom": "",
                                                                "expiration": ""
                                                            }
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                            

                            Start your free, no-risk trial today.