Access scopes

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.

​

campaigns_analytics_read

Resource: Campaigns analytics · Access: read · Used in v3: Yes Read access to campaigns analytics.

​

campaigns_read

Resource: Campaigns · Access: read · Used in v3: Yes Read access to campaigns.

​

campaigns_write

Resource: Campaigns · Access: write · Used in v3: Yes Write access to campaigns.

​

checkout_read

Resource: Checkout · Access: read · Used in v3: No Read access to checkout.

​

checkout_write

Resource: Checkout · Access: write · Used in v3: No Write access to checkout.

​

commerce_agent_knowledge_read

Resource: Commerce agent knowledge · Access: read · Used in v3: Yes Read access to commerce agent knowledge.

​

commerce_agent_knowledge_write

Resource: Commerce agent knowledge · Access: write · Used in v3: Yes Write access to commerce agent knowledge.

​

consolidations_read

Resource: Consolidations · Access: read · Used in v3: Yes Read access to consolidations.

​

customer_events_write

Resource: Customer events · Access: write · Used in v3: Yes Write access to customer events.

​

customers_read

Resource: Customers · Access: read · Used in v3: Yes Read access to customers.

​

customers_write

Resource: Customers · Access: write · Used in v3: Yes Write access to customers.

​

inbound_shipments_read

Resource: Inbound shipments · Access: read · Used in v3: No Read access to inbound shipments.

​

inventory_read

Resource: Inventory · Access: read · Used in v3: Yes Read access to inventory.

​

inventory_write

Resource: Inventory · Access: write · Used in v3: Yes Write access to inventory.

​

invoices_read

Resource: Invoices · Access: read · Used in v3: No Read access to invoices.

​

locations_read

Resource: Locations · Access: read · Used in v3: Yes Read access to locations.

​

locations_write

Resource: Locations · Access: write · Used in v3: No Write access to locations.

​

marketing_automations_analytics_read

Resource: Marketing automations analytics · Access: read · Used in v3: Yes Read access to marketing automations analytics.

​

marketing_automations_read

Resource: Marketing automations · Access: read · Used in v3: Yes Read access to marketing automations.

​

marketing_automations_write

Resource: Marketing automations · Access: write · Used in v3: Yes Write access to marketing automations.

​

marketing_templates_read

Resource: Marketing templates · Access: read · Used in v3: Yes Read access to marketing templates.

​

marketing_templates_write

Resource: Marketing templates · Access: write · Used in v3: Yes Write access to marketing templates.

​

orders_read

Resource: Orders · Access: read · Used in v3: No Read access to orders.

​

orders_write

Resource: Orders · Access: write · Used in v3: No Write access to orders.

​

pick_sessions_read

Resource: Pick sessions · Access: read · Used in v3: Yes Read access to pick sessions.

​

products_read

Resource: Products · Access: read · Used in v3: Yes Read access to products.

​

products_write

Resource: Products · Access: write · Used in v3: Yes Write access to products.

​

returns_read

Resource: Returns · Access: read · Used in v3: No Read access to returns.

​

returns_write

Resource: Returns · Access: write · Used in v3: No Write access to returns.

​

segments_read

Resource: Segments · Access: read · Used in v3: Yes Read access to segments.

​

segments_write

Resource: Segments · Access: write · Used in v3: Yes Write access to segments.

​

shipping_read

Resource: Shipping · Access: read · Used in v3: Yes Read access to shipping.

​

shipping_write

Resource: Shipping · Access: write · Used in v3: Yes Write access to shipping.

​

storefront_events_write

Resource: Storefront events · Access: write · Used in v3: No Write access to storefront events.

​

webhooks_read

Resource: Webhooks · Access: read · Used in v3: Yes Read access to webhooks.

​

webhooks_write

Resource: Webhooks · Access: write · Used in v3: Yes Write access to webhooks.