Jump to

• Request
• Response

addCarrier

post

/ccadmin/v1/carriers

Add Carrier. Adds the Carrier Details.

Request

Supported Media Types

• application/json

Body ()

Root Schema : addCarrier_request

Type: object

Show Source

• carrierId: string
  Carrier Id.
• carrierName: string
  Carrier Name.
• trackingUrl: string
  Tracking Url for the carrier.

{
    "properties":{
        "carrierName":{
            "description":"Carrier Name.",
            "type":"string"
        },
        "trackingUrl":{
            "description":"Tracking Url for the carrier.",
            "type":"string"
        },
        "carrierId":{
            "description":"Carrier Id.",
            "type":"string"
        }
    },
    "required":[
        "carrierName",
        "trackingUrl",
        "carrierId"
    ],
    "example":{
        "carrierName":"Fedex",
        "trackingUrl":"http://www.fedex.com/Tracking?action=track&tracknumbers=$$$$",
        "carrierId":"FED"
    }
}

Example:

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : addCarrier_response

Type: object

Show Source

• carrierId(optional): string
  Carrier Id.
• carrierName(optional): string
  Carrier Name.
• trackingUrl(optional): string
  Tracking Url for the carrier.

{
    "properties":{
        "carrierName":{
            "description":"Carrier Name.",
            "type":"string"
        },
        "trackingUrl":{
            "description":"Tracking Url for the carrier.",
            "type":"string"
        },
        "carrierId":{
            "description":"Carrier Id.",
            "type":"string"
        }
    }
}

Example Response (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

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top