Shopify API — Orders

naftiko: 1.0.0-alpha2
info:
  label: Shopify  API — Orders
  description: 'Shopify  API — Orders. 42 operations. Lead operation: Shopify Retrieves A List Of Fulfillment Orders On A
    Shop For A Specific App. Self-contained Naftiko capability covering one Shopify business surface.'
  tags:
  - Shopify
  - Orders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPIFY_API_KEY: SHOPIFY_API_KEY
capability:
  consumes:
  - type: http
    namespace: shopify-orders
    baseUri: ''
    description: Shopify  API — Orders business capability. Self-contained, no shared references.
    resources:
    - name: admin-api-2020-01-assigned_fulfillment_orders.json
      path: /admin/api/2020-01/assigned_fulfillment_orders.json
      operations:
      - name: deprecated202001getassignedfulfillmentorders
        method: GET
        description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: assignment_status
          in: query
          type: string
          description: 'The assigment status of the fulfillment orders that should be returned:'
        - name: location_ids
          in: query
          type: string
          description: The IDs of the assigned locations of the fulfillment orders that should be returned.
        - name: location_ids[]
          in: query
          type: integer
          description: location_ids[]
    - name: admin-api-2020-01-customers-customer_id-orders.json
      path: /admin/api/2020-01/customers/{customer_id}/orders.json
      operations:
      - name: deprecated202001getcustomersparamcustomeridorders
        method: GET
        description: Shopify Retrieves All Orders Belonging To A Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer_id
          in: path
          type: string
          description: customer_id
          required: true
    - name: admin-api-2020-01-fulfillments.json
      path: /admin/api/2020-01/fulfillments.json
      operations:
      - name: deprecated202001createfulfillments
        method: POST
        description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-01-orders.json
      path: /admin/api/2020-01/orders.json
      operations:
      - name: deprecated202001getorders
        method: GET
        description: Shopify Retrieves A List Of Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ids
          in: query
          type: string
          description: Retrieve only orders specified by a comma-separated list of order IDs.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show on a page.
        - name: since_id
          in: query
          type: string
          description: Show orders after the specified ID.
        - name: created_at_min
          in: query
          type: string
          description: 'Show orders created at or after date (format: 2014-04-25T16:15:47-04:00).'
        - name: created_at_max
          in: query
          type: string
          description: 'Show orders created at or before date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_min
          in: query
          type: string
          description: 'Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00).'
        - name: processed_at_min
          in: query
          type: string
          description: 'Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00).'
        - name: processed_at_max
          in: query
          type: string
          description: 'Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00).'
        - name: attribution_app_id
          in: query
          type: string
          description: Show orders attributed to a certain app, specified by the app ID. Set as current to show orders for
            the app currently consuming the API.
        - name: status
          in: query
          type: string
          description: Filter orders by their status.
        - name: financial_status
          in: query
          type: string
          description: Filter orders by their financial status.
        - name: fulfillment_status
          in: query
          type: string
          description: Filter orders by their fulfillment status.
        - name: fields
          in: query
          type: string
          description: Retrieve only certain fields, specified by a comma-separated list of fields names.
    - name: admin-api-2020-01-orders-order_id-cancel.json
      path: /admin/api/2020-01/orders/{order_id}/cancel.json
      operations:
      - name: deprecated202001createordersparamorderidcancel
        method: POST
        description: Shopify For Multi-currency Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          description: order_id
          required: true
        - name: amount
          in: query
          type: string
          description: The amount to refund. If set, Shopify attempts to void or refund the payment, depending on its status.
            Shopify refunds through a manual gateway in cases where t
        - name: currency
          in: query
          type: string
          description: The currency of the refund that's issued when the order is canceled. Required for multi-currency orders
            whenever the amount property is provided.
        - name: "restock\n                  deprecated"
          in: query
          type: string
          description: Whether to restock refunded items back to your store's inventory.
        - name: reason
          in: query
          type: string
          description: 'The reason for the order cancellation. Valid values: customer, inventory, fraud, declined, and other.)'
        - name: email
          in: query
          type: string
          description: Whether to send an email to the customer notifying them of the cancellation.
        - name: refund
          in: query
          type: string
          description: The refund transactions to perform. Required for some more complex refund situations. For more information,
            see the Refund API.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-01-orders-order_id-fulfillment_orders.json
      path: /admin/api/2020-01/orders/{order_id}/fulfillment_orders.json
      operations:
      - name: deprecated202001getordersparamorderidfulfillmentorders
        method: GET
        description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          description: order_id
          required: true
        - name: order_id
          in: query
          type: string
          description: The ID of the order that is associated with the fulfillment orders.
    - name: admin-api-2020-01-orders-order_id-refunds.json
      path: /admin/api/2020-01/orders/{order_id}/refunds.json
      operations:
      - name: deprecated202001createordersparamorderidrefunds
        method: POST
        description: Shopify For Multi-currency Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          description: order_id
          required: true
        - name: "restock\n                  deprecated"
          in: query
          type: string
          description: Whether to add the line items back to the store inventory. Use restock_type for refund line items instead.
        - name: notify
          in: query
          type: string
          description: Whether to send a refund notification to the customer.
        - name: note
          in: query
          type: string
          description: An optional note attached to a refund.
        - name: discrepancy_reason
          in: query
          type: string
          description: An optional comment that explains a discrepancy between calculated and actual refund amounts. Used
            to populate the reason property of the resulting order adjust
        - name: shipping
          in: query
          type: string
          description: 'Specify how much shipping to refund. It has the following properties:'
        - name: refund_line_items
          in: query
          type: string
          description: 'A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following
            properties:'
        - name: transactions
          in: query
          type: string
          description: A list of transactions
        - name: currency
          in: query
          type: string
          description: The three-letter code (ISO 4217 format) for the currency used for the refund.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-01-orders-order_id-refunds-calculate.json
      path: /admin/api/2020-01/orders/{order_id}/refunds/calculate.json
      operations:
      - name: deprecated202001createordersparamorderidrefundscalculate
        method: POST
        description: Shopify For Multi-currency Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          description: order_id
          required: true
        - name: shipping
          in: query
          type: string
          description: 'Specify how much shipping to refund. It has the following properties:'
        - name: refund_line_items
          in: query
          type: string
          description: 'A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following
            properties:'
        - name: currency
          in: query
          type: string
          description: The three-letter code (ISO 4217 format) for the
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-04-assigned_fulfillment_orders.json
      path: /admin/api/2020-04/assigned_fulfillment_orders.json
      operations:
      - name: deprecated202004getassignedfulfillmentorders
        method: GET
        description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: assignment_status
          in: query
          type: string
          description: 'The assigment status of the fulfillment orders that should be returned:'
        - name: location_ids
          in: query
          type: string
          description: The IDs of the assigned locations of the fulfillment orders that should be returned.
        - name: location_ids[]
          in: query
          type: integer
          description: location_ids[]
    - name: admin-api-2020-04-customers-customer_id-orders.json
      path: /admin/api/2020-04/customers/{customer_id}/orders.json
      operations:
      - name: deprecated202004getcustomersparamcustomeridorders
        method: GET
        description: Shopify Retrieves All Orders Belonging To A Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer_id
          in: path
          type: string
          description: customer_id
          required: true
    - name: admin-api-2020-04-fulfillments.json
      path: /admin/api/2020-04/fulfillments.json
      operations:
      - name: deprecated202004createfulfillments
        method: POST
        description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-04-orders.json
      path: /admin/api/2020-04/orders.json
      operations:
      - name: deprecated202004getorders
        method: GET
        description: Shopify Retrieves A List Of Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ids
          in: query
          type: string
          description: Retrieve only orders specified by a comma-separated list of order IDs.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show on a page.
        - name: since_id
          in: query
          type: string
          description: Show orders after the specified ID.
        - name: created_at_min
          in: query
          type: string
          description: 'Show orders created at or after date (format: 2014-04-25T16:15:47-04:00).'
        - name: created_at_max
          in: query
          type: string
          description: 'Show orders created at or before date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_min
          in: query
          type: string
          description: 'Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00).'
        - name: processed_at_min
          in: query
          type: string
          description: 'Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00).'
        - name: processed_at_max
          in: query
          type: string
          description: 'Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00).'
        - name: attribution_app_id
          in: query
          type: string
          description: Show orders attributed to a certain app, specified by the app ID. Set as current to show orders for
            the app currently consuming the API.
        - name: status
          in: query
          type: string
          description: Filter orders by their status.
        - name: financial_status
          in: query
          type: string
          description: Filter orders by their financial status.
        - name: fulfillment_status
          in: query
          type: string
          description: Filter orders by their fulfillment status.
        - name: fields
          in: query
          type: string
          description: Retrieve only certain fields, specified by a comma-separated list of fields names.
    - name: admin-api-2020-04-orders-order_id-cancel.json
      path: /admin/api/2020-04/orders/{order_id}/cancel.json
      operations:
      - name: deprecated202004createordersparamorderidcancel
        method: POST
        description: Shopify For Multi-currency Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          description: order_id
          required: true
        - name: amount
          in: query
          type: string
          description: The amount to refund. If set, Shopify attempts to void or refund the payment, depending on its status.
            Shopify refunds through a manual gateway in cases where t
        - name: currency
          in: query
          type: string
          description: The currency of the refund that's issued when the order is canceled. Required for multi-currency orders
            whenever the amount property is provided.
        - name: "restock\n                  deprecated"
          in: query
          type: string
          description: Whether to restock refunded items back to your store's inventory.
        - name: reason
          in: query
          type: string
          description: 'The reason for the order cancellation. Valid values: customer, inventory, fraud, declined, and other.)'
        - name: email
          in: query
          type: string
          description: Whether to send an email to the customer notifying them of the cancellation.
        - name: refund
          in: query
          type: string
          description: The refund transactions to perform. Required for some more complex refund situations. For more information,
            see the Refund API.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-04-orders-order_id-fulfillment_orders.json
      path: /admin/api/2020-04/orders/{order_id}/fulfillment_orders.json
      operations:
      - name: deprecated202004getordersparamorderidfulfillmentorders
        method: GET
        description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          description: order_id
          required: true
        - name: order_id
          in: query
          type: string
          description: The ID of the order that is associated with the fulfillment orders.
    - name: admin-api-2020-04-orders-order_id-refunds.json
      path: /admin/api/2020-04/orders/{order_id}/refunds.json
      operations:
      - name: deprecated202004createordersparamorderidrefunds
        method: POST
        description: Shopify For Multi-currency Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          description: order_id
          required: true
        - name: "restock\n                  deprecated"
          in: query
          type: string
          description: Whether to add the line items back to the store inventory. Use restock_type for refund line items instead.
        - name: notify
          in: query
          type: string
          description: Whether to send a refund notification to the customer.
        - name: note
          in: query
          type: string
          description: An optional note attached to a refund.
        - name: discrepancy_reason
          in: query
          type: string
          description: An optional comment that explains a discrepancy between calculated and actual refund amounts. Used
            to populate the reason property of the resulting order adjust
        - name: shipping
          in: query
          type: string
          description: 'Specify how much shipping to refund. It has the following properties:'
        - name: refund_line_items
          in: query
          type: string
          description: 'A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following
            properties:'
        - name: transactions
          in: query
          type: string
          description: A list of transactions
        - name: currency
          in: query
          type: string
          description: The three-letter code (ISO 4217 format) for the currency used for the refund.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-04-orders-order_id-refunds-calculate.json
      path: /admin/api/2020-04/orders/{order_id}/refunds/calculate.json
      operations:
      - name: deprecated202004createordersparamorderidrefundscalculate
        method: POST
        description: Shopify For Multi-currency Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          description: order_id
          required: true
        - name: shipping
          in: query
          type: string
          description: 'Specify how much shipping to refund. It has the following properties:'
        - name: refund_line_items
          in: query
          type: string
          description: 'A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following
            properties:'
        - name: currency
          in: query
          type: string
          description: The three-letter code (ISO 4217 format) for the
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-07-assigned_fulfillment_orders.json
      path: /admin/api/2020-07/assigned_fulfillment_orders.json
      operations:
      - name: deprecated202007getassignedfulfillmentorders
        method: GET
        description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: assignment_status
          in: query
          type: string
          description: 'The assigment status of the fulfillment orders that should be returned:'
        - name: location_ids
          in: query
          type: string
          description: The IDs of the assigned locations of the fulfillment orders that should be returned.
        - name: location_ids[]
          in: query
          type: integer
          description: location_ids[]
    - name: admin-api-2020-07-customers-customer_id-orders.json
      path: /admin/api/2020-07/customers/{customer_id}/orders.json
      operations:
      - name: deprecated202007getcustomersparamcustomeridorders
        method: GET
        description: Shopify Retrieves All Orders Belonging To A Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer_id
          in: path
          type: string
          description: customer_id
          required: true
    - name: admin-api-2020-07-fulfillments.json
      path: /admin/api/2020-07/fulfillments.json
      operations:
      - name: deprecated202007createfulfillments
        method: POST
        description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-07-orders.json
      path: /admin/api/2020-07/orders.json
      operations:
      - name: deprecated202007getorders
        method: GET
        description: Shopify Retrieves A List Of Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ids
          in: query
          type: string
          description: Retrieve only orders specified by a comma-separated list of order IDs.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show on a page.
        - name: since_id
          in: query
          type: string
          description: Show orders after the specified ID.
        - name: created_at_min
          in: query
          type: string
          description: 'Show orders created at or after date (format: 2014-04-25T16:15:47-04:00).'
        - name: created_at_max
          in: query
          type: string
          description: 'Show orders created at or before date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_min
          in: query
          type: string
          description: 'Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00).'
        - name: processed_at_min
          in: query
          type: string
          description: 'Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00).'
        - name: processed_at_max
          in: query
          type: string
          description: 'Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00).'
        - name: attribution_app_id
          in: query
          type: string
          description: Show orders attributed to a certain app, specified by the app ID. Set as current to show orders for
            the app currently consuming the API.
        - name: status
          in: query
          type: string
          description: Filter orders by their status.
        - name: financial_status
          in: query
          type: string
          description: Filter orders by their financial status.
        - name: fulfillment_status
          in: query
          type: string
          description: Filter orders by their fulfillment status.
        - name: fields
          in: query
          type: string
          description: Retrieve only certain fields, specified by a comma-separated list of fields names.
    - name: admin-api-2020-07-orders-order_id-fulfillment_orders.json
      path: /admin/api/2020-07/orders/{order_id}/fulfillment_orders.json
      operations:
      - name: deprecated202007getordersparamorderidfulfillmentorders
        method: GET
        description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          description: order_id
          required: true
        - name: order_id
          in: query
          type: string
          description: The ID of the order that is associated with the fulfillment orders.
    - name: admin-api-2020-07-orders-order_id-refunds.json
      path: /admin/api/2020-07/orders/{order_id}/refunds.json
      operations:
      - name: deprecated202007createordersparamorderidrefunds
        method: POST
        description: Shopify For Multi-currency Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          description: order_id
          required: true
        - name: "restock\n                  deprecated"
          in: query
          type: string
          description: Whether to add the line items back to the store inventory. Use restock_type for refund line items instead.
        - name: notify
          in: query
          type: string
          description: Whether to send a refund notification to the customer.
        - name: note
          in: query
          type: string
          description: An optional note attached to a refund.
        - name: discrepancy_reason
          in: query
          type: string
          description: An optional comment that explains a discrepancy between calculated and actual refund amounts. Used
            to populate the reason property of the resulting order adjust
        - name: shipping
          in: query
          type: string
          description: 'Specify how much shipping to refund. It has the following properties:'
        - name: refund_line_items
          in: query
          type: string
          description: 'A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following
            properties:'
        - name: transactions
          in: query
          type: string
          description: A list of transactions
        - name: currency
          in: query
          type: string
          description: The three-letter code (ISO 4217 format) for the currency used for the refund.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-07-orders-order_id-refunds-calculate.json
      path: /admin/api/2020-07/orders/{order_id}/refunds/calculate.json
      operations:
      - name: deprecated202007createordersparamorderidrefundscalculate
        method: POST
        description: Shopify For Multi-currency Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          description: order_id
          required: true
        - name: shipping
          in: query
          type: string
          description: 'Specify how much shipping to refund. It has the following properties:'
        - name: refund_line_items
          in: query
          type: string
          description: 'A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following
            properties:'
        - name: currency
          in: query
          type: string
          description: The three-letter code (ISO 4217 format) for the
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-10-assigned_fulfillment_orders.json
      path: /admin/api/2020-10/assigned_fulfillment_orders.json
      operations:
      - name: getassignedfulfillmentorders
        method: GET
        description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: assignment_status
          in: query
          type: string
          description: 'The assigment status of the fulfillment orders that should be returned:'
        - name: location_ids
          in: query
          type: string
          description: The IDs of the assigned locations of the fulfillment orders that should be returned.
        - name: location_ids[]
          in: query
          type: integer
          description: location_ids[]
    - name: admin-api-2020-10-customers-customer_id-orders.json
      path: /admin/api/2020-10/customers/{customer_id}/orders.json
      operations:
      - name: getcustomersparamcustomeridorders
        method: GET
        description: Shopify Retrieves All Orders Belonging To A Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer_id
          in: path
          type: string
          description: customer_id
          required: true
    - name: admin-api-2020-10-fulfillments.json
      path: /admin/api/

# --- truncated at 32 KB (101 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/capabilities/shopify-orders.yaml