> ## 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.

# Retrieve store config

> Retrieve store config



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json get /store/config
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/config:
    parameters: []
    get:
      tags:
        - Store
      summary: Retrieve store config
      description: Retrieve store config
      operationId: get-store-config
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      store_config:
                        $ref: '#/components/schemas/StoreConfig'
                    type: object
components:
  schemas:
    StoreConfig:
      title: StoreConfig
      type: object
      properties:
        is_kyc_enabled:
          type: boolean
          default: false
        is_customer_group_enabled:
          type: boolean
          default: false
        is_loyalty_program_enabled:
          type: boolean
          default: false
        tax:
          $ref: '#/components/schemas/TaxConfig'
        shipping:
          $ref: '#/components/schemas/ShippingConfig'
        customer_groups:
          type: array
          items:
            $ref: '#/components/schemas/CustomerGroup'
          readOnly: true
        kyc_documents:
          type: array
          items:
            $ref: '#/components/schemas/KycDocumentConfig'
          readOnly: true
        brand:
          $ref: '#/components/schemas/Brand'
        subscription:
          anyOf:
            - $ref: '#/components/schemas/SubscriptionSetting'
            - type: 'null'
        general:
          $ref: '#/components/schemas/StoreGeneralConfig'
        currency:
          $ref: '#/components/schemas/Currency'
          readOnly: true
        credit_line:
          anyOf:
            - $ref: '#/components/schemas/CreditLineConfig'
            - type: 'null'
        payout:
          $ref: '#/components/schemas/PayoutConfig'
        warehouses:
          type: array
          items:
            $ref: '#/components/schemas/StoreConfigWarehouse'
          readOnly: true
        templates:
          type: array
          items:
            $ref: '#/components/schemas/StoreConfigTemplate'
          readOnly: true
        service_providers:
          type: array
          items:
            $ref: '#/components/schemas/StoreConfigServiceProvider'
          readOnly: true
        shipping_zones:
          type: array
          items:
            $ref: '#/components/schemas/StoreConfigShippingZone'
          readOnly: true
        manual_payment_methods:
          type: array
          items:
            $ref: '#/components/schemas/ManualPaymentMethod'
          readOnly: true
        shipping_cost_policy:
          $ref: '#/components/schemas/ShippingCostPolicy'
      x-tags:
        - Store
    TaxConfig:
      title: TaxConfig
      type: object
      properties:
        tax_type:
          enum:
            - GST
        taxable_location:
          enum:
            - shipping-address
            - billing-address
        is_product_price_include_tax:
          description: >-
            This field indicates whether the product prices, handling charges
            already include applicable taxes.


            - If set to true, the product prices are inclusive of tax, meaning
            no additional tax will be added during checkout.


            - If set to false, taxes are excluded from the listed prices and
            will be calculated and added separately at checkout.
          type: boolean
        is_shipping_price_include_tax:
          description: >-
            This field indicates whether the shipping prices already include
            applicable taxes.


            - If set to true, the shipping prices are inclusive of tax, meaning
            no additional tax will be added during checkout.


            - If set to false, taxes are excluded from the listed prices and
            will be calculated and added separately at checkout.
          type: boolean
        is_tax_apply_after_discount:
          type: boolean
        is_discount_apply_after_tax:
          type: boolean
        shipping_tax_rate:
          type: number
        handling_charge_tax_rate:
          description: >-
            This represents the tax rate percentage applied specifically to
            handling charge in shipping. A handling charge is an additional fee
            applied to cover the costs associated with preparing, packaging, and
            processing an order for shipment or delivery.
          type: number
      x-tags:
        - Store
    ShippingConfig:
      title: ShippingConfig
      type: object
      properties:
        packaging_optimisation_logic:
          description: |-
            - cost - the lowest cost of shipment
            - bins_utilization - max. utilization inside packing spaces
            - bins_number - the smallest possible number of packing spaces
          enum:
            - cost
            - bins_utilization
            - bins_number
        location_priority:
          enum:
            - manual
            - distance
            - inventory
        warehouse_id:
          description: >-
            optional. required only if location_priority = manual. Value should
            be array of warehouses ids.
          type:
            - array
            - 'null'
          items:
            type: string
        approval_option:
          default: auto
          enum:
            - auto
            - manual
        shipping_option:
          description: Omitted when shipping is not configured for the store.
          enum:
            - auto
            - manual
        default_weight:
          description: >-
            Specifies the default weight (in kilograms) used to calculate
            shipping costs when product packing details are missing. This value
            ensures that shipping estimates can still be generated in the
            absence of product packing information.
          type: number
      additionalProperties: true
      x-tags:
        - Store
    CustomerGroup:
      title: CustomerGroup
      type: object
      required:
        - name
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        is_default:
          description: first record will be treated as default if not changed.
          type: boolean
        active:
          type: boolean
          default: true
      x-tags:
        - Store
    KycDocumentConfig:
      title: KycDocumentConfig
      type: object
      required:
        - document_type
        - title
        - is_mandatory
        - is_attachment_required
        - verification_type
      properties:
        id:
          type: string
          readOnly: true
        document_type:
          description: >-
            Kind of KYC document the store collects. Known values are `gst`,
            `pan`, `drug_license` and `other`; the set is store-configurable and
            not exhaustive.
          type: string
        title:
          type: string
        description:
          type:
            - string
            - 'null'
        active:
          type: boolean
          default: true
        is_mandatory:
          type: boolean
        is_attachment_required:
          type: boolean
        slug:
          type: string
          readOnly: true
        verification_type:
          enum:
            - auto
            - manual
        is_value_unique:
          description: >-
            When `true`, the document number must be unique across customers in
            the store.
          type: boolean
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type: string
          format: date-time
          readOnly: true
      x-tags:
        - Store
    Brand:
      title: Brand
      type: object
      properties:
        name:
          description: brand name. it will be used in emails and other communications.
          type: string
        logo_url:
          type:
            - string
            - 'null'
          readOnly: true
        file_id:
          description: >-
            Media gallery file id for the brand logo. Omitted or `null` when no
            logo file is linked.
          type:
            - string
            - 'null'
        social_media_links:
          description: "json object having key - value pair.\r\n\r\nexample - {\"facebook\": \"www.facebook.com/commecengine\"}"
          type:
            - object
            - 'null'
          additionalProperties:
            type: string
      additionalProperties: true
      x-tags:
        - Store
    SubscriptionSetting:
      title: SubscriptionSetting
      type: object
      required:
        - charge_automatically
        - retry_and_dunning
        - pause_during_trial
        - pause_when_past_due
        - pause_indefinitely
        - skip_next_interval
      properties:
        charge_automatically:
          type: boolean
        retry_and_dunning:
          type: boolean
        retry_and_dunning_rules:
          type:
            - array
            - 'null'
          items:
            type: object
            required:
              - days
              - retry_payment
              - send_notification
            properties:
              days:
                description: days after first payment failure
                type: integer
              retry_payment:
                type: boolean
              send_notification:
                type: boolean
        retry_final_step_action:
          description: send null value for no action.
          enum:
            - mark-as-unpaid
            - cancel-subscription
        pause_during_trial:
          type: boolean
        pause_when_past_due:
          type: boolean
        pause_indefinitely:
          type: boolean
        skip_next_interval:
          type: boolean
        skip_next_interval_threshold:
          description: days before next shipment. required if skip_next_interval = true
          type: integer
          default: 0
      x-tags:
        - Store
    StoreGeneralConfig:
      title: StoreGeneralConfig
      type: object
      properties:
        order_number_prefix:
          description: >-
            Prefix prepended to generated order numbers for identification or
            branding.
          type: string
          maxLength: 4
          minLength: 2
        currency_code:
          description: >-
            ISO 4217 currency code used for store prices and payments (e.g. INR,
            USD).
          type: string
          maxLength: 3
          minLength: 3
      x-tags:
        - Store
    Currency:
      title: Currency
      type: object
      properties:
        name:
          type: string
        code:
          type: string
        symbol:
          type: string
      x-tags:
        - Store
    CreditLineConfig:
      title: CreditLineConfig
      type: object
      required:
        - is_enabled
        - customer_eligibility
        - total_credit_limit
        - payment_method_slugs
      properties:
        is_enabled:
          description: >-
            Enables the credit line feature for the store. When `false`,
            customers cannot place orders using their credit line.
          type: boolean
          default: false
        customer_eligibility:
          description: >-
            Controls which customers can access the credit line.


            - `all` - every customer is eligible.

            - `specific` - only customers who have been individually approved
            are eligible.
          enum:
            - specific
            - all
        total_credit_limit:
          description: >-
            Default spending limit assigned to a customer when their credit line
            is approved.
          type: number
        mandate_per_order_limit:
          description: >-
            (Optional) Default upper cap on the mandate amount issued to a
            customer. Must be greater than or equal to `total_credit_limit`. If
            not provided, `total_credit_limit` will be automatically assigned as
            the mandate per order limit.
          type: number
        credit_period:
          description: >-
            Credit period in days. If not provided, the credit period will be
            automatically assigned as 21 days.
          type: number
          default: 21
        payment_method_slugs:
          description: Array of payment method slugs to be used for the credit line.
          type: array
          items:
            type: string
          writeOnly: true
        payment_methods:
          description: Payment methods to be used for the credit line.
          type: array
          items:
            $ref: '#/components/schemas/CreditLinePaymentMethod'
          readOnly: true
      x-tags:
        - Store
    PayoutConfig:
      title: PayoutConfig
      type: object
      required:
        - payment_option
        - payment_methods
      properties:
        payment_option:
          description: >-
            Controls how seller payouts are disbursed.


            - `auto` - payout batches are settled through the connected payment
            providers listed in `payment_methods`.


            - `manual` - payouts are settled outside the platform, so no
            provider is linked and `payment_methods` is empty.
          enum:
            - auto
            - manual
        payment_methods:
          description: >-
            Payment providers used to settle payout batches. When writing, send
            only `slug` and `is_default` for each entry; the response returns
            each fully expanded `PayoutPaymentMethod`. Send an empty array when
            `payment_option` is `manual`.
          type: array
          items:
            $ref: '#/components/schemas/PayoutPaymentMethod'
      x-tags:
        - Store
    StoreConfigWarehouse:
      title: StoreConfigWarehouse
      allOf:
        - $ref: '#/components/schemas/WarehouseDetail'
        - type: object
          properties:
            seller_id:
              type:
                - string
                - 'null'
            marketplace_listing:
              type: array
            manual_methods:
              type: array
              items:
                $ref: '#/components/schemas/StoreConfigWarehouseManualMethod'
              readOnly: true
            channels:
              type: array
              items:
                $ref: '#/components/schemas/StoreConfigWarehouseSalesChannel'
              readOnly: true
      x-tags:
        - Store
    StoreConfigTemplate:
      title: StoreConfigTemplate
      type: object
      properties:
        id:
          type: string
          readOnly: true
        template_type:
          enum:
            - terms-of-service
            - refund-policy
            - email
            - invoice
            - web-layer
            - whatsapp
            - chat
            - push-notification
            - webhook
        name:
          type: string
        activity:
          description: >-
            example - signup, order-confirmation, order-cancelled,
            order-refunded, cart-abandoned, etc.
          type:
            - string
            - 'null'
        content_type:
          enum:
            - html
            - markdown
            - plaintext
        description:
          type:
            - string
            - 'null'
        content_title:
          description: to be used in email subject or notification heading if provided.
          type:
            - string
            - 'null'
      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
    StoreConfigShippingZone:
      title: StoreConfigShippingZone
      allOf:
        - $ref: '#/components/schemas/ShippingZoneDetail'
      x-tags:
        - Store
    ManualPaymentMethod:
      title: ManualPaymentMethod
      type: object
      required:
        - name
        - description
        - payment_instructions
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
        slug:
          type: string
        description:
          type: string
        used_in_credit_line:
          description: >-
            `true` when the option is linked in the store credit-line payment
            method configuration.
          type: boolean
          readOnly: true
        is_connected:
          description: Derived from `status`. `true` when `status` is `active`.
          type: boolean
          readOnly: true
        payment_instructions:
          type: string
        mark_as_paid:
          description: >-
            When `true`, orders using this method can be marked paid without an
            online capture flow.
          type: boolean
          readOnly: true
        status:
          enum:
            - active
            - inactive
          readOnly: true
        created_at:
          type: string
          readOnly: true
        modified_at:
          type: string
          readOnly: true
      x-tags:
        - Store
    ShippingCostPolicy:
      title: ShippingCostPolicy
      type: object
      required:
        - rules
        - default_action
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/ShippingRule'
        default_action:
          $ref: '#/components/schemas/ShippingCostAction'
      additionalProperties: false
    CreditLinePaymentMethod:
      title: CreditLinePaymentMethod
      description: >-
        A payment method linked to the store credit line, as returned inside
        `StoreConfig.credit_line`. Read-only projection of a manual payment
        method or a connected payment provider - unlike `ManualPaymentMethod`,
        this shape carries branding (`type`, `logo_dark`, `logo_light`).
      type: object
      required:
        - name
        - description
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
        slug:
          type: string
        description:
          type: string
        type:
          description: >-
            `manual` for store-defined payment methods; `auto` for connected
            payment service providers.
          enum:
            - auto
            - manual
        used_in_credit_line:
          description: >-
            `true` when the option is linked in the store credit-line payment
            method configuration.
          type: boolean
          readOnly: true
        status:
          enum:
            - active
            - inactive
          readOnly: true
        logo_dark:
          type:
            - string
            - 'null'
          readOnly: true
        logo_light:
          type:
            - string
            - 'null'
          readOnly: true
        created_at:
          type: string
          readOnly: true
        modified_at:
          type: string
          readOnly: true
      x-tags:
        - Store
    PayoutPaymentMethod:
      title: PayoutPaymentMethod
      type: object
      required:
        - slug
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        slug:
          description: >-
            Slug of the payment provider to pay out through, for example
            `juspay` or `icici-cib`. The only identifier required when writing
            the payout configuration.
          type: string
        description:
          type: string
          readOnly: true
        status:
          enum:
            - active
            - inactive
          readOnly: true
        type:
          description: >-
            `auto` for connected payment service providers; `manual` for
            store-defined payment methods.
          enum:
            - auto
            - manual
          readOnly: true
        used_in_payout:
          description: >-
            `true` when the provider is linked in the store payout
            configuration.
          type: boolean
          readOnly: true
        is_default:
          description: >-
            Marks the provider used to settle payout batches by default. Exactly
            one entry should be `true` when `payment_option` is `auto`.
          type: boolean
          default: false
        logo_dark:
          type:
            - string
            - 'null'
          readOnly: true
        logo_light:
          type:
            - string
            - 'null'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type: string
          format: date-time
          readOnly: true
      x-tags:
        - Store
    WarehouseDetail:
      title: WarehouseDetail
      allOf:
        - $ref: '#/components/schemas/Warehouse'
        - type: object
          properties:
            seller_id:
              description: >-
                Relevant for marketplace type stores only. `null` for b2b and
                b2c type stores.
              type:
                - string
                - 'null'
              readOnly: true
            marketplace_listing:
              description: Marketplaces this warehouse is listed on.
              type: array
              items:
                type: object
                properties:
                  marketplace_id:
                    type: string
              readOnly: true
            shipping_boxes:
              type: array
              items:
                $ref: '#/components/schemas/StoreShippingBox'
              readOnly: true
            shipping_providers:
              type: array
              items:
                $ref: '#/components/schemas/ShippingOption'
              readOnly: true
            manual_methods:
              type: array
              items:
                $ref: '#/components/schemas/WarehouseManualMethod'
              readOnly: true
            available_shipping_options:
              type: array
              items:
                $ref: '#/components/schemas/WarehouseShippingOption'
              readOnly: true
      x-tags:
        - Store
    StoreConfigWarehouseManualMethod:
      title: StoreConfigWarehouseManualMethod
      description: Manual shipping method on a warehouse as returned in `StoreConfig`.
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        is_connected:
          type: boolean
        is_forward_shipping:
          type: boolean
        is_return_shipping:
          type: boolean
        logo_dark:
          type:
            - string
            - 'null'
          readOnly: true
        logo_light:
          type:
            - string
            - 'null'
          readOnly: true
        logo:
          type:
            - string
            - 'null'
          readOnly: true
        fulfillment_type:
          enum:
            - delivery
            - collect-in-store
          readOnly: true
        sort_order:
          type: integer
          readOnly: true
        status:
          enum:
            - active
            - inactive
        shipping_method_type:
          enum:
            - manual
            - local-pickup
        shipping_rate_name:
          type:
            - string
            - 'null'
        shipping_rate_fixed_price:
          description: '`null` when `shipping_rate_condition` is set.'
          type:
            - number
            - 'null'
        shipping_rate_condition:
          description: '`null` when `shipping_rate_fixed_price` is set.'
          anyOf:
            - $ref: '#/components/schemas/ManualShippingRateCondition'
            - type: 'null'
        maximum_weight:
          description: '`null` when there is no weight limit.'
          type:
            - number
            - 'null'
        delivery_leadtime_minimum:
          description: In days.
          type: integer
        delivery_leadtime_maximum:
          description: In days.
          type: integer
      x-tags:
        - Store
    StoreConfigWarehouseSalesChannel:
      title: StoreConfigWarehouseSalesChannel
      description: Sales channel on a warehouse as returned in `StoreConfig`.
      allOf:
        - $ref: '#/components/schemas/StoreConfigSalesChannel'
        - type: object
          properties:
            channel_type:
              description: 'Observed values: `web`, `pos`, `internal`.'
              type: string
            is_default:
              type: boolean
            domain:
              type:
                - string
                - 'null'
            app_platform:
              type:
                - string
                - 'null'
            external_id:
              type:
                - string
                - 'null'
            pos_vendor:
              type:
                - string
                - 'null'
            store_id:
              type: string
            store_name:
              type: string
            marketplace_id:
              description: Set only when `kind` is `marketplace`.
              type:
                - string
                - 'null'
            marketplace:
              description: '`null` unless `kind` is `marketplace`.'
              oneOf:
                - type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    slug:
                      type: string
                    marketplace_type:
                      type: string
                    store_id:
                      description: The marketplace operator's store.
                      type: string
                    sync_products:
                      type: boolean
                    sync_inventory:
                      type: boolean
                    sync_orders:
                      type: boolean
                    required_credentials_params:
                      type:
                        - object
                        - 'null'
                    created_at:
                      type: string
                      format: date-time
                    modified_at:
                      type: string
                      format: date-time
                - type: 'null'
            seller_account:
              description: >-
                This store's seller account on the marketplace. `null` unless
                `kind` is `marketplace`.
              oneOf:
                - $ref: '#/components/schemas/StoreConfigWarehouseSellerAccount'
                - type: 'null'
      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
    ShippingZoneDetail:
      title: ShippingZoneDetail
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        countries:
          type: array
          items:
            $ref: '#/components/schemas/Country'
        active:
          type: boolean
          default: true
        is_default:
          type: boolean
        available_shipping_options:
          type: array
          items:
            $ref: '#/components/schemas/ShippingOption'
          readOnly: true
        shipping_providers:
          type: array
          items:
            $ref: '#/components/schemas/ShippingOption'
          readOnly: true
        manual_methods:
          type: array
          items:
            $ref: '#/components/schemas/ShippingOption'
          readOnly: true
      x-tags:
        - Store
    ShippingRule:
      title: ShippingRule
      type: object
      required:
        - condition
        - action
      properties:
        condition:
          $ref: '#/components/schemas/ShippingCostCondition'
        action:
          $ref: '#/components/schemas/ShippingCostAction'
      additionalProperties: false
    ShippingCostAction:
      title: ShippingCostAction
      oneOf:
        - $ref: '#/components/schemas/FreeAction'
        - $ref: '#/components/schemas/FixedChargeAction'
        - $ref: '#/components/schemas/DiscountAction'
        - $ref: '#/components/schemas/DynamicAction'
    Warehouse:
      title: Warehouse
      description: >-
        Validations:


        1) Either 'can_receive_stock' or 'accepts_returns' must be set to true.

        2) 'can_receive_stock' cannot be set to false while the warehouse has
        existing inventory.

        3) 'is_checkout_point' must be true when the warehouse type is
        'retail-store'.

        4) If 'can_receive_stock' is false then 'can_ship_parcel' and
        'can_collect' fields should be false.
      type: object
      required:
        - name
        - warehouse_type
        - city
        - address_line1
        - pincode
        - state
        - country
        - contact_phone
        - contact_email
        - can_receive_stock
        - can_ship_parcel
        - can_collect
        - is_checkout_point
        - accepts_returns
      properties:
        id:
          description: warehouse id
          type: string
          readOnly: true
        name:
          description: legal name
          type: string
        warehouse_type:
          enum:
            - retail-store
            - distribution-center
        active:
          type: boolean
          default: true
        gstin:
          type:
            - string
            - 'null'
        city:
          type:
            - string
            - 'null'
        address_line1:
          type: string
        address_line2:
          type:
            - string
            - 'null'
        landmark:
          type:
            - string
            - 'null'
        pincode:
          type:
            - string
            - 'null'
        state:
          type:
            - string
            - 'null'
        country:
          type: string
        country_code:
          type:
            - string
            - 'null'
        contact_phone:
          description: 10 digit number without country code.
          type:
            - string
            - 'null'
        contact_email:
          type:
            - string
            - 'null'
        is_default:
          type: boolean
        image_url:
          type:
            - string
            - 'null'
        seller_warehouse_id:
          type:
            - string
            - 'null'
        can_receive_stock:
          type: boolean
        can_ship_parcel:
          type: boolean
        can_collect:
          type: boolean
        is_checkout_point:
          description: this field will be always true for warehouse_type = retail-store.
          type: boolean
        accepts_returns:
          type: boolean
        opening_hours:
          anyOf:
            - $ref: '#/components/schemas/OpeningHours'
            - type: 'null'
        channels:
          description: channels associated with the warehouse
          type: array
          items:
            $ref: '#/components/schemas/WarehouseSalesChannel'
          readOnly: true
    StoreShippingBox:
      title: ShippingBox
      description: ''
      type: object
      required:
        - name
        - length
        - width
        - height
        - empty_box_weight
        - max_weight_box_can_carry
        - empty_box_price
      properties:
        id:
          type: string
        name:
          type: string
        length:
          type: number
        width:
          type: number
        height:
          type: number
        empty_box_weight:
          type: number
        max_weight_box_can_carry:
          type: number
        empty_box_price:
          type: number
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type: string
          format: date-time
          readOnly: true
    ShippingOption:
      title: ShippingOption
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        is_connected:
          type: boolean
        is_forward_shipping:
          type: boolean
        is_return_shipping:
          type: boolean
        logo_dark:
          type:
            - string
            - 'null'
          readOnly: true
        logo_light:
          type:
            - string
            - 'null'
          readOnly: true
        logo:
          description: >-
            Primary logo URL for display. Same as `logo_light` for most
            providers.
          type:
            - string
            - 'null'
          readOnly: true
        fulfillment_type:
          enum:
            - delivery
            - collect-in-store
          readOnly: true
        sort_order:
          type: integer
          readOnly: true
        type:
          enum:
            - auto
            - manual
        status:
          enum:
            - active
            - inactive
    WarehouseManualMethod:
      title: WarehouseManualMethod
      allOf:
        - $ref: '#/components/schemas/WarehouseShippingOption'
        - type: object
          properties:
            shipping_method_type:
              enum:
                - manual
                - local-pickup
            shipping_rate_name:
              type:
                - string
                - 'null'
            shipping_rate_fixed_price:
              description: '`null` when `shipping_rate_condition` is set.'
              type:
                - number
                - 'null'
            shipping_rate_condition:
              description: '`null` when `shipping_rate_fixed_price` is set.'
              anyOf:
                - $ref: '#/components/schemas/ManualShippingRateCondition'
                - type: 'null'
            maximum_weight:
              description: '`null` when there is no weight limit.'
              type:
                - number
                - 'null'
            delivery_leadtime_minimum:
              description: In days.
              type: integer
            delivery_leadtime_maximum:
              description: In days.
              type: integer
      x-tags:
        - Store
    WarehouseShippingOption:
      title: WarehouseShippingOption
      allOf:
        - $ref: '#/components/schemas/ShippingOption'
        - type: object
          properties:
            logo:
              type:
                - string
                - 'null'
              readOnly: true
            fulfillment_type:
              enum:
                - delivery
                - collect-in-store
            sort_order:
              type: integer
      x-tags:
        - Store
    ManualShippingRateCondition:
      title: ManualShippingRateCondition
      anyOf:
        - $ref: '#/components/schemas/ShippingRateBasedOnItemWeight'
        - $ref: '#/components/schemas/ShippingRateBasedOnOrderValue'
      x-tags:
        - Shipping
    StoreConfigSalesChannel:
      title: StoreConfigSalesChannel
      description: Sales channel summary embedded in `StoreConfig` warehouse listings.
      type: object
      required:
        - id
        - name
        - active
      properties:
        id:
          type: string
        name:
          type: string
          readOnly: true
        kind:
          type: string
          enum:
            - storefront
            - marketplace
        active:
          type: boolean
          readOnly: true
      x-tags:
        - Store
    StoreConfigWarehouseSellerAccount:
      title: StoreConfigWarehouseSellerAccount
      description: >-
        Seller account linked to a marketplace channel on a warehouse in
        `StoreConfig`.
      type: object
      properties:
        id:
          type: string
        trade_name:
          type: string
        legal_name:
          type: string
        business_type:
          $ref: '#/components/schemas/SellerBusinessType'
        tax_identification_number:
          type: string
        status:
          $ref: '#/components/schemas/SellerAccountStatus'
        kyc_status:
          $ref: '#/components/schemas/SellerKycStatus'
        logo:
          type:
            - string
            - 'null'
        marketplace_id:
          type: string
        marketplace_name:
          type: string
      x-tags:
        - Store
    ServiceProviderType:
      title: ServiceProviderType
      description: The type of third-party service integration.
      type: string
      enum:
        - shipping
        - payment
        - chat
        - cms
        - analytics
    Country:
      title: Country
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
        country_code:
          type: string
        iso_code:
          type: string
        currency_code:
          type: string
        currency_symbol:
          type: string
        currency_name:
          type: string
        flag_icon_url:
          type: string
        region:
          type: string
        alias:
          type: string
        active:
          type: boolean
          default: true
        all_states:
          type: boolean
          default: true
        states:
          type: array
          items:
            $ref: '#/components/schemas/CountryState'
        total_states:
          description: >-
            Total number of states or provinces defined for the country in
            Commerce Engine.
          type: integer
          readOnly: true
        states_count:
          description: >-
            Number of states or provinces included in this shipping zone country
            entry.
          type: integer
          readOnly: true
      x-tags:
        - Store
    ShippingCostCondition:
      title: ShippingCostCondition
      type: object
      oneOf:
        - additionalProperties: false
          title: Order Total
          required:
            - order_total
          properties:
            order_total:
              $ref: '#/components/schemas/Comparison'
        - additionalProperties: false
          title: Shipping Mode
          required:
            - shipping_mode
          properties:
            shipping_mode:
              description: e.g. ["air","surface"]
              type: array
              items:
                type: string
        - additionalProperties: false
          title: Shipping Providers
          required:
            - providers
          properties:
            providers:
              description: e.g. ["dhl","fedex"]
              type: array
              items:
                type: string
    FreeAction:
      title: FreeAction
      type: object
      required:
        - type
      properties:
        type:
          type: string
          const: free
      additionalProperties: false
    FixedChargeAction:
      title: FixedChargeAction
      type: object
      required:
        - type
        - value
      properties:
        type:
          type: string
          const: fixed-charge
        value:
          description: Flat charge amount
          type: number
          minimum: 0
      additionalProperties: false
    DiscountAction:
      title: DiscountAction
      type: object
      required:
        - type
        - mode
        - value
      properties:
        type:
          type: string
          const: discount
        mode:
          type: string
          enum:
            - percent
            - absolute
        value:
          description: Percentage (0–100) or absolute amount off
          type: number
          minimum: 0
      additionalProperties: false
    DynamicAction:
      title: DynamicAction
      type: object
      required:
        - type
        - rounding
      properties:
        type:
          type: string
          const: dynamic
        rounding:
          $ref: '#/components/schemas/Rounding'
      additionalProperties: false
    OpeningHours:
      type: object
      required:
        - monday
        - tuesday
        - wednesday
        - thursday
        - friday
        - saturday
        - sunday
      properties:
        monday:
          type:
            - object
            - 'null'
          properties:
            opening_time:
              type: string
              format: time
            closing_time:
              type: string
              format: time
          required:
            - opening_time
            - closing_time
        tuesday:
          type:
            - object
            - 'null'
          properties:
            opening_time:
              type: string
              format: time
            closing_time:
              type: string
              format: time
          required:
            - opening_time
            - closing_time
        wednesday:
          type:
            - object
            - 'null'
          properties:
            opening_time:
              type: string
              format: time
            closing_time:
              type: string
              format: time
          required:
            - opening_time
            - closing_time
        thursday:
          type:
            - object
            - 'null'
          properties:
            opening_time:
              type: string
              format: time
            closing_time:
              type: string
              format: time
          required:
            - opening_time
            - closing_time
        friday:
          type:
            - object
            - 'null'
          properties:
            opening_time:
              type: string
              format: time
            closing_time:
              type: string
              format: time
          required:
            - opening_time
            - closing_time
        saturday:
          type:
            - object
            - 'null'
          properties:
            opening_time:
              type: string
              format: time
            closing_time:
              type: string
              format: time
          required:
            - opening_time
            - closing_time
        sunday:
          type:
            - object
            - 'null'
          properties:
            opening_time:
              type: string
              format: time
            closing_time:
              type: string
              format: time
          required:
            - opening_time
            - closing_time
    WarehouseSalesChannel:
      title: WarehouseSalesChannel
      allOf:
        - $ref: '#/components/schemas/SalesChannel'
        - type: object
          properties:
            channel_type:
              description: 'Observed values: `web`, `pos`, `internal`.'
              type: string
            is_default:
              type: boolean
            domain:
              type:
                - string
                - 'null'
            app_platform:
              type:
                - string
                - 'null'
            external_id:
              type:
                - string
                - 'null'
            pos_vendor:
              type:
                - string
                - 'null'
            store_id:
              type: string
            store_name:
              type: string
            marketplace_id:
              description: Set only when `kind` is `marketplace`.
              type:
                - string
                - 'null'
            marketplace:
              description: '`null` unless `kind` is `marketplace`.'
              oneOf:
                - type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    slug:
                      type: string
                    marketplace_type:
                      type: string
                    store_id:
                      description: The marketplace operator's store.
                      type: string
                    sync_products:
                      type: boolean
                    sync_inventory:
                      type: boolean
                    sync_orders:
                      type: boolean
                    required_credentials_params:
                      type:
                        - object
                        - 'null'
                    created_at:
                      type: string
                      format: date-time
                    modified_at:
                      type: string
                      format: date-time
                - type: 'null'
            seller_account:
              description: >-
                This store's seller account on the marketplace. `null` unless
                `kind` is `marketplace`.
              oneOf:
                - allOf:
                    - $ref: '#/components/schemas/SellerInfo'
                    - type: object
                      properties:
                        marketplace_id:
                          type: string
                        marketplace_name:
                          type: string
                - type: 'null'
      x-tags:
        - Store
    ShippingRateBasedOnItemWeight:
      title: ShippingRateBasedOnItemWeight
      description: ''
      anyOf:
        - $ref: '#/components/schemas/ShippingRateBasedOnWeightSlabs'
        - $ref: '#/components/schemas/ShippingRatePerKgFixedPrice'
      x-tags:
        - Shipping
    ShippingRateBasedOnOrderValue:
      title: ShippingRateBasedOnOrderValue
      type:
        - object
        - 'null'
      required:
        - rate_based_on
        - slabs
      properties:
        rate_based_on:
          enum:
            - order-value
        slabs:
          type: array
          items:
            type: object
            required:
              - order_value
              - shipping_rate
              - condition
            properties:
              order_value:
                type: number
              shipping_rate:
                type: number
              condition:
                enum:
                  - less-or-equal
                  - greater
      x-tags:
        - Shipping
    SellerBusinessType:
      title: SellerBusinessType
      type: string
      enum:
        - sole_proprietorship
        - private_limited
        - public_listed
        - public_limited
        - state_owned
        - charity
        - individual
    SellerAccountStatus:
      title: SellerAccountStatus
      type: string
      enum:
        - pending_approval
        - approved
        - rejected
    SellerKycStatus:
      title: SellerKycStatus
      type: string
      enum:
        - document_pending
        - document_submitted
        - approved
        - rejected
    CountryState:
      title: CountryState
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
        iso_code:
          type:
            - string
            - 'null'
        gst_code:
          type: string
        active:
          type: boolean
          default: true
        alias:
          type: string
    Comparison:
      title: Comparison
      oneOf:
        - type: object
          additionalProperties: false
          required:
            - gt
          properties:
            gt:
              type: number
              minimum: 0
          title: Greater than
        - type: object
          additionalProperties: false
          required:
            - gte
          properties:
            gte:
              type: number
              minimum: 0
          title: Greater than or equal
        - type: object
          additionalProperties: false
          required:
            - lt
          properties:
            lt:
              type: number
              minimum: 0
          title: Less than
        - type: object
          additionalProperties: false
          required:
            - lte
          properties:
            lte:
              type: number
              minimum: 0
          title: Less than or equal
    Rounding:
      title: Rounding
      description: Define how to round the shipping cost
      type: object
      required:
        - unit
        - method
      properties:
        unit:
          type: number
          exclusiveMinimum: 0
        method:
          type: string
          enum:
            - nearest
            - ceil
            - floor
      additionalProperties: false
    SalesChannel:
      title: SalesChannel
      type: object
      required:
        - id
        - name
        - active
      properties:
        id:
          type: string
        name:
          type: string
          readOnly: true
        kind:
          type: string
          enum:
            - storefront
            - marketplace
        active:
          type: boolean
          readOnly: true
        sales_channel_type:
          description: 'Observed values: `commercengine`, `web`, `pos`.'
          type:
            - string
            - 'null'
          readOnly: true
        sales_channel_slug:
          type:
            - string
            - 'null'
          readOnly: true
    SellerInfo:
      title: SellerInfo
      type: object
      properties:
        id:
          type: string
        name:
          description: >-
            Display name of the seller. Sent in place of `trade_name` and
            `legal_name` on the abbreviated form of this object.
          type: string
        trade_name:
          type: string
        legal_name:
          type: string
        business_type:
          $ref: '#/components/schemas/SellerBusinessType'
        tax_identification_number:
          type: string
        status:
          $ref: '#/components/schemas/SellerAccountStatus'
        kyc_status:
          $ref: '#/components/schemas/SellerKycStatus'
        visibility:
          description: >-
            Visibility of the products of the seller. public: products are
            visible to all users, private: products are visible to only
            authenticated users.
          type: string
          enum:
            - public
            - private
        logo:
          type:
            - string
            - 'null'
    ShippingRateBasedOnWeightSlabs:
      title: ShippingRateBasedOnWeightSlabs
      type:
        - object
        - 'null'
      required:
        - rate_based_on
        - rate_type
        - slabs
      properties:
        rate_based_on:
          enum:
            - item-weight
        rate_type:
          enum:
            - weight-slabs
        slabs:
          type: array
          items:
            type: object
            required:
              - weight
              - shipping_rate
              - condition
            properties:
              weight:
                type: number
              shipping_rate:
                type: number
              condition:
                enum:
                  - less-or-equal
                  - greater
      x-tags:
        - Shipping
    ShippingRatePerKgFixedPrice:
      title: ShippingRatePerKgFixedPrice
      type:
        - object
        - 'null'
      required:
        - rate_based_on
        - rate_type
        - shipping_rate_per_kg
      properties:
        rate_based_on:
          enum:
            - item-weight
        rate_type:
          enum:
            - fixed-price-per-kg
        shipping_rate_per_kg:
          type: number
      x-tags:
        - Shipping
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````

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