Store catalogue

Connect API · https://api.conciar.com/connect/v1

The webshop side: channel settings, categories and products. Converted prices follow X-Currency (a currency symbol such as EUR; an unknown one is ignored) or else the channel currency; names follow Accept-Language, or else the channel language.

INFO

Die API-Referenz ist auf Englisch.

Get channel settings

The sales channel's settings, merged over the defaults: guest checkout, pricing mode (snapshot or live), coupon stacking, hide-out-of-stock, supported countries, enabled payment methods, subscription options and restaurant pickup settings. Keys are camelCase. Back-office settings (the maintenance IP allow-list, abandoned-cart timing, dynamic pricing, receipt printing, subscription fulfilment, capture policy) are not included.

GET/connect/v1/store/config

Publishable Key oder geheimer SchlüsselErfordert X-Sales-Channel

curl "https://api.conciar.com/connect/v1/store/config" \
  -H "Accept: application/json" \
  -H "X-Api-Key: pk_your_publishable_key" \
  -H "X-Sales-Channel: cnct_ch_your_channel_token"

Beispielantwort · 200

{
  "config": {
    "active": true,
    "maintenanceMode": false,
    "guestCheckout": true,
    "cartPricing": "snapshot",
    "couponsStackable": false,
    "hideOutOfStock": false,
    "supportedCountries": [],
    "paymentMethodsMode": "organization",
    "…": "…"
  }
}

List categories

Top-level categories with their direct children and how many products in this channel each holds.

GET/connect/v1/store/categories

Publishable Key oder geheimer SchlüsselErfordert X-Sales-Channel

curl "https://api.conciar.com/connect/v1/store/categories" \
  -H "Accept: application/json" \
  -H "X-Api-Key: pk_your_publishable_key" \
  -H "X-Sales-Channel: cnct_ch_your_channel_token"

Beispielantwort · 200

{
  "data": [
    {
      "id": 1,
      "parent_id": null,
      "slug": "coffee",
      "name": "Coffee",
      "description": null,
      "product_count": 12,
      "children": [
        {
          "id": 2,
          "parent_id": 1,
          "slug": "beans",
          "name": "Beans",
          "description": null,
          "product_count": 8
        }
      ]
    }
  ]
}

List products

Active products in this channel, paginated. Each product comes with its type, variants, stock, retail_price, tax breakdown and, when a currency is known, converted_retail_price. stock holds track_stock and available. Only storefront fields are returned: no cost prices and no other sales channels.

GET/connect/v1/store/products

Publishable Key oder geheimer SchlüsselErfordert X-Sales-Channel

Query-Parameter

• qstring

  Search, max 100.

• categoryinteger

  Category id.

• typestring

  Comma-separated product types, e.g. physical,digital.

• sortstring

  recommended, price_asc, price_desc or newest.

• per_pageinteger

  1–100, default 20.

• pageinteger

  Page number.

• featured, subscriptionboolean

  true: only featured (in this channel) / only subscription products; false: only the others.

• price_min, price_maxnumber

  In the request currency.

• property[key]string

  Filter on a product property; values come from /store/products/filters.

curl "https://api.conciar.com/connect/v1/store/products?q=coffee&per_page=20" \
  -H "Accept: application/json" \
  -H "X-Api-Key: pk_your_publishable_key" \
  -H "X-Sales-Channel: cnct_ch_your_channel_token"

Beispielantwort · 200

{
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 9001,
        "sku": "EX-BEANS-1KG",
        "type": {
          "name": "physical"
        },
        "active": true,
        "out_of_stock": false,
        "featured": false,
        "resolved_info": {
          "name": "Example beans 1 kg",
          "…": "…"
        },
        "retail_price": {
          "amount": "24.95",
          "…": "…"
        },
        "tax": {
          "net": 22.89,
          "tax_total": 2.06,
          "gross": 24.95,
          "…": "…"
        },
        "variants": [],
        "…": "…"
      }
    ],
    "per_page": 20,
    "total": 1,
    "…": "…"
  }
}

List product filters

The property filters for the current product selection, with counts. Takes the same query parameters as the product list.

GET/connect/v1/store/products/filters

Publishable Key oder geheimer SchlüsselErfordert X-Sales-Channel

curl "https://api.conciar.com/connect/v1/store/products/filters" \
  -H "Accept: application/json" \
  -H "X-Api-Key: pk_your_publishable_key" \
  -H "X-Sales-Channel: cnct_ch_your_channel_token"

Beispielantwort · 200

{
  "filters": [
    {
      "key": "roast",
      "label": "Roast",
      "options": [
        {
          "value": "dark",
          "count": 5
        },
        {
          "value": "light",
          "count": 3
        }
      ]
    }
  ]
}

Get a product

One product with its translations, categories, price rules and variants (with their options).

GET/connect/v1/store/products/{id}

Publishable Key oder geheimer SchlüsselErfordert X-Sales-Channel

Pfadparameter

• idintegererforderlich

  Product id.

Statuscodes

• 404Not found or inactive.

Gut zu wissen

• Any active product of the organization is returned; it is not checked against this sales channel.

curl "https://api.conciar.com/connect/v1/store/products/9001" \
  -H "Accept: application/json" \
  -H "X-Api-Key: pk_your_publishable_key" \
  -H "X-Sales-Channel: cnct_ch_your_channel_token"

Beispielantwort · 200

{
  "data": {
    "id": 9001,
    "sku": "EX-BEANS-1KG",
    "resolved_info": {
      "name": "Example beans 1 kg",
      "…": "…"
    },
    "categories": [
      "…"
    ],
    "variants": [
      "…"
    ],
    "…": "…"
  }
}