removeIncompleteOrderForProfile
delete
/ccagent/v1/orders
Remove Incomplete Order For Profile. Removes the incomplete order for the profileId specified as query parameter. If the incomplete orderId passed as query parameter, it removes incomplete cart for the profileId. Additonally takes x-ccsite header to submit the edited order in a site. If the site information is not provided takes the order site. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization for a B2B user.
Request
Supported Media Types
- application/json
Query Parameters
-
orderId: string
The incomplete order id.
-
profileId: string
The customer profile id.
Header Parameters
-
X-CCOrganization(optional): string
the organization Id in which order should be created
-
x-ccsite(optional): string
the site id on which the orders is placed
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : removeIncompleteOrderForProfile_response
Type:
Show Source
object
-
orderId(optional):
string
Order Id of the incomplete order which is removed
Example Response (application/json)
{
"orderId":"o10001",
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/orders/?profileId=se-570032"
}
]
}
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|
|------------------|------------------|
|100094|Organization passed in the header is currently inactive|
|100095|The order or return request does not belong to the current organization of the shopper profile|
|100096|The organization associated to the order or return request was deleted / does not exist|
|100097|The organization associated to the order or return request is currently inactive|
|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|
|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|
|22000|No profile found with profile id /profile Id passed is null or empty|
|28316|Order remove failed|
|22001|An internal error occurred while processing input request.|
|30015|SiteId passed in x-ccsite header is currently inactive|
|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|
|28313|There is no incomplete order for this profile.|
|100101|The shopper profile does not belong to organization passed in the header|
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