Jump to

• Request
• Response

Cancel an order

post

/ccadmin/v1/orders/cancel

Cancels the order with the provided orderId. The order must not be in an "Incomplete" state.

Note: You must specify the payload properties orderId and cancelReason

Example cancel reasons:

• badProductReview
• betterCompetitorPrice
• cannotProcessOrder
• changeOfMind
• itemAvailableAtDiscountCurrently
• noLongerNeeded
• noUpdateOnShipmentStatus
• paymentNotReceived

See Merchant Settings Get Cancel Reasons for list of cancel reasons.

Request

Supported Media Types

• application/json

Header Parameters

• X-CCAsset-Language: string
  Instructs the endpoint to use the specified locale code for content returned in the response. The locale supplied in the header must be supported by your store.
• x-ccsite(required): string
  The site ID from which the order was placed.

Body ()

Root Schema : cancelOrder_request

Type: object

Show Source

• cancelReason(required): string
  The cancel reason of the order.
• orderId(required): string
  The ID of the order to be cancelled.

{
    "properties":{
        "orderId":{
            "description":"The ID of the order to be cancelled.",
            "type":"string"
        },
        "cancelReason":{
            "description":"The cancel reason of the order.",
            "type":"string"
        }
    },
    "required":[
        "orderId",
        "cancelReason"
    ],
    "example":{
        "orderId":"o30413",
        "cancelReason":"badProductReview"
    }
}

Example:

{
    "orderId":"o30413",
    "cancelReason":"badProductReview"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : cancelOrder_response

Type: object

Show Source

• result: string
  The result of the cancel operation performed.

{
    "properties":{
        "result":{
            "description":"The result of the cancel operation performed.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "result":"success"
}

Default Response

The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:

Error Code	Description	Possible Fix
200126	Invalid Input.	The request payload has an error in it e.g. spelling mistake
200101	Order is not in a state that can be cancelled.
200218	Invalid cancel reason.	Supply a valid cancel reason.
210105	Order not found.	Supply a valid order ID.

The error response:

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top