return

query

Code examples for QUERY: return

Query Reference for QUERY: return

"{\n  return(id) {\n    # Return fields\n  }\n}"

Input Reference for QUERY: return

Schema Reference for QUERY: return

Display Examples for QUERY: return

[
  {
    "example": {
      "type_name": "return",
      "title": "Get status and return line items for a return",
      "description": "The following query shows how to retrieve the `status` and the first 10 `returnLineItems` for a return. ",
      "query_string": "query {\n  return(id: \"gid://shopify/Return/945000954\") {\n    status\n    name\n    order {\n      id\n    }\n    returnLineItems(first: 10) {\n      edges {\n        node {\n          ... on ReturnLineItem {\n            fulfillmentLineItem {\n              lineItem {\n                name\n              }\n            }\n            totalWeight {\n              value\n            }\n          }\n          quantity\n          returnReason\n          returnReasonNote\n        }\n      }\n    }\n  }\n}",
      "query_arguments": {
        "first": 10
      },
      "response": {
        "data": {
          "return": {
            "status": "OPEN",
            "name": "#1001-R1",
            "order": {
              "id": "gid://shopify/Order/625362839"
            },
            "returnLineItems": {
              "edges": [
                {
                  "node": {
                    "fulfillmentLineItem": {
                      "lineItem": {
                        "name": "Draft - 151cm"
                      }
                    },
                    "totalWeight": {
                      "value": 1500
                    },
                    "quantity": 1,
                    "returnReason": "UNKNOWN",
                    "returnReasonNote": ""
                  }
                }
              ]
            }
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/returns/test/unit/graph_api/admin/return_test.rb",
      "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\": \"query { return(id: \\\"gid://shopify/Return/945000954\\\") { status name order { id } returnLineItems(first: 10) { edges { node { ... on ReturnLineItem { fulfillmentLineItem { lineItem { name } } totalWeight { value } } quantity returnReason returnReasonNote } } } } }\"\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    return(id: \"gid://shopify/Return/945000954\") {\n      status\n      name\n      order {\n        id\n      }\n      returnLineItems(first: 10) {\n        edges {\n          node {\n            ... on ReturnLineItem {\n              fulfillmentLineItem {\n                lineItem {\n                  name\n                }\n              }\n              totalWeight {\n                value\n              }\n            }\n            quantity\n            returnReason\n            returnReasonNote\n          }\n        }\n      }\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  query {\n    return(id: \"gid://shopify/Return/945000954\") {\n      status\n      name\n      order {\n        id\n      }\n      returnLineItems(first: 10) {\n        edges {\n          node {\n            ... on ReturnLineItem {\n              fulfillmentLineItem {\n                lineItem {\n                  name\n                }\n              }\n              totalWeight {\n                value\n              }\n            }\n            quantity\n            returnReason\n            returnReasonNote\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    return(id: \"gid://shopify/Return/945000954\") {\n      status\n      name\n      order {\n        id\n      }\n      returnLineItems(first: 10) {\n        edges {\n          node {\n            ... on ReturnLineItem {\n              fulfillmentLineItem {\n                lineItem {\n                  name\n                }\n              }\n              totalWeight {\n                value\n              }\n            }\n            quantity\n            returnReason\n            returnReasonNote\n          }\n        }\n      }\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  query {\n    return(id: \"gid://shopify/Return/945000954\") {\n      status\n      name\n      order {\n        id\n      }\n      returnLineItems(first: 10) {\n        edges {\n          node {\n            ... on ReturnLineItem {\n              fulfillmentLineItem {\n                lineItem {\n                  name\n                }\n              }\n              totalWeight {\n                value\n              }\n            }\n            quantity\n            returnReason\n            returnReasonNote\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  },
  {
    "example": {
      "type_name": "return",
      "title": "Get status and return line items for a return (API Version 2024-04 and older)",
      "description": "The following query shows how to retrieve the `status` and the first 10 `returnLineItems` for a return.",
      "query_string": "query {\n  return(id: \"gid://shopify/Return/945000954\") {\n    status\n    name\n    order {\n      id\n    }\n    returnLineItems(first: 10) {\n      edges {\n        node {\n          quantity\n          returnReason\n          returnReasonNote\n          fulfillmentLineItem {\n            lineItem {\n              name\n            }\n          }\n          totalWeight {\n            value\n          }\n        }\n      }\n    }\n  }\n}",
      "query_arguments": {
        "first": 10
      },
      "response": {
        "data": {
          "return": {
            "status": "OPEN",
            "name": "#1001-R1",
            "order": {
              "id": "gid://shopify/Order/625362839"
            },
            "returnLineItems": {
              "edges": [
                {
                  "node": {
                    "quantity": 1,
                    "returnReason": "UNKNOWN",
                    "returnReasonNote": "",
                    "fulfillmentLineItem": {
                      "lineItem": {
                        "name": "Draft - 151cm"
                      }
                    },
                    "totalWeight": {
                      "value": 1500
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/returns/test/unit/graph_api/admin/return_test.rb",
      "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\": \"query { return(id: \\\"gid://shopify/Return/945000954\\\") { status name order { id } returnLineItems(first: 10) { edges { node { quantity returnReason returnReasonNote fulfillmentLineItem { lineItem { name } } totalWeight { value } } } } } }\"\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    return(id: \"gid://shopify/Return/945000954\") {\n      status\n      name\n      order {\n        id\n      }\n      returnLineItems(first: 10) {\n        edges {\n          node {\n            quantity\n            returnReason\n            returnReasonNote\n            fulfillmentLineItem {\n              lineItem {\n                name\n              }\n            }\n            totalWeight {\n              value\n            }\n          }\n        }\n      }\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  query {\n    return(id: \"gid://shopify/Return/945000954\") {\n      status\n      name\n      order {\n        id\n      }\n      returnLineItems(first: 10) {\n        edges {\n          node {\n            quantity\n            returnReason\n            returnReasonNote\n            fulfillmentLineItem {\n              lineItem {\n                name\n              }\n            }\n            totalWeight {\n              value\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    return(id: \"gid://shopify/Return/945000954\") {\n      status\n      name\n      order {\n        id\n      }\n      returnLineItems(first: 10) {\n        edges {\n          node {\n            quantity\n            returnReason\n            returnReasonNote\n            fulfillmentLineItem {\n              lineItem {\n                name\n              }\n            }\n            totalWeight {\n              value\n            }\n          }\n        }\n      }\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  query {\n    return(id: \"gid://shopify/Return/945000954\") {\n      status\n      name\n      order {\n        id\n      }\n      returnLineItems(first: 10) {\n        edges {\n          node {\n            quantity\n            returnReason\n            returnReasonNote\n            fulfillmentLineItem {\n              lineItem {\n                name\n              }\n            }\n            totalWeight {\n              value\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  }
]