Qliro Upsell API

openapi: 3.2.0
info:
  title: Qliro.Payments.MerchantApi Upsell API
  version: v1
servers:
- url: https://pago.qit.nu/checkout/merchantapi
tags:
- name: Upsell
paths:
  /Upsell:
    post:
      tags:
      - Upsell
      summary: Upsell order
      description: Once an order is completed and eligible for Upsell, merchant can add list of OrderItems to the existing order by sending an Upsell request
      operationId: upsellOrder
      requestBody:
        x-name: request
        description: Upsell order request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsellOrderRequest'
        required: true
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsellOrderResponse'
        '400':
          description: See ErrorCode and ErrorMessage for more details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
        '500':
          description: System error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
components:
  schemas:
    UpsellOrderRequest:
      allOf:
      - $ref: '#/components/schemas/RequestBase'
      - type: object
        additionalProperties: false
        required:
        - OrderId
        - Currency
        - OrderItems
        properties:
          RequestId:
            type: string
            description: Unique request id.
            format: guid
            example: d7da92f4-1ad9-48c3-9cd3-26559c98e64c
          OrderId:
            type: integer
            description: Qliro Checkout order Id of an already completed order.
            format: int64
            example: 12345
          Currency:
            type: string
            description: 'Three uppercase characters, in accordance with ISO 4217. '
            minLength: 1
            example: SEK
          OrderItems:
            type: array
            description: 'List of order items to be added to an existing completed order '
            items:
              $ref: '#/components/schemas/OrderItemData'
    RequestBase:
      type: object
      x-abstract: true
      additionalProperties: false
      required:
      - MerchantApiKey
      properties:
        MerchantApiKey:
          type: string
          description: Will be provided by Qliro Checkout when setting up merchant account
          maxLength: 50
          minLength: 0
          example: MerchantApiKey
    ErrorResponseModel:
      type: object
      additionalProperties: false
      properties:
        ErrorCode:
          type:
          - string
          - 'null'
          description: Unique error code
          example: ORDER_NOT_FOUND
        DetailedErrorMessage:
          type:
          - string
          - 'null'
          description: Detailed error message
          example: Order not found
        ErrorReference:
          type: string
          description: A tracking ID from Qliro Checkout
          format: guid
          example: d7da92f4-1ad9-48c3-9cd3-26559c98e64c
    OrderItemData:
      type: object
      additionalProperties: false
      required:
      - MerchantReference
      - Type
      - Quantity
      - PricePerItemIncVat
      - PricePerItemExVat
      properties:
        MerchantReference:
          type: string
          description: A string generated by the merchant to identify the order item. The combination of MerchantReference and Price Per Item Including Vat is used to uniquely identify the order item. Maximum length is 200 characters.
          minLength: 1
          pattern: ^[\p{L}\s(.)'\-_&,\/–+0-9:]{1,200}$
          example: BlackHat
        Description:
          type:
          - string
          - 'null'
          description: A name or description of the order item.
          maxLength: 4000
          example: Original product
        Type:
          type: string
          description: An order item type can be 'Product', 'Discount', 'Fee' or 'Shipping'.
          minLength: 1
          example: Product
        Quantity:
          type: integer
          description: 'The quantity of item(s) and least quantity is 1.  '
          format: int32
          maximum: 2147483647
          minimum: 1
          example: 95
        PricePerItemIncVat:
          type: number
          description: The price per item including Value Added Tax. This can be specified with 0, 1 or 2 decimals, e.g. 99 or 99.9 or 99.99.
          format: decimal
          example: 143
        PricePerItemExVat:
          type: number
          description: The price per item excluding Value Added Tax. This can be specified with 0, 1 or 2 decimals, e.g. 99 or 99.9 or 99.99.
          format: decimal
          example: 100
    UpsellOrderResponse:
      type: object
      additionalProperties: false
      properties:
        PaymentTransactionId:
          type: integer
          description: 'Newly created payment transaction id. '
          format: int64
          example: 123
        Status:
          type:
          - string
          - 'null'
          description: 'Newly created payment transaction status. '
          example: Created
x-generator: NSwag v14.0.3.0 (NJsonSchema v11.0.0.0 (Newtonsoft.Json v13.0.0.0))