> ## 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.

# Give a storefront files

> Gives a storefront files of its own, copied from its theme's, as opening the code studio does. Until then it is drawn from its theme's files and follows them as they change. Nothing buyers see changes. Refused with `code_needs_copy` for a storefront from before its theme could be edited as code: make a copy of it ("Create a storefront" with `from`) and work on that. Answers as "Get a storefront's code".

Needs the `storefronts.write` permission (Change Storefronts).



## OpenAPI

````yaml /api-reference/openapi.json post /stores/{storeId}/storefronts/{storefrontId}/code/start
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}/storefronts/{storefrontId}/code/start:
    post:
      tags:
        - Storefront code
      summary: Give a storefront files
      description: >-
        Gives a storefront files of its own, copied from its theme's, as opening
        the code studio does. Until then it is drawn from its theme's files and
        follows them as they change. Nothing buyers see changes. Refused with
        `code_needs_copy` for a storefront from before its theme could be edited
        as code: make a copy of it ("Create a storefront" with `from`) and work
        on that. Answers as "Get a storefront's code".


        Needs the `storefronts.write` permission (Change Storefronts).
      operationId: storefronts.codeStart
      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
        - name: storefrontId
          in: path
          required: true
          description: The storefront.
          schema:
            type: string
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '201':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: object
                    properties:
                      storefront:
                        type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                          theme:
                            type: string
                          themeVersion:
                            type: string
                          published:
                            type: boolean
                          publishedAt:
                            nullable: true
                          live:
                            type: boolean
                          createdAt:
                            type: string
                          updatedAt:
                            type: string
                          code:
                            type: boolean
                          engine:
                            type: string
                          codeOnCopy:
                            nullable: true
                          unpublished:
                            type: boolean
                          accent:
                            nullable: true
                          headingFont:
                            nullable: true
                          pages:
                            type: integer
                      theme:
                        type: string
                      available:
                        type: boolean
                      started:
                        type: boolean
                      version:
                        type: integer
                      code:
                        type: object
                        properties:
                          rev:
                            type: integer
                          ahead:
                            type: integer
                          designAhead:
                            type: boolean
                          base:
                            type: string
                          files:
                            type: array
                            items:
                              type: object
                              properties:
                                path:
                                  type: string
                                hash:
                                  type: string
                                size:
                                  type: integer
                                added:
                                  type: boolean
                                changed:
                                  type: boolean
                                updatedAt:
                                  type: string
                          problems:
                            type:
                              - array
                              - object
                          limits:
                            type: object
                            properties:
                              files:
                                type: integer
                              fileBytes:
                                type: integer
                              bytes:
                                type: integer
                              used:
                                type: integer
                          folders:
                            type: object
                            properties:
                              layout:
                                type: array
                                items:
                                  type: string
                              pages:
                                type: array
                                items:
                                  type: string
                              elements:
                                type: array
                                items:
                                  type: string
                              parts:
                                type: array
                                items:
                                  type: string
                              assets:
                                type: array
                                items:
                                  type: string
                              locales:
                                type: array
                                items:
                                  type: string
                              config:
                                type: array
                                items:
                                  type: string
                      versions:
                        type:
                          - array
                          - object
                      preview:
                        type: object
                        properties:
                          url:
                            type: string
                          param:
                            type: string
                          token:
                            type: string
                          seconds:
                            type: integer
                          pages:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                path:
                                  type: string
              example:
                success: true
                message: null
                code: null
                data:
                  storefront:
                    id: 93618f34-cfad-44d8-a677-253b7238f272
                    name: Autumn look, second go
                    theme: keystone
                    themeVersion: 2.6.0
                    published: false
                    publishedAt: null
                    live: false
                    createdAt: '2026-10-22T16:20:20Z'
                    updatedAt: '2026-10-22T16:20:20Z'
                    code: true
                    engine: files
                    codeOnCopy: null
                    unpublished: false
                    accent: null
                    headingFont: null
                    pages: 6
                  theme: keystone
                  available: true
                  started: true
                  version: 1
                  code:
                    rev: 1
                    ahead: 107
                    designAhead: true
                    base: 2.6.0
                    files:
                      - path: assets/theme.css
                        hash: >-
                          5b682f97f28a435c9925b811f88717c9ef845de4df0517b9582dfe25383bcd9c
                        size: 177667
                        added: false
                        changed: false
                        updatedAt: '2026-10-22T16:20:20Z'
                      - path: assets/theme.js
                        hash: >-
                          ff1c708528bdf701288651d9e625dab13517f375460d1b206be9e8243345ccf0
                        size: 144234
                        added: false
                        changed: false
                        updatedAt: '2026-10-22T16:20:20Z'
                    problems: []
                    limits:
                      files: 150
                      fileBytes: 262144
                      bytes: 3145728
                      used: 855368
                    folders:
                      layout:
                        - liquid
                      pages:
                        - liquid
                      elements:
                        - liquid
                      parts:
                        - liquid
                      assets:
                        - css
                        - js
                      locales:
                        - json
                      config:
                        - json
                  versions: []
                  preview:
                    url: https://northwind.myshoply.gg
                    param: shoply_preview
                    token: >-
                      93618f34-cfad-44d8-a677-253b7238f272.1792689620.882d8ad47e28f67f6c4cafd72eadbed89290ea46
                    seconds: 3600
                    pages:
                      - name: Home
                        path: /
                      - name: All products
                        path: /products/
        '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.storefronts.codeStart("STOREFRONT_ID");
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $result = $shoply->storefronts->codeStart('STOREFRONT_ID');
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.storefronts.codeStart("STOREFRONT_ID")
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.