Use this method to get the same information as the existing Grower Report, such as Boxes received and sold per AWB, commissions, expenses, and more.
|
Request
URL: 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 (required)(date)
The initial arrival date of the AWBs.
Date format: YYYY-MM-DD
arrivalDateTo (optional)(date)
The final arrival date of AWBs.
Required if ShipDateTo is not specified.
Date format YYYY-MM-DD
shipDateFrom (optional)(date)
The initial ship date of products.
Required if arrivalDateFrom is not specified.
Date format: YYYY-MM-DD
shipDateTo (optional)(date)
The initial ship date of products.
Required if arrivalDateTo is not specified.
Date format: YYYY-MM-DD
poNumber (optional)(integer)
The PO# associated to the Vendor.
orderType (optional)
Inventory type from the products in the Purchase Order. You can only choose one.
Valid values: L = Local products | M = Open Market | P = Prebook | S = Standing Order
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
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
message (string:500)
Request status description.
items (array)
An array containing a breakdown of items by AWB.
awb (string:15)
AWB number.
orderType(string:1)
Order type.
Valid values: P = Prebook | S = Standing Order | L = Local products | M = Open Market
shipDate (date)
AWB ship date.
Date format: YYYY-MM-DD
color (string:50)
Product color.
category (string:50)
Product category.
variety (string:50)
Product variety.
grade (string:100)
Product grade or cut point.
pieces (integer:10)
Total number of pieces purchased.
boxType (string:3)
Box-Type code.
Valid values: FB, HB, QB, etc.
fbeReceived (decimal:10,2)
Total number of boxes received in Full Box Equivalence.
fbeSold (decimal:10,2)
Total number of boxes sold in Full Box Equivalence.
unitsSold (integer:10)
Total of Units sold.
totalSales (decimal:10,2)
Total sales amount.
avgPriceUnit (decimal:10,2)
Average price per unit.
commission (decimal:10,2)
Total commission value.
credits (decimal:10,2)
Total amount in credits for the Vendor.
expenses (decimal:10,2)
Landed cost minus the flower cost.
expensesBox (decimal:10,2)
Total expenses per full box.
return (decimal:10,2)
Total return.
Calculated with: Total Sales - Commission - Credits - Expenses
avgNet (decimal:10,2)
Total Return / Units Sold.
{
"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"
}
]
} |