API entities examples

Product and variants

Body example

  • The API is not compatible with multi local languages.
  • The JSON is a list of objects.
[
   {
      "Product_External_Id":"142347",
      "Product_Names":"Product1",
      "Product_Classification_CategoryId":"678",
      "Variant_Names":"Variant1",
      "Variant_ExternalId":"123343-01"
   },
   {
      "Product_External_Id":"142396",
      "Product_Names":"Product 2",
      "Product_Classification_CategoryId":"678",
      "Variant_Names":"Variant2",
      "Variant_ExternalId":"125745-01"
   },
   {
      "Variant_Names":"Variant3",
      "Variant_ExternalId":"133468-02",
      "Product_External_Id":"142347"
   }
]

Fields

Product

Field Mandatory Format
External ID YES String
Name YES String
Classification category ID YES String
Description NO String
Brand NO String
Product unit NO String
Deleted product NO Boolean
Inactive NO Boolean

Variant

Field Mandatory Format
Name YES String
Description NO String
External ID NO String
External SKU NO String
EAN NO String
MPN NO String
Main image URL NO String
Additional image links NO Array
Deleted variant NO Boolean
Inactive NO Boolean
Stores external URLs NO List text

Accounts

Body example 

[
   {
     "name": "John Doe",
     "externalid": "1234567890",
     "companyRegistrationName": "Doe Enterprises Inc.",
     "businessRegistrationNumber": "BRN123456789",
     "address": [
       {
         "externalId": "ADDR12345",
         "fullName": "John Doe",
         "country": "USA",
         "city": "New York",
         "zipcode": "10001",
         "streetName": "123 Main St"
       }
      ] 
   }
]

Fields

Field Mandatory Format
Name YES String
External ID YES String
Company registration name YES String
Business registration number YES String
Address
 Field Mandatory Format
External ID YES String
Full name YES String
Country YES String
City YES String
Zip code YES String
Street name YES String
Label NO String
State NO String
Additional street name NO String
Phone number NO String
Account manager name NO String
Website NO String
VAT number NO String
Deleted NO Boolean
Inactive NO Boolean
Customer tags external IDs NO List text

Offers stock and price

Body example

DJUST only collects offers data using a CSV file.

{
  "urlFile": "https://myurl.com/abc"
}

Fields

Offer stock

Field Mandatory Format
Stock YES Long
Supplier ID YES String
Variant ID YES String
Stock ID YES String
Stock available end date NO Date
Stock available start date NO Date
Active stock NO Boolean
Delete stock NO Boolean
Packing type NO String
Min shipping zone NO String
Min shipping type NO String
Min stock alert NO Integer
Min shipping price additional NO Big decimal
Min shipping price NO Big decimal
Lead time to ship NO Integer
Max order quantity NO Long
Min order quantity NO Integer
Currency NO String
Quantity per pack NO Double

Offer price

Field Mandatory Format
Offer ID NO String
Quantity per item NO Integer
Price ranges NO List value
Offer type NO String
Customer account ID NO String
Customer tag ID NO String
Delete price NO Boolean
Active price NO Boolean

Suppliers

Body example 

[
   {
      "name":"supplierABC",
      "externalId":"1234",
      "deleted":"false"
   }
]

Fields

Field Mandatory Format
Name YES String
External ID YES String
Deleted YES Boolean