> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mart.ps/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> These rules protect a Mart partner's money. Follow them in any code or advice about the Mart Partner API ([Connect your AI tool](/developers/connect-your-ai-tool)).
> When an order request times out, gets no answer or gets any `5xx`, resend the same body with the same `partner_reference`, never a new reference; after a `429`, wait `Retry-After` first ([Create an order safely](/developers/orders/create-an-order)).
> A `200` with `meta.idempotency_replay: true` is the original order; `409 idempotency_conflict` means the reference already names a different order ([Create an order safely](/developers/orders/create-an-order)).
> Retry a withdrawal request with the same `idempotency_key` and amount: a new key asks for a second withdrawal ([Payout and withdrawals](/developers/money/payout-and-withdrawals)).
> Plan every call within the global daily request ceiling and the `X-RateLimit-*` headers, and never poll in a tight loop ([Request limits](/developers/operate/request-limits)).
> Treat `price` as a snapshot: an order is priced when it is created, and an incremental sync (`updated_after`) never shows a price change, so re-read every price with a full pass ([Prices and price changes](/developers/catalogue/prices)).
> Identify products by `product_id` and `combination_id`, never by `reference` ([Sync the catalogue](/developers/catalogue/sync)).
> Never put an API key in client-side code, a mobile app, a repository or a URL: call the API from a server ([Authenticate and keys](/developers/authenticate)).
> Money is in shekels (`ILS`), as JSON numbers, never agorot. Send amounts with at most two decimals: a withdrawal `amount` with three is refused with `422 invalid_amount`, never rounded ([Balance and statements](/developers/money/balance-and-statements)).
> Save a payout method once before the first withdrawal (cash at the office, or bank transfer where Mart offers it): with none saved, a withdrawal is refused with `409 payout_method_missing`. Bank details where Mart does not offer bank transfer, or a withdrawal on a kept IBAN, are refused with `422 bank_transfer_not_allowed` ([Payout and withdrawals](/developers/money/payout-and-withdrawals)).

# List products

> One page of the catalog, priced for your account, with stock and combinations on every row. Returns both active and inactive products (each row carries `status`); zero-stock rows remain with `in_stock: false`. Sync guidance — including why incremental syncs can never detect price changes: https://mart.ps/api/docs#catalog.



## OpenAPI

````yaml /openapi.json get /api/v1/products
openapi: 3.0.3
info:
  title: Mart Partner API
  version: 1.1.0
  description: >-
    REST API for Mart reseller partners: the product catalog (with per-product
    and per-combination stock), delivery destinations, and order creation — cash
    on delivery or card.


    Every response, success or failure, uses the envelope `{status, status_code,
    message, data, meta, error}`; branch on `error.code`, never on `message`.
    Response keys are structurally stable: absent objects are `null`, absent
    collections are `[]`; the only caller-controlled structural variance is the
    products listing's `include=` parameter.


    Authenticate with `Authorization: Bearer <key>` (preferred) or `X-Api-Key`.
    A key holds scopes, each operation names the one it needs in
    `x-required-scope`, and a key without it is answered `403`
    `insufficient_scope` (`details.required_scope` names it) without using any
    quota; keys made before scopes existed keep exactly the access they had.
    Rate limits are per key on fixed minute/day windows; the `X-RateLimit-*`
    headers are authoritative.


    **Environments** — build against the sandbox first.
    `https://sandbox.mart.ps` is a separate installation with its own keys
    (`mk_test_…`), a periodically refreshed copy of the catalog, synthetic
    customers and orders, and Lahza's test gateway: nothing placed there is
    fulfilled or charged, and its data is reset on a published schedule.
    Production keys are `mk_live_…` and work only against `https://mart.ps`; a
    key sent to the wrong environment answers `401` `key_environment_mismatch`
    before anything else is checked. Every response carries `X-Mart-Environment:
    production|sandbox` — assert it in your client so a misconfigured base URL
    fails loudly.


    This document is the machine contract. The human documentation — onboarding,
    sync guidance, pricing semantics, idempotent retries, the full error
    catalogue with remedies — is at https://mart.ps/api/docs.
servers:
  - url: https://mart.ps
    description: Production
  - url: https://sandbox.mart.ps
    description: Sandbox
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Products
    description: 'Catalog: listing and product detail, with prices and stock.'
  - name: Categories
    description: Catalog category vocabulary for the products category_id filter.
  - name: Attributes
    description: Attribute-group vocabulary behind the products combination attributes.
  - name: Delivery
    description: Delivery destinations for order shipping addresses.
  - name: Orders
    description: >-
      Cash-on-delivery order creation, order list, dry-run validation, order
      read and cancellation.
  - name: Money
    description: >-
      Your balance, the ledger of movements, your statements, your payout
      method, your withdrawals and the feed of events on your account.
  - name: Reports
    description: Your own order totals by month, and your most ordered products.
  - name: Account
    description: 'Your own account: its state, limits and withdrawal rules.'
paths:
  /api/v1/products:
    get:
      tags:
        - Products
      summary: List products
      description: >-
        One page of the catalog, priced for your account, with stock and
        combinations on every row. Returns both active and inactive products
        (each row carries `status`); zero-stock rows remain with `in_stock:
        false`. Sync guidance — including why incremental syncs can never detect
        price changes: https://mart.ps/api/docs#catalog.
      operationId: listProducts
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: limit
          in: query
          description: Default 500, maximum 1000 (both back-office configurable).
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 500
        - name: include
          in: query
          description: >-
            Comma-separated opt-in heavy fields. Supported: `description` (adds
            description and description_short to every item — same content as
            the detail endpoint). Unknown values return 422.
          schema:
            type: string
            example: description
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - inactive
              - all
            default: all
        - name: updated_after
          in: query
          description: >-
            ISO 8601 datetime; filters on the product's last edit time
            (`date_upd`).
          schema:
            type: string
            format: date-time
          example: '2026-07-01T00:00:00+03:00'
        - name: in_stock
          in: query
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
        - name: category_id
          in: query
          description: >-
            Product category id (Meta product taxonomy) — see
            `category.category_id`. Products without a category mapping do not
            match; an unknown id matches nothing (200, empty page).
          schema:
            type: integer
        - name: brand_id
          in: query
          description: >-
            Brand (manufacturer) id — see `brand.id` on any product row. Must be
            a positive integer; `0`, a non-numeric value or a repeated
            `brand_id[]=` answer 422 `invalid_parameter`. Products with no brand
            never match, and an unknown id matches nothing (200, empty page).
          schema:
            type: integer
            minimum: 1
        - name: product_ids
          in: query
          description: >-
            Comma-separated product ids, 1 to 100, to fetch exactly those
            products (for example ones that entered your offer, see `GET
            /products/ids`). Combines with the other filters. Products you are
            not offered never appear. Anything else, including an empty value,
            answers 422 `invalid_parameter`.
          schema:
            type: string
            example: 9597,12402
      responses:
        '200':
          description: One page of products.
          headers:
            X-Mart-Environment:
              $ref: '#/components/headers/X-Mart-Environment'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          products:
                            type: array
                            items:
                              $ref: '#/components/schemas/ProductListItem'
                      meta:
                        type: object
                        properties:
                          pagination:
                            $ref: '#/components/schemas/ListPaginationMeta'
              example:
                status: success
                status_code: 200
                message: OK
                data:
                  products:
                    - product_id: 9597
                      reference: '1005118'
                      name: Hebron Rock and Star Men's Bustar
                      status: active
                      brand:
                        id: 100
                        name: Rock
                      category:
                        category_id: 429
                        category_name: clothing & accessories > shoes & footwear
                        gender: men
                      price:
                        group_price: 54.99
                        public_price: 59.99
                        base_price: 129.99
                      currency: ILS
                      total_quantity: 3
                      in_stock: true
                      cover_image: https://cdn.mart.ps/28359-thickbox_default/product.jpg
                      images:
                        - https://cdn.mart.ps/28359-thickbox_default/product.jpg
                      combinations:
                        - id: 41206
                          available_quantity: 3
                          attributes:
                            - id: 16
                              name: بني
                              group: اللون
                      updated_at: '2026-07-20T14:03:00+03:00'
                meta:
                  pagination:
                    page: 1
                    limit: 500
                    total: 15297
                    total_pages: 31
                    has_next: true
                error: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
      x-codeSamples:
        - lang: bash
          label: cURL recipe
          source: >
            #!/usr/bin/env bash

            # Sync the catalogue: read every page of the products your key is
            offered.

            # Needs MART_API_BASE and MART_API_KEY.

            set -euo pipefail


            # api PATH: sets $body, or prints the status and error code and
            stops.

            api() {
              local response status retry_after
              response=$(curl --silent --show-error --max-time 30 \
                --header @<(printf 'Authorization: Bearer %s\n' "$MART_API_KEY") \
                --write-out '\n%{http_code} %header{retry-after}' "$MART_API_BASE$1") || { echo "error: no answer" >&2; exit 1; }
              read -r status retry_after <<<"${response##*$'\n'}"
              body=${response%$'\n'*}
              if [ "$status" -ge 300 ]; then
                echo "error: $status $(jq -r '.error.code' <<<"$body" 2>/dev/null || echo '(not JSON)')${retry_after:+, try again after $retry_after s}" >&2
                exit 1
              fi
            }


            page=1

            total=0

            while true; do
              api "/api/v1/products?limit=100&page=$page"
              count=$(jq '.data.products | length' <<<"$body")
              # Store the products here: jq -c '.data.products[]' prints one per line.
              total=$((total + count))
              echo "page $page: $count products"
              [ "$(jq -r '.meta.pagination.has_next' <<<"$body")" = true ] || break
              page=$((page + 1))
              sleep 1 # a pause between pages, so a full sync never arrives as one burst
            done

            echo "products: $total"
        - lang: typescript
          label: TypeScript recipe
          source: >
            // Sync the catalogue: read every page of the products your key is
            offered.

            // Node 22.18 or later runs this .ts file as it is. Needs
            MART_API_BASE and MART_API_KEY.

            const base = process.env.MART_API_BASE;

            const key = process.env.MART_API_KEY;

            if (!base || !key) throw new Error('Set MART_API_BASE and
            MART_API_KEY');


            const sleep = (ms: number) => new Promise((resolve) =>
            setTimeout(resolve, ms));


            async function get(path: string): Promise<any> {
              const response = await fetch(`${base}${path}`, {
                headers: { Authorization: `Bearer ${key}` },
                signal: AbortSignal.timeout(30_000),
              });
              const body = await response.json().catch(() => null); // an edge error page is not JSON
              if (!response.ok || body === null) {
                const retryAfter = response.headers.get('retry-after');
                console.error(`error: ${response.status} ${body?.error?.code ?? '(not JSON)'}${retryAfter ? `, try again after ${retryAfter} s` : ''}`);
                process.exit(1);
              }
              return body;
            }


            let page = 1;

            let total = 0;

            while (true) {
              const body = await get(`/api/v1/products?limit=100&page=${page}`);
              const products: any[] = body.data.products;
              // Store the products here.
              total += products.length;
              console.log(`page ${page}: ${products.length} products`);
              if (!body.meta.pagination.has_next) break;
              page++;
              await sleep(1000); // a pause between pages, so a full sync never arrives as one burst
            }

            console.log(`products: ${total}`);
        - lang: python
          label: Python recipe
          source: >
            """Sync the catalogue: read every page of the products your key is
            offered. Python 3.9+, httpx.


            Needs MART_API_BASE and MART_API_KEY.

            """

            import os

            import sys

            import time


            import httpx


            TIMEOUT = 30

            client = httpx.Client(
                base_url=os.environ["MART_API_BASE"],
                headers={"Authorization": f"Bearer {os.environ['MART_API_KEY']}"},
                timeout=TIMEOUT,
            )



            def body_of(response: httpx.Response):
                """The JSON body, or None for an answer that is not JSON (an edge error page)."""
                try:
                    return response.json()
                except ValueError:
                    return None


            def check(response: httpx.Response) -> dict:
                body = body_of(response)
                if response.is_error or body is None:
                    code = body["error"]["code"] if body else "(not JSON)"
                    retry_after = response.headers.get("Retry-After")
                    sys.exit(f"error: {response.status_code} {code}" + (f", try again after {retry_after} s" if retry_after else ""))
                return body


            page = 1

            total = 0

            while True:
                body = check(client.get("/api/v1/products", params={"limit": 100, "page": page}))
                products = body["data"]["products"]
                # Store the products here.
                total += len(products)
                print(f"page {page}: {len(products)} products")
                if not body["meta"]["pagination"]["has_next"]:
                    break
                page += 1
                time.sleep(1)  # a pause between pages, so a full sync never arrives as one burst
            print(f"products: {total}")
        - lang: php
          label: PHP recipe
          source: >
            <?php

            // Sync the catalogue: read every page of the products your key is
            offered. PHP 7.4 or later, with

            // the curl extension. Needs MART_API_BASE and MART_API_KEY.

            $base = getenv('MART_API_BASE');

            $key = getenv('MART_API_KEY');


            /**
             * One request with the curl extension. Returns [status, headers (lower-case name => value), body];
             * status 0 when there was no answer at all.
             */
            function request(string $method, string $url, string $key, ?string
            $payload = null, int $timeout = 30): array

            {
                $headers = [];
                $curl = curl_init($url);
                curl_setopt_array($curl, [
                    CURLOPT_CUSTOMREQUEST => $method,
                    CURLOPT_HTTPHEADER => ["Authorization: Bearer $key", 'Content-Type: application/json'],
                    CURLOPT_RETURNTRANSFER => true,
                    CURLOPT_CONNECTTIMEOUT => 10,
                    CURLOPT_TIMEOUT => $timeout,
                    CURLOPT_HEADERFUNCTION => function ($curl, string $line) use (&$headers): int {
                        $parts = explode(':', $line, 2);
                        if (count($parts) === 2) {
                            $headers[strtolower(trim($parts[0]))] = trim($parts[1]);
                        }
                        return strlen($line);
                    },
                ]);
                if ($payload !== null) {
                    curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);
                }
                $body = curl_exec($curl);
                $status = $body === false ? 0 : (int) curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
                curl_close($curl);

                return [$status, $headers, (string) $body];
            }


            /** A GET that must succeed: the decoded body, or the status and
            error code, and stop. */

            function get(string $url, string $key): array

            {
                [$status, $headers, $raw] = request('GET', $url, $key);
                $body = json_decode($raw, true); // null for an answer that is not JSON (an edge error page)
                if ($status < 200 || $status >= 300 || !is_array($body)) {
                    $code = $status === 0 ? 'no answer' : $status . ' ' . ($body['error']['code'] ?? '(not JSON)');
                    $wait = isset($headers['retry-after']) ? ", try again after {$headers['retry-after']} s" : '';
                    fwrite(STDERR, "error: $code$wait\n");
                    exit(1);
                }

                return $body;
            }


            $page = 1;

            $total = 0;

            while (true) {
                $body = get("$base/api/v1/products?limit=100&page=$page", $key);
                $products = $body['data']['products'];
                // Store the products here.
                $total += count($products);
                echo "page $page: " . count($products) . " products\n";
                if (!$body['meta']['pagination']['has_next']) {
                    break;
                }
                $page++;
                sleep(1); // a pause between pages, so a full sync never arrives as one burst
            }

            echo "products: $total\n";
        - lang: go
          label: Go recipe
          source: "//go:build ignore\n\n// Sync the catalogue: read every page of the products your key is offered. Go 1.22 or later.\n// Needs MART_API_BASE and MART_API_KEY. Run it with: go run sync-the-catalogue.go\npackage main\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"os\"\n\t\"time\"\n)\n\nvar client = &http.Client{Timeout: 30 * time.Second}\n\nfunc main() {\n\tpage, total := 1, 0\n\tfor {\n\t\tvar body struct {\n\t\t\tData struct {\n\t\t\t\tProducts []json.RawMessage `json:\"products\"`\n\t\t\t} `json:\"data\"`\n\t\t\tMeta struct {\n\t\t\t\tPagination struct {\n\t\t\t\t\tHasNext bool `json:\"has_next\"`\n\t\t\t\t} `json:\"pagination\"`\n\t\t\t} `json:\"meta\"`\n\t\t}\n\t\tget(fmt.Sprintf(\"/api/v1/products?limit=100&page=%d\", page), &body)\n\t\t// Store the products here: decode each json.RawMessage into your own type.\n\t\ttotal += len(body.Data.Products)\n\t\tfmt.Printf(\"page %d: %d products\\n\", page, len(body.Data.Products))\n\t\tif !body.Meta.Pagination.HasNext {\n\t\t\tbreak\n\t\t}\n\t\tpage++\n\t\ttime.Sleep(time.Second) // a pause between pages, so a full sync never arrives as one burst\n\t}\n\tfmt.Println(\"products:\", total)\n}\n\n// get sends one GET and decodes its answer into out.\nfunc get(path string, out any) {\n\treq, err := http.NewRequest(http.MethodGet, os.Getenv(\"MART_API_BASE\")+path, nil)\n\tif err != nil {\n\t\tfail(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer \"+os.Getenv(\"MART_API_KEY\"))\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tfail(fmt.Errorf(\"no answer: %v\", err))\n\t}\n\tdecode(resp, out)\n}\n\n// decode reads an answer into out. An error answer, or one that is not JSON (an edge error page),\n// stops with its status and error code.\nfunc decode(resp *http.Response, out any) {\n\tdefer resp.Body.Close()\n\traw, err := io.ReadAll(resp.Body)\n\tif err != nil {\n\t\tfail(err)\n\t}\n\tvar envelope struct {\n\t\tError *struct {\n\t\t\tCode string `json:\"code\"`\n\t\t} `json:\"error\"`\n\t}\n\tif resp.StatusCode >= 300 {\n\t\tcode := \"(not JSON)\"\n\t\tif json.Unmarshal(raw, &envelope) == nil && envelope.Error != nil {\n\t\t\tcode = envelope.Error.Code\n\t\t}\n\t\twait := \"\"\n\t\tif after := resp.Header.Get(\"Retry-After\"); after != \"\" {\n\t\t\twait = \", try again after \" + after + \" s\"\n\t\t}\n\t\tfail(fmt.Errorf(\"%d %s%s\", resp.StatusCode, code, wait))\n\t}\n\tif err := json.Unmarshal(raw, out); err != nil {\n\t\tfail(fmt.Errorf(\"%d (not JSON)\", resp.StatusCode))\n\t}\n}\n\nfunc fail(err error) {\n\tfmt.Fprintln(os.Stderr, \"error:\", err)\n\tos.Exit(1)\n}\n"
        - lang: java
          label: Java recipe
          source: >
            // Sync the catalogue: read every page of the products your key is
            offered. Java 17 or later, with Jackson.

            // Needs MART_API_BASE and MART_API_KEY. Run it as a single file:
            java -cp <the Jackson jars> sync-the-catalogue.java

            import com.fasterxml.jackson.databind.JsonNode;

            import com.fasterxml.jackson.databind.ObjectMapper;

            import java.io.IOException;

            import java.net.URI;

            import java.net.http.HttpClient;

            import java.net.http.HttpRequest;

            import java.net.http.HttpResponse;

            import java.time.Duration;

            import java.util.Locale;


            class SyncTheCatalogue {
                static final HttpClient CLIENT = HttpClient.newBuilder().connectTimeout(Duration.ofSeconds(10)).build();
                static final ObjectMapper JSON = new ObjectMapper();

                public static void main(String[] args) throws Exception {
                    int page = 1;
                    int total = 0;
                    while (true) {
                        JsonNode body = get("/api/v1/products?limit=100&page=" + page);
                        JsonNode products = body.path("data").path("products");
                        // Store the products here.
                        total += products.size();
                        System.out.println("page " + page + ": " + products.size() + " products");
                        if (!body.path("meta").path("pagination").path("has_next").asBoolean()) {
                            break;
                        }
                        page++;
                        Thread.sleep(1000); // a pause between pages, so a full sync never arrives as one burst
                    }
                    System.out.println("products: " + total);
                }

                /** One GET that must succeed: the decoded body, or the status and error code, and stop. */
                static JsonNode get(String path) throws InterruptedException {
                    HttpRequest request = HttpRequest.newBuilder(URI.create(System.getenv("MART_API_BASE") + path))
                            .header("Authorization", "Bearer " + System.getenv("MART_API_KEY"))
                            .timeout(Duration.ofSeconds(30))
                            .GET()
                            .build();
                    HttpResponse<String> response;
                    try {
                        response = CLIENT.send(request, HttpResponse.BodyHandlers.ofString());
                    } catch (IOException e) {
                        fail("no answer: " + e.getMessage());
                        return null;
                    }
                    JsonNode body = parse(response.body());
                    if (response.statusCode() >= 300 || body == null) {
                        fail(response.statusCode() + " " + code(body) + when(response));
                    }
                    return body;
                }

                /** The JSON body, or null for an answer that is not JSON (an edge error page). */
                static JsonNode parse(String text) {
                    try {
                        return JSON.readTree(text);
                    } catch (IOException e) {
                        return null;
                    }
                }

                static void fail(String message) {
                    System.err.println("error: " + message);
                    System.exit(1);
                }

                static String code(JsonNode body) {
                    return body == null ? "(not JSON)" : body.path("error").path("code").asText();
                }

                /** ", try again after N s" when the answer says how long to wait (Retry-After), else nothing. */
                static String when(HttpResponse<String> response) {
                    return response.headers().firstValue("Retry-After").map(s -> ", try again after " + s + " s").orElse("");
                }
            }
components:
  headers:
    X-Mart-Environment:
      description: >-
        Which installation answered: `production` or `sandbox`. Present on every
        response; assert it once at startup.
      schema:
        type: string
        enum:
          - production
          - sandbox
    X-RateLimit-Limit:
      description: Limit of the tightest active window.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in the tightest active window.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Epoch seconds when the tightest window resets.
      schema:
        type: integer
  schemas:
    SuccessEnvelope:
      type: object
      required:
        - status
        - status_code
        - message
        - data
        - meta
        - error
      properties:
        status:
          type: string
          enum:
            - success
        status_code:
          type: integer
          example: 200
        message:
          type: string
          example: OK
        data:
          type: object
          description: >-
            One key named after the resource (products / product / states /
            categories / attributes / order / validation).
        meta:
          nullable: true
          type: object
        error:
          nullable: true
          type: object
          enum:
            - null
    ProductListItem:
      type: object
      required:
        - product_id
        - reference
        - name
        - status
        - brand
        - category
        - price
        - currency
        - total_quantity
        - in_stock
        - cover_image
        - images
        - combinations
        - updated_at
      properties:
        product_id:
          type: integer
          description: >-
            Stable product identifier used in catalog synchronization and order
            creation.
          example: 68516
        reference:
          type: string
          example: '1005118'
          description: >-
            Human-facing catalog reference. Descriptive data ONLY — editable in
            the back office and never resolved by the API. Key on `product_id`
            instead.
        name:
          type: string
        description:
          type: string
          nullable: true
          description: >-
            HTML as authored. ONLY present when the request carries
            include=description; omitted entirely otherwise.
        description_short:
          type: string
          nullable: true
          description: >-
            ONLY present when the request carries include=description; omitted
            entirely otherwise.
        status:
          type: string
          enum:
            - active
            - inactive
        brand:
          $ref: '#/components/schemas/Brand'
        category:
          $ref: '#/components/schemas/ProductCategory'
        price:
          $ref: '#/components/schemas/Price'
        currency:
          type: string
          example: ILS
        total_quantity:
          type: integer
          description: Aggregate quantity across combinations.
        in_stock:
          type: boolean
        cover_image:
          type: string
          format: uri
          nullable: true
          description: >-
            Single thumbnail URL — the cover image, or the first image when no
            cover is flagged. Always equals `images[0]`; null only when the
            product has no images.
          example: https://cdn.mart.ps/28359-thickbox_default/product.jpg
        images:
          type: array
          items:
            type: string
            format: uri
          description: All product image URLs ordered cover-first, then position.
        combinations:
          type: array
          items:
            $ref: '#/components/schemas/CombinationSummary'
          description: Empty for simple products.
        updated_at:
          type: string
          format: date-time
          nullable: true
    ListPaginationMeta:
      type: object
      required:
        - page
        - limit
        - total
        - total_pages
        - has_next
      properties:
        page:
          type: integer
        limit:
          type: integer
        total:
          type: integer
        total_pages:
          type: integer
        has_next:
          type: boolean
    Brand:
      type: object
      nullable: true
      description: Null when the product has no manufacturer.
      required:
        - id
        - name
      properties:
        id:
          type: integer
          example: 27
        name:
          type: string
          example: Rock
    ProductCategory:
      type: object
      nullable: true
      description: >-
        The product's category data (Meta product taxonomy). Null only when the
        product's category has no mapping row. The full category vocabulary —
        the valid `category_id` filter values — is `GET /api/v1/categories`.
      required:
        - category_id
        - category_name
        - gender
      properties:
        category_id:
          type: integer
          example: 429
        category_name:
          type: string
          example: clothing & accessories > shoes & footwear
        gender:
          type: string
          enum:
            - men
            - women
            - unisex
          example: women
    Price:
      type: object
      description: >-
        Three tax-included prices in the response `currency`, 2 decimals, all
        always present and never null. `base_price` is the highest (or equal);
        `group_price` is NOT guaranteed to be below `public_price`. Semantics:
        https://mart.ps/api/docs#catalog.
      required:
        - group_price
        - public_price
        - base_price
      properties:
        group_price:
          type: number
          description: >-
            Your account's current price: after your customer group's discounts
            and any specific price in effect. This is the ONLY figure the order
            price floor compares against, and the baseline for reward.
          example: 55.99
        public_price:
          type: number
          description: >-
            What an unidentified visitor is charged on the storefront right now.
            Useful as a recommended retail price; it has no bearing on what you
            may sell at, and it is NOT always above group_price.
          example: 59.99
        base_price:
          type: number
          description: >-
            The catalogue price before any specific price or group reduction —
            the crossed-out price. Equal to the other two when nothing is
            discounted.
          example: 99.99
    CombinationSummary:
      type: object
      description: >-
        Combination row as embedded in the listing. `id` is the stable variant
        token — the `combination_id` order creation accepts.
      required:
        - id
        - available_quantity
        - attributes
      properties:
        id:
          type: integer
          example: 41206
        available_quantity:
          type: integer
          example: 7
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/CombinationAttribute'
          description: Ordered by attribute-group position.
    ErrorEnvelope:
      type: object
      required:
        - status
        - status_code
        - message
        - data
        - meta
        - error
      properties:
        status:
          type: string
          enum:
            - fail
        status_code:
          type: integer
          example: 422
        message:
          type: string
        data:
          nullable: true
          enum:
            - null
        meta:
          nullable: true
          enum:
            - null
        error:
          type: object
          required:
            - code
            - details
          properties:
            code:
              type: string
              enum:
                - missing_api_key
                - invalid_api_key
                - key_environment_mismatch
                - api_customer_not_configured
                - customer_group_not_allowed
                - insufficient_scope
                - product_not_found
                - order_not_found
                - route_not_found
                - method_not_allowed
                - invalid_parameter
                - invalid_state
                - rate_limit_exceeded
                - bad_request
                - orders_not_enabled
                - api_group_misconfigured
                - idempotency_conflict
                - unknown_product
                - product_not_offered
                - product_not_orderable
                - combination_required
                - combination_not_allowed
                - unknown_combination
                - combination_mismatch
                - duplicate_product
                - cart_minimum_not_met
                - price_below_minimum
                - price_override_not_allowed
                - insufficient_stock
                - free_shipping_not_covered
                - free_shipping_not_allowed
                - card_not_enabled
                - internal_error
                - order_not_cancellable
                - order_cancellation_not_configured
                - order_cancellation_in_progress
                - card_not_on_file
                - saved_card_invalid
                - card_price_not_allowed
                - card_free_shipping_not_allowed
                - card_declined
                - payment_gateway_unavailable
                - order_creation_in_progress
                - charge_amount_mismatch
                - invalid_cursor
                - cursor_expired
                - ledger_unavailable
                - statement_not_found
                - withdrawals_disabled
                - invalid_iban
                - invalid_account_holder_name
                - invalid_national_id
                - invalid_amount
                - amount_below_minimum
                - payout_method_missing
                - withdrawals_locked
                - too_many_open_withdrawals
                - insufficient_available
                - withdrawal_busy
                - withdrawal_not_found
                - withdrawal_not_cancellable
                - cash_not_allowed
                - payout_method_change_blocked
                - amount_above_cash_maximum
                - invalid_payout_method
                - bank_transfer_not_allowed
            details:
              description: >-
                Structured context (parameter name, supported values, retry
                hints). Empty array when none.
    CombinationAttribute:
      type: object
      required:
        - id
        - name
        - group
      properties:
        id:
          type: integer
          description: Stable attribute-value identifier.
          example: 16
        name:
          type: string
          description: Localized value label.
          example: بني
        group:
          type: string
          description: Localized attribute-group label.
          example: اللون
  responses:
    Unauthorized:
      description: >-
        Missing or unusable API key (`missing_api_key`, `invalid_api_key`).
        Revoked and paused keys answer identically to unknown keys. A key issued
        for the other environment answers `key_environment_mismatch` before any
        lookup: `details.environment` names the environment you called
        (`production` or `sandbox`) — switch base URL or key. See the
        Environments note in the introduction.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >-
        The key does not have the scope this endpoint needs
        (`insufficient_scope`, `details.required_scope` names it; checked before
        the group and the rate limit, so it uses no quota), or the key customer
        is missing/inactive (`api_customer_not_configured`) or outside the
        allowed groups (`customer_group_not_allowed`). Group membership is
        re-checked on every request; access resumes when the customer rejoins an
        allowed group.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    MethodNotAllowed:
      description: >-
        The method is not accepted on this endpoint (`method_not_allowed`). Read
        the `Allow` response header rather than assuming; `OPTIONS` is accepted
        everywhere and answered as a bodyless 204.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    UnprocessableEntity:
      description: >-
        Invalid parameter value (`invalid_parameter`); `error.details` names the
        parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    TooManyRequests:
      description: >-
        Rate limit exceeded (`rate_limit_exceeded`). Carries `Retry-After`
        (seconds) plus the X-RateLimit-* trio of the exceeded window; day-window
        breaches advertise the day reset, not a 60-second retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: >-
        Opaque server failure (`internal_error`). Details are logged server-side
        and never exposed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer <key>'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-Api-Key

````

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