openapi: 3.1.0
x-internal: false
info:
  title: ShopApi - v2
  version: '2.0'
  description: >-
    Welcome to the specifications of the **Active Ants ShopApi v2**. We're
    working hard to give you the best experience and complete control over your
    data through our APIs. To make sure that the endpoints follow a certain
    design pattern we've based the APIs on the [JSON:API](https://jsonapi.org/)
    specifications.


    <div class="admonition admonition--attention"> 

    Note that this API is superceded by the **ShopApi v3** endpoints which will
    increasingly take over functionality available in this endpoint. 

    </div>
  license:
    name: © Active Ants 2023
    url: https://www.activeants.com/footer-menu/terms-and-conditions/
  contact:
    name: IT Support
    url: https://www.activeants.com/
    email: itsupport@activeants.com
  termsOfService: https://www.activeants.com/footer-menu/terms-and-conditions/
  summary: Active Ants ShopApi v2
servers:
  - description: acceptance
    url: https://shopapitest.activeants.nl
  - description: production
    url: https://shopapi.activeants.nl
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: Opaque
  schemas:
    post-token-request:
      type: object
      properties:
        grant_type:
          default: password
        username:
          type: string
          description: Provide the provided `username`
          example: shopapi-user
        password:
          type: string
          description: Prodide your `password`
          example: your-secret-is-safe
      required:
        - grant_type
        - username
        - password
    post-token-response:
      type: object
      properties:
        access_token:
          type: string
          description: The actual token to use when making API requests.
          example: WW91IGNvdWxkIG5vdCByZXNpc3QgdGhlIHVyZ2UgdG8gbG9vayBjb3VsZCB5b3U/
        token_type:
          type: string
          description: A constant indicating the type of the token, provided for reference
          default: bearer
        expires_in:
          type: number
          format: integer
          description: >-
            the number of seconds until the token expires and the user is
            required to request another
          example: 56499
        userName:
          type: string
          description: The user name echoed back from the request
          example: shopapi-user
        issued:
          type: string
          description: >-
            Date the token was issued in
            [RFC1123](https://www.rfc-editor.org/rfc/rfc1123) format
        expires:
          type: string
          description: >-
            Date the token will expire in
            [RFC1123](https://www.rfc-editor.org/rfc/rfc1123) format
    error-response:
      title: error-response
      type: object
      properties:
        error:
          type: string
        error_description:
          type: string
      x-internal: false
      description: ''
    get-status-get-response:
      type: object
      properties:
        messageCode:
          type: string
          example: OK
        message:
          type: string
          example: Status is OK.
        result:
          type: object
          nullable: true
          example: null
    response-structure:
      type: object
      properties:
        messageCode:
          type: string
          example: OK
          enum:
            - OK
            - NOK
          description: |-
            * `OK` All went well
            * `NOK` An error occurred. The message element indicates the issue.
        message:
          type: string
          example: Status is OK.
          description: For example `status is OK` or `return label found.`
        result:
          type: object
          nullable: true
          example: null
      required:
        - messageCode
        - message
    warehouseCode:
      type: string
      enum:
        - NR
        - NN
        - GN
        - BW
        - DD
        - FP
      title: warehouseCode
      description: >
        The code for the warehouse used to uniquely refer to an Active Ants
        warehouse.


        The following warehouses are currently defined:

        | code | country         | city        | customs region             | 

        | ---- | --------------- | ----------- | -------------------------- |

        | BW   | Belgium         | Willebroek  | EU - Common Customs Tariff |

        | DD   | Germany         | Dorsten     | EU - Common Customs Tariff |

        | GN   | Great Brittain  | Northampton | GB - UK Global Tariff      |

        | NN   | The Netherlands | Nieuwegein  | EU - Common Customs Tariff |

        | NR   | The Netherlands | Roosendaal  | EU - Common Customs Tariff |

        | FP   | France          | Pantin      | EU - Common Customs Tariff |
    get-settings-get-response:
      allOf:
        - $ref: '#/components/schemas/response-structure'
        - type: object
          properties:
            result:
              type: object
              description: >-
                An object containing the various settings applicable to the
                client.
              properties:
                mainShippingMethods:
                  type: array
                  description: >
                    Provides a list of the shipping methods available for use
                    through the `shopapi/v3` endpoints. 

                    The `id` field of the `mainShippingMethod` must be used when
                    providing a `preferredShippingMethod` or can be used as
                    reference when shippingMethods id's are being returned.

                    <div class="admonition admonition--warning">Warning

                      The `shopapi/v3` uses different shipping method id's than the `shopapi/v2` although both are related there is a significant difference.
                      `shopapi/v3` endpoints use the `mainShippingMethod` id's while the `shopapi/v2` endpoints use the `shippingMethod` id's.   
                    </div>
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                        description: The unique identifier for this `shippingMethod`
                      name:
                        type: string
                        description: Human readable name for the `shippingMethod`
                      code:
                        type: string
                        description: Administrative code  for the `shippingMethod`
                      shippingMethods:
                        type: array
                        description: |
                          An array of warehouse specific `shippingMethods`
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              decsription: >-
                                A client-specific and warehouse-specific
                                identifier for the `shippingMethod`
                            warehouse:
                              $ref: '#/components/schemas/warehouseCode'
                shippingMethods:
                  type: array
                  description: >
                    Provides a list of the shipping methods available for use
                    through the `shopapi/v2` endpoints. 

                    <div class="admonition admonition--warning">Warning

                      The `shopapi/v3` uses different shipping method id's than the `shopapi/v2` although both are related there is a significant difference.
                      `shopapi/v3` endpoints use the `mainShippingMethod` id's while the `shopapi/v2` endpoints use the `shippingMethod` id's.   
                    </div>
                  items:
                    type: object
                    properties:
                      id:
                        description: >-
                          The id of the `shippingMethod` (for use with
                          `shopapi/v2` endpoints)
                        type: integer
                      name:
                        description: A human readable name for the shipping method
                        type: string
                      code:
                        description: A code for the shipping method
                        type: string
                returnShippingMethods:
                  type: array
                  description: |
                    Provides a list of the available `returnShippingMethods`. 
                  items:
                    type: object
                    properties:
                      id:
                        description: >-
                          The id of the `shippingMethod` (for use with
                          `shopapi/v2` endpoints)
                        type: integer
                      name:
                        description: A human readable name for the `returnShippingMethod`
                        type: string
                      code:
                        description: A code for the `returnShippingMethod`
                        type: string
                orderTypes:
                  type: array
                  description: >
                    Provides a list of all the `orderType`s that have been
                    configured for your fulfillment-process.

                    The `orderType` drives an important part of how orders are
                    being handled and what rules are to be applied on these
                    orders. 

                    To understand the prossibilities please contact your acount
                    manager for further information on `orderTypes`.
                  items:
                    type: object
                    properties:
                      id:
                        description: >-
                          The unique `id` of the `orderType` one of which must
                          be used when submitting an `order`.
                        type: integer
                      name:
                        description: >-
                          A human-readable name of the `orderType`. Note that
                          this is just a name and does not entice behaviour,
                          meaning that an orderType named 'B2B' does not
                          'magically' implement B2B processes, these have to be
                          configured by your Account Manager.
                        type: string
                      code:
                        description: Repetition of the name.
                        type: string
                countries:
                  type: array
                  description: >
                    An array of all countries and their iso3166-code.

                    Note that some countries are divided into sub-territories
                    such as `ES-CE`. These countries often require specific
                    customs or tax-regulations to be adhered to.
                  items:
                    type: object
                    properties:
                      id:
                        description: >-
                          Internally assigned `id` for the country. Usually this
                          is not needed, but the older `shopapi/v2` endpoints
                          require this `id` to identify a country.
                        type: integer
                      name:
                        description: >-
                          Name of the country, always in English with the sole
                          exception of The Netherlands
                        type: string
                      code:
                        description: >-
                          The iso3166 alpha-2 code associated with this country,
                          or in case of a sub-territory a longer iso3166 code.
                          For more information see
                          [ISO-3166:ORG](https://www.iso.org/iso-3166-country-codes.html)
                        type: string
                languages:
                  description: >
                    An array of languages supported by the system. Note that
                    this set is limited to 11 languages.
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        description: Internally assigned `id` for the language.
                        type: integer
                      name:
                        description: Name of the language in Dutch.
                        type: string
                      code:
                        description: >-
                          Uppercase language code based on the ISO-639 language
                          code (set 1)
                        type: string
                returnReasons:
                  type: array
                  description: |
                    Set of reasons used for returned items. 
                  items:
                    type: object
                    properties:
                      id:
                        description: Unique `id` for the reason
                        type: integer
                      name:
                        description: Full name / short description for the reason
                        type: string
                      code:
                        description: Unique code for the description.
                        type: string
                paymentMethods:
                  type: array
                  deprecated: true
                  description: Payment methods are no longer in use.
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                        deprecated: true
                        description: Payment methods are no longer in use.
                      name:
                        type: string
                        deprecated: true
                        description: Payment methods are no longer in use.
                      code:
                        type: string
                        deprecated: true
                        description: Payment methods are no longer in use.
    response-structure-OK:
      type: object
      properties:
        messageCode:
          type: string
          const: OK
          description: The value `OK` indicates the message was accepted by the system.
        message:
          type: string
          examples:
            - status is OK
            - return label found.
          description: 'Some response indicating the success '
        result:
          oneOf:
            - type: object
            - type: string
            - type: integer
            - type: 'null'
          example: null
      required:
        - messageCode
        - message
    response-structure-NOK:
      type: object
      properties:
        messageCode:
          type: string
          const: NOK
          description: >-
            The value `NOK` indicates that an error occurred. The message
            element indicates the issue.
        message:
          type: string
          example: Unable to process request due to malformed contents
        result:
          type: null
          const: null
      required:
        - messageCode
        - message
  examples:
    post-token-001-request:
      value:
        grant_type: password
        username: shopapi-user
        password: your-secret-is-safe
    post-token-001-response:
      value:
        access_token: WW91IGNvdWxkIG5vdCByZXNpc3QgdGhlIHVyZ2UgdG8gbG9vayBjb3VsZCB5b3U/
        token_type: bearer
        expires_in: 56499
        userName: shopapi-user
        issued: Tue, 05 Dec 2024 11:22:52 GMT
        expires: Wed, 06 Dec 2024 03:22:52 GMT
    generic-404-not-found:
      value:
        error: 404 Not Found
        error_description: The requested resource could not be found
    get-status-get-001-response:
      value:
        messageCode: OK
        message: Status is OK.
        result: null
    get-settings-get-001-response:
      value:
        messageCode: OK
        message: Settings are ok.
        result:
          mainShippingMethods:
            - id: 1
              name: '--- DEFAULT SHIPPING METHOD ---'
              code: BUSEU1
              shippingMethods: []
            - id: 2
              name: AA - CS
              code: AA_CS
              shippingMethods:
                - id: 10001
                  warehouse: NR
                - id: 10002
                  warehouse: NN
            - id: 2
              name: AUSTRIA DPD DIRECT
              code: MAXAT_BPSC
              shippingMethods:
                - id: 10201
                  warehouse: NN
            - id: 3
              name: BELGIUM BPOST
              code: BELBE_BP
              shippingMethods:
                - id: 10301
                  warehouse: NN
                - id: 10302
                  warehouse: NR
                - id: 10303
                  warehouse: BW
          shippingMethods:
            - id: 1
              name: '--- DEFAULT SHIPPING METHOD ---'
              code: BUSEU1
            - id: 10001
              name: AA - CS
              code: AA_CS
            - id: 10201
              name: AUSTRIA DPD DIRECT
              code: MAXAT_BPSC
            - id: 10301
              name: BELGIUM BPOST
              code: BELBE_BP
          returnShippingMethods:
            - id: 10210
              name: AUSTRIA DPD RETURN
              code: MAXAT_BPSC_RET
            - id: 10310
              name: BELGIUM BPOST RETURN
              code: BELEUBE_BP_RET
          orderTypes:
            - id: 3000
              name: myshop_nl_orders
              code: myshop_nl_orders
            - id: 3001
              name: myshop_be_orders
              code: myshop_be_orders
            - id: 3002
              name: B2B_orders
              code: B2B_orders
            - id: 3003
              name: adhoc
              code: adhox
          countries:
            - id: 1
              name: NEDERLAND
              code: NL
            - id: 2
              name: BELGIUM
              code: BE
            - id: 3
              name: GERMANY
              code: DE
          languages:
            - id: 1
              name: Nederlands
              code: NL
            - id: 2
              name: Engels
              code: EN
            - id: 3
              name: Duits
              code: DE
            - id: 4
              name: Spaans
              code: ES
            - id: 5
              name: Frans
              code: FR
            - id: 6
              name: Portugees
              code: PT
            - id: 7
              name: Italiaans
              code: IT
            - id: 9
              name: Deens
              code: DA
            - id: 10
              name: Tsjechisch
              code: CS
            - id: 11
              name: Pools
              code: PL
          returnReasons:
            - id: 1
              name: Adres Onjuist / Wrong address / Mauvaise adresse
              code: ADRES_OBOA
            - id: 2
              name: Beschadigd product ontvangen / Damaged Item Received
              code: PRODT_BIONT
          paymentMethods:
            - id: 1
              name: '--- DEFAULT PAYMENT (NO PROCESSING) ---'
              code: GI
  responses:
    400-unauthorized:
      description: >
        ### 400 Unauthorized


        A `400 Not Found` response occurs when attempting to request a token
        with an invalid username or password.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error-response'
          examples:
            '400':
              value:
                error: invalid_grant
                error_description: The user name or password is incorrect.
    404-not-found:
      description: |
        A `404 Not Found` response occurs when attempting to access a resource
        that cannot be found on the server. It indicates that the requested
        resource does not exist, either because it has been deleted, the URL is
        incorrect or because the endpoint has not been realized.


        The following are common scenarios that may lead to a `404 Not Found`
        response:

        * Attempting to access an endpoint with an invalid or non-existent URL.

        * Attempting to access an endpoint that has not (yet) been realized

        * Requesting a resource that has been deleted or moved.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error-response'
          examples:
            '404':
              $ref: '#/components/examples/generic-404-not-found'
    400-bad-request:
      description: >-
        A `400 Not Found` response occurs when attempting to request a token
        with an invalid username or password.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error-response'
          examples:
            '400':
              value:
                error: Bad Request
                error_description: The message is a malformed
    get-returnlabel-response:
      description: OK
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/response-structure'
              - type: object
                properties:
                  result:
                    type: object
                    properties:
                      data:
                        type: string
                      mimeType:
                        type: string
                      fileName:
                        type: string
                      shipmentItemId:
                        type: string
                      packageNumber:
                        type: string
                      isPaperlessReturnShippingMethod:
                        type: boolean
            example:
              messageCode: OK
              message: Return label found.
              result:
                mimeType: application/pdf
                fileName: 5670887_RETURN_DHLNLLabel.pdf
                shippingMethodId: '115117'
                packageNumber: 3S5970887000000
                isPaperlessReturnShippingMethod: false
                data: >-
                  JVBERi0xLjcKJeLjz9MKOSAwIG9iago8PAovT3JkZXJpbmcgKElkZW50aXR5KQovUmVnaXN0cnkgKEFkb2JlKQovU3VwcGxlbWVudCAwCj4+CmVuZG9iagoxMSAwIG9iago8PAovTGVuZ3RoMSAxNDAyOAovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDUzODcKPj4Kc3RyZWFtCnic7TsLdBTXdffNzH6kXUm7kpBAKzSzDLt8RiBphRCSBVrrs6CVBPqsYFcItKu/sEBi+QgbYxNjgj3GDvUXXCemaY7jhDqZdVoMjpvabdw2rtVwnKbk5Gu7qXOS46R1fEgcG+30vplZIQFOE6cnPm15b97Me/fed+999917582CgACAHQ4DC/5NnSW+Fs9TlxDyKrZo//69gvv4vK8DkGIcvzg0Mbxzy31ZDhy/DZB1ZHjs1qHNvw41AzgnANJ2jQzGBjx9l74FUPA60q8eQUDGVzMUANd8HC8e2bn3wIGDFhOOa3D+E2Pj/TGyiEPU8u8AWC7sjB2YsLRm/RrA9zQChV2xnYOevnXP4PgfUeZrE+N79qpPgg9g1RMUPxEfnJg4qubg+AUAJgs47l7mBTCB1VTOTSHF4/qTmYIh5nv4tAHH0MIJwBxDPAtGae0UBDgNGdOXLUem/wbAmsuUC0CepDj2gqmOSgPWVEcrZKvfVn/Cfg+yANRfpFrycfXnpnzI1sdwO3wCdmKdhAGstH8bTMB+6IRB2AdjMIwUt+B9D+yAixCDbohDCCmG4SBSfxJGcMZ+vO/G8d0QhXHkdBBacX5Y4xBDyjHE7kfuhzROlL4DR6OIPYI8u5DnAELj0A5bYBtS7PYHT5187NFjnzx695G7PnH4zjsO3X7wtlsPTO7ft3dPfPfE+K6dY7fsGB0ZHhoc6O+LRXu3b+vZ2h0Jb9ncFepsb9u0sbWlOdi0YX1gKe9ITysmCVt6vVg/mL6iGBLpNuzaVhQTxVyvWDSgskkSFH972N3cEW5scLndEZfoVvwK52mkLTYg96cQEWSBs3AusmjuFJvbu8NCoxzVkAgJzRnp+DUzOKOnMPWhsBKQcDRrvF4bzww3XIVuSqFFQYE2WR5IAOtBuN+VIFrHVH9fBFcSEZU+SXSL4UGkTVjB7g5F67FnT/WIsB45Cucc0Ietf4t4jhi97rAiRIciG5AaGI+iXZ3noEI8oPejitAvCIrZI/a1hWW3QqKiyxh3hNFiJOaS3aJbiETOqS8VUmrRjbwYqEuI5J72hJ/c09kdPo9BKdwTCj/LEKY+WhdJLEZc+LwA4NegDIVSIB0IdADNBHfmWcaq0bvO+wEOa1hOA2jjflyFBrOmYAT6zzE6zKEL8mqC/MAghtMx/hQ1hzCrDjusUy81qK2IcVDM88BgBtKQekEr4c74001+qz/Nb2cyGNwLCnoWIc8jbRqBr9hJBnElkGeHBj5HDifS/K7zGqcOg/IwUlLY4RkYak7JZjFCefrCu66soKs7/BU7IH/tjhR1tKwobkwwGyXxilu3h3H3GhNkoxRF16ZD1tMooFsr/s4wpY260OfRuxtWFFPvEsLioEuMJHJz5YnGhMNR3yzXoyOjr2kOloiZvVFJ1l2OOproqEY3ZT1N/WIgiiQihg1eTQjq3yxElb6ohF3BEZAD1CtilBryEgzrSRDOQ9bBOrSb2a6ki4N1ik2sm8HUQq2OMVOMRaxTSJ5u9UaxUZg/KveLfeiB/rbwsGsoEkPeil+MKZxY50pwUIfxMp/gkhoTsFHCtTWjD26S2rZikFJjCLLcICT8nDfWH6PjBjfGvWygxIaGyKwZjYKs+GP9UaRojGjEGIkIbBRjwgBaGZeLlusUsdvdTeeEusOyfUAcENHCfr8cw2W7hP6IS470axbH+agarCg2XclORnJiaMx7+ofwdk6AvqjYpwNodF4NG74aMIRUs2FikIrTnkR7ykGxcQApaIsNKCx6nFsYiOguA21a3vhQIjKLSMA91ZjLjptSI2KMcICXrAzPHY7MDAO0RdFqK3VfUTgv9bywW9nhUsYi0gxJTDncJ8iCQ6wW6U2bvJ62qGLCzuH+GE1OZup7CAgiQAj3oS8jw0BUTnkcTuO8M5KUXdIclphSSQhFMx66HOVwmxCNCNEoQjF63C5BMeFTGIpR56Jpt01fTxvmfnzE5E6cCzSAXIoF3wBDsUHRjdlaoUGrW5/qyKF20BlWwCXLoqwQVNETQGJk71XM3ib6wGtCEmODuIlUnhAb1OYGUF3NOpSbq1F0R5CE8Wi2RMNhtuijt34ZvVHZhtFm8jjlbFmokjFrbcOEy3n7N0fxtSA4hICgbXUMPZkaoYmOIshIJ0zzUEKcr11eZaeU2GbxXIFo17ikE1s1rqhZR1hpS5FYtAs7uyWFyV+DSLp40oH5g9M2ihrP5GlC8/rRq1x0tqAwobCxPdr8JjrVldowfRpCtLRLX4vulL42XV9dqFm77NqV5lGsHtxohUMddLSFLueKE2AfldbnsJq6+gKwj6IEA6MtJGoMOM+gtib9dSjQ9IkHhZhIm+uc+mIb5sioSFskQsVbNUF0hsZa1hlTc5kp8nqmMCTpl41eTdoSZoPTtcui6Uxx+pJMcw1vWO+8+iLolnMbhfoMXeUxIyqNuBt0KSMRaUCfZTYyuIAZFTN3f7t22tiK0SC6LZjHcPkYVYLSKeFLRFvbMd2qQT07UK8kAREC6ENGB/JAAXEDoTfA0BI3KAwOZ3riswwQq7iGPtLENQmGWDDb02TkyLBjopf7owP6ixqtDGtcNfRoZNY2Ok3b2/00NYXCJhcX0VzGq0xKhhfr9/3SDH6SxqQlZUkrxckzSJPGblL3Da9x3y9ZrztLtv5uwqzGbippGo5mI6/1t4ti9Q0K6tsVZHTOQT1PINTbL8s0tSW2ZdIItXudCM9G1apQySpDS7TN7ahKGxVt1SDaEMPNQtXRt81jQ4QDaV/SXduGSAdq85JLp8LrvKrCfilFrRsB9U736H5uoI3ZundOShHsBWiLIkmANiOSbEaU2q/K+gZ7fU/T5iLFGWb0RS/OcKSjBLHjGZhzmVCiV3Cguao1e3pRVRzL1Qli8RoEJkrAeKpl2ZbK/zT9n8cDKGiHS4jIVwOUQ7gfuNcZ18dYr4ZmaGBjlzNmnhRohEN6vWKrp+cX+m5Kow6wEvf30MtGztGOE7MMo4FoKM6Gzqe2t6RSwriUmpuy25AW0sbcq6Ch8CGEUku9TN8kCsGnyeumzUVNp0mjPj4uGQfdQ3R379LY3SUJwiies+oJnrbwRTlKX1UCpbZ6tSQn44FnNBbT8pD2GTMfz1Id9HSMXwCiQyA1UKN/DInGdwa+AzhPuMZVFcHvinPqTwsjeqpi8CWPLSQLgsOJKFnIxg8N5ahmXgMnajB8i5u9BhVdwVEMTp2Oam9n5OZONAL9Iktf40qnX3mpD6yT0m9DC3Q+ZimlVzzgpqZQNou34mGhXlQEoQdTIgLXF0ZkGV+nski/pDaH9TtFkeJCejKgpxiD1lWI32hXhvZC6m6xc+pXCunn0oy0gylpcZRGO3JKnNJ/XWnUy8hW3dfw0tRPrAZRl895DaFyj9yN34duZSEVbOiBw8zCiMYBNTlJNcFDg/abwsumILCQBTmwAkr8BcvzhYIlpsVceu5oOudwrFy4OCeHMHGwxkGSfI6/9znL8SY5s/OrSst2O91OzyJvxarV5b68eblmk9vpJt7VlatXV6zyiovM88QUxmI2W9iXk9k+v99XXlubDLKFl39MSsy+tZXlVevW1f3V0/cfP9O5vmSRyRR8/+wP164sq6kpW7lW5p6c9uABwFtdLK2uq7rzvjt3h/rKhCrUnoAdtf+lqQ4skONPs1jjZoZhUVMJVZRKy2JOd4V7nttJ4snH2beSj3Phn/3sg6fxswzq1V+wT7E/giJYCm6/syA9bhXFLLDnWuJ8IdgoBx8yqarS+DQu8tIFLq68siRcUxEzzykuMZuX+FZXVpjN83LzyC0bj3WeIvPOhWqbet4b+ept4QfHqt+11Hwmo3HS89Ljddm1n+g7dm8ZV9EbCHYefKiWbznSN737UEv9c82rniStW9bW0DXVq++wr7LfR91c/oyMgowCcFgt8XxdK8mXXVVVUjKjE7VtXr7bq+mVm5dX7ltdUZ7JMAV3/+uhA/9y3+SLe0hSZcMbR6PLI4GOqMpM/F3WLd//whffmGj/3MFg5DMneo40xiJ3fDmiW+U/2B/T35SAh4V+R2Z6PAPiBTaUnuOYMYpPkuZIz0cHSJnBmdKDPD/6hcHBxJ6he5cRuGQrO17cvsdVeEugt2eLc+wHX/zym+NdDeQ373/t/qauf+pdS9z125547JFHUjvzXdyZAnCjDpmuPMjKAp6qkDKAs6oku6p8jg7Uu9xFDC6+0p3JEN0cjOfkd+Ljrz342i8ZMr2fkba3btpGiNk0/mLyDLmbHQ6FdmTf+uPTf/r6rerb9mW2wGRTczB+spnZNTQ4TPchjr71XbRGLuT77Q7WbIkjzAbpmhZoh9KyPbh0XT52VmlCLc444UoenXzg8eT7rjUlTSNLTHXTl2t7E8r0UaZ71cbipvLpvXSdMRRx3NShxZ3juXSOmOMaa+mfDcbsrKCKE+vdTS0tTU2treyFy6VcW7ByTVPTmsogclLPJk+RB5CTDfJpFGTbLUgPmZqalFl9BXUK5JhrFnNmMQ1W+28m1mfOvxVsaQluaG1NnnptXQP7b5d9X/qq6bkZAQRGUYgH7WCHzLMmiKcbFsDwohtA+eaVl88jrz/8535iLW6pWf/IAfYXlxe1bvgmXSda0bwJvTkXPCD6s4sK3G7dlua4x2ZYE4MM7YmPcm3p+dfYdKa3xEDhArmVn9n74KeT782vLg1MSOzUgurSxr3Swppn9v3Jp9kLD9b2nvuCZvJNUtOq6X1aJ+D7fH0fBRu+/j77A7Q+j/afjw7mSDnY3OBCS1HfpumMqqBFGbPwU9/ev//bD5y4ODl58cSmbq+3e1Nzt8fT7dz3xpOn35ycfPP0k2/se6X9WGfnsY4Oem/XbJE8xTnZ11PxlePMtMUXGMbQNkzSI6y0rDNlBU28uMi7xJnjMzKqxZmXFycmdtUDfWNP9w59aef2e9f8aHsovCU0WuAaS54yVT7SHtr1o7945vWx5pZkLiOcevTRk4PVyR/6e3A3a9X/ZD+N8VUKRf7sYrs5a2lRzmIruOdb4mkzKYYm9sZFK5mK8lwto6zyLsHBqnWMlvXEValsk4+jXAy4Sx1P3BH81Z7Wlq6B20f+rKdx34Mbm0/sbfzVdn9gk2880vtoOHDgpKOo6fbt7bWlVZUVCxesn4y1jN5cxAcORIJV3pWuZWJu3voDfV2TTW4jrzP3c2fRa1z+THNmpi1th8VmjmcbvueTyp3lKQcUK8oxy5fPE3VHZDzoiJ/9LLFevCi19KIzEuXVt956NRmlDonerF5iv8VeMKI6PZ7FIdv0meym5zbdq+nSK7HnxuxGjh9/jFgLbippGlxC0lT0vtO2577I3Db9VHmrtN7HHL9c+tDaGBD11+jvJuRvB97vsLFmFqxWkwk3OBU36Ob6mzNG3Dk5eJUTN8uS5ckpYv/rF0jei+ffT04l3/n6P7AXpjcxiek2Rrlcynxtuo7G+mXMST9H7hb0W8Gfk2ZON5HMDMbKAYfmyZoRoQnoJ5U5bmJh3ewSFJVPOLJn7zeJK/n5He+S5y/1Jk8T12tjZJLx1ZOt0+/enLyD3LWOcSSfqp+ewj1Q300+jJn4AjjpHqSZbTbMK+b0mdRCpaCQTppdKiu1tRBLJiNu764N5sxLyiTnnYvEnvx80bLhh3YkH/5OcXkFrmgl89rl0tD4bSV0l9uTr5AEqUQJ2c8BITbOlK1tg49ubifGemX+rHxl3rc4EE5ztkSjLc3btp1IvnIkb0sgs7chGB4dOXhmAOOrTv0l+7emNhCgmOqclZW7RBhd4k6L23NZw2/w5VFadrMW3TNHFIt7VqjjEiyzUy/ZQ8jGjk2NraGuHib5zsQr9xz7xi5fb135mvncZEtvb0tzby95JWN+xuCd1au31vrbol13JHpCp+OhA9sl9031xcmlvQ1NkUhTQ28GfvbicYthPsUuWhfqzaq5BDar9i8+P/jcvvfp880R364PHpmeSj9tzUVaM65JLzhP/7cgm+eDR977d8TD3ML+hH0Zj3Nvqr+hDW6Uj6WYu+Hox63D/0RhkzQD/98vXBbU/9FkOa4vi9v8IfCiP55u18huoOc2vZC3IYYtfjUNhf82HuRt9Sxt18MxNfRUeW0xn79WzjW6rf0j7lnXFX2Yr83VDc9Qtf/dfObMtXHENV5/7X9IMX1Azx1zC/tT9TI7pb77Ufjhuj8230sV9kHYwJ6FDR+3HjfKjXKj3Cg3yo1yo/z/LuS+D8cx+dB+1biPPjkT0P+x2Xuj/g714MdQv/FRKjHPqhtm1fv/oPqCVt/48Mo459TSWfX2a+rZj1Tfm13Z5mvqgZn69O9cL6Yql8Gtu1Fv1Bv1Rv1fVYdm1efo7/HsT6AMOHAACwzeSxBEmJasI6D/ym+BbvoXHVwa9vcCGH0CPhzpfQYy4Smjz0IQ/tLoc0iTNPomyCOlRt8MPhKAEIzAKOwBwbjHsA3BOOxCvgJMath+vKfwe2EQdsIEUsSRNo7QMbhVw+5C/F6EjWEdhAFYidAGpBMQM65x24cUg+CGm2Ez1hbYiCccCUcTiB3XuDdoUiaQQwy5FuNJZxz7A9CB84a1vy2hMtuQLgDVH4FPNZRiLUPdSrX6+3PYjJrEETOq2UgweP3+fGb+Pkd9gv7Nz7XFr/aWqvz2MpXfVhLne0oe4reWqHz3SpWPrJziw8Uqv2WFym9eMcV3SSofWhbkO5epfMdylW9ffoZvWybwm5Y28huXnuFbl6p8yxKVb/aqfNAr8U2Lh/kNi6f49YtVPuBR+UbPGb5BVPn6RSpf557ib3arvN99hq8Vpvh1gsqvFR7ia4QS/qaiOF9dpPJVvMqv4Q/zlQvj/OqFKl+xcIpfVTjFlxeqvK/wDF9WGudXFq/lVxTH+eXLtvMelLW4wLWgR1zk5xexBQt63AVreaEGO3zRMF+0bH5ez8J8lS/MU3lXxYLqrfNX51VvLfC30X4+7c9bcFPeSHdOVXaXs8rRlR1xRDKq7F2mKqaLw2aPZK3O7LJVpXdZqsxdmZH0iDkCkbQqaxeLWGuEiWBQ+f0mcp6cgJDUfM6idjQr1ratCrlH8XTSu7+9WzHfo0BX99ZwgpAHIkfvvx8W1jUrJzrDz+JGLayLJBimvj2c4NgHInW4x5IkgVG1rjGWJDKrAjZ6gaR3dLxBbvRnBlKK1IDPwcyH/wLZcaahCmVuZHN0cmVhbQplbmRvYmoKMTAgMCBvYmoKPDwKL1R5cGUgL0ZvbnREZXNjcmlwdG9yCi9Gb250TmFtZSAvQVZWTE5RK0FwdG9zIzIwRGlzcGxheSxCb2xkCi9GbGFncyAzMgovSXRhbGljQW5nbGUgMAovQXNjZW50IDkzOQovRGVzY2VudCAtMjgyCi9DYXBIZWlnaHQgOTM5Ci9BdmdXaWR0aCA1NjcKL01heFdpZHRoIDE4ODAKL0ZvbnRXZWlnaHQgNzAwCi9YSGVpZ2h0IDI1MAovU3RlbVYgNTYKL0ZvbnRCQm94IFstNTUyIC0yODIgMTMyOCA5MzldCi9Gb250RmlsZTIgMTEgMCBSCj4+CmVuZG9iagoxMiAwIG9iagpbMCBbNDcxXSAxNDcgWzQ5OV0gMjA1IFs1MDddIDIzMiBbNTA4XSAyMzggWzU0Ml0gMjQ0IFs1MTVdIDI3NSBbNTMzXSAyNzggWzI0MF0gMjkyIFsyNDBdIDI5OSBbMjc5XSAzMDUgWzg0MF0gMzE0IFs1MzBdIDM0MSBbNTQyXSAzNDggWzQ4NF0gMzU3IFszMzNdIDM2MiBbNTM0XSAzODMgWzc0OF0gMzg4IFs0ODkgNDc1XSA5ODUgWzE5M10gOTkyIFsyNjFdIDk5OCBbNTAyXV0KZW5kb2JqCjggMCBvYmoKPDwKL0Jhc2VGb250IC9BVlZMTlErQXB0b3MjMjBEaXNwbGF5LEJvbGQKL1N1YnR5cGUgL0NJREZvbnRUeXBlMgovVHlwZSAvRm9udAovQ0lEVG9HSURNYXAgL0lkZW50aXR5Ci9EVyAxMDAwCi9DSURTeXN0ZW1JbmZvIDkgMCBSCi9Gb250RGVzY3JpcHRvciAxMCAwIFIKL1cgMTIgMCBSCj4+CmVuZG9iago3IDAgb2JqCls4IDAgUl0KZW5kb2JqCjEzIDAgb2JqCjw8Ci9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMzM5Cj4+CnN0cmVhbQp4nF3SzW6DMAwA4DtPkWN3qCBQfiohpA6KxGE/WrcHoInpkEaIAj3w9kts2k1FAumT7eDE8cumalQ/M//djOIEM+t6JQ1M49UIYGe49MrjIZO9mFfhVwyt9nxbfFqmGYZGdaOX58z/sMFpNgvbHOR4hifPfzMSTK8ubPNVnqxPV61/YAA1s8ArCiahswu9tPq1HYD5WLZtpI3387K1NX8Zn4sGFqI5NSNGCZNuBZhWXcDLA/sULK/tU3ig5EOcJ1R27sR3a1z6PrLpQRDvCqeyQiUcdcxIEelIosx6R4qdOKdVkoyUkPaocM08kJ5JJSripIp0INWoOEalAakkYS88WWM7EtWl1Etak1I8gHWn/Lbv2znxDNvi2bpStmZTPHo4pqjaY1qIzUTHgFSSaLtR/f+H7uzdFbkPVlyNsTPFe4TDdGPsFdyvmh61q3LvLw8ftuwKZW5kc3RyZWFtCmVuZG9iago2IDAgb2JqCjw8Ci9UeXBlIC9Gb250Ci9TdWJ0eXBlIC9UeXBlMAovQmFzZUZvbnQgL0FWVkxOUStBcHRvcyMyMERpc3BsYXksQm9sZAovRW5jb2RpbmcgL0lkZW50aXR5LUgKL0Rlc2NlbmRhbnRGb250cyA3IDAgUgovVG9Vbmljb2RlIDEzIDAgUgo+PgplbmRvYmoKMTQgMCBvYmoKPDwKL1R5cGUgL0V4dEdTdGF0ZQovQk0gL05vcm1hbAovY2EgMQo+PgplbmRvYmoKMTUgMCBvYmoKPDwKL1R5cGUgL0V4dEdTdGF0ZQovQk0gL05vcm1hbAovQ0EgMQo+PgplbmRvYmoKMTggMCBvYmoKPDwKL0xlbmd0aDEgMTE3ODgKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAzNjE3Cj4+CnN0cmVhbQp4nO1afWwcx3V/u7f3QfIoHimZ+jhKO6fVXSQtPyTKokSaki4kj+KHLZE8krolJeuWx0+HFClKpuTYqhkripV1nAYNkrhBAQdoULRQ/tiTU4FMg9QuqiIIQCBIUQTIR1sEKdoAaf8JgrSxre1vZvcoilLcJi0sFOXszuy8j3nvzZs3b2cPRxIRldIi+ajndLqu/ukjf7YdmB+hZnMz5pzvp5QmkpoBV+cWLrPYZ574a8CTgN8en5uYOfNaWYRI3ktUdn1i+oXxLUcS/0hU/jXQvzU5Zo7GR375t0QV04AbJoEo/YvSPwb8VcB7JmcuX53rCGB8xbcxfnJ6Nmfe+cU3v0O0+wBR8M6MeXUumCz7FdG+fwE/u2DOjMWfOv4y0f4QbPje3Oyly86bVE+kc3vZ3PzY3NwNZzPg92BTGSnKp+Vvkp9C/kPKCji+7D7lFRqXf4hnCSkyLwoj+VXQfeSVZ9KM0VeIEQtef/8viUJb5EOMpDc5zfddfwvXJrgltNyDYVKAIbSKgJnjuK1vWcDkb+EXVTh/5/yz74dURuT8W6He+7Lzr/6tVOHC9BJ9gmZwXaFRXLz/cZqjBazDGD1P0zQBjo+hvUTP0ffJpCGap35wTNCL4P4UTWLEAtqLgD9JWZqFpBfpGYzPCAkmOKdBXYD0a0IS5+8DNAXqdcgcgMxRYOepl87QOXBcTHb94Rtf+uKrn7rxyeuvfGLx5d+79tKLH3/h6pWF5y9fmr84N3thZvpjz01NToyPjeZGzOz5Z8+dHR4yMmcGB/rTvT2nTz3zdHdXZ8fJ9r1qpLioWsqXFLdqrWPFNdWULy5Bt6SmWrIDrXZQIO3TOrOTvZlYd18m1RaNxYyoFrOTthJP8WqOWrkCwYAIjMJYiOhOa929QxmWsrKCCEz/A5BLP7pK83q23Nqfsdt1QGvgkwJeBTvWkTsLZI3Z1GNZo3nyxYFPRvOS6PhbXzMwE0OzR3QtpmXGwJsPUTjWn21FL1zoSewkJLKlCI2g5s5oS5LXG8rYLDtudICb5Lgt7vQSHdauuv2szXKM2YG4NtKTsWK2lNWiHtyXgcckM2rFtBgzjCXnnSrOrcUgS6aWvCbd7M0npZvpocwyNiC72Z+5LUtya7bFyO8BLbOMcE4KrMyxHMkBxgHqlrAyt+WQ4I8uJ4kWBVURCAHnMAuBCxVwEuWWZBcXcRUlhKIkyaAoLiVZ4FaAC7m4RZd7r8cdAiXCKd8gGXtLEN0CL2FlksX+ZChZlAzLpTLWgqNuA/MN8BZJ9FZYKpWiecjsE+glaTFflIwuC0l9HuciODlucRUHyznbGkHQ50584P4MBoYyb4UJ8kULjhZeaqpTefmUrt0P694MVi+Vl07pWYQ2B33xFENY28l0hvNmo4h5RHdbTTWPLpbRxqKakd+yxZpL5SOR1m6rFYGMWBMBljcDiaxuuSHHA02LNCFMffHOnNaeBYuGbYO7E6jcIMvaI1kdXRZpt9p5VJicmyrzsi+el5S4dJyOw2+BsF2sjbXYJVrLKuUEnXApAU4Jai22VOl6PaWl2LYpK6eNIAKTPZmJ6LhhQrad1Exb0VqieYVasF+2SZhSKk+ndMytGzF4Wu8ZxiblzmCW1cbySSVh5kwOt8Ww7y2PpLW1GWtGpJhlJ81cFhwpQzBjJwKZ0kw2Ci9juvBcWkN3aIiP6R/KWOFRbVSDh5NJy8S0oyxnRC0jJzyO8TCNaqr997OTl5xkvufjuXE0S4xGstqIi+C7cz1uYj1iHFxrcVoXVyeeknhaXVpqFBy8mqO2DxEXY6OGGzLUI/LGb2SS1jAxrKkQbkWeKkCSBwHAbdkTD4KTq2A7r1l4rdaNFVtJ8MjLxOznova0oa+ymPbiCLNYRGvSeCMGn+Q1a/vRWcyZPDkFeOwB0QUEy4wgliGwPWsVIg7DlMSqJvuC/oBIpFSpH6rlOJ+OvdjDsgbLZoHF7olFme3Hk42bPLh42u1x59OD3I+HaaUxlvgGitpBvAHGzTEthmxt803rep/bqMA6SmdsilqWZtkSTIy3gxniE3Yg0ckfuOd0zRzDInJ9zBwTY9thrvAOlxZNaTEDLHJc+BKOQ7YY4U3OQjTa57Db/PFyq8JijRay1jkkXCWRG8zitcAirJ2JpTYRydwJnRwyIMhlLIpzRowXd8Ke0fPngvH7GHHP6i5zSEiFZX0Zu6fAEhQ3Ohd1W956FEQ+eakP+UMRC8Wd5493wr1JRFWUj2a23J/xlkeM7+RDo4UFc4cBI9Iufy3GCvaWuPa6SgPiDou7KG6H4lhoW4ENLjnIp3M/CNCH0e4YnzDXnQD6UMU8iphI1gOU+JiYk/s6ZDx94qBgarxGl5y3e5AjsxqvhsHVh4QiPkKItlzB3F0BTnyUKzxN7l3C704xhbXoYnEHhc2c5k7J/6DjPe8tO2+T67mYV3jM8Fm+6u1Kb9+NRe1JQx91RwW8DM6QUZG5c73itDGM3aDFgshjmD52FbPTOl4iYm6vul7tcrMDj0qpXaN2xJDXoUqySeuQeEPYWlqHLQNc7Wm3ZZJC2lH+KNKO5mUpiGzPk1GkNIxEb+Wyo+6LGl6mo9FmfjQKiIUuEmu7wFNTf8YfVQwRMgn7iu5Fsdsu6Kv0K3xPBgueDHGatUr0C3FX3NhIeO2CHnrkKCv031MW8lbTLhI0no0SoQ9W5XMXqMtdri7Zldzl5glgEznL4qktf24T36HhRDnwFTCtEUY2elbCNy/BlB6uOiQwAsR2C3Jz3GWLl4AQAe87bmiXgBiBNe9EXS7cy/jEWNAL3K4TYHdx3I1zj+yNdqPzim6g185rFiztvHo7qcTbpeF1Wd8T765p0YNEbVUYf9FrqxI5lJfCOAMrUT80JlgE7moS/kzAVMBWU14KJjwGP2eQ402WVVLI/zz9L+MASuJwSYa1HmFfw3pgrUsfTQmtx5YKtLfKpatPjvS2Q3GrXdLKzy/83VTEA6AW63vtrpdzxHFijWMEim/Ftdht3PfBQkqY1QtjC34bF1vaG7sO25+5Biz31F3+JrElPP2JGK9R7jqhjcf4rO4ddK/x1X1FiHtFZ2wK56xWCactvCin+KuKce5QQiQ5CweeKdMUeUh8xmzDWaqPn47xBaBFGL7wm92PIc37zsA7QIlnmqONBr4rlpyfVRluqpLxkkfttxiLlINksQp8aNg3hHs9miZweIsHEh4Xn8ENbE6Xj1sflq3uNJzAv8iKj0aL+Vde4QPrDf2DyIyPR5ayz2tXY9wV9qD2Ag4LrZrN2FmkRCBPVhmWhdeppfEvqcGM23KSVF3FTwb8FOPxRqvwjXYfDFfxcDOXnLeq+OfSqrYXC9rmoY13rII6O/dIbTzKpGE31nAL8/MNpLn6lYSn1DprDeH7MGbv5Io9OwBuqjKEBFjyBreE/7rAf3+46+8iH5XRZqqhuuSO/VvZjo/49yjFW6aKlUikdueezZsleZ5C86Tr9ZG/qS8/hEYvr9jaeODgxfJYeXx34vCTDYfqK5/YEvDHymNSouFIQ8PhJxPa7sATWoESDASCvrv3KuqTyfpDJ07c6/JVvfdTqS5Qf+zIocbjx1v+/E9f/8yt9Mm63X5/16/v/P2x2oPNzQdrj1nKm+/HcQBINFXrDS2NL7/28sX+kYOsEdbL4pcQWf79v7pU9uz5suZfUklI/Nry468+/2v+/Mlk/YV3v/D+SvFXQlvAG8AIt2Cc+ztMSfzdL/z7P4FODxbfD3x34Z6fOP/BK22Ux1ICQ3Tjcdvwv1F89yj8uG34MIpSRq0fmq7Io3Upg78Bv+vDs+0h3W00X+hLPycTdX49D8d/kAzp584dXh9Fk5tp6lH4wPLDeh6y7diHuGYD9+2Rv/Wgbb5/oBP/1Xj51sP7SEk9eu7/k+J/1/nVepzvZ857vhXnF7+LPMz7scVeofj+gDp8d6jjcduxUTbKRtkoG2WjbJT/30V6TTzOb1wb18a1cW1cG9fG9X/h8n+f/4bu+wEdJIUi5CMZbR1Qkvx02XXvl/kgDfF/MypF6F8m8voS1QNy+zJtoj/x+j7qoq97fQU897y+nyqlA14/QPVSO/XTJE3RJWJea6KO0yxdgFxGVwQ1h7ZAv0xjNENz4JgH7zyw0/SCoF4A/TJw07jGaJRqgW0DHwNlVkh7HhxjFKOPUhr2dVCKBkkHNAfqrJDeJrTMQYIJqdXUAvw0ZPVh3IT4fyXX2QO+dmr6HeQ00QFcB2HbAXH99hIGYck8KFPCR8yT9dvLWf0/q/NH/D+yD5ekc/6Aoz570FHP1c2rZ+s+rw7XOepQraMatStqptpRz9Q46mDNijqgO2r/vi41vc9R+/Y7au/+W2rPPqae3ptST+29pT6z11Gf/oijdicctSuhq517JtSOPSvqyT2O2h531FT8ltqmOWrrbkdtia2oH405ajJ2Sz3BVtTjzFGPsc+rzaxOfWrXvNq0y1EbVUc9qi6qR3bOqw07HfXwzhX1yaoV9VCVo9ZX3VIPHphXa6uPqTXV8+r+fc+qcejasyO6/ay2O6nu9u3Yfja245jKmtFRd02ou/Ztqzy7c6ujVlU6avTw9qbhbQ2VTcM7kj28v5X3n9j+VOXk0ObGioHyxshAhRExShvDA/5GeUBBDRtlDZsGShqLB4KNgYFNRrERMMgoagwN+EANGbKBTZVM+qVl6XPUr3cvBZ2+bjvUM2xLN+14mrfJ3iE7cNOmgaHhTF6SPmvceP112tnSbX8unbmNhdrZYuRlubU3k1d8nzVasMa6rpN3ia4H67q05iJUfpPudly6x+71VwG9wOrhH6Bso/8ETxuCGgplbmRzdHJlYW0KZW5kb2JqCjE3IDAgb2JqCjw8Ci9UeXBlIC9Gb250RGVzY3JpcHRvcgovRm9udE5hbWUgL0FTSkhFVitBcHRvcyMyMERpc3BsYXksQm9sZAovRmxhZ3MgMzIKL0l0YWxpY0FuZ2xlIDAKL0FzY2VudCA5MzkKL0Rlc2NlbnQgLTI4MgovQ2FwSGVpZ2h0IDkzOQovQXZnV2lkdGggNTY3Ci9NYXhXaWR0aCAxODgwCi9Gb250V2VpZ2h0IDcwMAovWEhlaWdodCAyNTAKL1N0ZW1WIDU2Ci9Gb250QkJveCBbLTU1MiAtMjgyIDEzMjggOTM5XQovRm9udEZpbGUyIDE4IDAgUgo+PgplbmRvYmoKMTkgMCBvYmoKWzE5M10KZW5kb2JqCjE2IDAgb2JqCjw8Ci9UeXBlIC9Gb250Ci9TdWJ0eXBlIC9UcnVlVHlwZQovQmFzZUZvbnQgL0FTSkhFVitBcHRvcyMyMERpc3BsYXksQm9sZAovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZwovRm9udERlc2NyaXB0b3IgMTcgMCBSCi9GaXJzdENoYXIgMzIKL0xhc3RDaGFyIDMyCi9XaWR0aHMgMTkgMCBSCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMjc2Cj4+CnN0cmVhbQp4nK2RSUvEQBCF7/Ur+qgeampJbxAaZkkGvIkBD+LN5SaM/n8wnc4yUQ+Ck0MXr+h0vfreCQgpf07VGzKVWJRgJChaZz5e4OEG3mHXweZ4z2TePqE/BsFFHGHTshGP0ZnuFaJFHyrDziJ50z3DY00UNXGoiXmqLrHvq90ndjXpIRb9S//JdLfQdHAHp786zQZ/+GIvyLr2xVKVeW6bOJa5YrO2SWjxRfvD4Hv2me/Fpc/Kg1+2tmjZXcy3UkTlbzzbKmk/Xxu6OKco6FyfHysGnjj5dpVf3lukcGJ7xqlpVvlOeuYWeq5V5rUtdeQ+/5/3yv0w5jLyzP3yXig5TXMb97+95YyzCvrV3lfmenn8C5p9qB8KZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8Ci9UeXBlIC9QYWdlCi9NZWRpYUJveCBbMCAwIDQyNS4yOCAyODMuNTZdCi9SZXNvdXJjZXMgPDwKL0ZvbnQgPDwKL0YxIDYgMCBSCi9GMiAxNiAwIFIKPj4KL0V4dEdTdGF0ZSA8PAovR1MxMCAxNCAwIFIKL0dTMTEgMTUgMCBSCj4+Cj4+Ci9Db250ZW50cyA1IDAgUgovR3JvdXAgPDwKL1R5cGUgL0dyb3VwCi9TIC9UcmFuc3BhcmVuY3kKL0NTIC9EZXZpY2VSR0IKPj4KL1BhcmVudCAyIDAgUgo+PgplbmRvYmoKMjAgMCBvYmoKPDwKL0Rpc3BsYXlEb2NUaXRsZSB0cnVlCj4+CmVuZG9iagoyIDAgb2JqCjw8Ci9UeXBlIC9QYWdlcwovS2lkcyBbNCAwIFJdCi9Db3VudCAxCj4+CmVuZG9iagoxIDAgb2JqCjw8Ci9UeXBlIC9DYXRhbG9nCi9QYWdlcyAyIDAgUgovTGFuZyAobmwpCi9WaWV3ZXJQcmVmZXJlbmNlcyAyMCAwIFIKPj4KZW5kb2JqCjMgMCBvYmoKPDwKL0F1dGhvciAoU3RlcGhhbiBBbnNlbXMpCi9DcmVhdG9yIDxGRUZGMDA0RDAwNjkwMDYzMDA3MjAwNkYwMDczMDA2RjAwNjYwMDc0MDBBRTAwMjAwMDU3MDA2RjAwNzIwMDY0MDAyMDAwNzYwMDZGMDA2RjAwNzIwMDIwMDA0RDAwNjkwMDYzMDA3MjAwNkYwMDczMDA2RjAwNjYwMDc0MDAyMDAwMzMwMDM2MDAzNT4KL0NyZWF0aW9uRGF0ZSAoRDoyMDI1MDUzMDE0MDgyOSswMicwMCcpCi9Qcm9kdWNlciAoaUxvdmVQREYpCi9Nb2REYXRlIChEOjIwMjUwNTMwMTMwMzU2WikKPj4KZW5kb2JqCjIxIDAgb2JqCjw8Ci9TaXplIDIyCi9Sb290IDEgMCBSCi9JbmZvIDMgMCBSCi9JRCBbPDZBMUQ1MkJDMDREMDk1NDY4OEMwREVFNUI4MDEzM0U0PiA8RTVENUU5RkYzRjhCMjE3MDBENDU4Nzc3MTA2OEJCNTE+XQovVHlwZSAvWFJlZgovVyBbMSAyIDJdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9JbmRleCBbMCAyMl0KL0xlbmd0aCA4OQo+PgpzdHJlYW0KeJxjYGD4/59RT5WBgVH3DZDQqwYSOmeAhHYBkJASBRISSUBCfC2QYOAHEqJ7QaxIICF2HCRbCVK3BkQ8BRJaO4CE5gwgIS0H4i4CmXwASOjPZmAAAJrZD/UKZW5kc3RyZWFtCmVuZG9iagpzdGFydHhyZWYKMTIxODcKJSVFT0YK
security:
  - Bearer: []
tags:
  - name: common
    x-displayName: Common
    description: >-
      The "Common" section of the API documentation provides a set of endpoints
      that are frequently used across different operations. These endpoints
      handle fundamental tasks, such as authentication and service status
      checks, which are essential for ensuring smooth communication between your
      application and the API. Understanding these endpoints is crucial for
      maintaining an efficient integration process.


      One of the key endpoints in this section is `POST /token`. This operation
      is responsible for generating an authentication token. To access this
      endpoint, you must provide valid credentials, including a username and
      password specific to each shop. The returned token is essential for
      authenticating further requests. It's important to store the token
      securely and be prepared to request a new one if it becomes invalid, as
      unauthorized errors can occur.


      Another important endpoint is `GET status/get`, which serves as a quick
      way to check the status of the ShopAPI. It requires no authentication and
      provides a simple confirmation that the API is functioning properly. When
      the service is available, the response includes a message confirming that
      the status is OK.

      ___
  - name: v2/orders
    x-displayName: Orders
    description: |-

      ___
  - name: v2/shipments
    x-displayName: Shipments
    description: |-

      ___
  - name: v2/returns
    x-displayName: Returns
    description: >-
      The "Returns" section of the API documentation provides a set of endpoints
      that are related to the returns processes

      ___
  - name: v2/rma
    x-displayName: RMA
    description: |-

      ___
  - name: v2/products
    x-displayName: Products
    description: >-
      <div class="admonition admonition--danger"> 

      <h1>WARNING!</h1>

      <b>All</b> of the product related endpoints in the v2 specification have
      been deprecated and replaced by the new <a
      href="/specs/v3#tag/v3products"><code>v3/products</code></a> endpoints. At
      any point these legacy end points may be terminated. Please upgrade your
      implementation as soon as possible. For documentaiton on the new
      end-points go the the <a
      href="/specs/v3#tag/v3products"><code>v3/products</code></a> section of
      our new API specification

      </div>
  - name: v2/stock
    x-displayName: Stock
    description: >-
      <div class="admonition admonition--danger"> 

      <h1>WARNING!</h1>

      <b>All</b> of the stock related endpoints in the v2 specification have
      been deprecated and replaced by the new <a
      href="/specs/v3#tag/v3stock"><code>v3/stock</code></a> endpoints. At any
      point these legacy end points may be terminated. Please upgrade your
      implementation as soon as possible. For documentaiton on the new
      end-points go the the <a
      href="/specs/v3#tag/v3stock"><code>v3/stock</code></a> section of our new
      API specification.

      </div>
  - name: v2/stockmutations
    x-displayName: Stockmutations
    description: >-
      <div class="admonition admonition--danger"> 

      <h1>WARNING!</h1>

      <b>All</b> of the stock mutation related endpoints in the v2 specification
      have been deprecated and replaced by the new <a
      href="/specs/v3#tag/v3stock/operation/get-v3-stockmutations"><code>v3/stockmutations</code></a>
      endpoints. At any point these legacy end points may be terminated. Please
      upgrade your implementation as soon as possible. For documentaiton on the
      new end-points go the the <a
      href="/specs/v3#tag/v3stock/operation/get-v3-stockmutations"><code>v3/stockmutations</code></a>
      section of our new API specification.

      </div>
  - name: v2/purchaseorders
    x-displayName: Purchase Orders
    description: |-

      ___
x-tagGroups:
  - name: Authentication & Settings
    tags:
      - common
  - name: Orders, Shipments & Returns
    tags:
      - v2/orders
      - v2/shipments
      - v2/rma
      - v2/returns
  - name: Products & Stock
    tags:
      - v2/products
      - v2/stock
      - v2/stockmutations
  - name: Purchase Orders
    tags:
      - v2/purchaseorders
paths:
  /token:
    post:
      summary: token
      operationId: post-token
      x-json-api: false
      x-internal: false
      security: []
      tags:
        - common
      description: >
        # POST token


        The operations of the `shopapi/v3` require a bearer token to access the
        data. For each client a separate `username` and `password` can be
        requested which in turn can be used to request a bearer token for
        accessing the endpoints. The same bearer token will grant access to all
        `shopapi/v3` endpoints and older, but only to the information of the
        client it belongs to. and need to be provided to the Token operation.
        This operation will

        return a token string which needs to be provided in the header of each
        request.


        <div class="admonition admonition--info"> 

        It is not required to request a tokens for each and every API call. It
        is recommended to store the token until it expires. Be aware that a
        token can potentially be invalidated before it actually expires in case
        of intrusion detection. If this happens requests will return a <code>401
        Unauthorized error</code> and a new token must be requested.

        </div>
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/post-token-request'
            examples:
              '1':
                $ref: '#/components/examples/post-token-001-request'
      responses:
        '200':
          description: >
            A successful authorization response has the `token` and expiration
            date (`expires`) among other useful values. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/post-token-response'
              examples:
                '1':
                  $ref: '#/components/examples/post-token-001-response'
        '400':
          $ref: '#/components/responses/400-unauthorized'
        '404':
          $ref: '#/components/responses/404-not-found'
  /status/get:
    get:
      summary: status/get
      operationId: get-status-get
      x-json-api: false
      x-internal: false
      tags:
        - common
      description: >
        # GET status/get

        This endpoint can be used to verify if the ShopApi is up and running. 

        It requires no authentication and has no input requirements whatsoever.


        When the ShopApi is functioning the response is a simple message with
        the following structure:


        ```json title="Successful response"

        {
          "messageCode": "OK",
          "message": "Status is OK.",
          "result": null
        }

        ```
      security: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-status-get-response'
              examples:
                '1':
                  $ref: '#/components/examples/get-status-get-001-response'
        '400':
          $ref: '#/components/responses/400-bad-request'
  /settings/get:
    get:
      summary: settings/get
      operationId: get-settings-get
      x-json-api: false
      x-internal: false
      tags:
        - common
      description: >-
        # GET settings/get

        When making API calls you will often are required to provide the correct
        id's when refering to configuration entities such as `orderTypes`. These
        id's can be obtained by using the shopapi/v2 [`GET
        settings/get`](/specs/v2#tag/common/operation/get-setings-get) method.
        It is recommended to cache this data locally and refresh daily. Among
        these settings the id's and names of the following entities are returned


        | entity                  | description  |

        |-------------------------|------------- |

        | `mainShippingMethods`   | (required for the `shopapi/v3`) |

        | `shippingMethods`       | (deprecated, but still required for
        `shopapi/v2` endpoints) |

        | `orderTypes`            | |

        | `returnReasons`         | |

        | `returnShippingMethods` | |

        | `languages`             | |

        | `countries`             | |

        | `paymentMethods`        | (obsolete) |
      responses:
        '200':
          description: >
            A successful response from the server with the current client
            settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-settings-get-response'
              examples:
                '1':
                  $ref: '#/components/examples/get-settings-get-001-response'
        '400':
          $ref: '#/components/responses/400-bad-request'
        '401':
          description: >
            When an no token or when an invalid or expired token is used the
            server responds with a `401 Unauthorized` status code
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Authorization has been denied for this request.
              examples:
                '401':
                  value:
                    message: Authorization has been denied for this request.
  /order/release:
    post:
      summary: order/release
      operationId: post-order-release
      x-json-api: false
      x-internal: false
      tags:
        - v2/orders
      description: |-
        # POST order/release
        Releases an order which was created with `onHold=true`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                externalOrderNumber:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response-structure-OK'
  /order/add:
    post:
      summary: order/add
      operationId: post-order-add
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/orders
      description: >-
        # POST order/add

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3orders/operation/post-v3-orders"><code>POST
        v3/orders</code></a> end-point instead.

        </div>

        This operation will add new orders to the database. Important to note is
        that when the Billing Address fields are left empty, all the data in
        Delivery Address will be used for both Delivery and Billing.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - externalOrderNumber
                - paymentMethodId
                - deliveryAddressLastName
                - deliveryAddressPostalCode
                - deliveryAddressHouseNumber
                - deliveryAddressStreet
                - deliveryAddressCityName
                - deliveryAddressCountryIso
                - languageId
                - orderTypeId
                - orderItems
              properties:
                externalOrderNumber:
                  type: string
                  description: The order number of external system (e.g. Magento)
                extraReference:
                  type: string
                  description: Can be used to store an extra reference.
                actionCode:
                  type: string
                  description: >-
                    Can be used to store information about a promotional action
                    in an order.
                preferredShippingDate:
                  type: string
                  format: date-time
                  description: >-
                    When this date is set, the order will not be shipped before
                    this date.
                partialDelivery:
                  type: boolean
                  description: >-
                    When set to `false` the order will only ship when all
                    products are in stock. When set to `true`, orders will ship
                    in parts when products become available.
                onHold:
                  type: boolean
                  description: >-
                    When set to `true`, order gets status 'on hold'. Use the
                    end-point `POST order/release` to release the order.
                email:
                  type: string
                  description: The customer's email.
                phoneNumber:
                  type: string
                  description: The customer's phone number.
                currency:
                  type: string
                  default: EUR
                  description: >-
                    The currency of the order (ISO-3 code, like `EUR`, `USD`)
                    `EUR` is assumed when empty.
                bankAccountNumber:
                  deprecated: true
                  type: string
                  description: The customer's IBAN.
                bankAccountHolderName:
                  deprecated: true
                  type: string
                  description: The account holder's name.
                bankAccountCityName:
                  deprecated: true
                  type: string
                  description: The account holder's city.
                paymentMethodId:
                  type: integer
                  const: 1
                  description: >-
                    The id of the payment method. Since we do not handle
                    payments ourselves anymore, this should always have value 1
                    (deprecated)
                shippingMethodId:
                  type: integer
                  description: >-
                    The id of the shipping method. All available shipping
                    methods and the corresponding id's can be found with the
                    `GET settings/get` operation of the API.  When filled in,
                    this will overwrite the default shipping method. So unless
                    your customer uses a shipping method other than the default,
                    this field should be empty.
                deliveryAddressFirstName:
                  type: string
                  description: The name of the person of the delivery address.
                deliveryAddressInsertion:
                  type: string
                  description: >-
                    The insertion between first and last name of the delivery
                    address.
                deliveryAddressLastName:
                  type: string
                  description: The last name of the person of the delivery address.
                deliveryAddressExtraName:
                  type: string
                  description: >-
                    The extra name of the person of the delivery address (e.g.
                    the company name)
                deliveryAddressPostalCode:
                  type: string
                  description: >-
                    The postal code of the delivery address. This field is
                    required when shipping within The Netherlands, Germany or
                    Belgium (and most other countries).
                deliveryAddressHouseNumber:
                  type: integer
                  description: >-
                    The house number of the delivery address. This field is
                    required when shipping within The Netherlands, Belgium or
                    Germany. If there is no housenumber in there, Maya will try
                    to retrieve it from DeliveryAddressStreet. If
                    DeliveryAddressStreet does not contain a housenumber for
                    these countries mentioned, the order will be marked as Not
                    Valid, and won't be shipped, until a housenumber is added.
                deliveryAddressHouseNumberAddition:
                  type: string
                  description: The house number addition of the delivery address.
                deliveryAddressStreet:
                  type: string
                  description: The streetname of the delivery address
                DeliveryAddressCityName:
                  type: string
                  description: The cityname of the delivery address
                deliveryAddressRegion:
                  type: string
                  description: >-
                    The region this address is in. Preferably ISO 2 character
                    code. (ISO 3166-2)
                deliveryAddressCountryIso:
                  type: string
                  description: >-
                    The ISO 2 character countrycode (ISO 3166) of the delivery
                    address. All available countries and country codes can be
                    found with the `GET settings/get` operation of the API.
                deliveryAddressExtraAddress:
                  type: string
                  description: Used to store extra information for the delivery address.
                billingAddressFirstName:
                  type: string
                  description: The name of the person of the billing address
                billingAddressInsertion:
                  type: string
                  description: >-
                    The insertion between first and last name of the billing
                    address.
                billingAddressLastName:
                  type: string
                  description: The last name of the person of the billing address.
                billingAddressExtraName:
                  type: string
                  description: >-
                    The extra name of the person of the billing address (e.g.
                    the company name)
                billingAddressPostalCode:
                  type: string
                  description: The postal code of the billing address
                billingAddressHouseNumber:
                  type: integer
                  description: The house number of the billing address
                billingAddressHouseNumberAddition:
                  type: string
                  description: The house number addition of the billing address
                billingAddressStreet:
                  type: string
                  description: The street name of the billing address
                billingAddressCityName:
                  type: string
                  description: 'The city name of the billing address '
                billingAddressRegion:
                  type: string
                  description: >-
                    The region this billing address is in. Preferably ISO 2
                    character code. (ISO 3166-2)
                billingAddressCountryIso:
                  type: string
                  description: >-
                    The ISO 2 character country code (ISO 3166) of the billing
                    address. All available countries and country codes can be
                    found with the `GET settings/get` operation of the API.
                billingAddressExtraAddress:
                  type: string
                  description: Used to store extra information for the billing address.
                extra1:
                  type: string
                  description: 'Can be used to store extra information '
                extra2:
                  type: string
                  description: 'Can be used to store extra information '
                extra3:
                  type: string
                  description: 'Can be used to store extra information '
                extra4:
                  type: string
                  description: 'Can be used to store extra information '
                extra5:
                  type: string
                  description: 'Can be used to store extra information '
                vatNumber:
                  type: string
                  description: BTW (VAT) Number
                clientReference:
                  type: string
                  description: Extra reference space for the client.
                languageId:
                  type: integer
                  description: >-
                    The id of the Language Code. All available language codes
                    and the corresponding id's can be found with the `GET
                    settings/get` operation of the API.
                orderTypeId:
                  type: integer
                  description: >-
                    Defines the type of Order. All available Order Types can be
                    retrieved using the `GET settings/get` operation of the Api.
                pickUpPointId:
                  type: string
                  description: >-
                    Pickup spot Service point (f.e. PostNL-Pakje Gemak, DHL -
                    Service point, BPost afhaalpunt, UPS access point)
                    **Important to note is the following:** The following fields
                    need to be filled appropriately if you want the pickup point
                    shipments to be processed properly! Please ensure that the
                    pickup point address is valid and complete!
                pickUpPointName:
                  type: string
                  description: Pickup spot name (usually printed on label)
                pickUpPointStreet:
                  type: string
                  description: 'Pickup spot street name '
                pickUpPointHouseNumber:
                  type: integer
                  description: The house number of the pickup spot
                pickUpPointHouseNumberAddition:
                  type: string
                  description: The house number extension of the pickup spot
                pickUpPointPostalCode:
                  type: string
                  description: The Zip code of the pickup spot
                pickUpPointCityName:
                  type: string
                  description: City name of the Pickup spot
                pickUpPointCountryIso:
                  type: string
                  description: >-
                    The ISO 2 character country code (ISO 3166) of the pickup
                    spot address. All available countries and country codes can
                    be found with the `GET settings/get` operation of the API.
                pickUpPointRegion:
                  type: string
                  description: >-
                    The region this billing address is in. Preferably ISO 2
                    character code. (ISO 3166-2)
                pickUpPointExtraAddress:
                  type: string
                  description: Used to store extra information for the pickup spot address.
                warehouseId:
                  type: integer
                  description: >-
                    WarehouseId of the warehouse of the order. If a value is
                    given and not known within Maya, the order will fail.
                orderItems:
                  type: array
                  items:
                    type: object
                    required:
                      - sku
                      - quantity
                      - price
                    properties:
                      sku:
                        type: string
                        description: The product SKU for this order item.
                      quantity:
                        type: integer
                        description: Total number of products in this order item.
                      name:
                        type: string
                        description: Name of the product.
                      price:
                        type: number
                        description: Price per product.
                      vat:
                        type: number
                        description: VAT Percentage.
                      extra6:
                        type: string
                        description: Can be used to store extra information.
                      extra7:
                        type: string
                        description: Can be used to store extra information.
                      warehouseId:
                        type: integer
                        description: >-
                          WarehouseId of the warehouse of the orderitem. If a
                          value is given and not known within Maya, the order
                          will fail
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response-structure-OK'
              example:
                messageCode: OK
                message: Order has been successfully added.
                result: 470345326
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response-structure-NOK'
              example:
                messageCode: NOK
                message: >-
                  We were unable to parse your request, resulting in an empty
                  value. Please check your input.
  /v2/order/search:
    get:
      summary: v2/order/search/:ext
      operationId: get-v2-order-search
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/orders
      description: >-
        # GET v2/order/search

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/common/operation/get-status-get"><code>GET
        v3/orders?filter[externalOrderNumber][in]=<i>{externalOrderNumber}</i></code></a>
        end-point instead.

        </div>

        This operation will search for orders having the provided external order
        number and return the order if found.
      parameters:
        - name: externalOrderNumber
          in: query
          required: true
          schema:
            type: string
            example: GB-42145-222
          description: External order number to search for.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - orderNumber
                  - externalOrderNumber
                properties:
                  orderNumber:
                    type: integer
                  externalOrderNumber:
                    type: string
                  extra1:
                    type: string
                  extra2:
                    type: string
                  extra3:
                    type: string
                  extra4:
                    type: string
                  extra5:
                    type: string
              example:
                messageCode: OK
                message: Order found.
                result: &ref_0
                  orderNumber: 6298945
                  externalOrderNumber: '5432102'
                  extra1: null
                  extra2: null
                  extra3: null
                  extra4: null
                  extra5: null
  /order/search:
    post:
      summary: order/search
      operationId: post-order-search
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/orders
      description: >-
        # POST order/search

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/common/operation/get-status-get"><code>GET
        v3/orders?filter[externalOrderNumber][in]=<i>{externalOrderNumber}</i></code></a>
        end-point instead.

        </div>

        This operation will search for orders having the provided external order
        number and return the order if found.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - externalOrderNumber
              properties:
                externalOrderNumber:
                  type: string
                  example: GB-42145-222
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - orderNumber
                  - externalOrderNumber
                properties:
                  orderNumber:
                    type: integer
                  externalOrderNumber:
                    type: string
                  extra1:
                    type: string
                  extra2:
                    type: string
                  extra3:
                    type: string
                  extra4:
                    type: string
                  extra5:
                    type: string
              example:
                messageCode: OK
                message: Order found.
                result: *ref_0
  /v2/shipment/tracktracestatus:
    get:
      summary: v2/shipment/tracktracestatus
      operationId: get-v2-shipment-tracktracestatus
      x-json-api: false
      x-internal: false
      deprecated: false
      tags:
        - v2/shipments
      description: >
        # GET v2/shipment/tracktracestatus


        Returns current tracking data of shipments that are in trackable
        delivery. Trackable delivery means the shipment is tracked by a carrier
        from which we receive tracking information and hasn’t been delivered*
        yet. (*Delivered is meant in the broad sense of the word: arrived at a
        pick-up point, returned to sender, delivered at addressee.)


        **PLEASE NOTE : We rely on external companies for this data (like the
        carriers). This endpoint is only to be used as extra additional
        information about the shipments, we cannot guarantee each and every
        shipment will have (correct) tracking data! Also not all carriers have
        tracking available**


        **This endpoint should be consumed sparingly. It’s strongly advised to
        limit the use to once per hour. If violated we cannot guarantee
        responsiveness of our services.**


        ### CurrentTrackTraceStatus codes:

        * 1 - Labeled

        * 2 - Accepted by carrier

        * 3 - Sorted

        * 4 - In delivery

        * 5 - At pickup point

        * 7 - Delivered

        * 8 - Delivery started

        * 10 - Delivery started (1st attempt) 

        * 18 - Tracked Externally

        * 19 - Returned (at warehouse)

        * 20 - At customs (only for shipments that have to go through customs)

        * 21 - In transit (only for shipments that have to go through customs) 


        ### CurrentTrackTraceExceptionLevel Codes:

        * 1 - ok

        * 2 - warning

        * 3 - error 
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        shipmentId:
                          type: integer
                          description: Id of the Shipment
                        externalOrderNumber:
                          type: string
                          description: The external Order number this shipment belongs to
                        packageNumber:
                          type: string
                          description: Parcelnumber with the carrier
                        shipmentMethod:
                          type: string
                          description: Name of the shipping method
                        currentTrackTraceStatus:
                          type: integer
                          description: >-
                            Available tracking status at time of shipment search
                            request as described
                        currentTrackTraceStatusDateTime:
                          type: string
                          format: date-time
                          description: >-
                            Time of occurrence of the tracking status. Nullable
                            in case of old entries.
                        currentTrackTraceExceptionLevel:
                          type: integer
                          description: >-
                            Available exception status if available as
                            described.
              example:
                messageCode: OK
                message: Found track trace status data
                result:
                  - shipmentId: 29245399
                    externalOrderNumber: '70025063'
                    packageNumber: '323200935959943587046030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 19
                    currentTrackTraceStatusDateTime: null
                    currentTrackTraceExceptionLevel: 2
                  - shipmentId: 29285502
                    externalOrderNumber: '70025107'
                    packageNumber: '323200935959942062567030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 7
                    currentTrackTraceStatusDateTime: '2024-01-26T08:53:47'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 29285809
                    externalOrderNumber: '70025109'
                    packageNumber: '323200935959942066725030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 7
                    currentTrackTraceStatusDateTime: '2024-01-26T09:19:02'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 29286537
                    externalOrderNumber: '70025111'
                    packageNumber: '323200935959942080373030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 7
                    currentTrackTraceStatusDateTime: '2024-01-26T12:30:02'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 29288437
                    externalOrderNumber: '70025114'
                    packageNumber: '323200935959942085265030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 7
                    currentTrackTraceStatusDateTime: '2024-01-26T09:38:21'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 29288728
                    externalOrderNumber: '70025115'
                    packageNumber: '323200935959942085411030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 7
                    currentTrackTraceStatusDateTime: '2024-01-26T09:05:08'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30336791
                    externalOrderNumber: '70026066'
                    packageNumber: '323200935959945283210030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 3
                    currentTrackTraceStatusDateTime: '2024-03-13T22:26:00'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30337233
                    externalOrderNumber: '70026067'
                    packageNumber: '323200935959945284587030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 4
                    currentTrackTraceStatusDateTime: '2024-03-14T08:02:31'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30337562
                    externalOrderNumber: '70026068'
                    packageNumber: '323200935959945286269030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 3
                    currentTrackTraceStatusDateTime: '2024-03-13T22:25:30'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30339983
                    externalOrderNumber: '70026069'
                    packageNumber: '323200935959945292040030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 7
                    currentTrackTraceStatusDateTime: '2024-03-14T10:59:04'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30342714
                    externalOrderNumber: '70026070'
                    packageNumber: '323200935959945299917030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 4
                    currentTrackTraceStatusDateTime: '2024-03-14T06:59:40'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30332456
                    externalOrderNumber: '70026059'
                    packageNumber: '323200935959945266238030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 3
                    currentTrackTraceStatusDateTime: '2024-03-13T22:26:03'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30333414
                    externalOrderNumber: '70026060'
                    packageNumber: '323200935959945269692030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 4
                    currentTrackTraceStatusDateTime: '2024-03-14T07:45:18'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30333672
                    externalOrderNumber: '70026061'
                    packageNumber: '323200935959945270757030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 4
                    currentTrackTraceStatusDateTime: '2024-03-14T09:02:44'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30334167
                    externalOrderNumber: '70026062'
                    packageNumber: '323200935959945273651030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 4
                    currentTrackTraceStatusDateTime: '2024-03-14T08:04:42'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30334888
                    externalOrderNumber: '70026063'
                    packageNumber: '323200935959945276497030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 3
                    currentTrackTraceStatusDateTime: '2024-03-13T22:25:06'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30335356
                    externalOrderNumber: '70026064'
                    packageNumber: '323200935959945277939030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 4
                    currentTrackTraceStatusDateTime: '2024-03-14T07:44:03'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30328423
                    externalOrderNumber: '70026052'
                    packageNumber: '323200935959945255310030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 4
                    currentTrackTraceStatusDateTime: '2024-03-14T07:49:50'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30329114
                    externalOrderNumber: '70026054'
                    packageNumber: '323200935959945257337030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 4
                    currentTrackTraceStatusDateTime: '2024-03-14T07:37:55'
                    currentTrackTraceExceptionLevel: 1
                  - shipmentId: 30331058
                    externalOrderNumber: '70026055'
                    packageNumber: '323200935959945262112030'
                    shipmentMethod: BELGIUM BPOST
                    currentTrackTraceStatus: 3
                    currentTrackTraceStatusDateTime: '2024-03-13T22:35:26'
                    currentTrackTraceExceptionLevel: 1
  /v2/shipment/get:
    get:
      summary: v2/shipment/get
      operationId: get-v2-shipment-get
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/shipments
      description: >-
        # GET v2/shipment/get

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3shipments/operation/get-v3-shipments"><code>GET
        v3/shipments</code></a> end-point instead.

        </div>

        Only the shipments that are marked as 'needs to be synced' will be
        processed. Per request a max. of 100 shipments are returned. When
        processed the shipments is finished they should be marked as 'synced'
        with the UpdateSyncedShipments operation.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                    const: OK
                  message:
                    type: string
                    examples:
                      - Found 100 shipments that match your criteria.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Id of the shipment
                          example: 42434542
                        orderNumber:
                          type: integer
                          description: Id of the order this shipment belongs to
                          example: 42375131
                        orderType:
                          type: integer
                          description: Id of the order type this shipment belongs to
                          example: 1372
                        externalOrderNumber:
                          type: string
                          description: The external order number this shipment belongs to
                          example: 3000231343
                        shippingDate:
                          type: string
                          description: >-
                            The date this shipment is going to be/has been sent
                            off on
                        numberOfColli:
                          type: integer
                          description: Number of packages for this shipment
                        totalNumberOfProducts:
                          type: integer
                          description: >-
                            Total amount of products being shipped in this
                            shipment
                        shippingMethodId:
                          type: integer
                          description: Id of the shipping method
                        returnPackageNumber:
                          type: string
                          nullable: true
                          description: The number of the return label
                        shippedColli:
                          type: array
                          items:
                            type: object
                            properties:
                              colloNr:
                                type: string
                                description: Number of the collo
                              packageNumber:
                                type: string
                                description: Parcelnumber with the carrier
                              trackTraceUrl:
                                type: string
                                description: Track & trace url
                        shippedProducts:
                          type: array
                          items:
                            type: object
                            properties:
                              sku:
                                type: string
                                description: The product SKU
                              quantity:
                                type: integer
                                description: Quantity shipped of this product
                              serialNrs:
                                type: array
                                description: >-
                                  A list of serial numbers, if this is relevant
                                  for this product
                                items:
                                  type: string
                              weight:
                                type: number
                                description: Product Weight, 0 if unknown
                              tht:
                                type: string
                                nullable: true
                                format: date-time
                                description: Best Before Date, if product has one
                              extra6:
                                type: string
                                nullable: true
                              extra7:
                                type: string
                                nullable: true
                              lotNumber:
                                type: string
                                nullable: true
                              parts:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    sku:
                                      type: string
                                      description: The product SKU
                                    quantity:
                                      type: integer
                                      description: Quantity shipped of this product
                                    serialNrs:
                                      type: array
                                      description: >-
                                        A list of serial numbers, if this is
                                        relevant for this product
                                      items:
                                        type: string
                                    weight:
                                      type: number
                                      description: Product Weight, 0 if unknown
                                    tht:
                                      type: string
                                      format: date-time
                                      description: Best Before Date, if product has one
                                    extra6:
                                      type: string
                                    extra7:
                                      type: string
                                    lotNumber:
                                      type: string
                        basketPicURL:
                          type: string
                          description: Contains an URL pointing to the basketpic.
                        extra1:
                          type: string
                          nullable: true
                        extra2:
                          type: string
                          nullable: true
                        extra3:
                          type: string
                          nullable: true
                        extra4:
                          type: string
                          nullable: true
                        extra5:
                          type: string
                          nullable: true
                        currentTrackTraceStatus:
                          type: string
                          description: >-
                            Available trackingstatus at time of shipment search
                            request
                        currentTrackTraceExceptionLevel:
                          type: string
                          nullable: true
                          description: Available exception status if available
                        warehouseAbbrevation:
                          type: string
                          description: Showed Warehouse Abbreviation
                        mainShippingMethodId:
                          type: integer
                          description: >-
                            Showed MainShipingMethodId from core shipping
                            methods
              example:
                messageCode: OK
                message: Found 100 shipments that match your criteria.
                result:
                  - id: 42434542
                    orderNumber: 42375131
                    orderType: 1372
                    externalOrderNumber: '3000231343'
                    shippingDate: '2025-07-11T14:57:24.54'
                    numberOfColli: 1
                    totalNumberOfProducts: 1
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421665852
                    shippedProducts:
                      - sku: '51002325'
                        quantity: 1
                        serialNrs: []
                        weight: 0.295
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: delivered
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
                  - id: 42438078
                    orderNumber: 42380239
                    orderType: 1372
                    externalOrderNumber: '3000231358'
                    shippingDate: '2025-07-14T14:47:14.163'
                    numberOfColli: 1
                    totalNumberOfProducts: 5
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421613297
                    shippedProducts:
                      - sku: '324383'
                        quantity: 1
                        serialNrs: []
                        weight: 0.133
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51035044'
                        quantity: 1
                        serialNrs: []
                        weight: 0.916
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51011023'
                        quantity: 2
                        serialNrs: []
                        weight: 0.047
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '324386'
                        quantity: 1
                        serialNrs: []
                        weight: 0.133
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: labelled
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
                  - id: 42477756
                    orderNumber: 42416899
                    orderType: 1102
                    externalOrderNumber: '2000193651'
                    shippingDate: '2025-07-14T22:43:47.15'
                    numberOfColli: 1
                    totalNumberOfProducts: 20
                    shippingMethodId: 308059
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: https://some.track-and-trace.url/...
                    shippedProducts:
                      - sku: '51001497'
                        quantity: 20
                        serialNrs: []
                        weight: 0.374
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: New
                    currentTrackTraceExceptionLevel: null
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 966
                  - id: 42488956
                    orderNumber: 42427865
                    orderType: 1372
                    externalOrderNumber: '3000231529'
                    shippingDate: '2025-07-11T14:57:24.54'
                    numberOfColli: 1
                    totalNumberOfProducts: 3
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421651855
                    shippedProducts:
                      - sku: '51002032'
                        quantity: 1
                        serialNrs: []
                        weight: 0.2
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51002034'
                        quantity: 1
                        serialNrs: []
                        weight: 0.185
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51002317'
                        quantity: 1
                        serialNrs: []
                        weight: 0.192
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: delivered
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
                  - id: 42500878
                    orderNumber: 42440901
                    orderType: 1372
                    externalOrderNumber: '3000231566'
                    shippingDate: '2025-07-11T14:57:24.54'
                    numberOfColli: 1
                    totalNumberOfProducts: 2
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421662677
                    shippedProducts:
                      - sku: '51504578'
                        quantity: 1
                        serialNrs: []
                        weight: 0.366
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51504620'
                        quantity: 1
                        serialNrs: []
                        weight: 0.425
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: delivered
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
  /v2/shipment/byordertype:
    post:
      summary: v2/shipment/byordertype
      operationId: post-v2-shipment-byordertype
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/shipments
      description: >-
        # POST v2/shipment/byordertype

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3shipments/operation/get-v3-shipments"><code>GET
        v3/shipments?filter[orderType][in]=5,6,7</code></a> end-point instead.

        </div>

        Only the shipments that are marked as 'needs to be synced' will be
        processed. Per request a max. of 100 shipments are returned. When
        processed the shipments is finished they should be marked as 'synced'
        with the UpdateSyncedShipments operation.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                orderTypes:
                  type: array
                  description: >-
                    Used to indicate a subset of shipments to sync by order
                    type. This allows you to only retrieve & sync shipments for
                    specific order types.
                  items:
                    type: integer
            example:
              orderTypes:
                - 5
                - 6
                - 7
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                    const: OK
                  message:
                    type: string
                    examples:
                      - Found 100 shipments that match your criteria.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Id of the shipment
                          example: 42434542
                        orderNumber:
                          type: integer
                          description: Id of the order this shipment belongs to
                          example: 42375131
                        orderType:
                          type: integer
                          description: Id of the order type this shipment belongs to
                          example: 1372
                        externalOrderNumber:
                          type: string
                          description: The external order number this shipment belongs to
                          example: 3000231343
                        shippingDate:
                          type: string
                          description: >-
                            The date this shipment is going to be/has been sent
                            off on
                        numberOfColli:
                          type: integer
                          description: Number of packages for this shipment
                        totalNumberOfProducts:
                          type: integer
                          description: >-
                            Total amount of products being shipped in this
                            shipment
                        shippingMethodId:
                          type: integer
                          description: Id of the shipping method
                        returnPackageNumber:
                          type: string
                          nullable: true
                          description: The number of the return label
                        shippedColli:
                          type: array
                          items:
                            type: object
                            properties:
                              colloNr:
                                type: string
                                description: Number of the collo
                              packageNumber:
                                type: string
                                description: Parcelnumber with the carrier
                              trackTraceUrl:
                                type: string
                                description: Track & trace url
                        shippedProducts:
                          type: array
                          items:
                            type: object
                            properties:
                              sku:
                                type: string
                                description: The product SKU
                              quantity:
                                type: integer
                                description: Quantity shipped of this product
                              serialNrs:
                                type: array
                                description: >-
                                  A list of serial numbers, if this is relevant
                                  for this product
                                items:
                                  type: string
                              weight:
                                type: number
                                description: Product Weight, 0 if unknown
                              tht:
                                type: string
                                nullable: true
                                format: date-time
                                description: Best Before Date, if product has one
                              extra6:
                                type: string
                                nullable: true
                              extra7:
                                type: string
                                nullable: true
                              lotNumber:
                                type: string
                                nullable: true
                              parts:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    sku:
                                      type: string
                                      description: The product SKU
                                    quantity:
                                      type: integer
                                      description: Quantity shipped of this product
                                    serialNrs:
                                      type: array
                                      description: >-
                                        A list of serial numbers, if this is
                                        relevant for this product
                                      items:
                                        type: string
                                    weight:
                                      type: number
                                      description: Product Weight, 0 if unknown
                                    tht:
                                      type: string
                                      format: date-time
                                      description: Best Before Date, if product has one
                                    extra6:
                                      type: string
                                      nullable: true
                                    extra7:
                                      type: string
                                      nullable: true
                                    lotNumber:
                                      type: string
                                      nullable: true
                        basketPicURL:
                          type: string
                          description: Contains an URL pointing to the basketpic.
                        extra1:
                          type: string
                          nullable: true
                        extra2:
                          type: string
                          nullable: true
                        extra3:
                          type: string
                          nullable: true
                        extra4:
                          type: string
                          nullable: true
                        extra5:
                          type: string
                          nullable: true
                        currentTrackTraceStatus:
                          type: string
                          description: >-
                            Available trackingstatus at time of shipment search
                            request
                        currentTrackTraceExceptionLevel:
                          type: string
                          nullable: true
                          description: Available exception status if available
                        warehouseAbbrevation:
                          type: string
                          description: Showed Warehouse Abbreviation
                        mainShippingMethodId:
                          type: integer
                          description: >-
                            Showed MainShipingMethodId from core shipping
                            methods
              example:
                messageCode: OK
                message: Found 100 shipments that match your criteria.
                result:
                  - id: 42434542
                    orderNumber: 42375131
                    orderType: 1372
                    externalOrderNumber: '3000231343'
                    shippingDate: '2025-07-11T14:57:24.54'
                    numberOfColli: 1
                    totalNumberOfProducts: 1
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421665852
                    shippedProducts:
                      - sku: '51002325'
                        quantity: 1
                        serialNrs: []
                        weight: 0.295
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: delivered
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
                  - id: 42438078
                    orderNumber: 42380239
                    orderType: 1372
                    externalOrderNumber: '3000231358'
                    shippingDate: '2025-07-14T14:47:14.163'
                    numberOfColli: 1
                    totalNumberOfProducts: 5
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421613297
                    shippedProducts:
                      - sku: '324383'
                        quantity: 1
                        serialNrs: []
                        weight: 0.133
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51035044'
                        quantity: 1
                        serialNrs: []
                        weight: 0.916
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51011023'
                        quantity: 2
                        serialNrs: []
                        weight: 0.047
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '324386'
                        quantity: 1
                        serialNrs: []
                        weight: 0.133
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: labelled
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
                  - id: 42477756
                    orderNumber: 42416899
                    orderType: 1102
                    externalOrderNumber: '2000193651'
                    shippingDate: '2025-07-14T22:43:47.15'
                    numberOfColli: 1
                    totalNumberOfProducts: 20
                    shippingMethodId: 308059
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: https://some.track-and-trace.url/...
                    shippedProducts:
                      - sku: '51001497'
                        quantity: 20
                        serialNrs: []
                        weight: 0.374
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: New
                    currentTrackTraceExceptionLevel: null
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 966
                  - id: 42488956
                    orderNumber: 42427865
                    orderType: 1372
                    externalOrderNumber: '3000231529'
                    shippingDate: '2025-07-11T14:57:24.54'
                    numberOfColli: 1
                    totalNumberOfProducts: 3
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421651855
                    shippedProducts:
                      - sku: '51002032'
                        quantity: 1
                        serialNrs: []
                        weight: 0.2
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51002034'
                        quantity: 1
                        serialNrs: []
                        weight: 0.185
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51002317'
                        quantity: 1
                        serialNrs: []
                        weight: 0.192
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: delivered
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
                  - id: 42500878
                    orderNumber: 42440901
                    orderType: 1372
                    externalOrderNumber: '3000231566'
                    shippingDate: '2025-07-11T14:57:24.54'
                    numberOfColli: 1
                    totalNumberOfProducts: 2
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421662677
                    shippedProducts:
                      - sku: '51504578'
                        quantity: 1
                        serialNrs: []
                        weight: 0.366
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51504620'
                        quantity: 1
                        serialNrs: []
                        weight: 0.425
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: delivered
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
  /v2/shipment/byordertype/labeled:
    post:
      summary: v2/shipment/byordertype/labeled
      operationId: post-v2-shipment-byordertype-labeled
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/shipments
      description: >-
        # POST v2/shipment/byordertype/labeled

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3shipments/operation/get-v3-shipments"><code>GET
        v3/shipments?filter[orderType][in]=5,6,7&filter[status][in]=<i>SOME_STATUS</i></code></a>
        end-point instead.

        </div>

        Only the shipments that are marked as 'needs to be synced' will be
        processed. Per request a max. of 100 shipments are returned. When
        processed the shipments is finished they should be marked as 'synced'
        with the UpdateSyncedShipments operation.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                orderTypes:
                  type: array
                  description: >-
                    Used to indicate a subset of shipments to sync by order
                    type. This allows you to only retrieve & sync shipments for
                    specific order types.
                  items:
                    type: integer
            example:
              orderTypes:
                - 5
                - 6
                - 7
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                    const: OK
                  message:
                    type: string
                    examples:
                      - Found 100 shipments that match your criteria.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Id of the shipment
                          example: 42434542
                        orderNumber:
                          type: integer
                          description: Id of the order this shipment belongs to
                          example: 42375131
                        orderType:
                          type: integer
                          description: Id of the order type this shipment belongs to
                          example: 1372
                        externalOrderNumber:
                          type: string
                          description: The external order number this shipment belongs to
                          example: 3000231343
                        shippingDate:
                          type: string
                          description: >-
                            The date this shipment is going to be/has been sent
                            off on
                        numberOfColli:
                          type: integer
                          description: Number of packages for this shipment
                        totalNumberOfProducts:
                          type: integer
                          description: >-
                            Total amount of products being shipped in this
                            shipment
                        shippingMethodId:
                          type: integer
                          description: Id of the shipping method
                        returnPackageNumber:
                          type: string
                          nullable: true
                          description: The number of the return label
                        shippedColli:
                          type: array
                          items:
                            type: object
                            properties:
                              colloNr:
                                type: string
                                description: Number of the collo
                              packageNumber:
                                type: string
                                description: Parcelnumber with the carrier
                              trackTraceUrl:
                                type: string
                                description: Track & trace url
                        shippedProducts:
                          type: array
                          items:
                            type: object
                            properties:
                              sku:
                                type: string
                                description: The product SKU
                              quantity:
                                type: integer
                                description: Quantity shipped of this product
                              serialNrs:
                                type: array
                                description: >-
                                  A list of serial numbers, if this is relevant
                                  for this product
                                items:
                                  type: string
                              weight:
                                type: number
                                description: Product Weight, 0 if unknown
                              tht:
                                type: string
                                nullable: true
                                format: date-time
                                description: Best Before Date, if product has one
                              extra6:
                                type: string
                                nullable: true
                              extra7:
                                type: string
                                nullable: true
                              lotNumber:
                                type: string
                                nullable: true
                              parts:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    sku:
                                      type: string
                                      description: The product SKU
                                    quantity:
                                      type: integer
                                      description: Quantity shipped of this product
                                    serialNrs:
                                      type: array
                                      description: >-
                                        A list of serial numbers, if this is
                                        relevant for this product
                                      items:
                                        type: string
                                    weight:
                                      type: number
                                      description: Product Weight, 0 if unknown
                                    tht:
                                      type: string
                                      format: date-time
                                      description: Best Before Date, if product has one
                                    extra6:
                                      type: string
                                    extra7:
                                      type: string
                                    lotNumber:
                                      type: string
                        basketPicURL:
                          type: string
                          description: Contains an URL pointing to the basketpic.
                        extra1:
                          type: string
                        extra2:
                          type: string
                        extra3:
                          type: string
                        extra4:
                          type: string
                        extra5:
                          type: string
                        currentTrackTraceStatus:
                          type: string
                          description: >-
                            Available trackingstatus at time of shipment search
                            request
                        currentTrackTraceExceptionLevel:
                          type: string
                          description: Available exception status if available
                        warehouseAbbrevation:
                          type: string
                          description: Showed Warehouse Abbreviation
                        mainShippingMethodId:
                          type: integer
                          description: >-
                            Showed MainShipingMethodId from core shipping
                            methods
              example:
                messageCode: OK
                message: Found 100 shipments that match your criteria.
                result:
                  - id: 42434542
                    orderNumber: 42375131
                    orderType: 1372
                    externalOrderNumber: '3000231343'
                    shippingDate: '2025-07-11T14:57:24.54'
                    numberOfColli: 1
                    totalNumberOfProducts: 1
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421665852
                    shippedProducts:
                      - sku: '51002325'
                        quantity: 1
                        serialNrs: []
                        weight: 0.295
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: delivered
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
                  - id: 42438078
                    orderNumber: 42380239
                    orderType: 1372
                    externalOrderNumber: '3000231358'
                    shippingDate: '2025-07-14T14:47:14.163'
                    numberOfColli: 1
                    totalNumberOfProducts: 5
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421613297
                    shippedProducts:
                      - sku: '324383'
                        quantity: 1
                        serialNrs: []
                        weight: 0.133
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51035044'
                        quantity: 1
                        serialNrs: []
                        weight: 0.916
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51011023'
                        quantity: 2
                        serialNrs: []
                        weight: 0.047
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '324386'
                        quantity: 1
                        serialNrs: []
                        weight: 0.133
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: labelled
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
                  - id: 42477756
                    orderNumber: 42416899
                    orderType: 1102
                    externalOrderNumber: '2000193651'
                    shippingDate: '2025-07-14T22:43:47.15'
                    numberOfColli: 1
                    totalNumberOfProducts: 20
                    shippingMethodId: 308059
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: https://some.track-and-trace.url/...
                    shippedProducts:
                      - sku: '51001497'
                        quantity: 20
                        serialNrs: []
                        weight: 0.374
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: New
                    currentTrackTraceExceptionLevel: null
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 966
                  - id: 42488956
                    orderNumber: 42427865
                    orderType: 1372
                    externalOrderNumber: '3000231529'
                    shippingDate: '2025-07-11T14:57:24.54'
                    numberOfColli: 1
                    totalNumberOfProducts: 3
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421651855
                    shippedProducts:
                      - sku: '51002032'
                        quantity: 1
                        serialNrs: []
                        weight: 0.2
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51002034'
                        quantity: 1
                        serialNrs: []
                        weight: 0.185
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51002317'
                        quantity: 1
                        serialNrs: []
                        weight: 0.192
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: delivered
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
                  - id: 42500878
                    orderNumber: 42440901
                    orderType: 1372
                    externalOrderNumber: '3000231566'
                    shippingDate: '2025-07-11T14:57:24.54'
                    numberOfColli: 1
                    totalNumberOfProducts: 2
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421662677
                    shippedProducts:
                      - sku: '51504578'
                        quantity: 1
                        serialNrs: []
                        weight: 0.366
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51504620'
                        quantity: 1
                        serialNrs: []
                        weight: 0.425
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: delivered
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
  /v2/shipment/get/labeled:
    get:
      summary: v2/shipment/get/labeled
      operationId: get-v2-shipment-get-labeled
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/shipments
      description: >-
        # GET v2/shipment/get/labeled

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3shipments/operation/get-v3-shipments"><code>GET
        v3/shipments?filter[status][in]=<i>SOME_STATUS</i></code></a> end-point
        instead.

        </div>

        Only the shipments that are marked as ‘have labeled state’ will be
        processed. When processed the shipments can be marked 'synced' with the
        UpdateLabeledSyncedShipments operation. 
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                    const: OK
                  message:
                    type: string
                    examples:
                      - Found 100 shipments that match your criteria.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Id of the shipment
                          example: 42434542
                        orderNumber:
                          type: integer
                          description: Id of the order this shipment belongs to
                          example: 42375131
                        orderType:
                          type: integer
                          description: Id of the order type this shipment belongs to
                          example: 1372
                        externalOrderNumber:
                          type: string
                          description: The external order number this shipment belongs to
                          example: 3000231343
                        shippingDate:
                          type: string
                          description: >-
                            The date this shipment is going to be/has been sent
                            off on
                        numberOfColli:
                          type: integer
                          description: Number of packages for this shipment
                        totalNumberOfProducts:
                          type: integer
                          description: >-
                            Total amount of products being shipped in this
                            shipment
                        shippingMethodId:
                          type: integer
                          description: Id of the shipping method
                        returnPackageNumber:
                          type: string
                          description: The number of the return label
                        shippedColli:
                          type: array
                          items:
                            type: object
                            properties:
                              colloNr:
                                type: string
                                description: Number of the collo
                              packageNumber:
                                type: string
                                description: Parcelnumber with the carrier
                              trackTraceUrl:
                                type: string
                                description: Track & trace url
                        shippedProducts:
                          type: array
                          items:
                            type: object
                            properties:
                              sku:
                                type: string
                                description: The product SKU
                              quantity:
                                type: integer
                                description: Quantity shipped of this product
                              serialNrs:
                                type: array
                                description: >-
                                  A list of serial numbers, if this is relevant
                                  for this product
                                items:
                                  type: string
                              weight:
                                type: number
                                description: Product Weight, 0 if unknown
                              tht:
                                type: string
                                format: date-time
                                description: Best Before Date, if product has one
                              extra6:
                                type: string
                              extra7:
                                type: string
                              lotNumber:
                                type: string
                              parts:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    sku:
                                      type: string
                                      description: The product SKU
                                    quantity:
                                      type: integer
                                      description: Quantity shipped of this product
                                    serialNrs:
                                      type: array
                                      description: >-
                                        A list of serial numbers, if this is
                                        relevant for this product
                                      items:
                                        type: string
                                    weight:
                                      type: number
                                      description: Product Weight, 0 if unknown
                                    tht:
                                      type: string
                                      format: date-time
                                      description: Best Before Date, if product has one
                                    extra6:
                                      type: string
                                    extra7:
                                      type: string
                                    lotNumber:
                                      type: string
                        basketPicURL:
                          type: string
                          description: Contains an URL pointing to the basketpic.
                        extra1:
                          type: string
                        extra2:
                          type: string
                        extra3:
                          type: string
                        extra4:
                          type: string
                        extra5:
                          type: string
                        currentTrackTraceStatus:
                          type: string
                          description: >-
                            Available trackingstatus at time of shipment search
                            request
                        currentTrackTraceExceptionLevel:
                          type: string
                          description: Available exception status if available
                        warehouseAbbrevation:
                          type: string
                          description: Showed Warehouse Abbreviation
                        mainShippingMethodId:
                          type: integer
                          description: >-
                            Showed MainShipingMethodId from core shipping
                            methods
              example:
                messageCode: OK
                message: Found 100 shipments that match your criteria.
                result:
                  - id: 42434542
                    orderNumber: 42375131
                    orderType: 1372
                    externalOrderNumber: '3000231343'
                    shippingDate: '2025-07-11T14:57:24.54'
                    numberOfColli: 1
                    totalNumberOfProducts: 1
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421665852
                    shippedProducts:
                      - sku: '51002325'
                        quantity: 1
                        serialNrs: []
                        weight: 0.295
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: delivered
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
                  - id: 42438078
                    orderNumber: 42380239
                    orderType: 1372
                    externalOrderNumber: '3000231358'
                    shippingDate: '2025-07-14T14:47:14.163'
                    numberOfColli: 1
                    totalNumberOfProducts: 5
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421613297
                    shippedProducts:
                      - sku: '324383'
                        quantity: 1
                        serialNrs: []
                        weight: 0.133
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51035044'
                        quantity: 1
                        serialNrs: []
                        weight: 0.916
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51011023'
                        quantity: 2
                        serialNrs: []
                        weight: 0.047
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '324386'
                        quantity: 1
                        serialNrs: []
                        weight: 0.133
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: labelled
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
                  - id: 42477756
                    orderNumber: 42416899
                    orderType: 1102
                    externalOrderNumber: '2000193651'
                    shippingDate: '2025-07-14T22:43:47.15'
                    numberOfColli: 1
                    totalNumberOfProducts: 20
                    shippingMethodId: 308059
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: https://some.track-and-trace.url/...
                    shippedProducts:
                      - sku: '51001497'
                        quantity: 20
                        serialNrs: []
                        weight: 0.374
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: New
                    currentTrackTraceExceptionLevel: null
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 966
                  - id: 42488956
                    orderNumber: 42427865
                    orderType: 1372
                    externalOrderNumber: '3000231529'
                    shippingDate: '2025-07-11T14:57:24.54'
                    numberOfColli: 1
                    totalNumberOfProducts: 3
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421651855
                    shippedProducts:
                      - sku: '51002032'
                        quantity: 1
                        serialNrs: []
                        weight: 0.2
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51002034'
                        quantity: 1
                        serialNrs: []
                        weight: 0.185
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51002317'
                        quantity: 1
                        serialNrs: []
                        weight: 0.192
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: delivered
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
                  - id: 42500878
                    orderNumber: 42440901
                    orderType: 1372
                    externalOrderNumber: '3000231566'
                    shippingDate: '2025-07-11T14:57:24.54'
                    numberOfColli: 1
                    totalNumberOfProducts: 2
                    shippingMethodId: 308002
                    returnPackageNumber: null
                    shippedColli:
                      - colloNr: '1'
                        packageNumber: packagenumber-12345
                        trackTraceUrl: >-
                          https://some.track-and-trace.url/...=00340434638421662677
                    shippedProducts:
                      - sku: '51504578'
                        quantity: 1
                        serialNrs: []
                        weight: 0.366
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                      - sku: '51504620'
                        quantity: 1
                        serialNrs: []
                        weight: 0.425
                        tht: null
                        extra6: null
                        extra7: null
                        lotNumber: null
                        parts: []
                    basketPicURL: http://basketpic.activeants.nl/images/....jpg
                    extra1: null
                    extra2: null
                    extra3: null
                    extra4: null
                    extra5: null
                    currentTrackTraceStatus: delivered
                    currentTrackTraceExceptionLevel: success
                    warehouseAbbrevation: NR
                    mainShippingMethodId: 70
  /v2/shipment/sync:
    post:
      summary: v2/shipment/sync
      operationId: post-v2-shipment-sync
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/shipments
      description: >-
        # POST v2/shipment/sync

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to make use of the v3
        end-points which do not require syncing.

        </div>

        If an invalid collection of Ids is provided, the return message will
        contain a list of Ids that were not found or do not belong to your
        company. Any Ids that were correct will NOT be processed.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: Array of shipment ids
                  items:
                    type: integer
            example:
              ids:
                - 42558645
                - 42558647
                - 42558729
                - 42558734
                - 42558823
                - 42558824
                - 42558825
                - 42559039
                - 42559041
                - 42559131
                - 42559133
                - 42559456
                - 42559493
                - 42560774
                - 42560779
                - 42560783
                - 42560786
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response-structure-OK'
              example:
                messageCode: OK
                message: Request processed successfully.
                result: null
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response-structure-OK'
              example:
                messageCode: NOK
                message: Some Ids were not found
                result:
                  - 567096
  /v2/shipment/sync/labeled:
    post:
      summary: v2/shipment/sync/labeled
      operationId: post-v2-shipment-sync-labeled
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/shipments
      description: >-
        # POST v2/shipment/sync/labeled

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to make use of the v3
        end-points which do not require syncing.

        </div>

        If an invalid collection of Ids is provided, the return message will
        contain a list of Ids that were not found or do not belong to your
        company. Any Ids that were correct will NOT be processed.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: Array of shipment ids
                  items:
                    type: integer
            example:
              ids:
                - 42558645
                - 42558647
                - 42558729
                - 42558734
                - 42558823
                - 42558824
                - 42558825
                - 42559039
                - 42559041
                - 42559131
                - 42559133
                - 42559456
                - 42559493
                - 42560774
                - 42560779
                - 42560783
                - 42560786
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response-structure-OK'
              example:
                messageCode: OK
                message: Request processed successfully.
                result: null
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response-structure-OK'
              example:
                messageCode: NOK
                message: Some Ids were not found
                result:
                  - 567096
  /shipment/search:
    post:
      summary: shipment/search
      operationId: post-shipment-search
      x-json-api: false
      x-internal: false
      deprecated: true
      description: >
        # POST shipment/search

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3shipments/operation/get-v3-shipments"><code>GET
        v3/shipments</code></a> or <a
        href="/specs/v3#tag/v3shipments/operation/get-v3-shipments-by-id"><code>GET
        v3/shipments/:id</code></a> or end-points instead.

        </div>

        Can return multiple shipments, depending on the criteria provided. When
        no fields are supplied, all shipments of the past 24 hours belonging to
        your company are returned.

        <b>Please minimize frequency of request.</b>
      tags:
        - v2/shipments
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: Id of the Shipment
                externalOrderNumber:
                  type: string
                  description: >-
                    You can use this field to filter shipments by External Order
                    Number.
                shippingDate:
                  type: string
                  format: date-time
                  description: The shipping date you want to filter on.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Id of the Shipment
                        externalOrderNumber:
                          type: string
                          description: The external Order number this shipment belongs to.
                        trackingNumber:
                          type: integer
                          description: The Tracking Number used for this shipment.
                        shippingDate:
                          type: string
                          format: date-time
                          description: >-
                            The date this shipment is going to be/has been sent
                            off on.
                        numberOfColli:
                          type: integer
                          description: Number of packages for this shipment.
                        totalNumberOfProducts:
                          type: integer
                          description: >-
                            Total amount of products being shipped in this
                            shipment
                        trackAndTraceCode:
                          type: string
                          description: The track and trace URL belonging to the shipment
                        trackAndTraceBarCode:
                          type: string
                          description: The track and trace URL belonging to the shipment
                        shippingMethodId:
                          type: integer
                          description: Id of the shippingmethod
                        returnPackageNumber:
                          type: string
                          description: The number of the return label.
                        packageNumber:
                          type: string
                          description: The number of the shippinglabel.
                        currentTrackTraceStatus:
                          type: string
                          description: >-
                            Available trackingstatus at time of shipment search
                            request.
                        currentTrackTraceExceptionLevel:
                          type: string
                          description: Available exception status if available.
                        warehouseAbbreviation:
                          type: string
                          description: Added warehouse abbreviation
                        mainShippingMethodId:
                          type: integer
                          description: Added mainShippingMethodId
                        shipmentItems:
                          type: array
                          items:
                            type: object
                            properties:
                              shipmentItemId:
                                type: integer
                                description: The ID of the shipmentitem
                              quantity:
                                type: integer
                                description: >-
                                  Total number of products in this purchase
                                  order item.
                              sku:
                                type: string
                                description: The product SKU for this shipment order item.
                              lotNumber:
                                type: string
              example:
                messageCode: OK
                message: Found 6 shipments that match your criteria.
                result:
                  - id: 5670497
                    externalOrderNumber: '#1020-TST-001'
                    trackingNumber: 1
                    shippingDate: '2023-03-24T12:52:39.6333333'
                    numberOfColli: 1
                    totalNumberOfProducts: 2
                    trackAndTraceCode: ''
                    trackAndTraceBarCode: 3S567049701
                    shippingMethodId: 97707
                    returnPackageNumber: null
                    packageNumber: null
                    currentTrackTraceStatus: New
                    currentTrackTraceExceptionLevel: null
                    shipmentItems:
                      - shipmentItemId: 12274542
                        quantity: 1
                        sku: T-002-M
                        lotNumber: null
                      - shipmentItemId: 12274543
                        quantity: 1
                        sku: T-002-L
                        lotNumber: null
                    warehouseAbbreviation: NN
                    mainShippingMethodId: 595
                  - id: 5670498
                    externalOrderNumber: '#1021-TST-001'
                    trackingNumber: 1
                    shippingDate: '2023-03-24T12:57:10.5266667'
                    numberOfColli: 1
                    totalNumberOfProducts: 4
                    trackAndTraceCode: ''
                    trackAndTraceBarCode: 3S567049801
                    shippingMethodId: 97707
                    returnPackageNumber: null
                    packageNumber: null
                    currentTrackTraceStatus: New
                    currentTrackTraceExceptionLevel: null
                    shipmentItems:
                      - shipmentItemId: 12274544
                        quantity: 1
                        sku: T-002-M
                        lotNumber: null
                      - shipmentItemId: 12274545
                        quantity: 1
                        sku: T-002-XL
                        lotNumber: null
                      - shipmentItemId: 12274546
                        quantity: 1
                        sku: T-002-L
                        lotNumber: null
                      - shipmentItemId: 12274547
                        quantity: 1
                        sku: T-001
                        lotNumber: null
                    warehouseAbbreviation: NN
                    mainShippingMethodId: 595
                  - id: 5670503
                    externalOrderNumber: '#1021-TST-001'
                    trackingNumber: 1
                    shippingDate: '2023-03-24T14:49:21.0166667'
                    numberOfColli: 1
                    totalNumberOfProducts: 1
                    trackAndTraceCode: ''
                    trackAndTraceBarCode: 3S567050301
                    shippingMethodId: 97707
                    returnPackageNumber: null
                    packageNumber: null
                    currentTrackTraceStatus: New
                    currentTrackTraceExceptionLevel: null
                    shipmentItems:
                      - shipmentItemId: 12274555
                        quantity: 1
                        sku: T-002-S
                        lotNumber: null
                    warehouseAbbreviation: NN
                    mainShippingMethodId: 595
                  - id: 5670501
                    externalOrderNumber: '#1022-TST-001'
                    trackingNumber: 1
                    shippingDate: '2023-03-24T14:44:23.0166667'
                    numberOfColli: 1
                    totalNumberOfProducts: 3
                    trackAndTraceCode: ''
                    trackAndTraceBarCode: 3S567050101
                    shippingMethodId: 97707
                    returnPackageNumber: null
                    packageNumber: null
                    currentTrackTraceStatus: New
                    currentTrackTraceExceptionLevel: null
                    shipmentItems:
                      - shipmentItemId: 12274550
                        quantity: 1
                        sku: T-002-M
                        lotNumber: null
                      - shipmentItemId: 12274551
                        quantity: 1
                        sku: T-002-L
                        lotNumber: null
                      - shipmentItemId: 12274552
                        quantity: 1
                        sku: T-001
                        lotNumber: null
                    warehouseAbbreviation: NN
                    mainShippingMethodId: 595
                  - id: 5670502
                    externalOrderNumber: '#1022-TST-001'
                    trackingNumber: 1
                    shippingDate: '2023-03-24T14:49:21.0166667'
                    numberOfColli: 1
                    totalNumberOfProducts: 1
                    trackAndTraceCode: ''
                    trackAndTraceBarCode: 3S567050201
                    shippingMethodId: 97707
                    returnPackageNumber: null
                    packageNumber: null
                    currentTrackTraceStatus: New
                    currentTrackTraceExceptionLevel: null
                    shipmentItems:
                      - shipmentItemId: 12274553
                        quantity: 1
                        sku: T-002-XL
                        lotNumber: null
                    warehouseAbbreviation: NN
                    mainShippingMethodId: 595
                  - id: 5670504
                    externalOrderNumber: '#1022-TST-001'
                    trackingNumber: 2
                    shippingDate: '2023-03-24T14:49:21.0166667'
                    numberOfColli: 1
                    totalNumberOfProducts: 1
                    trackAndTraceCode: ''
                    trackAndTraceBarCode: 3S567050401
                    shippingMethodId: 97707
                    returnPackageNumber: null
                    packageNumber: null
                    currentTrackTraceStatus: New
                    currentTrackTraceExceptionLevel: null
                    shipmentItems:
                      - shipmentItemId: 12274556
                        quantity: 1
                        sku: T-002-S
                        lotNumber: null
                    warehouseAbbreviation: NN
                    mainShippingMethodId: 595
  /v2/rma/add:
    post:
      summary: v2/rma/add
      operationId: post-v2-rma-add
      x-json-api: false
      x-internal: false
      deprecated: false
      description: |
        # POST v2/rma/add
      tags:
        - v2/rma
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                shipmentId:
                  type: integer
                  description: The ID of the Shipment
                remark:
                  type: string
                  description: Optional remark.
                externalReference:
                  type: string
                  description: >-
                    Optional: external reference that can be used freely by the
                    API user
                rmaItems:
                  type: object
                  properties:
                    shipmentItemId:
                      type: integer
                      description: The id of the shipmentItem
                    quantity:
                      type: integer
                      description: Total number of products in the shipment item order
                    returnReasonId:
                      type: integer
                      description: Id of the return reason.
                    externalReference:
                      type: string
                      description: >-
                        Optional external reference that can be used freely by
                        the API user.
                    metadata:
                      type: object
                      description: >-
                        Optional list of key/value pairs that can be used freely
                        by the API user.
                      additionalProperties:
                        type: string
                      examples:
                        - purchasePrice: '140.00'
                          reference: '#74571'
                  required:
                    - shipmentItemId
                    - quantity
                    - returnReasonId
              required:
                - shipmentId
      responses:
        '200':
          description: OK
          content:
            application/x-www-form-urlencoded:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: integer
                x-examples:
                  Example 1:
                    messageCode: OK
                    message: RMA created.
                    result: 133
              examples:
                Example 1:
                  value:
                    messageCode: OK
                    message: RMA created.
                    result: 133
  /v2/returnlabel/get/{id}:
    get:
      summary: v2/returnlabel/get/:id
      operationId: get-v2-returnlabel-get-by-id
      x-json-api: false
      x-internal: false
      tags:
        - v2/returns
      description: >
        # GET v2/returnlabel/get/:shipmentId

        This endpoint returns a return-label for a `shipment` resource. The
        request requires a path parameter which is the `id` of the `shipment` to
        fetch the return label for. It returns only a label if the `shipment`
        can be be found and the return-label could be created successfully.


        ### Paperless Returns


        ### Return labels for specific (return)shipping methods
      parameters:
        - schema:
            type: integer
          name: shipmentId
          in: path
          required: true
          description: Id of the shipment as issued by Active Ants.
      responses:
        '200':
          $ref: '#/components/responses/get-returnlabel-response'
  /v2/returnlabel/get/{id}/{sm}:
    get:
      summary: v2/returnlabel/get/:id/:id
      operationId: get-v2-returnlabel-get-by-id-sm
      x-json-api: false
      tags:
        - v2/returns
      description: >

        # GET v2/returnlabel/get/:shipmentId/:shippingMethodId

        This endpoint returns a return-label for a `shipment` resource. The
        request requires a path parameter which is the `id` of the `shipment` to
        fetch the return label for and also the id of the shipping method to be
        used for the return in the path parameter `sm`. It returns only a label
        if the `shipment` can be be found and the return-label could be created
        successfully.


        ### Paperless Returns


        ### Return labels for any (return)shipping method

        See `GET v2/returnlabel/get/:id`.
      parameters:
        - schema:
            type: integer
          name: shipmentId
          in: path
          required: true
          description: Id of the shipment as issued by Active Ants.
        - schema:
            type: integer
          name: shippingMethodId
          in: path
          required: true
          description: Id of the shipping method as issued by Active Ants.
      responses:
        '200':
          $ref: '#/components/responses/get-returnlabel-response'
  /v2/returnitem/get:
    post:
      summary: v2/returnitem/get
      operationId: post-v2-returnitem-get
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/returns
      description: >-
        # POST v2/returnitem/get

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="specs/v3#tag/v3returns/operation/get-v3-returnItems"><code>POST
        v3/returnItems</code></a> end-point instead.

        </div>

        The request must be done by either posting an external ordernumber or a
        time path. The response will have a maximum of 1000 returnitems per
        post.
      responses:
        '200':
          description: OK
          content:
            application/x-www-form-urlencoded:
              schema:
                type: object
                x-examples:
                  Example 1:
                    messageCode: OK
                    message: Found 1 return items that match your criteria.
                    result:
                      - id: 499688
                        returnDate: '2024-02-06T14:40:38.69'
                        externalOrderNumber: TEST RW
                        sku: 36_WPBA_2000_09
                        quantity: 1
                        type: RETOUR
                        returnReasonId: 42
                        returnReason: Maat te groot
                        comment: |+

                        afterCare: GEEN
                        porti: null
                        returnShippingMethod: NL DHL RETOUR
                        returnShippingMethodId: 728
                        reDeliver: false
                        orderType: Decathlon NL
                        warehouseAbbreviation: NN
                        processedByWarehouseAbbreviation: NN
                        rma: null
                        rmaItem: null
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        returnDate:
                          type: string
                          description: "Date time of the returned item \r\n"
                        externalOrderNumber:
                          type: string
                          description: "The external order number this returnitem\r\nbelongs to "
                        sku:
                          type: string
                          description: The product SKU
                        quantity:
                          type: integer
                          description: "Quantity shipped of this product \r\n"
                        type:
                          type: string
                          description: Defines the condition
                        returnReasonId:
                          type: integer
                          description: The ID of the ReturnReason
                        returnReason:
                          type: string
                          description: "Description of the Return Reason \r\n"
                        comment:
                          type: string
                          description: "Comment related to the returnitem \r\n"
                        afterCare:
                          type: string
                        porti:
                          type: 'null'
                          description: 'Description of the used Porti '
                        returnShippingMethod:
                          type: string
                          description: Description of the used return shipping method
                        returnShippingMethodId:
                          type: integer
                        reDeliver:
                          type: boolean
                          description: Default false
                        orderType:
                          type: string
                          description: Ordertype of the ExternalOrderNumber
                        warehouseAbbreviation:
                          type: string
                        processedByWarehouseAbbreviation:
                          type: string
                        rma:
                          type: 'null'
                          description: "ExternalReference (String): reference of the Rma\r\nthat was supplied when the Rma was added. \r\n"
                        rmaItem:
                          type: 'null'
                          description: "ExternalReference (String): reference of the\r\nRmaItem that was supplied when the Rma was\r\nadded. Metadata (JSON object): metadata of the\r\nRmaItem that was supplied when the Rma was\r\nadded. "
              examples:
                Example 1:
                  value:
                    messageCode: OK
                    message: Found 1 return items that match your criteria.
                    result:
                      - id: 499688
                        returnDate: '2024-02-06T14:40:38.69'
                        externalOrderNumber: TEST RW
                        sku: 36_WPBA_2000_09
                        quantity: 1
                        type: RETOUR
                        returnReasonId: 42
                        returnReason: Maat te groot
                        comment: |+

                        afterCare: GEEN
                        porti: null
                        returnShippingMethod: NL DHL RETOUR
                        returnShippingMethodId: 728
                        reDeliver: false
                        orderType: Decathlon NL
                        warehouseAbbreviation: NN
                        processedByWarehouseAbbreviation: NN
                        rma: null
                        rmaItem: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ExternalOrderNumber:
                  type: integer
                  description: Optional, to get data from a specific external ordernumber
                Starttime:
                  type: string
                  format: date-time
                  description: Optional, date time returnitems from
                Endtime:
                  type: string
                  format: date-time
                  description: Optional, date time returnitems to
  /product/add:
    post:
      summary: product/add
      operationId: post-product-add
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/products
      description: >-
        # POST product/add

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3products/operation/post-v3-products"><code>POST
        v3/products</code></a> end-point instead.

        </div>

        This operation will insert a new product into the Maya database. 
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                sku:
                  type: string
                  description: The product's SKU. Should be a unique value in the database.
                name:
                  type: string
                  description: The product name
                barcode:
                  type: string
                  description: The product barcode.
                description:
                  type: string
                  description: The product description.
                harmonisationCode:
                  type: string
                  description: HS-code to be used for customs.
                countryOfOriginIso:
                  type: string
                  description: Alpha-2 ISO code of the Country of Origin.
                encodedImage:
                  type: string
                  description: Base64 string of the product image. Max file size is 100Kb.
                costPrice:
                  type: number
                  description: The product's purchasing price.
                supplierCode:
                  type: string
                  description: >-
                    Company code belonging to the supplier company (must be the
                    same as configured in MaYa)
                  example: Sup001
                supplierProductCode:
                  type: string
                  description: Product code used by the Supplier of this product
                stockMinimum:
                  type: integer
                  description: Used to define a minimum stock
                stockMaximum:
                  type: integer
                  description: Used to define a maximum stock
                priceA:
                  type: string
                  description: Product sale price (used in reports)
                priceB:
                  type: string
                  description: Product sale price (used in reports)
                priceC:
                  type: string
                  description: Product sale price (used in reports)
                priceD:
                  type: string
                  description: Product sale price (used in reports)
                vatLevel:
                  type: string
                  deprecated: true
                  description: 0 = No VAT, 1 = Low VAT, 2 = High VAT
                orderQuantity:
                  type: string
                  description: The quantity used in the order reports.
                extra1:
                  type: string
                  description: Additional product info
                extra2:
                  type: string
                  description: Additional product info
                extra3:
                  type: string
                  description: Additional product info
                extra4:
                  type: string
                  description: Additional product info
                extra5:
                  type: string
                  description: Additional product info
                hasThtDate:
                  type: boolean
                  description: Product has an expiration date if true
                warningDaysTillThtDate:
                  type: integer
                  description: Number of days for warning of THT
                maxDaysTillThtDate:
                  type: integer
                  description: Max number of days of THT
                hasLotNumber:
                  type: boolean
                  description: Product has a lot number if true
                hasSerial:
                  type: boolean
                  description: Product has a serial number if true
                useEconomicStock:
                  type: boolean
                  description: Use economic stock for product if true
              required:
                - sku
                - name
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: integer
              example:
                messageCode: OK
                message: Product has been successfully added
                result: 1326169
  /product/edit:
    post:
      summary: product/edit
      operationId: post-product-edit
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/products
      description: >-
        # POST product/edit

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3products/operation/put-v3-products"><code>PUT
        v3/products/:id</code></a> end-point instead.

        </div>

        This operation will update a product. 
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - sku
              properties:
                sku:
                  type: string
                  description: The Product SKU.
                CostPrice:
                  type: string
                  description: Purchasing cost of the product.
                Description:
                  type: string
                  description: The product description. Truncated after 200 characters
                HarmonisationCode:
                  type: string
                  description: HS-code to be used for customs.
                CountryOfOriginIso:
                  type: string
                  description: Alpha-2 ISO code of the Country of Origin.
                EncodedImage:
                  type: string
                  description: A Base64 encoded image. Max file size is 100Kb.
                Name:
                  type: string
                  description: The product name. Cannot be empty
                Barcode:
                  type: string
                  description: >-
                    The product barcode. Can only be changed as long as the
                    product is not in stock!
                StockMinimum:
                  type: integer
                  description: Used to define a minimum stock
                StockMaximum:
                  type: integer
                  description: Used to define a maximum stock
                PriceA:
                  type: number
                  description: Product sale price (used in reports)
                PriceB:
                  type: number
                  description: Product sale price (used in reports)
                PriceC:
                  type: number
                  description: Product sale price (used in reports)
                PriceD:
                  type: number
                  description: Product sale price (used in reports)
                VatLevel:
                  type: integer
                  deprecated: true
                  description: 0 = No VAT, 1 = Low VAT, 2 = High VAT
                OrderQuantity:
                  type: integer
                  description: The quantity used in the order reports.
                Extra1:
                  type: string
                  description: Additional product info
                Extra2:
                  type: string
                  description: Additional product info
                Extra3:
                  type: string
                  description: Additional product info
                Extra4:
                  type: string
                  description: Additional product info
                Extra5:
                  type: string
                  description: Additional product info
                HasThtDate:
                  type: boolean
                  description: >-
                    Set to true if the product has an expiration date to keep
                    track of
                WarningDaysTillThtDate:
                  type: integer
                  description: >-
                    Number of days before the expiration date to warning of
                    iminent expiration
                MaxDaysTillThtDate:
                  type: integer
                  description: >-
                    Number of days before the expiration date the product can be
                    sold at
                HasLotNumber:
                  type: boolean
                  description: Product has a lot number if true
                HasSerial:
                  type: boolean
                  description: Product has a serial number if true
                UseEconomicStock:
                  type: boolean
                  description: Use economic stock for product if true
            example:
              sku: string
              name: string
              barcode: string
              description: string
              harmonisationCode: string
              countryOfOriginIso: string
              encodedImage: string
              costPrice: 0
              supplierCode: Sup001
              supplierProductCode: string
              stockMinimum: 0
              stockMaximum: 0
              priceA: string
              priceB: string
              priceC: string
              priceD: string
              vatLevel: string
              orderQuantity: string
              extra1: string
              extra2: string
              extra3: string
              extra4: string
              extra5: string
              hasThtDate: true
              warningDaysTillThtDate: 0
              maxDaysTillThtDate: 0
              hasLotNumber: true
              hasSerial: true
              useEconomicStock: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: null
              example:
                messageCode: OK
                message: Edit of product (testsku125145) completed successfully.
                result: null
  /product/search:
    post:
      summary: product/search
      operationId: post-product-search
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/products
      description: >-
        # POST product/search

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3products/operation/get-v3-products"><code>GET
        v3/products?filter[sku][in]=sku1,sku2</code></a> and <a
        href="/specs/v3#tag/v3products/operation/get-v3-products"><code>GET
        v3/products?filter[barcode][in]=barcode1,barcode2</code></a> end-points
        instead.

        </div>
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                sku:
                  type: string
                  description: The product SKU code. Prioritized over barcode.
                barcode:
                  type: string
                  description: The product barcode.
            example:
              sku: test
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: object
                    properties:
                      sku:
                        type: string
                        description: Product SKU
              example:
                messageCode: OK
                message: Product found.
                result:
                  sku: testProductSKU123
  /v2/product/search:
    get:
      summary: v2/product/search
      operationId: get-v2-product-search
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/products
      description: >-
        # GET v2/product/search

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3products/operation/get-v3-products"><code>GET
        v3/products?filter[sku][in]=sku1,sku2</code></a> and <a
        href="/specs/v3#tag/v3products/operation/get-v3-products"><code>GET
        v3/products?filter[barcode][in]=barcode1,barcode2</code></a> end-points
        instead.

        </div>
      parameters:
        - name: sku
          in: query
          required: false
          schema:
            type: string
            example: GB-42145-222
          description: The product SKU, Prioritized over barcode.
        - name: barcode
          in: query
          required: false
          schema:
            type: string
            example: 1264232323
          description: The product barcode.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: object
                    properties:
                      sku:
                        type: string
                        description: Product SKU
                      barcode:
                        type: string
                        description: Product Barcode
                      weight:
                        type: number
                        description: Product weight (if known)
                      costPrice:
                        type: number
                        description: Product cost price (if known)
                      minTHT:
                        type: string
                        format: date-time
                        description: >-
                          If product has a best before date(THT), the closest
                          THT will be provided here.
              example:
                messageCode: OK
                message: Product found.
                result:
                  sku: RWS-DUO-470
                  barcode: ''
                  weight: null
                  costPrice: 0
                  minTHT: null
  /stock/get/{sku}:
    get:
      summary: stock/get/:sku
      operationId: get-stock-get-by-sku
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/stock
      description: >-
        # GET stock/get/:sku

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3stock/operation/get-v3-stock"><code>GET
        v3/stock?filter[sku][in]={sku}</code></a> end-point instead.

        </div>

        Either returns Economic stock or Free stock, based on the
        UseEconomicStock value in Product, set in Maya.
      parameters:
        - name: sku
          description: the sku to retreive the stock level for
          schema:
            type: string
          in: path
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: integer
                    description: >-
                      the stock level. Either economic or available, depending
                      on the product's settings
              example:
                messageCode: OK
                message: Found stock for the provided information.
                result: 15
  /stock/bulk/{all}:
    get:
      summary: stock/bulk/:all
      operationId: get-stock-bulk-allProducts
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/stock
      description: >-
        # GET stock/bulk/:all

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3stock/operation/get-v3-stock"><code>GET
        v3/stock</code></a> end-point instead.

        </div>

        allProducts needs to be either <code>true</code> or <code>false</code>.
        Under normal operation <code>false</code> needs to be specified.
        <code>true</code> is only needed when performing the initial stock
        synchronization to force all products to be retrieved. This is an
        intensive operation which should only be used sparingly. When
        <code>false</code> is specified only the products that are marked as
        ‘needs to be synched’ will be processed.
      parameters:
        - name: all
          in: path
          required: true
          schema:
            type: bool
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        sku:
                          type: string
                          description: The product SKU.
                        name:
                          type: string
                          description: The product name.
                        stock:
                          type: integer
                          description: >-
                            Either Economic stock or Available stock, based on
                            the UseEconomicStock value in Product, set in Maya.
                        thts:
                          type: array
                          description: >-
                            List of the best before dates, lotnumbers and
                            quantities per product (based on PhyscalStock)
                          items:
                            type: object
                            properties:
                              quantity:
                                type: integer
                              tht:
                                oneOf:
                                  - type: string
                                    format: date
                                  - type: null
                              lotNumber:
                                oneOf:
                                  - type: string
                                  - type: null
                        freeStock:
                          type: integer
                          description: Number of free stock for this Sku
                        economicStock:
                          type: integer
                          description: Number of economic stock for this Sku
                        availableStock:
                          type: integer
                          description: >-
                            Number of free stock minus stock stored on locations
                            which are excluded from fulfilment
                        physicalStock:
                          type: integer
                          description: Number of physical stock
              example:
                messageCode: OK
                message: Found 1 products suitable for stock synchronization.
                result:
                  - sku: AA-RWHM-342
                    name: Super Product Store – Hair Lotion (220ml)
                    stock: 2272
                    thts:
                      - quantity: 2272
                        tht: null
                        lotNumber: '2507111'
                    freeStock: 2272
                    economicStock: 2255
                    availableStock: 2272
                    physicalStock: 2272
                    unavailableStock: 0
                    expectedStock: -17
  /v2/stock/get/{sku}:
    get:
      summary: v2/stock/get/:sku
      operationId: get-v2-stock-get-by-sku
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/stock
      description: >-
        # GET v2/stock/get/:sku

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3stock/operation/get-v3-stock"><code>GET
        v3/stock?filter[sku][in]={sku}</code></a> end-point instead.

        </div>

        Either returns various stock levels for the sku.
      parameters:
        - name: sku
          schema:
            type: string
          in: path
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: object
                    properties:
                      name:
                        type: string
                        description: The product name
                      sku:
                        type: string
                        description: The product's SKU
                      productId:
                        type: integer
                        description: Id of the product
                      useEconomicStock:
                        type: null
                        description: >-
                          Either Economic stock or Available stock, based on the
                          UseEconomicStock value in Product, set in Maya.
                      physicalStock:
                        type: integer
                        description: Number of physical stock
                      expectedStock:
                        type: integer
                        description: Number of expected stock
                      orderedStock:
                        type: integer
                        description: Number of ordered stock
                      unavailableStock:
                        type: integer
                        description: Number of unavailable stock
                      freeStock:
                        type: integer
                        description: Number of free stock for this Sku
                      economicStock:
                        type: integer
                        description: Number of economic stock for this Sku
                      availableStock:
                        type: integer
                        description: >-
                          Number of free stock minus stock stored on locations
                          which are excluded from fulfilment
                      thts:
                        type: array
                        description: >-
                          List of the best before dates, lotnumbers and
                          quantities per product (based on PhyscalStock)
                        items:
                          type: object
                x-examples:
                  Example 1:
                    messageCode: OK
                    message: Found stock data for the provided information.
                    result:
                      name: Multiwarehouse product 002
                      sku: Mwhs-002
                      productId: 931141
                      useEconomicStock: null
                      physicalStock: 28
                      expectedStock: 0
                      orderedStock: 0
                      unavailableStock: 13
                      freeStock: 28
                      economicStock: 28
                      availableStock: 15
                      thts: []
  /v2/stock/bulk:
    get:
      summary: v2/stock/bulk
      operationId: get-v2-stock-bulk
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/stock
      parameters:
        - name: all_products
          description: >-
            When `true` returns product stock information for all products. When
            `false` returns product stock information for products with stock
            mutation date equal or greater than the default day (currently one
            day in the past).
          schema:
            type: boolean
          in: query
          required: fale
        - name: from
          description: >-
            ISO-8601 date and time format (time of day and time zone offset are
            optional). Value should be URLencoded. When specified, only the
            product stock information of products with a stock mutation date
            equal or greater than that date are returned.
          schema:
            type: string
            format: date-time
          in: query
          required: true
      description: >
        # GET v2/stock/bulk

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a href="/specs/v3#tag/v3stock/operation/get-v3-stock"><code>GET
        v3/stock</code></a> end-point instead.

        </div>

        Both query parameters are optional, but if `all_products` is set to
        `true` it will take priority over `from`. When no parameters are
        specified stock information for all products with stock mutation date
        equal or greater than the default day (currently one day in the past)
        will be returned.



        **Url examples:**:

        * https://shopapi.activeants.nl/v2/stock/bulk

        * https://shopapi.activeants.nl/v2/stock/bulk?all_products=true

        * https://shopapi.activeants.nl/v2/stock/bulk?all_products=false

        *
        https://shopapi.activeants.nl/v2/stock/bulk?from=2022-01-01T11%\3A54%3A07%2B01%3A00

        *
        https://shopapi.activeants.nl/v2/stock/bulk?from=2022-01-01T11%\3A54%3A07Z

        * https://shopapi.activeants.nl/v2/stock/bulk?from=2022-01-01

        *
        https://shopapi.activeants.nl/v2/stock/bulk?from=2022-01-01&all_products=false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: object
                    properties:
                      stockMutationPeriod:
                        type: object
                        properties:
                          from:
                            type: string
                            description: >-
                              The date time that is lesser or equal to the stock
                              mutation time of the products. This is the date
                              time supplied in the request.
                          to:
                            type: string
                            description: >-
                              The date time that is greater than the stock
                              mutation time of the products. This date time
                              should be used as from value in the successive
                              request.
                      stock:
                        type: array
                        items:
                          type: object
                          properties:
                            sku:
                              type: string
                              description: The product's SKU.
                            name:
                              type: string
                              description: The product name.
                            stock:
                              type: integer
                              description: >-
                                Either Economic stock or Free stock, based on
                                the UseEconomicStock value in Product, set in
                                Maya.
                            thts:
                              type: array
                              description: >-
                                List of the best before dates, lotnumbers and
                                quantities per product (based on PhyscalStock)
                              items:
                                type: object
                                properties:
                                  quantity:
                                    type: integer
                                  tht:
                                    type: string
                                    format: date-time
                                  lotNumber:
                                    type: string
                            freeStock:
                              type: integer
                              description: Number of free stock for this Sku
                            economicStock:
                              type: integer
                              description: Number of economic stock for this Sku
                            availableStock:
                              type: integer
                              description: >-
                                Number of free stock minus stock stored on
                                locations which are excluded from fulfilment
                            physicalStock:
                              type: integer
                              description: Number of physical stock
              example:
                messageCode: OK
                message: Found 4 products suitable for stock synchronization.
                result:
                  stockMutationPeriod:
                    from: '0001-01-01T00:00:00+00:00'
                    to: '2025-07-31T14:14:39+00:00'
                  stock:
                    - sku: '8010'
                      name: 1% Treatment solution
                      stock: 8179
                      thts:
                        - quantity: 10
                          tht: '2025-05-01T00:00:00'
                          lotNumber: T3342A
                        - quantity: 16
                          tht: '2025-12-01T00:00:00'
                          lotNumber: T4220A
                        - quantity: 336
                          tht: '2025-12-01T00:00:00'
                          lotNumber: T4221A
                        - quantity: 8394
                          tht: '2026-10-01T00:00:00'
                          lotNumber: T5113A
                      freeStock: 8215
                      economicStock: 8577
                      availableStock: 8179
                      physicalStock: 8756
                      unavailableStock: 57
                      expectedStock: 0
                    - sku: 7770-01
                      name: C15 Super Booster
                      stock: 0
                      thts: []
                      freeStock: 0
                      economicStock: 0
                      availableStock: 0
                      physicalStock: 0
                      unavailableStock: 0
                      expectedStock: 0
                    - sku: '34210'
                      name: Anniversary Bag 2021
                      stock: 184
                      thts:
                        - quantity: 194
                          tht: '2099-01-01T00:00:00'
                          lotNumber: 06-2024
                      freeStock: 184
                      economicStock: 184
                      availableStock: 184
                      physicalStock: 194
                      unavailableStock: 0
                      expectedStock: 0
                    - sku: '44037'
                      name: Sparkling water
                      stock: 3357
                      thts:
                        - quantity: 756
                          tht: '2099-01-01T00:00:00'
                          lotNumber: 06-2024
                        - quantity: 81
                          tht: '2099-01-01T00:00:00'
                          lotNumber: 07-2024
                        - quantity: 2520
                          tht: '2099-01-01T00:00:00'
                          lotNumber: '276518'
                      freeStock: 3357
                      economicStock: 3357
                      availableStock: 3357
                      physicalStock: 3357
                      unavailableStock: 0
                      expectedStock: 0
  /v2/stockmutation/get:
    get:
      summary: v2/stockmutation/get
      operationId: get-v2-stockmutation-get
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/stockmutations
      description: >-
        # GET v2/stockmutation/get

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a
        href="/specs/v3#tag/v3stock/operation/get-v3-stockmutations"><code>GET
        v3/stockmutations</code></a> end-point instead.

        </div>

        Only the stockmutations that are marked as ‘need to be synced’ will be
        processed. Only mutations of the last 7 days are shown. Shipments are
        excluded, they should be obtained with the GetShipments operation. When
        processed the stockmutations can be marked ‘synced’ with the
        UpdateSyncedStockMutations operation. Keep in mind that returns of
        damaged goods cannot be retrieved through this function, as they are not
        added to stock but discarded. This means there won’t be a StockMutation
        associated with this return. 
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Id of the Stock Mutation
                        sku:
                          type: string
                        quantity:
                          type: integer
                        type:
                          type: integer
                          description: |
                            Type of mutation:
                            * 1 = Received goods
                            * 3 = Returned goods
                            * 4 = Correction
                            * 5 = Composed products
                        createdAt:
                          type: string
                        thtDate:
                          type: null
                          description: THT Date (if applicable)
                        warehouseCode:
                          type: string
                          description: >-
                            The code for the warehouse where the item was moved
                            to
                        locationType:
                          type: string
                          enum:
                            - AUTOSTORE
                            - SPECIAL
                            - PALLET
                            - PICKABLE
                            - COOLED
                            - OUTBOUND
                            - INBOUND
                            - RETURN
                            - TRANSFER
                            - SECURED
                            - INSERTS
                          description: >-
                            Only filled if it corresponds with a type of
                            location, otherwise null.
                        correctionReason:
                          type: string
                          description: >-
                            Only filled with type 'correction'. Reason of
                            correction
                        remark:
                          type: string
                          description: >-
                            Only filled with type 'correction' or 'returned
                            goods'
                        supplierId:
                          type: null
                          description: Only filled with type 'received goods'
                        shippingId:
                          type: integer
                          description: Only filled with type 'returned goods'
                        orderNumber:
                          type: integer
                          description: Only filled with type 'returned goods'
                        externalOrderNumber:
                          type: null
                          description: Only filled with type 'returned goods'
                        returnReason:
                          type: null
                          description: Only filled with type 'returned goods'
                        lotNumber:
                          type: null
                          description: Lot number (if applicable)
                        purchaseOrders:
                          type: array
                          description: Only filled with type 'received goods'
                          items:
                            type: object
                            properties:
                              purchaseOrderId:
                                type: integer
                                description: Contains the purchase order Id
                              purchaseOrderReference:
                                type: string
                                description: Contains the purchase order reference
                              purchaseOrderRemark:
                                type: string
                                description: >-
                                  Any comments entered for this purchase order
                                  will be listed here.
              example:
                messageCode: OK
                message: Found 3 stock Mutations that match your criteria.
                result:
                  - id: 135682566
                    sku: 29-110-3
                    quantity: 1
                    type: 3
                    createdAt: '2025-07-29T12:35:24.147'
                    thtDate: null
                    warehouseCode: NR
                    locationType: RETURN
                    correctionReason: null
                    remark: |+

                    purchaseOrders: []
                    supplierId: null
                    shippingId: 42778080
                    orderNumber: 42701986
                    externalOrderNumber: '21383'
                    returnReason: Reden onbekend / Reason Unknown / Raison inconnue
                    lotNumber: null
                  - id: 135689831
                    sku: 29-63-6
                    quantity: 1
                    type: 3
                    createdAt: '2025-07-29T13:47:11.237'
                    thtDate: null
                    warehouseCode: NR
                    locationType: RETURN
                    correctionReason: null
                    remark: |+

                    purchaseOrders: []
                    supplierId: null
                    shippingId: 42816130
                    orderNumber: 42712591
                    externalOrderNumber: '21421'
                    returnReason: Reden onbekend / Reason Unknown / Raison inconnue
                    lotNumber: null
                  - id: 135365860
                    sku: 35-204-12
                    quantity: 1
                    type: 3
                    createdAt: '2025-07-25T07:34:57.697'
                    thtDate: null
                    warehouseCode: NR
                    locationType: RETURN
                    correctionReason: null
                    remark: |+

                    purchaseOrders: []
                    supplierId: null
                    shippingId: 42351015
                    orderNumber: 42258959
                    externalOrderNumber: '19899'
                    returnReason: Reden onbekend / Reason Unknown / Raison inconnue
                    lotNumber: null
  /v2/stockmutation/sync:
    post:
      summary: v2/stockmutation/sync
      operationId: get-v2-stockmutation-sync
      x-json-api: false
      x-internal: false
      deprecated: true
      tags:
        - v2/stockmutations
      description: >-
        # POST v2/stockmutation/sync

        <div class="admonition admonition--warning"> 

        This operation is deprecated, users are encouraged to migrate to the new
        <a
        href="/specs/v3#tag/v3stock/operation/get-v3-stockmutations"><code>GET
        v3/stockmutations</code></a> end-point instead.

        </div>

        If an invalid collection of Ids is provided, the return message will
        contain a list of Ids that were not found or do not belong to your
        company. Any Ids that were correct will NOT be processed in this event.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: Array of stockmutation id's
                  items:
                    type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: null
              example:
                messageCode: OK
                message: Request processed successfully.
                result: null
  /purchaseorder/add:
    post:
      summary: purchaseorder/add
      operationId: post-purchaseorder-add
      x-json-api: false
      x-internal: false
      deprecated: false
      tags:
        - v2/purchaseorders
      description: |-
        # POST purchaseorder/add
        This operation will insert a new purchase order into our database.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - reference
                - purchaseOrderItems
              properties:
                reference:
                  type: string
                  description: >-
                    Used to store a reference number or other text used to
                    identify the purchase order.
                comment:
                  type: string
                  description: >-
                    Can contain any extra information regarding the purchase
                    order.
                expectedDate:
                  type: string
                  format: date-time
                  description: The date on which the purchase order is expected to arrive
                warehouseId:
                  type: integer
                  description: >-
                    It is an optional field, used to store id of warehouse.
                    WarehouseId could be user input or default warehouse.
                purchaseOrderItems:
                  type: array
                  items:
                    type: object
                    description: >-
                      All Purchase Order Items will be put into this array in
                      your request. See 8.1.3 for details.
                    required:
                      - sku
                      - quantity
                    properties:
                      sku:
                        type: string
                        description: The product SKU for this purchase order item.
                      quantity:
                        type: integer
                        description: Total number of products in this purchase order item.
                      expectedDate:
                        type: string
                        format: date-time
                        description: The date on which this product is expected to arrive
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response-structure-OK'
              example:
                messageCode: OK
                message: PurchaseOrder added successfully.
                result: 23056
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response-structure-NOK'
  /purchaseorder/edit:
    post:
      summary: purchaseorder/edit
      operationId: post-purchaseorder-edit
      x-json-api: false
      x-internal: false
      deprecated: false
      tags:
        - v2/purchaseorders
      description: >-
        # POST purchaseorder/edit

        Rules for editing and deleting purchase orders (colours will be
        displayed in Maya)


        **Green rules**

        This purchase-order matches completely with all received goods. Each and
        every purchase-order-item is matched completely to incoming goods. There
        are no actions open for this purchase-order.

        * Edit of purchase-order allowed: NO

        * Delete of purchase-order allowed: NO

        * Edit of purchase-order-item allowed: NO

        * Delete of purchase-order-item allowed: NO

        * Adding purchase-order-item allowed: NO



        **Yellow rules**

        This purchase-order is not complete: not all expected goods have been
        delivered, but there is at least one purchase-order-item that has goods
        (partially) delivered.

        * Edit of purchase-order allowed: YES (only comment and reference, not
        expected date)

        * Delete of purchase-order allowed: NO

        * Edit of purchase-order-item allowed: YES (if new expected quantity for
        this purchase-order-item >= already booked)

        * Delete of purchase-order-item allowed: YES (if no goods booked on this
        purchase-order-item, otherwise set to booked value)

        * Adding purchase-order-item allowed: YES



        **Red rules**

        This purchase-order is new: no goods have been received for this
        purchase-order.

        * Edit of purchase-order allowed: YES (reference, comment and expected
        date)

        * Delete of purchase-order allowed: YES

        * Edit of purchase-order-item allowed: YES

        * Delete of purchase-order-item allowed: YES

        * Adding purchase-order-item allowed: YES


        **Notes:**

        1. **Edit purchase-order:** edit purchase-order, only provide
        purchase-order-level information. Existing purchase-order-items remain
        untouched.

        1. **Edit purchase-order-item(s):** edit purchase-order, provide array
        of SKUs and quantities. If SKU exists: overwrite quantity. Other
        existing purchase-order-items remain untouched. Red/ yellow rules apply

        1. **Add purchase-order-item(s):** edit purchase-order, provide array of
        SKUs and quantities to add. Existing purchase-order-items remain
        untouched.

        1. **Delete purchase-order-item(s):** edit purchase-order, provide array
        of SKUs with quantities set to 0. Any unbooked purchase-order-items will
        be deleted, or set to currently booked quantity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - purchaseOrderId
              properties:
                purchaseOrderId:
                  type: integer
                  description: >-
                    Used to look up, via Purchase Order ID of the original PO,
                    the purchase order to be modified.
                reference:
                  type: string
                  description: >-
                    Used to store the (modified) reference number or other text
                    used to identify the purchase order. Overwrites the "old"
                    reference when provided.
                comment:
                  type: string
                  description: >-
                    Can contain any extra information regarding the purchase
                    order. Overwrites the "old" comment when provided.
                expectedDate:
                  type: string
                  format: date-time
                  description: >-
                    The (modified) date on which the purchase order is expected
                    to arrive. Overwrites original when provided.
                purchaseOrderItems:
                  type: array
                  description: >-
                    All Purchase Order Items that are affected will be put into
                    this array in your request. Any PurchaseOrderItem / SKU not
                    listed will not be modified.
                  items:
                    type: object
                    required:
                      - sku
                      - quantity
                    properties:
                      sku:
                        type: string
                        description: The product SKU for this purchase order item.
                      quantity:
                        type: integer
                        description: Total number of products in this purchase order item.
            example:
              purchaseOrderId: 12345
              reference: ThisIsAReference
              comment: ThisIsAComment
              expectedDate: '2019-08-24T14:15:22Z'
              purchaseOrderItems:
                - sku: sku134
                  quantity: 500
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: integer
              example:
                messageCode: OK
                message: PurchaseOrder(Items) processed successfully.
                result: 23056
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: string
              examples:
                Incorrect format ExpectedDate:
                  value:
                    messageCode: NOK
                    message: Input did not pass validation. Check result for errors.
                    result:
                      - >-
                        Error for model.ExpectedDate: The value '2024-03-0' is
                        not valid for ExpectedDate.. Please check your input.
                Unknown PurchaseOrderId:
                  value:
                    messageCode: NOK
                    message: PurchaseOrder(Items) processed/deleted unsuccessfully.
                    result:
                      PurchaseOrderId: 123456
                      PurchaseOrderError: PurchaseOrder ID not found.
                Unknown SKU:
                  value:
                    messageCode: NOK
                    message: >-
                      PurchaseOrder(Items) processed/deleted unsuccessfully or
                      partially.
                    result:
                      PurchaseOrderId: 123456
                      PurchaseOrderError: PurchaseOrder ID not found.
                      PurchaseOrderItemsErrors:
                        - SKU: 1001
                          Status: NOK
                          Message: SKU not found
                Already completed PurchaseOrder:
                  value:
                    messageCode: NOK
                    message: PurchaseOrder(Items) processed/deleted unsuccessfully.
                    result:
                      PurchaseOrderId: 123456
                      PurchaseOrderError: PurchaseOrder is already completed.
                Edit on restricted fields:
                  value:
                    messageCode: string
                    message: string
                    result: string
  /purchaseorder/delete:
    post:
      summary: purchaseorder/delete
      operationId: post-purchaseorder-delete
      x-json-api: false
      x-internal: false
      deprecated: false
      tags:
        - v2/purchaseorders
      description: >-
        # POST purchaseorder/delete

        <div class="admonition admonition--note"> 
          <b>Important Note:</b> Calling Delete on a partially completed (Yellow) PurchaseOrder will result in the PurchaseOrder being adjusted to match any booked stock and set to Completed (Green).
        </div>


        To delete a purchase-order provide only purchase-order id, if red/yellow
        will do a full/partial delete respectively.


        To delete purchase-order-item(s) provide purchase-order id and array of
        SKUs to be deleted. Red/yellow rules apply.


        **Green rules**

        This purchase-order matches completely with all received goods. Each and
        every purchase-order-item is matched completely to incoming goods. There
        are no actions open for this purchase-order.

        * Edit of purchase-order allowed: NO

        * Delete of purchase-order allowed: NO

        * Edit of purchase-order-item allowed: NO

        * Delete of purchase-order-item allowed: NO

        * Adding purchase-order-item allowed: NO



        **Yellow rules**

        This purchase-order is not complete: not all expected goods have been
        delivered, but there is at least one purchase-order-item that has goods
        (partially) delivered.

        * Edit of purchase-order allowed: YES (only comment and reference, not
        expected date)

        * Delete of purchase-order allowed: NO

        * Edit of purchase-order-item allowed: YES (if new expected quantity for
        this purchase-order-item >= already booked)

        * Delete of purchase-order-item allowed: YES (if no goods booked on this
        purchase-order-item, otherwise set to booked value)

        * Adding purchase-order-item allowed: YES



        **Red rules**

        This purchase-order is new: no goods have been received for this
        purchase-order.

        * Edit of purchase-order allowed: YES (reference, comment and expected
        date)

        * Delete of purchase-order allowed: YES

        * Edit of purchase-order-item allowed: YES

        * Delete of purchase-order-item allowed: YES

        * Adding purchase-order-item allowed: YES
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - purchaseOrderId
              properties:
                purchaseOrderId:
                  type: integer
                  description: >-
                    Used to look up, via Purchase Order ID of the original
                    purchase-order, the purchase order to be modified.
                purchaseOrderItems:
                  type: array
                  description: >-
                    All purchase-order-items that are affected will be put into
                    this array in your request. Any purchase-order-item / SKU
                    not listed will not be modified. See below for description
                    of valid contents.
                  items:
                    type: object
                    required:
                      - sku
                    properties:
                      sku:
                        type: string
                        description: The product SKU for this purchase order item.
            example:
              purchaseOrderId: 1234
              purchaseOrderItems:
                sku: SKU1234
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: integer
              examples:
                messageCode: OK
                message: PurchaseOrder(Items) deleted successfully.
                result: 23056
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageCode:
                    type: string
                  message:
                    type: string
                  result:
                    type: integer
              examples:
                Unknown PurchaseOrderId:
                  value:
                    messageCode: NOK
                    message: PurchaseOrder(Items) processed/deleted unsuccessfully.
                    result:
                      PurchaseOrderId: 123456
                      PurchaseOrderError: PurchaseOrder ID not found.
                Unknown SKU:
                  value:
                    messageCode: string
                    message: string
                    result: 0
                Already completed PurchaseOrder:
                  value:
                    messageCode: NOK
                    message: PurchaseOrder(Items) processed/deleted unsuccessfully.
                    result:
                      PurchaseOrderId: 123456
                      PurchaseOrderError: PurchaseOrder is already completed.
