fulfillmentOrderReschedule - admin-graphql - MUTATION

Version: 2024-10

Description:

Reschedules a scheduled fulfillment order. Updates the value of the `fulfillAt` field on a scheduled fulfillment order. The fulfillment order will be marked as ready for fulfillment at this date and time.

Access Scopes

`write_merchant_managed_fulfillment_orders` access scope or `write_third_party_fulfillment_orders` access scope. Also: The user must have fulfill_and_ship_orders permission.

Arguments

• fulfillAt: DateTime! - A future date and time when the fulfillment order will be marked as ready for fulfillment.
• id: ID! - The ID of the fulfillment order to reschedule.

Returns

• fulfillmentOrder: FulfillmentOrder A fulfillment order with the rescheduled line items. Fulfillment orders may be merged if they have the same `fulfillAt` datetime. If the fulfillment order is merged then the resulting fulfillment order will be returned. Otherwise the original fulfillment order will be returned with an updated `fulfillAt` datetime.
• userErrors: FulfillmentOrderRescheduleUserError! The list of errors that occurred from executing the mutation.

Examples

• Reschedules the fulfill_at time of a scheduled fulfillment order

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fulfillmentOrderReschedule($fulfillAt: DateTime!, $id: ID!) { fulfillmentOrderReschedule(fulfillAt: $fulfillAt, id: $id) { fulfillmentOrder { id status fulfillAt } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/FulfillmentOrder/564786110\",\n    \"fulfillAt\": \"2024-11-25T18:40:54Z\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation fulfillmentOrderReschedule($fulfillAt: DateTime!, $id: ID!) {\n      fulfillmentOrderReschedule(fulfillAt: $fulfillAt, id: $id) {\n        fulfillmentOrder {\n          id\n          status\n          fulfillAt\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/FulfillmentOrder/564786110\",\n      \"fulfillAt\": \"2024-11-25T18:40:54Z\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation fulfillmentOrderReschedule($fulfillAt: DateTime!, $id: ID!) {\n    fulfillmentOrderReschedule(fulfillAt: $fulfillAt, id: $id) {\n      fulfillmentOrder {\n        id\n        status\n        fulfillAt\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/FulfillmentOrder/564786110\",\n  \"fulfillAt\": \"2024-11-25T18:40:54Z\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation fulfillmentOrderReschedule($fulfillAt: DateTime!, $id: ID!) {\n    fulfillmentOrderReschedule(fulfillAt: $fulfillAt, id: $id) {\n      fulfillmentOrder {\n        id\n        status\n        fulfillAt\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/FulfillmentOrder/564786110\",\n  \"fulfillAt\" => \"2024-11-25T18:40:54Z\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation fulfillmentOrderReschedule($fulfillAt: DateTime!, $id: ID!) {\n    fulfillmentOrderReschedule(fulfillAt: $fulfillAt, id: $id) {\n      fulfillmentOrder {\n        id\n        status\n        fulfillAt\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/FulfillmentOrder/564786110\",\n      \"fulfillAt\": \"2024-11-25T18:40:54Z\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation fulfillmentOrderReschedule($fulfillAt: DateTime!, $id: ID!) {\n  fulfillmentOrderReschedule(fulfillAt: $fulfillAt, id: $id) {\n    fulfillmentOrder {\n      id\n      status\n      fulfillAt\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/FulfillmentOrder/564786110",
    "fulfillAt": "2024-11-25T18:40:54Z"
  }

  response: {
    "data": {
      "fulfillmentOrderReschedule": {
        "fulfillmentOrder": {
          "id": "gid://shopify/FulfillmentOrder/564786110",
          "status": "SCHEDULED",
          "fulfillAt": "2024-11-25T18:40:54Z"
        },
        "userErrors": []
      }
    }
  }