Kibo Commerce Carrier Credential API

openapi: 3.2.0
info:
  title: Kibo Commerce Carrier Credential API
  version: '1.0'
  description: 'Operations tagged CarrierCredential across 3 of this provider''s published API definitions: openapi_openapi_shipping.json, kibo-commerce-shipping-admin-openapi.yml, kibo-commerce-shipping-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Kibo Base URL
  url: '{baseUrl}/api'
  variables:
    baseUrl:
      default: https://t1000000.sb.usc1.gcp.kibocommerce.com
      description: Base URL
security:
- bearerAuth: []
tags:
- name: CarrierCredential
paths:
  /commerce/shipping/admin/carriers/credentials:
    get:
      description: Returns a collection of all carrier credentials
      parameters:
      - description: The starting index.
        in: query
        name: startIndex
        schema:
          format: int32
          type: integer
      - description: The page size.
        in: query
        name: pageSize
        schema:
          format: int32
          type: integer
      - description: Any sorting filters.
        in: query
        name: sortBy
        schema:
          type: string
      - description: Any query filters.
        in: query
        name: filter
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierCredentialCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/CarrierCredentialCollection'
            text/plain:
              schema:
                $ref: '#/components/schemas/CarrierCredentialCollection'
          description: Success
      summary: Get Carrier Credentials
      tags:
      - CarrierCredential
      operationId: getCommerceShippingAdminCarriersCredentials
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/shipping/admin/carriers/credentials/{carrierId}:
    delete:
      description: Deletes carrier credentials
      parameters:
      - description: The carrier ID.
        in: path
        name: carrierId
        required: true
        schema:
          type: string
      - description: The site ID, if any.
        in: query
        name: siteId
        schema:
          format: int32
          type: integer
      - description: The location group code, if any.
        in: query
        name: locationGroupCode
        schema:
          type: string
      - description: The location code, if any.
        in: query
        name: locationCode
        schema:
          type: string
      responses:
        '200':
          description: Success
      summary: Delete Carrier Credentials
      tags:
      - CarrierCredential
      operationId: deleteCommerceShippingAdminCarriersCredentialsByCarrierId
      x-operation-id-source: derived
    get:
      description: Retrieves carrier credentials for a specific Carrier ID
      parameters:
      - description: The carrier ID.
        in: path
        name: carrierId
        required: true
        schema:
          type: string
      - description: The site ID, if any.
        in: query
        name: siteId
        schema:
          format: int32
          type: integer
      - description: The location group code, if any.
        in: query
        name: locationGroupCode
        schema:
          type: string
      - description: The location code, if any.
        in: query
        name: locationCode
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierCredential'
            text/json:
              schema:
                $ref: '#/components/schemas/CarrierCredential'
            text/plain:
              schema:
                $ref: '#/components/schemas/CarrierCredential'
          description: Success
      summary: Get Carrier Credentials by ID
      tags:
      - CarrierCredential
      operationId: getCommerceShippingAdminCarriersCredentialsByCarrierId
      x-operation-id-source: derived
    post:
      description: Creates new carrier credentials. See this guide for details about the fields that are required for each carrier.
      parameters:
      - description: The carrier ID.
        in: path
        name: carrierId
        required: true
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarrierCredential'
        description: The carrier credential data.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierCredential'
            text/json:
              schema:
                $ref: '#/components/schemas/CarrierCredential'
            text/plain:
              schema:
                $ref: '#/components/schemas/CarrierCredential'
          description: Success
      summary: Create Carrier Credentials
      tags:
      - CarrierCredential
      operationId: postCommerceShippingAdminCarriersCredentialsByCarrierId
      x-operation-id-source: derived
    put:
      description: Updates existing carrier credentials. See this guide for details about the fields that are required for each carrier.
      parameters:
      - description: The carrier ID.
        in: path
        name: carrierId
        required: true
        schema:
          type: string
      - description: The site ID, if any.
        in: query
        name: siteId
        schema:
          format: int32
          type: integer
      - description: The location group code, if any.
        in: query
        name: locationGroupCode
        schema:
          type: string
      - description: The location code, if any.
        in: query
        name: locationCode
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarrierCredential'
        description: The carrier credential data.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierCredential'
            text/json:
              schema:
                $ref: '#/components/schemas/CarrierCredential'
            text/plain:
              schema:
                $ref: '#/components/schemas/CarrierCredential'
          description: Success
      summary: Update Carrier Credentials
      tags:
      - CarrierCredential
      operationId: putCommerceShippingAdminCarriersCredentialsByCarrierId
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
components:
  schemas:
    CarrierCredentialSet:
      description: 'Stores a set of <see cref="T:Mozu.ShippingAdmin.Contracts.Carriers.CarrierCredentialSetValue">carrier credential key-value pairs</see>.

        Sets are stored at the tenant level and referenced by a Mozu.ShippingAdmin.Contracts.Carriers.CarrierCredential.'
      properties:
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        carrierId:
          description: 'The Carrier ID associated with this credential set.

            Usually the short name of a carrier (e.g., "FedEx").'
          type:
          - string
          - 'null'
        code:
          description: 'A unique code identifying this credential set.

            The code is only guaranteed to be unique at the tenant and carrier level.'
          type:
          - string
          - 'null'
        integrationId:
          description: Specifies the ID returned from an integration.
          type:
          - string
          - 'null'
        name:
          description: A name (i.e., nickname) for this credential set.
          type:
          - string
          - 'null'
        values:
          description: A collection of values contained in this credential set.
          items:
            $ref: '#/components/schemas/CarrierCredentialSetValue'
          type:
          - array
          - 'null'
      type: object
    AuditInfo:
      properties:
        createBy:
          type:
          - string
          - 'null'
        createDate:
          format: date-time
          type:
          - string
          - 'null'
        updateBy:
          type:
          - string
          - 'null'
        updateDate:
          format: date-time
          type:
          - string
          - 'null'
      type: object
    CarrierCredential:
      description: 'Stores a reference to a Mozu.ShippingAdmin.Contracts.Carriers.CarrierCredentialSet for use at different levels.

        Valid levels include Site, Location Group, and Location. Different levels may be used for rates versus labels.

        Site level is overriden by Location Group level which is overriden by Location level.'
      properties:
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        carrierId:
          description: 'The Carrier ID associated with this carrier credential.

            Usually the short name of a carrier (e.g., "FedEx").'
          type:
          - string
          - 'null'
        credentialSet:
          $ref: '#/components/schemas/CarrierCredentialSet'
        locationCode:
          description: The Location Code associated with this carrier credential, if any.
          type:
          - string
          - 'null'
        locationGroupCode:
          description: The Location Group Code associated with this carrier credential, if any.
          type:
          - string
          - 'null'
        siteId:
          description: The Site ID associated with this carrier credential, if any.
          format: int32
          type:
          - integer
          - 'null'
      type: object
    CarrierCredentialSetValue:
      properties:
        key:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
      type: object
    CarrierCredentialCollection:
      description: A collection of <see cref="T:Mozu.ShippingAdmin.Contracts.Carriers.CarrierCredential">carrier credentials</see>.
      properties:
        items:
          items:
            $ref: '#/components/schemas/CarrierCredential'
          type:
          - array
          - 'null'
        pageCount:
          format: int32
          type: integer
        pageSize:
          format: int32
          type: integer
        startIndex:
          format: int32
          type: integer
        totalCount:
          format: int32
          type: integer
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: JWT Authorization header using the Bearer scheme.
      scheme: bearer
      type: http
x-refined-from:
- openapi_openapi_shipping.json
- kibo-commerce-shipping-admin-openapi.yml
- kibo-commerce-shipping-openapi.yml