/purchase.order.va.details.list

Returns a list of Purchase Orders with their corresponding details from the Vendor Availability based on the applied filters.

Request

URL: https://api.kometsales.com/api/purchase.order.va.details.list

Method: GET

Content-Type: URL Params. 

Input parameters

• authenticationToken (required)(string:50): Komet Sales security token.

• purchaseOrderNumbers (optional)(string:200): purchase order number. You may send a set of numbers separated by commas. 

• purchaseOrderItemIds (optional)(string:200): A set of purchase order item IDs separated by commas. This is very useful for the Vendor Availability integration. 

• shipDate (optional)(date): the date when the order will be shipped. (format YYYY-MM-DD).

You must send at least one of these filters: purchaseOrderNumbers or purchaseOrderItemIds. 

curl

https://api.kometsales.com/api/purchase.order.va.details.list?authenticationToken=token_info_goes_here&shipDate=2015-07-24
&purchaseOrderItemIds=123445,2342343

Response

Output

• status (integer:1): transaction status. 1 for success or 0 for failure.

• message (string:500): description of the status of the transaction.

• purchaseOrders: array of purchase orders

  • id (integer:20): Komet Sales internal purchase order ID.

  • number (integer:10): purchase order number.

  • shipDate (date): order ship date. (date format YYYY-MM-DD).

  • details: array of purchase orders details.

    • poItemId (integer:20): PO item internal ID.

    • vendorAvailabilityDetails: details of the vendor availability items associated with this line of the order. 

      • productDescription (string:200): product description.

      • availableFrom (date): The date when the product was available from the vendor. (date format YYYY-MM-DD).

      • postHarvest (string:20): post-harvest. 

      • unitType (string:20): unit type. Stem or Bunch. 

      • unitsAllocated (integer:10): number of units allocated to this line of the order.

      • downgraded (boolean): true if the product was downgraded.

      • originalProductDescription (string:200): Product where the item was downgraded from. 

Sample Response

{
  "status": 1,
  "message": "Successful",
  "purchaseOrders": [
    {
      "id": 1358112,
      "number": "P002296",
      "shipDate": "2016-12-15",
      "details": [
        {
          "poItemId": 5131941,
          "vendorAvailabilityDetails": [
            {
              "productDescription": "Roses Yellow Yokohama 70",
              "availableFrom": "2016-12-10",
              "postHarvest": "C4",
              "downgraded": false,
              "originalProductDescription": "",
              "unitType": "Bunch",
              "unitsAllocated": 2
            }
          ]
        },
        {
          "poItemId": 5131943,
          "vendorAvailabilityDetails": [
            {
              "productDescription": "Yellow Roses Yokohama 50",
              "availableFrom": "2016-12-10",
              "postHarvest": "C4",
              "downgraded": true,
              "originalProductDescription": "Roses Yellow Yokohama 70",
              "unitType": "Stem",
              "unitsAllocated": 27
            }
          ]
        },
        {
          "poItemId": 5131947,
          "vendorAvailabilityDetails": [
            {
              "productDescription": "Yellow Roses Yokohama 50",
              "availableFrom": "2016-12-10",
              "postHarvest": "C4",
              "downgraded": true,
              "originalProductDescription": "Roses Yellow Yokohama 60",
              "unitType": "Bunch",
              "unitsAllocated": 9
            }
          ]
        }
      ]
    }
  ]
}