openapi: 3.1.0 info: title: Shopify Admin REST About Items 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: Items paths: /admin/api/2020-01/inventory_items.json: get: summary: Shopify Retrieves A List Of Inventory Items description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2020-01 parameters: - in: query name: "ids\n required" description: "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids schema: type: integer description: ids required: false tags: - Items responses: '200': description: '' operationId: deprecated_202001_get_inventory_items x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/inventory_items.json: get: summary: Shopify Retrieves A List Of Inventory Items description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2020-04 parameters: - in: query name: "ids\n required" description: "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids schema: type: integer description: ids required: false tags: - Items responses: '200': description: '' operationId: deprecated_202004_get_inventory_items x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/inventory_items.json: get: summary: Shopify Retrieves A List Of Inventory Items description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2020-07 parameters: - in: query name: "ids\n required" description: "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids schema: type: integer description: ids required: false tags: - Items responses: '200': description: '' operationId: deprecated_202007_get_inventory_items x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/inventory_items.json: get: summary: Shopify Retrieves A List Of Inventory Items description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2020-10 parameters: - in: query name: "ids\n required" description: "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids schema: type: integer description: ids required: false tags: - Items responses: '200': description: '' operationId: get_inventory_items x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/inventory_items.json: get: summary: Shopify Retrieves A List Of Inventory Items description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2021-01 parameters: - in: query name: "ids\n required" description: "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids schema: type: integer description: ids required: false tags: - Items responses: '200': description: '' operationId: deprecated_202101_get_inventory_items x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/inventory_items.json: get: summary: Shopify Retrieves A List Of Inventory Items description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-unstable parameters: - in: query name: "ids\n required" description: "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids schema: type: integer description: ids required: false tags: - Items responses: '200': description: '' operationId: deprecated_unstable_get_inventory_items x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/fulfillments.json: 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: - Items responses: '200': description: '' operationId: deprecated_202001_create_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/fulfillments.json: 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: - Items responses: '200': description: '' operationId: deprecated_202004_create_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/fulfillments.json: 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: - Items responses: '200': description: '' operationId: deprecated_202007_create_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/fulfillments.json: 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: - Items responses: '200': description: '' operationId: create_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/fulfillments.json: 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: - Items responses: '200': description: '' operationId: deprecated_202101_create_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/fulfillments.json: 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: - Items responses: '200': description: '' operationId: deprecated_unstable_create_orders_param_order_id_fulfillments 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