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

# Connect a WooCommerce store

> Connect a WooCommerce store to the tenant by storing its REST API keys. The store URL must use HTTPS and pass an SSRF safety check; the keys are validated against the store's Orders endpoint, encrypted at rest, and the marketplace card flips to Connected. Requires an admin role. Send the store URL plus the WooCommerce consumer key and secret.



## OpenAPI

````yaml /openapi.yaml post /api/v1/integrations/woocommerce/connect
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/integrations/woocommerce/connect:
    post:
      tags:
        - Integrations
      summary: Connect a WooCommerce store
      description: >-
        Connect a WooCommerce store to the tenant by storing its REST API keys.
        The store URL must use HTTPS and pass an SSRF safety check; the keys are
        validated against the store's Orders endpoint, encrypted at rest, and
        the marketplace card flips to Connected. Requires an admin role. Send
        the store URL plus the WooCommerce consumer key and secret.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - store_url
                - consumer_key
                - consumer_secret
              additionalProperties: false
              properties:
                store_url:
                  type: string
                  format: uri
                  maxLength: 2048
                  description: HTTPS URL of the WooCommerce store.
                consumer_key:
                  type: string
                  minLength: 8
                  maxLength: 256
                  description: WooCommerce REST API consumer key (`ck_…`).
                consumer_secret:
                  type: string
                  minLength: 8
                  maxLength: 256
                  description: WooCommerce REST API consumer secret (`cs_…`).
            example:
              store_url: https://shop.example.com
              consumer_key: ck_1a2b3c4d5e6f
              consumer_secret: cs_9z8y7x6w5v4u
      responses:
        '200':
          description: The store was connected.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      status:
                        type: string
                        description: Connection status (`connected`).
                      store_url:
                        type: string
                        description: The normalised store URL that was stored.
                      consumer_key_prefix:
                        type: string
                        description: >-
                          Non-sensitive prefix of the stored consumer key, for
                          display.
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
components:
  schemas:
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````