Skip to main content

PackNet Online Documentation

PackNet DIM Import Products Endpoint

The Import Products endpoint is used to populate the DIM database with the current information for products. Updates to products can be made in the future through the DIM UI or via update calls made through this same API endpoint.

Calls can be made to create or update product objects with several out-of-the-box properties, such as nesting, cavity fill, and orientation. A single product or several thousand of products may be sent in the same request as a JSON array. All available product properties are outlined below. Custom properties may also be created to meet the needs of individual business use cases.

[POST] https://api.prod1.packnet.app/Dim/v1/Import

Status Codes

  • 200 OK: Command received and processed.

  • 400 Bad request: The request cannot be processed due to apparent client error.

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

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

Request Body

The request body should be a JSON array containing one or more product objects. Each product object should follow the schema below.

Note

When using this request, custom attributes for color and shape should be created before sending the requests.

Request for a Single Product
[
  {
    "identifiers": {
      "gtin": "84815178465165",
      "upc": "123654789147",
      "ean": "68451848",
      "mpn": "651651846165",
      "isbn": "16516515135165",
      "sku": "7770777",
      "itemNumber": "7770777",
      "gtin_8": "6515648651658",
      "gtin_12": "null",
      "gtin_13": "651815168156",
      "gtin_14": "18616548165",
      "isbn_10": "518516556816",
      "isbn_13": "65165168465168"
    },
    "name": "Large Self Watering Pots",
    "description": "12/10/9 Plastic Planters with High Drainage Holes and Deep Reservoir for Indoor Outdoor Garden Plants and Flowers, White with Brown",
    "weight": 3.41,
    "dimensions": {
      "length": 12,
      "width": 12,
      "height": 7.5
    },
    "requiresPadding": true,
    "useDefaultPadding": false,
    "padding": 1,
    "paddedDimensions": {
      "length": 13,
      "width": 13,
      "height": 8.5
    },
    "canContain": true,
    "voidFill": {
      "length": 11.75,
      "width": 11.75,
      "height": 7
    },
    "canNest": true,
    "nesting": {
      "nestGrowthDimension1": 0,
      "nestGrowthDimension2": 0,
      "nestGrowthDimension3": 1,
      "nestMax": 3
    },
    "customAttributes": {
      "Shape": "Bozo",
      "Color": "White with Brown"
    },
    "orientationLocked": true,
    "quantity": 4,
    "isSingleLayer": false,
    "productImage": "https://postimg.cc/vDktSVJM",
    "supplier": "Plants & Pots Distribution",
    "supplierNumber": 75887,
    "manufacturer": "UOUZ",
    "comment": "These sell like hotcakes"
  }
]
Request for Multiple Products
[
  {
    "identifiers": {
      "gtin": "10010010010010",
      "upc": "200200200200",
      "ean": "30030030",
      "mpn": "PLNTBX-001",
      "isbn": "",
      "sku": "PLNTBX-001",
      "itemNumber": "PLNTBX-001",
      "gtin_8": "40040040",
      "gtin_12": "",
      "gtin_13": "5005005005005",
      "gtin_14": "60060060060060",
      "isbn_10": "",
      "isbn_13": ""
    },
    "name": "Premium Plant Box",
    "description": "Wooden plant box for small indoor plants, with built-in drainage tray.",
    "weight": 1.75,
    "dimensions": {
      "length": 16,
      "width": 8,
      "height": 7
    },
    "requiresPadding": true,
    "useDefaultPadding": true,
    "padding": 2,
    "paddedDimensions": {
      "length": 18,
      "width": 10,
      "height": 9
    },
    "canContain": false,
    "voidFill": {
      "length": 0,
      "width": 0,
      "height": 0
    },
    "canNest": false,
    "nesting": {
      "nestGrowthDimension1": 0,
      "nestGrowthDimension2": 0,
      "nestGrowthDimension3": 0,
      "nestMax": 0
    },
    "customAttributes": {
      "Design ID": "3000011",
      "Shape": "Rectangular",
      "Color": "Natural Wood"
    },
    "orientationLocked": false,
    "quantity": 10,
    "isSingleLayer": true,
    "productImage": "https://example.com/images/plantbox.jpg",
    "supplier": "Green Thumb Supplies",
    "supplierNumber": 15002,
    "manufacturer": "Green Thumb",
    "comment": "Popular for DIY home gardens."
  },
  {
    "identifiers": {
      "gtin": "90090090090090",
      "upc": "800800800850",
      "ean": "70070070",
      "mpn": "SOLR-LMP-XL",
      "isbn": "121",
      "sku": "SOLR-LMP-XL",
      "itemNumber": "SOLR-LMP-XL",
      "gtin_8": "",
      "gtin_12": "3434",
      "gtin_13": "",
      "gtin_14": "",
      "isbn_10": "121",
      "isbn_13": "12"
    },
    "name": "Solar Lantern XL",
    "description": "Outdoor solar-powered lantern with adjustable brightness and USB charging.",
    "weight": 2.2,
    "dimensions": {
      "length": 10,
      "width": 10,
      "height": 22
    },
    "requiresPadding": false,
    "useDefaultPadding": false,
    "padding": 0,
    "paddedDimensions": {
      "length": 10,
      "width": 10,
      "height": 22
    },
    "canContain": false,
    "voidFill": {
      "length": 0,
      "width": 0,
      "height": 0
    },
    "canNest": true,
    "nesting": {
      "nestGrowthDimension1": 0,
      "nestGrowthDimension2": 0,
      "nestGrowthDimension3": 2,
      "nestMax": 2
    },
    "customAttributes": {
      "Shape": "Cylinder",
      "Color": "Black"
    },
    "orientationLocked": true,
    "quantity": 20,
    "isSingleLayer": false,
    "productImage": "https://example.com/images/solarlantern-xl.jpg",
    "supplier": "Outdoor Gear Co.",
    "supplierNumber": 24017,
    "manufacturer": "SunBright",
    "comment": "Great for camping and patio lighting."
  }
]
Response
Products Created
 {
  "warnings": [],
  "totalRecordsCreated": 1,
  "isSuccessful": true,
  "errors": []
}
Products Updated
 {
  "warnings": [],
  "totalRecordsUpdated": 1,
  "isSuccessful": true,
  "errors": []
}
Error
{
  "warnings": [],
  "totalRecordsUpdated": 0,
  "isSuccessful": false,
  "errors": [
    "Request body can not be empty"
  ]
}
In this section: