> For the complete documentation index, see [llms.txt](https://docs.xplorpay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-products/products.md).

# Products

## Get specific equipment product

> Retrieve a specific equipment product based on the manufacturer and device type.

```json
{"openapi":"3.0.1","info":{"title":"Equipment Terminal Loader API","version":"2.0"},"paths":{"/api/equipment/products/{manufacturer}/{deviceType}":{"get":{"tags":["Products"],"summary":"Get specific equipment product","description":"Retrieve a specific equipment product based on the manufacturer and device type.","operationId":"getProductsByManufacturerAndDeviceType","parameters":[{"name":"manufacturer","in":"path","description":"The manufacturer of the product.","required":true,"schema":{"type":"string"}},{"name":"deviceType","in":"path","description":"The type or model of the device.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Requested product does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}}}}}},"components":{"schemas":{"Product":{"type":"object","properties":{"manufacturer":{"type":"string","description":"The manufacturer name of the product or terminal."},"productName":{"type":"string","description":"The display or commercial name of the product."},"modelId":{"type":"integer","description":"Unique numeric identifier of the product model.","format":"int32"},"frontends":{"type":"array","description":"List of supported front-end interfaces or applications associated with the product.","items":{"type":"string","description":"List of supported front-end interfaces or applications associated with the product."}},"productType":{"type":"string","description":"The category of the product. Typically a terminal or device type.","enum":["Terminal","Software"]},"metadata":{"$ref":"#/components/schemas/Metadata"}},"description":"Represents a product or terminal."},"Metadata":{"type":"object","properties":{"exchangeId":{"type":"string"},"timestamp":{"type":"string"}}},"ErrorResult":{"type":"object","properties":{"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"$ref":"#/components/schemas/Error"}}}},"Error":{"type":"object","properties":{"errorMessage":{"type":"string","description":"Describes the reason for the error."},"resultCode":{"type":"integer","description":"Numeric code that identifies the type of error returned by the request.","format":"int32"},"timeStamp":{"type":"string","description":"Date and time when the error occurred"}},"description":"Contains one or more error objects returned."}}}}
```

## Get equipment products

> Retrieve all equipment products that match the specified search criteria.

```json
{"openapi":"3.0.1","info":{"title":"Equipment Terminal Loader API","version":"2.0"},"paths":{"/api/equipment/products":{"get":{"tags":["Products"],"summary":"Get equipment products","description":"Retrieve all equipment products that match the specified search criteria.","operationId":"getProductsBySearchTerm","parameters":[{"name":"term","in":"query","description":"A search term to filter products by keyword.","required":false,"schema":{"type":"string","default":""}},{"name":"size","in":"query","description":"The number of records to return per page.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page number of results to return in a paginated response.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"The sorting criteria for the results. Possible values: by name or model.","required":false,"schema":{"type":"string"}},{"name":"isSoftware","in":"query","description":"Indicates whether to filter products that are software-based or hardware-based.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"No Products found with search parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}}}}}},"components":{"schemas":{"Products":{"type":"object","properties":{"products":{"$ref":"#/components/schemas/PageProduct"},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"PageProduct":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"number":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"sort":{"$ref":"#/components/schemas/Sort"},"first":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"pageable":{"$ref":"#/components/schemas/Pageable"},"last":{"type":"boolean"},"empty":{"type":"boolean"}}},"Product":{"type":"object","properties":{"manufacturer":{"type":"string","description":"The manufacturer name of the product or terminal."},"productName":{"type":"string","description":"The display or commercial name of the product."},"modelId":{"type":"integer","description":"Unique numeric identifier of the product model.","format":"int32"},"frontends":{"type":"array","description":"List of supported front-end interfaces or applications associated with the product.","items":{"type":"string","description":"List of supported front-end interfaces or applications associated with the product."}},"productType":{"type":"string","description":"The category of the product. Typically a terminal or device type.","enum":["Terminal","Software"]},"metadata":{"$ref":"#/components/schemas/Metadata"}},"description":"Represents a product or terminal."},"Metadata":{"type":"object","properties":{"exchangeId":{"type":"string"},"timestamp":{"type":"string"}}},"Sort":{"type":"object","properties":{"sorted":{"type":"boolean"},"unsorted":{"type":"boolean"},"empty":{"type":"boolean"}}},"Pageable":{"type":"object","properties":{"offset":{"type":"integer","format":"int64"},"sort":{"$ref":"#/components/schemas/Sort"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"unpaged":{"type":"boolean"},"paged":{"type":"boolean"}}},"ErrorResult":{"type":"object","properties":{"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"$ref":"#/components/schemas/Error"}}}},"Error":{"type":"object","properties":{"errorMessage":{"type":"string","description":"Describes the reason for the error."},"resultCode":{"type":"integer","description":"Numeric code that identifies the type of error returned by the request.","format":"int32"},"timeStamp":{"type":"string","description":"Date and time when the error occurred"}},"description":"Contains one or more error objects returned."}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-products/products.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.