Jump to

• Request
• Response

Get valid actions

get

/ccstore/v1/orders/validActions/{id}

Verifies whether the specified order can be cancelled or returned.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  the ID of the order to retrieve.

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-CCOrganization: string
  Current organization context of the logged in user

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : getValidActions_response

Type: object

Show Source

• cancel: object cancel
  cancel information
• return: object return
  return information

{
    "properties":{
        "cancel":{
            "description":"cancel information",
            "type":"object",
            "properties":{
                "isInitialValForCancelInFlightPassed":{
                    "description":"returns true if cancel inflight allowed for the order",
                    "type":"boolean"
                },
                "isCancelAllowed":{
                    "description":"returns true if cancel is allowed for the order",
                    "type":"boolean"
                }
            }
        },
        "return":{
            "description":"return information",
            "type":"object",
            "properties":{
                "isReturnAllowed":{
                    "description":"returns true if return is allowed for the order",
                    "type":"boolean"
                }
            }
        }
    }
}

Nested Schema : cancel

Type: object

cancel information

Show Source

• isCancelAllowed: boolean
  returns true if cancel is allowed for the order
• isInitialValForCancelInFlightPassed: boolean
  returns true if cancel inflight allowed for the order

{
    "description":"cancel information",
    "type":"object",
    "properties":{
        "isInitialValForCancelInFlightPassed":{
            "description":"returns true if cancel inflight allowed for the order",
            "type":"boolean"
        },
        "isCancelAllowed":{
            "description":"returns true if cancel is allowed for the order",
            "type":"boolean"
        }
    }
}

Nested Schema : return

Type: object

return information

Show Source

• isReturnAllowed: boolean
  returns true if return is allowed for the order

{
    "description":"return information",
    "type":"object",
    "properties":{
        "isReturnAllowed":{
            "description":"returns true if return is allowed for the order",
            "type":"boolean"
        }
    }
}

Example Response (application/json)

{
    "cancel":{
        "isInitialValForCancelInFlightPassed":false,
        "isCancelAllowed":true
    },
    "returns":{
        "isReturnAllowed":false
    }
}

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
210105	Order not found.	Ensure that you enter 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