Skip to main content

PackNet Online Documentation

PackNet DIM Get All Products Endpoint

The Get All endpoint allows users to fetch all products from their tenant in a paginated format supporting both JSON and CSV output formats. This endpoint provides flexibility for different client needs such as UI application (JSON) or data exports (CSV).

[GET] https://api.prod1.packnet.app/Dim/v1/GetAll?page=1&format=json

Status Codes
  • 204 No content: There was no content to send.

  • 403 Forbidden: The user is not allowed to make the request.

  • 404 Not found: The requested resource cannot be found.

Query Parameters

  • page - The page number to retrieve. Defaults to 1 when not provided.

  • format - The output format. Accepts "json" or "csv" and is case-insensitive. Defaults to "json" when not provided.

[
  {
    "totalCount": 15000,
    "currentPage": 1,
    "totalPages": 2,
    "pageSize": 9999,
    "startRange": 1,
    "endRange": 9999,
    "products": [
      {
        "tenantId": "846bfb7e-13d1-44a0-ad8b-b39f41b775cc",
        "identifier": "PROD001",
        "identifiers": {
          "upc": "123456789012",
          "sku": "SKU-001",
          "itemNumber": "ITEM-001"
        },
        "name": "Sample Product",
        "description": "Product description",
        "weight": 1.5,
        "requiresPadding": false,
        "useDefaultPadding": false,
        "padding": 0.0,
        "customAttributes": {
          "Color": "Blue",
          "Material": "Plastic"
        },
        "dimensions": {
          "length": 10.0,
          "width": 5.0,
          "height": 3.0
        },
        "paddedDimensions": {
          "length": 10.0,
          "width": 5.0,
          "height": 3.0
        },
        "canContain": false,
        "voidFill": null,
        "canNest": false,
        "nesting": null
      }
    ]
  }
]
 

When the request format is CSV, the endpoint returns a CSV string with pagination metadata in response headers.

Response Headers:

  • X-Total-Count - The total number of products.

  • X-Current-Page - The current page number.

  • X-Total-Pages - The total number of pages.

  • X-Page-Size - The number of products per page, defaulted to 9,999 products per page.

  • X-Start-Range - The starting product number for the page.

  • X-End-Range - The ending product number for the page.

Response Body (CSV String):

Identifier,Name,Description,Weight,Length,Width,Height,RequiresPadding,UseDefaultPadding,Padding,CanContain,CanNest
PROD001,Sample Product,Product description,1.5,10.0,5.0,3.0,False,False,0.0,False,False
PROD002,Another Product,Another description,2.0,12.0,6.0,4.0,False,False,0.0,False,False