# App API routes

> Every route under /oauth and /api/v1: its HTTP method, required scope and pagination support.

This page is generated from the source code: every route served under `/oauth` and `/api/v1` is listed below. For request fields, response payloads and error codes, see the [App API](../apps/api.md) page. Paginated routes accept `limit` and `page_info` ([Pagination](../apps/api.md#pagination)).

| Method | Path | Scope needed | Paginated |
| :--- | :--- | :--- | :--- |
| GET | `/api/v1/billing/credits` | None |  |
| POST | `/api/v1/billing/credits` | None |  |
| GET | `/api/v1/billing/plans` | None |  |
| GET | `/api/v1/billing/subscriptions` | None |  |
| POST | `/api/v1/billing/subscriptions` | None |  |
| GET | `/api/v1/billing/subscriptions/{id}` | None |  |
| POST | `/api/v1/billing/subscriptions/{id}/cancel` | None |  |
| POST | `/api/v1/billing/subscriptions/{id}/usage_records` | None |  |
| POST | `/api/v1/channels` | `write_channels` |  |
| POST | `/api/v1/channels/{id}/orders` | `write_channels` |  |
| GET | `/api/v1/channels/{id}/products` | `write_channels` | Yes |
| DELETE | `/api/v1/channels/{id}/products/{productID}` | `write_channels` |  |
| PUT | `/api/v1/channels/{id}/products/{productID}` | `write_channels` |  |
| GET | `/api/v1/collections` | `read_products` | Yes |
| GET | `/api/v1/collections/{id}` | `read_products` |  |
| GET | `/api/v1/companies` | `read_companies` | Yes |
| POST | `/api/v1/companies` | `write_companies` |  |
| DELETE | `/api/v1/companies/{id}` | `write_companies` |  |
| GET | `/api/v1/companies/{id}` | `read_companies` |  |
| PUT | `/api/v1/companies/{id}` | `write_companies` |  |
| POST | `/api/v1/companies/{id}/contacts` | `write_companies` |  |
| DELETE | `/api/v1/companies/{id}/contacts/{customerID}` | `write_companies` |  |
| PUT | `/api/v1/companies/{id}/contacts/{customerID}` | `write_companies` |  |
| POST | `/api/v1/companies/{id}/locations` | `write_companies` |  |
| DELETE | `/api/v1/companies/{id}/locations/{locationID}` | `write_companies` |  |
| PUT | `/api/v1/companies/{id}/locations/{locationID}` | `write_companies` |  |
| GET | `/api/v1/customer_segments` | `read_customers` | Yes |
| GET | `/api/v1/customer_segments/{id}` | `read_customers` |  |
| GET | `/api/v1/customer_segments/{id}/customers` | `read_customers` | Yes |
| GET | `/api/v1/customers` | `read_customers` | Yes |
| GET | `/api/v1/customers/{id}` | `read_customers` |  |
| PUT | `/api/v1/customers/{id}` | `write_customers` |  |
| POST | `/api/v1/customers/{id}/marketing_consent` | `write_marketing_consent` |  |
| GET | `/api/v1/discount_codes` | `write_discounts` | Yes |
| POST | `/api/v1/discount_codes` | `write_discounts` |  |
| DELETE | `/api/v1/discount_codes/{id}` | `write_discounts` |  |
| GET | `/api/v1/discount_codes/{id}` | `write_discounts` |  |
| PUT | `/api/v1/discount_codes/{id}` | `write_discounts` |  |
| GET | `/api/v1/draft_orders` | `read_draft_orders` | Yes |
| POST | `/api/v1/draft_orders` | `write_draft_orders` |  |
| DELETE | `/api/v1/draft_orders/{id}` | `write_draft_orders` |  |
| GET | `/api/v1/draft_orders/{id}` | `read_draft_orders` |  |
| PUT | `/api/v1/draft_orders/{id}` | `write_draft_orders` |  |
| POST | `/api/v1/draft_orders/{id}/complete` | `write_draft_orders` |  |
| POST | `/api/v1/draft_orders/{id}/send_invoice` | `write_draft_orders` |  |
| POST | `/api/v1/emails` | `write_emails` |  |
| GET | `/api/v1/function_runs` | Checked per endpoint |  |
| GET | `/api/v1/gift_cards` | `read_gift_cards` | Yes |
| POST | `/api/v1/gift_cards` | `write_gift_cards` |  |
| GET | `/api/v1/gift_cards/{id}` | `read_gift_cards` |  |
| PUT | `/api/v1/gift_cards/{id}` | `write_gift_cards` |  |
| POST | `/api/v1/gift_cards/{id}/disable` | `write_gift_cards` |  |
| GET | `/api/v1/inventory_levels` | `read_inventory` | Yes |
| PUT | `/api/v1/inventory_levels` | `write_inventory` |  |
| POST | `/api/v1/inventory_levels/adjust` | `write_inventory` |  |
| GET | `/api/v1/inventory_levels/history` | `read_inventory` | Yes |
| POST | `/api/v1/inventory_levels/move` | `write_inventory` |  |
| GET | `/api/v1/locations` | `read_locations` | Yes |
| GET | `/api/v1/marketing/audience` | `read_marketing_audience` | Yes |
| DELETE | `/api/v1/metafields` | Checked per endpoint |  |
| GET | `/api/v1/metafields` | Checked per endpoint | Yes |
| PUT | `/api/v1/metafields` | Checked per endpoint |  |
| GET | `/api/v1/metaobject_definitions` | `read_metaobjects` |  |
| POST | `/api/v1/metaobject_definitions` | `write_metaobjects` |  |
| DELETE | `/api/v1/metaobject_definitions/{id}` | `write_metaobjects` |  |
| GET | `/api/v1/metaobject_definitions/{id}` | `read_metaobjects` |  |
| PUT | `/api/v1/metaobject_definitions/{id}` | `write_metaobjects` |  |
| GET | `/api/v1/metaobjects` | `read_metaobjects` | Yes |
| POST | `/api/v1/metaobjects` | `write_metaobjects` |  |
| DELETE | `/api/v1/metaobjects/{id}` | `write_metaobjects` |  |
| GET | `/api/v1/metaobjects/{id}` | `read_metaobjects` |  |
| PUT | `/api/v1/metaobjects/{id}` | `write_metaobjects` |  |
| GET | `/api/v1/orders` | `read_orders` | Yes |
| GET | `/api/v1/orders/{id}` | `read_orders` |  |
| PUT | `/api/v1/orders/{id}` | `write_orders` |  |
| POST | `/api/v1/orders/{id}/cancel` | `write_orders` |  |
| POST | `/api/v1/orders/{id}/capture` | `write_payments` |  |
| POST | `/api/v1/orders/{id}/fulfillments` | `write_fulfillments` |  |
| PUT | `/api/v1/orders/{id}/fulfillments/{fulfillmentID}` | `write_fulfillments` |  |
| POST | `/api/v1/orders/{id}/fulfillments/{fulfillmentID}/cancel` | `write_fulfillments` |  |
| POST | `/api/v1/orders/{id}/fulfillments/{fulfillmentID}/events` | `write_fulfillments` |  |
| GET | `/api/v1/orders/{id}/refunds` | `read_orders` |  |
| POST | `/api/v1/orders/{id}/refunds` | `write_orders` |  |
| POST | `/api/v1/payments-app/configure` | Checked per endpoint |  |
| GET | `/api/v1/pixels/{pixelID}/settings` | `write_pixels` |  |
| PUT | `/api/v1/pixels/{pixelID}/settings` | `write_pixels` |  |
| GET | `/api/v1/products` | `read_products` | Yes |
| POST | `/api/v1/products` | `write_products` |  |
| GET | `/api/v1/products/{id}` | `read_products` |  |
| PUT | `/api/v1/products/{id}` | `write_products` |  |
| GET | `/api/v1/products/{id}/variants` | `read_products` | Yes |
| GET | `/api/v1/shop` | None |  |
| POST | `/api/v1/sms` | `write_sms` |  |
| POST | `/api/v1/sms/{id}/status` | `write_sms` |  |
| GET | `/api/v1/translations` | `read_translations` |  |
| PUT | `/api/v1/translations` | `write_translations` |  |
| PUT | `/api/v1/variants/{id}/cost` | `write_products` |  |
| PUT | `/api/v1/variants/{id}/inventory` | `write_inventory` |  |
| GET | `/api/v1/webhook_deliveries` | Checked per endpoint |  |
| POST | `/api/v1/webhook_deliveries/{id}/replay` | Checked per endpoint |  |
| POST | `/api/v1/{kind}/{id}/{action}` | Checked per endpoint |  |
| POST | `/oauth/access_token` | Checked per endpoint |  |
| GET | `/oauth/authorize` | Checked per endpoint |  |

**Scope needed:** Every write scope implies the corresponding read scope for that resource. "None" means any valid installation access token is accepted. "Checked per endpoint" means the route does not require a static scope and validates the caller inside the handler itself (OAuth endpoints, metafields, webhook delivery and function run logs, and payment app session endpoints).
