sendReceiptEmail( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Sends the receipt to the specified recipient in an email.

Specifying a contact ID is required only when no contact ID was specified upon receipt creation.

Note that if the specified contact ID doesn't have an associated email address, the call will fail.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Receipts
Manage Stores
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
receiptIdstringRequired

Receipt ID to send.

optionsSendReceiptEmailOptions

Field options. The contactId object must be passed if one was not already specified upon receipt creation.

Errors
400Invalid Argument

There is 1 error with this status code.

428Failed Precondition

There are 3 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?