Pavers API

Module: Cartons

A module containing the routes for dealing with cartons
Since:
  • 15/09/2017
Author:
  • Dave

Members

<route> getStoreDeliveryCartons

Route:
MethodPath
GET /api/v1/cartons/store
returns a list of cartons that a store need to accept
Query Parameters:
Name Type Description
branchID int The id of the branch to retrieve cartons for
daysOutstanding int How many days worth of cartons?
showScanned int Include cartons that have already been scanned
Since:
  • 18/09/2017
Author:
  • Dave
See:
  • HeelRealm.CartonFragment.getCartons
Example
/api/v1/cartons/store?branchID=22&daysOutstanding=5&showScanned=0

<route> postCarton

Route:
MethodPath
POST /api/v1/cartons/store
Updates a carton and marks it as scanned
Query Parameters:
Name Type Description
cartonID int The id of the carton that has been scanned
Since:
  • 18/09/2017
Author:
  • Dave
See:
  • HeelsRealm.CartonFragment.sendScanned
Example
/api/v1/cartons/store {BODY}

<route> postFailedCarton

Route:
MethodPath
POST /api/v1/cartons/store/failed
Trys to mark a failed scan
Query Parameters:
Name Type Description
branchID int The id of the branch that scanned a non carton
scannedBarcode string Whatever they have scanned
Since:
  • 18/09/2017
Author:
  • Dave
See:
  • HeelsRealm.CartonFragment.postAttemptedScan
Example
/api/v1/cartons/store/failed {BODY}