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-inventorybin-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 Inventory Bin API
  version: '1.0'
  description: 'Operations tagged InventoryBin across 2 of this provider''s published API definitions: openapi_openapi_inventory.json, kibo-commerce-inventory-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: InventoryBin
paths:
  /commerce/inventory/v1/bin/binStatuses:
    get:
      description: Get list of bin statuses
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/BinStatusModel'
                type: array
          description: Success
        '400':
          description: Bad Request
      summary: Get Bin Statuses
      tags:
      - InventoryBin
      operationId: getCommerceInventoryV1BinBinStatuses
      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/inventory/v1/bin/binTypes:
    get:
      description: Get list of bin types
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/BinTypeModel'
                type: array
          description: Success
        '400':
          description: Bad Request
      summary: Get Bin Types
      tags:
      - InventoryBin
      operationId: getCommerceInventoryV1BinBinTypes
      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/inventory/v1/bin:
    get:
      description: Get a list of bins
      parameters:
      - description: Id of location
        in: query
        name: locationID
        required: true
        schema:
          format: int64
          type: integer
      - description: Term to match in bins
        in: query
        name: searchTerm
        required: false
        schema:
          format: int64
          type: integer
      - description: Results per page
        in: query
        name: perPage
        required: false
        schema:
          format: int64
          type: integer
      - description: Page to show
        in: query
        name: page
        required: false
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BinResponseModel'
          description: Success
        '404':
          description: Bins Not Found
      summary: Get Bins
      tags:
      - InventoryBin
      operationId: getCommerceInventoryV1Bin
      x-operation-id-source: derived
    post:
      description: Create a bin
      parameters: []
      requestBody:
        $ref: '#/components/requestBodies/CreateBinRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BinIDResponse'
          description: Success
        '400':
          description: Bad Request
      summary: Create Bin
      tags:
      - InventoryBin
      operationId: postCommerceInventoryV1Bin
      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/inventory/v1/bin/loadInventory:
    post:
      description: Loads bin inventory for designated bins
      parameters: []
      requestBody:
        $ref: '#/components/requestBodies/LoadBinInventoryRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadBinInventoryResponse'
          description: Success
        '400':
          description: Bad Request
      summary: Load Inventory
      tags:
      - InventoryBin
      operationId: postCommerceInventoryV1BinLoadInventory
      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/inventory/v1/bin/searchInventory:
    post:
      description: Search bins for a inventory by bin name or any product identifier
      parameters: []
      requestBody:
        $ref: '#/components/requestBodies/BinSearchRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BinSearchResponse'
          description: Success
        '400':
          description: Bad Request
      summary: Search Bins
      tags:
      - InventoryBin
      operationId: postCommerceInventoryV1BinSearchInventory
      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/inventory/v1/bin/{bin_id}:
    post:
      description: Update the designated bin
      parameters:
      - description: Id of bin to update
        in: path
        name: bin_id
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        $ref: '#/components/requestBodies/UpdateBinRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bin'
          description: Success
        '400':
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
          description: Internal Server Error
      summary: Update Bin
      tags:
      - InventoryBin
      operationId: postCommerceInventoryV1BinByBinId
      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/inventory/v1/bin/updateBins:
    post:
      description: Update the designated bins
      parameters: []
      requestBody:
        $ref: '#/components/requestBodies/UpdateBinsRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateBinsResponse'
          description: Success
        '400':
          description: Bad Request
      summary: Update Bins
      tags:
      - InventoryBin
      operationId: postCommerceInventoryV1BinUpdateBins
      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:
    BinProductQuantities:
      description: A bin and its associated products and quantities
      properties:
        binName:
          description: Name of the bin
          type: string
        products:
          description: List of ProductQuantities - Products with their associated quantity
          items:
            $ref: '#/components/schemas/ProductQuantity'
          type: array
      title: Bin Product Quantities
      type: object
    BinSearchResponse:
      description: Bin Search Response Object
      properties:
        binQuantities:
          description: List of BinProductQuantities - bins with associated products and quantities
          items:
            $ref: '#/components/schemas/BinProductResponseQuantities'
          type: array
        messages:
          description: List of messages
          items:
            type: string
          type: array
        numResults:
          description: Number of results
          type: integer
        success:
          description: Flag for success
          type: boolean
      title: Bin Search Response
      type: object
    BinStatusModel:
      description: Status of Bin
      properties:
        binStatusID:
          description: Bin Status Identifier
          type: integer
        description:
          description: Bin Status Description
          type: string
      title: BinStatusModel
      type: object
    CreateBinRequest:
      description: Request needed for creating a new bin
      properties:
        binStatusID:
          description: Bin Status Identifier
          title: bin status id
          type: integer
        binTypeID:
          description: Bin Type Identifier
          title: bin type id
          type: integer
        locationCode:
          description: Location Code
          title: location code
          type: string
        name:
          description: Name
          title: name
          type: string
        pageNum:
          description: which page to show
          type: integer
        pageSize:
          description: how many results to show per page
          type: integer
        sortBy:
          description: index to sort results by
          type: string
        userID:
          description: user id
          type: integer
      title: Create Bin Request
      type: object
    Bin:
      description: Response object for a bin
      properties:
        binID:
          description: Bin ID
          type: integer
        binStatusID:
          description: Bin Status ID
          type: integer
        binTypeID:
          description: Bin Type ID
          type: integer
        locationCode:
          description: Location Code
          type: string
        messages:
          description: List of messages
          items:
            type: string
          type: array
        name:
          description: Bin Name
          type: string
        numResults:
          description: Number of results
          type: integer
        success:
          description: Flag for success
          type: boolean
      title: Bin Inventory Response
      type: object
    LoadBinInventoryRequest:
      description: Request needed for loading bin inventory
      properties:
        bins:
          description: List of bins and their associated product quantities
          items:
            $ref: '#/components/schemas/BinProductQuantities'
          type: array
        dryRun:
          description: Flag for dry runs
          type: boolean
        locationCode:
          description: Location Code
          title: location code
          type: string
        pageNum:
          description: which page to show
          type: integer
        pageSize:
          description: how many results to show per page
          type: integer
        sortBy:
          description: index to sort results by
          type: string
        userID:
          description: user id
          type: integer
      title: Load Bin Inventory Request
      type: object
    BinTypeModel:
      description: Type of Bin
      properties:
        binTypeID:
          description: Bin Type Identifier
          type: integer
        description:
          description: Bin Type Description
          type: string
      title: BinTypeModel
      type: object
    InventoryProduct:
      description: Product within a bin
      properties:
        partNumber:
          description: Part Number
          type: string
        sku:
          description: SKU
          type: string
        upc:
          description: UPC
          type: string
      title: Product
      type: object
    ProductQuantity:
      description: A product and its associated quantity
      properties:
        allocated:
          description: Amount of product allocated
          type: integer
        auditID:
          description: Audit ID
          type: integer
        auditProductID:
          description: Audit Product ID
          type: integer
        available:
          description: Amount of product available
          type: integer
        binID:
          description: ID of associated bin
          type: integer
        binStatusID:
          description: Bin Status ID
          type: integer
        binTypeID:
          description: Bin Type ID
          type: integer
        floor:
          description: Absolute minimum quantity of this item that should be in stock at any time
          type: integer
        inventoryID:
          description: Inventory ID
          type: integer
        locationID:
          description: Location Identifier of the owning location
          type: integer
        ltd:
          description: Custom field used for store prioritization
          type: integer
        name:
          description: Name of the product
          type: string
        onHand:
          description: Amount of product on hand
          type: integer
        partNumber:
          description: Part Number
          type: string
        pending:
          description: Amount of product pending
          type: integer
        quantity:
          description: Quantity of product
          type: integer
        safetystock:
          description: Quantity of this item the location wants to keep in stock to ensure stock isn't completely depleted
          type: integer
        sku:
          description: SKU
          type: string
        tags:
          $ref: '#/components/schemas/tags'
        tenantLocProductID:
          description: Tenant Location Product ID
          type: integer
        upc:
          description: UPC
          type: string
      title: Product Quantities
      type: object
    InventoryFutureInventory:
      description: Future Inventory Model
      properties:
        allocated:
          description: Expected change in the actual allocated inventory value when this future inventory record is released.
          type: integer
        available:
          description: Expected change in the actual available inventory value when this future inventory record is released.
          type: integer
        createDate:
          description: Date the inventory was created.
          format: date-time
          type: string
        deliveryDate:
          description: Date at which this inventory will become available. Expected format '2020-09-28T12:00:00-0500'
          format: date-time
          type: string
        futureInventoryID:
          description: Future Inventory unique identifier.
          type: integer
        onhand:
          description: Expected change in the actual onhand inventory value when this future inventory record is released.
          type: integer
        pending:
          description: Number of new expected pending items that would be created by releasing this future inventory record assuming no actual inventory is available
          type: integer
        type:
          description: 'Type of future inventory update: REFRESH or ADJUST.'
          type: string
      title: Future Inventory
      type: object
    UpdateBinsRequest:
      description: Request needed for updating bins
      properties:
        bins:
          description: List of Update Bin Requests
          items:
            $ref: '#/components/schemas/UpdateBinRequest'
          type: array
        locationCode:
          description: Location Code
          title: location code
          type: string
        pageNum:
          description: which page to show
          type: integer
        pageSize:
          description: how many results to show per page
          type: integer
        sortBy:
          description: index to sort results by
          type: string
        userID:
          description: user id
          type: integer
      title: Update Bins Request
      type: object
    BinResponseModel:
      description: Bin Response Object
      properties:
        bins:
          $ref: '#/components/schemas/BinModel'
        resultCount:
          description: number of results
          type: integer
      title: BinResponseModel
      type: object
    taggedInventoryMap:
      items:
        $ref: '#/components/schemas/TagQuantity'
      type: array
    UpdateBinsResponse:
      description: Response for updating bins
      properties:
        messages:
          description: List of messages
          items:
            type: string
          type: array
        numResults:
          description: Number of results
          type: integer
        numberAffected:
          description: Number of affected bins
          type: integer
        success:
          description: Flag for success
          type: boolean
      title: Update Bins Response
      type: object
    TagQuantity:
      description: Response object for a tag quantity
      properties:
        allocated:
          description: The quantity the location has that are already allocated for this tag
          type: integer
        available:
          description: The quantity the location has that are available for purchase for this tag
          type: integer
        futureInventory:
          $ref: '#/components/schemas/futureInventoryArray'
        onHand:
          description: The quantity the the location has in its possession for this tag
          type: integer
        pending:
          description: The quantity the location has that are pending for this tag
          type: integer
        tags:
          $ref: '#/components/schemas/tags'
      title: Tag quantity response
      type: object
    BinProductResponseQuantities:
      description: A response object for a bin and its associated products and quantities
      properties:
        binName:
          description: Name of the bin
          type: string
        products:
          description: List of ProductQuantities - Products with their associated quantity
          items:
            $ref: '#/components/schemas/ProductQuantityResponse'
          type: array
      title: Bin Product Response Quantities
      type: object
    LoadBinInventoryResponse:
      description: Response object for loading bin inventory
      properties:
        binQuantities:
          description: List of new bin product quantities
          items:
            $ref: '#/components/schemas/BinProductQuantities'
          type: array
        binsCreated:
          description: Names of created bins
          items:
            type: string
          type: array
        messages:
          description: List of messages
          items:
            type: string
          type: array
        numResults:
          description: Number of results
          type: integer
        productsCreated:
          description: List of products created
          items:
            $ref: '#/components/schemas/InventoryProduct'
          type: array
        success:
          description: Flag for success
          type: boolean
        unitsAdded:
          description: Number of units added
          type: integer
        unitsRemoved:
          description: Number of removed units
          type: integer
      title: Load Bin Inventory Response
      type: object
    BaseResponse:
      description: Base Response Model
      properties:
        messages:
          description: List of messages
          items:
            type: string
          type: array
        numResults:
          description: Number of results
          type: integer
        success:
          description: Flag for success
          type: boolean
      title: Base Response
      type: object
    BinSearchRequest:
      description: Request needed for searching for bins
      properties:
        binName:
          description: Partial match of bin name
          type: string
        locationCode:
          description: Location Code
          title: location code
          type: string
        pageNum:
          description: which page to show
          type: integer
        pageSize:
          description: how many results to show per page
          type: integer
        product:
          $ref: '#/components/schemas/InventoryProduct'
        showNegativeInventory:
          description: Flag for showing negative inventory
          type: boolean
        sortAscending:
          description: Flag for sorting ascending
          type: boolean
        sortBy:
          description: index to sort results by
          type: string
        tags:
          $ref: '#/components/schemas/tags'
        userID:
          description: user id
          type: integer
      title: Bin Search Request
      type: object
    ProductQuantityResponse:
      description: A response object for a product and its associated quantity
      properties:
        allocated:
          description: Amount of product allocated
          type: integer
        auditID:
          description: Audit ID
          type: integer
        auditProductID:
          description: Audit Product ID
          type: integer
        available:
          description: Amount of product available
          type: integer
        binID:
          description: ID of associated bin
          type: integer
        binStatusID:
          description: Bin Status ID
          type: integer
        binTypeID:
          description: Bin Type ID
          type: integer
        floor:
          description: Absolute minimum quantity of this item that should be in stock at any time
          type: integer
        inventoryID:
          description: Inventory ID
          type: integer
        locationCode:
          description: Location Code of the owning location
          type: string
        ltd:
          description: Custom field used for store prioritization
          type: integer
        name:
          description: Name of the product
          type: string
        onHand:
          description: Amount of product on hand
          type: integer
        partNumber:
          description: Part Number
          type: string
        pending:
          description: Amount of product pending
          type: integer
        quantity:
          description: Quantity of product
          type: integer
        safetystock:
          description: Quantity of this item the location wants to keep in stock to ensure stock isn't completely depleted
          type: integer
        sku:
          description: SKU
          type: string
        tags:
          $ref: '#/components/schemas/taggedInventoryMap'
        tenantLocProductID:
          description: Tenant Location Product ID
          type: integer
        upc:
          description: UPC
          type: string
      title: Product Quantities Response
      type: object
    futureInventoryArray:
      items:
        $ref: '#/components/schemas/InventoryFutureInventory'
      type: array
    UpdateBinRequest:
      description: Request needed for updating a bin
      properties:
        binID:
          description: Bin identifier
          type: integer
        binStatusID:
          description: New Bin's Status ID
          type: integer
        binTypeID:
          description: New Bin's Type ID
          type: integer
        locationCode:
          description: Location Code
          title: location code
          type: string
        pageNum:
          description: which page to show
          type: integer
        pageSize:
          description: how many results to show per page
          type: integer
        sortBy:
          description: index to sort results by
          type: string
        userID:
          description: user id
          type: integer
      title: Update Bin Request
      type: object
    BinIDResponse:
      description: Bin ID Response
      properties:
        binID:
          description: Bin ID
          type: integer
      title: Bin ID Response
      type: object
    tags:
      additionalProperties:
        type: string
      description: Associative Map of <String, String> for tagCategoryName => tagName
      type: object
    BinModel:
      description: Bin Model
      properties:
        binID:
          description: Unique Bin Identifier assigned by the system
          type: integer
        binStatusID:
          description: New Bin's Status ID
          type: integer
        binTypeID:
          description: New Bin's Type ID
          type: integer
        locationID:
          description: Location Identifier of the owning location
          type: integer
        name:
          description: Client specified static bin name
          type: integer
      title: BinModel
      type: object
  requestBodies:
    UpdateBinsRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateBinsRequest'
      description: Request to update multiple bins
      required: true
    LoadBinInventoryRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LoadBinInventoryRequest'
      description: Request to load bin inventory
      required: true
    BinSearchRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BinSearchRequest'
      description: Request to allocate inventory
      required: true
    CreateBinRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateBinRequest'
      description: Request to create a new bin
      required: true
    UpdateBinRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateBinRequest'
      description: Request to update a bin
      required: true
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: JWT Authorization header using the Bearer scheme.
      scheme: bearer
      type: http
x-refined-from:
- openapi_openapi_inventory.json
- kibo-commerce-inventory-openapi.yml
x-provenance:
  method: harvested
  publisher: Kibo Commerce
  source: https://docs.kibocommerce.com/openapi/openapi_inventory.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)