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

# RP: Replacement Products



## OpenAPI

````yaml get /prices
openapi: 3.0.0
info:
  title: ValueChecker API
  description: The ValueChecker Application Programming Interface.
  version: 0.150.1
  x-logo:
    url: >-
      https://files.valuechecker.net/images/default-category-images/Value-Checker_top_bar_logo.png
    backgroundColor: '#FFFFFF'
    altText: ValueChecker logo
  contact:
    name: Contact
    url: https://www.valuechecker.net/contact/
    email: support@valuechecker.net
servers:
  - url: https://api.valuechecker.net/
    description: ValueChecker API URL.
security:
  - apiKey: []
tags:
  - name: default
externalDocs:
  description: PDF Documentation (official)
  url: https://www.valuechecker.net/docs/api/pdf
paths:
  /prices:
    get:
      tags:
        - default
      summary: 'RP: Replacement Products'
      parameters:
        - name: pid
          required: true
          in: query
          schema:
            type: string
          example: '1262828314'
          description: >-
            The product identifier (usually selected from the product search
            response).
        - name: country
          in: query
          schema:
            type: string
          example: '{{country}}'
          description: The country in where prices will be searched.
        - name: client_category
          in: query
          schema:
            type: string
          example: '{{client_category}}'
        - name: client_category_id
          in: query
          schema:
            type: string
          example: '{{client_category_id}}'
        - $ref: '#/components/parameters/client_id'
        - $ref: '#/components/parameters/session-id'
      responses:
        '200':
          description: OK
          headers:
            Date:
              schema:
                type: string
                example: Tue, 25 Jul 2023 11:48:58 GMT
            Content-Type:
              schema:
                type: string
                example: application/json
            Content-Length:
              schema:
                type: integer
                example: '330017'
            Connection:
              schema:
                type: string
                example: keep-alive
            x-request-id:
              schema:
                type: string
                example: 5f6962fe-5c32-4d8d-ad17-0bca391b0c19
          content:
            application/json:
              schema:
                type: object
                properties:
                  claimed_product:
                    $ref: '#/components/schemas/ClaimedProduct'
                  grouped_prices:
                    type: array
                    description: >-
                      !! Group consists of an array of arrays containing price
                      objects. Check the example for more details.
                    items:
                      $ref: '#/components/schemas/PriceListElement'
              example:
                claimed_product:
                  pid: 1262828314
                  master_name: ''
                  product_name: Apple iPhone 14 Pro Max 1TB
                  vcid: 1417514
                  cid: 4364
                  pic_url: https://img.valuechecker.net/,---.jpg
                  product_pic_url: https://img.valuechecker.net/200x,---.jpg
                  product_url: >-
                    https://www.pricerunner.com/pl/1-3202448228/Mobile-Phones/Apple-iPhone-14-Pro-Max-1TB-Compare-Prices
                  specs:
                    - spec_id: 888
                      spec_value: Pro
                      spec_value_display: Pro
                      spec_value_numeric: 2
                      spec_name_display: Model Family
                    - spec_id: 999
                      spec_value: '36'
                      spec_value_display: Apple
                      spec_value_numeric: 3
                      spec_name_display: Brand
                    - spec_id: 8300
                      spec_value: '2022-07-01'
                      spec_value_display: '2022'
                      spec_value_numeric: 1656633600
                      spec_name_display: Release Year
                    - spec_id: 8000
                      spec_value: '1000000'
                      spec_value_display: 1024 GB
                      spec_value_numeric: 1000000
                      spec_name_display: Storage Capacity
                    - spec_id: 5000
                      spec_value: '17.018'
                      spec_value_display: 6.7"
                      spec_value_numeric: 17.02
                      spec_name_display: Screen Size
                  in_stock: true
                  query_at_limit: false
                  client_category_id: 4364
                  client_category: Mobile Phones
                grouped_prices:
                  - - shop_product_name: Apple iPhone 14 Pro Max (1 TB) - Gold
                      currency: GBP
                      total_price: 1684.99
                      base_price: 1684.99
                      price_date: '2023-07-25 11:07:41'
                      offer_id: 228246862
                      offer_url: https://offer.valuechecker.net/abc---123
                      international: false
                      is_refurbished: false
                      in_stock: true
                      blocked: false
                      country_code: uk
                      product:
                        pid: 1263096838
                        sid: 44001
                        vcid: 1417514
                        source_internal_id: '3202448228'
                        master_name: Apple iPhone 14 Pro Max 1024GB (2022)
                        product_name: Apple iPhone 14 Pro Max 1024GB (2022)
                        master_pic_url: https://img.valuechecker.net/200x,---.jpg
                        pic_url: https://img.valuechecker.net/,---.jpg
                        product_pic_url: https://img.valuechecker.net/200x,---.jpg
                        product_url: https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf
                        brand: Apple
                        price:
                          price_url: >-
                            https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf
                        rp_first_choice: true
                        specs:
                          - spec_id: 888
                            spec_value_display: Pro
                            spec_value_numeric: 2
                            spec_name_display: Model Family
                          - spec_id: 999
                            spec_value_display: Apple
                            spec_value_numeric: 3
                            spec_name_display: Brand
                          - spec_id: 8300
                            spec_value_display: '2022'
                            spec_value_numeric: 1656633600
                            spec_name_display: Release Year
                          - spec_id: 8000
                            spec_value_display: 1024 GB
                            spec_value_numeric: 1000000
                            spec_name_display: Storage Capacity
                          - spec_id: 5000
                            spec_value_display: 6.7"
                            spec_value_numeric: 17.02
                            spec_name_display: Screen Size
                        same_alid_as_cp: true
                        score_perfect: true
                        score: 12459
                      shop:
                        shop_name: Amazon UK
                        shop_status: 1
                        shop_score: 0
                      filtered_price: false
                      outside_price_range: false
                    - shop_product_name: Apple iPhone 14 Pro Max (1 TB) - Deep Purple
                      currency: GBP
                      total_price: 1684.99
                      base_price: 1684.99
                      price_date: '2023-07-25 11:07:41'
                      offer_id: 228246863
                      offer_url: https://offer.valuechecker.net/abc---123
                      international: false
                      is_refurbished: false
                      in_stock: true
                      blocked: false
                      country_code: uk
                      product:
                        pid: 1263096838
                        sid: 44001
                        vcid: 1417514
                        source_internal_id: '3202448228'
                        master_name: Apple iPhone 14 Pro Max 1024GB (2022)
                        product_name: Apple iPhone 14 Pro Max 1024GB (2022)
                        master_pic_url: https://img.valuechecker.net/200x,---.jpg
                        pic_url: https://img.valuechecker.net/,---.jpg
                        product_pic_url: https://img.valuechecker.net/200x,---.jpg
                        product_url: >-
                          https://offer-staging.valuechecker.net/dAkKadvB66xaQJoaQF5BrG
                        brand: Apple
                        price:
                          price_url: >-
                            https://offer-staging.valuechecker.net/dAkKadvB66xaQJoaQF5BrG
                        rp_first_choice: true
                        specs:
                          - spec_id: 888
                            spec_value_display: Pro
                            spec_value_numeric: 2
                            spec_name_display: Model Family
                          - spec_id: 999
                            spec_value_display: Apple
                            spec_value_numeric: 3
                            spec_name_display: Brand
                          - spec_id: 8300
                            spec_value_display: '2022'
                            spec_value_numeric: 1656633600
                            spec_name_display: Release Year
                          - spec_id: 8000
                            spec_value_display: 1024 GB
                            spec_value_numeric: 1000000
                            spec_name_display: Storage Capacity
                          - spec_id: 5000
                            spec_value_display: 6.7"
                            spec_value_numeric: 17.02
                            spec_name_display: Screen Size
                        same_alid_as_cp: true
                        score_perfect: true
                        score: 12459
                      shop:
                        shop_name: Amazon UK
                        shop_status: 1
                        shop_score: 0
                      filtered_price: false
                      outside_price_range: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  description:
                    type: string
                  event_code:
                    type: string
                  event_dict:
                    type: object
                    properties:
                      event_severity:
                        type: string
                      title:
                        type: string
                      description:
                        type: string
              example:
                error: Missing parameter
                description: The "pid" parameter is required.
                event_code: ERMPPR
                event_dict:
                  event_severity: ERROR
                  title: Missing parameter
                  description: The "pid" parameter is required.
        '401':
          $ref: '#/components/responses/401'
components:
  parameters:
    client_id:
      name: client_id
      in: query
      schema:
        type: integer
      example: '10'
      description: >-
        The client ID for the request. It's required if you have access to
        multiple clients with your API key. Otherwise, it's optional.
    session-id:
      name: session-id
      in: query
      schema:
        type: string
      example: a1b2c3d4e5f6g7h8i9j0
      description: Optional session identifier of the user.
  schemas:
    ClaimedProduct:
      type: object
      properties:
        pid:
          type: integer
        master_name:
          type: string
        product_name:
          type: string
        vcid:
          type: integer
        cid:
          type: integer
        pic_url:
          type: string
        product_pic_url:
          type: string
        product_url:
          type: string
        specs:
          type: array
          items:
            $ref: '#/components/schemas/Spec'
        in_stock:
          type: boolean
        query_at_limit:
          type: boolean
        client_category_id:
          type: integer
        client_category:
          type: string
    PriceListElement:
      type: object
      properties:
        shop_product_name:
          type: string
        currency:
          type: string
        total_price:
          type: number
          multipleOf: 0.01
        base_price:
          type: number
          multipleOf: 0.01
        price_date:
          type: string
        offer_id:
          type: integer
        offer_url:
          type: string
        international:
          type: boolean
        is_refurbished:
          type: boolean
        in_stock:
          type: boolean
        blocked:
          type: boolean
        country_code:
          type: string
        product:
          $ref: '#/components/schemas/GroupedPricesProduct'
        shop:
          $ref: '#/components/schemas/Shop'
        filtered_price:
          type: boolean
        outside_price_range:
          type: boolean
    Spec:
      type: object
      properties:
        spec_id:
          type: integer
        spec_value:
          type: string
        spec_value_display:
          type: string
        spec_value_numeric:
          type: number
        spec_name:
          type: string
        spec_name_display:
          type: string
    GroupedPricesProduct:
      type: object
      properties:
        pid:
          type: integer
        sid:
          type: integer
        vcid:
          type: integer
        source_internal_id:
          type: string
        master_name:
          type: string
        product_name:
          type: string
        master_pic_url:
          type: string
        pic_url:
          type: string
        product_pic_url:
          type: string
        product_url:
          type: string
        brand:
          type: string
        price:
          type: object
          properties:
            price_url:
              type: string
        rp_first_choice:
          type: boolean
        specs:
          type: array
          items:
            $ref: '#/components/schemas/Spec'
        same_alid_as_cp:
          type: boolean
        score_perfect:
          type: boolean
        score:
          type: number
    Shop:
      type: object
      properties:
        shop_name:
          type: string
        shop_status:
          type: integer
        shop_score:
          type: integer
  responses:
    '401':
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              event_code:
                type: string
              event_dict:
                type: object
                properties:
                  event_severity:
                    type: string
                  title:
                    type: string
                  description:
                    type: string
          example:
            error: Invalid Authorization header
            event_code: ERIT00
            event_dict:
              event_severity: ERROR
              title: Invalid Authorization header
              description: Please provide the right authorization token
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Note! Prefix your <api-key> with `apiKey `. Note the space after "apiKey
        ".

````