Versions Compared

Old Version 1

changes.mady.by.user Andres Toledo

Saved on

compared with

New Version Current

changes.mady.by.user Andres Toledo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Returns a list of detailed Purchase Orders based on the applied filters within a date range.

InfoThe maximum range for this request is six months.
Excerpt

Use this method to get a detailed list of Purchase Orders based on the applied filters within a date range.

Tip

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 and locationId uses an exact match.

  • Filtering by vendor and product uses a "LIKE" expression.

  • Filters are not case-sensitive.

  • The boxes array is only available when the Purchase Order was shipped by the Grower.

Filter by label (Content by label)
showLabelsfalse
max5
titleRelated Articles
cqllabel in ( "purchase-orders" , "purchase-order-management" , "purchase-orders-vendors" )

Request

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

Method: GET

Content-Type: URL

Params. 

Parameters 

Input parameters:

authenticationToken (required)(string:50)

:

Komet Sales security token.

date (required if number is not sent)(date)

: the vendor ship date of the order. (format

Vendor Ship Date.

Date format: YYYY-MM-DD

).

futureInventoryAvailableFrom (optional)(date)

: the date

Date when the product will be available

from. (format YYYY-MM-DD). The

.

The specified date range must not exceed 4 days.

Date format: YYYY-MM-DD 

futureInventoryAvailableTo (optional)(date)

: the date

Date when the product

will beavailable to. (format

stops being available.

Date format: YYYY-MM-

DD). The

DD 

The specified date range must not exceed 4 days.

vendor (optional)(string:50)

: vendor

Vendor name or code.

vendorId(optional)(integer:10)

: vendor

Komet Sales internal Vendor ID.

This parameter is used to search purchase orders from only one vendor.

You can

obtain

get this value from the vendor.list API method.

customerId(optional)(integer:20)

: customer

Komet Sales internal Customer ID.

You can

obtain

get this value from the customer.list API method.

customerPONumber (optional)(string:20)

: The PO # of the customer

Customer PO Number.

product (optional)(string:100)

: product

Product description.

number (

optional

required if date is not sent)(string:10)

: purchase

Purchase order number.

 You may

 

You can send a set of numbers

separated by commas. origin

separated by commas. 

origin (optional)(string:4)

Origin code. For example: MIA, MDE, and BOG.

prebook(optional)(string:

4): origin code (MIA, MDE, BOG, etc).prebook(optional)(string:10):prebooknumber

10)

Prebook number.

awbId (optional)(integer)

AWB ID of the order.

If you use this parameter, or inboundTruckId, you don’t need to send any other parameters aside from the authenticationToken.

inboundTruckId (optional)(integer)

Inbound Truck ID.

If you use this parameter, or awbId, you don’t need to send any other parameters aside from the authenticationToken.

locationId (optional)(integer:10)

: location

Komet Sales internal Location 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

Prebook status.

Valid values: Confirmed by Farm, Approved, Pending Approval, Cancelled.

If this filter is not set, the system will return

all the purchases orders

every Purchase Order, including those that

are

have the Pending Approval status.

statusLine (optional)(string:20)

: the status of the line.

Product line status.

Valid values:

 Pending

 Pending, Confirmed, Cancelled, Partial Confirm, Shipped. 

purchaseOrderItemIds (optional)(string:200)

:

A set of

purchase order item

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

)

Include Vendor Availability information.

Valid values: True | False

Default it's false.  

updatedAsOf (optional)(datetime)

 (date format YYYY-MM-DDhh:mm:ss):

When provided

it will force the method to

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): specify 1 if you want the list only the header of the orders and exclude the details. Default = 0.  

  • 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 Box Array is only available when the purchase order was shipped by the Grower.

curl

:1)

If the result should include only headers and exclude details.

Valid values: 0 = Include details | 1 = Exclude details

Default is 0.

Code Block
languagejs
https://api.kometsales.com/api/purchase.order.list?
authenticationToken=token_info_goes_here&date=2014-09-24&status=
A

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.

    • origin (string:4): origin code.

    • vendorId(integer:20): vendor Komet Sales internal ID.

    • vendorName(string:200): vendor name.

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

    • status (string:1): status code (CF = Confirmed by Farm, A = Approved, PA = Pending Approval, CA = Cancelled).

    • locationId(integer:20): location Komet Sales internal 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 will be in the GMT time zone.

    • createdOn(datetime):date when the order was created. (format YYYY-MM-DD'T'hh:mm:ss).

    • details: array of purchase orders details

      • poItemId(integer:20): PO item internal 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): carrier Komet Sales internal ID.

      • carrierName(string:200): carrier name.

      • standingOrder(string:10): standing order number.

      • orderType(string:1): P for prebook, S for standing Order, D for 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(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)

      • 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 instructions for the UPC. 

Info

The Ship-To information is only displayed with Company-type Tokens.

Sample Response Code Block{ "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":[ {
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.

carrierName (string:200)

Purchase Order carrier name.

carrierId (integer:20)

Purchase Order Carrier ID.

networkCodeId (integer)

Purchase Order Carrier’s Komet Network Code.

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)

Prebook Carrier ID.

carrierName(string:200)

Prebook 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.  

subtotalCost(decimal:10,2)

Purchase Order total cost plus additional charges.

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.

totalFbe(decimal:10,2)

Total Full Box Equivalent (FBE) of every box in the Purchase Order.

totalUnits(integer:10):total of units.

totalCost(decimal:10,3): total cost.

totalAdditionalCharges (decimal:10,2)

Total additional charges.

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.  

Info

The Ship-To information is only displayed with Company-type Tokens.

Code Block
{
    "message": "OK",
    "purchaseOrders": [
        {            
            "
orderType
origin": "
S
MIA",
            
"
stemsBunch
vendorId":
25
 25211,

            "
notes
totalBoxes":
""
 15,

            
"
standingOrder
shipName": "
S00717
",
            
"
notesForVendor
createdOn": "2024-10-07T08:06:28",
"customFields":[
           "shipCountry": "",
            "number": "P002937",
],
   
            "
breakdowns
locationId":
[
 4,
            "id": 90456,
            "shipZipCode": "",
],
     "shipCity": "",
            "
bunches
locationName":
6,
 "Omaha Mod",
            "updatedOn": "
prebookItemId":929164
2024-10-07T07:06:37",
            
"
units
vendorName":
150
 "AgriFarms",
            "shipDate":
"totalBoxes":20, 
"2024-10-07",
            
"
unitType
shipAddress": "
Stem
",

            "
carrierName
subtotalCost": "
Armellini
15",
            
"
referenceNumber
shipState": "",
"poItemId":283404,
  
            "totalCost": "
customerId
15"
:6319
,

            "
lineItemStatus
totalAdditionalCharges": "
C
0",

            "
productDescription
status":
"Red Roses Black Magic 60 Cm", 
 "PA",
            "
recipes
carrierId":
[]
 1357,
            "carrierName": 
"
laborAndMaterials
Armellini"
:[]
,

            "
boxes
networkCodeId":
[
 0,
            "details": [
                {
],
                  "
productId
orderType":
139688
 "P",
"boxType":"HB",
     "stemsBunch": 2,
"customerName":"Jeff's
Flowers",
          "totalPrice": "10",
"totalUnits":3000,
                "
markCode
notesForVendor": "",
                    "
prebook
customFields":
12385,
 [],
                    "
unitCost
breakdowns":
"0.33"
 [],
                    "
prebookTruckDate
bunches":
"2018-09-24",
 1,
                    "
quantityConfirmed
prebookItemId":
20
 934637,
                    "
carrierId
customerCode":
1204
 "main code",
                    "
totalCost
units":
"990"
 1,
}
         "totalBoxes":
]
5,
"id":88233,
          "
shipZipCode
unitType": "Bunch",
"totalCost":"990",
           "
status
totalFbe": "
CF
10",
},
{
       
"
origin
carrierName": "
MDE
Elite",
"vendorId":6521,
           "
updatedOn
referenceNumber":
"2018-09-20T14:25:19
 "",
"vendorName":"Flores
Duales",
          "
shipDate":"2018-09-24",
poItemId": 288102,
                    "
totalBoxes
customerId":
10
 29330,
"createdOn":"2018-09-20T14:24:36",
           "
number
lineItemStatus": "
P007309
P",
"details":[
       "productDescription": "Fancy Alstro",
{
                "
orderType
unitPrice": "
S
2",
"stemsBunch":25,
     "boxes": [],
"notes":"",
          "recipes": [],
"standingOrder":"S00953",
                "
notesForVendor
productId":
""
 217045,
"customFields":[
       "laborAndMaterials": [],
                    "boxType": "FB",
],
                "
breakdowns
customerName":
[
 "customer test main",
                    "totalUnits": 5,
],
           "prebook": 3280,
"bunches":6,
                "
prebookItemId
unitCost":
929183,
 "1",
                    "
customerCode
prebookTruckDate": "
BTW
2024-10-07",
"units":150,
     "quantityConfirmed": 0,
"totalBoxes":10,
          "carrierId": 3000,
"unitType":"Stem",
                "
carrierName
totalCost": "
Delivery
5"
,
"referenceNumber":"",
},
                {
"unitPrice":"0.9",
                "
poItemId
orderType":
283417,
 "P",
                    "
customerId
stemsBunch":
6614
 2,
                    "
lineItemStatus
totalPrice": "
C
20",
                    "
productDescription
notesForVendor": "
Recipe
",
Roses
60
Cm",
                "
recipes
customFields": [],
{ 
 "breakdowns": [],
                    "
productDescription
bunches":
"Pink
Roses"
1,
                    
"
stems
prebookItemId":
10
 934636,
},
"customerCode": "main code",
{ 
 "units": 1,
                    "
productDescription
totalBoxes":
"Akito
Roses"
10,
                    
"
stems
unitType":
15
 "Bunch",
}
   "totalFbe": "20",
],
"laborAndMaterials":[
"carrierName": "FedEx",
{ 
"referenceNumber": "",
                    "
productDescription
poItemId":
"Ribbon
red"
288103,

                    "
quantity
customerId":
10
 29330,
}
   
"lineItemStatus": "P",
],
                "
boxes
productDescription":
[
 "10 pack Leather Leaf",
                    "unitPrice": "2",
],
          "boxes": [],
"productId":139655,
                "
boxType
recipes":
"HB"
 [],
"customerName":"John's
john
Flowers",
   "productId": 219070,
"totalUnits":1500,
         "laborAndMaterials": [],
"markCode":"",
                "
totalPrice
boxType": "
90
FB",
                    "
prebook
customerName":
12394,
 "customer test main",
                    "
unitCost
totalUnits":
"0.2",
 10,
                    "
prebookTruckDate
prebook":
"2018-09-24"
 3279,
                    "
quantityConfirmed
unitCost":
10,
 "1",
                    "
carrierId
prebookTruckDate":
1209,
 "2024-10-07",
                    "
totalCost
quantityConfirmed":
"300"
 0,
}
         "carrierId":
]
4605,
"id":88244,
           "
shipZipCode
totalCost": "10"
,
"totalCost":"300",
   }
"status":"CF"
      ]
}
],
"status":1 } Panel
titleRelated Articles
Filter by label (Content by label)showLabelsfalsemax10showSpacefalsesorttitlecqllabel in ( "editing-purchase-orders" , "purchase-order-summary" , "purchase-orders" )labelsediting-purchase-orders purchase-orders purchase-order-summary
   
        }
    ],
    "status": 1
}
We've encountered an issue exporting this macro. Please try exporting this page again later.