fulfillmentOrderReschedule
mutation

Choose a version:

Requires 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.

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.

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'FulfillmentOrderReschedulePayload returns'

FulfillmentOrderReschedulePayload returns

Anchor to FulfillmentOrderReschedulePayload.fulfillmentOrder 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.
Anchor to FulfillmentOrderReschedulePayload.userErrors userErrors [FulfillmentOrderRescheduleUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: fulfillmentOrderReschedule

Query Reference for MUTATION: fulfillmentOrderReschedule

"mutation fulfillmentOrderReschedule($fulfillAt: DateTime!, $id: ID!) {\n  fulfillmentOrderReschedule(fulfillAt: $fulfillAt, id: $id) {\n    fulfillmentOrder {\n      # FulfillmentOrder fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: fulfillmentOrderReschedule

"{\n  \"fulfillAt\": \"2019-09-07T15:50:00Z\",\n  \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: fulfillmentOrderReschedule

""

Display Examples for MUTATION: fulfillmentOrderReschedule

[
  {
    "example": {
      "type_name": "fulfillmentorderreschedule",
      "title": "Reschedule a fulfillment order",
      "description": "The merchant or an order management app postpones a scheduled fulfillment order for a later date",
      "query_string": "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}",
      "variables": {
        "id": "gid://shopify/FulfillmentOrder/564786110",
        "fulfillAt": "2024-09-17T01:06:28Z"
      },
      "response": {
        "data": {
          "fulfillmentOrderReschedule": {
            "fulfillmentOrder": {
              "id": "gid://shopify/FulfillmentOrder/564786110",
              "status": "SCHEDULED",
              "fulfillAt": "2024-09-17T01:06:28Z"
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/fulfillments/test/unit/graph_api/admin/mutations/fulfillment_order_reschedule_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/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-09-17T01:06:28Z\"\n  }\n}'\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-09-17T01:06:28Z\"\n    },\n  },\n);\n\nconst data = await response.json();\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-09-17T01:06:28Z\"\n}\n\nresponse = client.query(query: query, variables: variables)\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-09-17T01:06:28Z\"\n    },\n  },\n});\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-09-17T01:06:28Z\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The ID of the fulfillment order to reschedule.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "id",
        "argValue": " \"gid://shopify/FulfillmentOrder/564786110\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "fulfillAt",
          "description": "A future date and time when the fulfillment order will be marked as ready for fulfillment.",
          "type": {
            "kind": "SCALAR",
            "name": "DateTime",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "DateTime!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "fulfillAt",
        "argValue": " \"2024-09-17T01:06:28Z\"",
        "typeKind": "MUTATION"
      }
    ]
  }
]

fulfillmentOrderReschedulemutation

Arguments

FulfillmentOrderReschedulePayload returns

fulfillmentOrderReschedule
mutation