REST API for Oracle Commerce Cloud December 2017

getAllCarriers

get

/ccadmin/v1/carriers

Get All Carriers. Gets all Carrier Details.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getAllCarriers_response

Properties

items: Type: array items

Additional Properties Allowed:

List of all carrier Details objects.

Nested Schema : items

Type: array

List of all carrier Details objects.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

carrierId: Type: string

Carrier Id
carrierName: Type: string

Carrier Name
trackingUrl: Type: string

Tracking Url for the carrier

Example application/json


{
    "items":[
        {
            "carrierName":"LaserShip",
            "trackingUrl":"http://www.lasership.com/track.php?track_number_input=$$$$",
            "carrierId":"LaserShip"
        },
        {
            "carrierName":"OnTrac",
            "trackingUrl":"http://www.ontrac.com/trackingdetail.asp?tracking=$$$$",
            "carrierId":"OnTrac"
        },
        {
            "carrierName":"USPS",
            "trackingUrl":"https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=$$$$",
            "carrierId":"USPS"
        },
        {
            "carrierName":"ICCWorld",
            "trackingUrl":"http://iccworld.com/track.asp?txtawbno=$$$$",
            "carrierId":"ICCWorld"
        }
    ]
}

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| |------------------|------------------| |96011|Unable to load carrier data|

Body

Root Schema : errorModel

Type: object

Properties

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

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

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

Examples

Sample Response Payload returned by endpoint:

{"items": [
  {
    "carrierName": "LaserShip",
    "trackingUrl": "http://www.lasership.com/track.php?track_number_input=$$$$",
    "carrierId": "LaserShip"
  },
  {
    "carrierName": "OnTrac",
    "trackingUrl": "http://www.ontrac.com/trackingdetail.asp?tracking=$$$$",
    "carrierId": "OnTrac"
  },
  {
    "carrierName": "USPS",
    "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=$$$$",
    "carrierId": "USPS"
  },
  {
    "carrierName": "ICCWorld",
    "trackingUrl": "http://iccworld.com/track.asp?txtawbno=$$$$",
    "carrierId": "ICCWorld"
  }
]}