URL: https://api.kometsales.com/api/prebook.details.list

Method: GET

Content-Type: URL Parameters

Input parameters

authenticationToken (required)

Komet Sales security token.

date (required)(date)

The Prebook Truck date set in the Bulk Purchasing Mode.

Optional: If you want to search a date range, use the vendorShipDateFrom and vendorShipDateTo parameters instead.

Date format: YYYY-MM-DD

prebook (optional)(integer:10)

Prebook number.

updatedAsOf (optional)(datetime)

When provided, it will force the method to only return orders that have been updated since the specified time and date.

Time must be in the GMT zone.

Date format YYYY-MM-DD hh:mm:ss

customer (optional)(string:200)

Customer name or code.

You can get this value from the customer.list API method.

customerId (optional)(integer:20)

Komet Sales internal Customer ID.

You can get this value from the customer.list API method.

carrierName (optional)(string:200)

Carrier name.

carrierId (optional)(integer:20)

Carrier ID.

You can get this value from the carrier.list API method.

vendorShipDateFrom (optional)(date)

The Vendor's ship date. 

Date format YYYY-MM-DD

vendorShipDateTo (optional)(date)

Vendor Ship Date. 

Date format: YYYY-MM-DD

The date range between shipDateFrom and shipDateFrom must not exceed seven days.

salesPersonId (optional)(integer:20)

Customer's Salesperson ID.

soNumber (optional)(integer:20)

Standing Order number.

customerPONumber (string)(integer:20)

Customer PO number.

locationId (optional)(integer:20)

Komet Sales internal Location ID.

brandId (optional)(integer:20)

Komet Sales internal Vendor Brand ID.

unableToSource (optional)(boolean)

Only return Prebooks marked as Unable to Source and are pending to buy.

Valid values: 1 = Yes | 0 = No

Back to top

status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure

message (string:500)

Transaction status description.

prebooks (array)

An array containing Prebooks

id (integer:20)

Komet Sales internal Prebook ID.

number (integer:10)

Invoice number.

locationId (integer:20)

Komet Sales internal Location ID.

locationName (string:200)

Location name.

locationCode (string:20)

Location code.

customerName (string:200)

Customer name.

customerId (integer:20)

Komet Sales internal Customer ID.

customerCode (string:20)

Customer code.

shipName (string:200)

Customer’s Ship-To name.

shipCity (string:200)

Shipping address city.

shipState (string:200)

Shipping address state.

shipAddress (string:200)

Shipping address street.

shipZipCode (string:10)

Shipping address zip code.

shipCountry (string:200)

Shipping address Country.

shipToCode (string:50)

Ship-To Code.

type (string:1)

Type of order.

Valid values: S = Standing Orders | P = Standalone Prebooks | D = Doubles 

truckDate (date)

Order ship date.

Date format: YYYY-MM-DD

customerPONumber (string:20)

Customer PO number.

carrierId (integer:20)

Komet Sales internal Carrier ID.

carrierName (string:200)

Carrier name.

shipvia (string:10)

Warehouse or Grower. 

comments (string:200)

Additional order notes.

details (array)

An array containing Prebook details.

prebookItemId (integer:20)

Komet Sales internal Prebook Item ID.

type (string:10)

If the line was sold as Units or Boxes.

Valid values: Unit or Box.

futureSales (Boolean)

If the Prebook line belongs to Future Sales.

vendorId (integer:20)

Komet Sales internal Grower or Vendor ID.

vendorName (string:200)

Grower or Vendor name.

vendorShipDate (date)

Vendor's shipping date.

Date format: YYYY-MM-DD

productId (integer:20)

Komet Sales internal product ID.

productDescription (string:200)

Product description.

totalBoxes (integer:10)

The number of boxes in the product line.

boxType (string:3)

Box type code

For example, FB, HB, QB, etc.

bunches (integer:10)

Number of Bunches per box.

stemsBunch (integer:10)

Number of stems per bunch.

unitPrice (decimal:10,2)

Unit price.

units (integer:10)

Units per Box.

unitType (string:10)

Unit-type.

Valid values: Stem or Bunch.

totalUnits (integer:10)

Total Units in the product line.

unitCost (decimal:10,2)

The product line Unit cost.

Only available for Vendor tokens with the option of changing unit cost.

totalPrice (decimal:10,2)

The amount in the product line. Calculated by Unit Price x Total Units.

markCode (string:50)

The product mark code.

brandId (integer:20)

Komet Sales internal Vendor brand ID.

brandName (string:200)

Vendor brand name.

generalNotes (string:500)

Product line notes that are visible to Customers and Vendors. 

vendorNotes (string:500)

Product line notes that are only visible to the Vendor.  

breakdowns (array)

An array containing breakdowns.

productId (integer:20)

Komet Sales internal product ID.

productDescription (string:20)

Product description.

stemsBunch (integer:10)

Number of Stems per Bunch.

bunches (integer:10)

Number of Bunches.

price (decimal:10,2)

Unit price.

Back to top