FedEx Irc API

openapi: 3.2.0
info:
  title: Credential Registration Irc API
  version: '1.1'
servers:
- url: /
tags:
- name: Irc
paths:
  /irc/v1/customerkeys:
    post:
      summary: Create Customer Key
      description: 'Compatible Providers can use this end point to generate Customer Key and Customer Secret for their customers. Customer Key and Customer Secret along with your API Key and Secret Key are required to generate OAuth token, which should be used in every API transaction.


        Note: OAuth token generated with your API Key and Secret Key should be passed in the authorization header in this API call. Please refer to Authentication Guide for more information.


        Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.'
      operationId: CreateCustomerKey
      parameters:
      - name: appmode
        in: query
        description: 'Specifies the level or mode where key is getting created.<br>Example: sandbox or live'
        style: form
        explode: true
        schema:
          type: string
          example: sandbox,live
      - in: header
        name: x-customer-transaction-id
        description: This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
        required: false
        schema:
          type: string
          example: 624deea6-b709-470c-8c39-4b5511281492
      - in: header
        name: content-type
        description: This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
        required: true
        schema:
          type: string
          example: application/json
      - in: header
        name: x-locale
        description: This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
        required: false
        schema:
          type: string
          example: en_US
      - in: header
        name: authorization
        description: This indicates the authorization token for the input request.
        required: true
        schema:
          type: string
          example: Bearer XXX
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerKeyInputVO'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IrcpResponseVO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseVO'
              example:
                transactionId: 624deea6-b709-470c-8c39-4b5511281492
                errors:
                - code: USER.ACCOUNT.NOTFOUND
                  message: Account Not Found in Database.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseVO401'
              example:
                transactionId: 624deea6-b709-470c-8c39-4b5511281492
                errors:
                - code: NOT.AUTHORIZED.ERROR
                  message: Access token expired. Please modify your request and try again.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseVO403'
              example:
                transactionId: 624deea6-b709-470c-8c39-4b5511281492
                errors:
                - code: FORBIDDEN.ERROR
                  message: We could not authorize your credentials. Please check your permissions and try again.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseVO404'
              example:
                transactionId: 624deea6-b709-470c-8c39-4b5511281482
                errors:
                - code: NOT.FOUND.ERROR
                  message: The resource you requested is no longer available. Please modify your request and try again.
        '500':
          description: Failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseVO500'
              example:
                transactionId: 624deea6-b709-470c-8c39-4b5511281492
                errors:
                - code: INTERNAL.SERVER.ERROR
                  message: We encountered an unexpected error and are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time.
      x-code-samples:
      - lang: C#
        source: 'var client = new RestClient("https://apis-sandbox.fedex.com/irc/v1/customerkeys");

          var request = new RestRequest(Method.POST);

          request.AddHeader("Authorization", "Bearer ");

          request.AddHeader("X-locale", "en_US");

          request.AddHeader("Content-Type", "application/json");

          // ''input'' refers to JSON Payload

          request.AddParameter("application/x-www-form-urlencoded", input, ParameterType.RequestBody);

          IRestResponse response = client.Execute(request);





          '
      - lang: JAVA
        source: "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\n// 'input' refers to JSON Payload\nRequestBody body = RequestBody.create(mediaType, input);\nRequest request = new Request.Builder()\n    .url(\"https://apis-sandbox.fedex.com/irc/v1/customerkeys\")\n    .post(body)\n    .addHeader(\"Content-Type\", \"application/json\")\n    .addHeader(\"X-locale\", \"en_US\")\n    .addHeader(\"Authorization\", \"Bearer \")\n    .build();\n            \nResponse response = client.newCall(request).execute();"
      - lang: JAVASCRIPT
        source: "// 'input' refers to JSON Payload\nvar data = JSON.stringify(input);\n  \n  var xhr = new XMLHttpRequest();\n  xhr.withCredentials = true;\n  \n  xhr.addEventListener(\"readystatechange\", function () {\n    if (this.readyState === 4) {\n      console.log(this.responseText);\n    }\n  });\n  \n  xhr.open(\"POST\", \"https://apis-sandbox.fedex.com/irc/v1/customerkeys\");\n  xhr.setRequestHeader(\"Content-Type\", \"application/json\");\n  xhr.setRequestHeader(\"X-locale\", \"en_US\");\n  xhr.setRequestHeader(\"Authorization\", \"Bearer \");\n  \n  xhr.send(data);"
      - lang: PHP
        source: "<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://apis-sandbox.fedex.com/irc/v1/customerkeys');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders(array(\n  'Authorization' => 'Bearer ',\n  'X-locale' => 'en_US',\n  'Content-Type' => 'application/json'\n));\n\n$request->setBody(input); // 'input' refers to JSON Payload\n\ntry {\n  $response = $request->send();\n\n  echo $response->getBody();\n} catch (HttpException $ex) {\n  echo $ex;\n}"
      - lang: PYTHON
        source: "import requests\n\nurl = \"https://apis-sandbox.fedex.com/irc/v1/customerkeys\"\n\npayload = input # 'input' refers to JSON Payload\nheaders = {\n    'Content-Type': \"application/json\",\n    'X-locale': \"en_US\",\n    'Authorization': \"Bearer \"\n    }\n\nresponse = requests.post(url, data=payload, headers=headers)\n\nprint(response.text)"
      - lang: RUST
        source: "extern crate reqwest;\n\nuse std::io::Read;\n\nfn construct_headers() -> HeaderMap {\n    let mut headers = HeaderMap::new();\n    headers.insert(\"Content-Type\", \"application/json\");\n    headers.insert(\"X-locale\", \"en_US\");\n    headers.insert(\"Authorization\", \"Bearer \");\n    headers\n}\n\nfn run() -> Result<()> {\n    let client = reqwest::Client::new();\n    let mut res = client.post(\"https://apis-sandbox.fedex.com/irc/v1/customerkeys\")\n        .body(input) // 'input' refers to JSON Payload\n        .headers(construct_headers())\n        .send()?;\n    let mut body = String::new();\n    res.read_to_string(&mut body)?;\n\n    println!(\"Status: {}\", res.status());\n    println!(\"Headers:\\n{:#?}\", res.headers());\n    println!(\"Body:\\n{}\", body);\n\n    Ok(())\n}"
      - lang: SWIFT
        source: "import Foundation\n\nlet headers = [\n  \"Content-Type\": \"application/json\",\n  \"X-locale\": \"en_US\",\n  \"Authorization\": \"Bearer \"\n]\nlet parameters = [\n  input // 'input' refers to JSON Payload\n] as [String : Any]\n\nlet postData = JSONSerialization.data(withJSONObject: parameters, options: [])\n\nlet request = NSMutableURLRequest(url: NSURL(string: \"https://apis-sandbox.fedex.com/irc/v1/customerkeys\")! as URL,\n                                        cachePolicy: .useProtocolCachePolicy,\n                                    timeoutInterval: 10.0)\nrequest.httpMethod = \"POST\"\nrequest.allHTTPHeaderFields = headers\nrequest.httpBody = postData as Data\n\nlet session = URLSession.shared\nlet dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in\n  if (error != nil) {\n    print(error)\n  } else {\n    let httpResponse = response as? HTTPURLResponse\n    print(httpResponse)\n  }\n})\n\ndataTask.resume()"
      tags:
      - Irc
      x-operation-id-source: normalized
      x-operation-id-original: Create Customer Key
components:
  schemas:
    Parameter:
      type: object
      properties:
        value:
          type: string
          description: This is a placeholder for parameter value.
        key:
          type: string
          description: This is a placeholder for parameter key.
      description: This object provides additional paramter details resulted in the alert.
    AddressVO:
      required:
      - city
      - countryCode
      - postalCode
      - residential
      - stateOrProvinceCode
      - streetLines
      type: object
      properties:
        residential:
          type: boolean
          description: Indicates whether this address is residential (as opposed to commercial).
          example: true
        city:
          type: string
          description: Specify name of city or town.
          example: Beverly Hills
        countryCode:
          type: string
          description: The two-letter code used to identify a country. Max length is 2.
          example: US
        postalCode:
          type: string
          description: Use this element to input postal code. Postal code is mandatory for postal-aware countries. The Max length is 10.
          example: '45245'
        streetLines:
          type: array
          description: Provide street address which is a combination of number, street name, etc. At least one line is required. For a valid physical address, empty lines should not be included. Max Length is 35.
          example:
          - 10 FedEx Parkway
          - Suite 302
          items:
            type: string
        stateOrProvinceCode:
          type: string
          description: Provide 2 letter state or province code.. Max length is 2
          example: OH
      description: Indicates the customer's address you are attempting to get the Customer Key and Customer Secret for. Note that address information needs to match the Shipping or billing address as loaded in FedEx systems. Contact FedEx support team for any address-related issues or questions.
    ErrorResponseVO500:
      type: object
      properties:
        transactionId:
          type: string
          description: 'The transaction ID is a special set of numbers that defines each transaction.<br>Example: 624deea6-b709-470c-8c39-4b5511281492'
          example: 624deea6-b709-470c-8c39-4b5511281492
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CXSError500'
    Alert:
      type: object
      properties:
        code:
          type: string
          description: Specifies the cxs alert code.
        alertType:
          type: string
          description: Specifies the cxs alert type.
          enum:
          - NOTE
          - WARNING
        parameterList:
          type: array
          description: This object provides additional paramters resulted in the alert.
          items:
            $ref: '#/components/schemas/Parameter'
        message:
          type: string
          description: Specifies the cxs alert message.
      description: Specifies the cxs alerts.
    CustomerKeyOutputVO:
      required:
      - customerKey
      - customerPassword
      type: object
      properties:
        customerKey:
          type: string
          description: Customer Key is a JSON Web Token provided for each of your customers. You must use the Customer Key along with the Client Key, Client Secret and Customer Secret to get oAuth token, which should be used as credentials with each API transaction.
          example: '12345'
        customerPassword:
          type: string
          description: Customer Password, also referred to as <i>Customer Secret</i>, is provided for each of your customers. You must use the Customer Secret along with the Client Key, Client Secret and Customer Key to get the oAuth token, which should be used as credentials with each API transaction.
          example: '*******'
        alerts:
          type: array
          description: Specifies the cxs alerts.
          items:
            $ref: '#/components/schemas/Alert'
      description: This is the response object providing Customer Key and secret key as a output.
    CXSError500:
      type: object
      properties:
        code:
          type: string
          description: 'Indicates the error code.<br>Example: INTERNAL.SERVER.ERROR'
        parameterList:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
        message:
          description: 'Indicates the description of API error alert message.<br>Example: We encountered an unexpected error and are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time.'
      description: Indicates error alert when suspicious files, potential exploits and viruses found while scanning files , directories and user accounts. This includes code, message and parameter
    ErrorResponseVO403:
      type: object
      properties:
        transactionId:
          type: string
          description: 'The transaction ID is a special set of numbers that defines each transaction.<br>Example: 624deea6-b709-470c-8c39-4b5511281492'
          example: 624deea6-b709-470c-8c39-4b5511281492
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CXSError403'
    CXSError403:
      type: object
      properties:
        code:
          type: string
          description: 'Indicates the error code.<br>Example: FORBIDDEN.ERROR'
        parameterList:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
        message:
          description: 'Indicates the description of API error alert message.<br>Example: We could not authorize your credentials. Please check your permissions and try again'
      description: Indicates error alert when suspicious files, potential exploits and viruses found while scanning files , directories and user accounts. This includes code, message and parameter
    CXSError404:
      type: object
      properties:
        code:
          type: string
          description: 'Indicates the error code.<br>Example: NOT.FOUND.ERROR'
        parameterList:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
        message:
          description: 'Indicates the description of API error alert message.<br>Example: The resource you requested is no longer available. Please modify your request and try again.'
      description: Indicates error alert when suspicious files, potential exploits and viruses found while scanning files , directories and user accounts. This includes code, message and parameter
    CXSError401:
      type: object
      properties:
        code:
          type: string
          description: 'Indicates the error code.<br>Example: NOT.AUTHORIZED.ERROR'
        parameterList:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
        message:
          description: 'Indicates the description of API error alert message.<br>Example: Access token expired. Please modify your request and try again.'
      description: Indicates error alert when suspicious files, potential exploits and viruses found while scanning files , directories and user accounts. This includes code, message and parameter
    BaseProcessOutputVO:
      $ref: '#/components/schemas/CustomerKeyOutputVO'
    CustomerKeyInputVO:
      required:
      - accountNumber
      - address
      - customerName
      type: object
      properties:
        address:
          $ref: '#/components/schemas/AddressVO'
        accountNumber:
          type: string
          description: This is the FedEx account number requesting authentication details.
          example: '125478963'
        customerName:
          type: string
          description: Name of the customer or company requesting authentication details.
          example: George
      description: This is a request object for requesting customer key and secret key.
    IrcpResponseVO:
      type: object
      properties:
        transactionId:
          type: string
          description: 'The transaction ID is a special set of numbers that defines each transaction.<br>Example: 624deea6-b709-470c-8c39-4b5511281492'
          example: 624deea6-b709-470c-8c39-4b5511281492
        output:
          $ref: '#/components/schemas/BaseProcessOutputVO'
      description: This is a wrapper class for outputVO
    CXSError:
      type: object
      properties:
        code:
          type: string
          description: 'Indicates the error code.<br>Example: ERROR.LONGLAT.REQUIRED'
          example: USER.ACCOUNT.NOTFOUND
        parameterList:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
        message:
          type: string
          description: 'Indicates the description of API error alert message.<br>Example: Account Not Found in Database.'
      description: Indicates error alert when suspicious files, potential exploits and viruses found while scanning files , directories and user accounts. This includes code, message and parameter
    ErrorResponseVO:
      type: object
      properties:
        transactionId:
          type: string
          description: 'The transaction ID is a special set of numbers that defines each transaction.<br>Example: 624deea6-b709-470c-8c39-4b5511281492'
          example: 624deea6-b709-470c-8c39-4b5511281492
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CXSError'
    ErrorResponseVO401:
      type: object
      properties:
        transactionId:
          type: string
          description: 'The transaction ID is a special set of numbers that defines each transaction.<br>Example: 624deea6-b709-470c-8c39-4b5511281492'
          example: 624deea6-b709-470c-8c39-4b5511281492
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CXSError401'
    ErrorResponseVO404:
      type: object
      properties:
        transactionId:
          type: string
          description: 'The transaction ID is a special set of numbers that defines each transaction.<br>Example: 624deea6-b709-470c-8c39-4b5511281492'
          example: 624deea6-b709-470c-8c39-4b5511281492
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CXSError404'