Overview

This method allows you to obtain the same information of the existing Grower Report, such as boxes received and sold per AWB, commissions, expenses, among others. 

Request

https://api.kometsales.com/api/custom/ff/grower.report.get

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

Input Parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • arrivalDateFrom (Mandatory if the ShipDateFrom is not specified): The initial arrival date of the AWBs (date format YYYY-MM-DD). 
  • arrivalDateTo (Mandatory if the ShipDateTo is not specified.): The final arrival date of AWBs (date format YYYY-MM-DD). 
  • shipDateFrom (Mandatory if the ArrivalDateFrom is not specified.): The initial ship date of products (date format YYYY-MM-DD). 
  • shipDateTo (Mandatory if the ArrivalDateTo is not specified): The initial ship date of products (date format YYYY-MM-DD).
  • poNumber (optional): The PO # associated to the vendor.
  • orderType (optional): Inventory type of the products within the PO. Type L to include only Local products, M for Open Market, P for products coming from a Prebook or S for products coming from a Standing Order. Only one allowed.

    Sample
    https://api.kometsales.com/api/custom/ff/grower.report.get?authenticationToken=<authenticationToken>&arrivalDateFrom=2017-02-08&arrivalDateTo=2017-03-07&shipDateFrom=2018-01-04&shipDateTo=2018-01-05&poNumber=0212321&orderType=L

Response

Output:

    • status (integer:1): transaction status. 1 for success or 0 for failure/error.
    • message (string:500): contains status description of request.
    • items: array of items:
        • awb (string:15): AWB number.
        • orderType(string:1): P for prebook, S for standing Order, L for local products, M for Open Market.
        • shipDate (date): ship date of the AWB. (date format YYYY-MM-DD).
        • color (string: 50): Color of the product. 
        • category (string: 50): Category name of the product. 
        • Variety (string:50): the variety of the product.
        • grade (string:100): grade or product cut point
        • pieces (integer:10): the total number of pieces purchased.
        • boxType (string:3): box type code (FB, HB, QB, etc).
        • fbeReceived (decimal:10,2): the total number of boxes received in full box equivalence.
        • fbeSold (decimal:10,2): the total number of boxes sold in full box equivalence.
        • unitsSold (integer:10): the total of units sold.
        • totalSales (decimal:10,2): the total sales amount.
        • avgPriceUnit (decimal:10,2): the average price per unit.
        • commission (decimal:10,2): the value of the commission.
        • credits (decimal:10,2): total amount in credits for the vendor.
        • expenses (decimal:10,2): the landed cost minus the cost of the flower.
        • expensesBox (decimal:10,2): total expenses per full box.
        • return (decimal:10,2): total Sales - commission - credits - expenses.
        • avgNet (decimal:10,2): total Return / Units Sold

Sample
{
    "status": "1",
    "message": "OK",
    "items": [
        {
            "awb": "000-0000-0417",
            "shipDate": "2018-04-17",
            "category": "Achillea",
            "variety": "",
            "color": "Purple",
            "grade": "",
            "pieces": 10,
            "boxType": "EA",
            "fbeReceived": 0,
            "fbeSold": 0,
            "unitsSold": 0,
            "totalSales": 0,
            "avgPriceUnit": 0,
            "commission": 0,
            "credits": 0,
            "expenses": 0,
            "expensesBox": 0,
            "return": 0,
            "avgNet": 0,
            "orderType": "P"
        },
        {
            "awb": "000-0000-0417",
            "shipDate": "2018-04-17",
            "category": "Agapanthus",
            "variety": "Smurf",
            "color": "Blue",
            "grade": "60",
            "pieces": 10,
            "boxType": "EB",
            "fbeReceived": 1.2,
            "fbeSold": 0,
            "unitsSold": 0,
            "totalSales": 0,
            "avgPriceUnit": 0,
            "commission": 0,
            "credits": 0,
            "expenses": 0,
            "expensesBox": 0,
            "return": 0,
            "avgNet": 0,
            "orderType": "L"
        },
        {
            "awb": "000-0000-0417",
            "shipDate": "2018-04-17",
            "category": "Agapanthus",
            "variety": "",
            "color": "Red",
            "grade": "",
            "pieces": 12,
            "boxType": "EB",
            "fbeReceived": 1.44,
            "fbeSold": 0,
            "unitsSold": 0,
            "totalSales": 0,
            "avgPriceUnit": 0,
            "commission": 0,
            "credits": 0,
            "expenses": 0,
            "expensesBox": 0,
            "return": 0,
            "avgNet": 0,
            "orderType": "M"
        }
    ]
}

 

 

Important

This method only works with tokens type Vendor.

  • No labels