Shopify Update API

The Update API from Shopify — 13 operation(s) for update.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

shopify-update-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Shopify Admin REST About Update 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: Update
paths:
  /admin/api/2020-01/webhooks/{webhook_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  webhook:
                    id: 4759306
                    address: https://somewhere-else.com/
                summary: Update a webhook subscription so that it POSTs to a different address
      summary: Shopify Update A Webhook Subscription's Topic Or Address Uris
      description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2020-01
      parameters:
      - in: path
        name: webhook_id
        required: true
        schema:
          type: string
        description: webhook_id
      tags:
      - Update
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_webhooks_param_webhook_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/webhooks/{webhook_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  webhook:
                    id: 4759306
                    address: https://somewhere-else.com/
                summary: Update a webhook subscription so that it POSTs to a different address
      summary: Shopify Update A Webhook Subscription's Topic Or Address Uris
      description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2020-04
      parameters:
      - in: path
        name: webhook_id
        required: true
        schema:
          type: string
        description: webhook_id
      tags:
      - Update
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_webhooks_param_webhook_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/webhooks/{webhook_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  webhook:
                    id: 4759306
                    address: https://somewhere-else.com/
                summary: Update a webhook subscription so that it POSTs to a different address
      summary: Shopify Update A Webhook Subscription's Topic Or Address Uris
      description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2020-07
      parameters:
      - in: path
        name: webhook_id
        required: true
        schema:
          type: string
        description: webhook_id
      tags:
      - Update
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_webhooks_param_webhook_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/webhooks/{webhook_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  webhook:
                    id: 4759306
                    address: https://somewhere-else.com/
                summary: Update a webhook subscription so that it POSTs to a different address
      summary: Shopify Update A Webhook Subscription's Topic Or Address Uris
      description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2020-10
      parameters:
      - in: path
        name: webhook_id
        required: true
        schema:
          type: string
        description: webhook_id
      tags:
      - Update
      responses:
        '200':
          description: ''
      operationId: update_webhooks_param_webhook_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/webhooks/{webhook_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  webhook:
                    id: 4759306
                    address: https://somewhere-else.com/
                summary: Update a webhook subscription so that it POSTs to a different address
      summary: Shopify Update A Webhook Subscription's Topic Or Address Uris
      description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2021-01
      parameters:
      - in: path
        name: webhook_id
        required: true
        schema:
          type: string
        description: webhook_id
      tags:
      - Update
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_webhooks_param_webhook_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/webhooks/{webhook_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  webhook:
                    id: 4759306
                    address: https://somewhere-else.com/
                summary: Update a webhook subscription so that it POSTs to a different address
      summary: Shopify Update A Webhook Subscription's Topic Or Address Uris
      description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-unstable
      parameters:
      - in: path
        name: webhook_id
        required: true
        schema:
          type: string
        description: webhook_id
      tags:
      - Update
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_webhooks_param_webhook_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/blogs/{blog_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  blog:
                    id: 241253187
                    title: IPod Updates
                summary: Update an existing blog title
              example2:
                value:
                  blog:
                    id: 241253187
                    title: IPod Updates
                    handle: ipod-updates
                    commentable: moderate
                summary: Update an existing blog title and handle and also activate comments
              example3:
                value:
                  blog:
                    id: 241253187
                    metafields:
                    - key: new
                      value: newvalue
                      value_type: string
                      namespace: global
                summary: Add a metafield to an existing blog
      summary: Shopify Update A Blog
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/blog#update-2020-01
      parameters:
      - in: path
        name: blog_id
        required: true
        schema:
          type: string
        description: blog_id
      tags:
      - Update
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_blogs_param_blog_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    tracking_number: '987654321'
                    id: 255858046
                summary: Update the tracking number for a fulfillment
      summary: Shopify Update Information Associated With A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2020-01
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Update
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_orders_param_order_id_fulfillments_param_fulfillment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    tracking_number: '987654321'
                    id: 255858046
                summary: Update the tracking number for a fulfillment
      summary: Shopify Update Information Associated With A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2020-04
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Update
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_orders_param_order_id_fulfillments_param_fulfillment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    tracking_number: '987654321'
                    id: 255858046
                summary: Update the tracking number for a fulfillment
      summary: Shopify Update Information Associated With A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2020-07
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Update
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_orders_param_order_id_fulfillments_param_fulfillment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    tracking_number: '987654321'
                    id: 255858046
                summary: Update the tracking number for a fulfillment
      summary: Shopify Update Information Associated With A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2020-10
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Update
      responses:
        '200':
          description: ''
      operationId: update_orders_param_order_id_fulfillments_param_fulfillment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    tracking_number: '987654321'
                    id: 255858046
                summary: Update the tracking number for a fulfillment
      summary: Shopify Update Information Associated With A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2021-01
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Update
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_orders_param_order_id_fulfillments_param_fulfillment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    tracking_number: '987654321'
                    id: 255858046
                summary: Update the tracking number for a fulfillment
      summary: Shopify Update Information Associated With A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-unstable
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Update
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_orders_param_order_id_fulfillments_param_fulfillment_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