Skip to main content
GET
Delivers the curated detail of a single supplier by its id, regardless of active state.

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.

Path Parameters

supplierId
string<uuid>
required

The key of the supplier to resolve.

Example:

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

Response

Success.

Full, curated detail of a single supplier. Named SupplierDetail (not Supplier) because the Supplier GraphQL type is already owned by the overview list type (Supplier.yml, now in this same project) — GraphQL type names are global across the schema, so the two cannot share one name and the detail type carries a distinct one. Note the collision is NOT a consequence of the earlier split across two projects: moving the overview definition here did not resolve it, and renaming this type to Supplier would still clash.

id
string<uuid>
required

Unique identifier of the supplier.

Example:

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

canDropship
boolean
required

Indicates whether the supplier can be used for dropshipping.

isActive
boolean
required

Indicates whether the supplier is active.

address
object
required

Postal address of the supplier.

isVatExempt
boolean
required

Indicates whether the supplier is exempt from VAT.

isExcludedFromPurchaseList
boolean
required

Indicates whether the supplier is excluded from the purchase list.

allowsDropshipCashOnDelivery
boolean
required

Indicates whether cash-on-delivery dropshipping is allowed for the supplier.

allowsDropshipFreeLineItems
boolean
required

Indicates whether free line items are allowed in dropshipping for the supplier.

supplierNumber
string

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

companyName
string

Company name of the supplier.

status
string

Free-text status of the supplier.

currencyIso
string

ISO code of the supplier's currency.

contact
object

Contact information of the supplier, or null when the supplier has no contact data.

languageIso
string

ISO code of the language assigned to the supplier.

supplierAccountNumber
string

The supplier's own customer number for the merchant ("Eigene Kd.-Nr."). A free-text value, not an identifier.

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.

createdAt
string<date-time>

Date and time when the supplier was created.

changedAt
string<date-time>

Date and time when the supplier was last changed.

defaultCompanyId
string<uuid>

Default own-company used for orders with this supplier, or null when unset.

Example:

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

defaultWarehouseId
string<uuid>

Default warehouse used for orders with this supplier, or null when unset.

Example:

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

vatFreePositionThresholdAmount
number<decimal>

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