Quick Docket

Appearance

Common Scopes ​

Many permission keys include a scope. A scope determines which records a permission applies to.

The following scopes are used throughout the permissions system.

All ​

The all scope grants access to every record for a table or feature.

text
locations.list.all
line_items.edit.all

Managing ​

The managing scope grants access to records that the user is responsible for as an account manager.

A record is considered to be managed by a user in the following situations:

  • If they are the account manager of a customer, they are considered to be managing that customer and all child records, including locations, contacts, portal users, orders, line items and delivery receipts.
  • If they are the account manager of a location, they are considered to be managing that location and all child records, including orders, line items and delivery receipts.
  • If they are the account manager of an order, they are considered to be managing that order and its child records, including line items and delivery receipts.

Examples:

text
locations.view.managing
contacts.new.managing
orders.list.managing

Assigned ​

The assigned scope grants access to orders that have been assigned to the user.

This permission also applies to records that belong to those orders, such as line items and delivery receipts.

text
order.list.assigned
line_items.edit.assigned

Assigned Deliverable ​

The assigned.deliverable scope is a more restrictive version of assigned and is intended for delivery staff.

In addition to only seeing orders assigned to them, users can only access orders with one of the following statuses:

  • ready_for_delivery
  • in_transit
  • delivered (for up to 10 days after delivery)

This scope also applies to records that belong to the order such as line items and delivery receipts.

This allows delivery staff to focus on the orders they are currently delivering while still providing limited access to recently completed deliveries in case any issues need to be resolved.

text
order.list.assigned.deliverable
line_items.edit.assigned.deliverable

Assigned Pickable ​

The assigned.pickable scope is a more restrictive version of assigned and is intended for warehouse staff.

In addition to only seeing orders assigned to them, users can only access orders with one of the following statuses:

  • processing
  • ready_for_delivery

This scope also applies to records that belong to the order such as line items and delivery receipts.

This allows warehouse staff to focus only on the orders they are currently preparing.

text
order.list.assigned.pickable
line_items.edit.assigned.pickable