openapi: 3.1.0 info: title: Shopify Admin REST About Order API description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date. version: 2025-01 contact: name: Shopify url: https://shopify.dev/docs/api/admin-rest email: api@shopify.com license: name: Shopify API Terms url: https://www.shopify.com/legal/api-terms x-date: '2026-03-04' servers: - url: https://{store}.myshopify.com/admin/api/2025-01 description: Shopify Admin REST API variables: store: default: my-store description: The Shopify store subdomain security: - AccessToken: [] tags: - name: Order paths: /admin/api/2020-01/orders.json: post: requestBody: content: application/json: schema: {} examples: example1: value: order: line_items: - variant_id: 447654529 quantity: 1 summary: Create a simple order with only a product variant ID example2: value: order: email: foo@example.com fulfillment_status: fulfilled send_receipt: true send_fulfillment_receipt: true line_items: - variant_id: 457924702 quantity: 1 summary: Create a simple order, sending an order confirmation and a shipping confirmation to the customer example3: value: order: email: foo@example.com fulfillment_status: fulfilled line_items: - variant_id: 447654529 quantity: 1 summary: Create a simple order without sending an order receipt or a fulfillment receipt example4: value: order: email: foo@example.com fulfillment_status: fulfilled fulfillments: - location_id: 48752903 line_items: - variant_id: 447654529 quantity: 1 summary: Create a simple order and fulfill it example5: value: order: line_items: - title: Big Brown Bear Boots price: 74.99 grams: '1300' quantity: 3 tax_lines: - price: 13.5 rate: 0.06 title: State tax transactions: - kind: sale status: success amount: 238.47 total_tax: 13.5 currency: EUR summary: Create a comprehensive order example6: value: order: line_items: - title: Red Leather Coat price: 129.99 grams: '1700' quantity: 1 - title: Blue Suede Shoes price: 85.95 grams: '750' quantity: 1 taxable: false - title: Raspberry Beret price: 19.99 grams: '320' quantity: 2 tax_lines: - price: 10.2 rate: 0.06 title: State tax - price: 4.25 rate: 0.025 title: County tax total_tax: 14.45 summary: Create an order with tax lines split across taxable line items example7: value: order: line_items: - title: Clicky Keyboard price: 99.99 grams: '600' quantity: 1 tax_lines: - price: 1 rate: 0.01 title: Keyboard tax tax_lines: - price: 6 rate: 0.06 title: State tax summary: Creating an order with tax lines both on line items and on the order fails and returns an error example8: value: order: line_items: - variant_id: 447654529 quantity: 1 customer: id: 207119551 financial_status: pending summary: Create a pending order with an existing customer example9: value: order: line_items: - variant_id: 447654529 quantity: 1 customer: first_name: Paul last_name: Norman email: paul.norman@example.com billing_address: first_name: John last_name: Smith address1: 123 Fake Street phone: 555-555-5555 city: Fakecity province: Ontario country: Canada zip: K2P 1L4 shipping_address: first_name: Jane last_name: Smith address1: 123 Fake Street phone: 777-777-7777 city: Fakecity province: Ontario country: Canada zip: K2P 1L4 email: jane@example.com transactions: - kind: authorization status: success amount: 50 financial_status: partially_paid summary: Create a partially paid order with a new customer and addresses example10: value: order: line_items: - variant_id: 447654529 quantity: 1 email: jane@example.com phone: '18885551234' billing_address: first_name: John last_name: Smith address1: 123 Fake Street phone: 555-555-5555 city: Fakecity province: Ontario country: Canada zip: K2P 1L4 shipping_address: first_name: Jane last_name: Smith address1: 123 Fake Street phone: 777-777-7777 city: Fakecity province: Ontario country: Canada zip: K2P 1L4 transactions: - kind: sale status: success amount: 50 financial_status: paid discount_codes: - code: FAKE30 amount: '9.00' type: percentage summary: Create an order and apply a discount summary: Shopify Creates An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#create-2020-01 parameters: [] tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}.json: get: summary: Shopify Retrieves A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#show-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: fields description: Retrieve only certain fields, specified by a comma-separated list of fields names. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true put: requestBody: content: application/json: schema: {} examples: example1: value: order: id: 450789469 tags: External, Inbound, Outbound summary: Update an order's tags example2: value: order: id: 450789469 note: Customer contacted us about a custom engraving on this iPod summary: Add a note to order example3: value: order: id: 450789469 note_attributes: - name: colour value: red summary: Add note attributes to an order example4: value: order: id: 450789469 email: a-different@email.com summary: Change an order's email address example5: value: order: id: 450789469 phone: '+15145556677' summary: Change an order's phone number example6: value: order: id: 450789469 buyer_accepts_marketing: true summary: Change whether the buyer accepts marketing example7: value: order: id: 450789469 metafields: - key: new value: newvalue value_type: string namespace: global summary: Add a metafield to an order example8: value: order: id: 450789469 shipping_address: address1: 123 Ship Street city: Shipsville summary: Update the shipping address of an order example9: value: order: id: 450789469 customer: null summary: Remove the customer from an order summary: Shopify Updates An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#update-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202001_update_orders_param_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#destroy-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202001_delete_orders_param_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/count.json: get: summary: Shopify Retrieves An Order Count description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#count-2020-01 parameters: - in: query name: created_at_min description: 'Count orders created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count orders created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count orders last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count orders last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: status description: "Count orders of a given status.\n (default: open)\n \n open: Count open orders.\n closed: Count closed orders.\n any: Count orders of any status." schema: {} required: false - in: query name: financial_status description: "Count orders of a given financial status.\n (default: any)\n \n authorized: Count authorized orders.\n pending: Count pending orders.\n paid: Count paid orders.\n refunded: Count refunded orders.\n voided: Count voided orders.\n any: Count orders of any financial status." schema: {} required: false - in: query name: fulfillment_status description: "Filter orders by their fulfillment status.\n (default: any)\n \n shipped: Show orders that have been shipped. Returns orders with fulfillment_status of fulfilled.\n partial: Show partially shipped orders.\n unshipped: Show orders that have not yet been shipped. Returns orders with fulfillment_status of null.\n any: Show orders of any fulfillment status.\n unfulfilled: Returns orders with fulfillment_status of null or partial." schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_get_orders_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/close.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Close an order summary: Shopify Closes An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#close-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_orders_param_order_id_close x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/open.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Re-open a closed order summary: Shopify Re-opens A Closed Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#open-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_orders_param_order_id_open x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders.json: post: requestBody: content: application/json: schema: {} examples: example1: value: order: line_items: - variant_id: 447654529 quantity: 1 summary: Create a simple order with only a product variant ID example2: value: order: email: foo@example.com fulfillment_status: fulfilled send_receipt: true send_fulfillment_receipt: true line_items: - variant_id: 457924702 quantity: 1 summary: Create a simple order, sending an order confirmation and a shipping confirmation to the customer example3: value: order: email: foo@example.com fulfillment_status: fulfilled line_items: - variant_id: 447654529 quantity: 1 summary: Create a simple order without sending an order receipt or a fulfillment receipt example4: value: order: email: foo@example.com fulfillment_status: fulfilled fulfillments: - location_id: 48752903 line_items: - variant_id: 447654529 quantity: 1 summary: Create a simple order and fulfill it example5: value: order: line_items: - title: Big Brown Bear Boots price: 74.99 grams: '1300' quantity: 3 tax_lines: - price: 13.5 rate: 0.06 title: State tax transactions: - kind: sale status: success amount: 238.47 total_tax: 13.5 currency: EUR summary: Create a comprehensive order example6: value: order: line_items: - title: Red Leather Coat price: 129.99 grams: '1700' quantity: 1 - title: Blue Suede Shoes price: 85.95 grams: '750' quantity: 1 taxable: false - title: Raspberry Beret price: 19.99 grams: '320' quantity: 2 tax_lines: - price: 10.2 rate: 0.06 title: State tax - price: 4.25 rate: 0.025 title: County tax total_tax: 14.45 summary: Create an order with tax lines split across taxable line items example7: value: order: line_items: - title: Clicky Keyboard price: 99.99 grams: '600' quantity: 1 tax_lines: - price: 1 rate: 0.01 title: Keyboard tax tax_lines: - price: 6 rate: 0.06 title: State tax summary: Creating an order with tax lines both on line items and on the order fails and returns an error example8: value: order: line_items: - variant_id: 447654529 quantity: 1 customer: id: 207119551 financial_status: pending summary: Create a pending order with an existing customer example9: value: order: line_items: - variant_id: 447654529 quantity: 1 customer: first_name: Paul last_name: Norman email: paul.norman@example.com billing_address: first_name: John last_name: Smith address1: 123 Fake Street phone: 555-555-5555 city: Fakecity province: Ontario country: Canada zip: K2P 1L4 shipping_address: first_name: Jane last_name: Smith address1: 123 Fake Street phone: 777-777-7777 city: Fakecity province: Ontario country: Canada zip: K2P 1L4 email: jane@example.com transactions: - kind: authorization status: success amount: 50 financial_status: partially_paid summary: Create a partially paid order with a new customer and addresses example10: value: order: line_items: - variant_id: 447654529 quantity: 1 email: jane@example.com phone: '18885551234' billing_address: first_name: John last_name: Smith address1: 123 Fake Street phone: 555-555-5555 city: Fakecity province: Ontario country: Canada zip: K2P 1L4 shipping_address: first_name: Jane last_name: Smith address1: 123 Fake Street phone: 777-777-7777 city: Fakecity province: Ontario country: Canada zip: K2P 1L4 transactions: - kind: sale status: success amount: 50 financial_status: paid discount_codes: - code: FAKE30 amount: '9.00' type: percentage summary: Create an order and apply a discount summary: Shopify Creates An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#create-2020-04 parameters: [] tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}.json: get: summary: Shopify Retrieves A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#show-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: fields description: Retrieve only certain fields, specified by a comma-separated list of fields names. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true put: requestBody: content: application/json: schema: {} examples: example1: value: order: id: 450789469 tags: External, Inbound, Outbound summary: Update an order's tags example2: value: order: id: 450789469 note: Customer contacted us about a custom engraving on this iPod summary: Add a note to order example3: value: order: id: 450789469 note_attributes: - name: colour value: red summary: Add note attributes to an order example4: value: order: id: 450789469 email: a-different@email.com summary: Change an order's email address example5: value: order: id: 450789469 phone: '+15145556677' summary: Change an order's phone number example6: value: order: id: 450789469 buyer_accepts_marketing: true summary: Change whether the buyer accepts marketing example7: value: order: id: 450789469 metafields: - key: new value: newvalue value_type: string namespace: global summary: Add a metafield to an order example8: value: order: id: 450789469 shipping_address: address1: 123 Ship Street city: Shipsville summary: Update the shipping address of an order example9: value: order: id: 450789469 customer: null summary: Remove the customer from an order summary: Shopify Updates An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#update-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202004_update_orders_param_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#destroy-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202004_delete_orders_param_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/count.json: get: summary: Shopify Retrieves An Order Count description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#count-2020-04 parameters: - in: query name: created_at_min description: 'Count orders created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count orders created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count orders last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count orders last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: status description: "Count orders of a given status.\n (default: open)\n \n open: Count open orders.\n closed: Count closed orders.\n any: Count orders of any status." schema: {} required: false - in: query name: financial_status description: "Count orders of a given financial status.\n (default: any)\n \n authorized: Count authorized orders.\n pending: Count pending orders.\n paid: Count paid orders.\n refunded: Count refunded orders.\n voided: Count voided orders.\n any: Count orders of any financial status." schema: {} required: false - in: query name: fulfillment_status description: "Filter orders by their fulfillment status.\n (default: any)\n \n shipped: Show orders that have been shipped. Returns orders with fulfillment_status of fulfilled.\n partial: Show partially shipped orders.\n unshipped: Show orders that have not yet been shipped. Returns orders with fulfillment_status of null.\n any: Show orders of any fulfillment status.\n unfulfilled: Returns orders with fulfillment_status of null or partial." schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_get_orders_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/close.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Close an order summary: Shopify Closes An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#close-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_orders_param_order_id_close x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/open.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Re-open a closed order summary: Shopify Re-opens A Closed Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#open-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_orders_param_order_id_open x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/risks.json: post: requestBody: content: application/json: schema: {} examples: example1: value: risk: message: This order came from an anonymous proxy recommendation: cancel score: 1 source: External cause_cancel: true display: true summary: Create an order risk showing a fraud risk for proxy detection summary: Shopify Creates An Order Risk For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true get: summary: Shopify Retrieves A List Of All Order Risks For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json: get: summary: Shopify Retrieves A Single Order Risk By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true put: requestBody: content: application/json: schema: {} examples: example1: value: risk: id: 284138680 message: After further review, this is a legitimate order recommendation: accept source: External cause_cancel: false score: 0 summary: Update an existing order risk for an order summary: Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_202001_update_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_202001_delete_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/risks.json: post: requestBody: content: application/json: schema: {} examples: example1: value: risk: message: This order came from an anonymous proxy recommendation: cancel score: 1 source: External cause_cancel: true display: true summary: Create an order risk showing a fraud risk for proxy detection summary: Shopify Creates An Order Risk For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true get: summary: Shopify Retrieves A List Of All Order Risks For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json: get: summary: Shopify Retrieves A Single Order Risk By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true put: requestBody: content: application/json: schema: {} examples: example1: value: risk: id: 284138680 message: After further review, this is a legitimate order recommendation: accept source: External cause_cancel: false score: 0 summary: Update an existing order risk for an order summary: Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_202004_update_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_202004_delete_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/risks.json: post: requestBody: content: application/json: schema: {} examples: example1: value: risk: message: This order came from an anonymous proxy recommendation: cancel score: 1 source: External cause_cancel: true display: true summary: Create an order risk showing a fraud risk for proxy detection summary: Shopify Creates An Order Risk For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202007_create_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true get: summary: Shopify Retrieves A List Of All Order Risks For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json: get: summary: Shopify Retrieves A Single Order Risk By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true put: requestBody: content: application/json: schema: {} examples: example1: value: risk: id: 284138680 message: After further review, this is a legitimate order recommendation: accept source: External cause_cancel: false score: 0 summary: Update an existing order risk for an order summary: Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_202007_update_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_202007_delete_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/risks.json: post: requestBody: content: application/json: schema: {} examples: example1: value: risk: message: This order came from an anonymous proxy recommendation: cancel score: 1 source: External cause_cancel: true display: true summary: Create an order risk showing a fraud risk for proxy detection summary: Shopify Creates An Order Risk For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: create_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true get: summary: Shopify Retrieves A List Of All Order Risks For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: get_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/risks/{risk_id}.json: get: summary: Shopify Retrieves A Single Order Risk By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: get_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true put: requestBody: content: application/json: schema: {} examples: example1: value: risk: id: 284138680 message: After further review, this is a legitimate order recommendation: accept source: External cause_cancel: false score: 0 summary: Update an existing order risk for an order summary: Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: update_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: delete_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/risks.json: post: requestBody: content: application/json: schema: {} examples: example1: value: risk: message: This order came from an anonymous proxy recommendation: cancel score: 1 source: External cause_cancel: true display: true summary: Create an order risk showing a fraud risk for proxy detection summary: Shopify Creates An Order Risk For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true get: summary: Shopify Retrieves A List Of All Order Risks For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/risks/{risk_id}.json: get: summary: Shopify Retrieves A Single Order Risk By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true put: requestBody: content: application/json: schema: {} examples: example1: value: risk: id: 284138680 message: After further review, this is a legitimate order recommendation: accept source: External cause_cancel: false score: 0 summary: Update an existing order risk for an order summary: Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_202101_update_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_202101_delete_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/risks.json: post: requestBody: content: application/json: schema: {} examples: example1: value: risk: message: This order came from an anonymous proxy recommendation: cancel score: 1 source: External cause_cancel: true display: true summary: Create an order risk showing a fraud risk for proxy detection summary: Shopify Creates An Order Risk For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true get: summary: Shopify Retrieves A List Of All Order Risks For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/risks/{risk_id}.json: get: summary: Shopify Retrieves A Single Order Risk By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true put: requestBody: content: application/json: schema: {} examples: example1: value: risk: id: 284138680 message: After further review, this is a legitimate order recommendation: accept source: External cause_cancel: false score: 0 summary: Update an existing order risk for an order summary: Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_unstable_update_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Order responses: '200': description: '' operationId: deprecated_unstable_delete_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/refunds.json: get: summary: Shopify Retrieves A List Of Refunds For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_refunds x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/refunds.json: get: summary: Shopify Retrieves A List Of Refunds For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_refunds x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/refunds.json: get: summary: Shopify Retrieves A List Of Refunds For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_refunds x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/refunds.json: get: summary: Shopify Retrieves A List Of Refunds For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Order responses: '200': description: '' operationId: get_orders_param_order_id_refunds x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/refunds.json: get: summary: Shopify Retrieves A List Of Refunds For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_refunds x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/refunds.json: get: summary: Shopify Retrieves A List Of Refunds For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_refunds x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: The customer changed his mind. summary: Sends a cancellation request to the fulfillment service of a fulfillment order and updates the fulfillment order summary: Shopify Sends A Cancellation Request To The Fulfillment Service Of A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#create-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: We had not started any processing yet. summary: Accepts a cancellation request sent to a fulfillment service and updates the fulfillment order summary: Shopify Accepts A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#accept-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for accepting the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request_accept x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: We have already send the shipment out. summary: Rejects a cancellation request sent to a fulfillment service and updates the fulfillment order summary: Shopify Rejects A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#reject-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for rejecting the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request_reject x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: The customer changed his mind. summary: Sends a cancellation request to the fulfillment service of a fulfillment order and updates the fulfillment order summary: Shopify Sends A Cancellation Request To The Fulfillment Service Of A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#create-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: We had not started any processing yet. summary: Accepts a cancellation request sent to a fulfillment service and updates the fulfillment order summary: Shopify Accepts A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#accept-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for accepting the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request_accept x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: We have already send the shipment out. summary: Rejects a cancellation request sent to a fulfillment service and updates the fulfillment order summary: Shopify Rejects A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#reject-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for rejecting the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request_reject x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: The customer changed his mind. summary: Sends a cancellation request to the fulfillment service of a fulfillment order and updates the fulfillment order summary: Shopify Sends A Cancellation Request To The Fulfillment Service Of A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#create-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: We had not started any processing yet. summary: Accepts a cancellation request sent to a fulfillment service and updates the fulfillment order summary: Shopify Accepts A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#accept-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for accepting the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request_accept x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: We have already send the shipment out. summary: Rejects a cancellation request sent to a fulfillment service and updates the fulfillment order summary: Shopify Rejects A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#reject-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for rejecting the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request_reject x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: The customer changed his mind. summary: Sends a cancellation request to the fulfillment service of a fulfillment order and updates the fulfillment order summary: Shopify Sends A Cancellation Request To The Fulfillment Service Of A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#create-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: create_fulfillment_orders_param_fulfillment_order_id_cancellation_request x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: We had not started any processing yet. summary: Accepts a cancellation request sent to a fulfillment service and updates the fulfillment order summary: Shopify Accepts A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#accept-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for accepting the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: create_fulfillment_orders_param_fulfillment_order_id_cancellation_request_accept x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: We have already send the shipment out. summary: Rejects a cancellation request sent to a fulfillment service and updates the fulfillment order summary: Shopify Rejects A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#reject-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for rejecting the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: create_fulfillment_orders_param_fulfillment_order_id_cancellation_request_reject x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: The customer changed his mind. summary: Sends a cancellation request to the fulfillment service of a fulfillment order and updates the fulfillment order summary: Shopify Sends A Cancellation Request To The Fulfillment Service Of A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#create-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: We had not started any processing yet. summary: Accepts a cancellation request sent to a fulfillment service and updates the fulfillment order summary: Shopify Accepts A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#accept-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for accepting the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request_accept x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: We have already send the shipment out. summary: Rejects a cancellation request sent to a fulfillment service and updates the fulfillment order summary: Shopify Rejects A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#reject-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for rejecting the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request_reject x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: The customer changed his mind. summary: Sends a cancellation request to the fulfillment service of a fulfillment order and updates the fulfillment order summary: Shopify Sends A Cancellation Request To The Fulfillment Service Of A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#create-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: We had not started any processing yet. summary: Accepts a cancellation request sent to a fulfillment service and updates the fulfillment order summary: Shopify Accepts A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#accept-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for accepting the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request_accept x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json: post: requestBody: content: application/json: schema: {} examples: example1: value: cancellation_request: message: We have already send the shipment out. summary: Rejects a cancellation request sent to a fulfillment service and updates the fulfillment order summary: Shopify Rejects A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#reject-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for rejecting the cancellation request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_fulfillment_orders_param_fulfillment_order_id_cancellation_request_reject x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With An Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_max description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false - in: query name: limit description: "Limit the amount of results.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: updated_at_max description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment: location_id: 487838322 tracking_number: '123456789' tracking_urls: - https://shipping.xyz/track.php?num=123456789 - https://anothershipper.corp/track.php?code=abc notify_customer: true summary: Fulfill all line items for an order and send the shipping confirmation email. Not specifying line item IDs causes all unfulfilled and partially fulfilled line items for the order to be fulfilled. example2: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill line items without a tracking number example3: value: fulfillment: location_id: 905684977 tracking_numbers: - 04263ac9875a5cdc27996db6865a3e91 - 74a62cd540170b8ef633f90d584daadf - d9d423437dc58dbb54a76908573239bc line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill all line items for an order with multiple tracking numbers example4: value: fulfillment: location_id: 905684977 tracking_url: http://www.packagetrackr.com/track/somecarrier/1234567 tracking_company: Jack Black's Pack, Stack and Track line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill all line items for an order and use a custom tracking URL and company example5: value: fulfillment: tracking_url: http://www.packagetrackr.com/track/somecarrier/1234567 tracking_company: Jack Black's Pack, Stack and Track line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill without a location_id results in a bad request example6: value: fulfillment: location_id: 905684977 tracking_number: '123456789' tracking_company: 4PX line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company (generates tracking URL) example7: value: fulfillment: location_id: 905684977 tracking_number: '123456789010' tracking_company: fed ex line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company in an incorrect format (uses fuzzy matches to generate tracking URL, but respects tracking company supplied) example8: value: fulfillment: location_id: 905684977 tracking_number: '123456789010' tracking_company: fed ex tracking_url: https://www.new-fedex-tracking.com/?number=123456789010 line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company in an incorrect format and custom tracking URL (respects sent URL) example9: value: fulfillment: location_id: 905684977 tracking_number: RR123456789CN tracking_company: Chinese Post line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a non-supported tracking company without a tracking URL (generates best guess URL if number matches recognizable pattern) example10: value: fulfillment: location_id: 905684977 tracking_number: '1234567' tracking_company: Custom Tracking Company line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a non-supported tracking company without a tracking URL. Does not generate a URL if tracking number does not match a recognizable pattern. example11: value: fulfillment: location_id: 905684977 tracking_number: CJ274101086US tracking_url: http://www.custom-tracking.com/?tracking_number=CJ274101086US line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using only a tracking number and a custom tracking URL (respects tracking URL but attempts to generate tracking company if number matches recognizable pattern) example12: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 518995019 summary: Fulfill a single line item by explicitly specifying the line items to be fulfilled example13: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 518995019 quantity: 1 summary: Partially fulfill a single line item by specifying a line item and quantity to be fulfilled summary: Shopify Create A Fulfillment For The Specified Order And Line Items description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#create-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order that is associated with the fulfillments. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_get_fulfillment_orders_param_fulfillment_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/fulfillments/count.json: get: summary: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_min description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_fulfillments_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment for a specific order ID summary: Shopify Cancel A Fulfillment For A Specific Order Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_orders_param_order_id_fulfillments_param_fulfillment_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With An Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_max description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false - in: query name: limit description: "Limit the amount of results.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: updated_at_max description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment: location_id: 487838322 tracking_number: '123456789' tracking_urls: - https://shipping.xyz/track.php?num=123456789 - https://anothershipper.corp/track.php?code=abc notify_customer: true summary: Fulfill all line items for an order and send the shipping confirmation email. Not specifying line item IDs causes all unfulfilled and partially fulfilled line items for the order to be fulfilled. example2: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill line items without a tracking number example3: value: fulfillment: location_id: 905684977 tracking_numbers: - 04263ac9875a5cdc27996db6865a3e91 - 74a62cd540170b8ef633f90d584daadf - d9d423437dc58dbb54a76908573239bc line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill all line items for an order with multiple tracking numbers example4: value: fulfillment: location_id: 905684977 tracking_url: http://www.packagetrackr.com/track/somecarrier/1234567 tracking_company: Jack Black's Pack, Stack and Track line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill all line items for an order and use a custom tracking URL and company example5: value: fulfillment: tracking_url: http://www.packagetrackr.com/track/somecarrier/1234567 tracking_company: Jack Black's Pack, Stack and Track line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill without a location_id results in a bad request example6: value: fulfillment: location_id: 905684977 tracking_number: '123456789' tracking_company: 4PX line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company (generates tracking URL) example7: value: fulfillment: location_id: 905684977 tracking_number: '123456789010' tracking_company: fed ex line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company in an incorrect format (uses fuzzy matches to generate tracking URL, but respects tracking company supplied) example8: value: fulfillment: location_id: 905684977 tracking_number: '123456789010' tracking_company: fed ex tracking_url: https://www.new-fedex-tracking.com/?number=123456789010 line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company in an incorrect format and custom tracking URL (respects sent URL) example9: value: fulfillment: location_id: 905684977 tracking_number: RR123456789CN tracking_company: Chinese Post line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a non-supported tracking company without a tracking URL (generates best guess URL if number matches recognizable pattern) example10: value: fulfillment: location_id: 905684977 tracking_number: '1234567' tracking_company: Custom Tracking Company line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a non-supported tracking company without a tracking URL. Does not generate a URL if tracking number does not match a recognizable pattern. example11: value: fulfillment: location_id: 905684977 tracking_number: CJ274101086US tracking_url: http://www.custom-tracking.com/?tracking_number=CJ274101086US line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using only a tracking number and a custom tracking URL (respects tracking URL but attempts to generate tracking company if number matches recognizable pattern) example12: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 518995019 summary: Fulfill a single line item by explicitly specifying the line items to be fulfilled example13: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 518995019 quantity: 1 summary: Partially fulfill a single line item by specifying a line item and quantity to be fulfilled summary: Shopify Create A Fulfillment For The Specified Order And Line Items description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#create-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order that is associated with the fulfillments. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_get_fulfillment_orders_param_fulfillment_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/fulfillments/count.json: get: summary: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_min description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_fulfillments_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment for a specific order ID summary: Shopify Cancel A Fulfillment For A Specific Order Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_orders_param_order_id_fulfillments_param_fulfillment_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With An Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_max description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false - in: query name: limit description: "Limit the amount of results.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: updated_at_max description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment: location_id: 487838322 tracking_number: '123456789' tracking_urls: - https://shipping.xyz/track.php?num=123456789 - https://anothershipper.corp/track.php?code=abc notify_customer: true summary: Fulfill all line items for an order and send the shipping confirmation email. Not specifying line item IDs causes all unfulfilled and partially fulfilled line items for the order to be fulfilled. example2: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill line items without a tracking number example3: value: fulfillment: location_id: 905684977 tracking_numbers: - 04263ac9875a5cdc27996db6865a3e91 - 74a62cd540170b8ef633f90d584daadf - d9d423437dc58dbb54a76908573239bc line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill all line items for an order with multiple tracking numbers example4: value: fulfillment: location_id: 905684977 tracking_url: http://www.packagetrackr.com/track/somecarrier/1234567 tracking_company: Jack Black's Pack, Stack and Track line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill all line items for an order and use a custom tracking URL and company example5: value: fulfillment: tracking_url: http://www.packagetrackr.com/track/somecarrier/1234567 tracking_company: Jack Black's Pack, Stack and Track line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill without a location_id results in a bad request example6: value: fulfillment: location_id: 905684977 tracking_number: '123456789' tracking_company: 4PX line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company (generates tracking URL) example7: value: fulfillment: location_id: 905684977 tracking_number: '123456789010' tracking_company: fed ex line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company in an incorrect format (uses fuzzy matches to generate tracking URL, but respects tracking company supplied) example8: value: fulfillment: location_id: 905684977 tracking_number: '123456789010' tracking_company: fed ex tracking_url: https://www.new-fedex-tracking.com/?number=123456789010 line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company in an incorrect format and custom tracking URL (respects sent URL) example9: value: fulfillment: location_id: 905684977 tracking_number: RR123456789CN tracking_company: Chinese Post line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a non-supported tracking company without a tracking URL (generates best guess URL if number matches recognizable pattern) example10: value: fulfillment: location_id: 905684977 tracking_number: '1234567' tracking_company: Custom Tracking Company line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a non-supported tracking company without a tracking URL. Does not generate a URL if tracking number does not match a recognizable pattern. example11: value: fulfillment: location_id: 905684977 tracking_number: CJ274101086US tracking_url: http://www.custom-tracking.com/?tracking_number=CJ274101086US line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using only a tracking number and a custom tracking URL (respects tracking URL but attempts to generate tracking company if number matches recognizable pattern) example12: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 518995019 summary: Fulfill a single line item by explicitly specifying the line items to be fulfilled example13: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 518995019 quantity: 1 summary: Partially fulfill a single line item by specifying a line item and quantity to be fulfilled summary: Shopify Create A Fulfillment For The Specified Order And Line Items description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#create-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202007_create_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order that is associated with the fulfillments. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_get_fulfillment_orders_param_fulfillment_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/fulfillments/count.json: get: summary: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_min description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_fulfillments_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment for a specific order ID summary: Shopify Cancel A Fulfillment For A Specific Order Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id tags: - Order responses: '200': description: '' operationId: deprecated_202007_create_orders_param_order_id_fulfillments_param_fulfillment_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With An Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_max description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false - in: query name: limit description: "Limit the amount of results.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: updated_at_max description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Order responses: '200': description: '' operationId: get_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment: location_id: 487838322 tracking_number: '123456789' tracking_urls: - https://shipping.xyz/track.php?num=123456789 - https://anothershipper.corp/track.php?code=abc notify_customer: true summary: Fulfill all line items for an order and send the shipping confirmation email. Not specifying line item IDs causes all unfulfilled and partially fulfilled line items for the order to be fulfilled. example2: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill line items without a tracking number example3: value: fulfillment: location_id: 905684977 tracking_numbers: - 04263ac9875a5cdc27996db6865a3e91 - 74a62cd540170b8ef633f90d584daadf - d9d423437dc58dbb54a76908573239bc line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill all line items for an order with multiple tracking numbers example4: value: fulfillment: location_id: 905684977 tracking_url: http://www.packagetrackr.com/track/somecarrier/1234567 tracking_company: Jack Black's Pack, Stack and Track line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill all line items for an order and use a custom tracking URL and company example5: value: fulfillment: tracking_url: http://www.packagetrackr.com/track/somecarrier/1234567 tracking_company: Jack Black's Pack, Stack and Track line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill without a location_id results in a bad request example6: value: fulfillment: location_id: 905684977 tracking_number: '123456789' tracking_company: 4PX line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company (generates tracking URL) example7: value: fulfillment: location_id: 905684977 tracking_number: '123456789010' tracking_company: fed ex line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company in an incorrect format (uses fuzzy matches to generate tracking URL, but respects tracking company supplied) example8: value: fulfillment: location_id: 905684977 tracking_number: '123456789010' tracking_company: fed ex tracking_url: https://www.new-fedex-tracking.com/?number=123456789010 line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company in an incorrect format and custom tracking URL (respects sent URL) example9: value: fulfillment: location_id: 905684977 tracking_number: RR123456789CN tracking_company: Chinese Post line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a non-supported tracking company without a tracking URL (generates best guess URL if number matches recognizable pattern) example10: value: fulfillment: location_id: 905684977 tracking_number: '1234567' tracking_company: Custom Tracking Company line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a non-supported tracking company without a tracking URL. Does not generate a URL if tracking number does not match a recognizable pattern. example11: value: fulfillment: location_id: 905684977 tracking_number: CJ274101086US tracking_url: http://www.custom-tracking.com/?tracking_number=CJ274101086US line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using only a tracking number and a custom tracking URL (respects tracking URL but attempts to generate tracking company if number matches recognizable pattern) example12: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 518995019 summary: Fulfill a single line item by explicitly specifying the line items to be fulfilled example13: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 518995019 quantity: 1 summary: Partially fulfill a single line item by specifying a line item and quantity to be fulfilled summary: Shopify Create A Fulfillment For The Specified Order And Line Items description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#create-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: create_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order that is associated with the fulfillments. schema: {} required: false tags: - Order responses: '200': description: '' operationId: get_fulfillment_orders_param_fulfillment_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/fulfillments/count.json: get: summary: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_min description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Order responses: '200': description: '' operationId: get_orders_param_order_id_fulfillments_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment for a specific order ID summary: Shopify Cancel A Fulfillment For A Specific Order Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id tags: - Order responses: '200': description: '' operationId: create_orders_param_order_id_fulfillments_param_fulfillment_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With An Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_max description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false - in: query name: limit description: "Limit the amount of results.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: updated_at_max description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment: location_id: 487838322 tracking_number: '123456789' tracking_urls: - https://shipping.xyz/track.php?num=123456789 - https://anothershipper.corp/track.php?code=abc notify_customer: true summary: Fulfill all line items for an order and send the shipping confirmation email. Not specifying line item IDs causes all unfulfilled and partially fulfilled line items for the order to be fulfilled. example2: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill line items without a tracking number example3: value: fulfillment: location_id: 905684977 tracking_numbers: - 04263ac9875a5cdc27996db6865a3e91 - 74a62cd540170b8ef633f90d584daadf - d9d423437dc58dbb54a76908573239bc line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill all line items for an order with multiple tracking numbers example4: value: fulfillment: location_id: 905684977 tracking_url: http://www.packagetrackr.com/track/somecarrier/1234567 tracking_company: Jack Black's Pack, Stack and Track line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill all line items for an order and use a custom tracking URL and company example5: value: fulfillment: tracking_url: http://www.packagetrackr.com/track/somecarrier/1234567 tracking_company: Jack Black's Pack, Stack and Track line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill without a location_id results in a bad request example6: value: fulfillment: location_id: 905684977 tracking_number: '123456789' tracking_company: 4PX line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company (generates tracking URL) example7: value: fulfillment: location_id: 905684977 tracking_number: '123456789010' tracking_company: fed ex line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company in an incorrect format (uses fuzzy matches to generate tracking URL, but respects tracking company supplied) example8: value: fulfillment: location_id: 905684977 tracking_number: '123456789010' tracking_company: fed ex tracking_url: https://www.new-fedex-tracking.com/?number=123456789010 line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company in an incorrect format and custom tracking URL (respects sent URL) example9: value: fulfillment: location_id: 905684977 tracking_number: RR123456789CN tracking_company: Chinese Post line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a non-supported tracking company without a tracking URL (generates best guess URL if number matches recognizable pattern) example10: value: fulfillment: location_id: 905684977 tracking_number: '1234567' tracking_company: Custom Tracking Company line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a non-supported tracking company without a tracking URL. Does not generate a URL if tracking number does not match a recognizable pattern. example11: value: fulfillment: location_id: 905684977 tracking_number: CJ274101086US tracking_url: http://www.custom-tracking.com/?tracking_number=CJ274101086US line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using only a tracking number and a custom tracking URL (respects tracking URL but attempts to generate tracking company if number matches recognizable pattern) example12: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 518995019 summary: Fulfill a single line item by explicitly specifying the line items to be fulfilled example13: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 518995019 quantity: 1 summary: Partially fulfill a single line item by specifying a line item and quantity to be fulfilled summary: Shopify Create A Fulfillment For The Specified Order And Line Items description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#create-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order that is associated with the fulfillments. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_get_fulfillment_orders_param_fulfillment_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/fulfillments/count.json: get: summary: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_min description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_fulfillments_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment for a specific order ID summary: Shopify Cancel A Fulfillment For A Specific Order Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_orders_param_order_id_fulfillments_param_fulfillment_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With An Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_max description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false - in: query name: limit description: "Limit the amount of results.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: updated_at_max description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment: location_id: 487838322 tracking_number: '123456789' tracking_urls: - https://shipping.xyz/track.php?num=123456789 - https://anothershipper.corp/track.php?code=abc notify_customer: true summary: Fulfill all line items for an order and send the shipping confirmation email. Not specifying line item IDs causes all unfulfilled and partially fulfilled line items for the order to be fulfilled. example2: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill line items without a tracking number example3: value: fulfillment: location_id: 905684977 tracking_numbers: - 04263ac9875a5cdc27996db6865a3e91 - 74a62cd540170b8ef633f90d584daadf - d9d423437dc58dbb54a76908573239bc line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill all line items for an order with multiple tracking numbers example4: value: fulfillment: location_id: 905684977 tracking_url: http://www.packagetrackr.com/track/somecarrier/1234567 tracking_company: Jack Black's Pack, Stack and Track line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill all line items for an order and use a custom tracking URL and company example5: value: fulfillment: tracking_url: http://www.packagetrackr.com/track/somecarrier/1234567 tracking_company: Jack Black's Pack, Stack and Track line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill without a location_id results in a bad request example6: value: fulfillment: location_id: 905684977 tracking_number: '123456789' tracking_company: 4PX line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company (generates tracking URL) example7: value: fulfillment: location_id: 905684977 tracking_number: '123456789010' tracking_company: fed ex line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company in an incorrect format (uses fuzzy matches to generate tracking URL, but respects tracking company supplied) example8: value: fulfillment: location_id: 905684977 tracking_number: '123456789010' tracking_company: fed ex tracking_url: https://www.new-fedex-tracking.com/?number=123456789010 line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a supported tracking company in an incorrect format and custom tracking URL (respects sent URL) example9: value: fulfillment: location_id: 905684977 tracking_number: RR123456789CN tracking_company: Chinese Post line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a non-supported tracking company without a tracking URL (generates best guess URL if number matches recognizable pattern) example10: value: fulfillment: location_id: 905684977 tracking_number: '1234567' tracking_company: Custom Tracking Company line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using a non-supported tracking company without a tracking URL. Does not generate a URL if tracking number does not match a recognizable pattern. example11: value: fulfillment: location_id: 905684977 tracking_number: CJ274101086US tracking_url: http://www.custom-tracking.com/?tracking_number=CJ274101086US line_items: - id: 466157049 - id: 518995019 - id: 703073504 summary: Fulfill an order using only a tracking number and a custom tracking URL (respects tracking URL but attempts to generate tracking company if number matches recognizable pattern) example12: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 518995019 summary: Fulfill a single line item by explicitly specifying the line items to be fulfilled example13: value: fulfillment: location_id: 905684977 tracking_number: null line_items: - id: 518995019 quantity: 1 summary: Partially fulfill a single line item by specifying a line item and quantity to be fulfilled summary: Shopify Create A Fulfillment For The Specified Order And Line Items description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#create-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order that is associated with the fulfillments. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_get_fulfillment_orders_param_fulfillment_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/fulfillments/count.json: get: summary: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_min description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_fulfillments_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment for a specific order ID summary: Shopify Cancel A Fulfillment For A Specific Order Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_orders_param_order_id_fulfillments_param_fulfillment_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: order_id description: The ID of the order that is associated with the fulfillment orders. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_202001_get_fulfillment_orders_param_fulfillment_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment order summary: Shopify Marks A Fulfillment Order As Cancelled description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#cancel-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_fulfillment_orders_param_fulfillment_order_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/close.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: message: Not enough inventory to complete this work. summary: Transition a fulfillment order from in progress to incomplete summary: Shopify Marks An In Progress Fulfillment Order As Incomplete description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for marking the fulfillment order as incomplete. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_fulfillment_orders_param_fulfillment_order_id_close x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/move.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: new_location_id: 905684977 summary: Move a fulfillment order to a new location summary: Shopify Moves A Fulfillment Order From One Merchant Managed Location To Another Merchant Managed Location description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#move-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: new_location_id description: The id of the location to which the fulfillment order will be moved. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_fulfillment_orders_param_fulfillment_order_id_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: order_id description: The ID of the order that is associated with the fulfillment orders. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_202004_get_fulfillment_orders_param_fulfillment_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment order summary: Shopify Marks A Fulfillment Order As Cancelled description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#cancel-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_fulfillment_orders_param_fulfillment_order_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/close.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: message: Not enough inventory to complete this work. summary: Transition a fulfillment order from in progress to incomplete summary: Shopify Marks An In Progress Fulfillment Order As Incomplete description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for marking the fulfillment order as incomplete. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_fulfillment_orders_param_fulfillment_order_id_close x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/move.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: new_location_id: 905684977 summary: Move a fulfillment order to a new location summary: Shopify Moves A Fulfillment Order From One Merchant Managed Location To Another Merchant Managed Location description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#move-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: new_location_id description: The id of the location to which the fulfillment order will be moved. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_fulfillment_orders_param_fulfillment_order_id_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: order_id description: The ID of the order that is associated with the fulfillment orders. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_202007_get_fulfillment_orders_param_fulfillment_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment order summary: Shopify Marks A Fulfillment Order As Cancelled description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#cancel-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_202007_create_fulfillment_orders_param_fulfillment_order_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/close.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: message: Not enough inventory to complete this work. summary: Transition a fulfillment order from in progress to incomplete summary: Shopify Marks An In Progress Fulfillment Order As Incomplete description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for marking the fulfillment order as incomplete. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_create_fulfillment_orders_param_fulfillment_order_id_close x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/move.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: new_location_id: 905684977 summary: Move a fulfillment order to a new location summary: Shopify Moves A Fulfillment Order From One Merchant Managed Location To Another Merchant Managed Location description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#move-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: new_location_id description: The id of the location to which the fulfillment order will be moved. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_create_fulfillment_orders_param_fulfillment_order_id_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: order_id description: The ID of the order that is associated with the fulfillment orders. schema: {} required: false tags: - Order responses: '200': description: '' operationId: get_orders_param_order_id_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: get_fulfillment_orders_param_fulfillment_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment order summary: Shopify Marks A Fulfillment Order As Cancelled description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#cancel-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: create_fulfillment_orders_param_fulfillment_order_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/close.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: message: Not enough inventory to complete this work. summary: Transition a fulfillment order from in progress to incomplete summary: Shopify Marks An In Progress Fulfillment Order As Incomplete description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for marking the fulfillment order as incomplete. schema: {} required: false tags: - Order responses: '200': description: '' operationId: create_fulfillment_orders_param_fulfillment_order_id_close x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/move.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: new_location_id: 905684977 summary: Move a fulfillment order to a new location summary: Shopify Moves A Fulfillment Order From One Merchant Managed Location To Another Merchant Managed Location description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#move-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: new_location_id description: The id of the location to which the fulfillment order will be moved. schema: {} required: false tags: - Order responses: '200': description: '' operationId: create_fulfillment_orders_param_fulfillment_order_id_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: order_id description: The ID of the order that is associated with the fulfillment orders. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_202101_get_fulfillment_orders_param_fulfillment_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment order summary: Shopify Marks A Fulfillment Order As Cancelled description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#cancel-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_fulfillment_orders_param_fulfillment_order_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/close.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: message: Not enough inventory to complete this work. summary: Transition a fulfillment order from in progress to incomplete summary: Shopify Marks An In Progress Fulfillment Order As Incomplete description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for marking the fulfillment order as incomplete. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_fulfillment_orders_param_fulfillment_order_id_close x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/move.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: new_location_id: 905684977 summary: Move a fulfillment order to a new location summary: Shopify Moves A Fulfillment Order From One Merchant Managed Location To Another Merchant Managed Location description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#move-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: new_location_id description: The id of the location to which the fulfillment order will be moved. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_fulfillment_orders_param_fulfillment_order_id_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/open.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Transition a fulfillment order from scheduled to open summary: Shopify Marks A Scheduled Fulfillment Order As Ready For Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#open-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_fulfillment_orders_param_fulfillment_order_id_open x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/reschedule.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: new_fulfill_at: '2021-12-05' summary: Update the fulfill_at time of a scheduled fulfillment order summary: Shopify Updates The Fulfill_at Time Of A Scheduled Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#reschedule-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_fulfillment_orders_param_fulfillment_order_id_reschedule x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: order_id description: The ID of the order that is associated with the fulfillment orders. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_unstable_get_fulfillment_orders_param_fulfillment_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment order summary: Shopify Marks A Fulfillment Order As Cancelled description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#cancel-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_fulfillment_orders_param_fulfillment_order_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/release_hold.json: post: requestBody: content: application/json: schema: {} examples: example1: value: order_id: 450789469 summary: Release the holds on the fulfillment orders for a specific order summary: Shopify Releases The Fulfillment Order Holds For A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#release_hold-unstable parameters: - in: query name: order_id description: The ID of the order that is associated to the fulfillment orders. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_fulfillment_orders_release_hold x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/close.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: message: Not enough inventory to complete this work. summary: Transition a fulfillment order from in progress to incomplete summary: Shopify Marks An In Progress Fulfillment Order As Incomplete description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for marking the fulfillment order as incomplete. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_fulfillment_orders_param_fulfillment_order_id_close x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/move.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: new_location_id: 905684977 summary: Move a fulfillment order to a new location summary: Shopify Moves A Fulfillment Order From One Merchant Managed Location To Another Merchant Managed Location description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#move-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: new_location_id description: The id of the location to which the fulfillment order will be moved. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_fulfillment_orders_param_fulfillment_order_id_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/open.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Transition a fulfillment order from scheduled to open summary: Shopify Marks A Scheduled Fulfillment Order As Ready For Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#open-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_fulfillment_orders_param_fulfillment_order_id_open x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/reschedule.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_order: new_fulfill_at: '2021-12-05' summary: Update the fulfill_at time of a scheduled fulfillment order summary: Shopify Updates The Fulfill_at Time Of A Scheduled Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#reschedule-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_fulfillment_orders_param_fulfillment_order_id_reschedule x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: Fulfill this ASAP please. fulfillment_order_line_items: - id: 1025578671 quantity: 1 - id: 1025578672 quantity: 1 summary: Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items example2: value: fulfillment_request: message: Fulfill this ASAP please. summary: Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank summary: Shopify Sends A Fulfillment Request To The Fulfillment Service Of A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#create-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional message for the fulfillment request. schema: {} required: false - in: query name: fulfillment_order_line_items description: The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: We will start processing your fulfillment on the next business day. summary: Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order summary: Shopify Accepts A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#accept-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for accepting the fulfillment request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request_accept x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: Not enough inventory on hand to complete the work. summary: Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order summary: Shopify Rejects A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#reject-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for rejecting the fulfillment request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request_reject x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: Fulfill this ASAP please. fulfillment_order_line_items: - id: 1025578671 quantity: 1 - id: 1025578672 quantity: 1 summary: Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items example2: value: fulfillment_request: message: Fulfill this ASAP please. summary: Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank summary: Shopify Sends A Fulfillment Request To The Fulfillment Service Of A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#create-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional message for the fulfillment request. schema: {} required: false - in: query name: fulfillment_order_line_items description: The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: We will start processing your fulfillment on the next business day. summary: Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order summary: Shopify Accepts A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#accept-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for accepting the fulfillment request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request_accept x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: Not enough inventory on hand to complete the work. summary: Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order summary: Shopify Rejects A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#reject-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for rejecting the fulfillment request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request_reject x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: Fulfill this ASAP please. fulfillment_order_line_items: - id: 1025578671 quantity: 1 - id: 1025578672 quantity: 1 summary: Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items example2: value: fulfillment_request: message: Fulfill this ASAP please. summary: Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank summary: Shopify Sends A Fulfillment Request To The Fulfillment Service Of A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#create-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional message for the fulfillment request. schema: {} required: false - in: query name: fulfillment_order_line_items description: The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: We will start processing your fulfillment on the next business day. summary: Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order summary: Shopify Accepts A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#accept-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for accepting the fulfillment request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request_accept x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: Not enough inventory on hand to complete the work. summary: Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order summary: Shopify Rejects A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#reject-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for rejecting the fulfillment request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request_reject x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: Fulfill this ASAP please. fulfillment_order_line_items: - id: 1025578671 quantity: 1 - id: 1025578672 quantity: 1 summary: Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items example2: value: fulfillment_request: message: Fulfill this ASAP please. summary: Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank summary: Shopify Sends A Fulfillment Request To The Fulfillment Service Of A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#create-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional message for the fulfillment request. schema: {} required: false - in: query name: fulfillment_order_line_items description: The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment. schema: {} required: false tags: - Order responses: '200': description: '' operationId: create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: We will start processing your fulfillment on the next business day. summary: Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order summary: Shopify Accepts A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#accept-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for accepting the fulfillment request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request_accept x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: Not enough inventory on hand to complete the work. summary: Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order summary: Shopify Rejects A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#reject-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for rejecting the fulfillment request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request_reject x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: Fulfill this ASAP please. fulfillment_order_line_items: - id: 1025578671 quantity: 1 - id: 1025578672 quantity: 1 summary: Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items example2: value: fulfillment_request: message: Fulfill this ASAP please. summary: Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank summary: Shopify Sends A Fulfillment Request To The Fulfillment Service Of A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#create-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional message for the fulfillment request. schema: {} required: false - in: query name: fulfillment_order_line_items description: The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: We will start processing your fulfillment on the next business day. summary: Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order summary: Shopify Accepts A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#accept-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for accepting the fulfillment request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request_accept x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: Not enough inventory on hand to complete the work. summary: Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order summary: Shopify Rejects A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#reject-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for rejecting the fulfillment request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request_reject x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: Fulfill this ASAP please. fulfillment_order_line_items: - id: 1025578671 quantity: 1 - id: 1025578672 quantity: 1 summary: Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items example2: value: fulfillment_request: message: Fulfill this ASAP please. summary: Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank summary: Shopify Sends A Fulfillment Request To The Fulfillment Service Of A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#create-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional message for the fulfillment request. schema: {} required: false - in: query name: fulfillment_order_line_items description: The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: We will start processing your fulfillment on the next business day. summary: Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order summary: Shopify Accepts A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#accept-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for accepting the fulfillment request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request_accept x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json: post: requestBody: content: application/json: schema: {} examples: example1: value: fulfillment_request: message: Not enough inventory on hand to complete the work. summary: Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order summary: Shopify Rejects A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#reject-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: message description: An optional reason for rejecting the fulfillment request. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_create_fulfillment_orders_param_fulfillment_order_id_fulfillment_request_reject x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json: get: summary: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202001_get_fulfillment_orders_param_fulfillment_order_id_locations_for_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json: get: summary: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202004_get_fulfillment_orders_param_fulfillment_order_id_locations_for_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json: get: summary: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202007_get_fulfillment_orders_param_fulfillment_order_id_locations_for_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json: get: summary: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order. schema: {} required: false tags: - Order responses: '200': description: '' operationId: get_fulfillment_orders_param_fulfillment_order_id_locations_for_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json: get: summary: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_202101_get_fulfillment_orders_param_fulfillment_order_id_locations_for_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json: get: summary: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order. schema: {} required: false tags: - Order responses: '200': description: '' operationId: deprecated_unstable_get_fulfillment_orders_param_fulfillment_order_id_locations_for_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true components: securitySchemes: AccessToken: type: apiKey name: X-Shopify-Access-Token in: header description: Access token obtained via OAuth