SUPPLIER

This page introduces Supplier imports in DJUST. It explains the overall logic, the data structure, and the expected format for creating and updating Suppliers.

⚙️ Introduction

This job is designed to create and update Suppliers by connecting your system to DJUST via the API Connector or SFTP. It processes data sent in JSON format from a REST API or as a CSV file.

You can:

  • Create and update Suppliers
  • Associate Suppliers with Customer Accounts
  • Map Custom Fields at Supplier level

📂 Import model

CSV Structure

The CSV file must contain one row per Supplier.

📄

Template

You can use the following spreadsheet as a template to structure your import:

Suppliers - Template


API Connector

The API Connector sends data as a JSON payload. The JSON must always be a list of objects.

[
  {
    "name": "string",
    "externalId": "string",
    "inactive": false,
    "description": "string",
    "logo": "string",
    "totalOffers": 0,
    "totalOrders": 0,
    "supplierRating": 0,
    "returnPolicy": "string",
    "banner": "string",
    "accountExternalId": "string",
    "status": "string",
    "storesExternalId": "string"
  },
  {
    "name": "string",
    "externalId": "string"
  }
]

📋 Fields

FieldDefinitionRequired for creationRequired for updateEditableDefault Value
Supplier NameSupplier name✅✅
Supplier External IdUnique external identifier of the Supplier✅✅
Mark Supplier as InactiveSet to TRUE to deactivate the Supplier✅FALSE
DescriptionDescription of the Supplier✅
LogoURL of the Supplier logo✅
Supplier RatingSupplier rating✅
Return PolicyReturn policy of the Supplier✅
BannerURL of the Supplier banner image✅
Account External Id

External ID of the Customer Account linked to the Supplier.

Use || to assign multiple Accounts.

✅
StatusActivation status of the Supplier✅
Store External IdStore ID(s) the Supplier is associated with. Use || to assign multiple stores (e.g. store1||store2). Required in a multi-store context☑️✅default_store
CF_[customFieldExternalId]Custom Field value. Column name must follow the convention CF_ followed by the Custom Field external ID (e.g. CF_deliveryDate)✅
☑️

Conditionally required

⚠️

Required Custom Fields

Any custom fields configured as required in DJUST must also be included.


🧠 Key Business Rules

  • A Supplier is identified by its External Id. If it does not exist, it is created. If it exists, it is updated.
  • Suppliers cannot be permanently removed via import, they can only be deactivated (status change), which is reversible
  • Store External Id is only required in a multi-store context. If not provided, the Supplier is associated with the default store. Use || to separate multiple stores (e.g. store1||store2).
  • Custom Fields use the naming convention CF_customFieldExternalId (e.g. CF_deliveryDate). Empty Custom Field values delete the existing value in DJUST.
📌

Best Practices

✔️ Map required Custom Fields before running the import.


Did this page help you?