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/kibo-commerce:kibo-commerce-shipmentpriority-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

openapi: 3.2.0
info:
  title: Kibo Commerce Shipment Priority API
  version: '1.0'
  description: 'Operations tagged ShipmentPriority across 2 of this provider''s published API definitions: openapi_openapi_fulfillment.json, kibo-commerce-fulfillment-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: ShipmentPriority
paths:
  /commerce/shipments/priorities/{shipmentNumber}/history:
    get:
      deprecated: false
      parameters:
      - description: shipmentNumber
        in: path
        name: shipmentNumber
        required: true
        schema:
          format: int32
          type: integer
      - in: header
        name: x-vol-site
        required: false
        schema:
          format: int32
          type: integer
      - in: header
        name: x-vol-tenant
        required: true
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/PriorityInfo'
            application/json:
              schema:
                $ref: '#/components/schemas/PriorityInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/PriorityInfo'
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Get Prioritization History
      tags:
      - ShipmentPriority
      operationId: getCommerceShipmentsPrioritiesByShipmentNumberHistory
      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/shipments/priorities/{shipmentNumber}:
    get:
      deprecated: false
      parameters:
      - description: shipmentNumber
        in: path
        name: shipmentNumber
        required: true
        schema:
          format: int32
          type: integer
      - in: header
        name: x-vol-site
        required: false
        schema:
          format: int32
          type: integer
      - in: header
        name: x-vol-tenant
        required: true
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/PriorityInfo'
            application/json:
              schema:
                $ref: '#/components/schemas/PriorityInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/PriorityInfo'
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Get Priority Info
      tags:
      - ShipmentPriority
      operationId: getCommerceShipmentsPrioritiesByShipmentNumber
      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/shipments/priorities:
    put:
      deprecated: false
      parameters:
      - in: header
        name: x-vol-site
        required: false
        schema:
          format: int32
          type: integer
      - in: header
        name: x-vol-tenant
        required: true
        schema:
          format: int32
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePrioritiesDto'
        description: request
        required: true
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/UpdatePrioritiesResponseDto'
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePrioritiesResponseDto'
            application/xml:
              schema:
                $ref: '#/components/schemas/UpdatePrioritiesResponseDto'
          description: OK
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Update Priorities
      tags:
      - ShipmentPriority
      operationId: putCommerceShipmentsPriorities
      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:
    PriorityResult:
      properties:
        actual:
          type: string
        expected:
          type: string
        fulfillmentPriority:
          format: int32
          type: integer
        previousPriority:
          format: int32
          type: integer
        reason:
          type: string
        ruleCode:
          type: string
        shipmentNumber:
          format: int32
          type: integer
        status:
          type: string
      title: PriorityResult
      type: object
    PriorityInfo:
      properties:
        history:
          items:
            $ref: '#/components/schemas/PriorityEvent'
          type: array
        prioritizedAt:
          format: date-time
          type: string
        priority:
          format: int32
          type: integer
        ruleCode:
          type: string
        ruleType:
          type: string
        statusWhenPrioritized:
          type: string
      title: PriorityInfo
      type: object
    PriorityAssignment:
      properties:
        fulfillmentPriority:
          format: int32
          type: integer
        ruleCode:
          type: string
        shipmentNumber:
          format: int32
          type: integer
      title: PriorityAssignment
      type: object
    UpdatePrioritiesResponseDto:
      properties:
        results:
          items:
            $ref: '#/components/schemas/PriorityResult'
          type: array
        shipmentsReset:
          format: int32
          type: integer
        shipmentsUnchanged:
          format: int32
          type: integer
        shipmentsUpdated:
          format: int32
          type: integer
      title: UpdatePrioritiesResponseDto
      type: object
    UpdatePrioritiesDto:
      properties:
        locationCode:
          type: string
        moreInfo:
          type: string
        priorities:
          items:
            $ref: '#/components/schemas/PriorityAssignment'
          type: array
        reasonCode:
          type: string
        resetOrphanedPriorities:
          type: boolean
        ruleType:
          type: string
        shipmentStatus:
          type: string
      title: UpdatePrioritiesDto
      type: object
    PriorityEvent:
      properties:
        action:
          type: string
        priority:
          format: int32
          type: integer
        ruleCode:
          type: string
        ruleType:
          type: string
        shipmentStatus:
          type: string
        timestamp:
          format: date-time
          type: string
      title: PriorityEvent
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: JWT Authorization header using the Bearer scheme.
      scheme: bearer
      type: http
x-refined-from:
- openapi_openapi_fulfillment.json
- kibo-commerce-fulfillment-openapi.yml
x-provenance:
  method: harvested
  publisher: Kibo Commerce
  source: https://docs.kibocommerce.com/openapi/openapi_fulfillment.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)