Kibo Commerce Storefront Auth Ticket API

openapi: 3.2.0
info:
  title: Kibo Commerce Storefront Auth Ticket API
  version: '1.0'
  description: 'Operations tagged StorefrontAuthTicket across 2 of this provider''s published API definitions: openapi_openapi_customer.json, kibo-commerce-customer-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: StorefrontAuthTicket
paths:
  /commerce/customer/authtickets/anonymousshopper:
    get:
      description: Authenticates anonymous shopper for the site.
      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/CustomerAuthTicket'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
          description: OK
      summary: Create Anonymous Shopper Auth Ticket
      tags:
      - StorefrontAuthTicket
      operationId: getCommerceCustomerAuthticketsAnonymousshopper
      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/customer/authtickets/2fa/auth:
    post:
      description: Validates the 2FA details provided by the user and creates an authentication ticket
      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/AuthTicket2FAInfo'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
          description: OK
      summary: Create Auth Ticket
      tags:
      - StorefrontAuthTicket
      operationId: postCommerceCustomerAuthtickets2faAuth
      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/customer/authtickets:
    post:
      description: Authenticates a user for a particular site given a set of user credentials.
      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/CustomerUserAuthInfo'
        description: User's email address and password.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
          description: OK
      summary: Create User Auth Ticket
      tags:
      - StorefrontAuthTicket
      operationId: postCommerceCustomerAuthtickets
      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/customer/authtickets/2fa/request:
    post:
      description: Generates a 6-digit 2FA code and sends it to the user's email
      parameters:
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          description: OK
      summary: Generate 2FA Code
      tags:
      - StorefrontAuthTicket
      operationId: postCommerceCustomerAuthtickets2faRequest
      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/customer/authtickets/otp/request:
    post:
      description: Generates a 6-digit OTP code and sends it to the user's email
      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/OtpRequest'
        description: Request containing email address.
      responses:
        '200':
          description: OK
      summary: Generate OTP Code
      tags:
      - StorefrontAuthTicket
      operationId: postCommerceCustomerAuthticketsOtpRequest
      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/customer/authtickets/impersonatecart:
    post:
      description: Impersonates a cart.
      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/CartAuthTicketRequest'
        description: ''
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
          description: OK
      summary: Impersonate Cart
      tags:
      - StorefrontAuthTicket
      operationId: postCommerceCustomerAuthticketsImpersonatecart
      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/customer/authtickets/refresh:
    put:
      description: Refreshes a user's authentication.
      parameters:
      - description: The user's refresh token.
        in: query
        name: refreshToken
        schema:
          type: string
      - description: Account Id specifies the account for which the user requests an authentication token.
        in: query
        name: accountId
        schema:
          format: int32
          type: integer
      - 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/CustomerAuthTicket'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
          description: OK
      summary: Refresh User Auth Ticket
      tags:
      - StorefrontAuthTicket
      operationId: putCommerceCustomerAuthticketsRefresh
      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/customer/authtickets/otp/auth:
    post:
      description: Validates the OTP details provided by the Admin and creates an authentication ticket
      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/AuthTicketOtpInfo'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerAuthTicket'
          description: OK
      summary: Validate OTP
      tags:
      - StorefrontAuthTicket
      operationId: postCommerceCustomerAuthticketsOtpAuth
      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:
    AuthTicketOtpInfo:
      properties:
        email:
          type:
          - string
          - 'null'
        fingerprint:
          type:
          - string
          - 'null'
        otpCode:
          type:
          - string
          - 'null'
        region:
          type:
          - string
          - 'null'
      type: object
    CustomerUserAuthInfo:
      properties:
        accountId:
          description: Account Id specifies the account for which the user requests an authentication token.
          format: int32
          type:
          - integer
          - 'null'
        authTicketTtlMinutes:
          description: 'Optional requested duration for the authentication ticket in minutes.

            Must not exceed tenant configuration or platform hard caps.

            Requires ''customer-auth:configure-token-durations'' behavior.'
          format: int32
          type:
          - integer
          - 'null'
        fingerprint:
          description: Specifies the fingerprint of the user for two-factor authentication.
          type:
          - string
          - 'null'
        password:
          type:
          - string
          - 'null'
        refreshTokenTtlMinutes:
          description: 'Optional requested duration for the refresh token in minutes.

            Must not exceed tenant configuration or platform hard caps.

            Requires ''customer-auth:configure-token-durations'' behavior.'
          format: int32
          type:
          - integer
          - 'null'
        region:
          description: Specifies the region of the user for two-factor authentication.
          type:
          - string
          - 'null'
        username:
          type:
          - string
          - 'null'
      type: object
    CustomerAccount:
      description: "Customer account. Customers provide contact information, view order history, and set email preferences on their account. \nMerchants can edit accounts to add internal notes or assign them to segments."
      properties:
        acceptsMarketing:
          description: If true, the customer prefers to receive marketing material such as newsletters or email offers.
          type: boolean
        accountType:
          description: Type of account.
          type:
          - string
          - 'null'
        attributes:
          description: List of attributes for the account.
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          type:
          - array
          - 'null'
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        commerceSummary:
          $ref: '#/components/schemas/CommerceSummary'
        companyOrOrganization:
          description: The company or organization name for an account.
          type:
          - string
          - 'null'
        contacts:
          description: List of contacts for this account. A customer account can have multiple contacts for billing and shipping addresses.
          items:
            $ref: '#/components/schemas/CustomerContact'
          type:
          - array
          - 'null'
        customerSet:
          type:
          - string
          - 'null'
        customerSinceDate:
          description: Date when the customer account is created.
          format: date-time
          type:
          - string
          - 'null'
        emailAddress:
          description: '"Email addresss of the customer.'
          type:
          - string
          - 'null'
        externalId:
          type:
          - string
          - 'null'
        firstName:
          description: First name of the customer.
          type:
          - string
          - 'null'
        hasExternalPassword:
          description: Indicates if an external password is set on this account
          type: boolean
        id:
          description: Unique identifier of the account, also known as a customer number.
          format: int32
          type: integer
        isActive:
          description: Is the account active?
          type: boolean
        isAnonymous:
          description: Is the account Anonymous?
          type: boolean
        isLocked:
          description: Is the account locked?
          type: boolean
        last2FaDate:
          format: date-time
          type:
          - string
          - 'null'
        lastName:
          description: Last name of the customer.
          type:
          - string
          - 'null'
        localeCode:
          description: Locale Code.
          type:
          - string
          - 'null'
        migrationRequired:
          description: Indicates Subscription migration is required or not.
          type: boolean
        notes:
          description: "List of notes for the account. Merchants use these internal notes, for example, to make a note of a customer's interests or complaints. \nNotes are available only from the merchant's view, customers cannot view these notes."
          items:
            $ref: '#/components/schemas/CustomerNote'
          type:
          - array
          - 'null'
        segments:
          description: "List of segments assigned to account. Merchants create segments, for example, to manage discounts or assign VIP status. \nThen they assign the account to the segment. An account can belong to several segments or none at all."
          items:
            $ref: '#/components/schemas/CustomerSegment'
          type:
          - array
          - 'null'
        taxExempt:
          type: boolean
        taxId:
          type:
          - string
          - 'null'
        userId:
          description: Unique identifier of the user who is currently logged in. This is null if the user is anonymous (not logged in).  Unicode data with a maximum length of 55 characters.
          type:
          - string
          - 'null'
        userName:
          description: User name for the customer account.
          type:
          - string
          - 'null'
      type: object
    ContactType:
      properties:
        isPrimary:
          type: boolean
        name:
          type:
          - string
          - 'null'
      type: object
    CommerceSummary:
      description: Commerce (orders and wishlists) on a customer account which lists all the orders the customer has made with the order date, order amount, and status. Includes cancellations and returns.  Also includes wishlist information.
      properties:
        lastOrderDate:
          description: When the last order was placed.
          format: date-time
          type:
          - string
          - 'null'
        orderCount:
          description: Number of orders listed in the order history of a customer account.
          format: int32
          type: integer
        totalOrderAmount:
          $ref: '#/components/schemas/CurrencyAmount'
        visitsCount:
          description: Number of visits for this customer across the entire tenant.
          format: int32
          type: integer
        wishlistCount:
          description: Number of wishlists listed in the wishlist count of a customer account
          format: int32
          type: integer
      type: object
    CartAuthTicketRequest:
      description: ''
      properties:
        accountId:
          description: Account Id of the user.
          format: int32
          type: integer
        cartId:
          description: Cart Id of the user
          type:
          - string
          - 'null'
        userId:
          description: User Id of the user.
          type:
          - string
          - 'null'
      type: object
    OtpRequest:
      description: Request for generating a one-time password (OTP)
      properties:
        email:
          description: Email address for which to generate the OTP code
          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
    CustomerContact:
      description: CustomerContact information for a customer account including the name, company, phone numbers, email addresses, and billing and shipping addresses (if supplied).
      properties:
        accountId:
          format: int32
          type: integer
        address:
          $ref: '#/components/schemas/Address'
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        companyOrOrganization:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
        faxNumber:
          type:
          - string
          - 'null'
        firstName:
          type:
          - string
          - 'null'
        id:
          format: int32
          type:
          - integer
          - 'null'
        label:
          type:
          - string
          - 'null'
        lastNameOrSurname:
          type:
          - string
          - 'null'
        middleNameOrInitial:
          type:
          - string
          - 'null'
        phoneNumbers:
          $ref: '#/components/schemas/Phone'
        types:
          items:
            $ref: '#/components/schemas/ContactType'
          type:
          - array
          - 'null'
      type: object
    CustomerAttribute:
      properties:
        attributeDefinitionId:
          format: int32
          type:
          - integer
          - 'null'
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        fullyQualifiedName:
          type:
          - string
          - 'null'
        values:
          items: {}
          type:
          - array
          - 'null'
      type: object
    CurrencyAmount:
      description: The currency code and amount of an order listed in the order history of a customer account. Currently, only USD is supported.
      properties:
        amount:
          description: Total amount of the order. Currently, only US dollar amounts are supported.
          format: double
          type: number
        currencyCode:
          description: Currency code for the amount of the order. Currently, only "USD" is supported.
          type:
          - string
          - 'null'
      type: object
    AuthTicket2FAInfo:
      properties:
        otpCode:
          type:
          - string
          - 'null'
        userId:
          type:
          - string
          - 'null'
      type: object
    CustomerNote:
      description: Note added to the customer account. Merchants can add internal notes, for example, to keep track of a customer's interests or complaints.
      properties:
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        content:
          description: Content of the note that the merchant added.
          type:
          - string
          - 'null'
        id:
          description: Unique identifier of the note.
          format: int32
          type: integer
      type: object
    Phone:
      properties:
        home:
          type:
          - string
          - 'null'
        mobile:
          type:
          - string
          - 'null'
        work:
          type:
          - string
          - 'null'
      type: object
    Address:
      properties:
        address1:
          type:
          - string
          - 'null'
        address2:
          type:
          - string
          - 'null'
        address3:
          type:
          - string
          - 'null'
        address4:
          type:
          - string
          - 'null'
        addressType:
          type:
          - string
          - 'null'
        cityOrTown:
          type:
          - string
          - 'null'
        countryCode:
          type:
          - string
          - 'null'
        isValidated:
          type:
          - boolean
          - 'null'
        postalOrZipCode:
          type:
          - string
          - 'null'
        stateOrProvince:
          type:
          - string
          - 'null'
      type: object
    CustomerSegment:
      description: A customer segment.
      properties:
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        code:
          description: Unique identifier of the customer segment.
          type:
          - string
          - 'null'
        description:
          description: Description of the customer segment.
          type:
          - string
          - 'null'
        id:
          description: Unique identifier of the customer segment.
          format: int32
          type: integer
        name:
          description: Name of the customer segment.
          type:
          - string
          - 'null'
      type: object
    CustomerAuthTicket:
      properties:
        accessToken:
          type:
          - string
          - 'null'
        accessTokenExpiration:
          format: date-time
          type: string
        customerAccount:
          $ref: '#/components/schemas/CustomerAccount'
        jwtAccessToken:
          type:
          - string
          - 'null'
        refreshToken:
          type:
          - string
          - 'null'
        refreshTokenExpiration:
          format: date-time
          type: string
        requires2FA:
          type: boolean
        userId:
          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_customer.json
- kibo-commerce-customer-openapi.yml
x-provenance:
  method: harvested
  publisher: Kibo Commerce
  source: https://docs.kibocommerce.com/openapi/openapi_customer.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)