API Roles
Table of Contents
Purpose
When creating an API Client, you must select the applicable API roles for the Client. These roles will dictate the API Client's access to your account when using the API; therefore, it is important that you enable the correct Roles for each Client.
API Roles Explained
|
Role |
Access |
API Document Links |
|---|---|---|
|
Add Customer |
Create a new customer View customers |
https://api-docs.cartoncloud.com/#create-customer |
|
Internal Field Access |
View Custom Fields marked as Internal Only |
|
|
TMS Create Job |
Add, view & search consignments View available Transport Products View Customers (only those the API client has access to) View which Custom Fields exist (but not Internal Custom Fields) View Warehouses (only those the API client has access to) |
https://api-docs.cartoncloud.com/#create-consignment https://api-docs.cartoncloud.com/#get-consignment https://api-docs.cartoncloud.com/#search-consignment https://api-docs.cartoncloud.com/#list-transport-products https://api-docs.cartoncloud.com/#get-transport-product |
|
TMS View Job |
View Consignments (including Warehouse Fulfilments) Note, this is automatically enabled when TMS Create Job is selected |
|
|
TMS Add/Edit Product |
Create New Transport Product View Transport Product/s |
https://api-docs.cartoncloud.com/#create-transport-product |
|
WMS Create Job |
Add, view, search and delete Purchase Orders (Inbound) Add, view, search and delete Sale Orders (Outbound) View Customers (only those the API client has access to) Run Stock Reports View Custom Fields (but not Internal Custom Fields) View Warehouses (only those the API client has access to) Please note, if the customer is configured with the 'Automatically Generate a Consignment from a Sale Order' setting, 'Yes, on Sale Order Import or Pack Completion', then the API Client will also require the 'TMS Create Jobs' role. |
https://api-docs.cartoncloud.com/#inbound-orders-purchase-orders https://api-docs.cartoncloud.com/#outbound-orders-sale-orders |
|
WMS Add Product |
Add, view Warehouse Products (Product Masters) Please note, even if you have the setting Stop Customers from being able to add their own Products enabled for the customer associated with the API Client, this will be ignored, and the customer using the API Client will still be able to add a WMS Product. |
|
|
WMS Edit Product |
Edit, view Warehouse Products (Product Masters) |
https://api-docs.cartoncloud.com/#update-product-put https://api-docs.cartoncloud.com/#partial-product-update-patch |