# POST /vendors/{id}/assign-dropship-provider.json

**POST /vendors/{id}/assign-dropship-provider.json**




## Servers
- http://api.example.com/v1: http://api.example.com/v1 ()


## Authentication methods
- Bearer auth


## Parameters

### Path parameters
- **id** (integer(int64))
  Numeric ID of the instance


### Body: application/json (object)

- **addressLineOne** (string | null)
  Address line one
- **addressLineTwo** (string | null)
  Address line two
- **addressRouting** (string | null)
  Address routing
- **adminNotes** (string | null)
  Admin notes
- **anyVendor** (boolean | null)
  Any vendor
- **applyDiscountCode** (boolean | null)
  Apply discount code
- **applyReturnPenalty** (string | null)
  Generate invoices for cancelled orders with the flexibility to apply adjustments
- **authenticationSecret** (string | null)
  Authentication secret
- **authenticationToken** (string | null)
  Authentication token
- **automaticallyPickup** (boolean | null)
  Automatically pickup
- **automaticallySendLabel** (boolean | null)
  Automatically send label
- **calculateCostPrices** (boolean | null)
  Calculate cost prices
- **city** (string | null)
  City
- **combineRates** (boolean | null)
  Combine rates
- **commissionGrossTax** (boolean | null)
  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.
- **commissionMethod** (string | null)
  Commission method
- **commissionPriceInventoryFeedId** (integer(int32) | null)
  Commission price inventory feed
- **commissionRate** (number | null)
  Commission rate
- **commissionRateBase** (string | null)

- **commissionRateDiscount** (boolean | null)
  Commission rate discount
- **commissionRateDiscountCodes** (array[string] | null)
  Commission rate discount codes
- **commissionRateDiscountScope** (string | null)
  Commission rate discount scope
- **commissionRateDiscountSplit** (number)
  Commission rate discount split
- **commissionRateEndpoint** (string | null)
  Commission rate endpoint
- **commissionRateEndpointHash** (string | null)
  Commission rate endpoint hash
- **commissionRateFixedType** (string | null)
  Commission rate fixed type
- **commissionRateShipping** (number | null)
  Commission rate shipping
- **commissionRateType** (string | null)
  Commission rate type
- **commissionReverseTaxIncluded** (boolean | null)
  Commission reverse tax included
- **commissionTaxCalculation** (string | null)
  Commission tax calculation
- **commissionTaxRateId** (integer(int32) | null)
  Commission tax rate
- **companyReferralId** (integer(int32) | null)
  Company referral
- **countries** (array[string] | null)
  Countries
- **country** (string | null)
  Country
- **countryFilter** (string | null)
  Country filter
- **createdAt** (string(date-time))
  Created at
- **currencyId** (integer(int32) | null)
  Currency
- **customCarriers** (string | null)

- **dailyEmailBatches** (string | null)
  Daily email batches
- **defaultAddress** (string | null)
  Default address
- **defaultReturnAddress** (string | null)
  Default return address
- **defaultShippingCode** (string | null)
  Default shipping code
- **defaultWeight** (number(float) | null)
  Default weight
- **defaultWeightUnit** (string | null)
  Default weight unit
- **discountCode** (string | null)
  Discount code
- **dropshipProviderAddressId** (integer(int32) | null)
  Dropship provider address
- **dropshipmentSplittingEndpoint** (string | null)
  Dropshipment splitting endpoint
- **emailCopy** (boolean | null)
  Email copy
- **enablePublishing** (boolean | null)
  Enable publishing
- **eoriNumber** (string | null)
  Eori number
- **externalId** (string | null)
  External
- **externalPaymentId** (string | null)
  External payment
- **externalPaymentStatus** (string | null)
  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.
- **firstName** (string | null)
  First name
- **ftpShipmentImportDelimiter** (string | null)
  Ftp shipment import delimiter
- **ftpShipmentImportType** (string | null)
  Ftp shipment import type
- **generatePayloadEndpoint** (string | null)
  Generate payload endpoint
- **generateShippingLabels** (boolean | null)
  Generate shipping labels
- **id** (integer(int32))
  Id
- **ignoreCostPriceAlerts** (boolean | null)
  Ignore cost price alerts
- **importAdjustments** (boolean | null)
  Import adjustments
- **includeCustomerEmail** (string | null)
  Include customer email
- **includeCustomerInvoice** (string | null)
  Include customer invoice
- **includeCustomerPhone** (boolean | null)
  Include customer phone
- **includeInvoice** (boolean | null)
  Include invoice
- **includeLabelInPackingSlip** (boolean | null)
  Include label in packing slip
- **includeOrderSummary** (boolean | null)
  Include order summary
- **includePackingSlip** (boolean | null)
  Include packing slip
- **intercomMessageId** (string | null)
  Intercom message
- **internalNotes** (string | null)
  Internal notes
- **internalReferenceTemplate** (string | null)
  Internal reference template
- **internalReferenceTemplateDateFormat** (string | null)
  Internal reference template date format
- **internalTags** (array[string] | null)
  Internal tags
- **inventoryRouting** (boolean | null)
  Inventory routing
- **inventorySetup** (string | null)
  Inventory setup
- **inventorySetupStatus** (string | null)
  Inventory setup status
- **inventorySetupStatusMessage** (string | null)
  Inventory setup status message
- **invoiceIssuer** (string | null)
  Invoice issuer
- **invoiceNotification** (string | null)
  Invoice notification
- **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
- **invoiceShipping** (boolean | null)
  Invoice shipping
- **invoiceShippingEligibility** (string | null)
  Invoice shipping eligibility
- **invoiceShippingSource** (string | null)
  Invoice shipping source
- **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
- **invoiceTaxSource** (string | null)
  Choose the source that should be used for determining the tax rate when calculating payouts.
- **invoiceTemplateId** (integer(int32) | null)
  Invoice template
- **invoiceTerms** (string | null)
  Invoice terms
- **invoicingStage** (string | null)
  Invoicing stage
- **isValid** (boolean | null)
  Is valid
- **labelCountries** (array[string] | null)
  Label countries
- **labelError** (string | null)
  Label error
- **labelFormat** (string | null)
  Label format
- **labelName** (string | null)
  Label name
- **labelRouting** (string | null)
  Label routing
- **labelScope** (string | null)
  Label scope
- **lastName** (string | null)
  Last name
- **magentoAgreementId** (string | null)
  Magento agreement
- **magentoStoreId** (integer(int32) | null)
  Magento store
- **minimumOrderRequirements** (string | null)
  Minimum order requirements
- **monthlyPaymentDay** (integer(int32) | null)
  Monthly payment day
- **muteError** (boolean | null)
  Mute error
- **name** (string)
  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
- **orderFormat** (string | null)
  Order format
- **orderLanguageCode** (string | null)
  Order language code
- **orderMinimum** (boolean | null)
  Order minimum
- **orderMinimumAmount** (number | null)
  Order minimum amount
- **orderPlatform** (string | null)
  Order platform
- **orderSetupStatus** (string | null)
  Order setup status
- **orderSetupStatusMessage** (string | null)
  Order setup status message
- **orderSplitting** (string | null)
  Order splitting
- **orderSplittingEndpoint** (string | null)
  Order splitting endpoint
- **orderStatusCode** (string | null)
  Order status code
- **orderTemplateId** (integer(int32) | null)
  Order template
- **orderTemplateType** (string | null)
  Order template type
- **orderUseProxy** (boolean | null)
  Order use proxy
- **ostUser** (string | null)
  Ost user
- **packagingWeight** (integer(int32) | null)
  Packaging weight
- **packingSlipFromLabel** (string | null)
  Packing slip from label
- **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
- **paymentDay** (string | null)
  Payment day
- **paymentDayMonthly** (string | null)
  Payment day monthly
- **paymentDays** (integer(int32) | null)
  Payment days
- **paymentMessage** (string | null)
  Payment message
- **paymentMethodId** (integer(int32) | null)
  Payment method
- **paymentModule** (string | null)
  Payment module
- **paymentNotes** (string | null)
  Payment notes
- **paymentSchedule** (string | null)
  Payment schedule
- **paymentScheduler** (string | null)
  Payment scheduler
- **paymentSetupStatus** (string | null)
  Payment setup status
- **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
- **platformDiscount** (string | null)
  Platform discount
- **platformExportReturns** (string | null)
  Platform export returns
- **platformInvoiceAddress** (string | null)
  Platform invoice address
- **platformLocation** (string | null)
  Platform location
- **platformNotes** (boolean | null)
  Platform notes
- **platformNotification** (string | null)
  Platform notification
- **platformPrice** (string | null)
  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). 
- **platformPriceFallback** (string | null)
  Select a fallback price to use when syncing an order to a vendor's store and there is no inventory feed connected. 
- **platformPriceListId** (integer(int32) | null)
  Platform price list
- **platformProducts** (string | null)
  Platform products
- **platformProperties** (string | null)
  Platform properties
- **platformShippingCode** (string | null)
  Platform shipping code
- **platformShippingCost** (boolean | null)
  Platform shipping cost
- **platformShippingMapping** (string | null)
  Platform shipping mapping
- **platformShippingMappingFallback** (string | null)
  Platform shipping mapping fallback
- **platformShippingPrice** (boolean | null)
  Platform shipping price
- **platformShippingProvider** (string | null)
  Platform shipping provider
- **platformShippingServiceLevel** (string | null)
  Platform shipping service level
- **platformStateCode** (string | null)
  Platform state code
- **platformTags** (array[string] | null)
  Platform tags
- **platformTax** (string | null)
  Platform tax
- **platformTaxIncluded** (string | null)
  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.
- **platformTaxRateId** (integer(int32) | null)
  Platform tax rate
- **platformTrackingCompanyRequirement** (string | null)

- **platformTrackingRequirement** (string | null)
  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.
- **prestashopShopGroupId** (string | null)
  Prestashop shop group
- **productTypeFilter** (string | null)
  Product type filter
- **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
- **requireInventoryFeedVariant** (boolean | null)
  Require inventory feed variant
- **requiresShippingApproval** (boolean | null)
  Requires shipping approval
- **restrictionDays** (integer(int32) | null)
  Restriction days
- **restrictionDaysScope** (string | null)
  Restriction days scope
- **restrictionTags** (array[string] | null)
  Restriction tags
- **restrictionTagsScope** (string | null)
  Restriction tags scope
- **returnDropshipProviderAddressId** (integer(int32) | null)
  Return dropship provider address
- **returnInHouse** (boolean | null)
  Return in house
- **returnLabelType** (string | null)
  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. 
- **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. 
- **returnShipmentTrigger** (string | null)
  Return shipment trigger
- **returnShippingRateId** (integer(int32) | null)
  Return shipping rate
- **returnsPolicy** (string | null)
  Returns policy
- **reverseShippingInvoice** (string | null)
  Manage how shipping rates are displayed on the customer invoice.
- **saleReturnCustomerStatus** (string | null)
  Sale return customer status
- **saleReturnRefundTrigger** (string | null)
  Select when the payment should be refunded from the vendor, back to you.
- **sendOrderNotification** (boolean | null)
  Send order notification
- **sendReminder** (boolean | null)
  Send reminder
- **sendTransferNotification** (boolean | null)
  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.
- **sendingSchedule** (string | null)
  Sending schedule
- **sendingScheduleHour** (string | null)
  Sending schedule hour
- **sendingScheduleMinute** (string | null)
  Sending schedule minute
- **setMerchantReference** (boolean | null)
  Set merchant reference
- **shipmentFetchFrequency** (string | null)
  Shipment fetch frequency
- **shipmentRouting** (string | null)
  Shipment routing
- **shippingEmail** (string | null)
  Shipping email
- **shippingEndpoint** (string | null)
  Shipping endpoint
- **shippingEndpointFormat** (string | null)
  Shipping endpoint format
- **shippingEndpointGrouping** (string | null)
  Shipping endpoint grouping
- **shippingEndpointImportSeconds** (integer(int32) | null)
  Shipping endpoint import seconds
- **shippingEndpointLastFetchedAt** (string(date-time) | null)
  Shipping endpoint last fetched at
- **shippingEndpointMapping** (string | null)
  Shipping endpoint mapping
- **shippingEndpointProblem** (object | null | array | boolean | integer | number | string)
  Shipping endpoint problem
- **shippingEndpointPurpose** (string | null)
  Shipping endpoint purpose
- **shippingPhone** (string | null)
  Shipping phone
- **shippingRateId** (integer(int32) | null)
  Shipping rate
- **shippingRates** (string | null)
  Shipping rates
- **shippingReminderAdmin** (boolean | null)
  Shipping reminder admin
- **shippingSetupStatus** (string | null)
  Shipping setup status
- **shippingSetupStatusMessage** (string | null)
  Shipping setup status message
- **shippingTaxRateCountries** (array[string] | null)
  Shipping tax rate countries
- **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.
- **shippingTaxRateScope** (string | null)
  Select whether you want the manual tax rate to apply in all instances, or only for specific ship-to countries.
- **shippingType** (string | null)
  Shipping type
- **shippingUpdateExtension** (boolean | null)
  Shipping update extension
- **shippingUpdateExtensionDuration** (integer(int32) | null)
  Shipping update extension duration
- **shippingUpdateSchedule** (string | null)
  Shipping update schedule
- **shippoToken** (string | null)
  Shippo token
- **shipstationPartnerKey** (string | null)
  Shipstation partner key
- **silenceAlerts** (boolean | null)
  Silence alerts
- **skuFilter** (string | null)
  Sku filter
- **skus** (array[string] | null)
  Skus
- **state** (string | null)
  State
- **status** (string | null)
  Status
- **stripeFlow** (string | null)
  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.
- **stripeId** (string | null)
  Stripe
- **stripeManaged** (boolean | null)
  Stripe managed
- **stripeManagedEnabled** (boolean | null)
  Stripe managed enabled
- **stripeManagedId** (string | null)
  Stripe managed
- **stripePayout** (string | null)
  Stripe payout
- **stripePayoutSource** (string | null)
  Stripe payout source
- **syncCompanyTag** (boolean | null)
  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
- **syncDropshipTag** (boolean | null)
  Will add the `dropship` tag to the order when syncing with the vendors platform.
- **syncExternalReturns** (boolean | null)
  Sync external returns
- **syncInternalShipmentsToPlatform** (boolean | null)
  Sync internal shipments to platform
- **syncOrderTax** (boolean | null)
  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. 
- **syncOrderWeight** (boolean | null)
  Sync order weight
- **syncReferenceTag** (boolean | null)
  Will add the order reference as a tag to the order (e.g. #1234-01), when syncing with the vendor platform.
- **tagFilter** (string | null)
  Tag filter
- **tagSplitting** (array[string] | null)
  Tag splitting
- **tags** (array[string] | null)
  Tags
- **taxCalculation** (string | null)
  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. 
- **taxId** (string | null)
  Tax
- **taxIncluded** (boolean | null)
  Tax included
- **taxJarToken** (string | null)
  Tax jar token
- **taxNumber** (string | null)
  Tax number
- **taxRateId** (integer(int32) | null)
  Tax rate
- **taxShipping** (boolean | null)
  Tax shipping
- **terms** (string | null)
  Terms
- **timezone** (string | null)
  Timezone
- **trackingScope** (string | null)
  Tracking scope
- **transferTerms** (string | null)
  Transfer terms
- **transferwiseRecipientId** (string | null)
  Transferwise recipient
- **updateOrderNotes** (boolean | null)
  Add any shipping labels or packing slips in the vendor's store when marking an order as shipped in Onport. For example, on Shopify the shipping label will be added to the note attributes of the order. The tracking company and number will continue to be updated in their respective fields as usual.
- **updatedAt** (string(date-time))
  Updated at
- **useChannelShippingRate** (boolean | null)
  Charge your customer a different shipping rate at checkout. If this isn't selected, the same shipping rate above will be applied to the shopping cart. This is only needed if Onport is providing live shipping rates in your checkout. 
- **useCommissionRateEndpoint** (boolean | null)
  API endpoint for sending the API payload for custom commission rate calculation.
- **useDropshipmentSplittingEndpoint** (boolean | null)
  Use dropshipment splitting endpoint
- **useGeneratePayloadEndpoint** (boolean | null)
  Use generate payload endpoint
- **useInternalReferenceTemplate** (boolean | null)
  Use internal reference template
- **usePdfEndpoint** (boolean | null)
  Use pdf endpoint
- **userId** (integer(int32) | null)
  User
- **validationMessage** (array[string] | null)
  Validation message
- **vendorPortalShowInvoices** (boolean | null)
  The links/buttons to the invoice PDF will be shown. However, this will not impact the ability for vendors to access the payment report. 
- **w9Form** (string | null)
  W9 form
- **websiteUrl** (string | null)
  Website url
- **xeroId** (string | null)
  Xero
- **zip** (string | null)
  Zip
- **zohoId** (string | null)
  Zoho


## Responses
### 200
Successful response

#### Body: application/json (object)
- **addressLineOne** (string | null)
  Address line one
- **addressLineTwo** (string | null)
  Address line two
- **addressRouting** (string | null)
  Address routing
- **adminNotes** (string | null)
  Admin notes
- **anyVendor** (boolean | null)
  Any vendor
- **applyDiscountCode** (boolean | null)
  Apply discount code
- **applyReturnPenalty** (string | null)
  Generate invoices for cancelled orders with the flexibility to apply adjustments
- **authenticationSecret** (string | null)
  Authentication secret
- **authenticationToken** (string | null)
  Authentication token
- **automaticallyPickup** (boolean | null)
  Automatically pickup
- **automaticallySendLabel** (boolean | null)
  Automatically send label
- **calculateCostPrices** (boolean | null)
  Calculate cost prices
- **city** (string | null)
  City
- **combineRates** (boolean | null)
  Combine rates
- **commissionGrossTax** (boolean | null)
  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.
- **commissionMethod** (string | null)
  Commission method
- **commissionPriceInventoryFeedId** (integer(int32) | null)
  Commission price inventory feed
- **commissionRate** (number | null)
  Commission rate
- **commissionRateBase** (string | null)

- **commissionRateDiscount** (boolean | null)
  Commission rate discount
- **commissionRateDiscountCodes** (array[string] | null)
  Commission rate discount codes
- **commissionRateDiscountScope** (string | null)
  Commission rate discount scope
- **commissionRateDiscountSplit** (number)
  Commission rate discount split
- **commissionRateEndpoint** (string | null)
  Commission rate endpoint
- **commissionRateEndpointHash** (string | null)
  Commission rate endpoint hash
- **commissionRateFixedType** (string | null)
  Commission rate fixed type
- **commissionRateShipping** (number | null)
  Commission rate shipping
- **commissionRateType** (string | null)
  Commission rate type
- **commissionReverseTaxIncluded** (boolean | null)
  Commission reverse tax included
- **commissionTaxCalculation** (string | null)
  Commission tax calculation
- **commissionTaxRateId** (integer(int32) | null)
  Commission tax rate
- **companyReferralId** (integer(int32) | null)
  Company referral
- **countries** (array[string] | null)
  Countries
- **country** (string | null)
  Country
- **countryFilter** (string | null)
  Country filter
- **createdAt** (string(date-time))
  Created at
- **currencyId** (integer(int32) | null)
  Currency
- **customCarriers** (string | null)

- **dailyEmailBatches** (string | null)
  Daily email batches
- **defaultAddress** (string | null)
  Default address
- **defaultReturnAddress** (string | null)
  Default return address
- **defaultShippingCode** (string | null)
  Default shipping code
- **defaultWeight** (number(float) | null)
  Default weight
- **defaultWeightUnit** (string | null)
  Default weight unit
- **discountCode** (string | null)
  Discount code
- **dropshipProviderAddressId** (integer(int32) | null)
  Dropship provider address
- **dropshipmentSplittingEndpoint** (string | null)
  Dropshipment splitting endpoint
- **emailCopy** (boolean | null)
  Email copy
- **enablePublishing** (boolean | null)
  Enable publishing
- **eoriNumber** (string | null)
  Eori number
- **externalId** (string | null)
  External
- **externalPaymentId** (string | null)
  External payment
- **externalPaymentStatus** (string | null)
  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.
- **firstName** (string | null)
  First name
- **ftpShipmentImportDelimiter** (string | null)
  Ftp shipment import delimiter
- **ftpShipmentImportType** (string | null)
  Ftp shipment import type
- **generatePayloadEndpoint** (string | null)
  Generate payload endpoint
- **generateShippingLabels** (boolean | null)
  Generate shipping labels
- **id** (integer(int32))
  Id
- **ignoreCostPriceAlerts** (boolean | null)
  Ignore cost price alerts
- **importAdjustments** (boolean | null)
  Import adjustments
- **includeCustomerEmail** (string | null)
  Include customer email
- **includeCustomerInvoice** (string | null)
  Include customer invoice
- **includeCustomerPhone** (boolean | null)
  Include customer phone
- **includeInvoice** (boolean | null)
  Include invoice
- **includeLabelInPackingSlip** (boolean | null)
  Include label in packing slip
- **includeOrderSummary** (boolean | null)
  Include order summary
- **includePackingSlip** (boolean | null)
  Include packing slip
- **intercomMessageId** (string | null)
  Intercom message
- **internalNotes** (string | null)
  Internal notes
- **internalReferenceTemplate** (string | null)
  Internal reference template
- **internalReferenceTemplateDateFormat** (string | null)
  Internal reference template date format
- **internalTags** (array[string] | null)
  Internal tags
- **inventoryRouting** (boolean | null)
  Inventory routing
- **inventorySetup** (string | null)
  Inventory setup
- **inventorySetupStatus** (string | null)
  Inventory setup status
- **inventorySetupStatusMessage** (string | null)
  Inventory setup status message
- **invoiceIssuer** (string | null)
  Invoice issuer
- **invoiceNotification** (string | null)
  Invoice notification
- **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
- **invoiceShipping** (boolean | null)
  Invoice shipping
- **invoiceShippingEligibility** (string | null)
  Invoice shipping eligibility
- **invoiceShippingSource** (string | null)
  Invoice shipping source
- **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
- **invoiceTaxSource** (string | null)
  Choose the source that should be used for determining the tax rate when calculating payouts.
- **invoiceTemplateId** (integer(int32) | null)
  Invoice template
- **invoiceTerms** (string | null)
  Invoice terms
- **invoicingStage** (string | null)
  Invoicing stage
- **isValid** (boolean | null)
  Is valid
- **labelCountries** (array[string] | null)
  Label countries
- **labelError** (string | null)
  Label error
- **labelFormat** (string | null)
  Label format
- **labelName** (string | null)
  Label name
- **labelRouting** (string | null)
  Label routing
- **labelScope** (string | null)
  Label scope
- **lastName** (string | null)
  Last name
- **magentoAgreementId** (string | null)
  Magento agreement
- **magentoStoreId** (integer(int32) | null)
  Magento store
- **minimumOrderRequirements** (string | null)
  Minimum order requirements
- **monthlyPaymentDay** (integer(int32) | null)
  Monthly payment day
- **muteError** (boolean | null)
  Mute error
- **name** (string)
  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
- **orderFormat** (string | null)
  Order format
- **orderLanguageCode** (string | null)
  Order language code
- **orderMinimum** (boolean | null)
  Order minimum
- **orderMinimumAmount** (number | null)
  Order minimum amount
- **orderPlatform** (string | null)
  Order platform
- **orderSetupStatus** (string | null)
  Order setup status
- **orderSetupStatusMessage** (string | null)
  Order setup status message
- **orderSplitting** (string | null)
  Order splitting
- **orderSplittingEndpoint** (string | null)
  Order splitting endpoint
- **orderStatusCode** (string | null)
  Order status code
- **orderTemplateId** (integer(int32) | null)
  Order template
- **orderTemplateType** (string | null)
  Order template type
- **orderUseProxy** (boolean | null)
  Order use proxy
- **ostUser** (string | null)
  Ost user
- **packagingWeight** (integer(int32) | null)
  Packaging weight
- **packingSlipFromLabel** (string | null)
  Packing slip from label
- **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
- **paymentDay** (string | null)
  Payment day
- **paymentDayMonthly** (string | null)
  Payment day monthly
- **paymentDays** (integer(int32) | null)
  Payment days
- **paymentMessage** (string | null)
  Payment message
- **paymentMethodId** (integer(int32) | null)
  Payment method
- **paymentModule** (string | null)
  Payment module
- **paymentNotes** (string | null)
  Payment notes
- **paymentSchedule** (string | null)
  Payment schedule
- **paymentScheduler** (string | null)
  Payment scheduler
- **paymentSetupStatus** (string | null)
  Payment setup status
- **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
- **platformDiscount** (string | null)
  Platform discount
- **platformExportReturns** (string | null)
  Platform export returns
- **platformInvoiceAddress** (string | null)
  Platform invoice address
- **platformLocation** (string | null)
  Platform location
- **platformNotes** (boolean | null)
  Platform notes
- **platformNotification** (string | null)
  Platform notification
- **platformPrice** (string | null)
  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). 
- **platformPriceFallback** (string | null)
  Select a fallback price to use when syncing an order to a vendor's store and there is no inventory feed connected. 
- **platformPriceListId** (integer(int32) | null)
  Platform price list
- **platformProducts** (string | null)
  Platform products
- **platformProperties** (string | null)
  Platform properties
- **platformShippingCode** (string | null)
  Platform shipping code
- **platformShippingCost** (boolean | null)
  Platform shipping cost
- **platformShippingMapping** (string | null)
  Platform shipping mapping
- **platformShippingMappingFallback** (string | null)
  Platform shipping mapping fallback
- **platformShippingPrice** (boolean | null)
  Platform shipping price
- **platformShippingProvider** (string | null)
  Platform shipping provider
- **platformShippingServiceLevel** (string | null)
  Platform shipping service level
- **platformStateCode** (string | null)
  Platform state code
- **platformTags** (array[string] | null)
  Platform tags
- **platformTax** (string | null)
  Platform tax
- **platformTaxIncluded** (string | null)
  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.
- **platformTaxRateId** (integer(int32) | null)
  Platform tax rate
- **platformTrackingCompanyRequirement** (string | null)

- **platformTrackingRequirement** (string | null)
  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.
- **prestashopShopGroupId** (string | null)
  Prestashop shop group
- **productTypeFilter** (string | null)
  Product type filter
- **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
- **requireInventoryFeedVariant** (boolean | null)
  Require inventory feed variant
- **requiresShippingApproval** (boolean | null)
  Requires shipping approval
- **restrictionDays** (integer(int32) | null)
  Restriction days
- **restrictionDaysScope** (string | null)
  Restriction days scope
- **restrictionTags** (array[string] | null)
  Restriction tags
- **restrictionTagsScope** (string | null)
  Restriction tags scope
- **returnDropshipProviderAddressId** (integer(int32) | null)
  Return dropship provider address
- **returnInHouse** (boolean | null)
  Return in house
- **returnLabelType** (string | null)
  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. 
- **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. 
- **returnShipmentTrigger** (string | null)
  Return shipment trigger
- **returnShippingRateId** (integer(int32) | null)
  Return shipping rate
- **returnsPolicy** (string | null)
  Returns policy
- **reverseShippingInvoice** (string | null)
  Manage how shipping rates are displayed on the customer invoice.
- **saleReturnCustomerStatus** (string | null)
  Sale return customer status
- **saleReturnRefundTrigger** (string | null)
  Select when the payment should be refunded from the vendor, back to you.
- **sendOrderNotification** (boolean | null)
  Send order notification
- **sendReminder** (boolean | null)
  Send reminder
- **sendTransferNotification** (boolean | null)
  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.
- **sendingSchedule** (string | null)
  Sending schedule
- **sendingScheduleHour** (string | null)
  Sending schedule hour
- **sendingScheduleMinute** (string | null)
  Sending schedule minute
- **setMerchantReference** (boolean | null)
  Set merchant reference
- **shipmentFetchFrequency** (string | null)
  Shipment fetch frequency
- **shipmentRouting** (string | null)
  Shipment routing
- **shippingEmail** (string | null)
  Shipping email
- **shippingEndpoint** (string | null)
  Shipping endpoint
- **shippingEndpointFormat** (string | null)
  Shipping endpoint format
- **shippingEndpointGrouping** (string | null)
  Shipping endpoint grouping
- **shippingEndpointImportSeconds** (integer(int32) | null)
  Shipping endpoint import seconds
- **shippingEndpointLastFetchedAt** (string(date-time) | null)
  Shipping endpoint last fetched at
- **shippingEndpointMapping** (string | null)
  Shipping endpoint mapping
- **shippingEndpointProblem** (object | null | array | boolean | integer | number | string)
  Shipping endpoint problem
- **shippingEndpointPurpose** (string | null)
  Shipping endpoint purpose
- **shippingPhone** (string | null)
  Shipping phone
- **shippingRateId** (integer(int32) | null)
  Shipping rate
- **shippingRates** (string | null)
  Shipping rates
- **shippingReminderAdmin** (boolean | null)
  Shipping reminder admin
- **shippingSetupStatus** (string | null)
  Shipping setup status
- **shippingSetupStatusMessage** (string | null)
  Shipping setup status message
- **shippingTaxRateCountries** (array[string] | null)
  Shipping tax rate countries
- **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.
- **shippingTaxRateScope** (string | null)
  Select whether you want the manual tax rate to apply in all instances, or only for specific ship-to countries.
- **shippingType** (string | null)
  Shipping type
- **shippingUpdateExtension** (boolean | null)
  Shipping update extension
- **shippingUpdateExtensionDuration** (integer(int32) | null)
  Shipping update extension duration
- **shippingUpdateSchedule** (string | null)
  Shipping update schedule
- **shippoToken** (string | null)
  Shippo token
- **shipstationPartnerKey** (string | null)
  Shipstation partner key
- **silenceAlerts** (boolean | null)
  Silence alerts
- **skuFilter** (string | null)
  Sku filter
- **skus** (array[string] | null)
  Skus
- **state** (string | null)
  State
- **status** (string | null)
  Status
- **stripeFlow** (string | null)
  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.
- **stripeId** (string | null)
  Stripe
- **stripeManaged** (boolean | null)
  Stripe managed
- **stripeManagedEnabled** (boolean | null)
  Stripe managed enabled
- **stripeManagedId** (string | null)
  Stripe managed
- **stripePayout** (string | null)
  Stripe payout
- **stripePayoutSource** (string | null)
  Stripe payout source
- **syncCompanyTag** (boolean | null)
  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
- **syncDropshipTag** (boolean | null)
  Will add the `dropship` tag to the order when syncing with the vendors platform.
- **syncExternalReturns** (boolean | null)
  Sync external returns
- **syncInternalShipmentsToPlatform** (boolean | null)
  Sync internal shipments to platform
- **syncOrderTax** (boolean | null)
  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. 
- **syncOrderWeight** (boolean | null)
  Sync order weight
- **syncReferenceTag** (boolean | null)
  Will add the order reference as a tag to the order (e.g. #1234-01), when syncing with the vendor platform.
- **tagFilter** (string | null)
  Tag filter
- **tagSplitting** (array[string] | null)
  Tag splitting
- **tags** (array[string] | null)
  Tags
- **taxCalculation** (string | null)
  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. 
- **taxId** (string | null)
  Tax
- **taxIncluded** (boolean | null)
  Tax included
- **taxJarToken** (string | null)
  Tax jar token
- **taxNumber** (string | null)
  Tax number
- **taxRateId** (integer(int32) | null)
  Tax rate
- **taxShipping** (boolean | null)
  Tax shipping
- **terms** (string | null)
  Terms
- **timezone** (string | null)
  Timezone
- **trackingScope** (string | null)
  Tracking scope
- **transferTerms** (string | null)
  Transfer terms
- **transferwiseRecipientId** (string | null)
  Transferwise recipient
- **updateOrderNotes** (boolean | null)
  Add any shipping labels or packing slips in the vendor's store when marking an order as shipped in Onport. For example, on Shopify the shipping label will be added to the note attributes of the order. The tracking company and number will continue to be updated in their respective fields as usual.
- **updatedAt** (string(date-time))
  Updated at
- **useChannelShippingRate** (boolean | null)
  Charge your customer a different shipping rate at checkout. If this isn't selected, the same shipping rate above will be applied to the shopping cart. This is only needed if Onport is providing live shipping rates in your checkout. 
- **useCommissionRateEndpoint** (boolean | null)
  API endpoint for sending the API payload for custom commission rate calculation.
- **useDropshipmentSplittingEndpoint** (boolean | null)
  Use dropshipment splitting endpoint
- **useGeneratePayloadEndpoint** (boolean | null)
  Use generate payload endpoint
- **useInternalReferenceTemplate** (boolean | null)
  Use internal reference template
- **usePdfEndpoint** (boolean | null)
  Use pdf endpoint
- **userId** (integer(int32) | null)
  User
- **validationMessage** (array[string] | null)
  Validation message
- **vendorPortalShowInvoices** (boolean | null)
  The links/buttons to the invoice PDF will be shown. However, this will not impact the ability for vendors to access the payment report. 
- **w9Form** (string | null)
  W9 form
- **websiteUrl** (string | null)
  Website url
- **xeroId** (string | null)
  Xero
- **zip** (string | null)
  Zip
- **zohoId** (string | null)
  Zoho


[Powered by Bump.sh](https://bump.sh)