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

Field

Definition

Required for creation

Required for update

Editable

Default Value

Supplier Name

Supplier name

Supplier External Id

Unique external identifier of the Supplier

Mark Supplier as Inactive

Set to TRUE to deactivate the Supplier

FALSE

Description

Description of the Supplier

Logo

URL of the Supplier logo

Supplier Rating

Supplier rating

Return Policy

Return policy of the Supplier

Banner

URL of the Supplier banner image

Account External Id

External ID of the Customer Account linked to the Supplier.

Use || to assign multiple Accounts.

Status

Activation status of the Supplier

Store External Id

Store ID the Supplier is associated with. 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.
  • 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.