REL documentation
Resource:customer email alert definitionC# Rel Const:Rels.CustomerSvc.EmailAlertDefURI template:{id}/emailalertdef{?type}Obtain URI from:
Get the definition of an email alert for a customer and event notify type
Success status: 200; ETag response header supplied
| Name (* = required) | Data Type | Description |
|---|---|---|
| id * | int | customer id |
| type * | Common.Enum.EmailTemplateType | must support email |
| - ItemCreateUpdate | ||
| - Receive | ||
| - ReceiveConfirmation | ||
| - OrderCreate | ||
| - OrderUpdate | ||
| - CustOrderShip | ||
| - Adjustment | ||
| - OrderCustCreate | ||
| - ShipToOrderShip | ||
| - FTPOrdImportFail | ||
| - ASNConfNotRcvd | ||
| - OrdersCreateFTP | ||
| - ItemMinReached | ||
| - LocMinReached | ||
| - ASNCreate | ||
| - OrderLoadedComplete | ||
| - OrderLoadedIncomplete | ||
| - PackedComplete | ||
| - ProductExpiration | ||
| - FTPRcvImportFail | ||
| - InvoiceDelivered | ||
| - StockStatusExportFailure | ||
| - CustomReportExportFailure | ||
| - ItemImportFailure | ||
| - InvoicePreview | ||
| - InventoryOnHold | ||
| - InventoryOffHold | ||
| - InventoryTransferToCust | ||
| - InventoryTransferFromCust |
| Type | Description | |
|---|---|---|
| EventNotifyId | int | |
| SimpleEmailRecipients | string | |
| EnhancedEmail | Customer.Models.EnhancedEmail | |
| Recipients | string | |
| TransformId | int | |
| IncludeAttachedDocumentLinks | bool | |
| Links | IList<WebApi.Hal.Link> | |
| - /rels/customers/customer |
Sample accept: application/hal+json
{
"eventNotifyId": 1,
"simpleEmailRecipients": "str",
"enhancedEmail": {
"recipients": "str",
"transformId": 2,
"includeAttachedDocumentLinks": true
}
}
Update the definition of an email alert for a customer and event notify type
Success status: 200; ETag response header supplied
| Name (* = required) | Data Type | Description |
|---|---|---|
| id * | int | |
| type * | Common.Enum.EmailTemplateType | |
| - ItemCreateUpdate | ||
| - Receive | ||
| - ReceiveConfirmation | ||
| - OrderCreate | ||
| - OrderUpdate | ||
| - CustOrderShip | ||
| - Adjustment | ||
| - OrderCustCreate | ||
| - ShipToOrderShip | ||
| - FTPOrdImportFail | ||
| - ASNConfNotRcvd | ||
| - OrdersCreateFTP | ||
| - ItemMinReached | ||
| - LocMinReached | ||
| - ASNCreate | ||
| - OrderLoadedComplete | ||
| - OrderLoadedIncomplete | ||
| - PackedComplete | ||
| - ProductExpiration | ||
| - FTPRcvImportFail | ||
| - InvoiceDelivered | ||
| - StockStatusExportFailure | ||
| - CustomReportExportFailure | ||
| - ItemImportFailure | ||
| - InvoicePreview | ||
| - InventoryOnHold | ||
| - InventoryOffHold | ||
| - InventoryTransferToCust | ||
| - InventoryTransferFromCust |
| Type | Description | |
|---|---|---|
| EventNotifyId | int | |
| SimpleEmailRecipients | string | |
| EnhancedEmail | Customer.Models.EnhancedEmail | |
| Recipients | string | |
| TransformId | int | |
| IncludeAttachedDocumentLinks | bool |
Sample content-type: application/hal+json |
{
"eventNotifyId": 1,
"simpleEmailRecipients": "str",
"enhancedEmail": {
"recipients": "str",
"transformId": 2,
"includeAttachedDocumentLinks": true
}
}
| Type | Description | |
|---|---|---|
| EventNotifyId | int | |
| SimpleEmailRecipients | string | |
| EnhancedEmail | Customer.Models.EnhancedEmail | |
| Recipients | string | |
| TransformId | int | |
| IncludeAttachedDocumentLinks | bool | |
| Links | IList<WebApi.Hal.Link> | |
| - /rels/customers/customer |
Sample accept: application/hal+json
{
"eventNotifyId": 1,
"simpleEmailRecipients": "str",
"enhancedEmail": {
"recipients": "str",
"transformId": 2,
"includeAttachedDocumentLinks": true
}
}
This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.