get https://{domain_prefix}.retail.lightspeed.app/api/2.0/consignments//totals
Returns the count and cost for the given consignment.
The consignment type can be SUPPLIER
, OUTLET
or RETURN
(not STOCKTAKE
).
The status of the consignment will determine which values make sense:
- If the consignment type is
OUTLET
the sent cost may not be accurate when the status isOPEN
. - If the consignment is
OPEN
orSENT
the received count and cost should both be zero. - For completely received consignments received cost should equal the sent cost and the received count should equal the sent count.
- For partially received consignments we would expect the received cost value to be less than sent cost value, and the received count to be less than the sent count.