redactOrders

post

/ccagent/v1/orders/redact

Redacts the given properties of the specified orders.

Request

Supported Media Types
Body ()
Root Schema : redactOrders_request
Type: object
Show Source
Example:
{
    "orderIds":[
        "o30411",
        "o30413"
    ],
    "properties":[
        "shippingGroups.firstName",
        "shippingGroups.lastName",
        "paymentGroups.email",
        "paymentGroups.creditCardNumber"
    ]
}
Nested Schema : orderIds
Type: array
The ids of the orders whose properties should be redacted.
Show Source
Nested Schema : properties
Type: array
The names of the order properties to be redacted.
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK.

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |13037|Missing required property: orderIds| |13037|Missing required property: properties| |28402|Error redacting orders.| |28403|The following properties are blocked from redaction, please remove from the set of properties to be redacted - {0}| |28404|Order with id {0} cannot be found.| |28405|Property of type RepositoryItem cannot be redacted, invalid property : {0}| |28405|Property of type Enumerated cannot be redacted, invalid property : {0}| |28405|Property is non writable and cannot be redacted, invalid property : {0}|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top