Shopify Modify API

openapi: 3.1.0
info:
  title: Shopify Admin REST About Modify 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: Modify
paths:
  /admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    id: 284138680
                    message: After further review, this is a legitimate order
                    recommendation: accept
                    source: External
                    cause_cancel: false
                    score: 0
                summary: Update an existing order risk for an order
      summary: Shopify Updates An Order Risk                                            You Cannot Modify An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-01
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: risk_id
        required: true
        schema:
          type: string
        description: risk_id
      tags:
      - Modify
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    id: 284138680
                    message: After further review, this is a legitimate order
                    recommendation: accept
                    source: External
                    cause_cancel: false
                    score: 0
                summary: Update an existing order risk for an order
      summary: Shopify Updates An Order Risk                                            You Cannot Modify An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-04
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: risk_id
        required: true
        schema:
          type: string
        description: risk_id
      tags:
      - Modify
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    id: 284138680
                    message: After further review, this is a legitimate order
                    recommendation: accept
                    source: External
                    cause_cancel: false
                    score: 0
                summary: Update an existing order risk for an order
      summary: Shopify Updates An Order Risk                                            You Cannot Modify An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-07
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: risk_id
        required: true
        schema:
          type: string
        description: risk_id
      tags:
      - Modify
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/orders/{order_id}/risks/{risk_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    id: 284138680
                    message: After further review, this is a legitimate order
                    recommendation: accept
                    source: External
                    cause_cancel: false
                    score: 0
                summary: Update an existing order risk for an order
      summary: Shopify Updates An Order Risk                                            You Cannot Modify An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-10
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: risk_id
        required: true
        schema:
          type: string
        description: risk_id
      tags:
      - Modify
      responses:
        '200':
          description: ''
      operationId: update_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/orders/{order_id}/risks/{risk_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    id: 284138680
                    message: After further review, this is a legitimate order
                    recommendation: accept
                    source: External
                    cause_cancel: false
                    score: 0
                summary: Update an existing order risk for an order
      summary: Shopify Updates An Order Risk                                            You Cannot Modify An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2021-01
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: risk_id
        required: true
        schema:
          type: string
        description: risk_id
      tags:
      - Modify
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/orders/{order_id}/risks/{risk_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    id: 284138680
                    message: After further review, this is a legitimate order
                    recommendation: accept
                    source: External
                    cause_cancel: false
                    score: 0
                summary: Update an existing order risk for an order
      summary: Shopify Updates An Order Risk                                            You Cannot Modify An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-unstable
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: risk_id
        required: true
        schema:
          type: string
        description: risk_id
      tags:
      - Modify
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/products/{product_id}/images/{image_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  image:
                    id: 850703190
                    position: 2
                    alt: new alt tag content
                summary: Modify an image; change its position and alt tag content
              example2:
                value:
                  image:
                    id: 850703190
                    metafields:
                    - key: my_new_metafield
                      value: my_new_value
                      value_type: string
                      namespace: tags
                summary: Modify an image; add a metafield
              example3:
                value:
                  image:
                    id: 850703190
                    variant_ids:
                    - 808950810
                    - 457924702
                summary: Modify an image; add it to product variants
      summary: Shopify Modify An Existing Product Image
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2020-01
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: path
        name: image_id
        required: true
        schema:
          type: string
        description: image_id
      tags:
      - Modify
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/products/{product_id}/images/{image_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  image:
                    id: 850703190
                    position: 2
                    alt: new alt tag content
                summary: Modify an image; change its position and alt tag content
              example2:
                value:
                  image:
                    id: 850703190
                    metafields:
                    - key: my_new_metafield
                      value: my_new_value
                      value_type: string
                      namespace: tags
                summary: Modify an image; add a metafield
              example3:
                value:
                  image:
                    id: 850703190
                    variant_ids:
                    - 808950810
                    - 457924702
                summary: Modify an image; add it to product variants
      summary: Shopify Modify An Existing Product Image
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2020-04
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: path
        name: image_id
        required: true
        schema:
          type: string
        description: image_id
      tags:
      - Modify
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/products/{product_id}/images/{image_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  image:
                    id: 850703190
                    position: 2
                    alt: new alt tag content
                summary: Modify an image; change its position and alt tag content
              example2:
                value:
                  image:
                    id: 850703190
                    metafields:
                    - key: my_new_metafield
                      value: my_new_value
                      value_type: string
                      namespace: tags
                summary: Modify an image; add a metafield
              example3:
                value:
                  image:
                    id: 850703190
                    variant_ids:
                    - 808950810
                    - 457924702
                summary: Modify an image; add it to product variants
      summary: Shopify Modify An Existing Product Image
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2020-07
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: path
        name: image_id
        required: true
        schema:
          type: string
        description: image_id
      tags:
      - Modify
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/products/{product_id}/images/{image_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  image:
                    id: 850703190
                    position: 2
                    alt: new alt tag content
                summary: Modify an image; change its position and alt tag content
              example2:
                value:
                  image:
                    id: 850703190
                    metafields:
                    - key: my_new_metafield
                      value: my_new_value
                      value_type: string
                      namespace: tags
                summary: Modify an image; add a metafield
              example3:
                value:
                  image:
                    id: 850703190
                    variant_ids:
                    - 808950810
                    - 457924702
                summary: Modify an image; add it to product variants
      summary: Shopify Modify An Existing Product Image
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2020-10
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: path
        name: image_id
        required: true
        schema:
          type: string
        description: image_id
      tags:
      - Modify
      responses:
        '200':
          description: ''
      operationId: update_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/products/{product_id}/images/{image_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  image:
                    id: 850703190
                    position: 2
                    alt: new alt tag content
                summary: Modify an image; change its position and alt tag content
              example2:
                value:
                  image:
                    id: 850703190
                    metafields:
                    - key: my_new_metafield
                      value: my_new_value
                      value_type: string
                      namespace: tags
                summary: Modify an image; add a metafield
              example3:
                value:
                  image:
                    id: 850703190
                    variant_ids:
                    - 808950810
                    - 457924702
                summary: Modify an image; add it to product variants
      summary: Shopify Modify An Existing Product Image
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2021-01
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: path
        name: image_id
        required: true
        schema:
          type: string
        description: image_id
      tags:
      - Modify
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_products_param_product_id_images_param_image_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/products/{product_id}/images/{image_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  image:
                    id: 850703190
                    position: 2
                    alt: new alt tag content
                summary: Modify an image; change its position and alt tag content
              example2:
                value:
                  image:
                    id: 850703190
                    metafields:
                    - key: my_new_metafield
                      value: my_new_value
                      value_type: string
                      namespace: tags
                summary: Modify an image; add a metafield
              example3:
                value:
                  image:
                    id: 850703190
                    variant_ids:
                    - 808950810
                    - 457924702
                summary: Modify an image; add it to product variants
      summary: Shopify Modify An Existing Product Image
      description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-unstable
      parameters:
      - in: path
        name: product_id
        required: true
        schema:
          type: string
        description: product_id
      - in: path
        name: image_id
        required: true
        schema:
          type: string
        description: image_id
      tags:
      - Modify
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_products_param_product_id_images_param_image_id
      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