getFailedMessage
get
/ccadmin/v1/webhookFailedMessages/{id}
Get Failed Message. Return data about a single failed webhooks message.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the failed message.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getFailedMessage_response
Type:
Show Source
object
-
asRaw(optional):
string
The raw byte stream of the failed message rendered as a String that may be useful in cases where deserialization fails.
-
forwardMessage(optional):
object forwardMessage
The message being forwarded. Note that specific message types will have additional properties.
-
id(optional):
string
The repository ID of this failed message.
-
lastErrorMessage(optional):
string
The error from the last send attempt.
-
messageType(optional):
string
The message type of this message.
-
remainingTargetUrls(optional):
array remainingTargetUrls
The remaining target URLs to which this message has not successfully been sent.
-
resend(optional):
boolean
Whether this message is marked to be requeued for WebHook send.
-
savedTime(optional):
string
The last time with message was saved.
-
serverType(optional):
string
The server type of the server that failed to send this message.
-
serviceName(optional):
string
The nucleus name of the webhook target.
Nested Schema : forwardMessage
Type:
object
The message being forwarded. Note that specific message types will have additional properties.
Show Source
-
id(optional):
string
The ID for the forward message.
-
originalId(optional):
string
The ID of the original message.
-
originalSource(optional):
string
The original source of the message.
-
originalUserId(optional):
string
The original user ID.
-
parentSessionId(optional):
string
The parent sesison ID of the session from which the message was sent.
-
sessionId(optional):
string
the Session ID
-
siteId(optional):
string
The site ID.
-
source(optional):
string
The source of the message.
-
type(optional):
string
The type of the message.
-
userId(optional):
string
The ID of the end user who last acted on this message.
Nested Schema : remainingTargetUrls
Type:
array
The remaining target URLs to which this message has not successfully been sent.
Show Source
Example Response (application/json)
{
"remainingTargetUrls":[
],
"messageType":"atg.commerce.fulfillment.SubmitOrder",
"lastErrorMessage":"atg.service.webhook.WebHookException: java.net.ConnectException: Connection refused (Connection refused)",
"savedTime":"2016-11-14T18:37:27.000Z",
"resend":false,
"serverType":"production",
"asRaw":"??????\u0000\u0005sr\u0000$atg.commerce.fulfillment.SubmitOrder3`???\u0004\u0005\u0001???9\u0002\u0000\u0003L\u0000\u0006mOrdert\u0000\u001aLatg/commerce/order/Order;L\u0000\bmOrderIdt\u0000\u0012Ljava/lang/String;L\u0000\bmProfilet\u0000\u001fLatg/repository/RepositoryItem;xr\u0000*atg.commerce.messaging.CommerceMessageImplU\"?????????8c\n\u0002\u0000\u0000xr\u0000\"atg.dms.forward.ForwardMessageImpl???>??????g???\u000b???\u0002\u0000\nL\u0000\u000bmAttributest\u0000\u000fLjava/util/Map;L\u0000\u0003mIdq\u0000~\u0000\u0002L\u0000\u000bmOriginalIdq\u0000~\u0000\u0002L\u0000\u000fmOriginalSourceq\u0000~\u0000\u0002L\u0000\u000fmOriginalUserIdq\u0000~\u0000\u0002L\u0000\u0010mParentSessionIdq\u0000~\u0000\u0002L\u0000\nmSessionIdq\u0000~\u0000\u0002L\u0000\u0007mSiteIdq\u0000~\u0000\u0002L\u0000\u0007mSourceq\u0000~\u0000\u0002L\u0000\u0007mUserIdq\u0000~\u0000\u0002xppppt\u0000\u000fCheckoutProcesspt\u0000 7BD2C9ADE7AA2A7FD88EF6D175C20812q\u0000~\u0000\tpq\u0000~\u0000\bpsr\u0000\u001eatg.cloud.order.CloudOrderImpl6\u0007???\u00026~??????\u0002\u0000\u0001L\u0000\bmProfileq\u0000~\u0000\u0003xr\u0000\u001catg.commerce.order.OrderImpl>???A??????Q???\r\u0002\u0000\u000bZ\u0000\bmChangedZ\u0000\u0012mSaveAllPropertiesI\u0000\bmVersionL\u0000\u0012mChangedPropertiest\u0000\u0013Ljava/util/HashSet;L\u0000\nmPriceInfot\u0000%Latg/commerce/pricing/OrderPriceInfo;L\u0000\u0018mPriceInfoRepositoryItemt\u0000&Latg/repository/MutableRepositoryItem;L\u0000\u000fmRepositoryItemq\u0000~\u0000\u000eL\u0000\u000emStateAsStringq\u0000~\u0000\u0002L\u0000\rmTaxPriceInfot\u0000#Latg/commerce/pricing/TaxPriceInfo;L\u0000\u001bmTaxPriceInfoRepositoryItemq\u0000~\u0000\u000eL\u0000\u000emTransientDataq\u0000~\u0000\u0006xr\u0000)atg.commerce.order.CommerceIdentifierImpl_\u0002;Rj????E\u0002\u0000\u0001L\u0000\u000bmCommerceIdq\u0000~\u0000\u0002xpt\u0000\u0006o10051\u0000\u0000\u0000\u0000\u0000\u0003pppsr\u0000\u0017atg.adapter.gsa.GSAItemwQ???/\u001cv??????\u0003\u0000\u0002J\u0000\u000emPrintHashcodeZ\u0000\u0015mUpdateReferencesFlagxr\u0000!atg.repository.RepositoryItemImplUu??????4???H???\u0003\u0000\u0001Z\u0000\u0010mBeingCheckedOutxp\u0000t\u0000#/atg/commerce/order/OrderRepositoryt\u0000\u0005orderq\u0000~\u0000\u0012w\u0005\u0000\u0000\u0000\u0000\u0000x\u0000\u0000\u0000\u0000{6$???\u0001xpppsr\u0000\u0011java.util.HashMap\u0005\u0007?????????\u0016`???\u0003\u0000\u0002F\u0000\nloadFactorI\u0000\tthresholdxp?@\u0000\u0000\u0000\u0000\u0000\u0000w\b\u0000\u0000\u0000\u0010\u0000\u0000\u0000\u0000xpq\u0000~\u0000\u0012sq\u0000~\u0000\u0013\u0000t\u0000+/atg/userprofiling/ProfileAdapterRepositoryt\u0000\u0004usert\u0000\tse-570031w\u0005\u0000\u0000\u0000\u0000\u0000x\u0000\u0000\u0000\u0000{ek???\u0001x",
"id":"200001",
"serviceName":"submitOrder",
"forwardMessage":{
"orderId":"o10051",
"parentSessionId":"7BD2C9ADE7AA2A7FD88EF6D175C20812",
"source":"CheckoutProcess",
"sessionId":"7BD2C9ADE7AA2A7FD88EF6D175C20812",
"type":"atg.commerce.fulfillment.SubmitOrder",
"userId":null,
"profileId":"se-570031",
"siteId":null,
"originalUserId":null,
"originalId":null,
"id":null,
"originalSource":"CheckoutProcess",
"order":{
"gwp":false,
"priceGroupId":"defaultPriceGroup",
"lastModifiedTime":1.476041288E12,
"creationTime":1.476041288E12,
"gwpMarkers":[
],
"locale":"en",
"salesChannel":"default",
"paymentGroups":[
{
"expirationYear":"2018",
"amountAuthorized":0,
"amount":43.2,
"gatewayName":null,
"expirationMonth":"04",
"submittedDate":"2015-05-16T10:21:13.000Z",
"authorizationStatus":[
{
"transactionUuid":"61c99dc99bba495c95af270fd8647cb8",
"authorizationDecision":"ACCEPT",
"amount":0,
"transactionSuccess":true,
"errorMessage":null,
"currency":null,
"reasonCode":"100",
"transactionId":null
}
],
"token":null,
"paymentGroupClassType":"tokenizedCreditCard",
"creditCardNumber":"1111",
"paymentMethod":"tokenizedCreditCard",
"state":"AUTHORIZED",
"id":"pg10051",
"billingAddress":{
"lastName":"d",
"country":"US",
"address3":null,
"city":"Montgomery",
"address2":null,
"address1":"600",
"prefix":null,
"companyName":null,
"jobTitle":null,
"postalCode":"36130",
"county":null,
"suffix":null,
"ownerId":null,
"firstName":"c",
"phoneNumber":"9876543210",
"faxNumber":null,
"middleName":null,
"state":"AL",
"email":"kim@example.com"
},
"debitStatus":[
],
"currencyCode":"USD"
}
],
"configuratorId":null,
"organizationId":null,
"priceInfo":{
"discounted":false,
"amount":15,
"total":43.2,
"shipping":25,
"manualAdjustmentTotal":0,
"amountIsFinal":false,
"discountAmount":0,
"tax":3.2,
"rawSubtotal":15,
"currencyCode":"USD"
},
"relationships":[
{
"paymentGroupId":"pg10051",
"amount":43.2,
"relationshipType":"ORDERAMOUNTREMAINING",
"id":"r10125"
}
],
"totalCommerceItemCount":1,
"id":"o10051",
"state":"SUBMITTED",
"quoteInfo":null,
"taxCalculated":false,
"commerceItems":[
{
"priceInfo":{
"discounted":true,
"amount":15,
"rawTotalPrice":99.99,
"salePrice":25,
"priceListId":"salePrices",
"quantityDiscounted":1,
"amountIsFinal":false,
"onSale":true,
"shippingSurcharge":0,
"discountable":true,
"currencyCode":"USD",
"currentPriceDetailsSorted":[
{
"discounted":true,
"amount":15,
"quantity":1,
"amountIsFinal":false,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"orderDiscountShare":0,
"tax":3.2,
"detailedUnitPrice":15,
"currencyCode":"USD"
}
],
"listPrice":99.99
},
"quantity":1,
"catalogId":null,
"productId":"prod10013",
"returnedQuantity":0,
"lineAttributes":[
],
"catalogKey":null,
"productDisplayName":"Playstation",
"externalPriceDetails":null,
"externalId":null,
"id":"ci1000074",
"catalogRefId":"sku10030"
}
],
"taxPriceInfo":{
"discounted":false,
"valueAddedTax":0,
"amount":3.2,
"countyTax":1.6,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":1.6,
"miscTaxInfo":{
},
"countryTax":0,
"cityTax":0,
"amountIsFinal":false,
"currencyCode":"USD"
},
"shippingGroups":[
{
"shippingMethod":"priorityShippingMethod",
"description":"sg10051",
"submittedDate":null,
"priceInfo":{
"discounted":false,
"shippingTax":0,
"amount":25,
"rawShipping":25,
"amountIsFinal":false,
"currencyCode":"USD"
},
"shipOnDate":null,
"actualShipDate":null,
"specialInstructions":{
},
"shippingAddress":{
"lastName":"Anderson",
"country":"US",
"address3":null,
"city":"Syracuse",
"address2":null,
"address1":"21 Cedar Ave",
"prefix":"Sr",
"companyName":null,
"jobTitle":"Director",
"postalCode":"13202",
"county":"United States",
"suffix":null,
"ownerId":null,
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"faxNumber":"212-555-1977",
"middleName":"Christian",
"state":"NY",
"email":"kim@example.com"
},
"commerceItemRelationships":[
{
"commerceItemId":"ci1000074",
"amount":0,
"quantity":1,
"relationshipType":"SHIPPINGQUANTITY",
"returnedQuantity":0,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"state":"INITIAL",
"commerceItemExternalId":null,
"id":"r10124"
}
],
"state":"INITIAL",
"id":"sg10051",
"stateDetail":null,
"trackingNumber":null,
"handlingInstructions":[
],
"shippingGroupClassType":"hardgoodShippingGroup"
}
],
"taxExempt":false,
"profile":{
"lastName":"Anderson",
"firstName":"Kim",
"shippingAddress":{
"country":"US",
"phoneNumber":"212-555-1977",
"address3":null,
"city":"Syracuse",
"address2":null,
"address1":"21 Cedar Ave",
"postalCode":"13202",
"county":null,
"state":"NY"
},
"middleName":null,
"email":"kim@example.com"
},
"shippingGroupCount":1,
"paymentGroupCount":1,
"profileId":"se-570031",
"siteId":"siteUS",
"activeQuoteOrderId":null
}
}
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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