Kibo Commerce Carrier Configuration API

openapi: 3.2.0
info:
  title: Kibo Commerce Carrier Configuration API
  version: '1.0'
  description: 'Operations tagged CarrierConfiguration 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: CarrierConfiguration
paths:
  /commerce/shipping/admin/carriers/{carrierId}:
    delete:
      description: Delete an existing Carrier Configuration
      parameters:
      - description: ''
        in: path
        name: carrierId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
      summary: Delete Carrier Configuration
      tags:
      - CarrierConfiguration
      operationId: deleteCommerceShippingAdminCarriersByCarrierId
      x-operation-id-source: derived
    get:
      description: Get Carrier Configuration (for this particular site)
      parameters:
      - description: ''
        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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierConfiguration'
            text/json:
              schema:
                $ref: '#/components/schemas/CarrierConfiguration'
            text/plain:
              schema:
                $ref: '#/components/schemas/CarrierConfiguration'
          description: Success
      summary: Get carrier configuration information
      tags:
      - CarrierConfiguration
      operationId: getCommerceShippingAdminCarriersByCarrierId
      x-operation-id-source: derived
    post:
      description: Create a new carrier configuration. The settings[] field is deprecated and no longer needs to be provided when working with credential sets.
      parameters:
      - description: ''
        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/CarrierConfiguration'
        description: ''
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierConfiguration'
            text/json:
              schema:
                $ref: '#/components/schemas/CarrierConfiguration'
            text/plain:
              schema:
                $ref: '#/components/schemas/CarrierConfiguration'
          description: Success
      summary: Create Carrier Configuration
      tags:
      - CarrierConfiguration
      operationId: postCommerceShippingAdminCarriersByCarrierId
      x-operation-id-source: derived
    put:
      description: Update an existing carrier configuration. The settings[] field is deprecated and no longer needs to be provided when working with credential sets.
      parameters:
      - description: ''
        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/CarrierConfiguration'
        description: ''
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierConfiguration'
            text/json:
              schema:
                $ref: '#/components/schemas/CarrierConfiguration'
            text/plain:
              schema:
                $ref: '#/components/schemas/CarrierConfiguration'
          description: Success
      summary: Update Carrier Configuration
      tags:
      - CarrierConfiguration
      operationId: putCommerceShippingAdminCarriersByCarrierId
      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:
    get:
      description: Retrieves a list of Carrier Configurations according to any specified filter criteria and sort options
      parameters:
      - description: Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. Optional.
        in: query
        name: startIndex
        schema:
          default: 0
          format: int32
          type: integer
      - description: Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. Optional.
        in: query
        name: pageSize
        schema:
          default: 0
          format: int32
          type: integer
      - description: The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.
        in: query
        name: sortBy
        schema:
          type: string
      - description: 'A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.'
        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/CarrierConfigurationCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/CarrierConfigurationCollection'
            text/plain:
              schema:
                $ref: '#/components/schemas/CarrierConfigurationCollection'
          description: Success
      summary: Get Carrier Configurations
      tags:
      - CarrierConfiguration
      operationId: getCommerceShippingAdminCarriers
      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:
    CustomTableRate:
      description: ''
      properties:
        content:
          $ref: '#/components/schemas/CustomTableRateContent'
        deliveryDuration:
          description: "The number of days it takes to ship the item on custom carrier types. \nAllowed values : EXPRESS, 1_DAY, 2_DAY, 3_DAY"
          type:
          - string
          - 'null'
        id:
          description: The Id of the CustomTableRate
          type:
          - string
          - 'null'
        rateType:
          description: 'The type of this rate

            <value>see ../commerce/catalog/admin/shipping/global/carriers/custom/serviceTypes/en-us</value>'
          type:
          - string
          - 'null'
        value:
          description: The value of this custom table rate
          format: double
          type: number
      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
    CarrierConfigurationCollection:
      description: Collection of carrrier configurations.
      properties:
        items:
          items:
            $ref: '#/components/schemas/CarrierConfiguration'
          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
    Setting:
      properties:
        key:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
      type: object
    CarrierConfiguration:
      properties:
        areCredentialsSet:
          description: 'Indicates whether the credentials/passwords are set.

            <remarks>Credetials are updated only if this flag is set to true</remarks>'
          type: boolean
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        customTableRates:
          description: 'A list of custom table rates for the ''Custom'' carrier

            <remarks>only use this if Id == ''Custom''</remarks>'
          items:
            $ref: '#/components/schemas/CustomTableRate'
          type:
          - array
          - 'null'
        enabled:
          description: Indicates that this CarrierConfiguration should be used at runtime
          type: boolean
        enabledForReturns:
          description: Indicates that this CarrierConfiguration should be the default for returns shipping
          type: boolean
        id:
          description: Carrier Id (usually a shortname of a carrier, e.g. FedEx)
          type:
          - string
          - 'null'
        isDeliveryMethod:
          type: boolean
        settings:
          description: Carrier Configuration Settings
          items:
            $ref: '#/components/schemas/Setting'
          type:
          - array
          - 'null'
      type: object
    CustomTableRateContent:
      description: ''
      properties:
        localeCode:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
      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