> ## Documentation Index
> Fetch the complete documentation index at: https://www.commercengine.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Configure a service provider

> Configure a service provider.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json post /store/service-providers
openapi: 3.1.0
info:
  title: CE Admin APIs
  version: '1.0'
  summary: Comprehensive admin interface for managing your e-commerce platform
  description: >-
    Complete administrative API suite for Commerce Engine, providing powerful
    tools to manage products, orders, customers, inventory, analytics, and
    system configuration. Designed for administrators and backend integrations
    requiring full platform control.
  license:
    name: All Rights Reserved
    url: https://www.commercengine.io/contact-us
  contact:
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
    name: Support
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/admin
    description: Staging Server
    variables:
      store_id:
        default: store_id
        description: Store ID
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/admin
    description: Prod Server
    variables:
      store_id:
        default: store_id
        description: Store ID
security:
  - Authorization: []
tags:
  - name: Analytics
    description: Analytics
  - name: Catalog
    description: Catalog
  - name: Coupons & promotions
    description: Coupons & promotions
  - name: Customers
    description: Customers
  - name: Filter Options
    description: Filter Options
  - name: Inventories
    description: Inventories
  - name: Marketplace
    description: Marketplace
  - name: Marketplace Catalog
    description: Marketplace Catalog
  - name: Media Gallery
    description: Media Gallery
  - name: Metrics
    description: Metrics
  - name: Orders
    description: Orders
  - name: Payments
    description: Payments
  - name: Payouts
    description: Payouts
  - name: POS
    description: POS
  - name: Segments
    description: Segments
  - name: Shipping
    description: Shipping
  - name: SSE
    description: SSE
  - name: Store
    description: Store
  - name: Webhooks
    description: Webhooks
paths:
  /store/service-providers:
    parameters: []
    post:
      tags:
        - Store
      summary: Configure a service provider
      description: Configure a service provider.
      operationId: create-service-provider-config
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  required:
                    - service_provider_id
                  properties:
                    service_provider_id:
                      type: string
                - oneOf:
                    - $ref: '#/components/schemas/CreateShippingServiceProvider'
                    - $ref: '#/components/schemas/CreateOtherServiceProvider'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      service_provider:
                        $ref: '#/components/schemas/ServiceProvider'
                    type: object
components:
  schemas:
    CreateShippingServiceProvider:
      title: CreateShippingServiceProvider
      type: object
      required:
        - api_credentials
        - warehouse_id
        - shipping_zone_id
      properties:
        api_credentials:
          description: >-
            json object in key & value pair. Keys must match with params
            specified in required_credentials_params object (input_field_name).
          type: object
        warehouse_id:
          type: array
          items:
            type: string
          writeOnly: true
        shipping_zone_id:
          type: array
          items:
            type: string
          writeOnly: true
      x-tags:
        - Store
    CreateOtherServiceProvider:
      title: CreateOtherServiceProvider
      type: object
      required:
        - api_credentials
      properties:
        api_credentials:
          description: >-
            json object in key & value pair. Keys must match with params
            specified in required_credentials_params object (input_field_name).
          type: object
      x-tags:
        - Store
    ServiceProvider:
      title: ServiceProvider
      description: >-
        Third-party service integration returned from store service-provider
        APIs. Combines catalog metadata, connection state, and type-specific
        fields (for example shipping `warehouses` and `shipping_zone`).
      allOf:
        - $ref: '#/components/schemas/StoreConfigServiceProvider'
      x-tags:
        - Store
    StoreConfigServiceProvider:
      title: StoreConfigServiceProvider
      allOf:
        - $ref: '#/components/schemas/OtherServiceProvider'
        - type: object
          properties:
            api_credentials:
              description: >-
                Connected credential values. Keys match
                `required_credentials_params[].input_field_name`. Returned as
                `null`, or as an empty array `[]`, when the provider has no
                stored credentials.
              type:
                - object
                - array
                - 'null'
              additionalProperties: true
              readOnly: true
            alias:
              type: string
            logo:
              description: >-
                Primary logo URL. Same as `logo_light` for `auto` providers;
                `null` for `manual` methods.
              type:
                - string
                - 'null'
              readOnly: true
            service_sub_type:
              type:
                - string
                - 'null'
            used_in_credit_line:
              description: >-
                `true` when the option is linked in the store credit-line
                payment method configuration.
              type: boolean
              readOnly: true
            used_in_payout:
              description: >-
                `true` when the option is linked in the store `payout`
                configuration.
              type: boolean
              readOnly: true
            warehouses:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
              readOnly: true
            shipping_zone:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
              readOnly: true
            fulfillment_type:
              description: Present on shipping providers.
              type: string
              enum:
                - delivery
              readOnly: true
            type:
              description: Present on shipping providers (`auto` fulfillment integrations).
              type: string
              enum:
                - auto
              readOnly: true
            is_forward_shipping:
              type: boolean
              default: false
              readOnly: true
            is_return_shipping:
              type: boolean
              default: false
              readOnly: true
      x-tags:
        - Store
    OtherServiceProvider:
      title: OtherServiceProvider
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        alias:
          type: string
          readOnly: true
        logo:
          description: Primary logo URL. Same as `logo_light` for most providers.
          type:
            - string
            - 'null'
          readOnly: true
        service_sub_type:
          type:
            - string
            - 'null'
          readOnly: true
        service_type:
          $ref: '#/components/schemas/ServiceProviderType'
          readOnly: true
        description:
          type: string
          readOnly: true
        short_description:
          type: string
          readOnly: true
        logo_dark:
          type:
            - string
            - 'null'
          readOnly: true
        logo_light:
          type:
            - string
            - 'null'
          readOnly: true
        website_url:
          type:
            - string
            - 'null'
          readOnly: true
        api_doc_url:
          type:
            - string
            - 'null'
          readOnly: true
        required_credentials_params:
          description: json object in key & value pair.
          type: array
          items:
            type: object
            properties:
              input_field_name:
                type: string
              input_field_label:
                type: string
              input_field_type:
                enum:
                  - text
                  - number
                  - boolean
                  - email
                  - password
          readOnly: true
        is_connected:
          type: boolean
          default: false
          readOnly: true
        is_connection_expired:
          type: boolean
          default: true
          readOnly: true
        supports_test_connection:
          type: boolean
          default: true
          readOnly: true
        api_credentials:
          description: >-
            Connected credential values. Keys match
            `required_credentials_params[].input_field_name`. Returned as
            `null`, or as an empty array `[]`, when the provider has no stored
            credentials.
          type:
            - object
            - array
            - 'null'
          additionalProperties: true
          readOnly: true
        status:
          default: active
          enum:
            - active
            - inactive
            - error
        features:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              description:
                type: string
              is_supported:
                type: boolean
              features:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    description:
                      type: string
                    is_supported:
                      type: boolean
          readOnly: true
      x-tags:
        - Store
    ServiceProviderType:
      title: ServiceProviderType
      description: The type of third-party service integration.
      type: string
      enum:
        - shipping
        - payment
        - chat
        - cms
        - analytics
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.