Shopify

Shopify Assets API

The Assets API from Shopify — 6 operation(s) for assets.

GitHub OpenAPI

Documentation

📖
Documentation
https://shopify.dev/docs/api/admin-rest
📖
Documentation
https://shopify.dev/docs/api/ajax

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-assets-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-product-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-customer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-inventory-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-fulfillment-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-product-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-order-structure.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-ld/shopify-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-create-product-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-list-orders-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/vocabulary/shopify-vocabulary.yml
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/rules/shopify-rules.yml
🔗
Reference
https://shopify.dev/docs/api/ajax/reference

OpenAPI Specification

shopify-assets-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Shopify Admin REST About Assets API
  description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date.
  version: 2025-01
  contact:
    name: Shopify
    url: https://shopify.dev/docs/api/admin-rest
    email: api@shopify.com
  license:
    name: Shopify API Terms
    url: https://www.shopify.com/legal/api-terms
  x-date: '2026-03-04'
servers:
- url: https://{store}.myshopify.com/admin/api/2025-01
  description: Shopify Admin REST API
  variables:
    store:
      default: my-store
      description: The Shopify store subdomain
security:
- AccessToken: []
tags:
- name: Assets
paths:
  /admin/api/2020-01/themes/{theme_id}/assets.json:
    get:
      summary: Shopify Retrieves A Single Asset For A Theme By Its Key
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2020-01
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names
        schema: {}
        required: false
      - in: query
        name: asset[key]
        schema:
          type: string
        description: asset[key]
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  asset:
                    key: templates/index.liquid
                    value: <img src='backsoon-postit.png'><p>We are busy updating the store for you and will be back within the hour.</p>
                summary: Change an existing Liquid template's value
              example2:
                value:
                  asset:
                    key: assets/empty.gif
                    attachment: 'R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

                      '
                summary: Create an image asset by providing a base64-encoded attachment
              example3:
                value:
                  asset:
                    key: assets/bg-body.gif
                    src: http://apple.com/new_bg.gif
                summary: Create an image asset by providing a source URL from which to upload the image
              example4:
                value:
                  asset:
                    key: layout/alternate.liquid
                    source_key: layout/theme.liquid
                summary: Duplicate an existing asset by providing a source key
      summary: Shopify Creates Or Updates An Asset For A Theme
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#update-2020-01
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: src
        description: The source URL of an image. Include in the body of the PUT request to upload the image to Shopify.
        schema: {}
        required: false
      - in: query
        name: source_key
        description: The path within the theme to an existing asset. Include in the body of the PUT request to create a duplicate asset.
        schema: {}
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes An Asset From A Theme
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-2020-01
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: asset[key]
        schema:
          type: string
        description: asset[key]
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_delete_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/themes/{theme_id}/assets.json:
    get:
      summary: Shopify Retrieves A Single Asset For A Theme By Its Key
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2020-04
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names
        schema: {}
        required: false
      - in: query
        name: asset[key]
        schema:
          type: string
        description: asset[key]
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  asset:
                    key: templates/index.liquid
                    value: <img src='backsoon-postit.png'><p>We are busy updating the store for you and will be back within the hour.</p>
                summary: Change an existing Liquid template's value
              example2:
                value:
                  asset:
                    key: assets/empty.gif
                    attachment: 'R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

                      '
                summary: Create an image asset by providing a base64-encoded attachment
              example3:
                value:
                  asset:
                    key: assets/bg-body.gif
                    src: http://apple.com/new_bg.gif
                summary: Create an image asset by providing a source URL from which to upload the image
              example4:
                value:
                  asset:
                    key: layout/alternate.liquid
                    source_key: layout/theme.liquid
                summary: Duplicate an existing asset by providing a source key
      summary: Shopify Creates Or Updates An Asset For A Theme
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#update-2020-04
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: src
        description: The source URL of an image. Include in the body of the PUT request to upload the image to Shopify.
        schema: {}
        required: false
      - in: query
        name: source_key
        description: The path within the theme to an existing asset. Include in the body of the PUT request to create a duplicate asset.
        schema: {}
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes An Asset From A Theme
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-2020-04
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: asset[key]
        schema:
          type: string
        description: asset[key]
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_delete_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/themes/{theme_id}/assets.json:
    get:
      summary: Shopify Retrieves A Single Asset For A Theme By Its Key
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2020-07
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names
        schema: {}
        required: false
      - in: query
        name: asset[key]
        schema:
          type: string
        description: asset[key]
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  asset:
                    key: templates/index.liquid
                    value: <img src='backsoon-postit.png'><p>We are busy updating the store for you and will be back within the hour.</p>
                summary: Change an existing Liquid template's value
              example2:
                value:
                  asset:
                    key: assets/empty.gif
                    attachment: 'R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

                      '
                summary: Create an image asset by providing a base64-encoded attachment
              example3:
                value:
                  asset:
                    key: assets/bg-body.gif
                    src: http://apple.com/new_bg.gif
                summary: Create an image asset by providing a source URL from which to upload the image
              example4:
                value:
                  asset:
                    key: layout/alternate.liquid
                    source_key: layout/theme.liquid
                summary: Duplicate an existing asset by providing a source key
      summary: Shopify Creates Or Updates An Asset For A Theme
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#update-2020-07
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: src
        description: The source URL of an image. Include in the body of the PUT request to upload the image to Shopify.
        schema: {}
        required: false
      - in: query
        name: source_key
        description: The path within the theme to an existing asset. Include in the body of the PUT request to create a duplicate asset.
        schema: {}
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes An Asset From A Theme
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-2020-07
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: asset[key]
        schema:
          type: string
        description: asset[key]
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_delete_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/themes/{theme_id}/assets.json:
    get:
      summary: Shopify Retrieves A Single Asset For A Theme By Its Key
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2020-10
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names
        schema: {}
        required: false
      - in: query
        name: asset[key]
        schema:
          type: string
        description: asset[key]
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: get_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  asset:
                    key: templates/index.liquid
                    value: <img src='backsoon-postit.png'><p>We are busy updating the store for you and will be back within the hour.</p>
                summary: Change an existing Liquid template's value
              example2:
                value:
                  asset:
                    key: assets/empty.gif
                    attachment: 'R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

                      '
                summary: Create an image asset by providing a base64-encoded attachment
              example3:
                value:
                  asset:
                    key: assets/bg-body.gif
                    src: http://apple.com/new_bg.gif
                summary: Create an image asset by providing a source URL from which to upload the image
              example4:
                value:
                  asset:
                    key: layout/alternate.liquid
                    source_key: layout/theme.liquid
                summary: Duplicate an existing asset by providing a source key
      summary: Shopify Creates Or Updates An Asset For A Theme
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#update-2020-10
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: src
        description: The source URL of an image. Include in the body of the PUT request to upload the image to Shopify.
        schema: {}
        required: false
      - in: query
        name: source_key
        description: The path within the theme to an existing asset. Include in the body of the PUT request to create a duplicate asset.
        schema: {}
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: update_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes An Asset From A Theme
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-2020-10
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: asset[key]
        schema:
          type: string
        description: asset[key]
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: delete_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/themes/{theme_id}/assets.json:
    get:
      summary: Shopify Retrieves A Single Asset For A Theme By Its Key
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2021-01
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names
        schema: {}
        required: false
      - in: query
        name: asset[key]
        schema:
          type: string
        description: asset[key]
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  asset:
                    key: templates/index.liquid
                    value: <img src='backsoon-postit.png'><p>We are busy updating the store for you and will be back within the hour.</p>
                summary: Change an existing Liquid template's value
              example2:
                value:
                  asset:
                    key: assets/empty.gif
                    attachment: 'R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

                      '
                summary: Create an image asset by providing a base64-encoded attachment
              example3:
                value:
                  asset:
                    key: assets/bg-body.gif
                    src: http://apple.com/new_bg.gif
                summary: Create an image asset by providing a source URL from which to upload the image
              example4:
                value:
                  asset:
                    key: layout/alternate.liquid
                    source_key: layout/theme.liquid
                summary: Duplicate an existing asset by providing a source key
      summary: Shopify Creates Or Updates An Asset For A Theme
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#update-2021-01
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: src
        description: The source URL of an image. Include in the body of the PUT request to upload the image to Shopify.
        schema: {}
        required: false
      - in: query
        name: source_key
        description: The path within the theme to an existing asset. Include in the body of the PUT request to create a duplicate asset.
        schema: {}
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes An Asset From A Theme
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-2021-01
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: asset[key]
        schema:
          type: string
        description: asset[key]
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_delete_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/themes/{theme_id}/assets.json:
    get:
      summary: Shopify Retrieves A Single Asset For A Theme By Its Key
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-unstable
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names
        schema: {}
        required: false
      - in: query
        name: asset[key]
        schema:
          type: string
        description: asset[key]
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  asset:
                    key: templates/index.liquid
                    value: <img src='backsoon-postit.png'><p>We are busy updating the store for you and will be back within the hour.</p>
                summary: Change an existing Liquid template's value
              example2:
                value:
                  asset:
                    key: assets/empty.gif
                    attachment: 'R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

                      '
                summary: Create an image asset by providing a base64-encoded attachment
              example3:
                value:
                  asset:
                    key: assets/bg-body.gif
                    src: http://apple.com/new_bg.gif
                summary: Create an image asset by providing a source URL from which to upload the image
              example4:
                value:
                  asset:
                    key: layout/alternate.liquid
                    source_key: layout/theme.liquid
                summary: Duplicate an existing asset by providing a source key
      summary: Shopify Creates Or Updates An Asset For A Theme
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#update-unstable
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: src
        description: The source URL of an image. Include in the body of the PUT request to upload the image to Shopify.
        schema: {}
        required: false
      - in: query
        name: source_key
        description: The path within the theme to an existing asset. Include in the body of the PUT request to create a duplicate asset.
        schema: {}
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes An Asset From A Theme
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-unstable
      parameters:
      - in: path
        name: theme_id
        required: true
        schema:
          type: string
        description: theme_id
      - in: query
        name: asset[key]
        schema:
          type: string
        description: asset[key]
        required: false
      tags:
      - Assets
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_delete_themes_param_theme_id_assets
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
components:
  securitySchemes:
    AccessToken:
      type: apiKey
      name: X-Shopify-Access-Token
      in: header
      description: Access token obtained via OAuth