REST API for Oracle Commerce Cloud December 2017

updateQuoteStatus

put

/ccadmin/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 Parameter

Root Schema : updateQuoteStatus_request

Example


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

Properties

id: Type: string

Order Id
quoteInfo: Type: object quoteInfo

Required: true

Additional Properties Allowed:

Details about quote info

Nested Schema : quoteInfo

Type: object

Details about quote info

Properties

errorInfo: Type: string

Error note for failure of this quote
externalId: Type: string

external id for this quote

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateQuoteStatus_response

Properties

agentId: Type: string

Agent id
errorInfo: Type: string

Error note for failure of this quote
expirationDate: Type: string

Expiration date for this quote
externalId: Type: string

external id for this quote
providerDate: Type: string

Provider Date for this quote
providerNote: Type: string

Provider note for this quote
rejectionDate: Type: string

Rejection date for this quote
rejectionNote: Type: string

Rejection note for this quote
requestDate: Type: string

Request Date for this quote
requesterNote: Type: string

Requestor note for this quote

Example 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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

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

Sample Response Payload returned by endpoint:

{
  "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
}