SERTICA

SERTICA Carriers API

The Carriers API from SERTICA — 16 operation(s) for carriers.

GitHub OpenAPI

Operations 20

GET /Carriers Gets a list of Carriers #
POST /Carriers Creates a new Carrier record #
GET /Carriers/{carrierNo} Gets a specific Carrier #
PUT /Carriers/{carrierNo} Updates an existing Carrier #
DELETE /Carriers/{carrierNo} Deletes a Carrier record #
POST /Carriers/search Search for Carriers. #
POST /Carriers/searchCount Returns number of hits in a search for Carriers Takes a SearchDefinition input… #
POST /Carriers/searchIndex/{carrierGuid} Get index of a record in a search for Carriers Takes a SearchDefinition input… #
GET /Carriers/searchInfo Returns structured information about what and how you can search for #
GET /Carriers/{carrierNo}/documents Returns a list of Documents used on the Carrier #
GET /Carriers/{carrierNo}/packages Returns a list of Packages used on the Carrier #
GET /Carriers/{carrierNo}/positions Returns a list of Positions used on the Carrier #
GET /Carriers/{carrierNo}/responses Gets a list of Carrier Responses #
POST /Carriers/{carrierNo}/responses Creates a new Carrier Response for the Carrier #
GET /Carriers/{carrierNo}/responses/count Returns the number of Responses on a specific Carrier #
POST /Carriers/labels/{labelTemplateDocumentNo} Gets the labels to print #
GET /Carriers/{carrierNo}/history Gets history for a specific Carrier #
GET /Carriers/{CarrierNo}/copy Copies an existing Carrier to a new object #
GET /Carriers/labels/{labelTemplateDocumentNo}/{settingsKey} Get the labels to print using settings key #
GET /Carriers/{carrierNo}/shipments Gets a list of linked Shipments #

Documentation

📖
Documentation
https://support.sertica.com/hc/en-us/articles/28558470734109-SERTICA-Application-Programming-Interface
📖
APIReference
https://docs.sertica.com/api/swagger/index.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/authentication/sertica-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/openapi/sertica-carriers-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/errors/sertica-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/conventions/sertica-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/data-model/sertica-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/asyncapi/sertica-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sertica-carriers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sertica-carriers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SERTICA Web Carriers API
  description: 'Online API browser for SERTICA Web API.


    Be aware that some endpoints are restricted by license or user rights and may not be available in your environment.


    Each endpoint includes a description of the required license and user rights.'
  version: v1
servers:
- url: /api
tags:
- name: Carriers
paths:
  /Carriers:
    get:
      tags:
      - Carriers
      summary: Gets a list of Carriers
      operationId: GetCarriers
      parameters:
      - name: page
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 25
      responses:
        '200':
          description: Returns all Carriers
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
    post:
      tags:
      - Carriers
      summary: Creates a new Carrier record
      operationId: CreateCarrier
      requestBody:
        description: The Carrier Object, including reference lists
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
      responses:
        '201':
          description: Returns the created Carrier object
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
        '400':
          description: Returns a validation result with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier_Update</td><td style='border-bottom:none'>Update</td></tr></tbody></table><br/><br/>Customer must have one of these License values set<table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>ProcurementDistributionModule</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Carriers/{carrierNo}:
    get:
      tags:
      - Carriers
      summary: Gets a specific Carrier
      operationId: GetCarrier
      parameters:
      - name: carrierNo
        in: path
        description: The Carrier No to get
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the requested Carrier
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
        '400':
          description: Returns a validation result with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '404':
          description: If a Carrier with the supplied Carrier No cannot be found
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
    put:
      tags:
      - Carriers
      summary: Updates an existing Carrier
      operationId: UpdateCarrier
      parameters:
      - name: carrierNo
        in: path
        description: The Carrier No of the Carrier to update
        required: true
        schema:
          type: string
      requestBody:
        description: The Carrier DTO object with the fields to update
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
      responses:
        '200':
          description: Returns the updated Carrier object
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
        '400':
          description: Returns a ValidationResult with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '404':
          description: If a Carrier with the supplied Carrier No cannot be found
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier_Update</td><td style='border-bottom:none'>Update</td></tr></tbody></table><br/><br/>Customer must have one of these License values set<table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>ProcurementDistributionModule</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
    delete:
      tags:
      - Carriers
      summary: Deletes a Carrier record
      parameters:
      - name: carrierNo
        in: path
        description: The Carrier No of the Carrier to delete
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Returns NoContent result if the Carrier is succesfully deleted
        '400':
          description: Returns a validation result with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '404':
          description: If a Carrier with the supplied Carrier No cannot be found
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier_Delete</td><td style='border-bottom:none'>Delete</td></tr></tbody></table><br/><br/>Customer must have one of these License values set<table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>ProcurementDistributionModule</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
      operationId: deleteCarriersByCarrierNo
      x-operation-id-source: derived
  /Carriers/search:
    post:
      tags:
      - Carriers
      summary: Search for Carriers.
      operationId: SearchCarriers
      parameters:
      - name: page
        in: query
        description: Page
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size
        schema:
          type: integer
          format: int32
          default: 25
      requestBody:
        description: The search definition
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          text/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
      responses:
        '200':
          description: Returns all Carriers matching the search criteria
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.Carrier'
        '400':
          description: Returns a validation result with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Carriers/searchCount:
    post:
      tags:
      - Carriers
      summary: Returns number of hits in a search for Carriers Takes a SearchDefinition input…
      operationId: SearchCountCarriers
      requestBody:
        description: The search definition
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          text/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
      responses:
        '200':
          description: Returns number of hits in a search for Carriers
          content:
            text/plain:
              schema:
                type: integer
                format: int32
            application/json:
              schema:
                type: integer
                format: int32
            text/json:
              schema:
                type: integer
                format: int32
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Carriers/searchIndex/{carrierGuid}:
    post:
      tags:
      - Carriers
      summary: Get index of a record in a search for Carriers Takes a SearchDefinition input…
      operationId: SearchIndexCarriers
      parameters:
      - name: carrierGuid
        in: path
        description: The carrier to find index for
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: The search definition
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          text/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
      responses:
        '200':
          description: Returns the index of a record in a search for Carriers or -1 if not found
          content:
            text/plain:
              schema:
                type: integer
                format: int32
            application/json:
              schema:
                type: integer
                format: int32
            text/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Returns a validation result with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Carriers/searchInfo:
    get:
      tags:
      - Carriers
      summary: Returns structured information about what and how you can search for
      operationId: CarrierSearchInfo
      responses:
        '200':
          description: Returns a list of valid search fields
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo'
            application/json:
              schema:
                $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo'
            text/json:
              schema:
                $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo'
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
  /Carriers/{carrierNo}/documents:
    get:
      tags:
      - Carriers
      summary: Returns a list of Documents used on the Carrier
      operationId: GetCarrierDocuments
      parameters:
      - name: carrierNo
        in: path
        description: The Carrier No to fetch Documents for
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the Documents for the Carrier
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierDocument'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierDocument'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierDocument'
        '400':
          description: Returns a validation result with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '404':
          description: If a Carrier with the supplied Carrier No cannot be found
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Carriers/{carrierNo}/packages:
    get:
      tags:
      - Carriers
      summary: Returns a list of Packages used on the Carrier
      operationId: GetCarrierPackages
      parameters:
      - name: carrierNo
        in: path
        description: The Carrier No to fetch Packages for
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the Packages for the Carrier
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPackage'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPackage'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPackage'
        '400':
          description: Returns a validation result with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '404':
          description: If a Carrier with the supplied Carrier No cannot be found
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Carriers/{carrierNo}/positions:
    get:
      tags:
      - Carriers
      summary: Returns a list of Positions used on the Carrier
      operationId: GetCarrierPositions
      parameters:
      - name: carrierNo
        in: path
        description: The Carrier No to fetch Positions for
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the Positions for the Carrier
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPosition'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPosition'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPosition'
        '400':
          description: Returns a validation result with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '404':
          description: If a Carrier with the supplied Carrier No cannot be found
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Carriers/{carrierNo}/responses:
    get:
      tags:
      - Carriers
      summary: Gets a list of Carrier Responses
      operationId: GetCarrierResponses
      parameters:
      - name: carrierNo
        in: path
        description: The Carrier No. to fetch values for
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the Responses for the Carrier
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse'
        '400':
          description: Returns a validation result with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '404':
          description: If a Carrier with the supplied Carrier No cannot be found
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
    post:
      tags:
      - Carriers
      summary: Creates a new Carrier Response for the Carrier
      operationId: CreateCarrierResponse
      parameters:
      - name: carrierNo
        in: path
        description: Carrier No from the URL
        required: true
        schema:
          type: string
      requestBody:
        description: The Carrier Response retrieved from the body of the post request
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse'
      responses:
        '200':
          description: Returns the created Carrier Response object
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse'
        '400':
          description: Returns a validation result with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '404':
          description: If a Carrier with the supplied Carrier No cannot be found
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier_Update</td><td style='border-bottom:none'>Update</td></tr></tbody></table><br/><br/>Customer must have one of these License values set<table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>ProcurementDistributionModule</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Carriers/{carrierNo}/responses/count:
    get:
      tags:
      - Carriers
      summary: Returns the number of Responses on a specific Carrier
      operationId: GetCarrierResponsesCount
      parameters:
      - name: carrierNo
        in: path
        description: The Carrier No to fetch the number of Responses for
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the Responses Count for the Carrier
          content:
            text/plain:
              schema:
                type: integer
                format: int32
            application/json:
              schema:
                type: integer
                format: int32
            text/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Returns a validation result with information about the bad request
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Carrier</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Carriers/labels/{labelTemplateDocumentNo}:
    post:
      tags:
      - Carriers
      summary: Gets the labels to print
      operationId: PrintCarrierLabels
      parameters:
      - name: labelTemplateDocumentNo
        in: path
        description: the template No to print
        required: true
        schema:
          type: string
      requestBody:
        description: A Search Definition containing the carrier numbers to print
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.S

# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/openapi/sertica-carriers-api-openapi.yml