Assortments Import - API Connector - Overview

This documentation describes the process of importing Assortments via the API Connector. It covers the available fields, business rules, and possible errors.

⚙️ Introduction

This job is designed to create and update Assortments, and to link or unlink Products to those Assortments by connecting your system to DJUST via the API Connector. It processes data sent in JSON format through a RESTful API.


📂 Accepted Payload Structure

The accepted payload format specifies the structure required for successful data transmission through the API Connector. Ensuring the payload adheres to this format guarantees efficient integration of Assortments within DJUST platform.

Payload structure example
{
"elements": [
  {
    "assortmentExternalId": "1234",
    "assortmentName": "Soft",
    "productExternalId": ["7890", "5678"],
    "unlink": false
  },
  {
    "assortmentExternalId": "56643",
    "assortmentName": "Alcohol",
    "productExternalId": ["9876", "45676"],
    "unlink": false
  }
],
"paging": {
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalRecords": 0
}
}
💡

The JSON must always be a list of objects


📋 Fields

FieldDefinitionRequired on creationRequired on updateEditableDefault value
assortmentExternalIdAssortment unique external identifier
assortmentNameAssortment name
productExternalIdProduct to link unique external identifier
unlinkUnlink Product(s) from the AssortmentFalse


🧠 Key Business Rules & Notes

  • Linking one or more products to an Assortment is done via productExternalId.

  • Unlinking a product from an Assortment is done by setting unlink: true.

  • A single product can be linked to multiple Assortments with no limit.

📌

Best Practices

✔️ Follow data formatting guidelines for optimal import results