data-src=../../../../../includes/saas-only.md

data-src=../../../../../includes/commerce-only.md

shareRequisitionListByEmail mutation

data-variant=info

data-slots=text1

This mutation is part of the B2B Storefront Compatibility Package and is only available on Adobe Commerce as a Cloud Service.

The shareRequisitionListByEmail mutation enables B2B customers to share a requisition list with colleagues within the same company in an email. The mutation requires requisitionListUid and an array of customerUids as input parameters. This mutation returns a sent_count which shows the count of emails the list has been shared to, and user_errors, if any.

Syntax

{
    shareRequisitionListByEmail(
        input: ShareRequisitionListByEmailInput!
    ): ShareRequisitionListByEmailOutput
}

Example usage

The following example shares a requisition list to the specified customer UIDs.

Request:

mutation ShareRequisitionListByEmail {
    shareRequisitionListByEmail(
        input: { customerUids: ["MQ==", "Mg=="], requisitionListUid: "OTc5" }
    ) {
        sent_count
        user_errors {
            code
            message
        }
    }
}

Response:

{
  "data": {
    "shareRequisitionListByEmail": {
      "sent_count": 2,
      "user_errors": []
    }
  }
}