REST API for Oracle Commerce Cloud December 2017

listOrderTypes

get

/ccadmin/v1/orderTypes

List Order Types. Lists all the order types.

Supported Media Types

Query Parameters

name: Type: string

An optional partial displayName of a order type to use for search.
orderTypeIds: Type: string

An optional, comma separated list of specific order type ID's to retrieve.

Supported Media Types

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listOrderTypes_response

items: Type: object items

Additional Properties Allowed: { "type":"string" }

the list of order types keyed by order type name

Nested Schema : items

Type: object

the list of order types keyed by order type name


{
    "order":{
        "displayName":"Order"
    }
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Nested Schema : items

Type: object

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Sample Response Payload returned by endpoint:

{"order": {"displayName": "Order"}}