Jump to

• Request
• Response

orderFailure

post

/ccadmin/v1/webhook/orderFailure

Notifies external systems that an order submission failure has occurred with failure cause details.

Request

Supported Media Types

• application/json

Body ()

Notifies an external system that an order has been deleted.

Root Schema : orderFailure_request

Type: object

Notifies an external system that an order has been deleted.

Show Source

• failedProcess: string
  The process that failed during order submission.
• failureCause: string
  The cause of the failure.
• returnedStatusCode: integer
  The status code returned when the failure occurred.

{
    "description":"Notifies an external system that an order has been deleted.",
    "properties":{
        "returnedStatusCode":{
            "description":"The status code returned when the failure occurred.",
            "type":"integer"
        },
        "failedProcess":{
            "description":"The process that failed during order submission.",
            "type":"string"
        },
        "failureCause":{
            "description":"The cause of the failure.",
            "type":"string"
        }
    },
    "example":{
        "returnedStatusCode":"N/A",
        "failedProcess":"Avalara Tax Processing",
        "failureCause":"Avalara Account Authentication Failure"
    }
}

Example:

{
    "returnedStatusCode":"N/A",
    "failedProcess":"Avalara Tax Processing",
    "failureCause":"Avalara Account Authentication Failure"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

No response is returned as this is an event webhook

Body ()

Root Schema : emptyResponse

Show Source

{
    "properties":{
    }
}

Back to Top