Jump to

• Request
• Response

getUpsellMessages

get

/ccagent/v1/orders/getUpsellMessages

Returns a list of unqualified promotion uspell messages.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getUpsellMessages_response

Type: object

Show Source

• promotionUpsellMessages(optional): array promotionUpsellMessages
  The promotion upsell messages.

{
    "properties":{
        "promotionUpsellMessages":{
            "description":"The promotion upsell messages.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "text":{
                        "description":"The promotion upsell message.",
                        "type":"string"
                    },
                    "tags":{
                        "description":"The tags the promotion upsell message is associated with.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : promotionUpsellMessages

Type: array

The promotion upsell messages.

Show Source

• Array of: object items

{
    "description":"The promotion upsell messages.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "text":{
                "description":"The promotion upsell message.",
                "type":"string"
            },
            "tags":{
                "description":"The tags the promotion upsell message is associated with.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• tags(optional): array tags
  The tags the promotion upsell message is associated with.
• text(optional): string
  The promotion upsell message.

{
    "type":"object",
    "properties":{
        "text":{
            "description":"The promotion upsell message.",
            "type":"string"
        },
        "tags":{
            "description":"The tags the promotion upsell message is associated with.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : tags

Type: array

The tags the promotion upsell message is associated with.

Show Source

• Array of: string

{
    "description":"The tags the promotion upsell message is associated with.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (application/json)

{
    "promotionUpsellMessages":[
        {
            "text":"Spend $100 get free shipping!",
            "tags":[
                "CART_UPSELL"
            ]
        },
        {
            "text":"Spend $50 on Sports equipment get a free Sports DVD!",
            "tags":[
                "BANNER_UPSELL",
                "CART_UPSELL"
            ]
        }
    ]
}

Default Response

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