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

Method: GET

Content-Type: URL Parameters

Input parameters

authenticationToken (required)(string:50)

Komet Sales security token.

dateFrom (required)(date)

Start Date.

Date format: YYYY-MM-DD

dateTo (required)(date)

End Date

Date format: YYYY-MM-DD

customer (optional)(string:50)

Customer name or code.

customerId (optional)(integer:10)

Komet Sales internal Customer ID.

Use this parameter to search Standing Orders from only one customer.

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

number (optional)(string:10)

Standing Order number.

locationId (optional)(integer:10)

Komet Sales internal Location ID.

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

status (optional)(string:20)

Use this parameter if you want to load only some orders with a specific status.

Valid values: All, Active, Cancelled.

Default is Active.

status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure

message (string:500)

Transaction status description.

standingOrders (array)

An array containing Standing Orders.  

id (integer:20)

Komet Sales internal Standing Order ID.

number (integer:10)

Purchase order number.

customerName (string:200)

Customer name.

priceList (string:200)

Price list associated to the customer.

carrierName (string:200)

Carrier name.

recurrence (integer:1)

Standing Order recurrence.

days (string:100)

List of the days when the order will be generated separated by a comma.

For example: Sunday, Monday. 

startDate (date)

Standing Order starting date.

Date format: YYYY-MM-DD

endDate (date)

Standing Order end date.

Date format: YYYY-MM-DD

salesperson (string:200)

Salesperson name.

locationCode (string:20)

Location code.

locationName (string:200)

Location name.

shipToName (string:200)

Ship To Name.

shipToCarrier (string:200)

Default Ship-To Carrier.

shipToStreet (string:200)

Ship-To Street.

shipToCity (string:200)

Ship-To City.

shipToState (string:200)

Ship-To State.

shipToZipcode (string:200)

Ship-To Zip Code.

shipToCountry (string:200)

Ship-To Country.

shipToPhone (string:200)

Ship-To Phone.

shipToFax (string:200)

Ship-To Fax.

customerCode (string:50)

Customer Code

companyLocationId (integer:20)

Location ID.

Only applies to Multi-Location Companies.

carrierId (integer:20)

Komet Sales internal Carrier ID.

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

customerId (integer:20)

The Customer’s Komet Sales internal ID.

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

salespersonId (integer:20)

Salesperson ID.

customerPo (integer:20)

Customer’s PO Number.

invoiceNotes (string)

Invoice additional notes.

comments (string)

Additional comments.

details (array)

An array containing Purchase Orders detail.

soItemId (integer:20)

Komet Sales Internal Standing Order Item ID.

productId (integer:20)

Komet Sales internal Product ID.

productDescription (string:200)

Product description.

units (integer:10)

Units per Box.

unitType (string:5)

Stem or Bunch.

bunches (integer:10)

Number of Bunches per Box.

totalBoxes (integer:10)

Total Boxes.

totalUnits (integer:10)

Total Units.

unitPrice (decimal:10,2)

Flower unit price.

totalPrice (decimal:10,2)

Total flower units price.

unitCost (decimal:10,2)

Flower unit cost.

totalCost (decimal:10,2)

Total flower units cost.

stemsBunch (integer:10)

Stems per Bunch.

markCode (string:20)

Special mark code or slot number.

boxType (string:3)

Box type code.

For example: HB, QB, and EB.

vendorName (string:200)

Vendor name.

isAssorted (boolean:1)

If the product is assorted.

Valid values: True | False 

breakdowns (array)

An array containing breakdowns.

productId (integer:20)

Komet Sales internal Product ID.

productDescription (string:200)

Product description.

stemsBunch (integer:10)

Stems per Bunch.

bunches (integer:10)

Number of Bunches.

price (decimal:10,2)

Flower unit price.

customField (array)

An array containing custom fields.

name (string:45)

Custom field name.

description (string:200)

Custom field description.