Jump to

• Request
• Response

updateQuoteStatus

put

/ccapp/v1/orders/updateQuoteStatus

Update Quote Status. This operation is used to update the externalID of quote in the case of quote success or to capture errorInfo and change the status of order to quote_request_failed in case of quote failure.

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateQuoteStatus_request

Type: object

Show Source

• id(optional): string
  Order Id
• quoteInfo: object quoteInfo
  Details about quote info

{
    "properties":{
        "id":{
            "description":"Order Id",
            "type":"string"
        },
        "quoteInfo":{
            "description":"Details about quote info",
            "type":"object",
            "properties":{
                "errorInfo":{
                    "description":"Error note for failure of this quote",
                    "type":"string"
                },
                "externalId":{
                    "description":"external id for this quote",
                    "type":"string"
                }
            }
        }
    },
    "required":[
        "quoteInfo"
    ],
    "example":{
        "id":"o12345",
        "quoteInfo":{
            "externalID":"1234"
        }
    }
}

Example:

{
    "id":"o12345",
    "quoteInfo":{
        "externalID":"1234"
    }
}

Nested Schema : quoteInfo

Type: object

Details about quote info

Show Source

• errorInfo(optional): string
  Error note for failure of this quote
• externalId(optional): string
  external id for this quote

{
    "description":"Details about quote info",
    "type":"object",
    "properties":{
        "errorInfo":{
            "description":"Error note for failure of this quote",
            "type":"string"
        },
        "externalId":{
            "description":"external id for this quote",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateQuoteStatus_response

Type: object

Show Source

• agentId(optional): string
  Agent id
• errorInfo(optional): string
  Error note for failure of this quote
• expirationDate(optional): string
  Expiration date for this quote
• externalId(optional): string
  external id for this quote
• providerDate(optional): string
  Provider Date for this quote
• providerNote(optional): string
  Provider note for this quote
• rejectionDate(optional): string
  Rejection date for this quote
• rejectionNote(optional): string
  Rejection note for this quote
• requestDate(optional): string
  Request Date for this quote
• requesterNote(optional): string
  Requestor note for this quote

{
    "properties":{
        "providerNote":{
            "description":"Provider note for this quote",
            "type":"string"
        },
        "providerDate":{
            "description":"Provider Date for this quote",
            "type":"string"
        },
        "agentId":{
            "description":"Agent id",
            "type":"string"
        },
        "rejectionDate":{
            "description":"Rejection date for this quote",
            "type":"string"
        },
        "requestDate":{
            "description":"Request Date for this quote",
            "type":"string"
        },
        "errorInfo":{
            "description":"Error note for failure of this quote",
            "type":"string"
        },
        "externalId":{
            "description":"external id for this quote",
            "type":"string"
        },
        "rejectionNote":{
            "description":"Rejection note for this quote",
            "type":"string"
        },
        "expirationDate":{
            "description":"Expiration date for this quote",
            "type":"string"
        },
        "requesterNote":{
            "description":"Requestor note for this quote",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "providerNote":null,
    "providerDate":"2016-09-22T07:23:43.315Z",
    "agentId":"AgentID123",
    "rejectionDate":null,
    "requestDate":"2016-09-20T03:43:12.315Z",
    "errorInfo":null,
    "externalID":"1234",
    "rejectionNote":null,
    "requesterNote":"please give discount",
    "expirationDate":null
}

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