> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Access scopes

> Scopes that API tokens carry and the fields they gate

Every API token carries a set of **scopes**. A field is denied unless your
token holds every scope listed on it. A nested field's scope adds to its
parent's, so a request needs the **union** of the scopes along each
selection path it touches. Scopes marked **Used in v3** gate fields in this
API version; the rest belong to other parts of the Redo platform.

<a id="scope-campaigns_analytics_read" />

### `campaigns_analytics_read`

**Resource:** Campaigns analytics · **Access:** read · **Used in v3:** Yes

Read access to campaigns analytics.

<a id="scope-campaigns_read" />

### `campaigns_read`

**Resource:** Campaigns · **Access:** read · **Used in v3:** Yes

Read access to campaigns.

<a id="scope-campaigns_write" />

### `campaigns_write`

**Resource:** Campaigns · **Access:** write · **Used in v3:** Yes

Write access to campaigns.

<a id="scope-checkout_read" />

### `checkout_read`

**Resource:** Checkout · **Access:** read · **Used in v3:** No

Read access to checkout.

<a id="scope-checkout_write" />

### `checkout_write`

**Resource:** Checkout · **Access:** write · **Used in v3:** No

Write access to checkout.

<a id="scope-commerce_agent_knowledge_read" />

### `commerce_agent_knowledge_read`

**Resource:** Commerce agent knowledge · **Access:** read · **Used in v3:** Yes

Read access to commerce agent knowledge.

<a id="scope-commerce_agent_knowledge_write" />

### `commerce_agent_knowledge_write`

**Resource:** Commerce agent knowledge · **Access:** write · **Used in v3:** Yes

Write access to commerce agent knowledge.

<a id="scope-consolidations_read" />

### `consolidations_read`

**Resource:** Consolidations · **Access:** read · **Used in v3:** Yes

Read access to consolidations.

<a id="scope-customer_events_write" />

### `customer_events_write`

**Resource:** Customer events · **Access:** write · **Used in v3:** Yes

Write access to customer events.

<a id="scope-customers_read" />

### `customers_read`

**Resource:** Customers · **Access:** read · **Used in v3:** Yes

Read access to customers.

<a id="scope-customers_write" />

### `customers_write`

**Resource:** Customers · **Access:** write · **Used in v3:** Yes

Write access to customers.

<a id="scope-inbound_shipments_read" />

### `inbound_shipments_read`

**Resource:** Inbound shipments · **Access:** read · **Used in v3:** No

Read access to inbound shipments.

<a id="scope-inventory_read" />

### `inventory_read`

**Resource:** Inventory · **Access:** read · **Used in v3:** Yes

Read access to inventory.

<a id="scope-inventory_write" />

### `inventory_write`

**Resource:** Inventory · **Access:** write · **Used in v3:** Yes

Write access to inventory.

<a id="scope-invoices_read" />

### `invoices_read`

**Resource:** Invoices · **Access:** read · **Used in v3:** No

Read access to invoices.

<a id="scope-locations_read" />

### `locations_read`

**Resource:** Locations · **Access:** read · **Used in v3:** Yes

Read access to locations.

<a id="scope-locations_write" />

### `locations_write`

**Resource:** Locations · **Access:** write · **Used in v3:** No

Write access to locations.

<a id="scope-marketing_automations_analytics_read" />

### `marketing_automations_analytics_read`

**Resource:** Marketing automations analytics · **Access:** read · **Used in v3:** Yes

Read access to marketing automations analytics.

<a id="scope-marketing_automations_read" />

### `marketing_automations_read`

**Resource:** Marketing automations · **Access:** read · **Used in v3:** Yes

Read access to marketing automations.

<a id="scope-marketing_automations_write" />

### `marketing_automations_write`

**Resource:** Marketing automations · **Access:** write · **Used in v3:** Yes

Write access to marketing automations.

<a id="scope-marketing_templates_read" />

### `marketing_templates_read`

**Resource:** Marketing templates · **Access:** read · **Used in v3:** Yes

Read access to marketing templates.

<a id="scope-marketing_templates_write" />

### `marketing_templates_write`

**Resource:** Marketing templates · **Access:** write · **Used in v3:** Yes

Write access to marketing templates.

<a id="scope-orders_read" />

### `orders_read`

**Resource:** Orders · **Access:** read · **Used in v3:** No

Read access to orders.

<a id="scope-orders_write" />

### `orders_write`

**Resource:** Orders · **Access:** write · **Used in v3:** No

Write access to orders.

<a id="scope-pick_sessions_read" />

### `pick_sessions_read`

**Resource:** Pick sessions · **Access:** read · **Used in v3:** Yes

Read access to pick sessions.

<a id="scope-products_read" />

### `products_read`

**Resource:** Products · **Access:** read · **Used in v3:** Yes

Read access to products.

<a id="scope-products_write" />

### `products_write`

**Resource:** Products · **Access:** write · **Used in v3:** Yes

Write access to products.

<a id="scope-returns_read" />

### `returns_read`

**Resource:** Returns · **Access:** read · **Used in v3:** No

Read access to returns.

<a id="scope-returns_write" />

### `returns_write`

**Resource:** Returns · **Access:** write · **Used in v3:** No

Write access to returns.

<a id="scope-segments_read" />

### `segments_read`

**Resource:** Segments · **Access:** read · **Used in v3:** Yes

Read access to segments.

<a id="scope-segments_write" />

### `segments_write`

**Resource:** Segments · **Access:** write · **Used in v3:** Yes

Write access to segments.

<a id="scope-shipping_read" />

### `shipping_read`

**Resource:** Shipping · **Access:** read · **Used in v3:** Yes

Read access to shipping.

<a id="scope-shipping_write" />

### `shipping_write`

**Resource:** Shipping · **Access:** write · **Used in v3:** Yes

Write access to shipping.

<a id="scope-storefront_events_write" />

### `storefront_events_write`

**Resource:** Storefront events · **Access:** write · **Used in v3:** No

Write access to storefront events.

<a id="scope-webhooks_read" />

### `webhooks_read`

**Resource:** Webhooks · **Access:** read · **Used in v3:** Yes

Read access to webhooks.

<a id="scope-webhooks_write" />

### `webhooks_write`

**Resource:** Webhooks · **Access:** write · **Used in v3:** Yes

Write access to webhooks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.