openapi: 3.0.3
info:
    title: 'API documentation for TruckPartsCross'
    description: ''
    version: 1.0.0
servers:
    -
        url: ''
paths:
    /api/v2/category:
        get:
            summary: List
            description: 'Get a list of categories (VMRS systems).'
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: [{ id: 1, code: '000', name: Uncategorized, sub_category_count: 1 }, { id: 2, code: '001', name: HVAC, sub_category_count: 7 }, { id: 3, code: '002', name: 'Cab & Hood', sub_category_count: 59 }]
                                properties:
                                    data: { type: array, example: [{ id: 1, code: '000', name: Uncategorized, sub_category_count: 1 }, { id: 2, code: '001', name: HVAC, sub_category_count: 7 }, { id: 3, code: '002', name: 'Cab & Hood', sub_category_count: 59 }], items: { type: object } }
            tags:
                - Categories
    /api/v2/category/search:
        get:
            summary: 'Search a Category in VMRS system'
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nSearch through VMRS systems."
            parameters:
                -
                    in: query
                    name: search
                    description: 'The beginning of category name to look for.'
                    example: totam
                    required: true
                    schema:
                        type: string
                        description: 'The beginning of category name to look for.'
                        example: totam
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: [{ vmrs: '011', name: 'Steer Axle Group-Non Driven' }, { vmrs: '021', name: 'Steer Axle Group-Driven' }, { vmrs: '022', name: 'Drive Axle Assembly-Driven' }, { vmrs: 012-000, name: 'Auxiliary Axles / Axles - Non-Driven, Rear' }, { vmrs: 021-000, name: 'Steer Axle Group-Driven / Axles - Driven, Front Steering' }, { vmrs: 022-000, name: 'Drive Axle Assembly-Driven / Axles - Driven, Rear' }, { vmrs: 011-001, name: 'Steer Axle Group-Non Driven / Axle Components - Non-Driven, Front' }, { vmrs: 012-001, name: 'Auxiliary Axles / Axle Components - Non-Driven, Rear' }, { vmrs: 021-001, name: 'Steer Axle Group-Driven / Axle Components - Driven Front Steer Axle' }, { vmrs: 022-001, name: 'Drive Axle Assembly-Driven / Axle Housing Components - Driven, Rear' }]
                                    meta: { found: 312 }
                                properties:
                                    data: { type: array, example: [{ vmrs: '011', name: 'Steer Axle Group-Non Driven' }, { vmrs: '021', name: 'Steer Axle Group-Driven' }, { vmrs: '022', name: 'Drive Axle Assembly-Driven' }, { vmrs: 012-000, name: 'Auxiliary Axles / Axles - Non-Driven, Rear' }, { vmrs: 021-000, name: 'Steer Axle Group-Driven / Axles - Driven, Front Steering' }, { vmrs: 022-000, name: 'Drive Axle Assembly-Driven / Axles - Driven, Rear' }, { vmrs: 011-001, name: 'Steer Axle Group-Non Driven / Axle Components - Non-Driven, Front' }, { vmrs: 012-001, name: 'Auxiliary Axles / Axle Components - Non-Driven, Rear' }, { vmrs: 021-001, name: 'Steer Axle Group-Driven / Axle Components - Driven Front Steer Axle' }, { vmrs: 022-001, name: 'Drive Axle Assembly-Driven / Axle Housing Components - Driven, Rear' }], items: { type: object } }
                                    meta: { type: object, example: { found: 312 } }
            tags:
                - Categories
    /api/v2/comment:
        get:
            summary: 'List comments'
            description: 'Get a list of comments.'
            parameters:
                -
                    in: query
                    name: part_id
                    description: 'Filter by ID of the part.'
                    example: 4
                    required: true
                    schema:
                        type: integer
                        description: 'Filter by ID of the part.'
                        example: 4
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: [{ id: 1, created_at: { date: '2018-07-30 03:56:03.000000', timezone_type: 3, timezone: America/New_York }, part_id: 1004203, part_name: 'Lube Filter', part_number: LF3000, user_name: 'John Doe', like: true, comment: 'Great tool', date: 'July 30, 2018', approved: true }]
                                    meta: { total: 18, found: 6, other_query_info: null }
                                properties:
                                    data: { type: array, example: [{ id: 1, created_at: { date: '2018-07-30 03:56:03.000000', timezone_type: 3, timezone: America/New_York }, part_id: 1004203, part_name: 'Lube Filter', part_number: LF3000, user_name: 'John Doe', like: true, comment: 'Great tool', date: 'July 30, 2018', approved: true }], items: { type: object } }
                                    meta: { type: object, example: { total: 18, found: 6, other_query_info: null } }
            tags:
                - Comments
        post:
            summary: 'Add a Comment'
            description: 'Create a new comment for a part.'
            parameters:
                -
                    in: query
                    name: part_id
                    description: 'ID of the part to attach the comment to.'
                    example: 19
                    required: true
                    schema:
                        type: integer
                        description: 'ID of the part to attach the comment to.'
                        example: 19
                -
                    in: query
                    name: user_source
                    description: 'Source of the comment. Possible values: 1 (truckinfo.com).'
                    example: 1
                    required: true
                    schema:
                        type: integer
                        description: 'Source of the comment. Possible values: 1 (truckinfo.com).'
                        example: 1
                -
                    in: query
                    name: user_id
                    description: 'ID of the author of the comment.'
                    example: 12
                    required: true
                    schema:
                        type: integer
                        description: 'ID of the author of the comment.'
                        example: 12
                -
                    in: query
                    name: user_name
                    description: 'Name of the author.'
                    example: sapiente
                    required: true
                    schema:
                        type: string
                        description: 'Name of the author.'
                        example: sapiente
                -
                    in: query
                    name: like
                    description: 'One of 1 (like) or 0 (dislike).'
                    example: true
                    required: true
                    schema:
                        type: boolean
                        description: 'One of 1 (like) or 0 (dislike).'
                        example: true
                -
                    in: query
                    name: comment
                    description: 'The text of the comment.'
                    example: non
                    required: true
                    schema:
                        type: string
                        description: 'The text of the comment.'
                        example: non
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 53, created_at: { date: '2019-02-14 11:22:58.000000', timezone_type: 3, timezone: America/New_York }, part_id: 1, part_name: 'Air Compressor', part_number: N5060, user_name: 'John Doe', like: true, comment: 'Great tool', date: 'February 14, 2019', approved: false }
                                properties:
                                    data: { type: object, example: { id: 53, created_at: { date: '2019-02-14 11:22:58.000000', timezone_type: 3, timezone: America/New_York }, part_id: 1, part_name: 'Air Compressor', part_number: N5060, user_name: 'John Doe', like: true, comment: 'Great tool', date: 'February 14, 2019', approved: false } }
            tags:
                - Comments
    '/api/v2/comment/{id}':
        get:
            summary: 'Retrieve a Comment'
            description: 'Fetch an existing comment.'
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 1, created_at: { date: '2018-07-30 03:56:03.000000', timezone_type: 3, timezone: America/New_York }, part_id: 1004203, part_name: 'Lube Filter', part_number: LF3000, user_name: 'John Doe', like: true, comment: 'Great tool', date: 'July 30, 2018', approved: true }
                                properties:
                                    data: { type: object, example: { id: 1, created_at: { date: '2018-07-30 03:56:03.000000', timezone_type: 3, timezone: America/New_York }, part_id: 1004203, part_name: 'Lube Filter', part_number: LF3000, user_name: 'John Doe', like: true, comment: 'Great tool', date: 'July 30, 2018', approved: true } }
            tags:
                - Comments
        parameters:
            -
                in: path
                name: id
                description: 'ID of the comment to fetch.'
                example: 10
                required: true
                schema:
                    type: integer
    /api/v2/comment/can-add:
        get:
            summary: 'Check if user can add Comment'
            description: 'Check if user can add new Comment for specified part.'
            parameters:
                -
                    in: query
                    name: part_id
                    description: 'ID of the part to attach the comment to.'
                    example: 4
                    required: true
                    schema:
                        type: integer
                        description: 'ID of the part to attach the comment to.'
                        example: 4
                -
                    in: query
                    name: user_source
                    description: 'Source of the comment. Possible values: 1 (truckinfo.com).'
                    example: 1
                    required: true
                    schema:
                        type: integer
                        description: 'Source of the comment. Possible values: 1 (truckinfo.com).'
                        example: 1
                -
                    in: query
                    name: user_id
                    description: 'ID of the author of the comment.'
                    example: 19
                    required: true
                    schema:
                        type: integer
                        description: 'ID of the author of the comment.'
                        example: 19
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    result: true
                                properties:
                                    result: { type: boolean, example: true }
            tags:
                - Comments
    /api/component_param:
        post:
            summary: Create
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nCreate the component parameter."
            parameters:
                -
                    in: query
                    name: component_id
                    description: 'ID of the component.'
                    example: 1
                    required: true
                    schema:
                        type: integer
                        description: 'ID of the component.'
                        example: 1
                -
                    in: query
                    name: name
                    description: 'Name of the component parameter.'
                    example: autem
                    required: true
                    schema:
                        type: string
                        description: 'Name of the component parameter.'
                        example: autem
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 23, component_id: 10, name: 'Spline Diameter', slug: spline_diameter, order: 3 }
                                properties:
                                    data: { type: object, example: { id: 23, component_id: 10, name: 'Spline Diameter', slug: spline_diameter, order: 3 } }
            tags:
                - 'Component Parameters'
    '/api/component_param/{id}':
        put:
            summary: Update
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nUpdate the component parameter."
            parameters:
                -
                    in: query
                    name: component_id
                    description: 'ID of the component.'
                    example: 2
                    required: true
                    schema:
                        type: integer
                        description: 'ID of the component.'
                        example: 2
                -
                    in: query
                    name: name
                    description: 'Name of the component parameter.'
                    example: accusamus
                    required: true
                    schema:
                        type: string
                        description: 'Name of the component parameter.'
                        example: accusamus
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 23, component_id: 10, name: 'Spline Diameter', slug: spline_diameter, order: 3 }
                                properties:
                                    data: { type: object, example: { id: 23, component_id: 10, name: 'Spline Diameter', slug: spline_diameter, order: 3 } }
            tags:
                - 'Component Parameters'
        delete:
            summary: Delete
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nDelete the component parameter"
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    type: object
                                example: []
            tags:
                - 'Component Parameters'
        parameters:
            -
                in: path
                name: id
                description: 'ID of the component parameter.'
                example: 18
                required: true
                schema:
                    type: integer
    /api/component:
        get:
            summary: List
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nGet the list of components."
            parameters:
                -
                    in: query
                    name: sort_by
                    description: 'What column to sort the results on. Defaults to ''name''. Possible values: ''name''.'
                    example: name
                    required: false
                    schema:
                        type: string
                        description: 'What column to sort the results on. Defaults to ''name''. Possible values: ''name''.'
                        example: name
                -
                    in: query
                    name: sort_dir
                    description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
                    example: asc
                    required: false
                    schema:
                        type: string
                        description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
                        example: asc
                -
                    in: query
                    name: page
                    description: 'Page of result to return. Defaults to 1.'
                    example: 15
                    required: false
                    schema:
                        type: integer
                        description: 'Page of result to return. Defaults to 1.'
                        example: 15
                -
                    in: query
                    name: per_page
                    description: 'How many rows to return per page. Defaults to 10, maximum 100.'
                    example: 20
                    required: false
                    schema:
                        type: integer
                        description: 'How many rows to return per page. Defaults to 10, maximum 100.'
                        example: 20
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: [{ id: 20, name: 'Air System - Air Dryers', notes: null, image: 'https://api-truckpartscross.com/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'https://api-truckpartscross.com/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }] }]
                                properties:
                                    data: { type: array, example: [{ id: 20, name: 'Air System - Air Dryers', notes: null, image: 'https://api-truckpartscross.com/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'https://api-truckpartscross.com/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }] }], items: { type: object } }
            tags:
                - Components
        post:
            summary: Create
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nCreate the component"
            parameters:
                -
                    in: query
                    name: name
                    description: 'Name of the component.'
                    example: sit
                    required: true
                    schema:
                        type: string
                        description: 'Name of the component.'
                        example: sit
                -
                    in: query
                    name: notes
                    description: 'Notes to the component.'
                    example: molestiae
                    required: false
                    schema:
                        type: string
                        description: 'Notes to the component.'
                        example: molestiae
                -
                    in: query
                    name: image
                    description: 'file Picture with explanations of component parameters.'
                    example: voluptatem
                    required: false
                    schema:
                        type: string
                        description: 'file Picture with explanations of component parameters.'
                        example: voluptatem
                -
                    in: query
                    name: default_manufacturer_id
                    description: '`ID` of the default manufacturer.'
                    example: 17
                    required: false
                    schema:
                        type: integer
                        description: '`ID` of the default manufacturer.'
                        example: 17
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] }
                                properties:
                                    data: { type: object, example: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] } }
            tags:
                - Components
    '/api/component/{id}':
        get:
            summary: Retrieve
            description: "Retrieve a specified component. In the retrieved component will be shown only parts from the default manufacturer.\nIf no default manufacturer is specified the first one is considered as the default."
            parameters:
                -
                    in: query
                    name: manufacturer_id
                    description: "Show only parts made by specified manufacturer, if not specified,\n   parts of the default manufacturer will be shown."
                    example: 7
                    required: false
                    schema:
                        type: integer
                        description: "Show only parts made by specified manufacturer, if not specified,\n   parts of the default manufacturer will be shown."
                        example: 7
                -
                    in: query
                    name: all_manufacturers
                    description: 'Show parts from all manufacturers.'
                    example: true
                    required: false
                    schema:
                        type: boolean
                        description: 'Show parts from all manufacturers.'
                        example: true
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] }
                                properties:
                                    data: { type: object, example: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] } }
            tags:
                - Components
        put:
            summary: Update
            description: '<aside class="warning">A Master API key is required to run this command.</aside>'
            parameters:
                -
                    in: query
                    name: name
                    description: 'Name of the component.'
                    example: omnis
                    required: false
                    schema:
                        type: string
                        description: 'Name of the component.'
                        example: omnis
                -
                    in: query
                    name: notes
                    description: 'Notes to the component.'
                    example: vero
                    required: false
                    schema:
                        type: string
                        description: 'Notes to the component.'
                        example: vero
                -
                    in: query
                    name: image
                    description: 'file Picture with explanations of component parameters.'
                    example: possimus
                    required: false
                    schema:
                        type: string
                        description: 'file Picture with explanations of component parameters.'
                        example: possimus
                -
                    in: query
                    name: default_manufacturer_id
                    description: '`ID` of the default manufacturer.'
                    example: 7
                    required: false
                    schema:
                        type: integer
                        description: '`ID` of the default manufacturer.'
                        example: 7
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] }
                                properties:
                                    data: { type: object, example: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] } }
            tags:
                - Components
        delete:
            summary: Delete
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nDelete the component"
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    type: object
                                example: []
            tags:
                - Components
        parameters:
            -
                in: path
                name: id
                description: 'ID of the component.'
                example: 1
                required: true
                schema:
                    type: integer
    '/api/component/{id}/attach':
        post:
            summary: 'Attach image'
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nAttach an image to the component"
            parameters:
                -
                    in: query
                    name: attachment
                    description: 'file Picture with explanations of component parameters.'
                    example: enim
                    required: true
                    schema:
                        type: string
                        description: 'file Picture with explanations of component parameters.'
                        example: enim
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] }
                                properties:
                                    data: { type: object, example: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] } }
            tags:
                - Components
        parameters:
            -
                in: path
                name: id
                description: 'ID of the component.'
                example: 18
                required: true
                schema:
                    type: integer
    '/api/component/{id}/detach':
        post:
            summary: 'Detach image'
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nDetach an image from the component. If image ID is not specified the last image is deleted."
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] }
                                properties:
                                    data: { type: object, example: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] } }
            tags:
                - Components
        parameters:
            -
                in: path
                name: id
                description: 'ID of the component.'
                example: 10
                required: true
                schema:
                    type: integer
            -
                in: path
                name: image_id
                description: 'ID of the image, if not specified the last image is deleted.'
                example: 9
                required: true
                schema:
                    type: integer
    '/api/component/{id}/detach/{image_id}':
        post:
            summary: 'Detach image'
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nDetach an image from the component. If image ID is not specified the last image is deleted."
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] }
                                properties:
                                    data: { type: object, example: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] } }
            tags:
                - Components
        parameters:
            -
                in: path
                name: id
                description: 'ID of the component.'
                example: 20
                required: true
                schema:
                    type: integer
            -
                in: path
                name: image_id
                description: 'ID of the image, if not specified the last image is deleted.'
                example: 8
                required: true
                schema:
                    type: integer
    /api/component/import:
        post:
            summary: Import
            description: 'Import component from CSV file.'
            parameters:
                -
                    in: query
                    name: import-data
                    description: 'file Data file in CSV format.'
                    example: distinctio
                    required: true
                    schema:
                        type: string
                        description: 'file Data file in CSV format.'
                        example: distinctio
                -
                    in: query
                    name: manufacturer_id
                    description: 'ID of the manufacturer.'
                    example: 19
                    required: false
                    schema:
                        type: integer
                        description: 'ID of the manufacturer.'
                        example: 19
                -
                    in: query
                    name: component_id
                    description: 'ID of the component, if it''s not specified the new component will be created.'
                    example: 16
                    required: false
                    schema:
                        type: integer
                        description: 'ID of the component, if it''s not specified the new component will be created.'
                        example: 16
                -
                    in: query
                    name: notify
                    description: 'Email to send the notification.'
                    example: qui
                    required: false
                    schema:
                        type: string
                        description: 'Email to send the notification.'
                        example: qui
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: 'The import has been scheduled. A notification will be sent to john.doe@example.com when it is completed.'
                                properties:
                                    data: { type: string, example: 'The import has been scheduled. A notification will be sent to john.doe@example.com when it is completed.' }
            tags:
                - Components
    '/api/component/{id}/part':
        post:
            summary: 'Add part'
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nAdd part to a component"
            parameters:
                -
                    in: query
                    name: manufacturer_part_id
                    description: 'ID of the part.'
                    example: 16
                    required: true
                    schema:
                        type: integer
                        description: 'ID of the part.'
                        example: 16
                -
                    in: query
                    name: params
                    description: 'array Array with values of the component parameters.'
                    example: est
                    required: true
                    schema:
                        type: string
                        description: 'array Array with values of the component parameters.'
                        example: est
                -
                    in: query
                    name: accessory_id
                    description: 'ID of accessory part.'
                    example: 3
                    required: false
                    schema:
                        type: integer
                        description: 'ID of accessory part.'
                        example: 3
                -
                    in: query
                    name: notes
                    description: 'Notes to the part.'
                    example: quod
                    required: false
                    schema:
                        type: string
                        description: 'Notes to the part.'
                        example: quod
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] }
                                properties:
                                    data: { type: object, example: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] } }
            tags:
                - Components
        parameters:
            -
                in: path
                name: id
                description: 'ID of the component.'
                example: 9
                required: true
                schema:
                    type: integer
    '/api/component/{id}/part/{partId}':
        put:
            summary: 'Update part'
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nUpdate a part linked to the component"
            parameters:
                -
                    in: query
                    name: manufacturer_part_id
                    description: 'ID of the part.'
                    example: 14
                    required: true
                    schema:
                        type: integer
                        description: 'ID of the part.'
                        example: 14
                -
                    in: query
                    name: params
                    description: 'array Array with values of the component parameters.'
                    example: consequatur
                    required: true
                    schema:
                        type: string
                        description: 'array Array with values of the component parameters.'
                        example: consequatur
                -
                    in: query
                    name: accessory_id
                    description: 'ID of accessory part.'
                    example: 4
                    required: false
                    schema:
                        type: integer
                        description: 'ID of accessory part.'
                        example: 4
                -
                    in: query
                    name: notes
                    description: 'Notes to the part.'
                    example: id
                    required: false
                    schema:
                        type: string
                        description: 'Notes to the part.'
                        example: id
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] }
                                properties:
                                    data: { type: object, example: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] } }
            tags:
                - Components
        delete:
            summary: 'Delete part'
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nDelete a part linked to the component"
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] }
                                properties:
                                    data: { type: object, example: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] } }
            tags:
                - Components
        parameters:
            -
                in: path
                name: id
                description: 'ID of the component.'
                example: et
                required: true
                schema:
                    type: string
            -
                in: path
                name: partId
                description: 'Optional parameter. ID of the part linked to the component.'
                required: true
                schema:
                    type: integer
                examples:
                    omitted:
                        summary: 'When the value is omitted'
                        value: ''
                    present:
                        summary: 'When the value is present'
                        value: 8
    '/api/component/{id}/manufacturer/{manufacturerId}':
        delete:
            summary: 'Detach Manufacturer'
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nDetach all parts of the specified manufacturer from the component"
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] }
                                properties:
                                    data: { type: object, example: { id: 20, name: 'Air System - Air Dryers', notes: null, image: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', images: [{ id: 5, url: 'http://api-truckpartscross.local/storage/public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png', path: public/component_images/WrJcNEo6Tv9bIw6lyPNrQIZOfOS8kYWJurFMIMgM.png }], params: [{ id: 130, component_id: 20, name: Manufacturer, slug: manufacturer, order: 1 }], manufacturers: [{ id: 3, name: Bendix, default: 0 }], parts: [{ id: 186128, number: '800959', name: DRYER_AIR, manufacturer_id: 3, manufacturer_name: Bendix, notes: 'Has 1/4" NPT auxiliary inlet port', params: { manufacturer: Bendix, style: AD-IS, voltage: 12V, wattage: 90W, port_size: '1/2"', purge_valve: n/a, purge_volume: Standard, new_or_reman: New, with_sc-pr_valve: 'No', includes_mounting_bracket: n/a, application: 'Chevrolet GMC Kodiak & Topkick C-Models' }, accessory: null }] } }
            tags:
                - Components
        parameters:
            -
                in: path
                name: id
                description: 'ID of the component.'
                example: 17
                required: true
                schema:
                    type: integer
            -
                in: path
                name: manufacturerId
                description: ''
                example: qui
                required: true
                schema:
                    type: string
            -
                in: path
                name: manufacturer_id
                description: 'ID of the manufacturer.'
                example: 20
                required: true
                schema:
                    type: integer
    /api/v2/favorite-parts:
        get:
            summary: List
            description: 'Retrieve all favorite parts'
            parameters:
                -
                    in: query
                    name: user_id
                    description: 'Show only parts that belong to the specified user.'
                    example: 16
                    required: true
                    schema:
                        type: integer
                        description: 'Show only parts that belong to the specified user.'
                        example: 16
                -
                    in: query
                    name: sort_by
                    description: 'What column to sort the results on. Defaults to ''name''. Possible values: ''name''.'
                    example: name
                    required: false
                    schema:
                        type: string
                        description: 'What column to sort the results on. Defaults to ''name''. Possible values: ''name''.'
                        example: name
                -
                    in: query
                    name: sort_dir
                    description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
                    example: asc
                    required: false
                    schema:
                        type: string
                        description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
                        example: asc
                -
                    in: query
                    name: page
                    description: 'Page of result to return. Defaults to 1.'
                    example: 12
                    required: false
                    schema:
                        type: integer
                        description: 'Page of result to return. Defaults to 1.'
                        example: 12
                -
                    in: query
                    name: per_page
                    description: 'How many rows to return per page. Defaults to 10, maximum 100.'
                    example: 20
                    required: false
                    schema:
                        type: integer
                        description: 'How many rows to return per page. Defaults to 10, maximum 100.'
                        example: 20
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: [{ id: 1, user_id: 1, part_id: 710650, part: { id: 710650, name: 'Full-Flow Lube Spin-on', number: LF300, manufacturer_id: 1166, manufacturer_name: Hastings } }]
                                    meta: { total: 1, found: 1, other_query_info: null }
                                properties:
                                    data: { type: array, example: [{ id: 1, user_id: 1, part_id: 710650, part: { id: 710650, name: 'Full-Flow Lube Spin-on', number: LF300, manufacturer_id: 1166, manufacturer_name: Hastings } }], items: { type: object } }
                                    meta: { type: object, example: { total: 1, found: 1, other_query_info: null } }
            tags:
                - 'Favorite Parts'
        post:
            summary: Create
            description: 'Create the favorite part'
            parameters:
                -
                    in: query
                    name: user_id
                    description: 'ID of the user.'
                    example: 17
                    required: true
                    schema:
                        type: integer
                        description: 'ID of the user.'
                        example: 17
                -
                    in: query
                    name: part_id
                    description: 'ID of the part.'
                    example: 8
                    required: true
                    schema:
                        type: integer
                        description: 'ID of the part.'
                        example: 8
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: { id: 1, user_id: 1, part_id: 710650, part: { id: 710650, name: 'Full-Flow Lube Spin-on', number: LF300, manufacturer_id: 1166, manufacturer_name: Hastings } }
                                properties:
                                    data: { type: object, example: { id: 1, user_id: 1, part_id: 710650, part: { id: 710650, name: 'Full-Flow Lube Spin-on', number: LF300, manufacturer_id: 1166, manufacturer_name: Hastings } } }
            tags:
                - 'Favorite Parts'
    '/api/v2/favorite-parts/{id}':
        delete:
            summary: Delete
            description: 'Delete the favorite part'
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    type: object
                                example: []
            tags:
                - 'Favorite Parts'
        parameters:
            -
                in: path
                name: id
                description: 'ID of the part.'
                example: 16
                required: true
                schema:
                    type: integer
    /api/v2/part/search:
        get:
            summary: List
            description: 'Get the list of parts.'
            parameters:
                -
                    in: query
                    name: search
                    description: 'Full or partial part number to look for (min: 3 characters).'
                    example: sed
                    required: true
                    schema:
                        type: string
                        description: 'Full or partial part number to look for (min: 3 characters).'
                        example: sed
                -
                    in: query
                    name: category_id
                    description: 'Filter by ID of the category.'
                    example: 1
                    required: false
                    schema:
                        type: integer
                        description: 'Filter by ID of the category.'
                        example: 1
                -
                    in: query
                    name: sub_category_id
                    description: 'Filter by ID of the sub category.'
                    example: 3
                    required: false
                    schema:
                        type: integer
                        description: 'Filter by ID of the sub category.'
                        example: 3
                -
                    in: query
                    name: manufacturer_id
                    description: 'Filter by ID of the manufacturer.'
                    example: 2
                    required: false
                    schema:
                        type: integer
                        description: 'Filter by ID of the manufacturer.'
                        example: 2
                -
                    in: query
                    name: manufacturer_name
                    description: "Filter by the name of the manufacturer,\nmatches the beginning of the manufacturer name."
                    example: quia
                    required: false
                    schema:
                        type: string
                        description: "Filter by the name of the manufacturer,\nmatches the beginning of the manufacturer name."
                        example: quia
                -
                    in: query
                    name: number
                    description: 'Filter by the number.'
                    example: maiores
                    required: false
                    schema:
                        type: string
                        description: 'Filter by the number.'
                        example: maiores
                -
                    in: query
                    name: vmrs
                    description: 'Filter by the VMRS.'
                    example: consequatur
                    required: false
                    schema:
                        type: string
                        description: 'Filter by the VMRS.'
                        example: consequatur
                -
                    in: query
                    name: no_name
                    description: 'Show only parts which have no name.'
                    example: false
                    required: false
                    schema:
                        type: boolean
                        description: 'Show only parts which have no name.'
                        example: false
                -
                    in: query
                    name: no_xrefs
                    description: 'Show only parts which have no cross references.'
                    example: false
                    required: false
                    schema:
                        type: boolean
                        description: 'Show only parts which have no cross references.'
                        example: false
                -
                    in: query
                    name: no_vmrs
                    description: 'Show only parts which have no VMRS.'
                    example: true
                    required: false
                    schema:
                        type: boolean
                        description: 'Show only parts which have no VMRS.'
                        example: true
                -
                    in: query
                    name: no_category
                    description: 'Show only parts which is not linked with some category.'
                    example: false
                    required: false
                    schema:
                        type: boolean
                        description: 'Show only parts which is not linked with some category.'
                        example: false
                -
                    in: query
                    name: no_ecommerce
                    description: 'Show only parts which have no ecommerce link.'
                    example: false
                    required: false
                    schema:
                        type: boolean
                        description: 'Show only parts which have no ecommerce link.'
                        example: false
                -
                    in: query
                    name: opticat_not_matched
                    description: 'Show only parts which are not matched with opticat part.'
                    example: false
                    required: false
                    schema:
                        type: boolean
                        description: 'Show only parts which are not matched with opticat part.'
                        example: false
                -
                    in: query
                    name: new_from
                    description: "Show only parts created in the period from 'new_from' to 'new_to'.\n'new_to' is required; format 'YYYY-mm-dd'."
                    example: '2021-08-01'
                    required: false
                    schema:
                        type: string
                        description: "Show only parts created in the period from 'new_from' to 'new_to'.\n'new_to' is required; format 'YYYY-mm-dd'."
                        example: '2021-08-01'
                -
                    in: query
                    name: new_to
                    description: "Show only parts created in the period from 'new_from' to 'new_to'.\n'new_from' is required; format 'YYYY-mm-dd'."
                    example: '2021-08-31'
                    required: false
                    schema:
                        type: string
                        description: "Show only parts created in the period from 'new_from' to 'new_to'.\n'new_from' is required; format 'YYYY-mm-dd'."
                        example: '2021-08-31'
                -
                    in: query
                    name: sort_by
                    description: "What column to sort the results on; defaults to 'number'.\nPossible values: 'number' or 'manufacturer_name'."
                    example: manufacturer_name
                    required: false
                    schema:
                        type: string
                        description: "What column to sort the results on; defaults to 'number'.\nPossible values: 'number' or 'manufacturer_name'."
                        example: manufacturer_name
                -
                    in: query
                    name: sort_dir
                    description: 'Sort direction; defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
                    example: desc
                    required: false
                    schema:
                        type: string
                        description: 'Sort direction; defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
                        example: desc
                -
                    in: query
                    name: page
                    description: 'Which page of results to return; defaults to page 1.'
                    example: 6
                    required: false
                    schema:
                        type: integer
                        description: 'Which page of results to return; defaults to page 1.'
                        example: 6
                -
                    in: query
                    name: per_page
                    description: 'How many rows to return, per page; defaults to 10, maximum 100.'
                    example: 6
                    required: false
                    schema:
                        type: integer
                        description: 'How many rows to return, per page; defaults to 10, maximum 100.'
                        example: 6
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: [{ id: 719206, sub_category_id: 139, category_name: Filters, sub_category_name: _Default_, number: LF3, standardized_number: LF3, name: 'By-Pass Lube Spin-on', retail: '0.00', cost: '0.00', image: '', image_url: '', vmrs: '', notes: '', manufacturer_name: Lee, manufacturer_website: null, manufacturer_phone: null, manufacturer_message: null, manufacturer_pdf: '', obsolete: false }]
                                    meta: { total: 1220353, found: 2, other_query_info: null }
                                properties:
                                    data: { type: array, example: [{ id: 719206, sub_category_id: 139, category_name: Filters, sub_category_name: _Default_, number: LF3, standardized_number: LF3, name: 'By-Pass Lube Spin-on', retail: '0.00', cost: '0.00', image: '', image_url: '', vmrs: '', notes: '', manufacturer_name: Lee, manufacturer_website: null, manufacturer_phone: null, manufacturer_message: null, manufacturer_pdf: '', obsolete: false }], items: { type: object } }
                                    meta: { type: object, example: { total: 1220353, found: 2, other_query_info: null } }
                401:
                    description: '401'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    message: Unauthenticated.
                                properties:
                                    message: { type: string, example: Unauthenticated. }
            tags:
                - Parts
    '/api/v2/part/{id}':
        get:
            summary: 'Retrieve a Part'
            description: 'Get a Part and its equivalences.'
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    id: 1004203
                                    sub_category_id: 114
                                    category_name: Filters
                                    sub_category_name: Lube
                                    number: LF3000
                                    standardized_number: LF3000
                                    name: 'Lube Filter'
                                    retail: '0.00'
                                    cost: '0.00'
                                    image: 1004203.jpeg
                                    image_url: 'https://api-truckpartscross.com/storage/parts/1004203.jpeg'
                                    vmrs: ''
                                    notes: '<p>Test note on LF3000</p>'
                                    manufacturer_name: 'Cummins Filtration (Fleetguard)'
                                    manufacturer_website: null
                                    manufacturer_phone: null
                                    manufacturer_message: null
                                    manufacturer_pdf: ''
                                    manufacturer_id: 4077
                                    retail_change_count: 0
                                    average_retail: '0.00'
                                    last_retail_changes: []
                                    amazon_url: 'https://www.amazon.com/gp/search?ie=UTF8&tag=diesellaptops-20&linkCode=ur2&linkId=25b0a443a8e34cd8f0a34f6885e2a793&camp=1789&creative=9325&index=automotive&keywords=LF3000'
                                    google_url: 'https://www.google.com/search?q=LF3000'
                                    ebay_url: 'http://rover.ebay.com/rover/1/711-53200-19255-0/1?ff3=4&pub=5575564369&toolid=10001&campid=5338645045&customid=TruckInfo&mpre=https%3A%2F%2Fwww.ebay.com%2Fsch%2Fi.html?_nkw=LF3000'
                                    obsolete: false
                                properties:
                                    id: { type: integer, example: 1004203 }
                                    sub_category_id: { type: integer, example: 114 }
                                    category_name: { type: string, example: Filters }
                                    sub_category_name: { type: string, example: Lube }
                                    number: { type: string, example: LF3000 }
                                    standardized_number: { type: string, example: LF3000 }
                                    name: { type: string, example: 'Lube Filter' }
                                    retail: { type: string, example: '0.00' }
                                    cost: { type: string, example: '0.00' }
                                    image: { type: string, example: 1004203.jpeg }
                                    image_url: { type: string, example: 'https://api-truckpartscross.com/storage/parts/1004203.jpeg' }
                                    vmrs: { type: string, example: '' }
                                    notes: { type: string, example: '<p>Test note on LF3000</p>' }
                                    manufacturer_name: { type: string, example: 'Cummins Filtration (Fleetguard)' }
                                    manufacturer_website: { type: string, example: null }
                                    manufacturer_phone: { type: string, example: null }
                                    manufacturer_message: { type: string, example: null }
                                    manufacturer_pdf: { type: string, example: '' }
                                    manufacturer_id: { type: integer, example: 4077 }
                                    retail_change_count: { type: integer, example: 0 }
                                    average_retail: { type: string, example: '0.00' }
                                    last_retail_changes: { type: array, example: [] }
                                    amazon_url: { type: string, example: 'https://www.amazon.com/gp/search?ie=UTF8&tag=diesellaptops-20&linkCode=ur2&linkId=25b0a443a8e34cd8f0a34f6885e2a793&camp=1789&creative=9325&index=automotive&keywords=LF3000' }
                                    google_url: { type: string, example: 'https://www.google.com/search?q=LF3000' }
                                    ebay_url: { type: string, example: 'http://rover.ebay.com/rover/1/711-53200-19255-0/1?ff3=4&pub=5575564369&toolid=10001&campid=5338645045&customid=TruckInfo&mpre=https%3A%2F%2Fwww.ebay.com%2Fsch%2Fi.html?_nkw=LF3000' }
                                    obsolete: { type: boolean, example: false }
                401:
                    description: '401'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    message: Unauthenticated.
                                properties:
                                    message: { type: string, example: Unauthenticated. }
            tags:
                - Parts
        parameters:
            -
                in: path
                name: id
                description: 'ID of part to be fetched.'
                example: 15
                required: true
                schema:
                    type: integer
    '/api/v2/part/{id}/equivalences':
        get:
            summary: 'Part Cross-References'
            description: 'Retrieve the list of cross-references for the specified part.'
            parameters:
                -
                    in: query
                    name: search
                    description: 'Full or partial part number to look for.'
                    example: id
                    required: false
                    schema:
                        type: string
                        description: 'Full or partial part number to look for.'
                        example: id
                -
                    in: query
                    name: manufacturer_id
                    description: 'ID of manufacturer to filter result.'
                    example: quam
                    required: false
                    schema:
                        type: string
                        description: 'ID of manufacturer to filter result.'
                        example: quam
                -
                    in: query
                    name: page
                    description: 'Which page of results to return. Defaults to page 1.'
                    example: 8
                    required: false
                    schema:
                        type: integer
                        description: 'Which page of results to return. Defaults to page 1.'
                        example: 8
                -
                    in: query
                    name: per_page
                    description: 'How many rows to return, per page. Defaults to 10.'
                    example: 18
                    required: false
                    schema:
                        type: integer
                        description: 'How many rows to return, per page. Defaults to 10.'
                        example: 18
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: [{ id: 1272397, number: SG319, name: 'Oxygen Sensor', manufacturer_id: 952, manufacturer_name: 'Standard Motor Products', manufacturer_phone: null, manufacturer_website: null, manufacturer_message: null, automatic: true, vmrs: 045-021-000, retail: null, equivalences_count: 32 }]
                                    meta: { total: 43, found: 43, page: 1, per_page: 10, updates: { manufacturer: { id: 953, name: 'Standard Motor Products' } } }
                                properties:
                                    data: { type: array, example: [{ id: 1272397, number: SG319, name: 'Oxygen Sensor', manufacturer_id: 952, manufacturer_name: 'Standard Motor Products', manufacturer_phone: null, manufacturer_website: null, manufacturer_message: null, automatic: true, vmrs: 045-021-000, retail: null, equivalences_count: 32 }], items: { type: object } }
                                    meta: { type: object, example: { total: 43, found: 43, page: 1, per_page: 10, updates: { manufacturer: { id: 953, name: 'Standard Motor Products' } } } }
                401:
                    description: '401'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    message: Unauthenticated.
                                properties:
                                    message: { type: string, example: Unauthenticated. }
            tags:
                - Parts
        parameters:
            -
                in: path
                name: id
                description: 'ID of the part.'
                example: 2
                required: true
                schema:
                    type: integer
    /api/v2/sub-category:
        get:
            summary: List
            description: 'Get a list of sub categories.'
            parameters:
                -
                    in: query
                    name: category_id
                    description: 'ID of the category.'
                    example: beatae
                    required: false
                    schema:
                        type: string
                        description: 'ID of the category.'
                        example: beatae
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: [{ id: 1, code: '000', category_id: 1, category_name: HVAC, name: 'Cab, Climate Control, Instrumentation, & Aerodynamic Devices Group' }]
                                properties:
                                    data: { type: array, example: [{ id: 1, code: '000', category_id: 1, category_name: HVAC, name: 'Cab, Climate Control, Instrumentation, & Aerodynamic Devices Group' }], items: { type: object } }
            tags:
                - 'Sub Categories'
    '/api/v2/user/{uid}/history':
        get:
            summary: 'User search statistics'
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nRetrieve the user search statistics."
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: [{ search: LF3000, date: '2021-08-01' }]
                                    meta: { total: 1987654, found: 50 }
                                properties:
                                    data: { type: array, example: [{ search: LF3000, date: '2021-08-01' }], items: { type: object } }
                                    meta: { type: object, example: { total: 1987654, found: 50 } }
                401:
                    description: '401'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    message: Unauthenticated.
                                properties:
                                    message: { type: string, example: Unauthenticated. }
            tags:
                - Tokens
        parameters:
            -
                in: path
                name: uid
                description: 'ID of the user.'
                example: ea
                required: true
                schema:
                    type: string
    '/api/v2/user/{uid}/favorites':
        post:
            summary: 'Add part'
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nAdd a part to user."
            parameters:
                -
                    in: query
                    name: part_id
                    description: 'ID of the part.'
                    example: 14
                    required: true
                    schema:
                        type: integer
                        description: 'ID of the part.'
                        example: 14
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    id: 1004203
                                    sub_category_id: 114
                                    category_name: Filters
                                    sub_category_name: Lube
                                    number: LF3000
                                    standardized_number: LF3000
                                    name: 'Lube Filter'
                                    retail: '0.00'
                                    cost: '0.00'
                                    image: 1004203.jpeg
                                    image_url: 'https://api-truckpartscross.com/storage/parts/1004203.jpeg'
                                    vmrs: ''
                                    notes: '<p>Test note on LF3000</p>'
                                    manufacturer_name: 'Cummins Filtration (Fleetguard)'
                                    manufacturer_website: null
                                    manufacturer_phone: null
                                    manufacturer_message: null
                                    manufacturer_pdf: ''
                                    manufacturer_id: 4077
                                    retail_change_count: 0
                                    average_retail: '0.00'
                                    last_retail_changes: []
                                    amazon_url: 'https://www.amazon.com/gp/search?ie=UTF8&tag=diesellaptops-20&linkCode=ur2&linkId=25b0a443a8e34cd8f0a34f6885e2a793&camp=1789&creative=9325&index=automotive&keywords=LF3000'
                                    google_url: 'https://www.google.com/search?q=LF3000'
                                    ebay_url: 'http://rover.ebay.com/rover/1/711-53200-19255-0/1?ff3=4&pub=5575564369&toolid=10001&campid=5338645045&customid=TruckInfo&mpre=https%3A%2F%2Fwww.ebay.com%2Fsch%2Fi.html?_nkw=LF3000'
                                    obsolete: false
                                properties:
                                    id: { type: integer, example: 1004203 }
                                    sub_category_id: { type: integer, example: 114 }
                                    category_name: { type: string, example: Filters }
                                    sub_category_name: { type: string, example: Lube }
                                    number: { type: string, example: LF3000 }
                                    standardized_number: { type: string, example: LF3000 }
                                    name: { type: string, example: 'Lube Filter' }
                                    retail: { type: string, example: '0.00' }
                                    cost: { type: string, example: '0.00' }
                                    image: { type: string, example: 1004203.jpeg }
                                    image_url: { type: string, example: 'https://api-truckpartscross.com/storage/parts/1004203.jpeg' }
                                    vmrs: { type: string, example: '' }
                                    notes: { type: string, example: '<p>Test note on LF3000</p>' }
                                    manufacturer_name: { type: string, example: 'Cummins Filtration (Fleetguard)' }
                                    manufacturer_website: { type: string, example: null }
                                    manufacturer_phone: { type: string, example: null }
                                    manufacturer_message: { type: string, example: null }
                                    manufacturer_pdf: { type: string, example: '' }
                                    manufacturer_id: { type: integer, example: 4077 }
                                    retail_change_count: { type: integer, example: 0 }
                                    average_retail: { type: string, example: '0.00' }
                                    last_retail_changes: { type: array, example: [] }
                                    amazon_url: { type: string, example: 'https://www.amazon.com/gp/search?ie=UTF8&tag=diesellaptops-20&linkCode=ur2&linkId=25b0a443a8e34cd8f0a34f6885e2a793&camp=1789&creative=9325&index=automotive&keywords=LF3000' }
                                    google_url: { type: string, example: 'https://www.google.com/search?q=LF3000' }
                                    ebay_url: { type: string, example: 'http://rover.ebay.com/rover/1/711-53200-19255-0/1?ff3=4&pub=5575564369&toolid=10001&campid=5338645045&customid=TruckInfo&mpre=https%3A%2F%2Fwww.ebay.com%2Fsch%2Fi.html?_nkw=LF3000' }
                                    obsolete: { type: boolean, example: false }
                401:
                    description: '401'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    message: Unauthenticated.
                                properties:
                                    message: { type: string, example: Unauthenticated. }
            tags:
                - Tokens
        get:
            summary: 'List parts'
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nRetrieve a list of user parts."
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: [{ id: 719206, sub_category_id: 139, category_name: Filters, sub_category_name: _Default_, number: LF3, standardized_number: LF3, name: 'By-Pass Lube Spin-on', retail: '0.00', cost: '0.00', image: '', image_url: '', vmrs: '', notes: '', manufacturer_name: Lee, manufacturer_website: null, manufacturer_phone: null, manufacturer_message: null, manufacturer_pdf: '', obsolete: false }]
                                    meta: { total: 1220353, found: 2, other_query_info: null }
                                properties:
                                    data: { type: array, example: [{ id: 719206, sub_category_id: 139, category_name: Filters, sub_category_name: _Default_, number: LF3, standardized_number: LF3, name: 'By-Pass Lube Spin-on', retail: '0.00', cost: '0.00', image: '', image_url: '', vmrs: '', notes: '', manufacturer_name: Lee, manufacturer_website: null, manufacturer_phone: null, manufacturer_message: null, manufacturer_pdf: '', obsolete: false }], items: { type: object } }
                                    meta: { type: object, example: { total: 1220353, found: 2, other_query_info: null } }
                401:
                    description: '401'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    message: Unauthenticated.
                                properties:
                                    message: { type: string, example: Unauthenticated. }
            tags:
                - Tokens
        parameters:
            -
                in: path
                name: uid
                description: 'ID of the user.'
                example: quo
                required: true
                schema:
                    type: string
    '/api/v2/user/{uid}/favorites/{part_id}':
        get:
            summary: 'Retrieve part'
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\nRetrieve the user part."
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    id: 1004203
                                    sub_category_id: 114
                                    category_name: Filters
                                    sub_category_name: Lube
                                    number: LF3000
                                    standardized_number: LF3000
                                    name: 'Lube Filter'
                                    retail: '0.00'
                                    cost: '0.00'
                                    image: 1004203.jpeg
                                    image_url: 'https://api-truckpartscross.com/storage/parts/1004203.jpeg'
                                    vmrs: ''
                                    notes: '<p>Test note on LF3000</p>'
                                    manufacturer_name: 'Cummins Filtration (Fleetguard)'
                                    manufacturer_website: null
                                    manufacturer_phone: null
                                    manufacturer_message: null
                                    manufacturer_pdf: ''
                                    manufacturer_id: 4077
                                    retail_change_count: 0
                                    average_retail: '0.00'
                                    last_retail_changes: []
                                    amazon_url: 'https://www.amazon.com/gp/search?ie=UTF8&tag=diesellaptops-20&linkCode=ur2&linkId=25b0a443a8e34cd8f0a34f6885e2a793&camp=1789&creative=9325&index=automotive&keywords=LF3000'
                                    google_url: 'https://www.google.com/search?q=LF3000'
                                    ebay_url: 'http://rover.ebay.com/rover/1/711-53200-19255-0/1?ff3=4&pub=5575564369&toolid=10001&campid=5338645045&customid=TruckInfo&mpre=https%3A%2F%2Fwww.ebay.com%2Fsch%2Fi.html?_nkw=LF3000'
                                    obsolete: false
                                properties:
                                    id: { type: integer, example: 1004203 }
                                    sub_category_id: { type: integer, example: 114 }
                                    category_name: { type: string, example: Filters }
                                    sub_category_name: { type: string, example: Lube }
                                    number: { type: string, example: LF3000 }
                                    standardized_number: { type: string, example: LF3000 }
                                    name: { type: string, example: 'Lube Filter' }
                                    retail: { type: string, example: '0.00' }
                                    cost: { type: string, example: '0.00' }
                                    image: { type: string, example: 1004203.jpeg }
                                    image_url: { type: string, example: 'https://api-truckpartscross.com/storage/parts/1004203.jpeg' }
                                    vmrs: { type: string, example: '' }
                                    notes: { type: string, example: '<p>Test note on LF3000</p>' }
                                    manufacturer_name: { type: string, example: 'Cummins Filtration (Fleetguard)' }
                                    manufacturer_website: { type: string, example: null }
                                    manufacturer_phone: { type: string, example: null }
                                    manufacturer_message: { type: string, example: null }
                                    manufacturer_pdf: { type: string, example: '' }
                                    manufacturer_id: { type: integer, example: 4077 }
                                    retail_change_count: { type: integer, example: 0 }
                                    average_retail: { type: string, example: '0.00' }
                                    last_retail_changes: { type: array, example: [] }
                                    amazon_url: { type: string, example: 'https://www.amazon.com/gp/search?ie=UTF8&tag=diesellaptops-20&linkCode=ur2&linkId=25b0a443a8e34cd8f0a34f6885e2a793&camp=1789&creative=9325&index=automotive&keywords=LF3000' }
                                    google_url: { type: string, example: 'https://www.google.com/search?q=LF3000' }
                                    ebay_url: { type: string, example: 'http://rover.ebay.com/rover/1/711-53200-19255-0/1?ff3=4&pub=5575564369&toolid=10001&campid=5338645045&customid=TruckInfo&mpre=https%3A%2F%2Fwww.ebay.com%2Fsch%2Fi.html?_nkw=LF3000' }
                                    obsolete: { type: boolean, example: false }
                401:
                    description: '401'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    message: Unauthenticated.
                                properties:
                                    message: { type: string, example: Unauthenticated. }
            tags:
                - Tokens
        delete:
            summary: 'Delete part'
            description: "<aside class=\"warning\">A Master API key is required to run this command.</aside>\n\ndelete the part from the user."
            parameters:
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    type: object
                                example: []
                401:
                    description: '401'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    message: Unauthenticated.
                                properties:
                                    message: { type: string, example: Unauthenticated. }
            tags:
                - Tokens
        parameters:
            -
                in: path
                name: uid
                description: 'ID of the user.'
                example: harum
                required: true
                schema:
                    type: string
            -
                in: path
                name: part_id
                description: 'ID of the part.'
                example: 10
                required: true
                schema:
                    type: integer
    /api/v2/vmrs-component:
        get:
            summary: 'List of VMRS Components'
            description: 'Get a list of VMRS components.'
            parameters:
                -
                    in: query
                    name: vmrs_assembly_id
                    description: "ID of the VMRS assembly (sub category).\nAt least one 'vmrs_assembly_id' or '<code>'sub_category_id' is required."
                    example: 9
                    required: false
                    schema:
                        type: integer
                        description: "ID of the VMRS assembly (sub category).\nAt least one 'vmrs_assembly_id' or '<code>'sub_category_id' is required."
                        example: 9
                -
                    in: query
                    name: sub_category_id
                    description: 'The same as ''vmrs_assembly_id''.'
                    example: 6
                    required: false
                    schema:
                        type: integer
                        description: 'The same as ''vmrs_assembly_id''.'
                        example: 6
                -
                    in: header
                    name: X-Authorization
                    description: ''
                    example: '{api-key}'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    data: [{ id: 1, code: '000', sub_category_id: 1, sub_category_name: 'Cab, Climate Control, Instrumentation, & Aerodynamic Devices Group', name: 'Cab, Climate Control, Instrumentation, & Aerodynamic Devices Group' }]
                                properties:
                                    data: { type: array, example: [{ id: 1, code: '000', sub_category_id: 1, sub_category_name: 'Cab, Climate Control, Instrumentation, & Aerodynamic Devices Group', name: 'Cab, Climate Control, Instrumentation, & Aerodynamic Devices Group' }], items: { type: object } }
            tags:
                - 'VMRS Component'
components:
    securitySchemes:
        default:
            type: apiKey
            name: X-Authorization
            in: header
            description: ''
security:
    -
        default: []
