GraphQL Permissions

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Essential knowledge

Author:

Fluent Commerce

Changed on:

3 May 2024

Overview

Every GraphQL operation is currently protected by Permissions.

Key points

Permissions Naming Convention: Queries and mutations are governed by permissions named after the entity and operation type, such as ENTITY_VIEW or ENTITY_CREATE.
Nested and Partial Mutations: Nested mutations require separate permissions, and partial mutations are not permitted—if one fails, the entire operation fails.
Plugin Management: Access to plugin management is controlled through specific Plugin Permissions.
Error Handling: Operations attempted without proper permissions will result in an error code (C0020E) and require contacting support to resolve permission issues.

1ACCOUNTUSAGE_VIEW(ACCOUNTUSAGE, VIEW),
2ARTICLE_AWAITING_ARRIVAL_VIEW(REPORT, VIEW),
3ARTICLE_AWAITING_CARRIER_COLLECTION_VIEW(REPORT, VIEW),
4ARTICLE_AWAITING_CUSTOMER_COLLECTION_VIEW(REPORT, VIEW),
5ARTICLE_CREATE(ARTICLE, CREATE),
6ARTICLE_EXCEPTION_VIEW(REPORT, VIEW),
7ARTICLE_UPDATE(ARTICLE, EDIT),
8ARTICLE_VIEW(ARTICLE, VIEW),
9ARTICLEITEM_CREATE(ARTICLEITEM, CREATE),
10ARTICLEITEM_VIEW(ARTICLEITEM, VIEW),
11BATCH_VIEW(BATCH, VIEW),
12BILLINGACCOUNT_CREATE(BILLINGACCOUNT, CREATE),
13BILLINGACCOUNT_UPDATE(BILLINGACCOUNT, EDIT),
14BILLINGACCOUNT_VIEW(BILLINGACCOUNT, VIEW),
15CARRIER_CREATE(CARRIER, CREATE),
16CARRIER_UPDATE(CARRIER, EDIT),
17CARRIER_VIEW(CARRIER, VIEW),
18CATEGORY_CREATE(CATEGORY, CREATE),
19CATEGORY_UPDATE(CATEGORY, EDIT),
20CATEGORY_VIEW(CATEGORY, VIEW),
21CATEGORYGROUPPRODUCT_REMOVE(CATEGORYGROUPPRODUCT, REMOVE),
22CATEGORYSTANDARDPRODUCT_REMOVE(CATEGORYSTANDARDPRODUCT, REMOVE),
23CATEGORYVARIANTPRODUCT_REMOVE(CATEGORYVARIANTPRODUCT, REMOVE),
24COMMENT_CREATE(COMMENT, CREATE),
25COMMENT_UPDATE(COMMENT, EDIT),
26COMMENT_VIEW(COMMENT, VIEW),
27CONSIGNMENT_CREATE(CONSIGNMENT, CREATE),
28CONSIGNMENT_UPDATE(CONSIGNMENT, EDIT),
29CONSIGNMENT_VIEW(CONSIGNMENT, VIEW),
30CONTROL_CREATE(CONTROL, CREATE),
31CONTROL_UPDATE(CONTROL, EDIT),
32CONTROL_VIEW(CONTROL, VIEW),
33CONTROLGROUP_CREATE(CONTROLGROUP, CREATE),
34CONTROLGROUP_UPDATE(CONTROLGROUP, EDIT),
35CONTROLGROUP_VIEW(CONTROLGROUP, VIEW),
36CREDITMEMO_CREATE(CREDITMEMO, CREATE),
37CREDITMEMO_UPDATE(CREDITMEMO, EDIT),
38CREDITMEMO_VIEW(CREDITMEMO, VIEW),
39CUSTOMER_CREATE(CUSTOMER, CREATE),
40CUSTOMER_UPDATE(CUSTOMER, EDIT),
41CUSTOMER_VIEW(CUSTOMER, VIEW),
42CUSTOMERADDRESS_CREATE(CUSTOMERADDRESS, CREATE),
43CUSTOMERADDRESS_UPDATE(CUSTOMERADDRESS, EDIT),
44CUSTOMERADDRESS_VIEW(CUSTOMERADDRESS, VIEW),
45DASHBOARD_VIEW(DASHBOARD, VIEW),
46DECISIONRULE_CREATE(DECISIONRULE, CREATE),
47DECISIONRULE_REMOVE(DECISIONRULE, REMOVE),
48DECISIONTABLE_VIEW(DECISIONTABLE, VIEW),
49EVENT_VIEW(EVENT, VIEW),
50FINANCIALTRANSACTION_CREATE(FINANCIALTRANSACTION, CREATE),
51FINANCIALTRANSACTION_UPDATE(FINANCIALTRANSACTION, EDIT),
52FINANCIALTRANSACTION_VIEW(FINANCIALTRANSACTION, VIEW),
53FULFILMENT_CREATE(FULFILMENT, CREATE),
54FULFILMENT_OPTIONS_VIEW(FULFILMENT_OPTIONS, VIEW),
55FULFILMENT_UPDATE(FULFILMENT, EDIT),
56FULFILMENT_VIEW(FULFILMENT, VIEW),
57FULFILMENTCHOICE_CREATE(FULFILMENTCHOICE, CREATE),
58FULFILMENTCHOICE_UPDATE(FULFILMENTCHOICE, EDIT),
59FULFILMENTCHOICE_VIEW(FULFILMENTCHOICE, VIEW),
60FULFILMENTITEM_CREATE(FULFILMENTITEM, CREATE),
61FULFILMENTITEM_UPDATE(FULFILMENTITEM, EDIT),
62FULFILMENTITEM_VIEW(FULFILMENTITEM, VIEW),
63FULFILMENTOPTION_CREATE(FULFILMENT_OPTIONS, CREATE),
64FULFILMENTOPTION_UPDATE(FULFILMENT_OPTIONS, EDIT),
65FULFILMENTOPTION_VIEW(FULFILMENTOPTION, VIEW),
66FULFILMENTPLAN_CREATE(FULFILMENTPLAN, CREATE),
67FULFILMENTPLAN_UPDATE(FULFILMENTPLAN, EDIT),
68FULFILMENTPLAN_VIEW(FULFILMENTPLAN, VIEW),
69GROUPPRODUCT_CREATE(GROUPPRODUCT, CREATE),
70GROUPPRODUCT_UPDATE(GROUPPRODUCT, EDIT),
71GROUPPRODUCT_VIEW(GROUPPRODUCT, VIEW),
72INVENTORY_VIEW(INVENTORY, VIEW),
73INVENTORYCATALOGUE_CREATE(INVENTORYCATALOGUE, CREATE),
74INVENTORYCATALOGUE_UPDATE(INVENTORYCATALOGUE, EDIT),
75INVENTORYCATALOGUE_VIEW(INVENTORYCATALOGUE, VIEW),
76INVENTORYFEED_CREATE(INVENTORYFEED, CREATE),
77INVENTORYFEED_UPDATE(INVENTORYFEED, EDIT),
78INVENTORYFEED_VIEW(INVENTORYFEED, VIEW),
79INVENTORYFEEDRUN_CREATE(INVENTORYFEEDRUN, CREATE),
80INVENTORYFEEDRUN_UPDATE(INVENTORYFEEDRUN, EDIT);
81INVENTORYFEEDRUN_VIEW(INVENTORYFEEDRUN, VIEW),
82INVENTORYPOSITION_CREATE(INVENTORYPOSITION, CREATE),
83INVENTORYPOSITION_UPDATE(INVENTORYPOSITION, EDIT),
84INVENTORYPOSITION_VIEW(INVENTORYPOSITION, VIEW),
85INVENTORYQUANTITY_CREATE(INVENTORYQUANTITY, CREATE),
86INVENTORYQUANTITY_UPDATE(INVENTORYQUANTITY, EDIT),
87INVENTORYQUANTITY_VIEW(INVENTORYQUANTITY, VIEW),
88INVOICE_CREATE(INVOICE, CREATE),
89INVOICE_UPDATE(INVOICE, EDIT),
90INVOICE_VIEW(INVOICE, VIEW),
91JOB_VIEW(JOB, VIEW),
92LOCATION_CREATE(LOCATION, CREATE),
93LOCATION_UPDATE(LOCATION, EDIT),
94LOCATION_VIEW(LOCATION, VIEW),
95LOCATIONETA_VIEW(LOCATIONETA, VIEW),
96LOCATIONNETWORK_REMOVE(LOCATIONNETWORK, REMOVE),
97MANIFEST_CREATE(MANIFEST, CREATE),
98MANIFEST_UPDATE(MANIFEST, EDIT),
99MANIFEST_VIEW(MANIFEST, VIEW),
100METRICS_VIEW(METRICS, VIEW),
101NETWORK_CREATE(NETWORK, CREATE),
102NETWORK_UPDATE(NETWORK, EDIT),
103NETWORK_VIEW(NETWORK, VIEW),
104NETWORKLOCATION_REMOVE(NETWORKLOCATION, REMOVE),
105OPENINGSCHEDULE_CREATE(OPENINGSCHEDULE, CREATE),
106OPENINGSCHEDULE_UPDATE(OPENINGSCHEDULE, EDIT),
107OPENINGSCHEDULE_VIEW(OPENINGSCHEDULE, VIEW),
108ORDER_CREATE(ORDER, CREATE),
109ORDER_UPDATE(ORDER, EDIT),
110ORDER_VIEW(ORDER, VIEW),
111ORDERITEM_CREATE(ORDERITEM, CREATE),
112ORDERITEM_UPDATE(ORDERITEM, EDIT),
113ORDERITEM_VIEW(ORDERITEM, VIEW),
114PAYMENT_CREATE(PAYMENT, CREATE),
115PAYMENT_UPDATE(PAYMENT, EDIT),
116PAYMENT_VIEW(PAYMENT, VIEW),
117PAYMENTSERVICEPROVIDER_CREATE(PAYMENTSERVICEPROVIDER, CREATE),
118PAYMENTSERVICEPROVIDER_UPDATE(PAYMENTSERVICEPROVIDER, EDIT),
119PAYMENTSERVICEPROVIDER_VIEW(PAYMENTSERVICEPROVIDER, VIEW),
120PERMISSION_VIEW(PERMISSION, VIEW),
121PERMISSIONROLE_REMOVE(PERMISSIONROLE, REMOVE),
122PLUGIN_INSTALL(PLUGIN, INSTALL),
123PLUGIN_UPLOAD(PLUGIN, UPLOAD),
124PLUGIN_VIEW(PLUGIN, VIEW),
125PRICE_VIEW(PRICE, VIEW),
126PRODUCT_VIEW(PRODUCT, VIEW),
127PRODUCTCATALOGUE_CREATE(PRODUCTCATALOGUE, CREATE),
128PRODUCTCATALOGUE_UPDATE(PRODUCTCATALOGUE, EDIT),
129PRODUCTCATALOGUE_VIEW(PRODUCTCATALOGUE, VIEW),
130REPORT_VIEW(REPORT, VIEW),
131RETAILER_CREATE(RETAILER, CREATE),
132RETAILER_UPDATE(RETAILER, EDIT),
133RETAILER_VIEW(RETAILER, VIEW),
134RETURN_VIEW(RETURN, VIEW),
135RETURNORDER_CREATE(RETURNORDER, CREATE),
136RETURNORDER_UPDATE(RETURNORDER, EDIT),
137RETURNORDER_VIEW(RETURNORDER, VIEW),
138ROLE_CREATE(ROLE, CREATE),
139ROLE_UPDATE(ROLE, EDIT),
140ROLE_VIEW(ROLE, VIEW),
141ROLEPERMISSION_UPDATE(ROLEPERMISSION, EDIT),
142ROLEUSER_REMOVE(ROLEUSER, REMOVE),
143SEARCHVIRTUALINVENTORY(VIRTUALINVENTORY, VIEW),
144SETTING_CREATE(SETTING, CREATE),
145SETTING_UPDATE(SETTING, EDIT),
146SETTING_VIEW(SETTING, VIEW),
147SKU_VIEW(SKU, VIEW),
148STANDARDPRODUCT_CREATE(STANDARDPRODUCT, CREATE),
149STANDARDPRODUCT_UPDATE(STANDARDPRODUCT, EDIT),
150STANDARDPRODUCT_VIEW(STANDARDPRODUCT, VIEW),
151STORAGEAREA_CREATE(STORAGEAREA, CREATE),
152STORAGEAREA_UPDATE(STORAGEAREA, EDIT),
153STORAGEAREA_VIEW(STORAGEAREA, VIEW),
154STORAGEAREARESERVATION_VIEW(STORAGEAREARESERVATION, VIEW),
155STOREADDRESS_CREATE(STOREADDRESS, CREATE),
156STOREADDRESS_UPDATE(STOREADDRESS, EDIT),
157STOREADDRESS_VIEW(STOREADDRESS, VIEW),
158TAXTYPE_VIEW(TAXTYPE, VIEW),
159TRANSACTION_VIEW(TRANSACTION, VIEW),
160USER_CREATE(USER, CREATE),
161USER_UPDATE(USER, EDIT),
162USER_VIEW(USER, VIEW),
163USERROLE_UPDATE(USERROLE, EDIT),
164VARIANTPRODUCT_CREATE(VARIANTPRODUCT, CREATE),
165VARIANTPRODUCT_UPDATE(VARIANTPRODUCT, EDIT),
166VARIANTPRODUCT_VIEW(VARIANTPRODUCT, VIEW),
167VIRTUALCATALOGUE_CREATE(VIRTUALCATALOGUE, CREATE),
168VIRTUALCATALOGUE_UPDATE(VIRTUALCATALOGUE, EDIT),
169VIRTUALCATALOGUE_VIEW(VIRTUALCATALOGUE, VIEW),
170VIRTUALINVENTORY_VIEW(VIRTUALINVENTORY, VIEW),
171VIRTUALPOSITION_CREATE(VIRTUALPOSITION, CREATE),
172VIRTUALPOSITION_UPDATE(VIRTUALPOSITION, EDIT),
173VIRTUALPOSITION_VIEW(VIRTUALPOSITION, VIEW),
174VIRTUALVIEW_CREATE(VIRTUALVIEW, CREATE),
175VIRTUALVIEW_VIEW(VIRTUALVIEW, VIEW),
176VIRTUALVIEWINVENTORYLEVELS(VIRTUALVIEW, VIEW),
177WAVE_CREATE(WAVE, CREATE),
178WAVE_UPDATE(WAVE, EDIT),
179WAVE_VIEW(WAVE, VIEW),
180WORKFLOW_CREATE(WORKFLOW, CREATE),
181WORKFLOW_UPDATE(WORKFLOW, EDIT),
182WORKFLOW_VIEW(WORKFLOW, VIEW).

Query Permissions

Every query operation is currently protected by permissions.

Permissions on entities follow an `<<ENTITY>>_VIEW` naming convention.

Examples:

The Order entity is protected by the `ORDER_VIEW` permission and the Location entity is protected by the `LOCATION_VIEW` permission etc.

1ACCOUNTUSAGE_VIEW(ACCOUNTUSAGE, VIEW),
2ARTICLE_AWAITING_ARRIVAL_VIEW(REPORT, VIEW),
3ARTICLE_AWAITING_CARRIER_COLLECTION_VIEW(REPORT, VIEW),
4ARTICLE_AWAITING_CUSTOMER_COLLECTION_VIEW(REPORT, VIEW),
5ARTICLE_EXCEPTION_VIEW(REPORT, VIEW),
6ARTICLE_VIEW(ARTICLE, VIEW),
7ARTICLEITEM_VIEW(ARTICLEITEM, VIEW),
8BATCH_VIEW(BATCH, VIEW),
9BILLINGACCOUNT_VIEW(BILLINGACCOUNT, VIEW),
10CARRIER_VIEW(CARRIER, VIEW),
11CATEGORY_VIEW(CATEGORY, VIEW),
12COMMENT_VIEW(COMMENT, VIEW),
13CONSIGNMENT_VIEW(CONSIGNMENT, VIEW),
14CONTROL_VIEW(CONTROL, VIEW),
15CONTROLGROUP_VIEW(CONTROLGROUP, VIEW),
16CREDITMEMO_VIEW(CREDITMEMO, VIEW),
17CUSTOMER_VIEW(CUSTOMER, VIEW),
18CUSTOMERADDRESS_VIEW(CUSTOMERADDRESS, VIEW),
19DASHBOARD_VIEW(DASHBOARD, VIEW),
20DECISIONTABLE_VIEW(DECISIONTABLE, VIEW),
21EVENT_VIEW(EVENT, VIEW),
22FINANCIALTRANSACTION_VIEW(FINANCIALTRANSACTION, VIEW),
23FULFILMENT_OPTIONS_VIEW(FULFILMENT_OPTIONS, VIEW),
24FULFILMENT_VIEW(FULFILMENT, VIEW),
25FULFILMENTCHOICE_VIEW(FULFILMENTCHOICE, VIEW),
26FULFILMENTITEM_VIEW(FULFILMENTITEM, VIEW),
27FULFILMENTOPTION_VIEW(FULFILMENTOPTION, VIEW),
28FULFILMENTPLAN_VIEW(FULFILMENTPLAN, VIEW),
29GROUPPRODUCT_VIEW(GROUPPRODUCT, VIEW),
30INVENTORY_VIEW(INVENTORY, VIEW),
31INVENTORYCATALOGUE_VIEW(INVENTORYCATALOGUE, VIEW),
32INVENTORYFEED_VIEW(INVENTORYFEED, VIEW),
33INVENTORYFEEDRUN_VIEW(INVENTORYFEEDRUN, VIEW),
34INVENTORYPOSITION_VIEW(INVENTORYPOSITION, VIEW),
35INVENTORYQUANTITY_VIEW(INVENTORYQUANTITY, VIEW),
36INVOICE_VIEW(INVOICE, VIEW),
37JOB_VIEW(JOB, VIEW),
38LOCATION_VIEW(LOCATION, VIEW),
39LOCATIONETA_VIEW(LOCATIONETA, VIEW),
40MANIFEST_VIEW(MANIFEST, VIEW),
41METRICS_VIEW(METRICS, VIEW)
42NETWORK_VIEW(NETWORK, VIEW),
43OPENINGSCHEDULE_VIEW(OPENINGSCHEDULE, VIEW),
44ORDER_VIEW(ORDER, VIEW),
45ORDERITEM_VIEW(ORDERITEM, VIEW),
46PAYMENT_VIEW(PAYMENT, VIEW),
47PAYMENTSERVICEPROVIDER_VIEW(PAYMENTSERVICEPROVIDER, VIEW),
48PERMISSION_VIEW(PERMISSION, VIEW),
49PRICE_VIEW(PRICE, VIEW),
50PRODUCT_VIEW(PRODUCT, VIEW),
51PRODUCTCATALOGUE_VIEW(PRODUCTCATALOGUE, VIEW),
52REPORT_VIEW(REPORT, VIEW),
53RETAILER_VIEW(RETAILER, VIEW),
54RETURN_VIEW(RETURN, VIEW),
55RETURNORDER_VIEW(RETURNORDER, VIEW),
56ROLE_VIEW(ROLE, VIEW),
57SEARCHVIRTUALINVENTORY(VIRTUALINVENTORY, VIEW),
58SETTING_VIEW(SETTING, VIEW),
59SKU_VIEW(SKU, VIEW),
60STANDARDPRODUCT_VIEW(STANDARDPRODUCT, VIEW),
61STORAGEAREA_VIEW(STORAGEAREA, VIEW),
62STORAGEAREARESERVATION_VIEW(STORAGEAREARESERVATION, VIEW),
63STOREADDRESS_VIEW(STOREADDRESS, VIEW),
64TAXTYPE_VIEW(TAXTYPE, VIEW),
65TRANSACTION_VIEW(TRANSACTION, VIEW),
66USER_VIEW(USER, VIEW),
67VARIANTPRODUCT_VIEW(VARIANTPRODUCT, VIEW),
68VIRTUALCATALOGUE_VIEW(VIRTUALCATALOGUE, VIEW),
69VIRTUALINVENTORY_VIEW(VIRTUALINVENTORY, VIEW),
70VIRTUALPOSITION_VIEW(VIRTUALPOSITION, VIEW),
71VIRTUALVIEW_VIEW(VIRTUALVIEW, VIEW),
72VIRTUALVIEWINVENTORYLEVELS(VIRTUALVIEW, VIEW),
73WAVE_VIEW(WAVE, VIEW),
74WORKFLOW_VIEW(WORKFLOW, VIEW).

Mutation Permissions

Create, update and remove operations are protected by `<<ENTITY>>_CREATE`, `<<ENTITY>>_UPDATE` and `<<ENTITY>>_REMOVE` permissions respectively.

Examples:

The `createSetting` mutation is accessed via the `SETTING_CREATE` permission.
The `updateLocation` mutation is protected by the `LOCATION_UPDATE` permission.
The `removeUserRolesFromUser` mutation requires the `ROLEUSER_REMOVE` permission.

1ARTICLE_CREATE(ARTICLE, CREATE),
2ARTICLEITEM_CREATE(ARTICLEITEM, CREATE),
3BILLINGACCOUNT_CREATE(BILLINGACCOUNT, CREATE),
4CARRIER_CREATE(CARRIER, CREATE),
5CATEGORY_CREATE(CATEGORY, CREATE),
6COMMENT_CREATE(COMMENT, CREATE),
7CONSIGNMENT_CREATE(CONSIGNMENT, CREATE),
8CONTROL_CREATE(CONTROL, CREATE),
9CONTROLGROUP_CREATE(CONTROLGROUP, CREATE),
10CREDITMEMO_CREATE(CREDITMEMO, CREATE),
11CUSTOMER_CREATE(CUSTOMER, CREATE),
12CUSTOMERADDRESS_CREATE(CUSTOMERADDRESS, CREATE),
13DECISIONRULE_CREATE(DECISIONRULE, CREATE),
14FINANCIALTRANSACTION_CREATE(FINANCIALTRANSACTION, CREATE),
15FULFILMENT_CREATE(FULFILMENT, CREATE),
16FULFILMENTCHOICE_CREATE(FULFILMENTCHOICE, CREATE),
17FULFILMENTITEM_CREATE(FULFILMENTITEM, CREATE),
18FULFILMENTOPTION_CREATE(FULFILMENT_OPTIONS, CREATE),
19FULFILMENTPLAN_CREATE(FULFILMENTPLAN, CREATE),
20GROUPPRODUCT_CREATE(GROUPPRODUCT, CREATE),
21INVENTORYCATALOGUE_CREATE(INVENTORYCATALOGUE, CREATE),
22INVENTORYFEED_CREATE(INVENTORYFEED, CREATE),
23INVENTORYFEEDRUN_CREATE(INVENTORYFEEDRUN, CREATE),
24INVENTORYPOSITION_CREATE(INVENTORYPOSITION, CREATE),
25INVENTORYQUANTITY_CREATE(INVENTORYQUANTITY, CREATE),
26INVOICE_CREATE(INVOICE, CREATE),
27LOCATION_CREATE(LOCATION, CREATE),
28MANIFEST_CREATE(MANIFEST, CREATE),
29NETWORK_CREATE(NETWORK, CREATE),
30OPENINGSCHEDULE_CREATE(OPENINGSCHEDULE, CREATE),
31ORDER_CREATE(ORDER, CREATE),
32ORDERITEM_CREATE(ORDERITEM, CREATE),
33PAYMENT_CREATE(PAYMENT, CREATE),
34PAYMENTSERVICEPROVIDER_CREATE(PAYMENTSERVICEPROVIDER, CREATE),
35PRODUCTCATALOGUE_CREATE(PRODUCTCATALOGUE, CREATE),
36RETAILER_CREATE(RETAILER, CREATE),
37RETURNORDER_CREATE(RETURNORDER, CREATE),
38ROLE_CREATE(ROLE, CREATE),
39SETTING_CREATE(SETTING, CREATE),
40STANDARDPRODUCT_CREATE(STANDARDPRODUCT, CREATE),
41STORAGEAREA_CREATE(STORAGEAREA, CREATE),
42STOREADDRESS_CREATE(STOREADDRESS, CREATE),
43USER_CREATE(USER, CREATE),
44VARIANTPRODUCT_CREATE(VARIANTPRODUCT, CREATE),
45VIRTUALCATALOGUE_CREATE(VIRTUALCATALOGUE, CREATE),
46VIRTUALPOSITION_CREATE(VIRTUALPOSITION, CREATE),
47VIRTUALVIEW_CREATE(VIRTUALVIEW, CREATE),
48WAVE_CREATE(WAVE, CREATE),
49WORKFLOW_CREATE(WORKFLOW, CREATE).

1ARTICLE_UPDATE(ARTICLE, EDIT),
2BILLINGACCOUNT_UPDATE(BILLINGACCOUNT, EDIT),
3CARRIER_UPDATE(CARRIER, EDIT),
4CATEGORY_UPDATE(CATEGORY, EDIT),
5COMMENT_UPDATE(COMMENT, EDIT),
6CONSIGNMENT_UPDATE(CONSIGNMENT, EDIT),
7CONTROL_UPDATE(CONTROL, EDIT),
8CONTROLGROUP_UPDATE(CONTROLGROUP, EDIT),
9CREDITMEMO_UPDATE(CREDITMEMO, EDIT),
10CUSTOMER_UPDATE(CUSTOMER, EDIT),
11CUSTOMERADDRESS_UPDATE(CUSTOMERADDRESS, EDIT),
12FINANCIALTRANSACTION_UPDATE(FINANCIALTRANSACTION, EDIT),
13FULFILMENT_UPDATE(FULFILMENT, EDIT),
14FULFILMENTCHOICE_UPDATE(FULFILMENTCHOICE, EDIT),
15FULFILMENTITEM_UPDATE(FULFILMENTITEM, EDIT),
16FULFILMENTOPTION_UPDATE(FULFILMENT_OPTIONS, EDIT),
17FULFILMENTPLAN_UPDATE(FULFILMENTPLAN, EDIT),
18GROUPPRODUCT_UPDATE(GROUPPRODUCT, EDIT),
19INVENTORYCATALOGUE_UPDATE(INVENTORYCATALOGUE, EDIT),
20INVENTORYFEED_UPDATE(INVENTORYFEED, EDIT),
21INVENTORYFEEDRUN_UPDATE(INVENTORYFEEDRUN, EDIT);
22INVENTORYPOSITION_UPDATE(INVENTORYPOSITION, EDIT),
23INVENTORYQUANTITY_UPDATE(INVENTORYQUANTITY, EDIT),
24INVOICE_UPDATE(INVOICE, EDIT),
25LOCATION_UPDATE(LOCATION, EDIT),
26MANIFEST_UPDATE(MANIFEST, EDIT),
27NETWORK_UPDATE(NETWORK, EDIT),
28OPENINGSCHEDULE_UPDATE(OPENINGSCHEDULE, EDIT),
29ORDER_UPDATE(ORDER, EDIT),
30ORDERITEM_UPDATE(ORDERITEM, EDIT),
31PAYMENT_UPDATE(PAYMENT, EDIT),
32PAYMENTSERVICEPROVIDER_UPDATE(PAYMENTSERVICEPROVIDER, EDIT),
33PRODUCTCATALOGUE_UPDATE(PRODUCTCATALOGUE, EDIT),
34RETAILER_UPDATE(RETAILER, EDIT),
35RETURNORDER_UPDATE(RETURNORDER, EDIT),
36ROLE_UPDATE(ROLE, EDIT),
37ROLEPERMISSION_UPDATE(ROLEPERMISSION, EDIT),
38SETTING_UPDATE(SETTING, EDIT),
39STANDARDPRODUCT_UPDATE(STANDARDPRODUCT, EDIT),
40STORAGEAREA_UPDATE(STORAGEAREA, EDIT),
41STOREADDRESS_UPDATE(STOREADDRESS, EDIT),
42USER_UPDATE(USER, EDIT),
43USERROLE_UPDATE(USERROLE, EDIT),
44VARIANTPRODUCT_UPDATE(VARIANTPRODUCT, EDIT),
45VIRTUALCATALOGUE_UPDATE(VIRTUALCATALOGUE, EDIT),
46VIRTUALPOSITION_UPDATE(VIRTUALPOSITION, EDIT),
47WAVE_UPDATE(WAVE, EDIT),
48WORKFLOW_UPDATE(WORKFLOW, EDIT).

1CATEGORYGROUPPRODUCT_REMOVE(CATEGORYGROUPPRODUCT, REMOVE),
2CATEGORYSTANDARDPRODUCT_REMOVE(CATEGORYSTANDARDPRODUCT, REMOVE),
3CATEGORYVARIANTPRODUCT_REMOVE(CATEGORYVARIANTPRODUCT, REMOVE),
4DECISIONRULE_REMOVE(DECISIONRULE, REMOVE),
5LOCATIONNETWORK_REMOVE(LOCATIONNETWORK, REMOVE),
6NETWORKLOCATION_REMOVE(NETWORKLOCATION, REMOVE),
7PERMISSIONROLE_REMOVE(PERMISSIONROLE, REMOVE),
8ROLEUSER_REMOVE(ROLEUSER, REMOVE).

Nested Mutations

All nested mutation operations require their own permissions based on the entity being mutated.

Example:

1input UpdateLocationInput {
2    # ID of the object
3    id: ID!
4    type: String
5    status: String
6    attributes: [AttributeInput]
7    name: String
8    supportPhoneNumber: String
9    defaultCarrier: String
10    primaryAddress: UpdateStoreAddressInput
11    retailer: RetailerId
12    openingSchedule: UpdateOpeningScheduleInput
13    networks: [NetworkId]
14    storageAreas: [UpdateStorageAreaWithLocationInput]
15}

The `updateLocation` mutation example above, supports updates for operations such as storage areas, store addresses and opening schedules. Each of these nested input types will require its own respective permission.

Partial Mutations

Partial mutations are not allowed. In the event that a mutation operation (whether it be a top or nested mutation) fails due to an incorrect or missing permission, the remaining operations will also fail and return an error.

Example:

Attempting to update the Opening Schedule using the `updateLocation` mutation will require two permissions: `LOCATION_UPDATE` and `OPENINGSCHEDULE_UPDATE`.

If the user did not have the second permission, the user will not be able to update the opening schedule. As partial mutations not allowed, this will cause the entire mutation to fail.

Example of a permission related error

`Error code: C0020E`
Error message: Your request failed due to insufficient permissions. You will need OPENINGSCHEDULE_UPDATE for executing this request.
Please contact your support to get the required permissions and try again.

Plugin Permissions

Access to plugins management process is configurable with Plugin Permissions.

1PLUGIN_VIEW(PLUGIN, VIEW),
2PLUGIN_UPLOAD(PLUGIN, UPLOAD),
3PLUGIN_INSTALL(PLUGIN, INSTALL).

Error Handling

Error Code: C0020E

Description: Indicates an invalid user permission for the attempted operation.

Possible reason: The user that has requested to perform an operation does not have the accurate permission level.

Please, contact the support team to acquire the necessary permission.

Warning

Parameter limitations:

Values of first and last must be within 1 - 5,000. If the value exceeds 5000, it is replaced by 5000.

GraphQL Permissions

Overview

Key points

Query Permissions

Examples:

Mutation Permissions

Examples:

Nested Mutations

Example:

Partial Mutations

Example:

Plugin Permissions

Error Handling

Error Code: C0020E

Related content

Exploring Roles & Permissions via the UI

Fluent Commerce

Building Blocks

By Type

Helpful Resources

Quick Links