redactOrders
post
/ccagent/v1/orders/redact
Redacts the given properties of the specified orders.
Request
Supported Media Types
- application/json
Root Schema : redactOrders_request
Type:
Show Source
object
-
orderIds:
array orderIds
The ids of the orders whose properties should be redacted.
-
properties:
array properties
The names of the order properties to be redacted.
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
Response
Supported Media Types
- application/json
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}|
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