REST API for Oracle Commerce Cloud December 2017

getCarrier

get

/ccadmin/v1/carriers/{id}

Get Carrier. Gets the Carrier Details.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

Carrier Id.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getCarrier_response

Properties

carrierId: Type: string

Carrier Id.
carrierName: Type: string

Carrier Name.
trackingUrl: Type: string

Tracking Url for the carrier.

Example application/json


{
    "carrierName":"Fedex",
    "trackingUrl":"http://www.fedex.com/Tracking?action=track&tracknumbers=$$$$",
    "carrierId":"FED"
}

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| |------------------|------------------| |96018|Missing Carrier Id.| |96020|No Carrier found for the given id.| |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:

{
  "carrierName": "Fedex",
  "trackingUrl": "http://www.fedex.com/Tracking?action=track&tracknumbers=$$$$",
  "carrierId": "FED"
}