markReturnReceived

Requires permission inventory:stock_movement:create.

Marks a return as RECEIVED and stamps the actual return date. This is the step that makes the return eligible for inspection (processReturnInspection). Needs the stock movement create permission and permission to read the return.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation MarkReturnReceived($returnId: String!) {
  markReturnReceived(returnId: $returnId) {
    id
    returnNumber
    rmaNumber
    status
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation MarkReturnReceived($returnId: String!) {\n  markReturnReceived(returnId: $returnId) {\n    id\n    returnNumber\n    rmaNumber\n    status\n  }\n}",
  "variables": {
    "returnId": "string"
  }
}
EOF

Variables:

{
  "returnId": "string"
}

Response:

{
  "data": {
    "markReturnReceived": {
      "id": "string",
      "returnNumber": "string",
      "rmaNumber": "string",
      "status": "string"
    }
  }
}

markReturnReceived(
  receivedItems: [PartialReturnItemInput!]
  returnId: String!
): ReturnResponse!

Arguments

markReturnReceived.receivedItems ● [PartialReturnItemInput!] list input

The items and quantities actually received. Omit to receive everything.

markReturnReceived.returnId ● String! non-null scalar

The ID of the return.

Type

ReturnResponse object

A return created through the RMA flow.