> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # Create a redirect > Sends an address that has nothing at it to one that has. It is followed only once the first address has turned out to be nothing, so a redirect can never take a page away. Adding one for a broken link takes that link off the list. Answers the store's redirects as they now stand. Needs the `seo.write` permission (Change Search Settings). ## OpenAPI ````yaml /api-reference/openapi.json post /stores/{storeId}/redirects openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Blacklist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}/redirects: post: tags: - Redirects summary: Create a redirect description: >- Sends an address that has nothing at it to one that has. It is followed only once the first address has turned out to be nothing, so a redirect can never take a page away. Adding one for a broken link takes that link off the list. Answers the store's redirects as they now stand. Needs the `seo.write` permission (Change Search Settings). operationId: redirects.create parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object properties: from: type: string description: >- The address that has nothing at it, as a path on the store (`/old-page`). A whole address of the store is cut down to its path. example: /product/?name=old-name to: type: string description: >- Where it leads, as a path on the store. A redirect never leaves the store, and never leads to an address that is itself redirected. example: /product/?name=new-name required: - from - to responses: '200': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: array items: type: object properties: id: type: string from: type: string to: type: string hits: type: integer createdAt: type: string live: type: boolean meta: type: object properties: home: type: string limit: type: integer missing: type: - array - object example: success: true message: null code: null data: - id: e6ad70ab-fff5-4a8e-a480-a64ea9942790 from: /old-pricing to: /products/ hits: 0 createdAt: '2026-10-22T16:20:18Z' live: false meta: home: https://northwind.myshoply.gg limit: 500 missing: [] '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/Refused' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const result = await shoply.redirects.create({ from: "/product/?name=old-name", to: "/product/?name=new-name", }); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->redirects->create([ 'from' => '/product/?name=old-name', 'to' => '/product/?name=new-name', ]); - lang: python label: Python source: > import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.redirects.create(from_="/product/?name=old-name", to="/product/?name=new-name") components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: >- A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with `Idempotent-Replay: true`. schema: type: string responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' Refused: description: >- The request was understood and not carried out. `validation_failed` says what is wrong with each field under `errors`; other codes are the route's own. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' schemas: Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.