1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Failed WebHook Messages

getFailedMessages

get

/ccadmin/v1/webhookFailedMessages

Get Failed Messages. The failed messages.

Request

Supported Media Types
  • application/json
Query Parameters
limit
Type: integer
The number of items to return.
offset
Type: integer
Index of the first element to return.
q
Type: string
The query in RQL syntax. Common query strings might limit by serverType or messageType.
sort
Type: string
Sorting criteria. Following are the fields supported by this param: |Field|Type|Description| |------------------|------------------|------------------| |property|string|The property the listing is sorted by.| |order|string|Sort order: asc or desc.|

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getFailedMessages_response
Nested Schema : items
Type: array
The array of failed message items.
Nested Schema : sort
Type: array
The sorting criteria.
Nested Schema : items
Type: object
Nested Schema : forwardMessage
Type: object
The message being forwarded. Note that specific message types will have additional properties.
Nested Schema : remainingTargetUrls
Type: array
The remaining target URLs to which this message has not successfully been sent.
Nested Schema : items
Type: object
Example application/json

{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":250,
    "sort":[
        {
            "property":"id",
            "order":"asc"
        }
    ],
    "items":[
        {
            "remainingTargetUrls":[
                "http://localhost:8080/ccstore/v1/logging/logInfoPostWithHeaders",
                "http://localhost:9080/ccstore/v1/logging/logInfoPostWithHeaders"
            ],
            "messageType":"atg.commerce.fulfillment.SubmitOrder",
            "lastErrorMessage":"atg.service.webhook.WebHookException: java.net.ConnectException: Connection refused (Connection refused)",
            "savedTime":"2015-01-20T17:37:13.000Z",
            "resend":false,
            "serverType":"publishing",
            "id":"100001",
            "forwardMessage":{
                "orderId":"o10007",
                "parentSessionId":"2AA367F8A3B9BBC645E5F161A5891122",
                "sessionId":"2AA367F8A3B9BBC645E5F161A5891122",
                "source":"CheckoutProcess",
                "type":"atg.commerce.fulfillment.SubmitOrder",
                "userId":null,
                "profileId":"se-570031",
                "originalUserId":null,
                "siteId":null,
                "id":"10001",
                "originalId":"10001",
                "order":{
                    "priceInfo":{
                        "amount":29.97,
                        "total":54.97,
                        "shipping":25,
                        "discountAmount":0,
                        "tax":0,
                        "rawSubtotal":29.97,
                        "currencyCode":"USD"
                    },
                    "totalCommerceItemCount":3,
                    "id":"o10007",
                    "commerceItems":[
                        {
                            "priceInfo":{
                                "amount":29.97,
                                "currencyCode":"USD"
                            },
                            "quantity":3,
                            "productId":"Product_3Dii",
                            "productDisplayName":"He's Just Not that Into You",
                            "id":"ci1000008",
                            "catalogRefId":"Sku_3Eii"
                        }
                    ]
                },
                "originalSource":"CheckoutProcess"
            }
        }
    ]
}
Default Response
The error response
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "total": 1,
  "totalResults": 1,
  "offset": 0,
  "limit": 250,
  "sort": [{
    "property": "id",
    "order": "asc"
  }],
  "items": [{
    "remainingTargetUrls": [
      "http://localhost:8080/ccstore/v1/logging/logInfoPostWithHeaders",
      "http://localhost:9080/ccstore/v1/logging/logInfoPostWithHeaders"
    ],
    "messageType": "atg.commerce.fulfillment.SubmitOrder",
    "lastErrorMessage": "atg.service.webhook.WebHookException: java.net.ConnectException: Connection refused (Connection refused)",
    "savedTime": "2015-01-20T17:37:13.000Z",
    "resend": false,
    "serverType": "publishing",
    "id": "100001",
    "forwardMessage": {
      "orderId": "o10007",
      "parentSessionId": "2AA367F8A3B9BBC645E5F161A5891122",
      "sessionId": "2AA367F8A3B9BBC645E5F161A5891122",
      "source": "CheckoutProcess",
      "type": "atg.commerce.fulfillment.SubmitOrder",
      "userId": null,
      "profileId": "se-570031",
      "originalUserId": null,
      "siteId": null,
      "id": "10001",
      "originalId": "10001",
      "order": {
        "priceInfo": {
          "amount": 29.97,
          "total": 54.97,
          "shipping": 25,
          "discountAmount": 0,
          "tax": 0,
          "rawSubtotal": 29.97,
          "currencyCode": "USD"
        },
        "totalCommerceItemCount": 3,
        "id": "o10007",
        "commerceItems": [{
          "priceInfo": {
            "amount": 29.97,
            "currencyCode": "USD"
          },
          "quantity": 3,
          "productId": "Product_3Dii",
          "productDisplayName": "He's Just Not that Into You",
          "id": "ci1000008",
          "catalogRefId": "Sku_3Eii"
        }]
      },
      "originalSource": "CheckoutProcess"
    }
  }]
}