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

# Save a file

> Saves a file the draft has. Send `was`, the `hash` it had when you read it, and the save is refused with `file_conflict` if it has changed since (in the code studio, say), with the file as it now stands in `file`: left out, it is saved whatever happened in between. Saved to the draft only: buyers see it once it is published. Answers the file as it now stands (`file`) and the whole list again (`code`), with what is now wrong in the templates. What is written counts toward the store's hour of saves, as the code studio's does.

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



## OpenAPI

````yaml /api-reference/openapi.json put /stores/{storeId}/storefronts/{storefrontId}/code/file
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/file:
    put:
      tags:
        - Storefront code
      summary: Save a file
      description: >-
        Saves a file the draft has. Send `was`, the `hash` it had when you read
        it, and the save is refused with `file_conflict` if it has changed since
        (in the code studio, say), with the file as it now stands in `file`:
        left out, it is saved whatever happened in between. Saved to the draft
        only: buyers see it once it is published. Answers the file as it now
        stands (`file`) and the whole list again (`code`), with what is now
        wrong in the templates. What is written counts toward the store's hour
        of saves, as the code studio's does.


        Needs the `storefronts.write` permission (Change Storefronts).
      operationId: storefronts.codeSave
      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'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                path:
                  type: string
                  description: >-
                    The file's path, its folder and its name:
                    `pages/index.liquid`, `assets/theme.css`.
                  example: pages/index.liquid
                content:
                  type: string
                  description: The file's whole text.
                was:
                  type: string
                  description: The SHA-256 the file had when you read it.
              required:
                - path
                - content
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: object
                    properties:
                      file:
                        type: object
                        properties:
                          path:
                            type: string
                          hash:
                            type: string
                          size:
                            type: integer
                          added:
                            type: boolean
                          changed:
                            type: boolean
                          updatedAt:
                            type: string
                          content:
                            type: string
                      rev:
                        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
              example:
                success: true
                message: null
                code: null
                data:
                  file:
                    path: assets/theme.css
                    hash: >-
                      28159614c556580924ad89d6f391cf7584e095c9955d29452fd67c671ebb136b
                    size: 177668
                    added: false
                    changed: true
                    updatedAt: '2026-10-22T16:20:20Z'
                    content: >-
                      /*! tailwindcss v4.3.3 | MIT License |
                      https://tailwindcss.com */

                      @layer properties;

                      :root, :host {
                        --fa-font-solid: normal 900 1em/1 'Font Awesome 7 Free';
                        --fa-font-regular: normal 400 1em/1 'Font Awesome 7 Free';
                        --fa-font-light: normal 300 1em/1 'Font Awesome 7 Pro';
                        --fa-font-thin: normal 100 1em/1 'Font Awesome 7 Pro';
                        --fa-font-duotone: normal 900 1em/1 'Font Awesome 7 Duotone';
                       …
                  rev: 2
                  code:
                    rev: 2
                    ahead: 107
                    designAhead: true
                    base: 2.6.0
                    files:
                      - path: assets/theme.css
                        hash: >-
                          28159614c556580924ad89d6f391cf7584e095c9955d29452fd67c671ebb136b
                        size: 177668
                        added: false
                        changed: true
                        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: 855369
                    folders:
                      layout:
                        - liquid
                      pages:
                        - liquid
                      elements:
                        - liquid
                      parts:
                        - liquid
                      assets:
                        - css
                        - js
                      locales:
                        - json
                      config:
                        - json
        '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.codeSave("STOREFRONT_ID", {
              path: "pages/index.liquid",
              content: "...",
            });
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

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

            $result = $shoply->storefronts->codeSave('STOREFRONT_ID', [
                'path' => 'pages/index.liquid',
                'content' => '...',
            ]);
        - lang: python
          label: Python
          source: >
            import shoply


            client = shoply.Client()  # reads SHOPLY_API_KEY


            result = client.storefronts.codeSave("STOREFRONT_ID",
            path="pages/index.liquid", content="...")
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.