Shopfront Developers
Suppliers
Object
CreateOrFindSupplierResponse
| Fields | Type | Description |
|---|---|---|
|
created |
Boolean! |
Whether the supplier had to be created or not |
|
supplier |
The supplier that was found |
Object
SupplierAdditionalContact
| Fields | Type | Description |
|---|---|---|
|
name |
String! |
The name of the additional contact |
|
contact |
The contact type associated to the additional contact |
|
|
emailOrders |
Boolean! |
Whether to automatically CC this contact on emailed orders |
Object
SupplierAuthentication
| Fields | Type | Description |
|---|---|---|
|
outlet |
The Outlet that this authentication is for |
|
|
accountNumber |
String |
The account number for this supplier |
|
username |
String |
The username for this supplier |
|
password |
String |
The password for this supplier |
|
additionalAuth |
String |
Any additional authentication required for this supplier |
Object
Supplier
Implements
List of interfaces this object implements
| Fields | Type | Description |
|---|---|---|
|
id |
The ID for the supplier |
|
|
name |
String! |
The name of the supplier |
|
mdbId |
Int |
The Master Database ID for the supplier |
|
status |
The status of the supplier, if inactive orders and returns are unable to be created |
|
|
contact |
The contact details for the supplier |
|
|
businessNumber |
String |
The business number for the supplier (e.g. ABN, ACN, EIN, etc) |
|
accountNumber |
String |
The account number for this supplier |
|
orderNotes |
String |
Any notes for ordering from this supplier |
|
internalOrderNotes |
String! |
Any internal notes for ordering from this supplier |
|
orderAutomaticEmail |
Boolean |
Whether to automatically send emails when placing orders |
|
defaultOrderTax |
The default tax for receiving orders |
|
|
emailFormat |
The format to use for sending emails |
|
|
comments |
String |
Any internal comments about the supplier |
|
feeAmount |
Float |
The default payment fee amount to be applied when receiving orders |
|
distributeFees |
How fees should be distributed by default when receiving orders |
|
|
freightIncludedOnInvoices |
Boolean! |
Whether to default freight to being included on the supplier invoices |
|
freightTax |
The tax rate used when receiving freight on orders |
|
|
feesTax |
The tax rate used when receiving fees on orders |
|
|
allowOrderBelowMinimum |
Boolean |
Whether to allow orders to be sent with a value less than the minimumOrderValue |
|
minimumOrderValue |
Float |
The minimum value an order can be for this supplier |
|
maximumOrderValue |
Float |
The maximum value an order can be for this supplier |
|
authentication |
A list of authentication for the supplier (used for integrations) |
|
|
defaultDaysUntilDue |
Int |
The default number of days until a new order is due |
|
freightFixedCostPerCase |
Float |
The cost of freight to apply to each cost through Shopfront's UI when editing an invoice |
|
distributeFreight |
How freight should be distributed by default when receiving orders |
|
|
additionalContacts |
The list of additional contacts for the supplier |