Returns a list of purchase orders with their corresponding details based on the applied filters.
Info |
---|
The maximum range for this request is six months. |
Request
URL: https://api.kometsales.com/api/purchase.order.list
Method: GET
Content-Type: URL Params.
Input parameters:
- authenticationToken (required)(string:50): Komet Sales security token.
- date (required)(date): the vendor ship date of the order. (format YYYY-MM-DD).
- futureInventoryAvailableFrom (optional)(date): the date when the product will be available from. (format YYYY-MM-DD). The specified date range must not exceed 4 days.
- futureInventoryAvailableTo (optional)(date): the date when the product will beavailable to. (format YYYY-MM-DD). The specified date range must not exceed 4 days.
- vendor (optional)(string:50): vendor name or code.
- vendorId(optional)(integer:10): vendor Komet Sales internal ID. This parameter is used to search purchase orders from only one vendor. You can obtain this value from the vendor.list API method.
- customerId(optional)(integer:20): customer Komet Sales internal ID. You can obtain this value from the customer.list API method.
- customerPONumber (optional) (string:20): The PO # of the customer.
- product (optional)(string:100): product description.
- number (optional)(string:10): purchase order number. You may send a set of numbers separated by commas.
- origin (optional)(string:4): origin code (MIA, MDE, BOG, etc).
- prebook(optional)(string:10):prebooknumber.
- locationId(optional)(integer:10): location Komet Sales internal ID. You can obtain this value from the location.list API method.
- status (optional)(string:20): it's used if you want to see only some orders with a specific status. Valid values: Confirmed by Farm, Approved, Pending Approval, Cancelled. If this filter is not set, the system will return all the purchases orders, including those that are Pending Approval.
- statusLine (optional)(string:20): the status of the line. Valid values: Pending, Confirmed, Cancelled, Partial Confirm, Shipped.
- purchaseOrderItemIds (optional)(string:200): A set of purchase order item IDs separated by commas. This is very useful for the Vendor Availability integration.
- includeVendorAvailabilityDetails (optional)(boolean:true/false): By default it's false. If this value is true, the response will include the details of the vendor availability information but you will have to apply the number filter and only one number is allowed at a time.
- updatedAsOf(optional) (datetime) (date format YYYY-MM-DDhh:mm:ss): When provided it will force the method to only return orders that have been updated as of the date/time that is specified. Time must be in the GMT time zone.
- excludeDetails(optional)(integer:1): specify 1 if you want the list only the header of the orders and exclude the details. Default = 0.
Info |
---|
Filtering by vendorId, status, number, origin, prebook, and locationId uses an exact match. Filtering by vendor and product uses a "LIKE" expression. Filters are not case-sensitive. |
Info |
---|
The array of boxes will be only available when the purchase order has been shipped from the farm. |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
https://api.kometsales.com/api/purchase.order.list?
authenticationToken=token_info_goes_here&date=2014-09-24&status=A |
Response
Output:
- productDescription(string:200): item description.
- stems(integer: 3): the number of stems.
- productDescription(string:200): product description.
- quantity(integer: 3): the number of units.
- productId (integer:20): product Komet Sales internal ID.
- productDescription(string:200): product description.
- stemsBunch(integer:10): stems per bunch.
- bunches (integer:10): number of bunches.
- cost (decimal:10,3): unit flower cost.
- boxCode(string:20): box code number.
- lotNumber(integer:10): box lot number.
- position (string:5): physical position of the box.
- statusId(integer:10): status Komet Sales internal ID.
- statusName(string:20): status name (Farm Shipped, Received Warehouse, Shipped Warehouse)
- name and value of the custom field (string:20).