Store Settings

Server

Download schema

Get store configuration

GET

https://api.wocart.store

/api/stores/me

X-API-Key (header)

Returns the current store's configuration including branding, theme, localization, SEO, and storefront settings.

Get store configuration › Responses

200

Store configuration

success

boolean · required

Store · required

Single-tenant store configuration: branding, theme, localization, SEO, and feature flags

GET/api/stores/me

curl https://api.wocart.store/api/stores/me \
  --header 'X-API-Key: <api-key>'

Example Responses

{
  "success": true,
  "data": {
    "id": "store_01",
    "name": "My Shop",
    "domain": null,
    "logo": {
      "key": "products/3f2a9c0b1d2e4f5061728394a5b6c7d8.webp",
      "url": "https://ik.imagekit.io/wocart/stores/maysa/products/3f2a9c0b1d2e4f5061728394a5b6c7d8.webp",
      "width": 1200,
      "height": 900
    },
    "themeId": "theme-00",
    "lang": "ar",
    "currency": "DZD",
    "currencySymbol": "دج",
    "metaTitle": "My Shop — Best Products",
    "metaDescription": "Find the best products at My Shop.",
    "ogImage": {
      "key": "products/3f2a9c0b1d2e4f5061728394a5b6c7d8.webp",
      "url": "https://ik.imagekit.io/wocart/stores/maysa/products/3f2a9c0b1d2e4f5061728394a5b6c7d8.webp",
      "width": 1200,
      "height": 900
    },
    "cartEnabled": false,
    "freeShippingThreshold": null,
    "cartShippingMode": "highest",
    "storeApiKey": "storeApiKey",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "languages": [
      {
        "locale": "ar",
        "published": true,
        "primary": true
      }
    ]
  }
}

json

application/json

Update store configuration

PATCH

https://api.wocart.store

/api/stores/me

X-API-Key (header)

Partially updates the store configuration. All fields are optional — only include the fields you want to change. Set nullable fields to null to clear them.

Update store configuration › Request Body

name

string · minLength: 1 · maxLength: 100

logoKey

string | null · minLength: 1 · maxLength: 512

A Media Key: the image's identity in the store's media. Never a URL.

domain

string | null · maxLength: 200 · pattern: ^[a-z0-9][a-z0-9.-]*…

lang

string · enum

Enum values:

object[] · minItems: 1 · maxItems: 3

currencySymbol

string · minLength: 1 · maxLength: 10

metaTitle

string | null · maxLength: 200

metaDescription

string | null · maxLength: 500

ogImageKey

string | null · minLength: 1 · maxLength: 512

A Media Key: the image's identity in the store's media. Never a URL.

cartEnabled

boolean

freeShippingThreshold

integer | null · min: 1 · max: 10000000

cartShippingMode

string · enum

Enum values:

highest

default_profile

Update store configuration › Responses

200

Updated store configuration

success

boolean · required

Store · required

Single-tenant store configuration: branding, theme, localization, SEO, and feature flags

PATCH/api/stores/me

curl https://api.wocart.store/api/stores/me \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "name",
  "logoKey": "products/3f2a9c0b1d2e4f5061728394a5b6c7d8.webp",
  "domain": "domain",
  "lang": "ar",
  "languages": [
    {
      "locale": "ar",
      "published": true
    }
  ],
  "currencySymbol": "currencySymbol",
  "metaTitle": "metaTitle",
  "metaDescription": "metaDescription",
  "ogImageKey": "products/3f2a9c0b1d2e4f5061728394a5b6c7d8.webp",
  "cartEnabled": true,
  "freeShippingThreshold": 1,
  "cartShippingMode": "highest"
}'

Example Request Body

{
  "name": "name",
  "logoKey": "products/3f2a9c0b1d2e4f5061728394a5b6c7d8.webp",
  "domain": "domain",
  "lang": "ar",
  "languages": [
    {
      "locale": "ar",
      "published": true
    }
  ],
  "currencySymbol": "currencySymbol",
  "metaTitle": "metaTitle",
  "metaDescription": "metaDescription",
  "ogImageKey": "products/3f2a9c0b1d2e4f5061728394a5b6c7d8.webp",
  "cartEnabled": true,
  "freeShippingThreshold": 1,
  "cartShippingMode": "highest"
}

json

Example Responses

{
  "success": true,
  "data": {
    "id": "store_01",
    "name": "My Shop",
    "domain": null,
    "logo": {
      "key": "products/3f2a9c0b1d2e4f5061728394a5b6c7d8.webp",
      "url": "https://ik.imagekit.io/wocart/stores/maysa/products/3f2a9c0b1d2e4f5061728394a5b6c7d8.webp",
      "width": 1200,
      "height": 900
    },
    "themeId": "theme-00",
    "lang": "ar",
    "currency": "DZD",
    "currencySymbol": "دج",
    "metaTitle": "My Shop — Best Products",
    "metaDescription": "Find the best products at My Shop.",
    "ogImage": {
      "key": "products/3f2a9c0b1d2e4f5061728394a5b6c7d8.webp",
      "url": "https://ik.imagekit.io/wocart/stores/maysa/products/3f2a9c0b1d2e4f5061728394a5b6c7d8.webp",
      "width": 1200,
      "height": 900
    },
    "cartEnabled": false,
    "freeShippingThreshold": null,
    "cartShippingMode": "highest",
    "storeApiKey": "storeApiKey",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "languages": [
      {
        "locale": "ar",
        "published": true,
        "primary": true
      }
    ]
  }
}

json

application/json

Get a store's translations

GET

https://api.wocart.store

/api/stores/me/translations

X-API-Key (header)

The translatable fields in the store's primary language and every stored translation, each flagged outdated when its source text changed after it was written.

Get a store's translations › Responses

200

Source and translations

success

boolean · required

object · required

GET/api/stores/me/translations

curl https://api.wocart.store/api/stores/me/translations \
  --header 'X-API-Key: <api-key>'

Example Responses

{
  "success": true,
  "data": {
    "resource": "resource",
    "id": "id",
    "sourceLocale": "ar",
    "targetLocales": [
      {
        "locale": "ar",
        "published": true
      }
    ],
    "source": {
      "key": "string"
    },
    "options": [
      {
        "name": "name",
        "key": "key",
        "values": [
          {
            "value": "value",
            "key": "key"
          }
        ]
      }
    ],
    "translations": {
      "ar": {
        "key": {
          "value": "value",
          "outdated": true
        }
      },
      "fr": {
        "key": {
          "value": "value",
          "outdated": true
        }
      },
      "en": {
        "key": {
          "value": "value",
          "outdated": true
        }
      }
    }
  }
}

json

application/json

Translate a store into one language

PATCH

https://api.wocart.store

/api/stores/me/translations

X-API-Key (header)

A JSON Merge Patch (RFC 7396) of one language: a string sets a field, null removes its translation, other fields are untouched. The language must be one the store has added, and not its primary — the resource's own fields hold that.

Translate a store into one language › Request Body

locale

string · enum · required

Enum values:

object · required

Translate a store into one language › Responses

200

Source and translations after the patch

success

boolean · required

object · required

PATCH/api/stores/me/translations

curl https://api.wocart.store/api/stores/me/translations \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "locale": "ar",
  "values": {
    "metaTitle": "metaTitle",
    "metaDescription": "metaDescription",
    "currencySymbol": "currencySymbol"
  }
}'

Example Request Body

{
  "locale": "ar",
  "values": {
    "metaTitle": "metaTitle",
    "metaDescription": "metaDescription",
    "currencySymbol": "currencySymbol"
  }
}

json

Example Responses

{
  "success": true,
  "data": {
    "resource": "resource",
    "id": "id",
    "sourceLocale": "ar",
    "targetLocales": [
      {
        "locale": "ar",
        "published": true
      }
    ],
    "source": {
      "key": "string"
    },
    "options": [
      {
        "name": "name",
        "key": "key",
        "values": [
          {
            "value": "value",
            "key": "key"
          }
        ]
      }
    ],
    "translations": {
      "ar": {
        "key": {
          "value": "value",
          "outdated": true
        }
      },
      "fr": {
        "key": {
          "value": "value",
          "outdated": true
        }
      },
      "en": {
        "key": {
          "value": "value",
          "outdated": true
        }
      }
    }
  }
}

json

application/json

Wilayas Store Pages