Get a Standing Order list

Use this method to get a detailed list of Standing Orders based on the applied filters.

Valid Tokens: Company.

Take the following statements into account when using filters:

  • Filtering by customerId, status, number and locationId uses an exact match.

  • Filtering by customer uses a "LIKE" expression.

  • Filters are not case sensitive.


Related Articles

Request


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.


https://api.kometsales.com/api/standing.order.list? authenticationToken=token_info_goes_here& dateFrom=2015-01-01&dateTo=2015-12-31

Response


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.


{ "message": "OK", "status": "1", "standingOrders": [ { "id": 7165, "number": "S07165", "customerName": "AB Flower Shop", "priceList": "", "carrierName": "Armellini", "recurrence": 1, "days": "Sunday, Monday", "startDate": "2015-05-18", "endDate": "2015-05-27", "salesPerson": "none", "locationCode": "", "locationName": "", "shipToName": "Diane", "shipToCarrier": "", "shipToStreet": "45 Elm ave 2", "shipToCity": "Miami", "shipToState": "FL", "shipToZipCode": "33172", "shipToPhone": "306589675415", "shipToCountry": "USA", "shipToFax": "302123456789", "customerCode": "1034", "companyLocationId": “623”,             "carrierId": “2952”,             "customerId": “21846”,             "salesPersonId": “21291”,             "customerPo": "1325P",             "invoiceNotes": "Please send wrapped in plastic",             "comments": "read notes", "details": [ { "soItemId": 28569, "productId": 140294, "productDescription": "Calla Yellow Florex Gold 50 cm", "units": 14, "unitType": "Bunch", "bunches": 14, "totalBoxes": 10, "totalUnits": 140, "unitPrice": 1.25571, "totalPrice": 175.7994, "unitCost": 0.577, "totalCost": 80.8, "stemsBunch": null, "markCode": "", "boxType": "EB", "vendorName": "", "breakdowns": [ { "productId": 140294, "productDescription": "Calla Yellow Florex Gold 50 cm", "bunches": 10, "stemsBunch": 5, "price": 1.53 }, { "productId": 335312, "productDescription": "Flower Food Blue 10gr Crysal", "bunches": 4, "stemsBunch": 6, "price": 0.57 } ], "assorted": true }, { "soItemId": 28570, "productId": 139489, "productDescription": "Pom Cushion White Sefiros 70 Cm", "units": 10, "unitType": "Bunch", "bunches": 10, "totalBoxes": 10, "totalUnits": 100, "unitPrice": 1.53, "totalPrice": 153, "unitCost": 0.3, "totalCost": 30, "stemsBunch": 12, "markCode": "", "boxType": "EB", "vendorName": "Agro Roses of the North", "breakdowns": [], "assorted": false } ] } ] }

Peacock