Body Required

• addressLineOne string | null

  Address line one

• addressLineTwo string | null

  Address line two

• addressRouting string | null

  Address routing

  Values are default or requireAssigned.

• adminNotes string | null

  Admin notes

• anyVendor boolean | null Required

  Any vendor

  Default value is false.

• applyDiscountCode boolean | null Required

  Apply discount code

  Default value is false.

• authenticationSecret string | null

  Authentication secret

• authenticationToken string | null

  Authentication token

• automaticallyPickup boolean | null

  Automatically pickup

• automaticallySendLabel boolean | null Required

  Automatically send label

  Default value is false.

• calculateCostPrices boolean | null

  Calculate cost prices

• city string | null

  City

• combineRates boolean | null Required

  Combine rates

  Default value is false.

• commissionMethod string | null Required

  Commission method

  Values are retained or reverse. Default value is retained.

• commissionRate number | null

  This is the percentage or fixed amount of the price you will keep. For example if choosing percentage, enter 20 to deduct 20% from the retail price on the sales order. This is based on the item price in the cart, so its important that prices are up to date.

• commissionRateDiscount boolean | null

  Commission rate discount

• commissionRateDiscountCodes array[string] | null

  Commission rate discount codes

• commissionRateDiscountScope string | null Required

  Select whether the payout should be reduced for all discount codes. Or, only a subset of the discount codes used on the website. You may want to use this to omit certain discount codes from discounting payouts.

  Values are all or selected. Default value is all.

• commissionRateDiscountSplit number Required

  Select the percentage of the discount to be paid out to the brand. For example, if you want allocate all of the discount to the brand, enter 100%.

  Default value is 100.

• commissionRateEndpoint string | null

  Commission rate endpoint

• commissionRateFixedType string | null Required

  Commission rate fixed type

  Values are set_to or deduct_by. Default value is deduct_by.

• commissionRateType string | null

  Commission rate type

  Values are percentage or fixed.

• commissionTaxCalculation string | null Required

  When invoicing for the commission amount, a different amount can be applied than the amount of tax applied on the customer order. For example, if no tax was applied to the customer order (e.g. where the customer an international customer placed an order), tax may still be applicable on the commission amount (e.g. where the vendor and marketplace are in the same tax justistriction).

  Values are disabled or manual. Default value is disabled.

• 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 Required

  Country filter

  Values are all, include, or exclude. Default value is all.

• createdAt string(date-time)

  Created at

• defaultAddress string | null Required

  Default address

  Values are default or selected. Default value is default.

• defaultReturnAddress string | null Required

  Default return address

  Values are default or selected. Default value is default.

• defaultShippingCode string | null

  Default shipping code

• defaultWeight number(float) | null Required

  Default weight

  Default value is 0.

• defaultWeightUnit string | null Required

  Default weight unit

  Values are g, kg, oz, or lb. Default value is g.

• discountCode string | null

  Discount code

• dropshipProviderAddressId integer(int32) | null

  Dropship provider address

• dropshipmentSplittingEndpoint string | null

  Dropshipment splitting endpoint

• emailCopy boolean | null Required

  Email copy

  Default value is false.

• enablePublishing boolean | null Required

  Enable publishing

  Default value is false.

• externalId string | null

  External

• externalPaymentId string | null

  External payment

• externalPaymentStatus string | null Required

  Select when the order should be marked as paid within the dropship providers store. Some dropship providers may require orders to be immediately marked as paid if they have a shipping or 3PL system connected.

  Values are ignore, onPayment, or onOrder. Default value is ignore.

• firstName string | null

  First name

• ftpShipmentImportDelimiter string | null

  You can leave this blank if you are using a regular CSV file. However, some dropship providers might want to import TSV or use a customer character for separating the columns in the file (e.g. the ":" character).

• ftpShipmentImportType string | null Required

  Ftp shipment import type

  Values are single or combined. Default value is single.

• generateShippingLabels boolean | null

  Generate shipping labels

• id integer(int32)

  Id

• ignoreCostPriceAlerts boolean | null Required

  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, or none.

• includeCustomerInvoice string | null Required

  Include customer invoice

  Values are none, vendor, or sale. Default value is none.

• includeCustomerPhone boolean | null

  Include customer phone

• includeInvoice boolean | null Required

  Include invoice

  Default value is false.

• includeLabelInPackingSlip boolean | null

  Include label in packing slip

• includeOrderSummary boolean | null Required

  Include order summary

  Default value is true.

• includePackingSlip boolean | null Required

  Include a packing slip when sending the order notification, or, when syncing an order into the dropship providers platform. They'll still be able to download from the dropship portal if needed.

  Default value is true.

• intercomMessageId string | null

  Intercom message

• internalNotes string | null

  Internal notes

• internalReferenceTemplate string | null

  When generating purchase orders, an reference can be generated using a template to confirm with your own internal structure. For example, if you wanted to assign the reference ORDER_10001-01_MYVENDOR you can use the template "ORDER_NAME_{{REFERENCE}}_{{name}}".

• internalReferenceTemplateDateFormat string | null

  Internal reference template date format

• internalTags array[string] | null

  Internal tags

• inventoryRouting boolean | null

  Inventory routing

• inventorySetup string | null

  Jetti can automatically publish items from an inventory feed. Once published, pricing and inventory levels will then automatically be kept in sync. Setting up an inventory feed usually requires generating a set of API credentials for your dropship provider's platform. Or, setting up a CSV file to import. If you don't want to sync an inventory feed, you can also set Jetti up so they can update the pricing and inventory levels of their products currently in your store.

  Values are feed, mapped, or none.

• inventorySetupStatus string | null Required

  Inventory setup status

  Values are pending, requested, complete, or error. Default value is complete.

• inventorySetupStatusMessage string | null

  Inventory setup status message

• invoiceNotification string | null

  Invoice notification

  Values are staff, dropship_provider, both, or none.

• invoiceShipping boolean | null

  Setup the invoicing flow for shipping. You can opt to add funds to the payout, deduct funds from the payout (e.g. to cover the costs of shipping labels) or handle commission flows on the shipping.

• invoiceShippingEligibility string | null Required

  Select the conditions under which there should be an invoice / payout for the shipping amount. You can select between always. Or, only invoicing a shipping amount when there was shipping income collected from the customer.

  Values are all or freeShipping. Default value is all.

• invoiceShippingSource string | null

  Invoice shipping source

  Values are shippingRate, dropshipment, or customer.

• invoiceShippingType string | null

  Select whether to pay the vendor for the shipping amount, deduct the amount from the vendor. Or, whether you want to payout an amount, but deduct a commission from that amount.

  Values are addition, deduct, or commission.

• invoiceTemplateId integer(int32) | null

  Invoice template

• invoiceTerms string | null

  Invoice terms

• invoicingStage string | null

  Invoicing stage

  Values are beforeShipping, afterShipping, delivered, or manual.

• isValid boolean | null Required

  Is valid

  Default value is true.

• labelCountries array[string] | null

  Select the countries that labels should be generated for. This should be the ship-to counties (i.e. where the customer is located).

• labelError string | null Required

  When labels cannot be generated (e.g. maybe there is an error, or, the labels aren't provided for the destination), Jetti can either prevent the order from being shipped / sent. Or, allow the order to be processed and the instead, allow tracking to be entered.

  Values are prevent or tracking. Default value is prevent.

• labelFormat string | null Required

  Label format

  Values are pdf, png, pdf_4x6, or pdf_4x8. Default value is pdf.

• labelName string | null

  Label name

• labelRouting string | null

  Values are bestMatch or cheapest.

• labelScope string | null Required

  Select whether to generate labels for all shipments, or limit to only certain shipments, such as domestic or international.

  Values are all, domestic, international, or selected. Default value is all.

• lastName string | null

  Last name

• magentoStoreId integer(int32) | null

  Magento store

• minimumOrderRequirements string | null

  Minimum order requirements

• muteError boolean | null Required

  Mute error

  Default value is false.

• name string Required

  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 Required

  Order format

  Values are csv, json, or xml. Default value is csv.

• 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, or wooCommerceLegacy.

• orderSetupStatus string | null Required

  Order setup status

  Values are pending, requested, complete, or error. Default value is pending.

• orderSetupStatusMessage string | null

  Order setup status message

• orderSplitting string | null Required

  You can optionally split items across multiple dropship purchases if needed within the same vendor. For example, you may want to create a separate purchase order per item on the order if the vendor ships larger items.

  Values are group, splitQuantity, splitTag, or endpoint. Default value is group.

• orderSplittingEndpoint string | null

  Order splitting endpoint

• orderStatusCode string | null

  Order status code

• orderTemplateId integer(int32) | null

  Order template

• orderTemplateType string | null Required

  Order template type

  Values are none, custom, or default. Default value is none.

• orderUseProxy boolean | null

  Order use proxy

• ostUser string | null

  Ost user

• packagingWeight integer(int32) | null Required

  Packaging weight

  Default value is 0.

• 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 Required

  Payment day

  Values are monday, tuesday, wednesday, thursday, friday, saturday, or sunday. Default value is monday.

• paymentDayMonthly string | null Required

  Payment day monthly

  Values are firstMonday, firstDay, lastDay, or lastFriday. Default value is firstDay.

• 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 or disabled.

• paymentNotes string | null

  Payment notes

• paymentSchedule string | null Required

  Payment schedule

  Values are daily, weekly, or monthly. Default value is daily.

• paymentSetupStatus string | null Required

  Payment setup status

  Values are pending, requested, complete, or error. Default value is pending.

• paymentSetupStatusMessage string | null

  Payment setup status message

• paypalEmail string | null

  Paypal email

• phone string | null

  Phone

• platformCurrencyId integer(int32) | null

  When syncing orders, you can convert the prices from the currency in your store with the currency in the vendor's store. This will also convert the price of the shipping into the currency of the store.

• platformCustomerExternalId string | null

  Platform customer external

• platformExportReturns string | null Required

  Orders will be cancelled in the dropship providers store as returns and cancellations are raised in Jetti.

  Values are none or always. Default value is none.

• platformInvoiceAddress string | null Required

  Platform invoice address

  Values are customer, company, or none. Default value is company.

• platformNotification string | null Required

  Platform notification

  Values are enable, disable, or default. Default value is default.

• platformPrice string | null Required

  Platform price

  Values are purchase, sale, platform, or zero. Default value is purchase.

• platformProducts string | null Required

  Platform products

  Values are connected, notConnected, or all. Default value is connected.

• platformProperties string | null Required

  Platform properties

  Values are default, optionValues, or notes. Default value is default.

• platformShippingCode string | null

  System code shipping rate (e.g. "UPS_GROUND").

• platformShippingCost boolean | null Required

  Platform shipping cost

  Default value is false.

• platformShippingMapping string | null Required

  When syncing the shipping rate with the dropship providers store, you can change the display of the rates. This may be useful where their shipping platform requires the shipping names/codes to have specific values to be routed correctly.

  Values are default, mapping, or override. Default value is default.

• platformShippingMappingFallback string | null Required

  Platform shipping mapping fallback

  Values are default, none, or override. Default value is default.

• platformShippingPrice boolean | null Required

  Platform shipping price

  Default value is true.

• platformShippingProvider string | null

  Carrier/provider name for the shipping rate (e.g. FedEx).

• platformShippingServiceLevel string | null

  Service level for the shipping rate (e.g. Ground).

• platformStateCode string | null Required

  Change the format for US states on the shipping and invoice address.

  Values are ISO3166-2 or none. Default value is none.

• platformTags array[string] | null

  Platform tags

• platformTax string | null Required

  When syncing orders with the vendor store, a different tax rate can be applied than the one used to calculate payments. This will have no impact on the payout amounts. However, is typically requested by vendors if they want a specific tax rate applied to their orders other than that calculated at checkout by the marketplace.

  Values are default, manual, eu, or domestic. Default value is default.

• platformTaxRateId integer(int32) | null

  Platform tax rate

• platformTrackingRequirement string | null Required

  You can disable shipments from being import from your dropship provider if no tracking is available. This may be useful where vendors first mark 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 might mean the shipments are never marked as shipped if the tracking details are not available in their store.

  Values are skip, enabled, or disabled. Default value is disabled.

• prestashopShopGroupId string | null

  Prestashop shop group

• productTypeFilter string | null Required

  Product type filter

  Values are all, include, or exclude. Default value is all.

• productTypes array[string] | null

  Product types

• purchaseNotes string | null

  These notes are automatically included on emails, in the dropship portal and when syncing external orders.

• 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 Required

  Require inventory feed variant

  Default value is false.

• requiresShippingApproval boolean | null Required

  Default value is false.

• returnDropshipProviderAddressId integer(int32) | null

  Return dropship provider address

• returnInHouse boolean | null

  Return in house

• returnLabelType string | null Required

  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 or paid. Default value is paid.

• returnLabels string | null

  Jetti 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, or onSend.

• returnShipmentTrigger string | null Required

  Return shipment trigger

  Values are any or none. Default value is any.

• returnsPolicy string | null

  Returns policy

• saleReturnCustomerStatus string | null Required

  You can automatically set the approval status when returns are raised by staff or customers. A default can be set for all dropship providers in the returns setup area. Or, you can specify a different value here if needed.

  Values are default, requested, or finalized. Default value is default.

• saleReturnRefundTrigger string | null Required

  Sale return refund trigger

  Values are none, any, draft, requested, finalized, shipped, or received. Default value is none.

• sendOrderNotification boolean | null Required

  Send order notification

  Default value is false.

• sendReminder boolean | null Required

  Send reminder

  Default value is false.

• sendingSchedule string | null

  Orders can either be sent in real time, sent in daily batches or you can review before sending. The getting started with Jetti, we recommend setting this to review before sending, so no tests orders are accidently sent to the dropship provider.

  Values are manual, immediate, or daily.

• sendingScheduleHour string | null Required

  Sending schedule hour

  Default value is 9.

• sendingScheduleMinute string | null Required

  Sending schedule minute

  Values are 0, 15, 30, or 45. Default value is 0.

• setMerchantReference boolean | null

  Set merchant reference

• shipmentRouting string | null Required

  Shipment routing

  Values are customer, consolidated, or consolidatedInternational. Default value is customer.

• shippingEmail string | null Required

  Select which email address should be used when generating shipping labels. You can select either to use the dropship provider's email, or your email. If the dropship provider doesn't have any email set, it will default back to your email.

  Values are company or dropshipProvider. Default value is company.

• shippingEndpoint string | null

  Shipping endpoint

• shippingEndpointFormat string | null Required

  Shipping endpoint format

  Values are ftp, json, none, googleSheet, upload, or xml. Default value is none.

• shippingEndpointGrouping string | null Required

  Shipping endpoint grouping

  Values are order or lineItem. Default value is order.

• shippingEndpointMapping string | null Required

  Shipping endpoint mapping

  Values are default or custom. Default value is default.

• shippingEndpointPurpose string | null Required

  Shipping endpoint purpose

  Values are all or invoice. Default value is all.

• shippingPhone string | null Required

  Select which phone number should be used when generating shipping labels. You can select either to use the dropship provider's phone number, or yours. If the dropship provider doesn't have any phone number set, it will default back to yours.

  Values are company or dropshipProvider. Default value is company.

• shippingRateId integer(int32) | null

  Shipping rate

• shippingRates string | null

  Shipping rates

• shippingSetupStatus string | null Required

  Shipping setup status

  Values are pending, requested, complete, or error. Default value is pending.

• shippingSetupStatusMessage string | null

  Shipping setup status message

• shippingType string | null

  Shipping type

  Values are rechargeShipping, generateShippingLabels, customRates, or fixed.

• shippingUpdateExtension boolean | null

  Shipping update extension

• shippingUpdateExtensionDuration integer(int32) | null Required

  Shipping update extension duration

  Default value is 0.

• shippoToken string | null

  Shippo token

• silenceAlerts boolean | null

  Silence alerts

• skuFilter string | null Required

  Sku filter

  Values are all or startsWith. Default value is all.

• skus array[string] | null

  Skus

• state string | null

  State

• status string | null Required

  Status

  Values are pending, accepted, onboarding, away, disabled, or archived. Default value is accepted.

• stripeId string | null

  Stripe

• stripeManaged boolean | null Required

  Stripe managed

  Default value is false.

• stripeManagedEnabled boolean | null Required

  Stripe managed enabled

  Default value is false.

• stripeManagedId string | null

  Stripe managed

• stripePayout string | null

  Stripe payout

  Values are jetti or retailer.

• stripePayoutSource string | null Required

  Stripe payout source

  Values are balance or customer. Default value is balance.

• syncExternalReturns boolean | null Required

  Sync external returns

  Default value is false.

• syncOrderTax boolean | null Required

  Sync order tax

  Default value is true.

• tagFilter string | null Required

  Tag filter

  Values are all, include, or exclude. Default value is all.

• tagSplitting array[string] | null Required

  Tag splitting

  Default value is [] (empty).

• tags array[string] | null

  Tags

• taxCalculation string | null Required

  Tax calculation

  Values are disabled, taxjar, channel, or manual. Default value is disabled.

• taxId string | null

  Tax ID used for commerical invoices when generating shipping labels for international shipments.

• taxIncluded boolean | null Required

  Tax included

  Default value is true.

• taxJarToken string | null

  Tax jar token

• taxNumber string | null

  Tax number

• taxRateId integer(int32) | null

  Tax rate

• taxShipping boolean | null Required

  Tax shipping

  Default value is true.

• terms string | null

  Terms

• timezone string | null

  Timezone

• trackingScope string | null

  Tracking scope

  Values are full or none.

• transferwiseRecipientId string | null

  Transferwise recipient

• updatedAt string(date-time)

  Updated at

• useChannelShippingRate boolean | null Required

  Use channel shipping rate

  Default value is false.

• useCommissionRateEndpoint boolean | null Required

  API endpoint for sending the API payload for custom commission rate calculation.

  Default value is false.

• useDropshipmentSplittingEndpoint boolean | null

  Use dropshipment splitting endpoint

• useInternalReferenceTemplate boolean | null Required

  Use internal reference template

  Default value is false.

• userId integer(int32) | null

  User

• validationMessage array[string] | null

  Validation message

• w9Form string | null

  W9 form

• websiteUrl string | null

  Website url

• xeroId string | null

  Xero

• zip string | null

  Zip

• zohoId string | null

  Zoho