returnLineItemRemoveFromReturn

mutation

Requires write_returns access scope. Also: The user must have return_orders permission.

Removes return lines from a return.

Arguments

Anchor to returnIdreturnId • ID!required: The ID of the return for line item removal.
Anchor to returnLineItemsreturnLineItems • [ReturnLineItemRemoveFromReturnInput!]!required: The return line items to remove from the return.

Was this section helpful?

Anchor to ReturnLineItemRemoveFromReturnPayload returnsReturnLineItemRemoveFromReturnPayload returns

Anchor to returnreturn • Return: The modified return.
Anchor to userErrorsuserErrors • [ReturnUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Remove a return line item from a return
returnLineItemRemoveFromReturn reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation ReturnLineItemRemoveFromReturn($returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]!) {
6    returnLineItemRemoveFromReturn(returnId: $returnId, returnLineItems: $returnLineItems) {
7      userErrors {
8        field
9        message
10      }
11      return {
12        id
13        status
14        returnLineItems(first: 10) {
15          edges {
16            node {
17              id
18              quantity
19            }
20          }
21        }
22      }
23    }
24  }`,
25  {
26    variables: {
27      "returnId": "gid://shopify/Return/945000969",
28      "returnLineItems": [
29        {
30          "returnLineItemId": "gid://shopify/ReturnLineItem/791246324",
31          "quantity": 1
32        }
33      ]
34    },
35  },
36);
37
38const data = await response.json();
39

mutation ReturnLineItemRemoveFromReturn($returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]!) {
  returnLineItemRemoveFromReturn(returnId: $returnId, returnLineItems: $returnLineItems) {
    userErrors {
      field
      message
    }
    return {
      id
      status
      returnLineItems(first: 10) {
        edges {
          node {
            id
            quantity
          }
        }
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation ReturnLineItemRemoveFromReturn($returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]!) { returnLineItemRemoveFromReturn(returnId: $returnId, returnLineItems: $returnLineItems) { userErrors { field message } return { id status returnLineItems(first: 10) { edges { node { id quantity } } } } } }",
 "variables": {
    "returnId": "gid://shopify/Return/945000969",
    "returnLineItems": [
      {
        "returnLineItemId": "gid://shopify/ReturnLineItem/791246324",
        "quantity": 1
      }
    ]
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation ReturnLineItemRemoveFromReturn($returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]!) {
    returnLineItemRemoveFromReturn(returnId: $returnId, returnLineItems: $returnLineItems) {
      userErrors {
        field
        message
      }
      return {
        id
        status
        returnLineItems(first: 10) {
          edges {
            node {
              id
              quantity
            }
          }
        }
      }
    }
  }`,
  {
    variables: {
      "returnId": "gid://shopify/Return/945000969",
      "returnLineItems": [
        {
          "returnLineItemId": "gid://shopify/ReturnLineItem/791246324",
          "quantity": 1
        }
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation ReturnLineItemRemoveFromReturn($returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]!) {
      returnLineItemRemoveFromReturn(returnId: $returnId, returnLineItems: $returnLineItems) {
        userErrors {
          field
          message
        }
        return {
          id
          status
          returnLineItems(first: 10) {
            edges {
              node {
                id
                quantity
              }
            }
          }
        }
      }
    }`,
    "variables": {
      "returnId": "gid://shopify/Return/945000969",
      "returnLineItems": [
        {
          "returnLineItemId": "gid://shopify/ReturnLineItem/791246324",
          "quantity": 1
        }
      ]
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation ReturnLineItemRemoveFromReturn($returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]!) {
    returnLineItemRemoveFromReturn(returnId: $returnId, returnLineItems: $returnLineItems) {
      userErrors {
        field
        message
      }
      return {
        id
        status
        returnLineItems(first: 10) {
          edges {
            node {
              id
              quantity
            }
          }
        }
      }
    }
  }
QUERY

variables = {
  "returnId": "gid://shopify/Return/945000969",
  "returnLineItems": [{"returnLineItemId"=>"gid://shopify/ReturnLineItem/791246324", "quantity"=>1}]
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "returnId": "gid://shopify/Return/945000969",
3  "returnLineItems": [
4    {
5      "returnLineItemId": "gid://shopify/ReturnLineItem/791246324",
6      "quantity": 1
7    }
8  ]
9}

Response

JSON

1{
2  "returnLineItemRemoveFromReturn": {
3    "userErrors": [],
4    "return": {
5      "id": "gid://shopify/Return/945000969",
6      "status": "CLOSED",
7      "returnLineItems": {
8        "edges": []
9      }
10    }
11  }
12}