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-shipmentdata-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 Data API
  version: '1.0'
  description: 'Operations tagged ShipmentData 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: ShipmentData
paths:
  /commerce/shipments/{shipmentNumber}/data/{key}:
    delete:
      deprecated: false
      description: Delete a shipment data entry by its key.
      parameters:
      - description: key
        in: path
        name: key
        required: true
        schema:
          type: string
      - description: shipmentNumber
        in: path
        name: shipmentNumber
        required: true
        schema:
          format: int32
          type: integer
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      summary: Delete Shipment Data By Key
      tags:
      - ShipmentData
      operationId: deleteCommerceShipmentsByShipmentNumberDataByKey
      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/{shipmentNumber}/items/{lineId}/data/{key}:
    delete:
      deprecated: false
      description: Delete a shipment item data record by its key.
      parameters:
      - description: key
        in: path
        name: key
        required: true
        schema:
          type: string
      - description: lineId
        in: path
        name: lineId
        required: true
        schema:
          format: int32
          type: integer
      - description: shipmentNumber
        in: path
        name: shipmentNumber
        required: true
        schema:
          format: int32
          type: integer
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      summary: Delete Shipment Item Data By Key
      tags:
      - ShipmentData
      operationId: deleteCommerceShipmentsByShipmentNumberItemsByLineIdDataByKey
      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/{shipmentNumber}/data:
    delete:
      deprecated: false
      description: Delete a shipment's data.
      parameters:
      - description: shipmentNumber
        in: path
        name: shipmentNumber
        required: true
        schema:
          format: int32
          type: integer
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      summary: Delete Shipment Data
      tags:
      - ShipmentData
      operationId: deleteCommerceShipmentsByShipmentNumberData
      x-operation-id-source: derived
    get:
      deprecated: false
      description: Get the data of a shipment.
      parameters:
      - description: shipmentNumber
        in: path
        name: shipmentNumber
        required: true
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                additionalProperties:
                  type: object
                type: object
            application/json:
              schema:
                additionalProperties:
                  type: object
                type: object
            application/xml:
              schema:
                additionalProperties:
                  type: object
                type: object
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Get Shipment Data
      tags:
      - ShipmentData
      operationId: getCommerceShipmentsByShipmentNumberData
      x-operation-id-source: derived
    put:
      deprecated: false
      description: Update and replace a shipment's data.
      parameters:
      - description: merge
        in: query
        name: merge
        schema:
          default: false
          type: boolean
      - description: shipmentNumber
        in: path
        name: shipmentNumber
        required: true
        schema:
          format: int32
          type: integer
      requestBody:
        $ref: '#/components/requestBodies/replaceShipmentDataUsingPUTData'
        description: data
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                additionalProperties:
                  type: object
                type: object
            application/json:
              schema:
                additionalProperties:
                  type: object
                type: object
            application/xml:
              schema:
                additionalProperties:
                  type: object
                type: object
          description: OK
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Replace Shipment Data
      tags:
      - ShipmentData
      x-codegen-request-body-name: data
      operationId: putCommerceShipmentsByShipmentNumberData
      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/{shipmentNumber}/items/{lineId}/data:
    delete:
      deprecated: false
      description: Delete shipment item data.
      parameters:
      - description: lineId
        in: path
        name: lineId
        required: true
        schema:
          format: int32
          type: integer
      - description: shipmentNumber
        in: path
        name: shipmentNumber
        required: true
        schema:
          format: int32
          type: integer
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      summary: Delete Shipment Item Data
      tags:
      - ShipmentData
      operationId: deleteCommerceShipmentsByShipmentNumberItemsByLineIdData
      x-operation-id-source: derived
    get:
      deprecated: false
      description: Get the data of a shipment line item.
      parameters:
      - description: lineId
        in: path
        name: lineId
        required: true
        schema:
          format: int32
          type: integer
      - description: shipmentNumber
        in: path
        name: shipmentNumber
        required: true
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                additionalProperties:
                  type: object
                type: object
            application/json:
              schema:
                additionalProperties:
                  type: object
                type: object
            application/xml:
              schema:
                additionalProperties:
                  type: object
                type: object
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Get Shipment Item Data
      tags:
      - ShipmentData
      operationId: getCommerceShipmentsByShipmentNumberItemsByLineIdData
      x-operation-id-source: derived
    put:
      deprecated: false
      description: Replace shipment item data.
      parameters:
      - description: lineId
        in: path
        name: lineId
        required: true
        schema:
          format: int32
          type: integer
      - description: merge
        in: query
        name: merge
        schema:
          default: false
          type: boolean
      - description: shipmentNumber
        in: path
        name: shipmentNumber
        required: true
        schema:
          format: int32
          type: integer
      requestBody:
        $ref: '#/components/requestBodies/replaceShipmentDataUsingPUTData'
        description: data
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                additionalProperties:
                  type: object
                type: object
            application/json:
              schema:
                additionalProperties:
                  type: object
                type: object
            application/xml:
              schema:
                additionalProperties:
                  type: object
                type: object
          description: OK
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Replace Shipment Item Data
      tags:
      - ShipmentData
      x-codegen-request-body-name: data
      operationId: putCommerceShipmentsByShipmentNumberItemsByLineIdData
      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:
  requestBodies:
    replaceShipmentDataUsingPUTData:
      content:
        application/json:
          schema:
            additionalProperties:
              type: object
            type: object
      description: data
      required: true
  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)