Overview

Returns a list of pick tickets with their corresponding details.

Request

https://api.kometsales.com/api/pickticket.details.list

  • Method: GET
  • Content-Type: application/json

Input Parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • orderDate (required) (date): shipping date (date format YYYY-MM-DD).
  • status: (optional)(integer:1) status of the order (0=Pending Approval,1=Confirmed), if this filter is not given, the system will return all the orders from the orderDate specified.
  • customer (optional)(string:200): customer name or code. You can obtain this value from the customer.list API method.
  • customerId (optional)(integer:20): customer Komet Sales internal ID. You can obtain this value from the customer.list API method.
  • carrierName (optional) (string:200): carrier name.
  • carrierId (optional)(integer:20): carrier ID. You can obtain this value from the carrier.list API method.
  • product (optional)(string:200): product description.
  • order (optional)(integer:10): order number
  • locationId (optional)(integer:20): location Komet Sales internal ID.
  • updatedAsOf (optional) (datetime) (date format YYYY-MM-DD'T'hh:mm:ss): When provided it will force the method to only return transactions that have been updated as of the date/time that is specified. Time must be in EST. 
  • confirmedAsOf (optional) (datetime) (date format YYYY-MM-DD'T'hh:mm:ss): When provided it will force the method to only return transactions that have been confirmed as of the date/time that is specified. Time must be in EST.

You can send parameters such as the status, customer, customerId and product in order to filter the results. When filtering by status, carrierId or customerId the system uses an exact match. Filtering by customer and product uses a "LIKE" expression. Filters are not case sensitive.

Sample 1
https://api.kometsales.com/api/pickticket.details.list?authenticationToken=token_info_goes_here&orderDate=2014-11-15

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • message (string:500): description of the status of the transaction.
  • picktickets: array of orders
    • id (integer:20): Komet Sales internal invoice ID.
    • number (integer:10): invoice number.
    • customerId (integer:20): Komet Sales internal customer ID.
    • customerName (string:200): name of the customer.
    • billCity (string:200): billing city name.
    • billState (string:200): billing state name.
    • billAddress (string:200): billing address.
    • billZipCode (string:10): billing Zip Code.
    • billCountry (string:200): billing country name.
    • orderRef (string:20): reference order number.
    • 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.
    • shipDate (date): ship date of the order. (date format YYYY-MM-DD).
    • carrierId (integer:20): carrier Komet Sales internal ID.
    • carrierCode (string:20): carrier code.
    • carrierName (string:200): carrier name.
    • carrierAccount (string:20): carrier account number.
    • salesPersonId (integer:20): salesperson Komet Sales internal ID.
    • salesPersonName (string:200): salesperson name.
    • locationId (integer:20): location Komet Sales internal ID.
    • locationName (string:200): location name.
    • customerPONumber (string:20): customer PO #.
    • totalBoxes (integer:10): total of boxes.
    • status (string:20): status of the order (Draft, Pending Approval, Confirmed)
    • createdOn (datetime): date when the order was created. (format YYYY-MM-DD'T'hh:mm:ss).
    • confirmedOn (datetime): date when the order was confirmed by the sales person. (format YYYY-MM-DD'T'hh:mm:ss).
    • truckDate (date): truck date of the order. This field is calculated based on the ship date of the order and the transit days set up for this customer. If the customer does not have Transit Days set up, this date is equal to the Ship Date(date format YYYY-MM-DD).
    • countConfirmed (integer:10): number of times that the order has been confirmed.
    • isEcommerce (string:3): it will return "Yes" when the order was entered from the E-commerce site, otherwise it will be "No".
    • details: array of order details:
      • detailId (integer:20): internal ID of the line of the order.
      • awb (string:20): AWB number or shipment reference number.
      • ref (string:20): reference number of the product line.
      • productId (integer:20): product Komet Sales internal ID.
      • productDescription (string:200): product description.
      • vendorId (integer:20): vendor Komet Sales internal ID
      • vendorName (string:200): vendor name.
      • totalBoxes (integer:10): number of boxes in the product line.
      • boxTypeId (integer:20): box type Komet Sales internal ID.
      • boxType (string:3): box type code (FB, HB, QB, etc).
      • units (integer:10): units per Box.
      • unitType (string:10): stem or bunch.
      • totalUnits (integer:10): total units in the product line.
      • bunchesBox (integer:10): bunches per box.
      • stemsBunch (integer:10): stems per bunch.
      • markCode (string:50): mark code.
      • warehouseNotes (string:200): additional notes or label instructions.
      • salesType (string:1): M (Open Market), P (Prebook), S (Standing Order), L (Local)
      • boxes: array of boxes
        • detailId (integer:20): Internal ID of the line of the order.
        • boxCode (string:10): box code or box number.
        • lotNumber (integer:10): lot number.
        • position (string:5): rack position or location.
        • statusId (integer:20): status Komet Sales internal ID.
        • statusName (string:20): status name: (Farm Shipped, Received Warehouse, Shipped Warehouse)
        • length (decimal:10,3): length of the box in inches. 
        • width (decimal:10,3): width of the box in inches. 
        • height (decimal:10,3): height of the box in inches. 

Output Sample
{
    "message": "OK",
    "picktickets": [
        {
            "id": 452191,
            "customerId": "29413",
            "customerName": "FLORAL F",
            "number": "2566",
            "billCity": "CHICAGO",
            "billState": "IL",
            "billAddress": "2334 W Street 100",
            "billZipCode": "60625",
            "billCountry": "USA",
            "shipAddress": "2334 W CHAMBORT   SUITE 100",
            "shipZipcode": "60625",
            "shipCountry": "USA",
            "shipCity": "CHICAGO",
            "shipState": "IL",
            "shipName": "FLORAL F ",
            "shipDate": "2018-05-29",
            "locationId": "",
            "locationName": "",
            "carrierId": 1204,
            "carrierName": "Armellini",
            "carrierCode": "AR",
            "salesPersonId": "1751",
            "salesPersonName": "Johan Hidalgo",
            "customerPONumber": "",
            "totalBoxes": 2,
            "status": "Pending",
            "countConfirmed": 0,
            "confirmedOn": "",
            "isEcommerce": "No",
            "orderRef": "",
            "createdOn": "2018-05-29T14:48:37",
            "updatedOn": "2018-05-29T14:49:46",
            "truckDate": "2018-05-29",
            "carrierAccount": "",
            "details": [
                {
                    "detailId": 913701,
                    "awb": "3243535321",
                    "ref": "MAFE",
                    "productId": 235208,
                    "productDescription": "BQ Lavender Rose",
                    "vendorId": 29227,
                    "vendorName": "Flores ABC",
                    "totalBoxes": 2,
                    "boxTypeId": 899,
                    "boxType": "EA",
                    "salesType": "P",
                    "units": 250,
                    "unitType": "Stem",
                    "totalUnits": 500,
                    "bunchesBox": 10,
                    "stemsBunch": 25,
                    "markCode": "093496",
                    "warehouseNotes": "",
                    "boxes": [
                        {
                            "detailId": 913701,
                            "boxCode": "SK4245633",
                            "lotNumber": "16555",
                            "position": "",
                            "statusId": 1,
                            "statusName": "Farm Shipped",
                            "length": "10.00",
                            "width": "2.00",
                            "height": "3.00",
                            "fbe": "0.120"
                        },
                        {
                            "detailId": 913701,
                            "boxCode": "SK4245634",
                            "lotNumber": "16555",
                            "position": "",
                            "statusId": 1,
                            "statusName": "Farm Shipped",
                            "length": "10.00",
                            "width": "2.00",
                            "height": "3.00",
                            "fbe": "0.120"
                        }
                    ]
                }
            ]
        }
    ],
    "status": 1
}