REST API for Oracle Commerce Cloud December 2017

addCarrier

post

/ccadmin/v1/carriers

Add Carrier. Adds the Carrier Details.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : addCarrier_request

Example


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

Properties

carrierId: Type: string

Required: true

Carrier Id.
carrierName: Type: string

Required: true

Carrier Name.
trackingUrl: Type: string

Required: true

Tracking Url for the carrier.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : addCarrier_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| |------------------|------------------| |96016|Tracking Url format is invalid.| |96017|Missing Carrier Name.| |96018|Missing Carrier Id.| |96019|Already a carrier added for the given id.| |96012|Missing Carrier Tracking Url.| |96013|Carrier name passed is null.| |96014|Carrier Id passed is null.| |96015|Carrier Tracking Url passed is null.| |96010|Unable to save 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 Request:

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

Sample Response Payload returned by endpoint:

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