Jump to

• Request
• Response

redactOrder

post

/ccadmin/v1/webhook/redactOrder

This is triggered upon a redact order event.

Request

Supported Media Types

• application/json

Body ()

Notifies an external system that an order has been redacted.

Root Schema : redactOrder_request

Type: object

Notifies an external system that an order has been redacted.

Show Source

• orderId(optional): string
  Id of the order that has been redacted.

{
    "description":"Notifies an external system that an order has been redacted.",
    "properties":{
        "orderId":{
            "description":"Id of the order that has been redacted.",
            "type":"string"
        }
    }
}

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