Scopes

A scope represents an action that a Client Application may take on a user's behalf. Generally scopes represent the ability to either read or write a particular type of data, to/from a backend Server system that supports the requested operation.

Access to a scope must be requested when a connection is created. If additional access is needed at a later date, the user will be required to go through the setup process again to approve the additional permissions.

List of Scopes

ID

Name (presented to user)

Description

SHIPMENT_READ

Read shipment data

Retrieve data for a specific Shipment from a backend Server

SHIPMENT_MILESTONE_WRITE

Write shipment milestone

Write a milestone to a specific shipment ID.

SHIPMENT_DOCUMENT_WRITE

Attach document to shipment

This scope grants access to the two stage upload process:
a. To upload files to object storage.
b. To attach uploaded file to a shipment.

READ_SHIPMENT_PAYABLES

Get Accruals / Payables

Used to get financial data like accruals and payables

READ_SHIPMENT_DOCUMENTS

List Documents / Get document

List and retrieve shipment documents