Search branches

curl -X POST "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/branches/search?page=1&limit=20" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "search": {
      "value": "downtown",
      "case_sensitive": false
    },
    "filters": [
      { "field": "status", "operator": "=", "value": true }
    ],
    "sort": [
      { "field": "name", "direction": "asc" }
    ]
  }'

POST

ecommerce

apps

{app_id}

branches

curl -X POST "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/branches/search?page=1&limit=20" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "search": {
      "value": "downtown",
      "case_sensitive": false
    },
    "filters": [
      { "field": "status", "operator": "=", "value": true }
    ],
    "sort": [
      { "field": "name", "direction": "asc" }
    ]
  }'

string

required

Your store ID in Jelou Shop.

integer

default:"1"

Page number to return.

integer

default:"15"

Number of results per page (max. 100).

object

Text search object.

Show Search properties

string

required

Text to search in the name and code fields.

boolean

default:"false"

Whether the search is case-sensitive.

object[]

List of filters to apply.

Show Properties of each filter

string

required

Field to filter by: status or code.

string

default:"="

Comparison operator. Supported values: =, !=, <, <=, >, >=, like, not like, in, not in.

string | boolean

required

Filter value.

object[]

Result ordering.

Show Properties of each sort

string

required

Field to sort by: created_at, updated_at, name or code.

string

default:"asc"

Sort direction: asc or desc.

curl -X POST "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/branches/search?page=1&limit=20" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "search": {
      "value": "downtown",
      "case_sensitive": false
    },
    "filters": [
      { "field": "status", "operator": "=", "value": true }
    ],
    "sort": [
      { "field": "name", "direction": "asc" }
    ]
  }'

Each branch in the response includes products_count with the number of active products linked to it. If you omit sort, results are ordered by created_at ascending.

Searchable fields: name, code Filterable fields: status, code Sortable fields: created_at, updated_at, name, code

⌘I

Getting Started

Developer

Jelou CLI

Outbound Messaging

Management

Marketplace

Channels

Configuration

Billing