openapi: 3.0.0
info:
  title: Ijsedal orders
  description: |-
    Deze API geeft details terug van alle orders van een bepaalde webshop
  version: 1.0.0
servers:
  - url: https://api.webshops.ijsedal.be/
paths:
  /orders:
    get:
      summary: Get Orders
      parameters:
        - in: query
          name: from
          schema:
            type: string
            format: date
          required: false
          description: All orders that changed status to 'Done' or given status FROM this date (yyyy-mm-dd)
        - in: query
          name: to
          schema:
            type: string
            format: date
          required: false
          description: All orders that changed status to 'Done' or given status TO this date (yyyy-mm-dd)
        - in: query
          name: status
          schema:
            type: integer
            enum: [0, 1, 2, 3, 4, 5]
            default: 4 (done)
          required: false
          description: >
            status options:
              * 0 - Pending
              * 1 - Picking
              * 2 - Picking done
              * 3 - Packing
              * 4 - Done
              * 5 - Cancelled
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  allOf:
                    - $ref: '#/components/schemas/order'
        '400':
          description: No api-key
        '401':
          description: No valid api-key
components:
  schemas:
    order:
      type: object
      properties:
        hashId:
          type: string
        ordernr:
          type: string
        externalOrderId:
          type: string
        customerId:
          type: string
        name:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        phone:
          type: string
        streetName:
          type: string
        streetNumber:
          type: string
        postalcode:
          type: string
        city:
          type: string
        birthdate:
          type: string
        organisation:
          type: string
        vatnr:
          type: string
        customerOrganisationID:
            type: string
        customerOrganisation:
          type: string
        customerOrganisationType:
          type: string
        customerStreetName:
          type: string
        customerStreetNumber:
          type: string
        customerBoxNumber:
          type: string
        customerPostalcode:
          type: string
        customerCity:
          type: string
        customerCountry:
          type: string
        reference:
          type: string
        shippingName:
          type: string
        shippingStreetName:
          type: string
        shippingStreetNumber:
          type: string
        shippingPostalcode:
          type: string
        shippingCity:
          type: string
        shippingCountry:
          type: string
        shippingSameAsInvoice:
          type: integer
        invoiceName:
          type: string
        invoiceStreetName:
          type: string
        invoiceStreetNumber:
          type: string
        invoicePostalcode:
          type: string
        invoiceCity:
          type: string
        invoiceCountry:
          type: string
        invoiceEmail:
          type: string
        invoicePhone:
          type: string
        orderDate:
          type: string
          example: '2023-05-23T13:34:35+02:00'
        shippingDate:
          type: string
          example: '2023-05-23T13:34:35+02:00'
        requestedDeliveryDate:
          type: string
          example: '2023-05-23T13:34:35+02:00'
        paymentDate:
          type: string
          example: '2023-05-23T13:34:35+02:00'
        externalComments:
          type: string
        internalComments:
          type: string
        onlinePayment:
          type: boolean
        paid:
          type: boolean
        orderItems:
          type: array
          items:
            $ref: '#/components/schemas/orderItem'
        orderPicking:
          type: array
          items:
            $ref: '#/components/schemas/orderPicking'
        orderHistory:
          type: array
          items:
            $ref: '#/components/schemas/orderHistory'
        shippingCost:
          type: integer
        tax:
          type: number
          format: float
        taxPercentage:
          type: string
          format: integer
        totalPrice:
          type: number
          format: float
        totalPriceAfterTax:
          type: number
          format: float
        isPaidOrInvoice:
          type: boolean
        dateOfPayment:
          type: string
        isInvoice:
          type: boolean
    orderItem:
      type: object
      properties:
        title:
          type: string
        articlenr:
          type: string
        opCode:
          type: string
        description:
          type: string
        productCategories:
          type: array
          description: Productcategorieën met titels in de taal van het winkelmandje. Voor transportregels is dit een lege lijst.
          items:
            $ref: '#/components/schemas/productCategory'
        supplier:
          type: string
        bookOnAccount:
          type: string
        analytical1:
          type: string
        analytical2:
          type: string
        analytical3:
          type: string
        quantity:
          type: integer
        tax:
          type: number
          format: float
        taxPercentage:
          type: number
          format: float
        maxUnitPrice:
          type: number
          format: float
        unitPrice:
          type: number
          format: float
        totalPrice:
          type: number
          format: float
        totalPriceAfterTax:
          type: number
          format: float
        discount:
          type: string
    productCategory:
      type: object
      properties:
        id:
          type: integer
        parentId:
          type: integer
          description: 0 voor een hoofdcategorie.
        title:
          type: string
    orderPicking:
      type: object
      properties:
        orderPickerName:
          type: string
        code:
          type: string
        status:
          type: integer
        remarks:
          type: string
    orderHistory:
      type: object
      properties:
        event:
          type: string
        date:
          type: string
  securitySchemes:
    api_key:
      type: apiKey
      name: x-api-key
      in: header
security:
  - api_key: []