brinkcommerce-dev-mcp 0.1.0-beta.1

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

@@ -0,0 +1,771 @@
+openapi: 3.0.1
+info:
+  title: StoreManagement
+  version: '1'
+servers:
+  - url: https://management.eu-west-1.CUSTOMER_NAME.brinkcommerce.io/store
+security:
+  - OAuth2:
+      - store-management/store:write
+      - store-management/store:read
+paths:
+  /store-groups:
+    get:
+      operationId: GetStoreGroups
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetStoreGroupsResponse'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: 401 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      security:
+        - OAuth2:
+            - store-management/store:read
+        - api_key: []
+      x-hideTryItPanel: true
+  /store-groups/{storeGroupId}/markets/{countryCode}:
+    put:
+      operationId: PutStoreMarket
+      parameters:
+        - name: countryCode
+          in: path
+          required: true
+          schema:
+            $ref: '#/components/schemas/CountryCode'
+        - name: storeGroupId
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PutStoreMarketRequest'
+        required: true
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/StoreMarket'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: 401 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '415':
+          description: 415 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      security:
+        - OAuth2:
+            - store-management/store:write
+        - api_key: []
+      x-hideTryItPanel: true
+    delete:
+      operationId: DeleteStoreMarket
+      parameters:
+        - name: countryCode
+          in: path
+          required: true
+          schema:
+            $ref: '#/components/schemas/CountryCode'
+        - name: storeGroupId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: 204 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: 401 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      security:
+        - OAuth2:
+            - store-management/store:write
+        - api_key: []
+      x-hideTryItPanel: true
+    patch:
+      operationId: PatchStoreMarket
+      parameters:
+        - name: countryCode
+          in: path
+          required: true
+          schema:
+            $ref: '#/components/schemas/CountryCode'
+        - name: storeGroupId
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PatchStoreMarketRequest'
+        required: true
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/StoreMarket'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: 401 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '415':
+          description: 415 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      security:
+        - OAuth2:
+            - store-management/store:write
+        - api_key: []
+      x-hideTryItPanel: true
+  /store-groups/{storeGroupId}:
+    get:
+      operationId: GetStoreGroup
+      parameters:
+        - name: storeGroupId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/StoreGroup'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: 401 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'
+      security:
+        - OAuth2:
+            - store-management/store:read
+        - api_key: []
+      x-hideTryItPanel: true
+    put:
+      operationId: PutStoreGroup
+      parameters:
+        - name: storeGroupId
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PutStoreGroupRequest'
+        required: true
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/StoreGroup'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: 401 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '415':
+          description: 415 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      security:
+        - OAuth2:
+            - store-management/store:write
+        - api_key: []
+      x-hideTryItPanel: true
+    delete:
+      operationId: DeleteStoreGroup
+      parameters:
+        - name: storeGroupId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: 204 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: 401 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      security:
+        - OAuth2:
+            - store-management/store:write
+        - api_key: []
+      x-hideTryItPanel: true
+    patch:
+      operationId: PatchStoreGroup
+      parameters:
+        - name: storeGroupId
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PatchStoreGroupRequest'
+        required: true
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/StoreGroup'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: 401 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '415':
+          description: 415 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      security:
+        - OAuth2:
+            - store-management/store:write
+        - api_key: []
+      x-hideTryItPanel: true
+  /store-groups/{storeGroupId}/markets:
+    get:
+      operationId: GetStoreMarkets
+      parameters:
+        - name: storeGroupId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: 200 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetStoreMarketsResponse'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: 401 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'
+      security:
+        - OAuth2:
+            - store-management/store:read
+        - api_key: []
+      x-hideTryItPanel: true
+components:
+  schemas:
+    ChannelType:
+      type: string
+      description: The channel type used for the store group (B2C or B2B). Cannot be edited.
+      enum:
+        - B2C
+        - B2B
+      default: B2C
+    StoreGroup:
+      title: StoreGroup
+      required:
+        - channelType
+        - created
+        - description
+        - id
+        - name
+        - updated
+      type: object
+      properties:
+        countryOfSale:
+          type: string
+          description: Home country of the selling entity (ISO-3166-1 alpha-2). Used in B2B tax calculations
+          pattern: ^[A-Z]{2}$
+        created:
+          type: string
+          description: When the store group was created
+          format: date-time
+        name:
+          type: string
+          description: A descriptive name of the store group
+        description:
+          type: string
+          description: A description of the store group
+        channelType:
+          $ref: '#/components/schemas/ChannelType'
+        id:
+          type: string
+          description: Id of the store group
+        updated:
+          type: string
+          description: When the store group was last updated
+          format: date-time
+    GetStoreGroupsResponse:
+      title: GetStoreGroupsResponse
+      type: object
+      required:
+        - storeGroups
+      properties:
+        storeGroups:
+          type: array
+          description: A list of store groups
+          items:
+            $ref: '#/components/schemas/StoreGroup'
+    ErrorResponse:
+      title: Error
+      type: object
+      properties:
+        requestId:
+          type: string
+          description: The request id
+        error:
+          type: string
+          description: The error message
+    CountryCode:
+      type: string
+      description: ISO 3166-1 alpha-2 country code
+      maxLength: 2
+      minLength: 2
+      pattern: ^[A-Z]{2}$
+    ShippingProviderType:
+      type: string
+      description: Type of shipping provider
+      enum:
+        - Ingrid
+        - Nshift
+    ShippingProvider:
+      required:
+        - id
+        - type
+      type: object
+      properties:
+        id:
+          type: string
+          description: Identifier of shipping provider
+        type:
+          $ref: '#/components/schemas/ShippingProviderType'
+    GiftCardProviderType:
+      type: string
+      description: Type of gift card provider
+      enum:
+        - BSGGiftCard
+        - KBSGiftCard
+        - Retain24
+    GiftCardProvider:
+      required:
+        - id
+        - type
+      type: object
+      properties:
+        id:
+          type: string
+          description: Identifier of gift card provider
+        type:
+          $ref: '#/components/schemas/GiftCardProviderType'
+    PaymentProviderType:
+      type: string
+      description: Type of payment provider
+      enum:
+        - Adyen
+        - Avarda
+        - KlarnaCheckout
+        - SveaCheckout
+        - WalleyCheckout
+        - QliroOne
+        - Zaver
+        - Ledyer
+    PaymentProvider:
+      required:
+        - id
+        - type
+      type: object
+      properties:
+        id:
+          type: string
+          description: Identifier of payment provider
+        type:
+          $ref: '#/components/schemas/PaymentProviderType'
+    Capabilities:
+      type: object
+      description: Payment, shipping, gift card providers
+      required:
+        - paymentProviders
+      properties:
+        shippingProviders:
+          type: array
+          description: Shipping providers
+          items:
+            $ref: '#/components/schemas/ShippingProvider'
+        giftCardProviders:
+          type: array
+          description: Gift card providers
+          items:
+            $ref: '#/components/schemas/GiftCardProvider'
+        paymentProviders:
+          type: array
+          description: Payment providers
+          items:
+            $ref: '#/components/schemas/PaymentProvider'
+    CartCapabilityBonus:
+      type: object
+      description: Bonus config
+      required:
+        - id
+      properties:
+        id:
+          type: string
+          description: Identifier of bonus config
+    CartCapabilityVoyado:
+      type: object
+      description: Voyado config
+      required:
+        - id
+      properties:
+        id:
+          type: string
+          description: Identifier of voyado config
+    CartCapabilityRetain24:
+      type: object
+      description: Retain24 config
+      required:
+        - id
+      properties:
+        id:
+          type: string
+          description: Identifier of retain24 config
+    CartCapabilities:
+      title: CartCapabilities
+      type: object
+      description: Capabilities for cart
+      properties:
+        bonus:
+          $ref: '#/components/schemas/CartCapabilityBonus'
+        voyado:
+          $ref: '#/components/schemas/CartCapabilityVoyado'
+        retain24:
+          $ref: '#/components/schemas/CartCapabilityRetain24'
+    PutStoreMarketRequest:
+      title: PutStoreMarketRequest
+      required:
+        - currencyCode
+        - isTaxIncludedInPrice
+      type: object
+      properties:
+        isTaxExemptionEligible:
+          type: boolean
+          description: If the market is eligible for tax exemption. Should typically be set to true for all B2B markets except the home market of the merchant
+        isTaxIncludedInPrice:
+          type: boolean
+          description: If tax is included in the price for this store in this country. This can only be set to true if channel type is B2C
+        capabilities:
+          $ref: '#/components/schemas/Capabilities'
+        cartCapabilities:
+          $ref: '#/components/schemas/CartCapabilities'
+        currencyCode:
+          pattern: ^[A-Z]{3}$
+          type: string
+          description: A ISO 4217 code of the currency used in this store in this country
+    StoreMarket:
+      title: StoreMarket
+      required:
+        - countryCode
+        - created
+        - currencyCode
+        - description
+        - isArchived
+        - isTaxExemptionEligible
+        - isTaxIncludedInPrice
+        - name
+        - storeGroupId
+        - updated
+      type: object
+      properties:
+        countryOfSale:
+          pattern: ^[A-Z]{2}$
+          type: string
+          description: Home country of the selling entity (ISO-3166-1 alpha-2). Used for B2B tax calculations
+        isTaxExemptionEligible:
+          type: boolean
+          description: If the market is eligible for tax exemption. Should typically be set to true for all B2B markets except the home market of the merchant
+        isTaxIncludedInPrice:
+          type: boolean
+          description: If tax is included in the price for this store in this country
+        capabilities:
+          $ref: '#/components/schemas/Capabilities'
+        isArchived:
+          type: boolean
+          description: If this country is archived for this store
+        created:
+          type: string
+          description: When this country was added to the store market
+          format: date-time
+        description:
+          type: string
+          description: A description of the store group
+        channelType:
+          $ref: '#/components/schemas/ChannelType'
+        storeGroupId:
+          type: string
+          description: Id of the store group
+        countryCode:
+          $ref: '#/components/schemas/CountryCode'
+        name:
+          type: string
+          description: A descriptive name of the store group
+        cartCapabilities:
+          $ref: '#/components/schemas/CartCapabilities'
+        currencyCode:
+          pattern: ^[A-Z]{3}$
+          type: string
+          description: A ISO 4217 code of the currency used in this store in this country
+        updated:
+          type: string
+          description: When this country was last updated for this store market
+          format: date-time
+    PatchStoreMarketRequest:
+      title: PatchStoreMarketRequest
+      type: object
+      properties:
+        isTaxExemptionEligible:
+          type: boolean
+          description: If the market is eligible for tax exemption. Should typically be set to true for all B2B markets except the home market of the merchant
+        isTaxIncludedInPrice:
+          type: boolean
+          description: If tax is included in the price for this store in this country. This can only be set to true if channel type is B2C
+          default: false
+        capabilities:
+          $ref: '#/components/schemas/Capabilities'
+        isArchived:
+          type: boolean
+          description: If this country is archived for this store
+        cartCapabilities:
+          $ref: '#/components/schemas/CartCapabilities'
+        currencyCode:
+          pattern: ^[A-Z]{3}$
+          type: string
+          description: A ISO 4217 code of the currency used in this store in this country
+    PutStoreGroupRequest:
+      title: PutStoreGroupRequest
+      required:
+        - description
+        - name
+      type: object
+      properties:
+        countryOfSale:
+          type: string
+          description: Home country of the selling entity (ISO-3166-1 alpha-2). Used for B2B tax calculations
+          pattern: ^[A-Z]{2}$
+        name:
+          type: string
+          description: A descriptive name of the store group
+        description:
+          type: string
+          description: A description of the store group
+        channelType:
+          $ref: '#/components/schemas/ChannelType'
+    PatchStoreGroupRequest:
+      title: PatchStoreGroupRequest
+      type: object
+      properties:
+        countryOfSale:
+          type: string
+          description: Home country of the selling entity (ISO-3166-1 alpha-2). Used for tax calculations and is required if "channelType" is B2B.
+          pattern: ^[A-Z]{2}$
+          nullable: true
+        name:
+          type: string
+          description: A descriptive name of the store group
+        description:
+          type: string
+          description: A description of the store group
+    GetStoreMarketsResponse:
+      title: GetStoreMarketsResponse
+      type: object
+      required:
+        - storeMarkets
+      properties:
+        storeMarkets:
+          type: array
+          description: A list of markets for the store group
+          items:
+            $ref: '#/components/schemas/StoreMarket'
+  securitySchemes:
+    OAuth2:
+      type: oauth2
+      flows:
+        clientCredentials:
+          tokenUrl: TOKEN_URL
+          scopes:
+            store-management/store:write: Store write access
+            store-management/store:read: Store read-only access
+    api_key:
+      type: apiKey
+      name: x-api-key
+      in: header