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 ()

Root Schema : redactOrder_request

Type: object

Show Source

• properties(required): array properties
  The names of the order properties to be redacted.

{
    "properties":{
        "properties":{
            "description":"The names of the order properties to be redacted.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "properties"
    ],
    "example":{
        "properties":[
            "shippingGroups.firstName",
            "shippingGroups.lastName",
            "paymentGroups.email",
            "paymentGroups.creditCardNumber"
        ]
    }
}

Example:

{
    "properties":[
        "shippingGroups.firstName",
        "shippingGroups.lastName",
        "paymentGroups.email",
        "paymentGroups.creditCardNumber"
    ]
}

Nested Schema : properties

Type: array

The names of the order properties to be redacted.

Show Source

• Array of: string

{
    "description":"The names of the order properties to be redacted.",
    "type":"array",
    "items":{
        "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