> ## 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.
# All Appraisals In Specific Client Reference
This endpoint returns a paginated response. For Client References with a
larger quantity of appraisals, use pagination parameters.
`page` - Defaults to 1. The minimum value is 1, defaults to 1 if it's a
non-positive integer.
`page_size` - Defaults to 25. The minimum value is 10, and the maximum value is 100.
## OpenAPI
````yaml get /client_reference/{client_reference_id}/appraisal
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:
/client_reference/{client_reference_id}/appraisal:
get:
tags:
- default
summary: All Appraisals In Specific Client Reference
parameters:
- $ref: '#/components/parameters/client_reference_id'
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/session-id'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/attachments'
responses:
'200':
description: OK
headers:
Date:
schema:
type: string
example: Tue, 25 Jul 2023 11:52:07 GMT
Content-Type:
schema:
type: string
example: application/json
Content-Length:
schema:
type: integer
example: '2238'
Connection:
schema:
type: string
example: keep-alive
x-request-id:
schema:
type: string
example: 4b4a1ee3-9217-4452-8d61-6427a195fa78
content:
application/json:
schema:
type: object
properties:
appraisals:
type: array
items:
$ref: '#/components/schemas/Appraisal'
metadata:
$ref: '#/components/schemas/AppraisalMetadata'
examples:
Standard response:
value:
appraisals:
- appraisal_id: 97771
client_reference_id: 9337
cpid: 1262828314
rpid: 1263096838
create_time: '2023-07-25 13:51:08'
update_time: '2023-07-25 13:51:08'
cp_name_cart: Apple iPhone 14 Pro Max 1TB
rp_name_cart: Apple iPhone 14 Pro Max 1024GB (2022)
cp_pic_url: https://img.valuechecker.net/,---.jpg
rp_pic_url: https://img.valuechecker.net/,---.jpg
item_quantity: 1
replacement_cost_value: 1684.99
rp_price_date: '2023-07-25 11:07:41'
homepage_client_category_id: 2740
selected_client_category_id: 2740
date_damage: '2024-05-07'
date_purchase: '2024-05-01'
claimed_amount: 1000
shop_name: Amazon UK
shop_url: https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf
is_compensation_based_on_claimed_amount: false
depr_extra_one_year_no_receipt: false
offer_id: 228246862
- appraisal_id: 97770
client_reference_id: 9337
cpid: 1262828314
rpid: 1263096838
create_time: '2023-07-25 13:50:46'
update_time: '2023-07-25 13:50:46'
cp_name_cart: Apple iPhone 14 Pro Max 1TB
rp_name_cart: Apple iPhone 14 Pro Max 1024GB (2022)
cp_pic_url: https://img.valuechecker.net/,---.jpg
rp_pic_url: https://img.valuechecker.net/,---.jpg
item_quantity: 1
replacement_cost_value: 1684.99
date_damage: '2024-05-07'
date_purchase: '2024-05-01'
claimed_amount: 1000
rp_price_date: '2023-07-25 11:07:41'
homepage_client_category_id: 2740
selected_client_category_id: 2740
shop_name: Amazon UK
shop_url: https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf
is_compensation_based_on_claimed_amount: false
depr_extra_one_year_no_receipt: false
offer_id: 228246862
metadata:
ongoing_count: 0
timestamp: '2025-03-31 10:08:36'
appraisals:
current_page: 1
page_size: 25
total_pages: 1
total_items: 2
Attachments parameter response:
summary: Appraisal not yet available
value:
appraisals:
- appraisal_id: 97771
client_reference_id: 9337
cpid: 1262828314
rpid: 1263096838
create_time: '2023-07-25 13:51:08'
update_time: '2023-07-25 13:51:08'
cp_name_cart: Apple iPhone 14 Pro Max 1TB
rp_name_cart: Apple iPhone 14 Pro Max 1024GB (2022)
cp_pic_url: https://img.valuechecker.net/,---.jpg
rp_pic_url: https://img.valuechecker.net/,---.jpg
item_quantity: 1
replacement_cost_value: 1684.99
date_damage: '2024-05-07'
date_purchase: '2024-05-01'
claimed_amount: 1000
rp_price_date: '2023-07-25 11:07:41'
homepage_client_category_id: 2740
selected_client_category_id: 2740
shop_name: Amazon UK
shop_url: https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf
is_compensation_based_on_claimed_amount: false
depr_extra_one_year_no_receipt: false
offer_id: 228246862
attachments:
- file_name: cat.gif
url: >-
https://storage.googleapis.com/vc/example/attachments/1/1/cat.gif
type: image/gif
update_time: '2025-01-01 11:06:45'
- file_name: logo.svg
url: >-
https://storage.googleapis.com/vc/example/attachments/1/2/logo.svg
type: image/svg+xml
update_time: '2025-01-01 11:06:23'
- appraisal_id: 97770
client_reference_id: 9337
cpid: 1262828314
rpid: 1263096838
create_time: '2023-07-25 13:50:46'
update_time: '2023-07-25 13:50:46'
cp_name_cart: Apple iPhone 14 Pro Max 1TB
rp_name_cart: Apple iPhone 14 Pro Max 1024GB (2022)
cp_pic_url: https://img.valuechecker.net/,---.jpg
rp_pic_url: https://img.valuechecker.net/,---.jpg
item_quantity: 1
replacement_cost_value: 1684.99
date_damage: '2024-05-07'
date_purchase: '2024-05-01'
claimed_amount: 1000
rp_price_date: '2023-07-25 11:07:41'
homepage_client_category_id: 2740
selected_client_category_id: 2740
shop_name: Amazon UK
shop_url: https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf
is_compensation_based_on_claimed_amount: false
depr_extra_one_year_no_receipt: false
offer_id: 228246862
attachments: []
metadata:
ongoing_count: 0
timestamp: '2025-03-31 10:08:36'
appraisals:
current_page: 1
page_size: 25
total_pages: 1
total_items: 2
'401':
$ref: '#/components/responses/401'
'404':
description: Not Found
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: Appraisal id 239055 was not found
event_code: ERNFAP
event_dict:
event_severity: ERROR
title: Wrong "appraisal_id" value
description: The appraisal_id "239055" was not found
components:
parameters:
client_reference_id:
name: client_reference_id
in: path
schema:
type: integer
required: true
description: The client reference identifier.
example: '9337'
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.
page:
name: page
in: query
schema:
type: integer
example: '2'
description: Page number for response pagination.
page_size:
name: page_size
in: query
schema:
type: integer
example: '30'
description: Page size for response pagination.
attachments:
name: attachments
in: query
schema:
type: boolean
example: 'true'
description: Optional flag determining if file attachments should be present.
schemas:
Appraisal:
type: object
properties:
appraisal_id:
type: integer
client_reference_id:
type: integer
cpid:
type: integer
rpid:
type: integer
create_time:
type: string
update_time:
type: string
cp_name_cart:
type: string
rp_name_cart:
type: string
cp_pic_url:
type: string
rp_pic_url:
type: string
item_quantity:
type: integer
replacement_cost_value:
type: number
multipleOf: 0.01
date_damage:
type: string
format: date
description: The date of the submitted damage for this product.
date_purchase:
type: string
format: date
description: The date of purchase as reported by the claimant.
claimed_amount:
type: number
multipleOf: 0.01
description: The claimed amount for the appraisal reported by the claimant.
rp_price_date:
type: string
homepage_client_category_id:
type: integer
selected_client_category_id:
type: integer
shop_name:
type: string
shop_url:
type: string
is_acv_cp_price_estimate_based:
type: boolean
deprecated: true
description: >-
Use 'is_compensation_based_on_claimed_amount' instead. This field
will be removed in a future version.
is_compensation_based_on_claimed_amount:
type: boolean
description: >-
Base the ACV calculation on the value from `claimed_amount`
(Purchase Price / Repair) instead of Replacement Cost.
depr_extra_one_year_no_receipt:
type: boolean
offer_id:
type: integer
appraisal_status_id:
type: integer
description: The ID of the assigned appraisal status.
attachments:
type: array
description: Accessible through attachments parameter.
items:
$ref: '#/components/schemas/AppraisalAttachments'
AppraisalMetadata:
type: object
properties:
ongoing_count:
type: integer
description: Count of ongoing calculation of RCV.
timestamp:
type: string
description: Timestamp of the response.
appraisals:
type: object
properties:
current_page:
type: integer
description: Current response pagination page number
page_size:
type: integer
description: Current response pagination page size
total_pages:
type: integer
description: Total pages in the Client Reference
total_items:
type: integer
description: Total items in the Client Reference
AppraisalAttachments:
type: object
properties:
file_name:
type: string
url:
type: string
type:
type: string
update_time:
type: string
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 with `apiKey `. Note the space after "apiKey
".
````