Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Products

Get Products

Retrieves a list of products within the system that are available for shipping. With this endpoint, you can search for specific products based on various criteria and that provides relevant product details in the response. It is essential for inventory management, order processing, and logistics planning.

get/v4/products

Query parameters

searchTermstring

A string representing the term or keywords used to filter the search results for the products. This parameter helps you find specific products by name, SKU, or other relevant features.

pageSizeinteger

An integer that defines the number of product records returned per page in the response. For instance, if pageSize is set to 20, the API will return up to 20 products in each response.<br><br>Note: By default, this field is set to 100.</br></br>

pageNumberinteger

An integer indicating the specific page of results to retrieve, allowing for pagination of larger datasets. For example, if pageNumber is set to 3, the API will return the results corresponding to the third page of products based on the specified pageSize.<br><br>Note: By default, this field is set to 1.</br></br>

sortBy'Description' | 'Value' | 'HSCode' | 'SKU' | 'Weight' | 'Currency' | 'LastModified' | 'Country' | 'Category'

Sort By

A string specifying the field by which to organise the search results. For instance, "Weight" could be used to sort products on weight values, arranging the results in a more user-friendly order.<br><br>Note: By default, this field is set to Description.</br></br>

sortDir'Ascending' | 'Descending'

Order Direction

A string indicating the direction in which to sort the results, typically set to "ascending" or "descending." For example, setting sortDir to "Ascending" while using "Weight" as sortBy would arrange the products from lower to higher weight values.<br><br>Note: By default, this field is set to Ascending.</br></br>

Response

Returns a list of products.

TotalCountinteger required

An integer representing the total number of products that match the search criteria. This count provides users with an overview of how many product records are available based on the filters applied.

Example response

{
  "Products": [
    {
      "LastUpdatedDateUtc": "2022-02-06T16:13:24.010Z",
      "LastUpdatedBy": "User A",
      "SkuCode": "SKU123",
      "Description": "White Men Large T-shirt",
      "Value": 19.99,
      "Weight": "0.5",
      "HSCode": "6109100010",
      "CountryOfOrigin": "GB",
      "CurrencyCode": "GBP",
      "Hazmat": {
        "UNCode": "1002",
        "ProperShippingName": "Compressed Air",
        "Class": "9",
        "Id8000Category": "Nail Varnish",
        "Quantity": 3.5,
        "EmergencyActionCode": "E012"
      }
    }
  ],
  "TotalCount": 32
}