Bol Inventory API

openapi: 3.2.0
info:
  title: v10 - Retailer Inventory API
  description: 'The bol.com API for retailers.


    # Authentication

    Our API requires authentication via OAuth2. The detailed steps to authenticate are explained here


    # Demo scenarios

    Our API specification includes examples of the responses you can expect. For more information as well as more examples, we refer you to the following resources:

    - Demo environment

    - Demo scenarios'
  termsOfService: https://api.bol.com/retailer/public/Retailer-API/legal/terms-of-service.html
  contact:
    name: developers.bol.com
    url: https://developers.bol.com
  version: 10.x
  x-logo:
    url: https://api.bol.com/retailer/public/Retailer-API/_images/bolcom_logo.png
    altText: bol.com logo
security:
- OAuth2: []
tags:
- name: Inventory
  description: Inventory resource
paths:
  /retailer/inventory:
    get:
      tags:
      - Inventory
      summary: Get LVB/FBB inventory
      description: The inventory endpoint is a specific LVB/FBB endpoint. It provides a paginated list containing your fulfilment by bol.com inventory. This endpoint does not provide information about your own stock.
      operationId: get-inventory
      parameters:
      - name: page
        in: query
        description: The requested page number with a page size of 50 items.
        required: false
        schema:
          minimum: 1
          type: integer
          format: int32
          default: 1
        example: 1
      - name: quantity
        in: query
        description: Filter inventory by providing a range of quantity (min-range)-(max-range). Note that if no state query is submitted in the same request, then the quantity will be filtered on regularStock by default.
        required: false
        schema:
          type: array
          items:
            type: string
        example: 0-10,20-30
      - name: stock
        in: query
        description: Filter inventory by stock level.
        required: false
        schema:
          type: string
          enum:
          - SUFFICIENT, INSUFFICIENT
        example: SUFFICIENT
      - name: state
        in: query
        description: Filter inventory by stock type.
        required: false
        schema:
          type: string
          enum:
          - REGULAR, GRADED
        example: REGULAR
      - name: query
        in: query
        description: Filter inventory by EAN or product title.
        required: false
        schema:
          type: string
        example: '0000007740404'
      responses:
        '200':
          description: 'Ok: Successfully processed the request.'
          content:
            application/vnd.retailer.v10+json:
              schema:
                $ref: '#/components/schemas/InventoryResponse'
        '400':
          description: 'Bad request: The sent request does not meet the API specification. Please check the error message(s) for more information.'
          content:
            application/vnd.retailer.v10+json:
              schema:
                $ref: '#/components/schemas/Problem'
components:
  schemas:
    Violation:
      required:
      - name
      - reason
      type: object
      properties:
        name:
          type: string
          description: Describes the origin of the error, for instance a field or query parameter validation error.
          example: exampleValue
        reason:
          type: string
          description: Detailed description of the validation error that caused the problem.
          example: 'Request contains invalid value(s): ''INVALID'', allowed values: ALLOWED_VALUE1, ALLOWED_VALUE2.'
      description: Describes a violation that occurred interacting with the API.
    Inventory:
      required:
      - bsku
      - ean
      - gradedStock
      - regularStock
      - title
      type: object
      properties:
        ean:
          type: string
          description: The EAN number associated with this product.
          example: '0000007740404'
        bsku:
          type: string
          description: The BSKU number associated with this product.
          example: '2950002126612'
        gradedStock:
          type: integer
          description: The stock that is not available for sale anymore.
          format: int32
          example: 10
        regularStock:
          type: integer
          description: The stock that is available for sale.
          format: int32
          example: 10
        title:
          type: string
          description: The product title.
          example: Product Title
    InventoryResponse:
      required:
      - inventory
      type: object
      properties:
        inventory:
          type: array
          items:
            $ref: '#/components/schemas/Inventory'
    Problem:
      required:
      - detail
      - status
      - title
      - type
      - violations
      type: object
      properties:
        type:
          type: string
          description: 'Type URI for this problem. Fixed value: https://api.bol.com/problems.'
          format: uri
          example: https://api.bol.com/problems
        title:
          type: string
          description: Title describing the nature of the problem.
          example: Error validating request. Consult the bol.com API documentation for more information.
        status:
          type: integer
          description: HTTP status returned from the endpoint causing the problem.
          format: int32
        detail:
          type: string
          description: Detailed error message describing in additional detail what caused the service to return this problem.
          example: Bad request
        host:
          type:
          - string
          - 'null'
          description: Host identifier describing the server instance that reported the problem.
          example: Instance-001
        instance:
          type:
          - string
          - 'null'
          description: Full URI path of the resource that reported the problem.
          format: uri
          example: https://api.bol.com//retailer/resource
        violations:
          type: array
          items:
            $ref: '#/components/schemas/Violation'
      description: Describes a problem that occurred interacting with the API.
  securitySchemes:
    OAuth2:
      type: http
      description: JWT-based access to api.bol.com
      in: header
      scheme: bearer