Skip to Content
FastracDocs

Permissions

Which permission each API endpoint and dashboard feature needs, and what the default Admin and Member roles include.

Product
APIShipping Engine API
Section
Reference
Reading time
4 min read

Every user in an organisation has one role, and a role is a list of permission codes. An endpoint that needs a permission your role doesn't have returns 403 Missing permissions.

Your API key uses the owner's role

An API key belongs to the organisation, but every API call acts as the organisation owner: the user whose business verification created the organisation.

  • The key has exactly the permissions of the owner's current role. If an admin changes that role, the key's permissions change on the next request.
  • Orders, shipments, balance and balance logs are kept per user. Everything you create through the API belongs to the owner, is paid from the owner's balance, and appears in the owner's dashboard.
  • The owner gets the Admin role when the business is approved, so a new key can call every endpoint below. Keep the owner on a role that has at least the permissions your integration uses.

API endpoints

EndpointPermission
Regions: searchRegions, listProvinces, listCities, listDistricts, listSubdistricts, lookupPostcodeNone (no token needed)
listPackageTypesNone (no token needed)
listCouriers, listCourierServicesREAD_SHIPPING_RATES
createShippingRates, retrieveShippingRateREAD_SHIPPING_RATES, plus USE_COD when you send codOption
createOrderCREATE_ORDER, plus USE_COD when a rate uses COD
cancelOrderREAD_ORDER
listShipments, retrieveShipment, trackShipmentREAD_ORDER
cancelShipmentCANCEL_ORDER
simulateShipmentStatus (sandbox only)CANCEL_ORDER
retrieveBalance, listBalanceLogsNone beyond a valid token
retrieveWebhookEndpointREAD_WEBHOOKS
setWebhookEndpointMANAGE_WEBHOOKS

Permission codes

CodeAllowsAdminMember
READ_SHIPPING_RATESList couriers and services, request and read shipping rates (API)YesNo
USE_CODQuote and book cash-on-delivery (COD) shipmentsYesYes
CREATE_ORDERCreate orders (API) and book shipments in the dashboardYesYes
READ_ORDERList, view and track shipments; cancel whole orders (API)YesYes
CANCEL_ORDERCancel single shipments; simulate statuses in the sandboxYesYes
READ_WEBHOOKSView the webhook endpointYesNo
MANAGE_WEBHOOKSSet, change, disable or delete the webhook endpointYesNo
READ_API_KEYSView the organisation's API key details in the dashboardYesNo
MANAGE_API_KEYSRotate the API key secretYesNo
READ_ORGANIZATIONView the organisation profile and its membersYesYes
UPDATE_ORGANIZATIONEdit the organisation profileYesNo
MANAGE_MEMBERSInvite and remove members, change a member's roleYesNo
MANAGE_ROLESCreate, edit, delete and assign custom rolesYesNo
READ_BANK_ACCOUNTSView bank accounts for withdrawalsYesYes
MANAGE_BANK_ACCOUNTSAdd bank accounts and choose the active oneYesYes
READ_ADDRESS_BOOKView saved addressesYesYes
MANAGE_ADDRESS_BOOKAdd, edit and delete saved addressesYesYes
READ_PRODUCT_CATALOGView the store's product catalogYesYes
MANAGE_PRODUCT_CATALOGAdd and edit products, variants, categories and imagesYesYes
MANAGE_USERSIncluded in Admin. Not required by any endpoint today.YesNo
READ_INVOICESIncluded in Admin. Not required by any endpoint today.YesNo

Admin and Member are the two roles every business organisation starts with. The owner is an Admin. People you invite get the role you choose, or Member (the default role) when you don't choose one. Both roles can be edited.

Custom roles

Anyone with MANAGE_ROLES (Admins by default) can create custom roles from the codes above in the dashboard's organisation settings, and assign them to members. Other permission codes exist for Shipping Engine staff and can't be added to an organisation role.

Don't lock out your integration

Removing CREATE_ORDER, READ_ORDER or READ_SHIPPING_RATES from the owner's role stops your API integration immediately. Change the owner's role only on purpose.

Was this page helpful?

On this page