brinkcommerce-dev-mcp 0.1.0-beta.1

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

@@ -0,0 +1,1158 @@
+openapi: 3.0.3
+info:
+  title: ShopperLedyer
+  version: '1'
+servers:
+  - url: https://shopper.eu-west-1.CUSTOMER_NAME.brinkcommerce.io/shopper-ledyer
+security: []
+paths:
+  /sessions:
+    post:
+      operationId: CreateLedyerSession
+      parameters:
+        - $ref: '#/components/parameters/apiKey'
+      security:
+        - JWT: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateSessionRequest'
+        required: true
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SessionResponse'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: 401 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '403':
+          description: 403 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: 404 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '409':
+          description: 409 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      x-hideTryItPanel: true
+  /sessions/sync:
+    post:
+      operationId: SyncLedyerSession
+      parameters:
+        - $ref: '#/components/parameters/apiKey'
+      security:
+        - JWT: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdateSessionRequest'
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SessionResponse'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: 401 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '403':
+          description: 403 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: 404 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      x-hideTryItPanel: true
+  /confirmation:
+    get:
+      operationId: GetLedyerConfirmation
+      parameters:
+        - $ref: '#/components/parameters/apiKey'
+      security:
+        - JWT: []
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetLedyerConfirmationResponse'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: 401 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '403':
+          description: 403 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: 404 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      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
+  schemas:
+    CreateSessionRequest:
+      title: CreateSessionRequest
+      type: object
+      required:
+        - ledyer
+      properties:
+        ledyer:
+          $ref: '#/components/schemas/Ledyer'
+    Ledyer:
+      title: ledyer
+      type: object
+      required:
+        - settings
+      properties:
+        autoCapture:
+          $ref: '#/components/schemas/autoCapture'
+        customer:
+          $ref: '#/components/schemas/customer'
+        locale:
+          description: The language(/locale) for this session request. If not provided then the default language for this merchant and market will be used.
+          minLength: 1
+          type: string
+        settings:
+          $ref: '#/components/schemas/settings'
+        storeId:
+          type: string
+          description: Only needed in case of multiple stores with same country and currency.
+          minLength: 1
+        source:
+          type: string
+          description: A string that should either be "pos" or "online".
+          minLength: 1
+          enum:
+            - pos
+            - online
+      additionalProperties: false
+      description: Payment provider specific fields, please see the Ledyer documentation for details.
+    autoCapture:
+      type: object
+      description: Optional settings for auto capture
+      required:
+        - delayMinutes
+      properties:
+        delayMinutes:
+          minimum: 0
+          maximum: 10080
+          type: integer
+        enabled:
+          type: boolean
+    customer:
+      description: Optional fields to prefill fields in Ledyer Checkout.
+      type: object
+      properties:
+        companyId:
+          description: Company ID based on country.
+          type: string
+          minLength: 1
+        email:
+          description: The email of the customer.
+          type: string
+          format: email
+        firstName:
+          description: The first name of the customer.
+          minLength: 1
+          type: string
+        lastName:
+          description: The last name of the customer.
+          minLength: 1
+          type: string
+        phone:
+          description: The phone number of the customer.
+          minLength: 1
+          type: string
+        reference1:
+          minLength: 1
+          type: string
+        reference2:
+          minLength: 1
+          type: string
+      additionalProperties: false
+    settings:
+      description: Object containing various setting possibilities.
+      type: object
+      required:
+        - urls
+      properties:
+        customer:
+          type: object
+          properties:
+            allowShippingAddress:
+              type: boolean
+              description: If true the customer will be allowed to enter a shipping address that differs from the billing address.
+            showNameFields:
+              type: boolean
+              description: Set to true in order to require the customer to enter first name and last name in the initial checkout view. Default is false.
+            showShippingAddressContact:
+              type: boolean
+              description: If true the customer will be allowed the enter a separate contact person for the shipping address.
+        security:
+          type: object
+          properties:
+            level:
+              type: integer
+              description: Set security level.
+            requireClientValidation:
+              type: boolean
+              description: |
+                If true Ledyer's checkout client will pause after the end user has pressed the complete purchase button, in order to give the merchant an opportunity to perform any kind of validation before the order is submitted to Ledyer, for a maximum duration of 10 seconds.
+                The result of the validation is communicated to Ledyer via Ledyer's client validation API, see Client API & events for further instructions.
+                If false, the order will be placed without delay.
+            validationSuccessOnTimeout:
+              type: boolean
+              description: If false the validate callback must get a positive response to not stop purchase. Default is true.
+        urls:
+          type: object
+          required:
+            - terms
+          properties:
+            confirmation:
+              type: string
+              description: |
+                The landing page for a successful purchase.
+                If not provided the user will stay on the same page while the Ledyer Checkout content is swapped to a Thank you page.
+                The following placeholders can be included in the url: "{session.id}", "{order.id}".
+              minLength: 1
+            privacy:
+              type: string
+              description: Merchant privacy policy that will be visible and linked in the checkout. Optional since this information can be included in the terms link as well.
+              minLength: 1
+            terms:
+              type: string
+              description: Merchant terms that will be visible and linked in the checkout.
+              minLength: 1
+      additionalProperties: false
+    UpdateSessionRequest:
+      title: UpdateSessionRequest
+      type: object
+      properties:
+        locale:
+          description: The language(/locale) for this session request. If not provided then the default language for this merchant and market will be used.
+          minLength: 1
+          type: string
+    SessionResponse:
+      type: object
+      required:
+        - orderId
+        - sessionId
+        - expiresAt
+      properties:
+        orderId:
+          type: string
+        sessionId:
+          type: string
+        expiresAt:
+          type: string
+          format: date-time
+    GetLedyerConfirmationResponse:
+      title: GetLedyerConfirmationResponse
+      type: object
+      required:
+        - order
+      properties:
+        order:
+          $ref: '#/components/schemas/Order'
+    ErrorResponse:
+      title: Error
+      type: object
+      required:
+        - requestId
+        - error
+      properties:
+        requestId:
+          type: string
+          description: The request id
+        error:
+          type: string
+          description: The error message
+    CurrencyCode:
+      title: CurrencyCode
+      maxLength: 3
+      minLength: 3
+      pattern: ^[A-Z]{3}$
+      type: string
+      description: ISO 4217 currency code
+    ShippingFee:
+      type: object
+      required:
+        - basePriceAmount
+        - displayName
+        - taxAmount
+        - salePriceAmount
+        - taxPercentage
+        - taxPercentageDecimals
+        - name
+        - discountAmount
+        - id
+        - currencyCode
+      properties:
+        basePriceAmount:
+          type: integer
+          format: int64
+          description: Per unit base unit price of the shipping fee
+        displayName:
+          type: string
+          description: Display name of the shipping fee
+        taxGroupId:
+          type: string
+          description: Tax group ID of the shipping fee
+        salePriceAmount:
+          type: integer
+          format: int64
+          description: Per unit sale price of the shipping fee
+        taxPercentage:
+          type: integer
+          format: int64
+          description: Tax percentage for the shipping fee
+        name:
+          type: string
+          description: Name of the shipping fee
+        discountAmount:
+          type: integer
+          format: int64
+          description: Per unit discount of the shipping fee
+        id:
+          type: string
+          description: Unique ID for the shipping fee item
+        taxAmount:
+          type: integer
+          format: int64
+          description: Per unit discount of the shipping fee
+        currencyCode:
+          $ref: '#/components/schemas/CurrencyCode'
+        taxPercentageDecimals:
+          type: integer
+          format: int64
+          description: Number of decimals in tax percentage, eg. taxPercentage=2500 and taxPercentageDecimals=2 -> 25 % tax
+    CheckoutBonus:
+      required:
+        - maxAmount
+      type: object
+      properties:
+        maxAmount:
+          type: integer
+          format: int64
+          description: Max amount in minor units from bonus points
+    OrderTotals:
+      required:
+        - bonusTotal
+        - discountTotal
+        - giftCardTotal
+        - grandTotal
+        - shippingTotal
+        - subTotal
+        - taxTotal
+        - voucherTotal
+      type: object
+      properties:
+        shippingTotal:
+          type: integer
+          format: int64
+          description: Total shipping amount for the order
+        giftCardTotal:
+          type: integer
+          format: int64
+          description: Total gift card amount for the order
+        bonusTotal:
+          type: integer
+          format: int64
+          description: Total bonus amount for the order
+        discountTotal:
+          type: integer
+          format: int64
+          description: Total discount amount for the order
+        grandTotal:
+          type: integer
+          format: int64
+          description: Grand total amount for the cart
+        taxTotal:
+          type: integer
+          format: int64
+          description: Total tax for the order
+        voucherTotal:
+          type: integer
+          format: int64
+          description: 'Deprecated: it''s now part of discountTotal'
+          deprecated: true
+        subTotal:
+          type: integer
+          format: int64
+          description: Sub total amount for the order
+    LanguageCode:
+      title: LanguageCode
+      pattern: ^[A-Za-z0-9_-]+$
+      type: string
+      description: Language code
+    CheckoutGiftCardProduct:
+      required:
+        - amount
+        - distribution
+        - id
+        - name
+        - provider
+      type: object
+      properties:
+        amount:
+          type: integer
+          format: int64
+          description: Monetary amount in minor units
+        provider:
+          type: string
+          description: Provider used for gift card product
+        name:
+          type: string
+          description: Gift card product name
+        recipient:
+          type: string
+          description: Recipient information used for gift card product distribution
+        id:
+          type: string
+          description: ID for the gift card product
+        distribution:
+          type: string
+          description: Distribution of the gift card product
+        merchantReference:
+          type: string
+          description: Merchant reference
+    CheckoutVoucher:
+      type: object
+      required:
+        - amount
+        - description
+        - id
+      properties:
+        amount:
+          type: integer
+          format: int64
+          description: Monetary value for the voucher
+        description:
+          type: string
+          description: Description for the checkout voucher
+        id:
+          type: string
+          description: ID for the checkout voucher
+    OrderProvider:
+      required:
+        - id
+        - name
+      type: object
+      properties:
+        name:
+          type: string
+          description: Provider name
+        id:
+          type: string
+          description: Provider id
+    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
+    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
+    Campaign:
+      title: Campaign
+      required:
+        - campaignGroupId
+        - campaignId
+        - name
+      type: object
+      properties:
+        campaignId:
+          type: string
+          description: The campaign id
+        campaignGroupId:
+          type: string
+          description: The campaign group id
+        name:
+          type: string
+          description: The campaign name
+    BundleOutcome:
+      type: object
+      required:
+        - bundleId
+        - discountAmount
+        - bundleGroupId
+      properties:
+        bundleId:
+          type: string
+          description: Id of the bundle applying this discount
+        discountAmount:
+          type: integer
+          format: int64
+          description: The discount amount in minor units
+        bundleGroupId:
+          type: string
+          description: Id of the bundle group applying this discount
+    ExternalRuleOutcome:
+      type: object
+      required:
+        - reference
+        - discountAmount
+        - ruleId
+      properties:
+        reference:
+          type: string
+          description: Reference from the external provider used with this rule
+        discountAmount:
+          type: integer
+          format: int64
+          description: The discount amount in minor units
+        ruleId:
+          type: string
+          description: Id of the discount external rule applying this discount
+    CodeRuleOutcome:
+      type: object
+      required:
+        - code
+        - discountAmount
+        - ruleId
+      properties:
+        code:
+          type: string
+          description: Code used with this rule
+        discountAmount:
+          type: integer
+          format: int64
+          description: The discount amount in minor units
+        ruleId:
+          type: string
+          description: Id of the discount code rule applying this discount
+    CartRuleOutcome:
+      type: object
+      required:
+        - discountAmount
+        - ruleId
+      properties:
+        discountAmount:
+          type: integer
+          format: int64
+          description: The discount amount in minor units
+        ruleId:
+          type: string
+          description: Id of the discount cart rule applying this discount
+    OrderLineDiscountOutcome:
+      title: OrderLineDiscountOutcome
+      type: object
+      required:
+        - bundles
+        - externalRules
+        - codeRules
+        - cartRules
+        - totalDiscountAmount
+      properties:
+        bundles:
+          type: array
+          items:
+            $ref: '#/components/schemas/BundleOutcome'
+        externalRules:
+          type: array
+          items:
+            $ref: '#/components/schemas/ExternalRuleOutcome'
+        codeRules:
+          type: array
+          items:
+            $ref: '#/components/schemas/CodeRuleOutcome'
+        cartRules:
+          type: array
+          items:
+            $ref: '#/components/schemas/CartRuleOutcome'
+        totalDiscountAmount:
+          type: integer
+          format: int64
+          description: The total discount amount from discount rules applied on this order line
+        rules:
+          type: array
+          description: 'Deprecated: This field is deprecated due to being replaced by more informative models. Use CodeRules, CartRules and ExternalRules instead.'
+          deprecated: true
+          items:
+            type: object
+            properties:
+              discountAmount:
+                type: integer
+                format: int64
+                description: The discount amount in minor units
+              discountRuleId:
+                type: string
+                description: Id of the discount rule applying this discount
+    Dimensions:
+      title: Dimensions
+      type: object
+      required:
+        - width
+        - length
+        - height
+      properties:
+        width:
+          type: integer
+          format: int32
+          description: Width (in millimeters)
+          minimum: 0
+        length:
+          type: integer
+          format: int32
+          description: Length (in millimeters)
+          minimum: 0
+        height:
+          type: integer
+          format: int32
+          description: Height (in millimeters)
+          minimum: 0
+    CustomAttributes:
+      title: CustomAttributes
+      maxProperties: 50
+      type: object
+      additionalProperties:
+        type: string
+        maxLength: 500
+    OrderLine:
+      type: object
+      required:
+        - id
+        - productVariantId
+        - productParentId
+        - basePriceAmount
+        - customAttributes
+        - currencyCode
+        - description
+        - discountAmount
+        - discountOutcome
+        - displayDescription
+        - displayName
+        - distributedTotalDiscountAmount
+        - distributedTotalPriceAmount
+        - distributedTotalTaxAmount
+        - imageUrl
+        - name
+        - options
+        - quantity
+        - salePriceAmount
+        - shippingAttributes
+        - tags
+        - taxGroupId
+        - taxPercentage
+        - taxPercentageDecimals
+        - totalDiscountAmount
+        - totalPriceAmount
+        - totalTaxAmount
+      properties:
+        productVariantId:
+          type: string
+          description: ID of the product variant
+        distributedTotalPriceAmount:
+          type: integer
+          format: int64
+          description: Total amount of the order line including distributed order discount
+        totalPriceAmount:
+          type: integer
+          format: int64
+          description: Total amount of the order line
+        displayName:
+          type: string
+          description: Display name of the product variant
+        salePriceAmount:
+          type: integer
+          format: int64
+          description: Per unit sale price of the product variant
+        distributedTotalTaxAmount:
+          type: integer
+          format: int64
+          description: Total tax amount for the order line including distributed order discount
+        description:
+          type: string
+          description: Description of the product variant
+        discountAmount:
+          type: integer
+          format: int64
+          description: Per unit discount of the product variant
+        imageUrl:
+          type: string
+          description: URL to an image of the product variant
+        options:
+          $ref: '#/components/schemas/Options'
+        id:
+          type: string
+          description: Unique ID for the cart item
+        shippingAttributes:
+          $ref: '#/components/schemas/ShippingAttributes'
+        displayDescription:
+          type: string
+          description: Display description of the product variant
+        quantity:
+          type: integer
+          format: int64
+          description: Quantity of the order line
+        totalDiscountAmount:
+          type: integer
+          format: int64
+          description: Total discount amount of the order line
+        taxPercentage:
+          type: integer
+          format: int64
+          description: Tax percentage for the order line
+        weight:
+          type: integer
+          format: int32
+          description: Weight in grams
+        tags:
+          $ref: '#/components/schemas/Tags'
+        basePriceAmount:
+          type: integer
+          format: int64
+          description: Per unit base unit price of the product variant
+        distributedTotalDiscountAmount:
+          type: integer
+          format: int64
+          description: Total discount amount of the order line including distributed order discount
+        taxGroupId:
+          type: string
+          description: Tax group ID of the order line
+        name:
+          type: string
+          description: Name of the product variant
+        campaign:
+          $ref: '#/components/schemas/Campaign'
+        discountOutcome:
+          $ref: '#/components/schemas/OrderLineDiscountOutcome'
+        totalTaxAmount:
+          type: integer
+          format: int64
+          description: Per unit tax amount for the product variant
+        taxPercentageDecimals:
+          type: integer
+          format: int64
+          description: Number of decimals in tax percentage, eg. taxPercentage=2500 and taxPercentageDecimals=2 -> 25 % tax
+        productParentId:
+          type: string
+          description: ID of the product parent
+        currencyCode:
+          $ref: '#/components/schemas/CurrencyCode'
+        dimensions:
+          $ref: '#/components/schemas/Dimensions'
+        customAttributes:
+          $ref: '#/components/schemas/CustomAttributes'
+    ProductParentId:
+      type: string
+      maxLength: 100
+      description: A product parent id from product-management
+    OrderGift:
+      type: object
+      required:
+        - id
+        - productVariantId
+        - productParentId
+        - basePriceAmount
+        - customAttributes
+        - currencyCode
+        - description
+        - discountAmount
+        - displayDescription
+        - displayName
+        - discountRuleId
+        - imageUrl
+        - name
+        - quantity
+        - salePriceAmount
+        - shippingAttributes
+        - taxGroupId
+        - taxPercentage
+        - taxPercentageDecimals
+        - totalDiscountAmount
+        - totalPriceAmount
+        - totalTaxAmount
+      properties:
+        displayDescription:
+          type: string
+          description: Display description of the product variant
+        quantity:
+          type: integer
+          format: int64
+          description: Quantity of the checkout gift
+        productVariantId:
+          type: string
+          description: ID of the product variant
+        totalPriceAmount:
+          type: integer
+          format: int64
+          description: Total price amount of the checkout gift
+        displayName:
+          type: string
+          description: Display name of the product variant
+        totalDiscountAmount:
+          type: integer
+          format: int64
+          description: Total discount amount of the checkout gift
+        taxPercentage:
+          type: integer
+          format: int64
+          description: Tax percentage for the checkout gift
+        salePriceAmount:
+          type: integer
+          format: int64
+          description: Per unit sale price of the product variant
+        description:
+          type: string
+          description: Description of the product variant
+        discountAmount:
+          type: integer
+          format: int64
+          description: Per unit discount of the product variant
+        basePriceAmount:
+          type: integer
+          format: int64
+          description: Per unit base unit price of the product variant
+        taxGroupId:
+          type: string
+          description: Tax group ID of the product variant
+        imageUrl:
+          type: string
+          description: URL to an image of the product variant
+        name:
+          type: string
+          description: Name of the product variant
+        discountRuleId:
+          type: string
+          description: ID of the discount rule adding this gift
+        id:
+          type: string
+          description: Unique ID for the checkout gift
+        totalTaxAmount:
+          type: integer
+          format: int64
+          description: Total tax amount of the checkout gift
+        taxPercentageDecimals:
+          type: integer
+          format: int64
+          description: Number of decimals in tax percentage, eg. taxPercentage=2500 and taxPercentageDecimals=2 -> 25 % tax
+        weight:
+          type: integer
+          format: int32
+          description: Weight in grams
+        currencyCode:
+          $ref: '#/components/schemas/CurrencyCode'
+        dimensions:
+          $ref: '#/components/schemas/Dimensions'
+        shippingAttributes:
+          $ref: '#/components/schemas/ShippingAttributes'
+        productParentId:
+          $ref: '#/components/schemas/ProductParentId'
+        customAttributes:
+          $ref: '#/components/schemas/CustomAttributes'
+    OrderPaymentProvider:
+      required:
+        - id
+        - name
+      type: object
+      properties:
+        name:
+          type: string
+          description: Provider name
+        id:
+          type: string
+          description: Provider id
+        config:
+          type: object
+          additionalProperties:
+            type: string
+      description: Payment provider
+    CountryCode:
+      title: CountryCode
+      maxLength: 2
+      minLength: 2
+      pattern: ^[A-Z]{2}$
+      type: string
+      description: ISO 3166-1 alpha-2 country code
+    StoreGroupId:
+      type: string
+      maxLength: 100
+      description: A store group id from store-management
+    OrderAddress:
+      type: object
+      properties:
+        country:
+          $ref: '#/components/schemas/CountryCode'
+        pcc:
+          type: string
+        stateOrProvince:
+          type: string
+        streetAddress:
+          type: string
+        city:
+          type: string
+        givenName:
+          type: string
+        familyName:
+          type: string
+        postalCode:
+          type: string
+        streetAddress2:
+          type: string
+    OrderDiscountOutcome:
+      title: OrderDiscountOutcome
+      type: object
+      required:
+        - discountReduction
+        - externalRules
+        - cartRules
+        - codeRules
+        - totalDiscountAmount
+        - freeShipping
+      properties:
+        discountReduction:
+          type: integer
+          format: int64
+          description: The amount reduced to prevent negative value
+        freeShipping:
+          type: boolean
+          description: If free shipping was applied by a discount rule
+        externalRules:
+          type: array
+          items:
+            $ref: '#/components/schemas/ExternalRuleOutcome'
+        codeRules:
+          type: array
+          items:
+            $ref: '#/components/schemas/CodeRuleOutcome'
+        cartRules:
+          type: array
+          items:
+            $ref: '#/components/schemas/CartRuleOutcome'
+        totalDiscountAmount:
+          type: integer
+          format: int64
+          description: The total discount amount from discount rules applied directly on the order
+        rules:
+          type: array
+          description: 'Deprecated: This field is deprecated due to being replaced with more informative models. Use CodeRules, CartRules and ExternalRules instead.'
+          deprecated: true
+          items:
+            type: object
+            properties:
+              discountAmount:
+                type: integer
+                format: int64
+                description: The discount amount in minor units
+              discountRuleId:
+                type: string
+                description: Id of the discount rule applying this discount
+    OrderGiftCard:
+      type: object
+      required:
+        - amount
+        - id
+      properties:
+        amount:
+          type: integer
+          format: int64
+          description: Amount to be used from gift card
+        id:
+          type: string
+          description: ID for the order gift card
+    Order:
+      type: object
+      required:
+        - billingAddress
+        - storeGroupId
+        - countryCode
+        - currencyCode
+        - discountOutcome
+        - email
+        - giftCardProducts
+        - giftCards
+        - gifts
+        - id
+        - isTaxIncludedInPrice
+        - languageCode
+        - orderLines
+        - paymentProvider
+        - reference
+        - shippingAddress
+        - shippingFees
+        - totals
+        - vouchers
+      properties:
+        isTaxIncludedInPrice:
+          type: boolean
+          description: Whether prices include tax or not
+        shippingFees:
+          type: array
+          items:
+            $ref: '#/components/schemas/ShippingFee'
+        bonus:
+          $ref: '#/components/schemas/CheckoutBonus'
+        totals:
+          $ref: '#/components/schemas/OrderTotals'
+        languageCode:
+          $ref: '#/components/schemas/LanguageCode'
+        giftCardProducts:
+          type: array
+          items:
+            $ref: '#/components/schemas/CheckoutGiftCardProduct'
+        vouchers:
+          type: array
+          items:
+            $ref: '#/components/schemas/CheckoutVoucher'
+        reference:
+          type: string
+          description: The shorter order reference
+        shippingProvider:
+          $ref: '#/components/schemas/OrderProvider'
+        giftCardProvider:
+          $ref: '#/components/schemas/OrderProvider'
+        orderLines:
+          type: array
+          items:
+            $ref: '#/components/schemas/OrderLine'
+        gifts:
+          type: array
+          items:
+            $ref: '#/components/schemas/OrderGift'
+        paymentProvider:
+          $ref: '#/components/schemas/OrderPaymentProvider'
+        countryCode:
+          $ref: '#/components/schemas/CountryCode'
+        storeGroupId:
+          $ref: '#/components/schemas/StoreGroupId'
+        shippingAddress:
+          $ref: '#/components/schemas/OrderAddress'
+        id:
+          type: string
+          description: The order id
+        billingAddress:
+          $ref: '#/components/schemas/OrderAddress'
+        discountOutcome:
+          $ref: '#/components/schemas/OrderDiscountOutcome'
+        giftCards:
+          type: array
+          items:
+            $ref: '#/components/schemas/OrderGiftCard'
+        currencyCode:
+          $ref: '#/components/schemas/CurrencyCode'
+        email:
+          type: string
+          description: Customer email
+          format: email
+  securitySchemes:
+    ApiKey:
+      type: apiKey
+      name: x-shopper-api-key
+      in: header
+    JWT:
+      type: http
+      scheme: bearer