Discrepancy
========================

Services to report discrepancies in the catalog data, upload screen grabs and get statuses.

Create Discrepancy
------------------

This service provides a method for users to report discrepancies in the catalog data.

.. grid:: 2
    :margin: 0
    :padding: 0

    .. grid-item::
        :columns: 10

        .. code-block:: none
            :caption: Service Endpoint

            POST /v2/catalog/discrepancy

Parameters
~~~~~~~~~~

.. warning::
    :code:`contact_email` or :code:`contact_phone` are required for follow up information regarding a discrepancy. If one is not provided, the discrepancy may not be resolved.

:code:`contact_name` :bdg:`string` :bdg-danger:`required`
    First and Last name of user submitting discrepancy

:code:`contact_email` :bdg:`string` :bdg-warning:`optional`
    Valid email address of user submitting discrepancy

:code:`contact_phone` :bdg:`integer` :bdg-warning:`optional`
    Valid phone number of user submitting discrepancy including country code. Must adhere to E.164 international phone number standard.

:code:`location_id` :bdg:`string` :bdg-danger:`required`
    Location ID of the user submitting discrepancy. Must be a valid location ID.

:code:`catalog_region` :bdg:`string` :bdg-danger:`required`
    Catalog Region used to filter the catalog data. Must be a valid catalog region.

:code:`base_vehicle_id` :bdg:`integer` :bdg-danger:`required`
    Base Vehicle ID returned from :code:`Vehicles` service.

:code:`part_type_id` :bdg:`integer` :bdg-danger:`required`
    Part Type ID returned from the :code:`Parts` service.

:code:`mfr_code` :bdg:`string` :bdg-warning:`optional`
    Manufacturer Code if available.

:code:`part_number` :bdg:`string` :bdg-warning:`optional`
    Part Number if available.

:code:`reason_id` :bdg:`integer` :bdg-warning:`optional`
    Reason code for the discrepancy. See Reason Codes below.

:code:`comments` :bdg:`string` :bdg-danger:`required` :bdg-danger-line:`MAX 300 Characters`
    Detailed comment from the user describing the issue. See Comments below.

Example
~~~~~~~

.. code-block:: json
    :caption: Example Request

    {
        "contact_name": "John Doe",
        "contact_email": "john.doe@example.com",
        "contact_phone": "+15555551234",
        "location_id": "STN",
        "catalog_region": "74dff468-4228-45f2-b63b-441dc8ab70c3",
        "base_vehicle_id": 3386,
        "part_type_id": 1684,
        "mfr_code": "ACD",
        "part_number": "P123",
        "reason_id": 5,
        "comments": "DOES NOT FIT 2022+ MITSUBISHI OUTLANDER",
    }

.. code-block:: json
    :caption: Example Response

    {
        "id": 123456,
        "status": "success",
        "message": "Discrepancy submitted successfully."
    }


Reason Codes
~~~~~~~~~~~~

* 0 - Uncategorized/Other
* 5 - Missing Part Application
* 7 - Incorrect Part Application
* 8 - Incorrect Image
* 9 - Incorrect Video


Comments
~~~~~~~~~~~~

.. hint::
   Resolution of discrepancies depends on the quality of the comments provided. We recommend providing examples or instructions to users to provide sufficiently detailed information for timely resolution of discrepancies.

The following are examples of quality comments:

* "2010 Lexus RX350, parts is listed as #2 solenoid, is actually #1 solenoid"
* "THIS SHOULD BE NOTED TO FIT THE 395MM ROTOR OPTION FOR THIS VEHICLE"
* "THIS PART IS ALSO THE FRONT LEFT OUTER SHOULD COME UP WHEN YOU CLICK F.L.O. NOT JUST ON LEFT OUTER"
* "Also fits 1988 Chevy c1500 5.7L"
* "DOES NOT FIT 2022+ MITSUBISHI OUTLANDER"

UI Recommendations
~~~~~~~~~~~~~~~~~~

.. image:: /assets/discrepancy_ui_example.png
    :alt: Example of a discrepancy UI
    :width: 100%
    :align: center

Upload Media
------------------

This service provides a method for users to upload a screenshot or video to be attached to the discrepancy.

.. warning::
   Only one media file can be uploaded per discrepancy.

.. grid:: 2
    :margin: 0
    :padding: 0

    .. grid-item::
        :columns: 10

        .. code-block:: none
            :caption: Service Endpoint

            POST /v2/catalog/discrepancy/:id:/upload

URL Parameters
~~~~~~~~~~~~~~

:code:`id` :bdg:`integer` :bdg-danger:`required`
    ID of the discrepancy to upload screenshot or video to. This ID is returned by the Create Discrepancy service.

The :code:`Content-Type` header must be set to :code:`multipart/form-data` and the method to POST. The name of the upload input must be :code:`screenshot`


Get Discrepancy Status
----------------------

This service provides a method for users view the current status of a discrepancy.

.. grid:: 2
    :margin: 0
    :padding: 0

    .. grid-item::
        :columns: 10

        .. code-block:: none
            :caption: Service Endpoint

            GET /v2/catalog/discrepancy/:id:

URL Parameters
~~~~~~~~~~~~~~

:code:`id` :bdg:`integer` :bdg-danger:`required`
    ID of the discrepancy to be retrieved. This ID is returned by the Create Discrepancy service.

Example
~~~~~~~

.. code-block:: json
    :caption: Example Response

    {
        "base_vehicle_id": 3386,
        "catalog_region": "a441b0b2-ae65-4378-9c04-08f0eeb63d95",
        "comments": "test comment",
        "created_at": "Fri, 09 May 2025 19:38:08 GMT",
        "id": 910050,
        "location_id": "STN",
        "mfr_code": "MFRCODE",
        "notes": "<p>Need more info</p>",
        "part_number": "PARTNO",
        "part_type_id": 1684,
        "reason": "Missing Part Application",
        "resolution": "Not enough information given by store team member",
        "status": "Waiting on Complaintant",
        "updated_at": "Fri, 09 May 2025 19:41:53 GMT"
    }