Pavers API

Module: CustomerOrder

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

Members

<route> getBranchVars

Route:
MethodPath
GET /api/v1/cop/branch/vars
returns the cop system variables for a branch
Since:
  • 18/09/2017
Author:
  • Dave
See:
  • Unknown
Example
/api/v1/cop/branch/vars?branchCode=312

<route> getDiscounts

Route:
MethodPath
GET /api/v1/cop/discounts
returns a list of available discounts
Since:
  • 18/09/2017
Author:
  • Dave
See:
  • Unknown
Example
/api/v1/cop/discounts

<route> getOrders

Route:
MethodPath
GET /api/v1/cop/orders
returns a list of orders with non collected items for a branch
Query Parameters:
Name Type Description
req.query.branchCode integer the branch code to fetch expected for
Since:
  • 29/03/2018
Author:
  • Dave
See:
  • HeelsRealm.copreceived.COPReceievedFragment
Example
/api/v1/cop/orders?branchCode=312

<route> postCollected

Route:
MethodPath
POST /api/v1/cop/collected
marks an order collected
Query Parameters:
Name Type Description
req.query.orderNumber string the order to mark
req.query.branchCode string the branch the order has been received too
Since:
  • 29/03/2018
Author:
  • Dave
See:
  • HeelsRealm.copreceived.COPReceievedFragment
Example
/api/v1/cop/collected {body}

<route> postContacted

Route:
MethodPath
POST /api/v1/cop/contacted
marks an order customer contacted
Query Parameters:
Name Type Description
req.query.orderNumber string the order to mark
req.query.branchCode string the branch the order has been received too
Since:
  • 29/03/2018
Author:
  • Dave
See:
  • HeelsRealm.copreceived.COPReceievedFragment
Example
/api/v1/cop/contacted {body}