/v23.1/Suppliers
  • 05 Jun 2024
  • 6 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

/v23.1/Suppliers

  • Dark
    Light
  • PDF

Article summary

Post
/v23.1/Suppliers
Security
HTTP
Type Bearer

Please enter a valid token

Body parameters
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
supplierNumber
integer (int64)
externalCode
string
financialExportCode
string
gs1Code
integer (int64)
generalName
string
vatCode
string
defaultGrossProfitPercentage
number (double)
iban
string
bic
string
defaultCommunicationType
string
Valid values[ "NotSpecified", "RetailLink", "Email" ]
acceptMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
acceptShipmentMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
acceptInvoiceMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
administrationEmailAddress
string
gS1EdiFormat
string
Valid values[ "NotSpecified", "EanCom", "EdiXml", "Codanet", "NedFox", "NearSt" ]
gS1EdiPartyNumber
integer (int64)
gS1EdiSupplierPartyNumber
integer (int64)
partyNumberValidated
boolean
Default"False"
poRowOrderType
string
Valid values[ "NotSpecified", "OrderCode", "ConsumerBarcode", "PurchaseUnitBarcode" ]
poFtpSubfolder
string
poEmailAddress
string
supplierType
string
Valid values[ "NotSpecified", "Own", "FranchiseSupplier", "CancelledFranchiseSupplier" ]
fallbackVatId
integer (int32)
information
string
ignoreAutoStockValues
boolean
Default"False"
autoStockCalculate
boolean
Default"False"
autoStockDefaultMinStockDays
integer (int32)
autoStockDefaultMaxStockDays
integer (int32)
autoStockDefaultSaleDays
integer (int32)
autoStockMinStockPercentage
integer (int32)
autoStockMaxStockPercentage
integer (int32)
seasonProfileId
integer (int32)
printLabel
boolean
Default"False"
labelClassId
integer (int32)
maintainStock
boolean
Default"False"
allowSavings
boolean
Default"False"
allowDiscounts
boolean
Default"False"
isBackorders
boolean
Default"False"
isDisablePreferredSupplierChange
boolean
Default"False"
isConsignmentSupplier
boolean
Default"False"
isInterbranche
boolean
Default"False"
isCancelled
boolean
Default"False"
discountCalculationMethod
string
Valid values[ "NotSpecified", "MultiplyDiscountValues", "AddDiscountValues" ]
orderDiscountExecuteOrder
integer (int32)
ediDiscountExecuteOrder
integer (int32)
performanceDiscountExecuteOrder
integer (int32)
freeDiscount1ExecuteOrder
integer (int32)
freeDiscount2ExecuteOrder
integer (int32)
purchaseOrdersMinimumOrderAmount
integer (int32)
ignoreChanges
boolean
Default"False"
defaultDeliveryDays
integer (int32)
debitAccountsPayableLedgerId
integer (int32)
creditAccountsPayableLedgerId
integer (int32)
digitalSaleOrderBoundOrdersAutoFinal
boolean
Default"False"
digitalSaleOrderBoundDropshipmentOrdersAutoFinal
boolean
Default"False"
paymentDiscountSource
string
Valid values[ "NotSpecified", "EdiMessage", "SupplierCondition" ]
paymentDiscountTotalExInVat
string
Valid values[ "NotSpecified", "TotalExclVat", "TotalInclVat" ]
paymentDiscountApplyOnPurchaseOrders
boolean
Default"False"
paymentDiscountApplyOnGoodsIn
boolean
Default"False"
dcSupplier
boolean
Default"False"
dcStoreId
integer (int32)
exportToNearSt
boolean
Default"False"
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
supplierNumber
integer (int64)
externalCode
string
financialExportCode
string
gs1Code
integer (int64)
generalName
string
vatCode
string
defaultGrossProfitPercentage
number (double)
iban
string
bic
string
defaultCommunicationType
string
Valid values[ "NotSpecified", "RetailLink", "Email" ]
acceptMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
acceptShipmentMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
acceptInvoiceMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
administrationEmailAddress
string
gS1EdiFormat
string
Valid values[ "NotSpecified", "EanCom", "EdiXml", "Codanet", "NedFox", "NearSt" ]
gS1EdiPartyNumber
integer (int64)
gS1EdiSupplierPartyNumber
integer (int64)
partyNumberValidated
boolean
Default"False"
poRowOrderType
string
Valid values[ "NotSpecified", "OrderCode", "ConsumerBarcode", "PurchaseUnitBarcode" ]
poFtpSubfolder
string
poEmailAddress
string
supplierType
string
Valid values[ "NotSpecified", "Own", "FranchiseSupplier", "CancelledFranchiseSupplier" ]
fallbackVatId
integer (int32)
information
string
ignoreAutoStockValues
boolean
Default"False"
autoStockCalculate
boolean
Default"False"
autoStockDefaultMinStockDays
integer (int32)
autoStockDefaultMaxStockDays
integer (int32)
autoStockDefaultSaleDays
integer (int32)
autoStockMinStockPercentage
integer (int32)
autoStockMaxStockPercentage
integer (int32)
seasonProfileId
integer (int32)
printLabel
boolean
Default"False"
labelClassId
integer (int32)
maintainStock
boolean
Default"False"
allowSavings
boolean
Default"False"
allowDiscounts
boolean
Default"False"
isBackorders
boolean
Default"False"
isDisablePreferredSupplierChange
boolean
Default"False"
isConsignmentSupplier
boolean
Default"False"
isInterbranche
boolean
Default"False"
isCancelled
boolean
Default"False"
discountCalculationMethod
string
Valid values[ "NotSpecified", "MultiplyDiscountValues", "AddDiscountValues" ]
orderDiscountExecuteOrder
integer (int32)
ediDiscountExecuteOrder
integer (int32)
performanceDiscountExecuteOrder
integer (int32)
freeDiscount1ExecuteOrder
integer (int32)
freeDiscount2ExecuteOrder
integer (int32)
purchaseOrdersMinimumOrderAmount
integer (int32)
ignoreChanges
boolean
Default"False"
defaultDeliveryDays
integer (int32)
debitAccountsPayableLedgerId
integer (int32)
creditAccountsPayableLedgerId
integer (int32)
digitalSaleOrderBoundOrdersAutoFinal
boolean
Default"False"
digitalSaleOrderBoundDropshipmentOrdersAutoFinal
boolean
Default"False"
paymentDiscountSource
string
Valid values[ "NotSpecified", "EdiMessage", "SupplierCondition" ]
paymentDiscountTotalExInVat
string
Valid values[ "NotSpecified", "TotalExclVat", "TotalInclVat" ]
paymentDiscountApplyOnPurchaseOrders
boolean
Default"False"
paymentDiscountApplyOnGoodsIn
boolean
Default"False"
dcSupplier
boolean
Default"False"
dcStoreId
integer (int32)
exportToNearSt
boolean
Default"False"
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
supplierNumber
integer (int64)
externalCode
string
financialExportCode
string
gs1Code
integer (int64)
generalName
string
vatCode
string
defaultGrossProfitPercentage
number (double)
iban
string
bic
string
defaultCommunicationType
string
Valid values[ "NotSpecified", "RetailLink", "Email" ]
acceptMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
acceptShipmentMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
acceptInvoiceMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
administrationEmailAddress
string
gS1EdiFormat
string
Valid values[ "NotSpecified", "EanCom", "EdiXml", "Codanet", "NedFox", "NearSt" ]
gS1EdiPartyNumber
integer (int64)
gS1EdiSupplierPartyNumber
integer (int64)
partyNumberValidated
boolean
Default"False"
poRowOrderType
string
Valid values[ "NotSpecified", "OrderCode", "ConsumerBarcode", "PurchaseUnitBarcode" ]
poFtpSubfolder
string
poEmailAddress
string
supplierType
string
Valid values[ "NotSpecified", "Own", "FranchiseSupplier", "CancelledFranchiseSupplier" ]
fallbackVatId
integer (int32)
information
string
ignoreAutoStockValues
boolean
Default"False"
autoStockCalculate
boolean
Default"False"
autoStockDefaultMinStockDays
integer (int32)
autoStockDefaultMaxStockDays
integer (int32)
autoStockDefaultSaleDays
integer (int32)
autoStockMinStockPercentage
integer (int32)
autoStockMaxStockPercentage
integer (int32)
seasonProfileId
integer (int32)
printLabel
boolean
Default"False"
labelClassId
integer (int32)
maintainStock
boolean
Default"False"
allowSavings
boolean
Default"False"
allowDiscounts
boolean
Default"False"
isBackorders
boolean
Default"False"
isDisablePreferredSupplierChange
boolean
Default"False"
isConsignmentSupplier
boolean
Default"False"
isInterbranche
boolean
Default"False"
isCancelled
boolean
Default"False"
discountCalculationMethod
string
Valid values[ "NotSpecified", "MultiplyDiscountValues", "AddDiscountValues" ]
orderDiscountExecuteOrder
integer (int32)
ediDiscountExecuteOrder
integer (int32)
performanceDiscountExecuteOrder
integer (int32)
freeDiscount1ExecuteOrder
integer (int32)
freeDiscount2ExecuteOrder
integer (int32)
purchaseOrdersMinimumOrderAmount
integer (int32)
ignoreChanges
boolean
Default"False"
defaultDeliveryDays
integer (int32)
debitAccountsPayableLedgerId
integer (int32)
creditAccountsPayableLedgerId
integer (int32)
digitalSaleOrderBoundOrdersAutoFinal
boolean
Default"False"
digitalSaleOrderBoundDropshipmentOrdersAutoFinal
boolean
Default"False"
paymentDiscountSource
string
Valid values[ "NotSpecified", "EdiMessage", "SupplierCondition" ]
paymentDiscountTotalExInVat
string
Valid values[ "NotSpecified", "TotalExclVat", "TotalInclVat" ]
paymentDiscountApplyOnPurchaseOrders
boolean
Default"False"
paymentDiscountApplyOnGoodsIn
boolean
Default"False"
dcSupplier
boolean
Default"False"
dcStoreId
integer (int32)
exportToNearSt
boolean
Default"False"
Responses
200

Success

object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
supplierNumber
integer (int64)
externalCode
string
financialExportCode
string
gs1Code
integer (int64)
generalName
string
vatCode
string
defaultGrossProfitPercentage
number (double)
iban
string
bic
string
defaultCommunicationType
string
Valid values[ "NotSpecified", "RetailLink", "Email" ]
acceptMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
acceptShipmentMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
acceptInvoiceMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
administrationEmailAddress
string
gS1EdiFormat
string
Valid values[ "NotSpecified", "EanCom", "EdiXml", "Codanet", "NedFox", "NearSt" ]
gS1EdiPartyNumber
integer (int64)
gS1EdiSupplierPartyNumber
integer (int64)
partyNumberValidated
boolean
Default"False"
poRowOrderType
string
Valid values[ "NotSpecified", "OrderCode", "ConsumerBarcode", "PurchaseUnitBarcode" ]
poFtpSubfolder
string
poEmailAddress
string
supplierType
string
Valid values[ "NotSpecified", "Own", "FranchiseSupplier", "CancelledFranchiseSupplier" ]
fallbackVatId
integer (int32)
information
string
ignoreAutoStockValues
boolean
Default"False"
autoStockCalculate
boolean
Default"False"
autoStockDefaultMinStockDays
integer (int32)
autoStockDefaultMaxStockDays
integer (int32)
autoStockDefaultSaleDays
integer (int32)
autoStockMinStockPercentage
integer (int32)
autoStockMaxStockPercentage
integer (int32)
seasonProfileId
integer (int32)
printLabel
boolean
Default"False"
labelClassId
integer (int32)
maintainStock
boolean
Default"False"
allowSavings
boolean
Default"False"
allowDiscounts
boolean
Default"False"
isBackorders
boolean
Default"False"
isDisablePreferredSupplierChange
boolean
Default"False"
isConsignmentSupplier
boolean
Default"False"
isInterbranche
boolean
Default"False"
isCancelled
boolean
Default"False"
discountCalculationMethod
string
Valid values[ "NotSpecified", "MultiplyDiscountValues", "AddDiscountValues" ]
orderDiscountExecuteOrder
integer (int32)
ediDiscountExecuteOrder
integer (int32)
performanceDiscountExecuteOrder
integer (int32)
freeDiscount1ExecuteOrder
integer (int32)
freeDiscount2ExecuteOrder
integer (int32)
purchaseOrdersMinimumOrderAmount
integer (int32)
ignoreChanges
boolean
Default"False"
defaultDeliveryDays
integer (int32)
debitAccountsPayableLedgerId
integer (int32)
creditAccountsPayableLedgerId
integer (int32)
digitalSaleOrderBoundOrdersAutoFinal
boolean
Default"False"
digitalSaleOrderBoundDropshipmentOrdersAutoFinal
boolean
Default"False"
paymentDiscountSource
string
Valid values[ "NotSpecified", "EdiMessage", "SupplierCondition" ]
paymentDiscountTotalExInVat
string
Valid values[ "NotSpecified", "TotalExclVat", "TotalInclVat" ]
paymentDiscountApplyOnPurchaseOrders
boolean
Default"False"
paymentDiscountApplyOnGoodsIn
boolean
Default"False"
dcSupplier
boolean
Default"False"
dcStoreId
integer (int32)
exportToNearSt
boolean
Default"False"
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
supplierNumber
integer (int64)
externalCode
string
financialExportCode
string
gs1Code
integer (int64)
generalName
string
vatCode
string
defaultGrossProfitPercentage
number (double)
iban
string
bic
string
defaultCommunicationType
string
Valid values[ "NotSpecified", "RetailLink", "Email" ]
acceptMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
acceptShipmentMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
acceptInvoiceMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
administrationEmailAddress
string
gS1EdiFormat
string
Valid values[ "NotSpecified", "EanCom", "EdiXml", "Codanet", "NedFox", "NearSt" ]
gS1EdiPartyNumber
integer (int64)
gS1EdiSupplierPartyNumber
integer (int64)
partyNumberValidated
boolean
Default"False"
poRowOrderType
string
Valid values[ "NotSpecified", "OrderCode", "ConsumerBarcode", "PurchaseUnitBarcode" ]
poFtpSubfolder
string
poEmailAddress
string
supplierType
string
Valid values[ "NotSpecified", "Own", "FranchiseSupplier", "CancelledFranchiseSupplier" ]
fallbackVatId
integer (int32)
information
string
ignoreAutoStockValues
boolean
Default"False"
autoStockCalculate
boolean
Default"False"
autoStockDefaultMinStockDays
integer (int32)
autoStockDefaultMaxStockDays
integer (int32)
autoStockDefaultSaleDays
integer (int32)
autoStockMinStockPercentage
integer (int32)
autoStockMaxStockPercentage
integer (int32)
seasonProfileId
integer (int32)
printLabel
boolean
Default"False"
labelClassId
integer (int32)
maintainStock
boolean
Default"False"
allowSavings
boolean
Default"False"
allowDiscounts
boolean
Default"False"
isBackorders
boolean
Default"False"
isDisablePreferredSupplierChange
boolean
Default"False"
isConsignmentSupplier
boolean
Default"False"
isInterbranche
boolean
Default"False"
isCancelled
boolean
Default"False"
discountCalculationMethod
string
Valid values[ "NotSpecified", "MultiplyDiscountValues", "AddDiscountValues" ]
orderDiscountExecuteOrder
integer (int32)
ediDiscountExecuteOrder
integer (int32)
performanceDiscountExecuteOrder
integer (int32)
freeDiscount1ExecuteOrder
integer (int32)
freeDiscount2ExecuteOrder
integer (int32)
purchaseOrdersMinimumOrderAmount
integer (int32)
ignoreChanges
boolean
Default"False"
defaultDeliveryDays
integer (int32)
debitAccountsPayableLedgerId
integer (int32)
creditAccountsPayableLedgerId
integer (int32)
digitalSaleOrderBoundOrdersAutoFinal
boolean
Default"False"
digitalSaleOrderBoundDropshipmentOrdersAutoFinal
boolean
Default"False"
paymentDiscountSource
string
Valid values[ "NotSpecified", "EdiMessage", "SupplierCondition" ]
paymentDiscountTotalExInVat
string
Valid values[ "NotSpecified", "TotalExclVat", "TotalInclVat" ]
paymentDiscountApplyOnPurchaseOrders
boolean
Default"False"
paymentDiscountApplyOnGoodsIn
boolean
Default"False"
dcSupplier
boolean
Default"False"
dcStoreId
integer (int32)
exportToNearSt
boolean
Default"False"
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
supplierNumber
integer (int64)
externalCode
string
financialExportCode
string
gs1Code
integer (int64)
generalName
string
vatCode
string
defaultGrossProfitPercentage
number (double)
iban
string
bic
string
defaultCommunicationType
string
Valid values[ "NotSpecified", "RetailLink", "Email" ]
acceptMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
acceptShipmentMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
acceptInvoiceMsgsFrom
string
Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
administrationEmailAddress
string
gS1EdiFormat
string
Valid values[ "NotSpecified", "EanCom", "EdiXml", "Codanet", "NedFox", "NearSt" ]
gS1EdiPartyNumber
integer (int64)
gS1EdiSupplierPartyNumber
integer (int64)
partyNumberValidated
boolean
Default"False"
poRowOrderType
string
Valid values[ "NotSpecified", "OrderCode", "ConsumerBarcode", "PurchaseUnitBarcode" ]
poFtpSubfolder
string
poEmailAddress
string
supplierType
string
Valid values[ "NotSpecified", "Own", "FranchiseSupplier", "CancelledFranchiseSupplier" ]
fallbackVatId
integer (int32)
information
string
ignoreAutoStockValues
boolean
Default"False"
autoStockCalculate
boolean
Default"False"
autoStockDefaultMinStockDays
integer (int32)
autoStockDefaultMaxStockDays
integer (int32)
autoStockDefaultSaleDays
integer (int32)
autoStockMinStockPercentage
integer (int32)
autoStockMaxStockPercentage
integer (int32)
seasonProfileId
integer (int32)
printLabel
boolean
Default"False"
labelClassId
integer (int32)
maintainStock
boolean
Default"False"
allowSavings
boolean
Default"False"
allowDiscounts
boolean
Default"False"
isBackorders
boolean
Default"False"
isDisablePreferredSupplierChange
boolean
Default"False"
isConsignmentSupplier
boolean
Default"False"
isInterbranche
boolean
Default"False"
isCancelled
boolean
Default"False"
discountCalculationMethod
string
Valid values[ "NotSpecified", "MultiplyDiscountValues", "AddDiscountValues" ]
orderDiscountExecuteOrder
integer (int32)
ediDiscountExecuteOrder
integer (int32)
performanceDiscountExecuteOrder
integer (int32)
freeDiscount1ExecuteOrder
integer (int32)
freeDiscount2ExecuteOrder
integer (int32)
purchaseOrdersMinimumOrderAmount
integer (int32)
ignoreChanges
boolean
Default"False"
defaultDeliveryDays
integer (int32)
debitAccountsPayableLedgerId
integer (int32)
creditAccountsPayableLedgerId
integer (int32)
digitalSaleOrderBoundOrdersAutoFinal
boolean
Default"False"
digitalSaleOrderBoundDropshipmentOrdersAutoFinal
boolean
Default"False"
paymentDiscountSource
string
Valid values[ "NotSpecified", "EdiMessage", "SupplierCondition" ]
paymentDiscountTotalExInVat
string
Valid values[ "NotSpecified", "TotalExclVat", "TotalInclVat" ]
paymentDiscountApplyOnPurchaseOrders
boolean
Default"False"
paymentDiscountApplyOnGoodsIn
boolean
Default"False"
dcSupplier
boolean
Default"False"
dcStoreId
integer (int32)
exportToNearSt
boolean
Default"False"
400

Bad Request

Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
401

Unauthorized

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
403

Forbidden

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.