Kibo Commerce Checkout Settings API

openapi: 3.2.0
info:
  title: Kibo Commerce Checkout Settings API
  version: '1.0'
  description: 'Operations tagged CheckoutSettings across 2 of this provider''s published API definitions: openapi_openapi_settings.json, kibo-commerce-settings-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Kibo Base URL
  url: '{baseUrl}/api'
  variables:
    baseUrl:
      default: https://t1000000.sb.usc1.gcp.kibocommerce.com
      description: Base URL
security:
- bearerAuth: []
tags:
- name: CheckoutSettings
paths:
  /commerce/settings/checkout/paymentsettings/thirdpartyworkflows/{fullyQualifiedName}:
    delete:
      description: Deletes a third party payment workflow definition defined for the site
      parameters:
      - in: path
        name: fullyQualifiedName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      summary: Delete Third Party Payment Workflow
      tags:
      - CheckoutSettings
      operationId: deleteCommerceSettingsCheckoutPaymentsettingsThirdpartyworkflowsByFullyQualifiedName
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/settings/checkout:
    get:
      description: 'Retrieves all checkout settings defined for the site: Payment settings, such as the payment gateway ID and credentials,supported credit cards,Customer Checkout settings whether login is required and any custom attributes; and Order Processing settings, such as when payment is authorized and captured, and any custom attributes.'
      parameters:
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutSettings'
            text/json:
              schema:
                $ref: '#/components/schemas/CheckoutSettings'
            text/plain:
              schema:
                $ref: '#/components/schemas/CheckoutSettings'
          description: OK
      summary: Get Checkout Settings
      tags:
      - CheckoutSettings
      operationId: getCommerceSettingsCheckout
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/settings/checkout/customercheckoutsettings:
    get:
      description: Retrieves existing customer checkout settings including the checkout type, which determines whether the customer must be logged in when placing an order. Also lists any custom customer checkout attributes.
      parameters:
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerCheckoutSettings'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerCheckoutSettings'
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerCheckoutSettings'
          description: OK
      summary: Get Customer Checkout Settings
      tags:
      - CheckoutSettings
      operationId: getCommerceSettingsCheckoutCustomercheckoutsettings
      x-operation-id-source: derived
    put:
      description: Modifies existing customer checkout settings. When a shopper starts the process of checking out,the Checkout Service checks these settings to render the checkout page.This is where you can specify whether shoppers must be logged in 'LoginRequired' or not 'LoginOptional' to checkout. You can also update your own customer checkout requirements, for example, to add a tracking code.
      parameters:
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerCheckoutSettings'
        description: Properties of the customer checkout settings to update.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerCheckoutSettings'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerCheckoutSettings'
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerCheckoutSettings'
          description: OK
      summary: Update Customer Checkout Settings
      tags:
      - CheckoutSettings
      operationId: putCommerceSettingsCheckoutCustomercheckoutsettings
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/settings/checkout/paymentsettings/thirdpartyworkflow/{fullyQualifiedName}:
    get:
      description: Gets a third party payment workflow specified by workflow definition. A third-party payment workflow is a definition of a process by which a third-party payment provider (such as Amazon Payments or PayPal Express) interacts with the Unified eCommerce platform.
      parameters:
      - in: path
        name: fullyQualifiedName
        required: true
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalPaymentWorkflowDefinition'
            text/json:
              schema:
                $ref: '#/components/schemas/ExternalPaymentWorkflowDefinition'
            text/plain:
              schema:
                $ref: '#/components/schemas/ExternalPaymentWorkflowDefinition'
          description: OK
      summary: Get Third Party Payment Workflow With Values
      tags:
      - CheckoutSettings
      operationId: getCommerceSettingsCheckoutPaymentsettingsThirdpartyworkflowByFullyQualifiedName
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/settings/checkout/paymentsettings/thirdpartyworkflows:
    get:
      description: Retrieves list of external payment workflow definitions. A third-party payment workflow is a definition of a process by which a third-party payment provider (such as Amazon Payments or PayPal Express) interacts with the Unified eCommerce platform.
      parameters:
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ExternalPaymentWorkflowDefinition'
                type: array
            text/json:
              schema:
                items:
                  $ref: '#/components/schemas/ExternalPaymentWorkflowDefinition'
                type: array
            text/plain:
              schema:
                items:
                  $ref: '#/components/schemas/ExternalPaymentWorkflowDefinition'
                type: array
          description: OK
      summary: Get Third Party Payment Workflows
      tags:
      - CheckoutSettings
      operationId: getCommerceSettingsCheckoutPaymentsettingsThirdpartyworkflows
      x-operation-id-source: derived
    put:
      description: Adds a third party payment workflow definition. A third-party payment workflow is a definition of a process by which a third-party payment provider (such as Amazon Payments or PayPal Express) interacts with the Unified eCommerce platform.
      parameters:
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalPaymentWorkflowDefinition'
      responses:
        '200':
          description: OK
      summary: Add Third Party Payment Workflow
      tags:
      - CheckoutSettings
      operationId: putCommerceSettingsCheckoutPaymentsettingsThirdpartyworkflows
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
components:
  schemas:
    PreAuthorizeDefinition:
      properties:
        id:
          format: int32
          type: integer
        preAuthorizeProdUrl:
          type:
          - string
          - 'null'
        preAuthorizeTestUrl:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/PreAuthorizeTransactionTypeDataContract'
      type: object
    ForceCaptureJob:
      description: Contains settings for when payments should be auto-captured regardless of shipment status.
      properties:
        captureAfterDays:
          format: int32
          type: integer
        interval:
          description: How often this job should run in minutes.
          format: int32
          type: integer
        isEnabled:
          description: Specifies whether this job should run.
          type: boolean
      type: object
    OrderJobSettings:
      description: Contains settings for the auto-capture payment feature.
      properties:
        autoCaptureJob:
          $ref: '#/components/schemas/AutoCaptureJob'
        forceCaptureJob:
          $ref: '#/components/schemas/ForceCaptureJob'
      type: object
    ThirdPartyPaymentSetting:
      properties:
        paymentProcessingFlowType:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
      type: object
    GatewayDefinition:
      properties:
        administationUi:
          items:
            type: object
          type:
          - array
          - 'null'
        countryCode:
          type:
          - string
          - 'null'
        credentialDefinitions:
          items:
            $ref: '#/components/schemas/GatewayCredentialFieldDefinition'
          type:
          - array
          - 'null'
        features:
          items:
            type: string
          type:
          - array
          - 'null'
        id:
          type:
          - string
          - 'null'
        integrationImplTypeName:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        preAuthorizeDefinition:
          $ref: '#/components/schemas/PreAuthorizeDefinition'
        prodServiceURL:
          type:
          - string
          - 'null'
        supportedCards:
          items:
            $ref: '#/components/schemas/SupportedCard'
          type:
          - array
          - 'null'
        testServiceURL:
          type:
          - string
          - 'null'
      type: object
    AutoCaptureJob:
      description: Contains settings for the auto-capture payment feature.
      properties:
        flexibleCapture:
          $ref: '#/components/schemas/FlexibleCapture'
        forceCaptureOnFirstCapture:
          description: Specifies whether all available funds should be collected once any shipment is ready for capture.
          type: boolean
        interval:
          description: How often this job should run in minutes.
          format: int32
          type: integer
        isEnabled:
          description: Specifies whether this job should run.
          type: boolean
      type: object
    CheckoutSettings:
      description: "Checkout and payment settings defined for this site. Can set which payment gateway to use, whether a shopper is required to login to place an order,\nwhen credit cards are authorized and charged (when the order is placed or shipped), and, in the future, \nwhether the checkout page displays an option for shoppers to receive your email marketing campaigns."
      properties:
        customerCheckoutSettings:
          $ref: '#/components/schemas/CustomerCheckoutSettings'
        orderProcessingSettings:
          $ref: '#/components/schemas/OrderProcessingSettings'
        paymentSettings:
          $ref: '#/components/schemas/PaymentSettings'
      type: object
    ThirdPartyCredentialField:
      description: Describes the name and value of a third party credential field.
      properties:
        apiName:
          description: The name of this credential that should be used for web requests.
          type:
          - string
          - 'null'
        displayName:
          description: The displayable name of this credential field
          type:
          - string
          - 'null'
        inputType:
          description: The input field type for the value.
          type:
          - string
          - 'null'
        isSensitive:
          description: the value holds sensitive information.
          type:
          - boolean
          - 'null'
        value:
          description: The value for this credential that should be used for web requests.
          type:
          - string
          - 'null'
        vocabularyValues:
          items:
            $ref: '#/components/schemas/VocabularyValue'
          type:
          - array
          - 'null'
      type: object
    SiteGatewaySupportedCard:
      properties:
        cardTypeId:
          type:
          - string
          - 'null'
        gatewayAccountId:
          type:
          - string
          - 'null'
        paymentType:
          type:
          - string
          - 'null'
        processingGatewayAccountId:
          type:
          - string
          - 'null'
      type: object
    PurchaseOrderPaymentDefinition:
      properties:
        allowSplitPayment:
          description: Indicates whether another payment can be used with the purchase order
          type: boolean
        customFields:
          description: ''
          items:
            $ref: '#/components/schemas/SiteSettingsPurchaseOrderCustomField'
          type:
          - array
          - 'null'
        isEnabled:
          description: Is purchase order payment enabled
          type: boolean
        paymentTerms:
          description: Allowed net terms
          items:
            $ref: '#/components/schemas/SiteSettingsPurchaseOrderPaymentTerm'
          type:
          - array
          - 'null'
      type: object
    CustomerCheckoutSettings:
      description: "Checkout requirements for customers, for example, whether they must login before purchasing from your store. \nOther customized checkout requirements can be defined."
      properties:
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        customerCheckoutType:
          description: 'Checkout login setting. Value can be either "LoginOptional," where shoppers are prompted to sign in

            but are not required to do so, or "LoginRequired," where shopppers must login before purchasing.'
          type:
          - string
          - 'null'
      type: object
    FlexibleCapture:
      description: Contains settings specifying whether the auto-capture payment feature should consider pre-fulfilled shipments.
      properties:
        bopisFlow:
          $ref: '#/components/schemas/FlexibleCaptureFlow'
        deliveryFlow:
          $ref: '#/components/schemas/FlexibleCaptureFlow'
        sthFlow:
          $ref: '#/components/schemas/FlexibleCaptureFlow'
      type: object
    Gateway:
      properties:
        areGatewayCredentialFieldsSet:
          description: Returns true if Gateway CredentialsField is set. For security purposes, Gateway subresource CredentialFields will not be returned.
          type: boolean
        gatewayAccount:
          $ref: '#/components/schemas/GatewayAccount'
        gatewayDefinition:
          $ref: '#/components/schemas/GatewayDefinition'
        siteGatewaySupportedCards:
          description: Which credit cards the Merchant supports
          items:
            $ref: '#/components/schemas/SiteGatewaySupportedCard'
          type:
          - array
          - 'null'
        supportedCards:
          description: Which credit cards the Merchant supports
          items:
            type: string
          type:
          - array
          - 'null'
      type: object
    FlexibleCaptureFlow:
      description: Specifies a pre-fulfilled shipment state that is eligible for capture.
      properties:
        captureBy:
          description: Look at the `ShipmentState` or the `ShipmentWorkflow`.
          type:
          - string
          - 'null'
        captureOn:
          description: Which shipment states or workflow statuses are considered eligible for capture.
          items:
            type: string
          type:
          - array
          - 'null'
      type: object
    VocabularyValue:
      properties:
        contents:
          items:
            $ref: '#/components/schemas/LocalizedContent'
          type:
          - array
          - 'null'
        key:
          type:
          - string
          - 'null'
      type: object
    OrderProcessingSettings:
      description: "Order processing (credit card payment authorization) setting defined for this site. \nCan choose when the shopper’s credit card is authorized and charged. Possibilities include, \"authorize and charge the shopper's credit card for the full \norder amount when the order is placed,\" \"authorize the shopper's credit card for the full amount when the order is placed and charge the credit card when the order is shipped,\" or \n\"authorize and charge the shopper's credit card for the full amount when the order is shipped.\""
      properties:
        abandonedOrderThresholdInMinutes:
          description: Abandoned Order Threshold in minutes indicates the number of minutes until a pending order is considered abandoned.
          format: int32
          type:
          - integer
          - 'null'
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        giftCardProcessingType:
          description: "Gift card payment authorization setting. Options can be authorize and charge the shopper's credit card when the order is placed, \"AuthorizeAndCaptureOnOrderPlacement,\" \nauthorize the shopper's gift card when the order is placed and charge the gift card when it is shipped, \"AuthorizeOnOrderPlacementAndCaptureOnOrderShipment,\" \nor authorize and charge the shopper's gift card for the full amount when the order is shipped, \"AuthorizeAndCaptureOnOrderShipment.\""
          type:
          - string
          - 'null'
        giftCardRefundCreditProcessingType:
          description: GiftCrd Refund/Credit flow, wither to existing or new giftcard
          type:
          - string
          - 'null'
        paymentProcessingFlowType:
          description: "Credit card payment authorization setting. Options can be authorize and charge the shopper's credit card when the order is placed, \"AuthorizeAndCaptureOnOrderPlacement,\" \nauthorize the shopper's credit card when the order is placed and charge the credit card when the shipped, \"AuthorizeOnOrderPlacementAndCaptureOnOrderShipment,\" \nor authorize and charge the shopper's credit card for the full amount when the order is shipped, \"AuthorizeAndCaptureOnOrderShipment.\""
          type:
          - string
          - 'null'
        thirdPartyPaymentSettings:
          description: 'Order processing settings for Third party payments

            Ex- ApplePay using AuthorizeOnOrderPlacementAndCaptureOnOrderShipment for processing orders'
          items:
            $ref: '#/components/schemas/ThirdPartyPaymentSetting'
          type:
          - array
          - 'null'
        useOverridePriceToCalculateDiscounts:
          description: Use the override price on products to calculate discounts
          type: boolean
      type: object
    PaymentSettings:
      description: "Payment gateway settings defined for this site. A payment gateway is an e-commerce application service provider that authorizes \npayments for e-businesses and online retailers. You can define multiple payment gateway settings but only one is active at a time. \nAuthorize.net is the only payment gateway supported currently."
      properties:
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        externalPaymentWorkflowDefinitions:
          items:
            $ref: '#/components/schemas/ExternalPaymentWorkflowDefinition'
          type:
          - array
          - 'null'
        gateways:
          items:
            $ref: '#/components/schemas/Gateway'
          type:
          - array
          - 'null'
        jobSettings:
          $ref: '#/components/schemas/OrderJobSettings'
        payByMail:
          type: boolean
        paymentRanking:
          type:
          - string
          - 'null'
        purchaseOrder:
          $ref: '#/components/schemas/PurchaseOrderPaymentDefinition'
        refundRanking:
          type:
          - string
          - 'null'
      type: object
    GatewayCredentialFieldDefinition:
      properties:
        adminDisplayOrder:
          format: int32
          type: integer
        displayName:
          type:
          - string
          - 'null'
        isPublic:
          type: boolean
        name:
          type:
          - string
          - 'null'
      type: object
    PreAuthorizeTransactionTypeDataContract:
      properties:
        description:
          type:
          - string
          - 'null'
        id:
          format: int32
          type: integer
        type:
          type:
          - string
          - 'null'
      type: object
    AuditInfo:
      properties:
        createBy:
          type:
          - string
          - 'null'
        createDate:
          format: date-time
          type:
          - string
          - 'null'
        updateBy:
          type:
          - string
          - 'null'
        updateDate:
          format: date-time
          type:
          - string
          - 'null'
      type: object
    SiteSettingsPurchaseOrderCustomField:
      properties:
        code:
          description: Unique code/name for memo field
          type:
          - string
          - 'null'
        isEnabled:
          description: Whether this memo field is enabled
          type: boolean
        isRequired:
          description: Whether this memo field is mandatory to be filled in when placing an order
          type: boolean
        label:
          description: Memo field label that appers on the store front
          type:
          - string
          - 'null'
        sequenceNumber:
          description: Sequence Number
          format: int32
          type: integer
      type: object
    GatewayAccount:
      properties:
        binPatterns:
          items:
            type: string
          type:
          - array
          - 'null'
        countryCode:
          type:
          - string
          - 'null'
        credentialFields:
          items:
            $ref: '#/components/schemas/GatewayCredentialFieldValue'
          type:
          - array
          - 'null'
        gatewayDefinitionId:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        isActive:
          type: boolean
        name:
          type:
          - string
          - 'null'
      type: object
    SupportedCard:
      properties:
        friendlyName:
          type:
          - string
          - 'null'
        paymentType:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
      type: object
    LocalizedContent:
      properties:
        localeCode:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
      type: object
    ExternalPaymentWorkflowDefinition:
      description: 'This class describes credentials and enablement for the various third-party payment workflows that we will integrate with.

        Examples include Paypal Express, Amazon Payments, Google Wallet, etc.'
      properties:
        credentials:
          items:
            $ref: '#/components/schemas/ThirdPartyCredentialField'
          type:
          - array
          - 'null'
        description:
          description: 'Information about this definition for display purposes in the ''Payment and Checkout Settings''

            admin ui.  This field may contain valid html tags'
          type:
          - string
          - 'null'
        fullyQualifiedName:
          type:
          - string
          - 'null'
        isEnabled:
          type: boolean
        isLegacy:
          description: 'Indicates if this is a legacy implementation using ARC only

            or using the new extensible implementation.'
          type:
          - boolean
          - 'null'
        name:
          description: Should be one of Contracts.Constants.ThirdPartyWorkflowNames.
          type:
          - string
          - 'null'
        namespace:
          type:
          - string
          - 'null'
      type: object
    SiteSettingsPurchaseOrderPaymentTerm:
      properties:
        code:
          description: A unique code for purchase order payment term
          type:
          - string
          - 'null'
        description:
          description: Value of the net term
          type:
          - string
          - 'null'
        sequenceNumber:
          description: Sequence Number
          format: int32
          type: integer
      type: object
    GatewayCredentialFieldValue:
      properties:
        isValueSet:
          type: boolean
        name:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: JWT Authorization header using the Bearer scheme.
      scheme: bearer
      type: http
x-refined-from:
- openapi_openapi_settings.json
- kibo-commerce-settings-openapi.yml