When your app requests authorisation from a user it will ask for a set of scopes. The scopes will be displayed to the user on the authorisation screen and will describe what data your Custom App will be able to access.
You should request the minimum scopes required for whatever action that user is performing. It is not possible to remove scopes from an existing access token, instead revoke the token and start again.
Scopes displayed when authorising a Custom App with Consignly
Offline Access
If you wish to receive a Refresh Token when authorising with Consignly, you must request the offline_access scope. Using a refresh token means you can refresh your Access Token and maintain a connection without requiring user input.
Organisation Scopes
Use these scopes to request access to data in a Consignly organisation:
| Scope | Purpose |
| consignment | View and manage parts of your consignments |
| consignment.read | View parts of your consignments |
| partner | View and manage parts of your partners |
| partner.read | View parts of your partners |
| organisation | View and manage parts of your organisation |
| organisation.read | View parts of your organisation |
| warehouse | View and manage parts of your warehouse |
| warehouse.read | View parts of your warehouse |
| inventory | View inventory and manage certain inventory functions within your warehouse |
| inventory.read | View parts of your inventory |
| financial | View and manage financial data such as schedules for your organisation |
| financial.read | View parts of your financial data for your organisation |
| report | Run report data for your organisation |