Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Excerpt |
---|
This method returns a list of prebooks with their corresponding details. |
Request
https://api.kometsales.com/api/prebook.details.list
- Method: GET
- Content-Type: URL Params
Input parameters:
- authenticationToken (required): Komet Sales security token.
- date (required) (date): Prebook Truck prebook truck date (date format YYYY-MM-DD).
- prebook (optional)(integer:10): Prebook prebook number.
- customer (optional)(string:200): Customer customer name or code. You can obtain this value from the customer.list API method.
- customerId (optional)(integer:20): Customer customer Komet Sales internal ID. You can obtain this value from the customer.list API method.
- carrierName (optional) (string:200): Carrier carrier name.
- carrierId (optional)(integer:20): Carrier Idcarrier ID. You can obtain this value from the carrier.list API method.
- salesPersonId (optional)(integer:20): Customercustomer's Sales Person sales person ID.
- soNumber (optional)(integer:20): Standing Order Number standing order number.
- customerPONumber (string)(integer:20): Customer customer PO Numbernumber.
- locationId (optional)(integer:20): Location location Komet Sales internal ID.
- brandId (optional)(integer:20): Vendor vendor Komet Sales internal brand ID.
Filtering by prebook, date, customerId, carrierId, salesPersonId,locationId, brandId, soNumber and customerPONumber uses an exact match.
Filtering by customer and carrier uses a "LIKE" expression.
Filters are not case sensitive.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
https://api.kometsales.com/api/prebook.details.list?authenticationToken=token_info_goes_here&date=2015-02-10 |
Response
Output:
- status (integer:1): Transaction transaction status. 1 for success or 0 for failure.
- message (string:500): Description description of the status of the transaction.
- prebooks: Array array of prebooks
- id (integer:20): Komet Sales Internal Prebook internal prebook ID.
- number (integer:10): Invoice invoice number.
- locationId (integer:20): Location location Komet Sales internal ID.
- locationName (string:200): Location location name.
- locationCode (string:20): Location location code.
- customerName (string:200): Name name of the customer.
- customerId (integer:20): Komet Sales internal customer ID.
- customerCode (string:20): Code code of the customer.
- type (string:1): S for Standing Orders, P for standalone Prebooks.
- truckDate (date): Ship ship date of the order. (date format YYYY-MM-DD).
- customerPONumber (string:20): Customer customer PO #number.
- carrierId (integer:20): Carrier carrier Komet Sales internal ID.
- carrierName (string:200): Carrier carrier name.
- shipvia (string:10): Warehouse warehouse or Growergrower.
- comments (string:200): Order order notes.
- details: Array array of Prebook Detailsprebook details
- vendorId (integer:20): Grower grower or Vendor vendor Komet Sales internal ID
- vendorName (string:200): Grower grower or Vendor name.
- productId (integer:20): Product product Komet Sales internal ID.
- productDescription (string:200): Product product description.
- totalBoxes (integer:10): Number number of boxes in the product line.
- boxType (string:3): Box Type box type code (FB, HB, QB, etc).
- bunches (integer:10): Bunches bunches per box.
- stemsBunch (integer:10): Stems stems per bunch.
- unitPrice (decimal:10,2): Unit unit price.
- units (integer:10): Units units per Boxbox.
- unitType (string:10): Stem stem or Bunchbunch.
- totalUnits (integer:10): Total total units in the product line.
- totalPrice (decimal:10,2): The the amount of the product line. Unit Price times total units.
- markCode (string:50): Mark Codemark code.
- brandId (integer:20): Vendor Brand vendor brand Komet Sales internal ID.
- brandName (string:200): Vendor Brand vendor brand name.
- breakdowns: Array array of breakdowns
- productId (integer:20): Product product Komet Sales internal ID.
- productDescription (string:20): Product product description.
- stemsBunch (integer:10): Stems stems per bunch.
- bunches (integer:10): Number number of bunches.
- price (decimal:10,2): Unit unit price.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "message": "OK", "status": 1, "prebooks": [ { "customerName": "AB Flower Shop", "id": 1927173, "customerId": 34325, "details": [ { "breakdowns": [], "vendorName": "Flores Capiro", "boxType": "HB", "unitType": "Stem", "productDescription": "Combos Multiple Colors Rose Combo1 Multiple Grades", "stemsBunch": 12, "unitPrice": "1.250", "vendorId": 6320, "brandId": 2, "brandName": "Demo Brand", "units": 240, "productId": 178172, "totalUnits": 2400, "bunches": 20, "totalBoxes": 10, "totalPrice": "3,000.00" }, { "breakdowns": [], "vendorName": "Exportadora de Flores", "boxType": "HB", "productDescription": "Carnation Assorted Select", "stemsBunch": 20, "unitType": "Bunch", "unitPrice": "1.050", "vendorId": 17684, "units": 18, "productId": 276277, "totalUnits": 180, "bunches": 18, "totalBoxes": 10, "totalPrice": "189.00" }, { "breakdowns": [], "vendorName": "Flores del Este", "boxType": "HB", "productDescription": "Lilies Assorted Oriental 2 Blooms", "stemsBunch": 5, "unitType": "Bunch", "unitPrice": "1.250", "vendorId": 6321, "units": 25, "productId": 139103, "totalUnits": 250, "bunches": 25, "totalBoxes": 10, "totalPrice": "312.50" } ], "carrierId": 1207, "customerCode": "34325", "shipVia": "Warehouse", "carrierName": "American Airlines", "number": "13010", "truckDate": "2015-02-10", "type": "P", "totalPrice": "3,501.50" }, { "customerName": "Eric's Flowers", "id": 1949612, "customerId": 6529, "details": [ { "breakdowns": [], "vendorName": "Flores Capiro", "boxType": "HB", "unitType": "Bunch", "productDescription": "Pom Button Green Athos 70 Cm", "stemsBunch": 10, "unitPrice": "1.650", "vendorId": 6320, "brandId": 2, "brandName": "Demo Brand", "units": 24, "productId": 139478, "totalUnits": 336, "bunches": 24, "totalBoxes": 14, "totalPrice": "554.40" } ], "carrierId": 1204, "customerCode": "6529", "shipVia": "Warehouse", "carrierName": "Armellini", "number": "13949", "truckDate": "2015-02-10", "type": "S", "totalPrice": "554.40" } ] } |