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

# Export a storefront

> A storefront to keep, work on or hand on: its design, and every file of its code when it has code of its own, as text. `storefront` in the answer is what "Import a storefront" takes.

Needs the `storefronts.read` permission (Read Storefronts). It is one of the heavier reads, and is counted against a smaller budget of its own: 60 a minute for each key.



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/storefronts/{storefrontId}/export
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}/export:
    get:
      tags:
        - Storefronts
      summary: Export a storefront
      description: >-
        A storefront to keep, work on or hand on: its design, and every file of
        its code when it has code of its own, as text. `storefront` in the
        answer is what "Import a storefront" takes.


        Needs the `storefronts.read` permission (Read Storefronts). It is one of
        the heavier reads, and is counted against a smaller budget of its own:
        60 a minute for each key.
      operationId: storefronts.export
      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
      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:
                      filename:
                        type: string
                      storefront:
                        type: object
                        properties:
                          kind:
                            type: string
                          format:
                            type: integer
                          exportedAt:
                            type: string
                          name:
                            type: string
                          theme:
                            type: string
                          design:
                            type: object
                            properties:
                              version:
                                type: integer
                              theme:
                                type: object
                                properties:
                                  accent:
                                    type: string
                                  accentText:
                                    type: string
                                  page:
                                    type: string
                                  cards:
                                    type: string
                                  text:
                                    type: string
                                  muted:
                                    type: string
                                  border:
                                    type: string
                                  tintArt:
                                    type: boolean
                                  headingFont:
                                    type: string
                                  bodyFont:
                                    type: string
                                  headingWeight:
                                    type: string
                                  radius:
                                    type: string
                                  buttonRadius:
                                    type: string
                                  pageWidth:
                                    type: integer
                                  motion:
                                    type: boolean
                                  customCss:
                                    type: string
                              announcement:
                                type: object
                                properties:
                                  enabled:
                                    type: boolean
                                  text:
                                    type: string
                                  icon:
                                    type: string
                                  link:
                                    type: string
                                  bg:
                                    type: string
                                  color:
                                    type: string
                                  dismissible:
                                    type: boolean
                              header:
                                type: object
                                properties:
                                  showLogo:
                                    type: boolean
                                  logo:
                                    type: string
                                  logoSize:
                                    type: integer
                                  showName:
                                    type: boolean
                                  categoriesMenu:
                                    type: boolean
                                  categoriesLabel:
                                    type: string
                                  nav:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        label: {}
                                        link: {}
                                        icon: {}
                                  featured:
                                    type: boolean
                                  showBlog:
                                    type: boolean
                                  showOnline:
                                    type: boolean
                                  showSearch:
                                    type: boolean
                                  showCart:
                                    type: boolean
                                  showAccount:
                                    type: boolean
                                  accountLabel:
                                    type: string
                              footer:
                                type: object
                                properties:
                                  showLogo:
                                    type: boolean
                                  showName:
                                    type: boolean
                                  tagline:
                                    type: string
                                  about:
                                    type: string
                                  columns:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        title: {}
                                        links: {}
                                  legalTitle:
                                    type: string
                                  policies:
                                    type: boolean
                                  privacy:
                                    type: string
                                  help:
                                    type: boolean
                                  helpTitle:
                                    type: string
                                  helpText:
                                    type: string
                                  helpLabel:
                                    type: string
                                  helpLink:
                                    type: string
                                  directory:
                                    type: boolean
                                  socials:
                                    type:
                                      - array
                                      - object
                                  copyright:
                                    type: string
                              cart:
                                type: object
                                properties:
                                  openOnAdd:
                                    type: boolean
                                  bar:
                                    type: boolean
                                  showImages:
                                    type: boolean
                                  title:
                                    type: string
                                  checkoutLabel:
                                    type: string
                                  note:
                                    type: string
                                  emptyText:
                                    type: string
                                  emptyLinkLabel:
                                    type: string
                                  emptyLink:
                                    type: string
                              pages:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                    kind:
                                      type: string
                                    name:
                                      type: string
                                    path:
                                      type: string
                                    title:
                                      type: string
                                    description:
                                      type: string
                                    hideHeader:
                                      type: boolean
                                    hideFooter:
                                      type: boolean
                                    sections:
                                      type: array
                                      items: {}
                          files:
                            nullable: true
              example:
                success: true
                message: null
                code: null
                data:
                  filename: autumn-look-second-go.zip
                  storefront:
                    kind: shoply-storefront
                    format: 1
                    exportedAt: '2026-10-22T16:20:20Z'
                    name: Autumn look, second go
                    theme: keystone
                    design:
                      version: 1
                      theme:
                        accent: ''
                        accentText: ''
                        page: ''
                        cards: ''
                        text: ''
                        muted: ''
                        border: ''
                        tintArt: true
                        headingFont: ''
                        bodyFont: ''
                        headingWeight: '700'
                        radius: lg
                        buttonRadius: inherit
                        pageWidth: 1280
                        motion: true
                        customCss: ''
                      announcement:
                        enabled: false
                        text: Free delivery on every order.
                        icon: megaphone
                        link: ''
                        bg: ''
                        color: ''
                        dismissible: true
                      header:
                        showLogo: true
                        logo: ''
                        logoSize: 30
                        showName: true
                        categoriesMenu: true
                        categoriesLabel: Categories
                        nav:
                          - label: Status
                            link: /status
                            icon: activity
                          - label: Reviews
                            link: /reviews
                            icon: star
                        featured: true
                        showBlog: true
                        showOnline: true
                        showSearch: true
                        showCart: true
                        showAccount: true
                        accountLabel: My orders
                      footer:
                        showLogo: true
                        showName: true
                        tagline: Digital products, delivered instantly
                        about: >-
                          Secure checkout, instant delivery and real people when
                          you need a hand.
                        columns:
                          - title: Store
                            links:
                              - label: All products
                                link: /products
                              - label: Status
                                link: /status
                        legalTitle: Legal
                        policies: true
                        privacy: ''
                        help: true
                        helpTitle: Need help?
                        helpText: >-
                          We're here to help. Get in touch and we'll answer as
                          soon as we can.
                        helpLabel: Contact support
                        helpLink: ''
                        directory: true
                        socials: []
                        copyright: ''
                      cart:
                        openOnAdd: false
                        bar: true
                        showImages: true
                        title: Your cart
                        checkoutLabel: Checkout
                        note: Secure checkout. Your order is delivered instantly.
                        emptyText: Your cart is empty
                        emptyLinkLabel: Browse products
                        emptyLink: /products
                      pages:
                        - id: home
                          kind: home
                          name: Home
                          path: /
                          title: ''
                          description: ''
                          hideHeader: false
                          hideFooter: false
                          sections:
                            - id: khero001
                              type: ks-hero
                              hidden: false
                              props:
                                name: ''
                                anchor: ''
                                width: full
                                align: left
                                mt: 0
                                mb: 0
                                pt: 0
                                pb: 0
                                gap: 16
                                minHeight: 0
                                valign: center
                                boxed: false
                                radius: inherit
                                border: true
                                shadow: false
                                bg: none
                                bgColor: '#12151c'
                                bgColor2: '#2563eb'
                                angle: 135
                                bgImage: ''
                                bgSize: cover
                                overlay: '#000000'
                                overlayOpacity: 40
                                effect: none
                                textColor: ''
                                hideDesktop: false
                                hideTablet: false
                                hideMobile: false
                              blocks:
                                - id: kherob01
                                  type: ks-hero
                                  hidden: false
                                  props:
                                    badge: true
                                    badgeText: Trusted by thousands of happy customers
                                    badgeIcon: star
                                    badgeLink: /reviews
                                    title: |-
                                      *Premium* digital products,
                                      delivered instantly
                                    subtitle: >-
                                      Instant delivery · Secure checkout · Real
                                      support
                                    search: true
                                    searchPlaceholder: Search for products...
                                    shortcuts:
                                      - icon: layout-grid
                                        label: Products
                                        link: /products
                                      - icon: activity
                                        label: Status
                                        link: /status
                                    image: ''
                                    tint: false
                                    strength: 40
                                    fullScreen: true
                                    scrollHint: true
                                    specks: true
                                    mt: 0
                                    mb: 0
                                    hideDesktop: false
                                    hideTablet: false
                                    hideMobile: false
                            - id: kcats001
                              type: categories
                              hidden: false
                              props:
                                name: ''
                                anchor: ''
                                width: default
                                align: center
                                mt: 0
                                mb: 0
                                pt: 48
                                pb: 48
                                gap: 32
                                minHeight: 0
                                valign: center
                                boxed: false
                                radius: inherit
                                border: true
                                shadow: false
                                bg: none
                                bgColor: '#12151c'
                                bgColor2: '#2563eb'
                                angle: 135
                                bgImage: ''
                                bgSize: cover
                                overlay: '#000000'
                                overlayOpacity: 40
                                effect: none
                                textColor: ''
                                hideDesktop: false
                                hideTablet: false
                                hideMobile: false
                              blocks:
                                - id: kcatsh01
                                  type: heading
                                  hidden: false
                                  props:
                                    text: Shop by category
                                    level: h2
                                    highlight: ''
                                    size: 36
                                    mobileSize: 0
                                    weight: '700'
                                    font: ''
                                    color: ''
                                    lineHeight: 0
                                    letterSpacing: 0
                                    transform: none
                                    align: center
                                    maxWidth: 0
                                    mt: 0
                                    mb: 0
                                    hideDesktop: false
                                    hideTablet: false
                                    hideMobile: false
                                - id: kcatsb01
                                  type: categories
                                  hidden: false
                                  props:
                                    which: all
                                    categories: []
                                    limit: 8
                                    showCount: true
                                    showPrice: true
                                    viewAll: true
                                    viewAllLabel: View all categories
                                    columns: '4'
                                    mobileColumns: '2'
                                    mt: 0
                                    mb: 0
                                    hideDesktop: false
                                    hideTablet: false
                                    hideMobile: false
                        - id: products
                          kind: products
                          name: All products
                          path: /products
                          title: ''
                          description: ''
                          hideHeader: false
                          hideFooter: false
                          sections:
                            - id: kphead01
                              type: page-header
                              hidden: false
                              props:
                                name: ''
                                anchor: ''
                                width: default
                                align: left
                                mt: 0
                                mb: 0
                                pt: 24
                                pb: 8
                                gap: 16
                                minHeight: 0
                                valign: center
                                boxed: false
                                radius: inherit
                                border: true
                                shadow: false
                                bg: none
                                bgColor: '#12151c'
                                bgColor2: '#2563eb'
                                angle: 135
                                bgImage: ''
                                bgSize: cover
                                overlay: '#000000'
                                overlayOpacity: 40
                                effect: none
                                textColor: ''
                                hideDesktop: false
                                hideTablet: false
                                hideMobile: false
                              blocks:
                                - id: kpheab01
                                  type: ks-page-header
                                  hidden: false
                                  props:
                                    breadcrumbs: true
                                    title: '{page}'
                                    text: >-
                                      Everything in the store, delivered the
                                      moment you pay.
                                    level: h1
                                    image: ''
                                    tint: false
                                    strength: 100
                                    mt: 0
                                    mb: 0
                                    hideDesktop: false
                                    hideTablet: false
                                    hideMobile: false
                            - id: kstore01
                              type: catalogue
                              hidden: false
                              props:
                                name: ''
                                anchor: ''
                                width: default
                                align: left
                                mt: 0
                                mb: 0
                                pt: 16
                                pb: 16
                                gap: 16
                                minHeight: 0
                                valign: center
                                boxed: false
                                radius: inherit
                                border: true
                                shadow: false
                                bg: none
                                bgColor: '#12151c'
                                bgColor2: '#2563eb'
                                angle: 135
                                bgImage: ''
                                bgSize: cover
                                overlay: '#000000'
                                overlayOpacity: 40
                                effect: none
                                textColor: ''
                                hideDesktop: false
                                hideTablet: false
                                hideMobile: false
                              blocks:
                                - id: kstoreb1
                                  type: catalogue
                                  hidden: false
                                  props:
                                    search: true
                                    searchPlaceholder: Search products or categories...
                                    showCount: true
                                    showPrice: true
                                    columns: '6'
                                    mobileColumns: '2'
                                    filters: true
                                    featured: true
                                    views: true
                                    perPage: 12
                                    empty: No products found
                                    mt: 0
                                    mb: 0
                                    hideDesktop: false
                                    hideTablet: false
                                    hideMobile: false
                    files: null
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '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.export("STOREFRONT_ID");
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

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

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

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.storefronts.export("STOREFRONT_ID")
components:
  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'
    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.