brinkcommerce-dev-mcp 0.1.0-beta.1

package/openapi-specs/.cache/ShopperQliro.yaml

@@ -0,0 +1,819 @@
+openapi: 3.0.3
+info:
+  title: ShopperQliroOne
+  version: '1'
+servers:
+  - url: https://shopper.eu-west-1.CUSTOMER_NAME.brinkcommerce.io/shopper-qliro
+security: []
+paths:
+  /checkouts:
+    post:
+      operationId: CreateQliroOrder
+      parameters:
+        - $ref: '#/components/parameters/apiKey'
+      security:
+        - JWT: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateOrderRequest'
+        required: true
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CreateOrderResponse'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '403':
+          description: 403 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+      x-hideTryItPanel: true
+    get:
+      operationId: GetQliroOrder
+      parameters:
+        - $ref: '#/components/parameters/apiKey'
+      security:
+        - JWT: []
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetOrderResponse'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '403':
+          description: 403 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+      x-hideTryItPanel: true
+  /checkouts/sync:
+    post:
+      operationId: SyncQliroOrder
+      parameters:
+        - $ref: '#/components/parameters/apiKey'
+      security:
+        - JWT: []
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UpdateOrderResponse'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '403':
+          description: 403 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+      x-hideTryItPanel: true
+  /upsell/start:
+    post:
+      operationId: StartQliroUpsell
+      parameters:
+        - $ref: '#/components/parameters/apiKey'
+      security:
+        - JWT: []
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UpsellSession'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '403':
+          description: 403 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '404':
+          description: 404 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '409':
+          description: 409 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+      x-hideTryItPanel: true
+  /upsell:
+    get:
+      operationId: GetQliroUpsell
+      parameters:
+        - $ref: '#/components/parameters/apiKey'
+      security:
+        - QliroUpsell: []
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UpsellSession'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '403':
+          description: 403 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '404':
+          description: 404 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+      x-hideTryItPanel: true
+  /upsell/items:
+    post:
+      operationId: AddQliroUpsellItem
+      parameters:
+        - $ref: '#/components/parameters/apiKey'
+      security:
+        - QliroUpsell: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpsellAddItemRequest'
+        required: true
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UpsellSession'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '403':
+          description: 403 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '404':
+          description: 404 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+      x-hideTryItPanel: true
+  /upsell/items/{itemId}:
+    put:
+      operationId: UpdateQliroUpsellItem
+      parameters:
+        - $ref: '#/components/parameters/apiKey'
+        - $ref: '#/components/parameters/itemId'
+      security:
+        - QliroUpsell: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpsellUpdateItemRequest'
+        required: true
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UpsellSession'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '403':
+          description: 403 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '404':
+          description: 404 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+      x-hideTryItPanel: true
+    delete:
+      operationId: RemoveQliroUpsellItem
+      parameters:
+        - $ref: '#/components/parameters/apiKey'
+        - $ref: '#/components/parameters/itemId'
+      security:
+        - QliroUpsell: []
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UpsellSession'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '403':
+          description: 403 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '404':
+          description: 404 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+      x-hideTryItPanel: true
+  /upsell/confirm:
+    post:
+      operationId: ConfirmQliroUpsell
+      parameters:
+        - $ref: '#/components/parameters/apiKey'
+      security:
+        - QliroUpsell: []
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UpsellSession'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '403':
+          description: 403 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '404':
+          description: 404 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '409':
+          description: 409 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QliroErrorResponse'
+      x-hideTryItPanel: true
+components:
+  parameters:
+    apiKey:
+      name: x-shopper-api-key
+      in: header
+      description: |
+        Shopper API Key should be used for integrations using BFF (Backend for Frontend) or
+        other reverse-proxy between the end-user and Shopper. Generated by Brink Commerce
+      required: false
+      schema:
+        type: string
+        nullable: false
+    itemId:
+      name: itemId
+      in: path
+      required: true
+      schema:
+        type: string
+        format: uuid
+  schemas:
+    Order:
+      required:
+        - id
+        - reference
+      type: object
+      properties:
+        reference:
+          type: string
+          description: The shorter order reference
+        id:
+          type: string
+          description: The order id
+    UpsellUpdateItemRequest:
+      title: UpsellUpdateItemRequest
+      required:
+        - quantity
+      type: object
+      properties:
+        quantity:
+          minimum: 1
+          type: integer
+    UpsellSessionCart:
+      title: UpsellSessionCart
+      type: object
+      properties:
+        upsellSessionId:
+          type: string
+          description: The upsell session that this cart is associated with
+        isTaxIncludedInPrice:
+          type: boolean
+          description: Whether prices include tax or not
+        storeGroupId:
+          type: string
+          description: The store group the upsell session started in
+        countryCode:
+          $ref: '#/components/schemas/CountryCode'
+        created:
+          type: string
+          description: When the upsell session was created
+          format: date-time
+        totals:
+          type: object
+          properties:
+            discountTotal:
+              type: integer
+              description: Total discount amount for the cart
+            grandTotal:
+              type: integer
+              description: Total amount for the cart, including taxes
+            taxTotal:
+              type: integer
+              description: Total tax for the cart
+            subTotal:
+              type: integer
+              description: Total amount for the cart, excluding taxes
+          description: Cart totals in minor units
+        currencyCode:
+          $ref: '#/components/schemas/CurrencyCode'
+        updated:
+          type: string
+          description: When the upsell session was last updated
+          format: date-time
+        items:
+          maxItems: 10
+          minItems: 0
+          type: array
+          description: Upsell session cart items
+          items:
+            $ref: '#/components/schemas/UpsellCartItem'
+    CreateOrderRequest:
+      title: CreateOrderRequest
+      required:
+        - qliro
+      type: object
+      properties:
+        qliro:
+          required:
+            - merchantConfirmationUrl
+            - merchantTermsUrl
+          type: object
+          properties:
+            backgroundColor:
+              type: string
+            merchantTermsUrl:
+              type: string
+              format: uri
+            askForNewsletterSignup:
+              type: boolean
+            askForNewsletterSignupText:
+              type: string
+            merchantConfirmationUrl:
+              type: string
+              format: uri
+            primaryColor:
+              type: string
+            callToActionColor:
+              type: string
+            requireIdentityVerification:
+              type: boolean
+            askForNewsletterSignupChecked:
+              type: boolean
+            cornerRadius:
+              type: number
+            callToActionHoverColor:
+              type: string
+            buttonCornerRadius:
+              type: number
+            merchantProvidedQuestion:
+              type: object
+              properties:
+                checked:
+                  type: boolean
+                text:
+                  type: string
+            merchantConstraintName:
+              maxLength: 100
+              type: string
+            availableShippingMethods:
+              type: array
+              description: See [Qliro One documentation](https://developers.qliro.com/docs/api/Orders-post#createOrder-AvailableShippingMethods) for details
+              items:
+                type: object
+            merchantProvidedMetadata:
+              maxItems: 20
+              type: array
+              items:
+                required:
+                  - key
+                  - value
+                type: object
+                properties:
+                  value:
+                    type: string
+                  key:
+                    type: string
+            customerInformation:
+              type: object
+              description: See [Qliro One documentation](https://developers.qliro.com/docs/api/Orders-post#createOrder-CustomerInformation) for details
+            merchantIntegrityPolicyUrl:
+              type: string
+              format: uri
+          additionalProperties: false
+          description: Payment provider specific fields, please see the [Qliro One documentation](https://developers.qliro.com/docs/api/Orders-post)for details.
+    SessionDetails:
+      title: SessionDetails
+      required:
+        - orderId
+      type: object
+      properties:
+        mobilePhoneNumber:
+          type: string
+          description: The mobile phone number entered by the customer
+        orderHtmlSnippet:
+          type: string
+          description: The html snippet to use in checkout
+        orderId:
+          type: integer
+          description: Qliro order id
+        totalPrice:
+          type: number
+          description: Total price of the order
+        upsell:
+          required:
+            - eligibleForUpsell
+            - isUpsellOrder
+            - upsellTotalPrice
+          type: object
+          properties:
+            eligibleForUpsell:
+              type: boolean
+            upsellTotalPrice:
+              type: number
+              description: Upsell total price in major units
+            isUpsellOrder:
+              type: boolean
+            eligibleForUpsellUntil:
+              type: string
+              description: Only available when eligibleForUpsell is true
+              format: date-time
+          description: Upsell details are only available after a purchase. See Qliro`s API docs for more information
+        merchantReference:
+          type: string
+          description: Brink reference
+        email:
+          type: string
+          description: The email address entered by the customer
+        customerCheckoutStatus:
+          type: string
+          description: The status of the Qliro One Order
+    GetOrderResponse:
+      title: GetOrderResponse
+      required:
+        - order
+        - qliro
+      type: object
+      properties:
+        qliro:
+          $ref: '#/components/schemas/SessionDetails'
+        order:
+          $ref: '#/components/schemas/Order'
+    UpdateOrderResponse:
+      title: UpdateOrderResponse
+      type: object
+      properties:
+        qliro:
+          $ref: '#/components/schemas/QliroOrder'
+        order:
+          $ref: '#/components/schemas/Order'
+    QliroErrorResponse:
+      type: object
+      allOf:
+        - $ref: '#/components/schemas/ErrorResponse'
+        - type: object
+          properties:
+            qliro:
+              type: object
+              properties:
+                id:
+                  type: string
+                  description: Qliro request id
+                error:
+                  type: object
+                  description: Qliro error model, see [Qliro documentation](https://developers.qliro.com/docs/api/Orders-post) for details
+    UpsellCartItem:
+      title: UpsellCartItem
+      type: object
+      properties:
+        displayDescription:
+          type: string
+          description: Display description of the product variant
+        quantity:
+          type: integer
+          description: Quantity of the cart item
+        productVariantId:
+          type: string
+          description: ID of the product variant
+        totalPriceAmount:
+          type: integer
+          description: Total amount of the cart item
+        displayName:
+          type: string
+          description: Display name of the product variant
+        totalDiscountAmount:
+          type: integer
+          description: Total discount amount of the cart item
+        created:
+          type: string
+          description: When this cart item was first created
+          format: date-time
+        salePriceAmount:
+          type: integer
+          description: Per unit sale price of the product variant
+        taxPercentage:
+          type: integer
+          description: Tax percentage for the cart item
+        description:
+          type: string
+          description: Description of the product variant
+        discountAmount:
+          type: integer
+          description: Per unit discount of the product variant
+        tags:
+          $ref: '#/components/schemas/Tags'
+        basePriceAmount:
+          type: integer
+          description: Per unit base unit price of the product variant
+        taxGroupId:
+          type: string
+          description: Tax group ID of the cart item
+        imageUrl:
+          type: string
+          description: URL to an image of the product variant
+        name:
+          type: string
+          description: Name of the product variant
+        options:
+          $ref: '#/components/schemas/Options'
+        id:
+          type: string
+          description: Unique cart item ID
+        totalTaxAmount:
+          type: integer
+          description: Total tax amount for the cart item
+        updated:
+          type: string
+          description: When this cart item was updated
+          format: date-time
+        taxPercentageDecimals:
+          type: integer
+          description: Number of decimals in tax percentage, eg. taxPercentage=2500 and taxPercentageDecimals=2 -> 25 % tax
+        shippingAttributes:
+          $ref: '#/components/schemas/ShippingAttributes'
+        productParentId:
+          type: string
+          description: ID of the product parent
+        customAttributes:
+          $ref: '#/components/schemas/CustomAttributes'
+    QliroOrder:
+      title: QliroOrder
+      required:
+        - orderId
+      type: object
+      properties:
+        orderId:
+          type: string
+          description: Qliro OrderId
+    CreateOrderResponse:
+      title: CreateOrderResponse
+      required:
+        - order
+        - qliro
+      type: object
+      properties:
+        qliro:
+          $ref: '#/components/schemas/QliroOrder'
+        order:
+          $ref: '#/components/schemas/Order'
+    UpsellAddItemRequest:
+      title: UpsellAddItemRequest
+      required:
+        - productVariantId
+        - quantity
+      type: object
+      properties:
+        quantity:
+          minimum: 1
+          type: integer
+        productVariantId:
+          type: string
+        options:
+          $ref: '#/components/schemas/Options'
+    UpsellSession:
+      title: UpsellSession
+      required:
+        - cart
+        - token
+      type: object
+      properties:
+        cart:
+          $ref: '#/components/schemas/UpsellSessionCart'
+        token:
+          type: string
+          description: Upsell session token
+    ErrorResponse:
+      title: Error
+      type: object
+      required:
+        - requestId
+        - error
+      properties:
+        requestId:
+          type: string
+          description: The request id
+        error:
+          type: string
+          description: The error message
+    CountryCode:
+      title: CountryCode
+      maxLength: 2
+      minLength: 2
+      pattern: ^[A-Z]{2}$
+      type: string
+      description: ISO 3166-1 alpha-2 country code
+    CurrencyCode:
+      title: CurrencyCode
+      maxLength: 3
+      minLength: 3
+      pattern: ^[A-Z]{3}$
+      type: string
+      description: ISO 4217 currency code
+    Tags:
+      title: Tags
+      type: object
+      description: |
+        Tags based on the product variant from product-management.
+
+        The keys must use only alphanumeric, hyphen & underscore characters, and max 20 in length (`^[A-Za-z0-9_-]{1,20}$`).
+      maxProperties: 20
+      additionalProperties:
+        type: array
+        minItems: 1
+        maxItems: 10
+        uniqueItems: true
+        items:
+          type: string
+          pattern: ^[^\n\t]+$
+          maxLength: 40
+          uniqueItems: true
+    Options:
+      description: |
+        Customer specified options for item
+
+        The keys must use only alphanumeric, hyphen & underscore characters, and max 40 in length (`^[A-Za-z0-9_-]{1,40}$`).
+      type: object
+      nullable: true
+      maxProperties: 10
+      additionalProperties:
+        type: string
+        maxLength: 256
+    ShippingAttributes:
+      title: ShippingAttributes
+      type: array
+      description: Attributes that could be used to adjust delivery and shipping options
+      nullable: true
+      maxItems: 10
+      uniqueItems: true
+      items:
+        type: string
+        pattern: ^[A-Za-z0-9_-]+$
+        maxLength: 40
+    CustomAttributes:
+      title: CustomAttributes
+      maxProperties: 50
+      type: object
+      additionalProperties:
+        type: string
+        maxLength: 500
+  securitySchemes:
+    ApiKey:
+      type: apiKey
+      name: x-shopper-api-key
+      in: header
+    JWT:
+      type: http
+      scheme: bearer
+    QliroUpsell:
+      type: http
+      scheme: bearer