Skip to content

Glossary (draft)

Jump to bottom
Alexandru Ichim edited this page Apr 29, 2021 · 12 revisions

This is a Glossary to help you navigate and understand the different terminology within the CoopCycle docs.

Platform

  • Platform → the logistics software developed by CoopCycle and used by Coops, Clients and Customers to fulfill and create Orders, purchase products or book Deliveries.
  • App → The mobile app (Android and iPhone) where the Platform can be accessed by its different Users.
  • Settings → The section where you can configure the settings of an Instance.
  • Instance → An Instance is the fully-fledged CoopCycle platform local to each Coop.
  • Dispatch Admin dashboard → The area of the Platform where a Dispatcher can create, cancel, modify and assign Tasks and Orders to Couriers.
  • Dashboard1 → The area of the Platform where an Admin can see overall stats regarding Tasks and Orders.
  • Live orders2 Dashboard → This area is for viewing Orders coming in Live on the Platform. Live orders can be viewed in two ways: Overview where you can view Live Orders from all Shops at once and Regular view where you can view Live orders from an individual Shop.
  • Store3 → Store is a Business account on the Platform where a Store owner can create Orders. Sometimes a Store is referred to as Backoffice, meaning it's not visible on the Homepage of an Instance and Customers cannot purchase Products online from a Store. A Store is also known as a Client.
  • Shop Restaurant → Shop is a Business account on the Platform where Customers can place online Orders from a selection of Products and pay online. A Shop is visible on the Homepage of an Instance. A Shop can be anything from food, to clothes, to jewelry, to homeware and so on. A Shop is also known as a Client.
  • Task → A Task is an action created by an Admin or Dispatcher and fulfilled by a Courier. A Task can be a Pick-up or a Drop-off. Each task has a unique ID.
    • Pick-up → A Pick-up is a Task. It can exist as an individual action or can be part of an Order. A Pick-up is also known as a Collection.
    • Drop-off4 → A Drop-off is a Task. It can exist as an individual action or can be part of an Order.
  • Order → An Order is a grouping of two Tasks (one Pick-up and one Drop-off). An Order can be created by an Admin, Store client or a Customer. Each Order has a unique ID unrelated to the ID of Tasks.

Users

  • User/s → Any kind of user that has log in details and can utilise the Platform.
  • Admin → A User that has full access to the Platform, usually a Coop member.
  • Dispatcher5 → A User that has access to the Dispatch being able to create, cancel, modify and assign Tasks and Orders. A Dispatcher also has access to the overall Dashboard and Live orders.
  • Courier → A User that can receive and fulfill Orders. A Courier can also be referred to as a Rider.
  • Store owner → A User that is a Store owner and can place orders on their Store account. A Store owner is also referred to as a Client.
  • Shop owner → A User that is a Shop owner where Customers can purchase and pay online Shop Products. A Shop owner is also referred to as a Client.
  • Customer → A User that can purchase Products from a Shop and pay online.

Coop / Cooperative

  • Coop is a bicycle cooperative part of CoopCycle that uses the Platform to perform their courier activities.
  • Coop member → A member of a bicycle Coop.

Additional terminology

  • Backoffice → A Store account that can be accessed by a Store owner and is not visible on the Homepage nor can Products be purchased online.
  • Client → Referring to a Client of the Coop. A Client can be a Store/Store owner or a Shop/Shop owner.
  • Delivery → Informally referring to an Order.
  • Rider → Informally referring to a Courier.
  • Store account → A Backoffice account.

1 The Dashboard is being developed.
2 The current Dashboard under Orders could be refactored this way, see issue #2342.
3 Mex suggested that we determine our own schema if needed and not follow Schema.org 100%. In that regard, I believe we should keep Store as the term for Backoffice accounts.
4 The Dispatcher User is yet to be created on the Platform.
5 The term Delivery shouldn't be used to refer to a Drop-off.

Clone this wiki locally