Skip to content

Search API

Workflow guides for Advanced Search endpoints under /api-user/v1/search/advanced/. For authentication and signature rules, see API Overview. Filter and pagination parameters are defined in Swagger — this guide shows common patterns only.

Quick Check - Before You Start
  • You have a valid API Key and API Secret from your 3 Clicks administrator.
  • Advanced search uses GET requests with query parameters (not POST bodies).
  • For strict auth, the HMAC data component is a JSON string of query parameters — see Overview — Signature verification.
  • Use page (default 1) and limit (default 20, max 100) for pagination.

Base path

Area Base path Swagger tag
Advanced search /api-user/v1/search/advanced/ v1 - Search > Advanced

Available searches: style, order, sales-order, shipping.

Search styles with filters and pagination.

  1. Choose filters (search_content, status, season, brand, etc.) — see Swagger Style - Search for all @Schema parameters.
  2. Send a GET to /api-user/v1/search/advanced/style with query parameters.
curl -G 'https://[your-api-domain]/api-user/v1/search/advanced/style' \
  --data-urlencode 'search_content=STY3456' \
  --data-urlencode 'mode=all' \
  --data-urlencode 'page=1' \
  --data-urlencode 'limit=20' \
  -H 'accept: */*' \
  -H 'X-Api-Key: your-api-key' \
  -H 'X-Api-Signature: your-signature' \
  -H 'X-Api-Timestamp: 1717127589'

Pagination and filters

Response includes paginated results in content.pagination_data. Additional filters (ecommerce_status, category, barcode, last_updated_at_from, etc.) are documented on Style - Search in Swagger UI.

Search orders with filters and pagination.

  1. Choose filters — see Swagger Order - Search for the full OrderSearchAdvancedParam schema.
  2. Send a GET to /api-user/v1/search/advanced/order with query parameters.
curl -G 'https://[your-api-domain]/api-user/v1/search/advanced/order' \
  --data-urlencode 'search_content=ORD-12345' \
  --data-urlencode 'status=In Progress' \
  --data-urlencode 'season=SS26' \
  --data-urlencode 'page=1' \
  --data-urlencode 'limit=20' \
  -H 'accept: */*' \
  -H 'X-Api-Key: your-api-key' \
  -H 'X-Api-Signature: your-signature' \
  -H 'X-Api-Timestamp: 1717127589'

Search shipments using the same advanced-search pattern.

curl -G 'https://[your-api-domain]/api-user/v1/search/advanced/shipping' \
  --data-urlencode 'search_content=SHP' \
  --data-urlencode 'page=1' \
  --data-urlencode 'limit=20' \
  -H 'accept: */*' \
  -H 'X-Api-Key: your-api-key' \
  -H 'X-Api-Signature: your-signature' \
  -H 'X-Api-Timestamp: 1717127589'

See Swagger Shipping - Search for available filter parameters.

Search Path
Sales orders GET /api-user/v1/search/advanced/sales-order

All advanced search operations share pagination (page, limit) and optional deleted-record filters (is_deleted, deleted_at_from, deleted_at_to). Full parameter lists live in Swagger UI under v1 - Search > Advanced.

Further reading