getAllCarriers
get
/ccadmin/v1/carriers
Get All Carriers. Gets all Carrier Details.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getAllCarriers_response
Type:
Show Source
object
-
items(optional):
array items
List of all carrier Details objects.
Nested Schema : items
Type:
Show Source
object
-
carrierId(optional):
string
Carrier Id
-
carrierName(optional):
string
Carrier Name
-
trackingUrl(optional):
string
Tracking Url for the carrier
Example Response (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|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code