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

# Map Amazon browse node ids to GS1 GPC codes

> Map Amazon browse node ids or product-type phrases to GS1 GPC codes. Accepts up to 100 comma-separated browse_id values or q phrases per request (not both). Each browse result carries GPC ancestry, match_precision (SKOS-style), match_source (self | inherited), assurance_state, and browse_node { name, path, in_serving_catalog }. Unmapped ids come back with gpc: null so the response lines up 1:1 with the request. Phrase results are certain-or-blank: a hit is always curated. A class-level hit (e.g. coffee → 50202600) includes forms[] — the child bricks; ask the user which form if they need a leaf, or pass the class code as category= (it matches every brick beneath). An empty gpc list always includes miss { reason, detail, hint, try, candidates }. reason is unmatched_phrase, or ambiguous when several GPC types share the head (fish → prepared vs raw). hint is built from this query; try is nearby lexicon phrases; candidates are competing type identities (code + title), not keyword hits like fish oil. Do not treat empty gpc as 'give up' — read miss and either retry or ask which type. Version-pinned: X-GPC-Release and X-Map-Version, not X-Data-Freshness-Hours.



## OpenAPI

````yaml https://api.syntalic.com/openapi.json get /v1/reference/classify
openapi: 3.1.0
info:
  title: 'Syntalic — Data Analytics for Agentic Commerce '
  version: 1.0.0
  contact:
    name: Syntalic
    email: support@syntalic.com
    url: https://syntalic.com
  description: >-
    Competitive pricing data across US and Canadian e-commerce retailers
    (Amazon, Walmart, Target, Best Buy, Home Depot, etc.). Serves price
    comparisons, deal alerts, brand tracking, promotional intelligence, and
    market analytics to AI agents via x402 and MPP micropayments.
  x-guidance: >-
    This API has three endpoint groups organized by use case:


    **Shopper endpoints** ($0.01/query): Use these for price comparisons and
    deal hunting. Start with /v1/shopper/best-price?q=<product> to find the
    cheapest option across retailers. Use
    /v1/shopper/deal-finder?category=<category> to find discounted products. Use
    /v1/shopper/price-drop-alert?q=<product> to check for recent price drops.


    **Marketing endpoints** ($0.01/query): Use these for competitive analysis.
    /v1/marketing/competitive-landscape?category=<category> shows all products
    in a category with pricing. /v1/marketing/brand-tracker?brand=<brand> tracks
    a brand's pricing over time.
    /v1/marketing/share-of-shelf?category=<category> shows brand market share.


    **Analyst endpoints** ($0.02/query): Use these for market-level insights.
    /v1/analyst/inflation?category=<category> shows price trends over time.
    /v1/analyst/price-dispersion?category=<category> shows price spread across
    retailers.


    All endpoints accept an optional 'country' parameter (us or ca, defaults to
    us). Query parameters use 'q' for free-text search and 'category' for
    category-level queries.


    Marketing and analyst responses carry a `meta` block (served_from,
    freshness_seconds, schema_version) for staleness budgeting and a `resolved`
    block describing how the category input was matched against the taxonomy.
    Every response also sends an X-Data-Freshness-Hours header.


    **Free pre-payment rejection:** requests that cannot be served are rejected
    BEFORE any payment challenge — invalid params (400 INVALID_PARAMS),
    retailers that are not serving-eligible (404 RETAILER_NOT_SERVING_ELIGIBLE,
    with the catalog quality status and the serving_eligible_retailers list in
    error.details), and shopper queries that resolve to nothing in the catalog
    (404 NO_RESULTS). You only pay when the API can actually execute your query.
    Retailer values are case-insensitive (amazon == Amazon).
servers:
  - url: https://api.syntalic.com
security: []
paths:
  /v1/reference/classify:
    get:
      tags:
        - Reference
      summary: Map Amazon browse node ids to GS1 GPC codes
      description: >-
        Map Amazon browse node ids or product-type phrases to GS1 GPC codes.
        Accepts up to 100 comma-separated browse_id values or q phrases per
        request (not both). Each browse result carries GPC ancestry,
        match_precision (SKOS-style), match_source (self | inherited),
        assurance_state, and browse_node { name, path, in_serving_catalog }.
        Unmapped ids come back with gpc: null so the response lines up 1:1 with
        the request. Phrase results are certain-or-blank: a hit is always
        curated. A class-level hit (e.g. coffee → 50202600) includes forms[] —
        the child bricks; ask the user which form if they need a leaf, or pass
        the class code as category= (it matches every brick beneath). An empty
        gpc list always includes miss { reason, detail, hint, try, candidates }.
        reason is unmatched_phrase, or ambiguous when several GPC types share
        the head (fish → prepared vs raw). hint is built from this query; try is
        nearby lexicon phrases; candidates are competing type identities (code +
        title), not keyword hits like fish oil. Do not treat empty gpc as 'give
        up' — read miss and either retry or ask which type. Version-pinned:
        X-GPC-Release and X-Map-Version, not X-Data-Freshness-Hours.
      operationId: classifyBrowseNodes
      parameters:
        - name: browse_id
          in: query
          required: false
          schema:
            type: string
            pattern: ^\d{1,20}(,\d{1,20})*$
          description: >-
            Comma-separated Amazon browse node ids (max 100 per request).
            Provide either browse_id or q, not both.
          example: 300334,12899121
        - name: q
          in: query
          required: false
          schema:
            type: string
          description: >-
            Comma-separated product-type phrases to resolve to GPC bricks or
            classes via the curated lexicon, e.g. 'protein bars' or 'coffee'.
            Max 100 per request. Only an ASCII comma separates phrases.
            Certain-or-blank: a phrase the lexicon does not carry returns an
            empty gpc list plus miss { reason, detail, hint, try, candidates },
            never a nearest guess. A class hit includes forms[]. Provide either
            browse_id or q, not both.
          example: protein bars,laptops
      responses:
        '200':
          description: Browse node to GPC mappings
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        browse_id:
                          type: string
                        browse_node:
                          type: object
                          description: >-
                            Amazon browse node label. name/path are null when
                            taxonomy_nodes is unpublished or the id is unknown.
                          properties:
                            browse_id:
                              type: string
                            name:
                              type: string
                              nullable: true
                            path:
                              type: string
                              nullable: true
                            in_serving_catalog:
                              type: boolean
                        gpc:
                          type: object
                          nullable: true
                          description: >-
                            The matched GS1 GPC node and its ancestry. null when
                            the id has no mapping.
                          properties:
                            code:
                              type: string
                            title:
                              type: string
                            level:
                              type: string
                              enum:
                                - brick
                                - class
                                - family
                                - segment
                            segment:
                              type: string
                              nullable: true
                            family:
                              type: string
                              nullable: true
                            class:
                              type: string
                              nullable: true
                            brick:
                              type: string
                              nullable: true
                            is_catchall:
                              type: boolean
                              nullable: true
                              description: >-
                                True when GS1 files the brick as a residual
                                bucket ('... Other', 'Variety Packs',
                                'Replacement Parts'): the match is still exact,
                                but the brick blends everything GS1 put in it.
                                null above brick level.
                            attributes_defined:
                              type: boolean
                              nullable: true
                              description: >-
                                true: this API serves GS1 attributes for the
                                brick. false: GS1 defines none. null: above
                                brick level, or GS1 defines attributes this API
                                does not serve yet, so an empty attributes list
                                is unknown, not empty.
                        match_precision:
                          type: string
                          nullable: true
                        match_source:
                          type: string
                          nullable: true
                        inherited_from:
                          type: string
                          nullable: true
                        assurance_state:
                          type: string
                          nullable: true
                        attribute_count:
                          type: integer
                        q:
                          type: string
                          description: >-
                            Phrase results: the phrase as looked up, lowercased
                            and normalized. Keeps accents when accent-aware
                            matching is on (rosé), otherwise folded to ASCII.
                        input:
                          type: string
                          description: >-
                            Phrase results with accent-aware matching on: your
                            own text for this entry, trimmed and in Unicode NFC.
                            When one spelling appears more than once in a batch
                            (Rosé,rosé), there is one result and input is its
                            first occurrence. Absent otherwise.
                        q_folded:
                          type: string
                          description: >-
                            Phrase results with accent-aware matching on: the
                            accent-folded phrase (rose). Absent otherwise.
                        match_tier:
                          type: string
                          nullable: true
                          enum:
                            - exact
                            - folded
                          description: >-
                            Phrase results with accent-aware matching on: exact
                            when a lexicon row with this exact spelling
                            answered, folded when an accent-insensitive row did
                            (pate reaches pâté), null on a miss. Absent
                            otherwise.
                        miss:
                          type: object
                          nullable: true
                          description: >-
                            Present iff phrase classify returned an empty gpc
                            list. reason is a closed enum. Read
                            hint/try/candidates instead of giving up.
                          properties:
                            reason:
                              type: string
                              enum:
                                - need_type
                                - unmatched_phrase
                                - ambiguous
                                - out_of_scope
                            detail:
                              type: string
                            hint:
                              type: string
                            try:
                              type: array
                              items:
                                type: string
                              description: >-
                                Lexicon phrases to retry. Not a type guess; gpc
                                is still empty.
                            candidates:
                              type: array
                              items:
                                type: object
                                properties:
                                  code:
                                    type: string
                                  title:
                                    type: string
                                  level:
                                    type: string
                              description: >-
                                Competing GPC type identities when the head is a
                                homograph. Ask which type; do not pick one.
                        forms:
                          type: array
                          items:
                            type: object
                            properties:
                              code:
                                type: string
                              title:
                                type: string
                              level:
                                type: string
                          description: >-
                            Child bricks when the hit is a class. Offer as
                            'which form?' or pass the class code as category=.
                  gpc_release:
                    type: string
                    example: v20260520
                  schema_version:
                    type: string
                    example: v3
        '400':
          description: >-
            Invalid query parameters or unsupported enum values. Rejected by
            preflight BEFORE the payment challenge — no payment is requested or
            charged for malformed requests.
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                properties:
                  type:
                    type: string
                    format: uri-reference
                  title:
                    type: string
                    example: Bad Request
                  status:
                    type: integer
                    const: 400
                  detail:
                    type: string
                  instance:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties: true
                    additionalProperties: true
                additionalProperties: true
        '402':
          description: Payment challenge required before executing paid work
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                properties:
                  type:
                    type: string
                    format: uri-reference
                  title:
                    type: string
                    example: Payment Required
                  status:
                    type: integer
                    const: 402
                  detail:
                    type: string
                  instance:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties: true
                    additionalProperties: true
                additionalProperties: true
        '404':
          description: >-
            No matching result. error.code distinguishes the cases: NO_RESULTS
            (the query resolves to nothing in the catalog),
            RETAILER_NOT_SERVING_ELIGIBLE (the requested retailer exists but is
            not serving-eligible — error.details carries its catalog
            quality_status and the serving_eligible_retailers list to retry
            against), or NOT_PUBLISHED (a social rollup the current publish run
            does not compute yet — a gap in what we publish, not a finding about
            the category). Structurally-unservable requests are rejected by
            preflight before any payment challenge.
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                properties:
                  type:
                    type: string
                    format: uri-reference
                  title:
                    type: string
                    example: Not Found
                  status:
                    type: integer
                    const: 404
                  detail:
                    type: string
                  instance:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties: true
                    additionalProperties: true
                additionalProperties: true
        '429':
          description: Rate limit exceeded
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                properties:
                  type:
                    type: string
                    format: uri-reference
                  title:
                    type: string
                    example: Too Many Requests
                  status:
                    type: integer
                    const: 429
                  detail:
                    type: string
                  instance:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties: true
                    additionalProperties: true
                additionalProperties: true
        '500':
          description: Unexpected server error
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                properties:
                  type:
                    type: string
                    format: uri-reference
                  title:
                    type: string
                    example: Internal Server Error
                  status:
                    type: integer
                    const: 500
                  detail:
                    type: string
                  instance:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties: true
                    additionalProperties: true
                additionalProperties: true

````

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