Get a list of Purchase Orders
Use this method to get a detailed list of Purchase Orders based on the applied filters within a date range.
Valid Tokens: Company and Vendor.
When using this method take the following statements into account:
The maximum range for this request is six months.
Filtering by
vendorId
,status
,number
,origin
,prebook
andlocationId
uses an exact match.Filtering by
vendor
andproduct
uses a "LIKE" expression.Filters are not case sensitive.
The
boxes
array is only available when the Purchase Order was shipped by the Grower.
Related Articles
-
Substitute Items (Knowledge Base)
-
Confirm PO's - "V" Mark (Knowledge Base)
-
Confirm POs from the Vendor Portal (Knowledge Base)
-
Purchase Order Management (Knowledge Base)
-
Problems finding Purchase Orders (Knowledge Base)
Request
URL: https://api.kometsales.com/api/purchase.order.list
Method: GET
Content-Type: URL Parameters
Input parameters:
authenticationToken (required)(string:50)
Komet Sales security token.
date (required if number
is not sent)(date)
Vendor Ship Date.
Date format: YYYY-MM-DD
futureInventoryAvailableFrom (optional)(date)
Date when the product will be available.
The specified date range must not exceed 4 days.
Date format: YYYY-MM-DD
futureInventoryAvailableTo (optional)(date)
Date when the product stops being available.
Date 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)
Komet Sales internal Vendor ID.
This parameter is used to search purchase orders from only one vendor.
You can get this value from the vendor.list API method.
customerId(optional)(integer:20)
Komet Sales internal Customer ID.
You can get this value from the customer.list API method.
customerPONumber (optional)(string:20)
Customer PO Number.
product (optional)(string:100)
Product description.
number (required if date
is not sent)(string:10)
Purchase order number.
You can send a set of numbers separated by commas.
origin (optional)(string:4)
Origin code. For example: MIA, MDE, and BOG.
prebook(optional)(string:10)
Prebook number.
locationId (optional)(integer:10)
Komet Sales internal Location ID.
You can obtain this value from the location.list API method.
status (optional)(string:20)
Prebook status.
Valid values: Confirmed by Farm, Approved, Pending Approval, Cancelled.
If this filter is not set, the system will return every Purchase Order, including those that have the Pending Approval status.
statusLine (optional)(string:20)
Product line status.
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)
Include Vendor Availability information.
Valid values: True | False
Default it's false.
updatedAsOf (optional)(datetime)
When provided the system will only return orders that have been updated as of the date/time that is specified.
Date format: YYYY-MM-DDhh:mm:ss
Time must be in the GMT time zone.
excludeDetails(optional)(integer:1)
If the result should include only headers and exclude details.
Valid values: 0 = Include details | 1 = Exclude details
Default is 0.
https://api.kometsales.com/api/purchase.order.list?
authenticationToken=token_info_goes_here&date=2014-09-24&status=A
Response
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
message (string:500)
Transaction status description.
purchaseOrders (array)
An array containing Purchase Orders.
— id (integer:20)
Komet Sales internal Purchase Order ID.
number (integer:10)
Purchase Order number.
origin (string:4)
Origin code.
vendorId (integer:20)
Komet Sales internal Vendor ID.
vendorName (string:200)
Vendor name.
shipDate (date)
Purchase Order shipping date.
Date format: YYYY-MM-DD
status (string:1)
Status code.
Valid values: CF = Confirmed by Farm | A = Approved | PA = Pending Approval | CA = Cancelled
locationId (integer:20)
Komet Sales internal Location ID.
locationName (string:200)
Location name.
totalCost (decimal:10,3)
Total cost of the order.
comments (string:500)
Special instructions or comments.
totalBoxes (integer:10)
Number of boxes.
updatedOn (datetime)
Last time when the order was updated.
Date format: YYYY-MM-DD'T'hh:mm:ss
Time is in the GMT time zone.
createdOn (datetime)
Date when the order was created.
Date format: YYYY-MM-DD'T'hh:mm:ss
details (array)
Purchase Order details.
poItemId (integer:20)
Komet Sales internal Purchase Order Item ID.
prebookItemId (integer:20)
Prebook item internal ID.
prebook(integer:10)
Prebook number.
prebookTruckDate(date)
Prebook Truck Date.
Date format: YYYY-MM-DD
carrierId(integer:20)
Komet Sales internal Carrier ID.
carrierName(string:200)
Carrier name.
standingOrder(string:10)
Standing order number.
orderType(string:1)
Order type.
Valid values: P = Prebook | S = Standing Order | D = Double
customerId(integer:20): customer Komet Sales internal ID.
customerName(string:200): customer name.
customerCode (string:50): Customer code.
shipName (string:200): Ship To name.
shipCity (string:200): ship city name.
shipState (string:200): ship state name.
shipAddress (string:200): ship address.
shipZipCode (string:10): ship zip code.
shipCountry (string:200): ship country name.
productId (integer:20) product Komet Sales internal ID.
productDescription(string:200): product description.
recipes (array) of the products included within the recipe:
productDescription(string:200): item description.
stems(integer: 3): the number of stems.
laborAndMaterials: array of the labor and materials included within the recipe:
productDescription(string:200): product description.
quantity(integer: 3): the number of units.
totalBoxes(integer:10): number of boxes.
quantityConfirmed(integer:10): number of boxes confirmed by the vendor.
boxType(string:3): box type code. (HB, QB, EB, etc).
bunches (integer:10): number of bunches per box.
stemsBunch(integer:10): stems per bunch.
unitCost(decimal:10,3): unit flower cost.
units (integer:10): units per box.
unitType(string:5): stem or bunch.
totalUnits(integer:10):total of units.
totalCost(decimal:10,3): total cost.
unitPrice(decimal:10,3): unit flower price. This field is only available if the token type is Company Token.
totalPrice(decimal:10,3): total price. This field is only available if the token type is Company Token.
markCode(string:20): special mark code or slot number.
customField1 (string:50): additional field #1.
notes (string:200): general notes for each line.
notesForVendor (string:200): notes for the vendor associated to the prebook item.
lineItemStatus(string:1): vendor status code of the product line. P for Pending, C for Confirmed, CA for Cancelled, PC for Partial Confirm, S for Shipped.
breakdowns: array of breakdowns
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.
boxes: array of boxes
boxCode(string:20): box code number.
lotNumber(string)
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)
customFields: array of custom fields of the line, only if they exist.
name and value of the custom field (string:20).
vendorAvailabilityDetails: details of the vendor availability items associated to this line of the order.
productDescription(string:200): product description.
availableFrom(date): 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.
upc: details of the upc information added to the product.
number (string: 50): UPC number.
checkDigit(integer: 2): UPC check digit.
pullDate(string: 20): UPC Pull date
price (string:20): UPC unit price.
description (string:200): Product description for the UPC.
instructions (string:200)
Additional UPC instructions.
The Ship-To information is only displayed with Company-type Tokens.
{
"message":"OK",
"purchaseOrders":[
{
"origin":"MDE",
"vendorId":6321,
"updatedOn":"2018-09-20T14:25:20",
"vendorName":"Flores del Este",
"shipDate":"2018-09-24",
"totalBoxes":20,
"createdOn":"2018-09-20T14:24:34",
"number":"P007298",
"details":[
{
"orderType":"S",
"stemsBunch":25,
"notes":"",
"standingOrder":"S00717",
"notesForVendor":"",
"customFields":[
],
"breakdowns":[
],
"bunches":6,
"prebookItemId":929164,
"units":150,
"totalBoxes":20,
"unitType":"Stem",
"carrierName":"Armellini",
"referenceNumber":"",
"poItemId":283404,
"customerId":6319,
"lineItemStatus":"C",
"productDescription":"Red Roses Black Magic 60 Cm",
"recipes":[],
"laborAndMaterials":[],
"boxes":[
],
"productId":139688,
"boxType":"HB",
"customerName":"Jeff's Flowers",
"totalUnits":3000,
"markCode":"",
"prebook":12385,
"unitCost":"0.33",
"prebookTruckDate":"2018-09-24",
"quantityConfirmed":20,
"carrierId":1204,
"totalCost":"990"
}
],
"id":88233,
"shipZipCode":"",
"totalCost":"990",
"status":"CF"
},
{
"origin":"MDE",
"vendorId":6521,
"updatedOn":"2018-09-20T14:25:19",
"vendorName":"Flores Duales",
"shipDate":"2018-09-24",
"totalBoxes":10,
"createdOn":"2018-09-20T14:24:36",
"number":"P007309",
"details":[
{
"orderType":"S",
"stemsBunch":25,
"notes":"",
"standingOrder":"S00953",
"notesForVendor":"",
"customFields":[
],
"breakdowns":[
],
"bunches":6,
"prebookItemId":929183,
"customerCode":"BTW",
"units":150,
"totalBoxes":10,
"unitType":"Stem",
"carrierName":"Delivery",
"referenceNumber":"",
"unitPrice":"0.9",
"poItemId":283417,
"customerId":6614,
"lineItemStatus":"C",
"productDescription":"Recipe Roses 60 Cm",
"recipes":[
{
"productDescription":"Pink Roses",
"stems":10
},
{
"productDescription":"Akito Roses",
"stems":15
}
],
"laborAndMaterials":[
{
"productDescription":"Ribbon red",
"quantity":10
}
],
"boxes":[
],
"productId":139655,
"boxType":"HB",
"customerName":"John's john Flowers",
"totalUnits":1500,
"markCode":"",
"totalPrice":"90",
"prebook":12394,
"unitCost":"0.2",
"prebookTruckDate":"2018-09-24",
"quantityConfirmed":10,
"carrierId":1209,
"totalCost":"300"
}
],
"id":88244,
"shipZipCode":"",
"totalCost":"300",
"status":"CF"
}
],
"status":1
}