Jump to

• Request
• Response

getMessageTags

get

/ccadmin/v1/messageTags

List message tags for promotion upsell messages.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The following model is returned when the operation succeeds.

Body ()

Root Schema : listMessageTags_response

Type: object

Show Source

• items: array items
  The list of available message tags.

{
    "properties":{
        "items":{
            "description":"The list of available message tags.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository ID of the message tag.",
                        "type":"string"
                    },
                    "name":{
                        "description":"The tag's name to use when referring to it in storefront widgets.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of available message tags.

Show Source

• Array of: object items

{
    "description":"The list of available message tags.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Repository ID of the message tag.",
                "type":"string"
            },
            "name":{
                "description":"The tag's name to use when referring to it in storefront widgets.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  The tag's name to use when referring to it in storefront widgets.
• repositoryId: string
  Repository ID of the message tag.

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of the message tag.",
            "type":"string"
        },
        "name":{
            "description":"The tag's name to use when referring to it in storefront widgets.",
            "type":"string"
        }
    }
}

Example Response (application/json)

[
    {
        "items":[
            {
                "repositoryId":"mt1001",
                "name":"Banner"
            },
            {
                "repositoryId":"mt1002",
                "name":"Cart"
            }
        ]
    }
]

Default Response

The error response.

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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