POST /vendors/{id}/assign-dropship-provider.json
Path parameters
-
Numeric ID of the instance
Minimum value is
1
.
Body Required
-
addressLineOne string | null
Address line one
-
addressLineTwo string | null
Address line two
-
addressRouting string | null
Address routing
Values are
default
orrequireAssigned
. -
adminNotes string | null
Admin notes
-
Any vendor
Default value is
false
. -
Apply discount code
Default value is
false
. -
Generate invoices for cancelled orders with the flexibility to apply adjustments
Values are
disabled
orenabled
. Default value isdisabled
. -
authenticationSecret string | null
Authentication secret
-
authenticationToken string | null
Authentication token
-
automaticallyPickup boolean | null
Automatically pickup
-
Automatically send label
Default value is
false
. -
calculateCostPrices boolean | null
Calculate cost prices
-
city string | null
City
-
Combine rates
Default value is
false
. -
When this setting is enabled, commission will be calculated based on the gross amount paid by the customer. If the setting is disabled, commission will be calculated based on the net amount paid by the customer, which is the default calculation method.
Default value is
false
. -
Commission method
Values are
retained
orreverse
. Default value isretained
. -
commissionPriceInventoryFeedId integer(int32) | null
Commission price inventory feed
-
commissionRate number | null
Commission rate
-
Values are
inventoryFeedVariant
orsaleItem
. Default value issaleItem
. -
commissionRateDiscount boolean | null
Commission rate discount
-
commissionRateDiscountCodes array[string] | null
Commission rate discount codes
-
Commission rate discount scope
Values are
all
,selected
, orexclude
. Default value isall
. -
Commission rate discount split
Default value is
100
. -
commissionRateEndpoint string | null
Commission rate endpoint
-
commissionRateEndpointHash string | null
Commission rate endpoint hash
-
Commission rate fixed type
Values are
set_to
ordeduct_by
. Default value isdeduct_by
. -
Commission rate shipping
Default value is
0
. -
commissionRateType string | null
Commission rate type
Values are
percentage
orfixed
. -
commissionReverseTaxIncluded boolean | null
Commission reverse tax included
-
Commission tax calculation
Values are
disabled
ormanual
. Default value isdisabled
. -
commissionTaxRateId integer(int32) | null
Commission tax rate
-
companyReferralId integer(int32) | null
Company referral
-
countries array[string] | null
Countries
-
country string | null
Country
-
Country filter
Values are
all
,include
, orexclude
. Default value isall
. -
createdAt string(date-time)
Created at
-
currencyId integer(int32) | null
Currency
-
customCarriers string | null
Values are
all
,selected
, ornone
. -
Daily email batches
Values are
split
orcombine
. Default value issplit
. -
Default address
Values are
default
orselected
. Default value isdefault
. -
Default return address
Values are
default
orselected
. Default value isdefault
. -
defaultShippingCode string | null
Default shipping code
-
Default weight
Default value is
0
. -
Default weight unit
Values are
g
,kg
,oz
, orlb
. Default value isg
. -
discountCode string | null
Discount code
-
dropshipProviderAddressId integer(int32) | null
Dropship provider address
-
dropshipmentSplittingEndpoint string | null
Dropshipment splitting endpoint
-
Email copy
Default value is
false
. -
Enable publishing
Default value is
false
. -
eoriNumber string | null
Eori number
-
externalId string | null
External
-
externalPaymentId string | null
External payment
-
Select whether the order should be marked as paid within the dropship providers store or if financial status should be ignored . Some dropship providers may require orders to be immediately marked as paid if they have a shipping or 3PL system connected. This does not affect the financial status of the order in your store, only the way it is synced to the vendor’s platform.
Values are
ignore
,unpaid
,onPayment
, oronOrder
. Default value isignore
. -
firstName string | null
First name
-
ftpShipmentImportDelimiter string | null
Ftp shipment import delimiter
-
Ftp shipment import type
Values are
single
orcombined
. Default value issingle
. -
generatePayloadEndpoint string | null
Generate payload endpoint
-
generateShippingLabels boolean | null
Generate shipping labels
-
id integer(int32)
Id
-
Ignore cost price alerts
Default value is
false
. -
importAdjustments boolean | null
Import adjustments
-
includeCustomerEmail string | null
Include customer email
Values are
customer
,company
,companyUnique
,reference
, ornone
. -
Include customer invoice
Values are
none
,vendor
, orsale
. Default value isnone
. -
includeCustomerPhone boolean | null
Include customer phone
-
Include invoice
Default value is
false
. -
includeLabelInPackingSlip boolean | null
Include label in packing slip
-
Include order summary
Default value is
true
. -
Include packing slip
Default value is
true
. -
intercomMessageId string | null
Intercom message
-
internalNotes string | null
Internal notes
-
internalReferenceTemplate string | null
Internal reference template
-
internalReferenceTemplateDateFormat string | null
Internal reference template date format
-
inventoryRouting boolean | null
Inventory routing
-
inventorySetup string | null
Inventory setup
Values are
feed
,mapped
, ornone
. -
Inventory setup status
Values are
pending
,requested
,complete
, orerror
. Default value iscomplete
. -
inventorySetupStatusMessage string | null
Inventory setup status message
-
Invoice issuer
Values are
marketplace
ordropshipProvider
. Default value ismarketplace
. -
invoiceNotification string | null
Invoice notification
Values are
staff
,dropship_provider
,both
, ornone
. -
invoiceReturnShipping boolean | null
Automatically invoice the vendor for the cost of return labels generated through Onport. For example, if you provide the customer with a returns label in Onport, the vendor will have their payout deducted by the cost of the label.
-
invoiceReturnShippingType string | null
Invoice return shipping type
Values are
addition
ordeduct
. -
invoiceShipping boolean | null
Invoice shipping
-
Invoice shipping eligibility
Values are
all
orfreeShipping
. Default value isall
. -
invoiceShippingSource string | null
Invoice shipping source
Values are
shippingRate
,dropshipment
,customer
, ortransaction
. -
invoiceShippingSources array[string] | null
Add specific invoice sources to ensure vendors are paid only when the shipping rate selected by a customer at checkout matches the vendor's shipping source.
WARNING: Sources are case sensitive
-
invoiceShippingTax boolean | null
When this setting is enabled, shipping tax will be added to vendor invoices.
-
invoiceShippingType string | null
Invoice shipping type
Values are
addition
,deduct
, orcommission
. -
Choose the source that should be used for determining the tax rate when calculating payouts.
Values are
manual
ororder
. Default value isorder
. -
invoiceTemplateId integer(int32) | null
Invoice template
-
invoiceTerms string | null
Invoice terms
-
invoicingStage string | null
Invoicing stage
Values are
beforeShipping
,afterShipping
,delivered
, ormanual
. -
Is valid
Default value is
true
. -
labelCountries array[string] | null
Label countries
-
Label error
Values are
prevent
ortracking
. Default value isprevent
. -
Label format
Values are
pdf
,png
,pdf_4x6
, orpdf_4x8
. Default value ispdf
. -
labelName string | null
Label name
-
labelRouting string | null
Label routing
Values are
bestMatch
orcheapest
. -
Label scope
Values are
all
,domestic
,international
, orselected
. Default value isall
. -
lastName string | null
Last name
-
magentoAgreementId string | null
Magento agreement
-
magentoStoreId integer(int32) | null
Magento store
-
minimumOrderRequirements string | null
Minimum order requirements
-
Monthly payment day
Default value is
1
. -
Mute error
Default value is
false
. -
Name
-
orderCarrierCode string | null
Order carrier code
-
orderCurrencyCode string | null
Order currency code
-
orderEndpointPath string | null
Order endpoint path
-
orderEndpointUrl string | null
Order endpoint url
-
orderFlattenSeperator string | null
Order flatten seperator
-
Order format
Values are
csv
,json
, orxml
. Default value iscsv
. -
orderLanguageCode string | null
Order language code
-
orderMinimum boolean | null
Order minimum
-
orderMinimumAmount number | null
Order minimum amount
-
orderPlatform string | null
Order platform
Values are
api
,bigCommerce
,digital
,email
,ftp
,magento
,magentoLegacy
,manual
,other
,phone
,prestaShop
,shipstation
,shopify
,squareSpace
,tradeGecko
,website
,wooCommerce
, orwooCommerceLegacy
. -
Order setup status
Values are
pending
,requested
,complete
, orerror
. Default value ispending
. -
orderSetupStatusMessage string | null
Order setup status message
-
Order splitting
Values are
group
,splitQuantity
,splitTag
, orendpoint
. Default value isgroup
. -
orderSplittingEndpoint string | null
Order splitting endpoint
-
orderStatusCode string | null
Order status code
-
orderTemplateId integer(int32) | null
Order template
-
Order template type
Values are
none
,custom
, ordefault
. Default value isnone
. -
orderUseProxy boolean | null
Order use proxy
-
ostUser string | null
Ost user
-
Packaging weight
Default value is
0
. -
Packing slip from label
Values are
orderedFrom
orshippedFrom
. Default value isorderedFrom
. -
payAutomatically boolean | null
Automatically pay the vendor for any outstanding invoices. Vendors will be sent a confirmation email. You will also receive an alert if any payments aren't successfully sent (e.g. the payment source is declined).
-
paymentCode string | null
Payment code
-
Payment day
Values are
monday
,tuesday
,wednesday
,thursday
,friday
,saturday
, orsunday
. Default value ismonday
. -
Payment day monthly
Values are
firstMonday
,firstDay
,lastDay
,lastFriday
, ormanual
. Default value isfirstDay
. -
paymentDays integer(int32) | null
Payment days
-
paymentMessage string | null
Payment message
-
paymentMethodId integer(int32) | null
Payment method
-
paymentModule string | null
Payment module
Values are
enabled
,disabled
, orrestricted
. -
paymentNotes string | null
Payment notes
-
Payment schedule
Values are
daily
,weekly
,biweekly
, ormonthly
. Default value isdaily
. -
Payment scheduler
Values are
default
orcustom
. Default value isdefault
. -
Payment setup status
Values are
pending
,requested
,complete
, orerror
. Default value ispending
. -
paymentSetupStatusMessage string | null
Payment setup status message
-
paypalEmail string | null
Paypal email
-
pdfEndpoint string | null
Pdf endpoint
-
phone string | null
Phone
-
platformCurrencyId integer(int32) | null
Platform currency
-
platformCustomerExternalId string | null
Platform customer external
-
Platform discount
Values are
enabled
ordisabled
. Default value isdisabled
. -
Platform export returns
Values are
none
oralways
. Default value isnone
. -
Platform invoice address
Values are
customer
,company
, ornone
. Default value iscompany
. -
platformLocation string | null
Platform location
-
platformNotes boolean | null
Platform notes
-
Platform notification
Values are
enable
,disable
, ordefault
. Default value isdefault
. -
When syncing orders directly with a vendor's store, you can control which price should be set for the items. Some vendors might want you to send the full retail price, whereas others may want you to send the price you are paying them for the item (e.g. the retail price minus the commission).
Values are
purchase
,sale
,platform
,zero
,inventoryFeed
, orpriceList
. Default value ispurchase
. -
Select a fallback price to use when syncing an order to a vendor's store and there is no inventory feed connected.
Values are
purchase
,sale
,zero
, orpriceList
. Default value iszero
. -
platformPriceListId integer(int32) | null
Platform price list
-
Platform products
Values are
connected
,notConnected
, orall
. Default value isconnected
. -
Platform properties
Values are
default
,optionValues
, ornotes
. Default value isdefault
. -
platformShippingCode string | null
Platform shipping code
-
Platform shipping cost
Default value is
false
. -
Platform shipping mapping
Values are
default
,mapping
, oroverride
. Default value isdefault
. -
Platform shipping mapping fallback
Values are
default
,none
, oroverride
. Default value isdefault
. -
Platform shipping price
Default value is
true
. -
platformShippingProvider string | null
Platform shipping provider
-
platformShippingServiceLevel string | null
Platform shipping service level
-
Platform state code
Values are
ISO3166-2
ornone
. Default value isnone
. -
Platform tax
Values are
default
,manual
,eu
, ordomestic
. Default value isdefault
. -
To manage tax discrepancies between Onport and your vendors' stores, you can modify the relevant settings. By choosing the Tax Included option when the purchase order prices are listed in NET amounts, Onport will automatically convert and transmit these prices as GROSS values, factoring in the sales tax accordingly.
Values are
taxIncluded
orpurchase
. Default value ispurchase
. -
platformTaxRateId integer(int32) | null
Platform tax rate
-
Values are
enabled
ordisabled
. Default value isdisabled
. -
You can prevent shipments from being imported off your dropship provider if no tracking is available. This may be useful when vendors first mark orders as shipped and later enter tracking or if you want to sync orders to their platform but have them enter tracking from the vendor portal. If this is enabled, it may mean the shipments are never marked as shipped if the tracking details are not available in their store.
Values are
skip
,enabled
, ordisabled
. Default value isdisabled
. -
prestashopShopGroupId string | null
Prestashop shop group
-
Product type filter
Values are
all
,include
, orexclude
. Default value isall
. -
productTypes array[string] | null
Product types
-
purchaseNotes string | null
Purchase notes
-
purchaseShippingLabelAutomatically boolean | null
Purchase shipping label automatically
-
quickbooksId string | null
Quickbooks
-
receiverRequired boolean | null
Receiver required
-
reminderDays integer(int32) | null
Reminder days
-
Require inventory feed variant
Default value is
false
. -
Requires shipping approval
Default value is
false
. -
Restriction days
Default value is
0
. -
Restriction days scope
Values are
enabled
ordisabled
. Default value isdisabled
. -
returnDropshipProviderAddressId integer(int32) | null
Return dropship provider address
-
returnInHouse boolean | null
Return in house
-
Type of label to generate when creating the return label on sale returns. You can either create a pre-paid scan based return label. Or, a regular shipping label with the ship-to/from addresses switched, so the items are send back from the customer.
Values are
prePaid
orpaid
. Default value ispaid
. -
returnLabels string | null
Onport can automatically provide pre-paid return labels from your connected carrier integrations. The return labels are provided seperately from the outbound label. For example, you can provide a return label even if you are not providing the original outbound label.
Values are
none
,manual
, oronSend
. -
Return shipment trigger
Values are
any
ornone
. Default value isany
. -
returnShippingRateId integer(int32) | null
Return shipping rate
-
returnsPolicy string | null
Returns policy
-
Manage how shipping rates are displayed on the customer invoice.
Values are
marketplace
ordropshipProvider
. Default value isdropshipProvider
. -
Sale return customer status
Values are
default
,requested
, orfinalized
. Default value isdefault
. -
Select when the payment should be refunded from the vendor, back to you.
Values are
none
,any
,draft
,requested
,finalized
,shipped
, orreceived
. Default value isnone
. -
Send order notification
Default value is
false
. -
Send reminder
Default value is
false
. -
An email notification will be sent to the vendor with a link to the vendor portal when a payment/transfer has been created. For automated payments with Stripe, Wise, or PayPal, a notification will be sent regardless of this setting.
Default value is
false
. -
sendingSchedule string | null
Sending schedule
Values are
manual
,immediate
, ordaily
. -
Sending schedule hour
Default value is
9
. -
Sending schedule minute
Values are
0
,15
,30
, or45
. Default value is0
. -
setMerchantReference boolean | null
Set merchant reference
-
Shipment fetch frequency
Values are
hourly
,daily
, orcustom
. Default value isdaily
. -
Shipment routing
Values are
customer
,consolidated
, orconsolidatedInternational
. Default value iscustomer
. -
Shipping email
Values are
company
ordropshipProvider
. Default value iscompany
. -
shippingEndpoint string | null
Shipping endpoint
-
Shipping endpoint format
Values are
ftp
,json
,none
,googleSheet
,upload
, orxml
. Default value isnone
. -
Shipping endpoint grouping
Values are
order
orlineItem
. Default value isorder
. -
shippingEndpointImportSeconds integer(int32) | null
Shipping endpoint import seconds
-
shippingEndpointLastFetchedAt string(date-time) | null
Shipping endpoint last fetched at
-
Shipping endpoint mapping
Values are
default
orcustom
. Default value isdefault
. shippingEndpointProblem object | null | array | boolean | integer | number | string
Any of: Shipping endpoint problem
Shipping endpoint problem
Shipping endpoint problem
Shipping endpoint problem
Shipping endpoint problem
Shipping endpoint problem
-
Shipping endpoint purpose
Values are
all
orinvoice
. Default value isall
. -
Shipping phone
Values are
company
ordropshipProvider
. Default value iscompany
. -
shippingRateId integer(int32) | null
Shipping rate
-
shippingRates string | null
Shipping rates
-
Shipping reminder admin
Default value is
false
. -
Shipping setup status
Values are
pending
,requested
,complete
, orerror
. Default value ispending
. -
shippingSetupStatusMessage string | null
Shipping setup status message
-
Shipping tax rate countries
Default value is
[]
(empty). -
shippingTaxRateId integer(int32) | null
You can manually set a tax rate for shipping in this setting. This may be useful if you wish to apply a tax rate different from the one set on the order imported from your channel.
-
Select whether you want the manual tax rate to apply in all instances, or only for specific ship-to countries.
Values are
all
orselected
. Default value isall
. -
shippingType string | null
Shipping type
Values are
rechargeShipping
,generateShippingLabels
,customRates
, orfixed
. -
shippingUpdateExtension boolean | null
Shipping update extension
-
Shipping update extension duration
Default value is
0
. -
Shipping update schedule
Values are
none
,default
, ormanual
. Default value isdefault
. -
shippoToken string | null
Shippo token
-
shipstationPartnerKey string | null
Shipstation partner key
-
silenceAlerts boolean | null
Silence alerts
-
Sku filter
Values are
all
orstartsWith
. Default value isall
. -
skus array[string] | null
Skus
-
state string | null
State
-
Status
Values are
pending
,accepted
,onboarding
,away
,disabled
, orarchived
. Default value isaccepted
. -
This will change how vendors will be asked to connect in the vendor portal. You can always manually disconnect or reassign Stripe contacts below if needed.
Values are
standard
,express
, ormanual
. Default value ismanual
. -
stripeId string | null
Stripe
-
Stripe managed
Default value is
false
. -
Stripe managed enabled
Default value is
false
. -
stripeManagedId string | null
Stripe managed
-
stripePayout string | null
Stripe payout
Values are
jetti
orretailer
. -
Stripe payout source
Values are
balance
orcustomer
. Default value isbalance
. -
Will add your company name as a tag to the order, when syncing with the vendor platform. This can be changed under Setup > Quick setup
Default value is
true
. -
Will add the
dropship
tag to the order when syncing with the vendors platform.Default value is
true
. -
Sync external returns
Default value is
false
. -
syncInternalShipmentsToPlatform boolean | null
Sync internal shipments to platform
-
Add the shipping and product tax lines when raising an order within the dropship provider's store. Currently only supported on Shopify stores. Only works when syncing a price on the order to the vendor's store.
Default value is
true
. -
Sync order weight
Default value is
true
. -
Will add the order reference as a tag to the order (e.g. #1234-01), when syncing with the vendor platform.
Default value is
true
. -
Tag filter
Values are
all
,include
, orexclude
. Default value isall
. -
Onport can automatically apply tax to the products and shipping on the order. Tax and dropshipping can be complex. As such, we recommend consulting a tax specialist to understand the most relevant setup for your specific circumstances.
Values are
disabled
,taxjar
,channel
, ormanual
. Default value isdisabled
.