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/2020-10/fulfillments.json operations: - name: createfulfillments 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-10-orders-order_id-fulfillment_orders.json path: /admin/api/2020-10/orders/{order_id}/fulfillment_orders.json operations: - name: getordersparamorderidfulfillmentorders 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-10-orders-order_id-refunds.json path: /admin/api/2020-10/orders/{order_id}/refunds.json operations: - name: createordersparamorderidrefunds 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-10-orders-order_id-refunds-calculate.json path: /admin/api/2020-10/orders/{order_id}/refunds/calculate.json operations: - name: createordersparamorderidrefundscalculate 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-2021-01-assigned_fulfillment_orders.json path: /admin/api/2021-01/assigned_fulfillment_orders.json operations: - name: deprecated202101getassignedfulfillmentorders 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-2021-01-customers-customer_id-orders.json path: /admin/api/2021-01/customers/{customer_id}/orders.json operations: - name: deprecated202101getcustomersparamcustomeridorders 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-2021-01-fulfillments.json path: /admin/api/2021-01/fulfillments.json operations: - name: deprecated202101createfulfillments 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-2021-01-orders-order_id-fulfillment_orders.json path: /admin/api/2021-01/orders/{order_id}/fulfillment_orders.json operations: - name: deprecated202101getordersparamorderidfulfillmentorders 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-2021-01-orders-order_id-refunds.json path: /admin/api/2021-01/orders/{order_id}/refunds.json operations: - name: deprecated202101createordersparamorderidrefunds 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-2021-01-orders-order_id-refunds-calculate.json path: /admin/api/2021-01/orders/{order_id}/refunds/calculate.json operations: - name: deprecated202101createordersparamorderidrefundscalculate 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-unstable-assigned_fulfillment_orders.json path: /admin/api/unstable/assigned_fulfillment_orders.json operations: - name: deprecatedunstablegetassignedfulfillmentorders 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-unstable-customers-customer_id-orders.json path: /admin/api/unstable/customers/{customer_id}/orders.json operations: - name: deprecatedunstablegetcustomersparamcustomeridorders 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-unstable-fulfillments.json path: /admin/api/unstable/fulfillments.json operations: - name: deprecatedunstablecreatefulfillments 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-unstable-orders-order_id-fulfillment_orders.json path: /admin/api/unstable/orders/{order_id}/fulfillment_orders.json operations: - name: deprecatedunstablegetordersparamorderidfulfillmentorders 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-unstable-orders-order_id-refunds.json path: /admin/api/unstable/orders/{order_id}/refunds.json operations: - name: deprecatedunstablecreateordersparamorderidrefunds 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-unstable-orders-order_id-refunds-calculate.json path: /admin/api/unstable/orders/{order_id}/refunds/calculate.json operations: - name: deprecatedunstablecreateordersparamorderidrefundscalculate 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: fetch_tracking_numbers path: /fetch_tracking_numbers operations: - name: deprecatedunknownversiongetfetchtrackingnumbers method: GET description: Shopify Get Tracking Numbers For Orders outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_names in: query type: string description: 'The fulfillment names we require tracking numbers for (i.e. #1001.1)' - name: shop in: query type: string description: The shop's myshopify url exposes: - type: rest namespace: shopify-orders-rest port: 8080 description: REST adapter for Shopify API — Orders. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/admin/api/2020-01/assigned-fulfillment-orders-json name: admin-api-2020-01-assigned-fulfillment-orders-json description: REST surface for admin-api-2020-01-assigned_fulfillment_orders.json. operations: - method: GET name: deprecated202001getassignedfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App call: shopify-orders.deprecated202001getassignedfulfillmentorders with: assignment_status: rest.assignment_status location_ids: rest.location_ids location_ids[]: rest.location_ids[] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/customers/{customer-id}/orders-json name: admin-api-2020-01-customers-customer-id-orders-json description: REST surface for admin-api-2020-01-customers-customer_id-orders.json. operations: - method: GET name: deprecated202001getcustomersparamcustomeridorders description: Shopify Retrieves All Orders Belonging To A Customer call: shopify-orders.deprecated202001getcustomersparamcustomeridorders with: customer_id: rest.customer_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/fulfillments-json name: admin-api-2020-01-fulfillments-json description: REST surface for admin-api-2020-01-fulfillments.json. operations: - method: POST name: deprecated202001createfulfillments description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders call: shopify-orders.deprecated202001createfulfillments with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders-json name: admin-api-2020-01-orders-json description: REST surface for admin-api-2020-01-orders.json. operations: - method: GET name: deprecated202001getorders description: Shopify Retrieves A List Of Orders call: shopify-orders.deprecated202001getorders with: ids: rest.ids limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max processed_at_min: rest.processed_at_min processed_at_max: rest.processed_at_max attribution_app_id: rest.attribution_app_id status: rest.status financial_status: rest.financial_status fulfillment_status: rest.fulfillment_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/cancel-json name: admin-api-2020-01-orders-order-id-cancel-json description: REST surface for admin-api-2020-01-orders-order_id-cancel.json. operations: - method: POST name: deprecated202001createordersparamorderidcancel description: Shopify For Multi-currency Orders call: shopify-orders.deprecated202001createordersparamorderidcancel with: order_id: rest.order_id amount: rest.amount currency: rest.currency ? "restock\n deprecated" : "rest.restock\n deprecated" reason: rest.reason email: rest.email refund: rest.refund body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/fulfillment-orders-json name: admin-api-2020-01-orders-order-id-fulfillment-orders-json description: REST surface for admin-api-2020-01-orders-order_id-fulfillment_orders.json. operations: - method: GET name: deprecated202001getordersparamorderidfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order call: shopify-orders.deprecated202001getordersparamorderidfulfillmentorders with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/refunds-json name: admin-api-2020-01-orders-order-id-refunds-json description: REST surface for admin-api-2020-01-orders-order_id-refunds.json. operations: - method: POST name: deprecated202001createordersparamorderidrefunds description: Shopify For Multi-currency Orders call: shopify-orders.deprecated202001createordersparamorderidrefunds with: order_id: rest.order_id ? "restock\n deprecated" : "rest.restock\n deprecated" notify: rest.notify note: rest.note discrepancy_reason: rest.discrepancy_reason shipping: rest.shipping refund_line_items: rest.refund_line_items transactions: rest.transactions currency: rest.currency body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/refunds/calculate-json name: admin-api-2020-01-orders-order-id-refunds-calculate-json description: REST surface for admin-api-2020-01-orders-order_id-refunds-calculate.json. operations: - method: POST name: deprecated202001createordersparamorderidrefundscalculate description: Shopify For Multi-currency Orders call: shopify-orders.deprecated202001createordersparamorderidrefundscalculate with: order_id: rest.order_id shipping: rest.shipping refund_line_items: rest.refund_line_items currency: rest.currency body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/assigned-fulfillment-orders-json name: admin-api-2020-04-assigned-fulfillment-orders-json description: REST surface for admin-api-2020-04-assigned_fulfillment_orders.json. operations: - method: GET name: deprecated202004getassignedfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App call: shopify-orders.deprecated202004getassignedfulfillmentorders with: assignment_status: rest.assignment_status location_ids: rest.location_ids location_ids[]: rest.location_ids[] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/customers/{customer-id}/orders-json name: admin-api-2020-04-customers-customer-id-orders-json description: REST surface for admin-api-2020-04-customers-customer_id-orders.json. operations: - method: GET name: deprecated202004getcustomersparamcustomeridorders description: Shopify Retrieves All Orders Belonging To A Customer call: shopify-orders.deprecated202004getcustomersparamcustomeridorders with: customer_id: rest.customer_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/fulfillments-json name: admin-api-2020-04-fulfillments-json description: REST surface for admin-api-2020-04-fulfillments.json. operations: - method: POST name: deprecated202004createfulfillments description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders call: shopify-orders.deprecated202004createfulfillments with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders-json name: admin-api-2020-04-orders-json description: REST surface for admin-api-2020-04-orders.json. operations: - method: GET name: deprecated202004getorders description: Shopify Retrieves A List Of Orders call: shopify-orders.deprecated202004getorders with: ids: rest.ids limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max processed_at_min: rest.processed_at_min processed_at_max: rest.processed_at_max attribution_app_id: rest.attribution_app_id status: rest.status financial_status: rest.financial_status fulfillment_status: rest.fulfillment_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/cancel-json name: admin-api-2020-04-orders-order-id-cancel-json description: REST surface for admin-api-2020-04-orders-order_id-cancel.json. operations: - method: POST name: deprecated202004createordersparamorderidcancel description: Shopify For Multi-currency Orders call: shopify-orders.deprecated202004createordersparamorderidcancel with: order_id: rest.order_id amount: rest.amount currency: rest.currency ? "restock\n deprecated" : "rest.restock\n deprecated" reason: rest.reason email: rest.email refund: rest.refund body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/fulfillment-orders-json name: admin-api-2020-04-orders-order-id-fulfillment-orders-json description: REST surface for admin-api-2020-04-orders-order_id-fulfillment_orders.json. operations: - method: GET name: deprecated202004getordersparamorderidfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order call: shopify-orders.deprecated202004getordersparamorderidfulfillmentorders with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/refunds-json name: admin-api-2020-04-orders-order-id-refunds-json description: REST surface for admin-api-2020-04-orders-order_id-refunds.json. operations: - method: POST name: deprecated202004createordersparamorderidrefunds description: Shopify For Multi-currency Orders call: shopify-orders.deprecated202004createordersparamorderidrefunds with: order_id: rest.order_id ? "restock\n deprecated" : "rest.restock\n deprecated" notify: rest.notify note: rest.note discrepancy_reason: rest.discrepancy_reason shipping: rest.shipping refund_line_items: rest.refund_line_items transactions: rest.transactions currency: rest.currency body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/refunds/calculate-json name: admin-api-2020-04-orders-order-id-refunds-calculate-json description: REST surface for admin-api-2020-04-orders-order_id-refunds-calculate.json. operations: - method: POST name: deprecated202004createordersparamorderidrefundscalculate description: Shopify For Multi-currency Orders call: shopify-orders.deprecated202004createordersparamorderidrefundscalculate with: order_id: rest.order_id shipping: rest.shipping refund_line_items: rest.refund_line_items currency: rest.currency body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/assigned-fulfillment-orders-json name: admin-api-2020-07-assigned-fulfillment-orders-json description: REST surface for admin-api-2020-07-assigned_fulfillment_orders.json. operations: - method: GET name: deprecated202007getassignedfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App call: shopify-orders.deprecated202007getassignedfulfillmentorders with: assignment_status: rest.assignment_status location_ids: rest.location_ids location_ids[]: rest.location_ids[] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/customers/{customer-id}/orders-json name: admin-api-2020-07-customers-customer-id-orders-json description: REST surface for admin-api-2020-07-customers-customer_id-orders.json. operations: - method: GET name: deprecated202007getcustomersparamcustomeridorders description: Shopify Retrieves All Orders Belonging To A Customer call: shopify-orders.deprecated202007getcustomersparamcustomeridorders with: customer_id: rest.customer_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/fulfillments-json name: admin-api-2020-07-fulfillments-json description: REST surface for admin-api-2020-07-fulfillments.json. operations: - method: POST name: deprecated202007createfulfillments description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders call: shopify-orders.deprecated202007createfulfillments with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders-json name: admin-api-2020-07-orders-json description: REST surface for admin-api-2020-07-orders.json. operations: - method: GET name: deprecated202007getorders description: Shopify Retrieves A List Of Orders call: shopify-orders.deprecated202007getorders with: ids: rest.ids limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max processed_at_min: rest.processed_at_min processed_at_max: rest.processed_at_max attribution_app_id: rest.attribution_app_id status: rest.status financial_status: rest.financial_status fulfillment_status: rest.fulfillment_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/fulfillment-orders-json name: admin-api-2020-07-orders-order-id-fulfillment-orders-json description: REST surface for admin-api-2020-07-orders-order_id-fulfillment_orders.json. operations: - method: GET name: deprecated202007getordersparamorderidfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order call: shopify-orders.deprecated202007getordersparamorderidfulfillmentorders with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/refunds-json name: admin-api-2020-07-orders-order-id-refunds-json description: REST surface for admin-api-2020-07-orders-order_id-refunds.json. operations: - method: POST name: deprecated202007createordersparamorderidrefunds description: Shopify For Multi-currency Orders call: shopify-orders.deprecated202007createordersparamorderidrefunds with: order_id: rest.order_id ? "restock\n deprecated" : "rest.restock\n deprecated" notify: rest.notify note: rest.note discrepancy_reason: rest.discrepancy_reason shipping: rest.shipping refund_line_items: rest.refund_line_items transactions: rest.transactions currency: rest.currency body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/refunds/calculate-json name: admin-api-2020-07-orders-order-id-refunds-calculate-json description: REST surface for admin-api-2020-07-orders-order_id-refunds-calculate.json. operations: - method: POST name: deprecated202007createordersparamorderidrefundscalculate description: Shopify For Multi-currency Orders call: shopify-orders.deprecated202007createordersparamorderidrefundscalculate with: order_id: rest.order_id shipping: rest.shipping refund_line_items: rest.refund_line_items currency: rest.currency body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/assigned-fulfillment-orders-json name: admin-api-2020-10-assigned-fulfillment-orders-json description: REST surface for admin-api-2020-10-assigned_fulfillment_orders.json. operations: - method: GET name: getassignedfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App call: shopify-orders.getassignedfulfillmentorders with: assignment_status: rest.assignment_status location_ids: rest.location_ids location_ids[]: rest.location_ids[] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/customers/{customer-id}/orders-json name: admin-api-2020-10-customers-customer-id-orders-json description: REST surface for admin-api-2020-10-customers-customer_id-orders.json. operations: - method: GET name: getcustomersparamcustomeridorders description: Shopify Retrieves All Orders Belonging To A Customer call: shopify-orders.getcustomersparamcustomeridorders with: customer_id: rest.customer_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/fulfillments-json name: admin-api-2020-10-fulfillments-json description: REST surface for admin-api-2020-10-fulfillments.json. operations: - method: POST name: createfulfillments description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders call: shopify-orders.createfulfillments with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/fulfillment-orders-json name: admin-api-2020-10-orders-order-id-fulfillment-orders-json description: REST surface for admin-api-2020-10-orders-order_id-fulfillment_orders.json. operations: - method: GET name: getordersparamorderidfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order call: shopify-orders.getordersparamorderidfulfillmentorders with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/refunds-json name: admin-api-2020-10-orders-order-id-refunds-json description: REST surface for admin-api-2020-10-orders-order_id-refunds.json. operations: - method: POST name: createordersparamorderidrefunds description: Shopify For Multi-currency Orders call: shopify-orders.createordersparamorderidrefunds with: order_id: rest.order_id ? "restock\n deprecated" : "rest.restock\n deprecated" notify: rest.notify note: rest.note discrepancy_reason: rest.discrepancy_reason shipping: rest.shipping refund_line_items: rest.refund_line_items transactions: rest.transactions currency: rest.currency body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/refunds/calculate-json name: admin-api-2020-10-orders-order-id-refunds-calculate-json description: REST surface for admin-api-2020-10-orders-order_id-refunds-calculate.json. operations: - method: POST name: createordersparamorderidrefundscalculate description: Shopify For Multi-currency Orders call: shopify-orders.createordersparamorderidrefundscalculate with: order_id: rest.order_id shipping: rest.shipping refund_line_items: rest.refund_line_items currency: rest.currency body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/assigned-fulfillment-orders-json name: admin-api-2021-01-assigned-fulfillment-orders-json description: REST surface for admin-api-2021-01-assigned_fulfillment_orders.json. operations: - method: GET name: deprecated202101getassignedfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App call: shopify-orders.deprecated202101getassignedfulfillmentorders with: assignment_status: rest.assignment_status location_ids: rest.location_ids location_ids[]: rest.location_ids[] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/customers/{customer-id}/orders-json name: admin-api-2021-01-customers-customer-id-orders-json description: REST surface for admin-api-2021-01-customers-customer_id-orders.json. operations: - method: GET name: deprecated202101getcustomersparamcustomeridorders description: Shopify Retrieves All Orders Belonging To A Customer call: shopify-orders.deprecated202101getcustomersparamcustomeridorders with: customer_id: rest.customer_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/fulfillments-json name: admin-api-2021-01-fulfillments-json description: REST surface for admin-api-2021-01-fulfillments.json. operations: - method: POST name: deprecated202101createfulfillments description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders call: shopify-orders.deprecated202101createfulfillments with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/fulfillment-orders-json name: admin-api-2021-01-orders-order-id-fulfillment-orders-json description: REST surface for admin-api-2021-01-orders-order_id-fulfillment_orders.json. operations: - method: GET name: deprecated202101getordersparamorderidfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order call: shopify-orders.deprecated202101getordersparamorderidfulfillmentorders with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/refunds-json name: admin-api-2021-01-orders-order-id-refunds-json description: REST surface for admin-api-2021-01-orders-order_id-refunds.json. operations: - method: POST name: deprecated202101createordersparamorderidrefunds description: Shopify For Multi-currency Orders call: shopify-orders.deprecated202101createordersparamorderidrefunds with: order_id: rest.order_id ? "restock\n deprecated" : "rest.restock\n deprecated" notify: rest.notify note: rest.note discrepancy_reason: rest.discrepancy_reason shipping: rest.shipping refund_line_items: rest.refund_line_items transactions: rest.transactions currency: rest.currency body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/refunds/calculate-json name: admin-api-2021-01-orders-order-id-refunds-calculate-json description: REST surface for admin-api-2021-01-orders-order_id-refunds-calculate.json. operations: - method: POST name: deprecated202101createordersparamorderidrefundscalculate description: Shopify For Multi-currency Orders call: shopify-orders.deprecated202101createordersparamorderidrefundscalculate with: order_id: rest.order_id shipping: rest.shipping refund_line_items: rest.refund_line_items currency: rest.currency body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/assigned-fulfillment-orders-json name: admin-api-unstable-assigned-fulfillment-orders-json description: REST surface for admin-api-unstable-assigned_fulfillment_orders.json. operations: - method: GET name: deprecatedunstablegetassignedfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App call: shopify-orders.deprecatedunstablegetassignedfulfillmentorders with: assignment_status: rest.assignment_status location_ids: rest.location_ids location_ids[]: rest.location_ids[] outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/customers/{customer-id}/orders-json name: admin-api-unstable-customers-customer-id-orders-json description: REST surface for admin-api-unstable-customers-customer_id-orders.json. operations: - method: GET name: deprecatedunstablegetcustomersparamcustomeridorders description: Shopify Retrieves All Orders Belonging To A Customer call: shopify-orders.deprecatedunstablegetcustomersparamcustomeridorders with: customer_id: rest.customer_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/fulfillments-json name: admin-api-unstable-fulfillments-json description: REST surface for admin-api-unstable-fulfillments.json. operations: - method: POST name: deprecatedunstablecreatefulfillments description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders call: shopify-orders.deprecatedunstablecreatefulfillments with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/fulfillment-orders-json name: admin-api-unstable-orders-order-id-fulfillment-orders-json description: REST surface for admin-api-unstable-orders-order_id-fulfillment_orders.json. operations: - method: GET name: deprecatedunstablegetordersparamorderidfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order call: shopify-orders.deprecatedunstablegetordersparamorderidfulfillmentorders with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/refunds-json name: admin-api-unstable-orders-order-id-refunds-json description: REST surface for admin-api-unstable-orders-order_id-refunds.json. operations: - method: POST name: deprecatedunstablecreateordersparamorderidrefunds description: Shopify For Multi-currency Orders call: shopify-orders.deprecatedunstablecreateordersparamorderidrefunds with: order_id: rest.order_id ? "restock\n deprecated" : "rest.restock\n deprecated" notify: rest.notify note: rest.note discrepancy_reason: rest.discrepancy_reason shipping: rest.shipping refund_line_items: rest.refund_line_items transactions: rest.transactions currency: rest.currency body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/refunds/calculate-json name: admin-api-unstable-orders-order-id-refunds-calculate-json description: REST surface for admin-api-unstable-orders-order_id-refunds-calculate.json. operations: - method: POST name: deprecatedunstablecreateordersparamorderidrefundscalculate description: Shopify For Multi-currency Orders call: shopify-orders.deprecatedunstablecreateordersparamorderidrefundscalculate with: order_id: rest.order_id shipping: rest.shipping refund_line_items: rest.refund_line_items currency: rest.currency body: rest.body outputParameters: - type: object mapping: $. - path: /v1/fetch-tracking-numbers name: fetch-tracking-numbers description: REST surface for fetch_tracking_numbers. operations: - method: GET name: deprecatedunknownversiongetfetchtrackingnumbers description: Shopify Get Tracking Numbers For Orders call: shopify-orders.deprecatedunknownversiongetfetchtrackingnumbers with: order_names: rest.order_names shop: rest.shop outputParameters: - type: object mapping: $. - type: mcp namespace: shopify-orders-mcp port: 9090 transport: http description: MCP adapter for Shopify API — Orders. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: shopify-retrieves-list-fulfillment-orders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202001getassignedfulfillmentorders with: assignment_status: tools.assignment_status location_ids: tools.location_ids location_ids[]: tools.location_ids[] outputParameters: - type: object mapping: $. - name: shopify-retrieves-all-orders-belonging description: Shopify Retrieves All Orders Belonging To A Customer hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202001getcustomersparamcustomeridorders with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-creates-fulfillment-one-many description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202001createfulfillments with: body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-orders description: Shopify Retrieves A List Of Orders hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202001getorders with: ids: tools.ids limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max processed_at_min: tools.processed_at_min processed_at_max: tools.processed_at_max attribution_app_id: tools.attribution_app_id status: tools.status financial_status: tools.financial_status fulfillment_status: tools.fulfillment_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202001createordersparamorderidcancel with: order_id: tools.order_id amount: tools.amount currency: tools.currency ? "restock\n deprecated" : "tools.restock\n deprecated" reason: tools.reason email: tools.email refund: tools.refund body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-2 description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202001getordersparamorderidfulfillmentorders with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders-2 description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202001createordersparamorderidrefunds with: order_id: tools.order_id ? "restock\n deprecated" : "tools.restock\n deprecated" notify: tools.notify note: tools.note discrepancy_reason: tools.discrepancy_reason shipping: tools.shipping refund_line_items: tools.refund_line_items transactions: tools.transactions currency: tools.currency body: tools.body outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders-3 description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202001createordersparamorderidrefundscalculate with: order_id: tools.order_id shipping: tools.shipping refund_line_items: tools.refund_line_items currency: tools.currency body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-3 description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202004getassignedfulfillmentorders with: assignment_status: tools.assignment_status location_ids: tools.location_ids location_ids[]: tools.location_ids[] outputParameters: - type: object mapping: $. - name: shopify-retrieves-all-orders-belonging-2 description: Shopify Retrieves All Orders Belonging To A Customer hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202004getcustomersparamcustomeridorders with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-creates-fulfillment-one-many-2 description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202004createfulfillments with: body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-orders-2 description: Shopify Retrieves A List Of Orders hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202004getorders with: ids: tools.ids limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max processed_at_min: tools.processed_at_min processed_at_max: tools.processed_at_max attribution_app_id: tools.attribution_app_id status: tools.status financial_status: tools.financial_status fulfillment_status: tools.fulfillment_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders-4 description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202004createordersparamorderidcancel with: order_id: tools.order_id amount: tools.amount currency: tools.currency ? "restock\n deprecated" : "tools.restock\n deprecated" reason: tools.reason email: tools.email refund: tools.refund body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-4 description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202004getordersparamorderidfulfillmentorders with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders-5 description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202004createordersparamorderidrefunds with: order_id: tools.order_id ? "restock\n deprecated" : "tools.restock\n deprecated" notify: tools.notify note: tools.note discrepancy_reason: tools.discrepancy_reason shipping: tools.shipping refund_line_items: tools.refund_line_items transactions: tools.transactions currency: tools.currency body: tools.body outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders-6 description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202004createordersparamorderidrefundscalculate with: order_id: tools.order_id shipping: tools.shipping refund_line_items: tools.refund_line_items currency: tools.currency body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-5 description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202007getassignedfulfillmentorders with: assignment_status: tools.assignment_status location_ids: tools.location_ids location_ids[]: tools.location_ids[] outputParameters: - type: object mapping: $. - name: shopify-retrieves-all-orders-belonging-3 description: Shopify Retrieves All Orders Belonging To A Customer hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202007getcustomersparamcustomeridorders with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-creates-fulfillment-one-many-3 description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202007createfulfillments with: body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-orders-3 description: Shopify Retrieves A List Of Orders hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202007getorders with: ids: tools.ids limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max processed_at_min: tools.processed_at_min processed_at_max: tools.processed_at_max attribution_app_id: tools.attribution_app_id status: tools.status financial_status: tools.financial_status fulfillment_status: tools.fulfillment_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-6 description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202007getordersparamorderidfulfillmentorders with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders-7 description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202007createordersparamorderidrefunds with: order_id: tools.order_id ? "restock\n deprecated" : "tools.restock\n deprecated" notify: tools.notify note: tools.note discrepancy_reason: tools.discrepancy_reason shipping: tools.shipping refund_line_items: tools.refund_line_items transactions: tools.transactions currency: tools.currency body: tools.body outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders-8 description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202007createordersparamorderidrefundscalculate with: order_id: tools.order_id shipping: tools.shipping refund_line_items: tools.refund_line_items currency: tools.currency body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-7 description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App hints: readOnly: true destructive: false idempotent: true call: shopify-orders.getassignedfulfillmentorders with: assignment_status: tools.assignment_status location_ids: tools.location_ids location_ids[]: tools.location_ids[] outputParameters: - type: object mapping: $. - name: shopify-retrieves-all-orders-belonging-4 description: Shopify Retrieves All Orders Belonging To A Customer hints: readOnly: true destructive: false idempotent: true call: shopify-orders.getcustomersparamcustomeridorders with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-creates-fulfillment-one-many-4 description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.createfulfillments with: body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-8 description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-orders.getordersparamorderidfulfillmentorders with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders-9 description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.createordersparamorderidrefunds with: order_id: tools.order_id ? "restock\n deprecated" : "tools.restock\n deprecated" notify: tools.notify note: tools.note discrepancy_reason: tools.discrepancy_reason shipping: tools.shipping refund_line_items: tools.refund_line_items transactions: tools.transactions currency: tools.currency body: tools.body outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders-10 description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.createordersparamorderidrefundscalculate with: order_id: tools.order_id shipping: tools.shipping refund_line_items: tools.refund_line_items currency: tools.currency body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-9 description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202101getassignedfulfillmentorders with: assignment_status: tools.assignment_status location_ids: tools.location_ids location_ids[]: tools.location_ids[] outputParameters: - type: object mapping: $. - name: shopify-retrieves-all-orders-belonging-5 description: Shopify Retrieves All Orders Belonging To A Customer hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202101getcustomersparamcustomeridorders with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-creates-fulfillment-one-many-5 description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202101createfulfillments with: body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-10 description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecated202101getordersparamorderidfulfillmentorders with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders-11 description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202101createordersparamorderidrefunds with: order_id: tools.order_id ? "restock\n deprecated" : "tools.restock\n deprecated" notify: tools.notify note: tools.note discrepancy_reason: tools.discrepancy_reason shipping: tools.shipping refund_line_items: tools.refund_line_items transactions: tools.transactions currency: tools.currency body: tools.body outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders-12 description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecated202101createordersparamorderidrefundscalculate with: order_id: tools.order_id shipping: tools.shipping refund_line_items: tools.refund_line_items currency: tools.currency body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-11 description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecatedunstablegetassignedfulfillmentorders with: assignment_status: tools.assignment_status location_ids: tools.location_ids location_ids[]: tools.location_ids[] outputParameters: - type: object mapping: $. - name: shopify-retrieves-all-orders-belonging-6 description: Shopify Retrieves All Orders Belonging To A Customer hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecatedunstablegetcustomersparamcustomeridorders with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-creates-fulfillment-one-many-6 description: Shopify Creates A Fulfillment For One Or Many Fulfillment Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecatedunstablecreatefulfillments with: body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-12 description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecatedunstablegetordersparamorderidfulfillmentorders with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders-13 description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecatedunstablecreateordersparamorderidrefunds with: order_id: tools.order_id ? "restock\n deprecated" : "tools.restock\n deprecated" notify: tools.notify note: tools.note discrepancy_reason: tools.discrepancy_reason shipping: tools.shipping refund_line_items: tools.refund_line_items transactions: tools.transactions currency: tools.currency body: tools.body outputParameters: - type: object mapping: $. - name: shopify-multi-currency-orders-14 description: Shopify For Multi-currency Orders hints: readOnly: false destructive: false idempotent: false call: shopify-orders.deprecatedunstablecreateordersparamorderidrefundscalculate with: order_id: tools.order_id shipping: tools.shipping refund_line_items: tools.refund_line_items currency: tools.currency body: tools.body outputParameters: - type: object mapping: $. - name: shopify-get-tracking-numbers-orders description: Shopify Get Tracking Numbers For Orders hints: readOnly: true destructive: false idempotent: true call: shopify-orders.deprecatedunknownversiongetfetchtrackingnumbers with: order_names: tools.order_names shop: tools.shop outputParameters: - type: object mapping: $.