Shopify Progress API

The Progress API from Shopify — 6 operation(s) for progress.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

shopify-progress-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Shopify Admin REST About Progress 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: Progress
paths:
  /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/close.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment_order:
                    message: Not enough inventory to complete this work.
                summary: Transition a fulfillment order from in progress to incomplete
      summary: Shopify Marks An In Progress Fulfillment Order As Incomplete
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2020-01
      parameters:
      - in: path
        name: fulfillment_order_id
        required: true
        schema:
          type: string
        description: fulfillment_order_id
      - in: query
        name: message
        description: An optional reason for marking the fulfillment order as incomplete.
        schema: {}
        required: false
      tags:
      - Progress
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_fulfillment_orders_param_fulfillment_order_id_close
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/close.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment_order:
                    message: Not enough inventory to complete this work.
                summary: Transition a fulfillment order from in progress to incomplete
      summary: Shopify Marks An In Progress Fulfillment Order As Incomplete
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2020-04
      parameters:
      - in: path
        name: fulfillment_order_id
        required: true
        schema:
          type: string
        description: fulfillment_order_id
      - in: query
        name: message
        description: An optional reason for marking the fulfillment order as incomplete.
        schema: {}
        required: false
      tags:
      - Progress
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_fulfillment_orders_param_fulfillment_order_id_close
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/close.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment_order:
                    message: Not enough inventory to complete this work.
                summary: Transition a fulfillment order from in progress to incomplete
      summary: Shopify Marks An In Progress Fulfillment Order As Incomplete
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2020-07
      parameters:
      - in: path
        name: fulfillment_order_id
        required: true
        schema:
          type: string
        description: fulfillment_order_id
      - in: query
        name: message
        description: An optional reason for marking the fulfillment order as incomplete.
        schema: {}
        required: false
      tags:
      - Progress
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_fulfillment_orders_param_fulfillment_order_id_close
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/close.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment_order:
                    message: Not enough inventory to complete this work.
                summary: Transition a fulfillment order from in progress to incomplete
      summary: Shopify Marks An In Progress Fulfillment Order As Incomplete
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2020-10
      parameters:
      - in: path
        name: fulfillment_order_id
        required: true
        schema:
          type: string
        description: fulfillment_order_id
      - in: query
        name: message
        description: An optional reason for marking the fulfillment order as incomplete.
        schema: {}
        required: false
      tags:
      - Progress
      responses:
        '200':
          description: ''
      operationId: create_fulfillment_orders_param_fulfillment_order_id_close
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/close.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment_order:
                    message: Not enough inventory to complete this work.
                summary: Transition a fulfillment order from in progress to incomplete
      summary: Shopify Marks An In Progress Fulfillment Order As Incomplete
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2021-01
      parameters:
      - in: path
        name: fulfillment_order_id
        required: true
        schema:
          type: string
        description: fulfillment_order_id
      - in: query
        name: message
        description: An optional reason for marking the fulfillment order as incomplete.
        schema: {}
        required: false
      tags:
      - Progress
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_fulfillment_orders_param_fulfillment_order_id_close
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/close.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment_order:
                    message: Not enough inventory to complete this work.
                summary: Transition a fulfillment order from in progress to incomplete
      summary: Shopify Marks An In Progress Fulfillment Order As Incomplete
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-unstable
      parameters:
      - in: path
        name: fulfillment_order_id
        required: true
        schema:
          type: string
        description: fulfillment_order_id
      - in: query
        name: message
        description: An optional reason for marking the fulfillment order as incomplete.
        schema: {}
        required: false
      tags:
      - Progress
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_fulfillment_orders_param_fulfillment_order_id_close
      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