# Products

CrUD service for equipment products

## Get All Equipment Products

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

```json
{"openapi":"3.1.1","info":{"title":"Equipment Terminal Loader","version":"2.0"},"tags":[{"name":"Products","description":"CrUD service for equipment products"}],"servers":[{"url":"/"}],"paths":{"/api/equipment/products":{"get":{"tags":["Products","us-ext"],"summary":"Get All Equipment Products","description":"Retrieve all equipment products that match the specified search criteria.","operationId":"getProductsBySearchTermUsingGET_1","parameters":[{"schema":{"type":"boolean"},"name":"isSoftware","in":"query","description":"Indicates whether to filter products that are software-based or hardware-based.","required":false,"allowEmptyValue":false},{"schema":{"type":"string"},"name":"page","in":"query","description":"The page number of results to return in a paginated response.","required":false,"allowEmptyValue":false},{"schema":{"type":"string"},"name":"size","in":"query","description":"The number of records to return per page.","required":false,"allowEmptyValue":false},{"schema":{"type":"string"},"name":"sort","in":"query","description":"The sorting criteria for the results. Possible values: by name or model.","required":false,"allowEmptyValue":false},{"schema":{"type":"string"},"name":"term","in":"query","description":"A search term to filter products by keyword.","required":false,"allowEmptyValue":false}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"No Products found with search parameters"}},"deprecated":false}}},"components":{"schemas":{"Product":{"type":"object","properties":{"frontends":{"type":"array","description":"List of supported front-end interfaces or applications associated with the product.","items":{"type":"string"}},"manufacturer":{"type":"string","description":"The manufacturer name of the product or terminal."},"metadata":{"description":"Metadata object containing: exchangeId - Unique correlation ID for tracking the request across systems; timestamp - The date and time when the request was generated.","$ref":"#/components/schemas/Metadata"},"modelId":{"type":"integer","format":"int32","description":"Unique numeric identifier of the product model."},"productName":{"type":"string","description":"The display or commercial name of the product."},"productType":{"type":"string","description":"The category of the product. Typically a terminal or device type.","enum":["Terminal","Software"]}},"title":"Product","description":"Represents a product or terminal."},"Metadata":{"type":"object","properties":{"exchangeId":{"type":"string"},"timestamp":{"type":"string","description":"yyyy-MM-dd'T'hh:mm:ss.SSS"}},"title":"Metadata"}}}}
```

## Get a Specific Equipment Product

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

```json
{"openapi":"3.1.1","info":{"title":"Equipment Terminal Loader","version":"2.0"},"tags":[{"name":"Products","description":"CrUD service for equipment products"}],"servers":[{"url":"/"}],"paths":{"/api/equipment/products/{manufacturer}/{deviceType}":{"get":{"tags":["Products","us-ext"],"summary":"Get a Specific Equipment Product","description":"Retrieve a specific equipment product based on the manufacturer and device type.","operationId":"getProductsByManufacturerAndDeviceTypeUsingGET_1","parameters":[{"schema":{"type":"string"},"name":"deviceType","in":"path","description":"The type or model of the device.","required":true},{"schema":{"type":"string"},"name":"manufacturer","in":"path","description":"The manufacturer of the product.","required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Requested product does not exist"}},"deprecated":false}}},"components":{"schemas":{"Product":{"type":"object","properties":{"frontends":{"type":"array","description":"List of supported front-end interfaces or applications associated with the product.","items":{"type":"string"}},"manufacturer":{"type":"string","description":"The manufacturer name of the product or terminal."},"metadata":{"description":"Metadata object containing: exchangeId - Unique correlation ID for tracking the request across systems; timestamp - The date and time when the request was generated.","$ref":"#/components/schemas/Metadata"},"modelId":{"type":"integer","format":"int32","description":"Unique numeric identifier of the product model."},"productName":{"type":"string","description":"The display or commercial name of the product."},"productType":{"type":"string","description":"The category of the product. Typically a terminal or device type.","enum":["Terminal","Software"]}},"title":"Product","description":"Represents a product or terminal."},"Metadata":{"type":"object","properties":{"exchangeId":{"type":"string"},"timestamp":{"type":"string","description":"yyyy-MM-dd'T'hh:mm:ss.SSS"}},"title":"Metadata"}}}}
```


---

# Agent Instructions: 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:

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

The question should be specific, self-contained, and written in natural language.
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.