Jump to

• Request
• Response

Download email templates

get

/ccadmin/v1/email/types/{emailTypeId}/templates

Downloads the Freemarker templates for the subject and body of the email type for a specific site, along with associated locale-specific resource files, so that these can be viewed and customized.

Email templates are site-specific, so the correct site context must be specified via the X-CCSite request header or occsite query parameter. If the site context is omitted, the templates downloaded will be for the default site.

The email type to be downloaded is identified by the {emailTypeId} path parameter. The emailTypeId parameter must correspond to the ID of an existing email type.

The email templates and locale resources are downloaded as a zipped file in the endpoint response.

Note:If the request fails, a JSON object is returned instead of an application/zip file.

Request

Supported Media Types

• application/json

Path Parameters

• emailTypeId: string
  ID of email type.

Back to Top

Response

Supported Media Types

• */*

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : downloadEmailTemplates_200_response

Type: object

Show Source

• items(optional): object items
  Response content type is application/x-zip-compressed, with response body containing the compressed zip file containing templates for the email type.

{
    "properties":{
        "items":{
            "description":"Response content type is application/x-zip-compressed, with response body containing the compressed zip file containing templates for the email type.",
            "type":"object"
        }
    }
}

Nested Schema : items

Type: object

Response content type is application/x-zip-compressed, with response body containing the compressed zip file containing templates for the email type.

404 Response

When the given email does not exist

Body ()

Root Schema : downloadEmailTemplates_404_response

Type: object

Show Source

• errorCode(optional): string
  00000000
• message(optional): string
  Email type {emailType} does not exist
• status(optional): string
  404

{
    "properties":{
        "errorCode":{
            "description":"00000000",
            "type":"string"
        },
        "message":{
            "description":"Email type {emailType} does not exist",
            "type":"string"
        },
        "status":{
            "description":"404",
            "type":"string"
        }
    }
}

Default Response

The following internal error codes are thrown by this API when the request fails in Commerce:

Error Code	Description	Possible Fix
950049	An unexpected error occurred building the zip file.	See the returned error messages for further information.

The error response:

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top