• Register

Request URL

A request URL is the complete web address used to make an API call. It contains the base endpoint along with all required and optional query parameters that tell the API what data you want, how it should be formatted, and how to authenticate the request. In this example, the request URL includes several key parameters:

  • callInfo.responseDataFormat – specifies whether the response should be XML or JSON

  • callInfo.omitXmlSchema – controls whether XML schema details are included

  • callInfo.callback – used for callback functions (typically for JSONP)

  • term – the search term or field/value being queried

  • storeInfo.id – identifies the store or region for the request

  • callInfo.apiKey – your API key for authentication

  • userInfo.signature – security signature for the request

  • userInfo.timestamp – timestamp used for request validation

  • userInfo.billAccNum – billing account number

  • userInfo.customerId – customer identifier

  • userInfo.contractId – contract identifier

  • resultsSettings.offset – starting point for paginated results

  • resultsSettings.numberOfResults – number of results to return

  • resultsSettings.refinements.filters – filters such as rohsCompliant or inStock

  • resultsSettings.responseGroup – controls the level of detail returned (none, small, medium, large, Prices, Inventory)

.