Skip to main content
POST
Creates a new supplier.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Body

application/json

Request model for CreateSupplier command endpoint. Route parameters bind from the route, query parameters from the query string, everything else from the body.

companyName
string
required

Company name of the supplier.

address
object
required

Postal address of the supplier.

currencyIso
string
required

ISO code of the supplier's currency.

languageIso
string
required

ISO code of the language assigned to the supplier.

defaultCompanyId
string<uuid>
required

Default own-company used for orders with this supplier. A supplier always has an assigned company.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

defaultWarehouseId
string<uuid>
required

Default warehouse used for orders with this supplier. A supplier always has an assigned warehouse.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

supplierNumber
string

Supplier number (free-text supplier identifier held at the merchant).

contact
object

Contact information of the supplier.

status
string

Free-text status of the supplier.

canDropship
boolean

Indicates whether the supplier can be used for dropshipping. Defaults to false when omitted.

supplierAccountNumber
string

The supplier's own customer number for the merchant ("Eigene Kd.-Nr.").

creditorNumber
integer<int32>

Creditor number of the supplier.

vatId
string

VAT identification number of the supplier.

freightCostAmount
number<decimal>

Freight cost charged by the supplier.

minimumOrderValueAmount
number<decimal>

Minimum order value required by the supplier.

smallQuantitySurchargeAmount
number<decimal>

Surcharge applied by the supplier for small quantities.

cashDiscountPercentage
number<decimal>

Cash discount percentage granted by the supplier.

cashDiscountDays
integer<int32>

Number of days within which the cash discount applies.

paymentTermInDays
integer<int32>

Payment term in days agreed with the supplier.

freeShippingThresholdAmount
number<decimal>

Order value from which the supplier ships free of charge.

deliveryTimeInDays
integer<int32>

Delivery time in days of the supplier.

website
string

Website URL of the supplier.

deliveryConditionNote
string

Note on the delivery conditions of the supplier.

comment
string

Free-text comment on the supplier.

isVatExempt
boolean

Indicates whether the supplier is exempt from VAT. Defaults to false when omitted.

isExcludedFromPurchaseList
boolean

Indicates whether the supplier is excluded from the purchase list. Defaults to false when omitted.

allowsDropshipCashOnDelivery
boolean

Indicates whether cash-on-delivery dropshipping is allowed. Defaults to false when omitted.

allowsDropshipFreeLineItems
boolean

Indicates whether free line items are allowed in dropshipping. Defaults to false when omitted.

vatFreePositionThresholdAmount
number<decimal>

Order value threshold above which line items are treated as VAT-free.

Response

Supplier created successfully.

Creates a new supplier. - Response

id
string<uuid>
required

The key of the newly created supplier.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"