# Shopify — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Retrieve comprehensive Shopify admin schema documentation to explore all available types, fields, arguments, and relationships across Access, Analytics, Apps, B2B, Billing, and other categories. Query specific type details or batch multiple types at once to understand how to build custom integrations with Shopify's admin platform.

**Category:** Developer Tools | **Website:** [shopify.dev/docs/api/admin-graphql/2026-01](https://shopify.dev/docs/api/admin-graphql/2026-01) | **Docs:** [parse.bot/marketplace/d388a619-ff87-4690-89e0-a9b3054a0668/shopify-dev-api](https://parse.bot/marketplace/d388a619-ff87-4690-89e0-a9b3054a0668/shopify-dev-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/shopify/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get api navigation

Get the full navigation tree of the Shopify GraphQL Admin API. Returns all categories, type groups, and individual types with their names and URL paths. Supports filtering by category and/or type kind. When type_kind is specified, returns a flat list of matching types with a total count. When no type_kind filter is applied, returns the full tree with category names and type counts per kind. Not all type kinds exist in every category (e.g. unions are only in the 'GraphQL Types' category).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | No | Filter by category name (e.g., 'Access', 'Orders', 'Products and collections'). Omitting returns all categories. |
| `type_kind` | string | No | Filter by type kind: mutations, objects, queries, connections, enums, input-objects, interfaces, payloads, scalars, unions. Omitting returns all type kinds. |
| `version` | string | No | API version (e.g., '2026-01', '2025-10') |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/shopify/get-api-navigation \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>","type_kind":"<string>","version":"<string>"}'
```

### Get type detail

Get detailed information about a specific GraphQL type including description, fields, arguments, enum values, return types, related queries/mutations, possible types (for unions/interfaces), and code examples. Returns the full schema definition for a single named type within its kind.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `type_kind` | string | Yes | Type kind: mutations, objects, queries, connections, enums, input-objects, interfaces, payloads, scalars, unions |
| `type_name` | string | Yes | Name of the type (e.g., 'AccessScope', 'appRevokeAccessScopes', 'AbandonedCheckoutSortKeys', 'Order') |
| `version` | string | No | API version (e.g., '2026-01', '2025-10') |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/shopify/get-type-detail \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"type_kind":"<string>","type_name":"<string>","version":"<string>"}'
```

### Get types batch

Get detailed information for multiple types in a batch. Fetches all types of a given kind (optionally filtered by category) with offset-based pagination, returning full details including fields, arguments, enum values, etc. Each type in the batch includes its name, kind, category, description, and type-specific details.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | No | Filter by category name (e.g., 'Access', 'Orders'). Omitting returns types from all categories. |
| `limit` | integer | No | Maximum number of types to return per batch |
| `offset` | integer | No | Starting offset for pagination |
| `type_kind` | string | Yes | Type kind: mutations, objects, queries, connections, enums, input-objects, interfaces, payloads, scalars, unions |
| `version` | string | No | API version (e.g., '2026-01', '2025-10') |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/shopify/get-types-batch \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>","limit":"<integer>","offset":"<integer>","type_kind":"<string>","version":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.