ShipHero Field Reference

Sample

 

https://connectors.windsor.ai/shiphero?api_key=[your API key]&date_preset=last_7d&fields=date,bill_id,bill_status,bill_customer_name,bill_profile_name,bill_created_at,bill_due_date,bill_amount,bill_billing_period_start,bill_billing_period_end,bill_billing_frequency


Fields

IDTypeNameDescriptionReport
account_idTEXTAccount IDThe Account ID
account_nameTEXTAccount NameThe Account Name
bill_amountTEXTBill AmountBill Amountbills
bill_billing_frequencyTEXTBilling FrequencyBilling Frequencybills
bill_billing_period_endTEXTBilling Period EndBilling Period Endbills
bill_billing_period_startTEXTBilling Period StartBilling Period Startbills
bill_created_atDATEBill Created DateBill Created Atbills
bill_customer_nameTEXTBill Customer NameBill Customer Namebills
bill_due_dateDATEBill Due DateBill Due Datebills
bill_idTEXTBill IDBill IDbills
bill_profile_nameTEXTBill Profile NameBill Profile Namebills
bill_statusTEXTBill StatusBill Statusbills
datasourceTEXTData SourceThe name of the Windsor connector returning the row
dateDATEDateCreated Date
day_of_monthTEXTDay of monthDay of the month
monthTEXTMonthNumber of the month
order_account_idTEXTOrder Account IDOrder Account IDorders
order_adult_signature_requiredBOOLEANOrder Adult Signature RequiredOrder Adult Signature Requiredorders
order_alcoholBOOLEANOrder AlcoholOrder Alcoholorders
order_allocation_priorityNUMERICOrder Allocation PriorityOrder Allocation Priorityorders
order_allow_partialBOOLEANOrder Allow PartialOrder Allow Partialorders
order_allow_splitBOOLEANOrder Allow SplitOrder Allow Splitorders
order_auto_print_return_labelBOOLEANOrder Auto Print Return LabelOrder Auto Print Return Labelorders
order_billing_address_address1TEXTOrder Billing Address Address1Order Billing Address Address1orders
order_billing_address_address2TEXTOrder Billing Address Address2Order Billing Address Address2orders
order_billing_address_cityCITYOrder Billing Address CityOrder Billing Address Cityorders
order_billing_address_companyTEXTOrder Billing Address CompanyOrder Billing Address Companyorders
order_billing_address_countryCOUNTRYOrder Billing Address CountryOrder Billing Address Countryorders
order_billing_address_country_codeCOUNTRYOrder Billing Address Country CodeOrder Billing Address Country Codeorders
order_billing_address_emailTEXTOrder Billing Address EmailOrder Billing Address Emailorders
order_billing_address_first_nameTEXTOrder Billing Address First NameOrder Billing Address First Nameorders
order_billing_address_last_nameTEXTOrder Billing Address Last NameOrder Billing Address Last Nameorders
order_billing_address_phoneTEXTOrder Billing Address PhoneOrder Billing Address Phoneorders
order_billing_address_stateTEXTOrder Billing Address StateOrder Billing Address Stateorders
order_billing_address_state_codeTEXTOrder Billing Address State CodeOrder Billing Address State Codeorders
order_billing_address_zipTEXTOrder Billing Address ZipOrder Billing Address Ziporders
order_box_nameTEXTOrder Box NameOrder Box Nameorders
order_currencyTEXTOrder CurrencyOrder Currencyorders
order_custom_invoice_urlTEXTOrder Custom Invoice UrlOrder Custom Invoice Urlorders
order_dateDATEOrder DateOrder Dateorders
order_dry_ice_weight_in_lbsTEXTOrder Dry Ice Weight In LbsOrder Dry Ice Weight In Lbsorders
order_emailTEXTOrder EmailOrder Emailorders
order_expected_weight_in_ozTEXTOrder Expected Weight In OzOrder Expected Weight In Ozorders
order_flaggedBOOLEANOrder FlaggedOrder Flaggedorders
order_ftr_exemptionNUMERICOrder Ftr ExemptionOrder Ftr Exemptionorders
order_fulfillment_statusTEXTOrder Fulfillment StatusStatus of the order (pending, fulfilled, cancelled, etc)orders
order_gift_invoiceBOOLEANOrder Gift InvoiceOrder Gift Invoiceorders
order_gift_noteTEXTOrder Gift NoteOrder Gift Noteorders
order_has_dry_iceBOOLEANOrder Has Dry IceOrder Has Dry Iceorders
order_hold_until_dateDATEOrder Hold Until DateOrder Hold Until Dateorders
order_holds_address_holdBOOLEANOrder Address HoldOrder Address Holdorders
order_holds_client_holdBOOLEANOrder Client HoldOrder Client Holdorders
order_holds_fraud_holdBOOLEANOrder Fraud HoldOrder Fraud Holdorders
order_holds_operator_holdBOOLEANOrder Operator HoldOrder Operator Holdorders
order_holds_payment_holdBOOLEANOrder Payment HoldOrder Payment Holdorders
order_holds_shipping_method_holdBOOLEANOrder Shipping Method HoldOrder Shipping Method Holdorders
order_idTEXTOrder IDOrder IDorders
order_ignore_address_validation_errorsBOOLEANOrder Ignore Address Validation ErrorsOrder Ignore Address Validation Errorsorders
order_incotermsTEXTOrder IncotermsOrder Incotermsorders
order_insuranceBOOLEANOrder InsuranceOrder Insuranceorders
order_insurance_amountTEXTOrder Insurance AmountOrder Insurance Amountorders
order_legacy_idNUMERICOrder Legacy IDOrder Legacy IDorders
order_numberTEXTOrder NumberThe store's internal order numberorders
order_packing_noteTEXTOrder Packing NoteOrder Packing Noteorders
order_partner_order_idTEXTOrder Partner Order IDThe order ID assigned by the storefrontorders
order_priority_flagBOOLEANOrder Priority FlagOrder Priority Flagorders
order_profileTEXTOrder ProfileOrder Profileorders
order_require_signatureBOOLEANOrder Require SignatureOrder Require Signatureorders
order_required_ship_dateDATEOrder Required Ship DateOrder Required Ship Dateorders
order_saturday_deliveryBOOLEANOrder Saturday DeliveryOrder Saturday Deliveryorders
order_shipping_address_address1TEXTOrder Shipping Address Address1Order Shipping Address Address1orders
order_shipping_address_address2TEXTOrder Shipping Address Address2Order Shipping Address Address2orders
order_shipping_address_cityCITYOrder Shipping Address CityOrder Shipping Address Cityorders
order_shipping_address_companyTEXTOrder Shipping Address CompanyOrder Shipping Address Companyorders
order_shipping_address_countryCOUNTRYOrder Shipping Address CountryOrder Shipping Address Countryorders
order_shipping_address_country_codeCOUNTRYOrder Shipping Address Country CodeOrder Shipping Address Country Codeorders
order_shipping_address_emailTEXTOrder Shipping Address EmailOrder Shipping Address Emailorders
order_shipping_address_first_nameTEXTOrder Shipping Address First NameOrder Shipping Address First Nameorders
order_shipping_address_last_nameTEXTOrder Shipping Address Last NameOrder Shipping Address Last Nameorders
order_shipping_address_phoneTEXTOrder Shipping Address PhoneOrder Shipping Address Phoneorders
order_shipping_address_stateTEXTOrder Shipping Address StateOrder Shipping Address Stateorders
order_shipping_address_state_codeTEXTOrder Shipping Address State CodeOrder Shipping Address State Codeorders
order_shipping_address_zipTEXTOrder Shipping Address ZipOrder Shipping Address Ziporders
order_shipping_lines_carrierTEXTOrder Shipping Lines CarrierOrder Shipping Lines Carrierorders
order_shipping_lines_methodTEXTOrder Shipping Lines MethodOrder Shipping Lines Methodorders
order_shipping_lines_priceTEXTOrder Shipping Lines PriceOrder Shipping Lines Priceorders
order_shipping_lines_titleTEXTOrder Shipping Lines TitleOrder Shipping Lines Titleorders
order_shop_nameTEXTOrder Shop NameOrder Shop Nameorders
order_skip_address_validationBOOLEANOrder Skip Address ValidationOrder Skip Address Validationorders
order_sourceTEXTOrder SourceOrder Sourceorders
order_subtotalNUMERICOrder SubtotalOrder Subtotalorders
order_tax_idTEXTOrder Tax IDOrder Tax IDorders
order_tax_typeTEXTOrder Tax TypeOrder Tax Typeorders
order_third_party_shipper_account_numberTEXTOrder Third Party Shipper Account NumberOrder Third Party Shipper Account Numberorders
order_third_party_shipper_countryCOUNTRYOrder Third Party Shipper CountryOrder Third Party Shipper Countryorders
order_third_party_shipper_zipTEXTOrder Third Party Shipper ZipOrder Third Party Shipper Ziporders
order_total_discountsNUMERICOrder Total DiscountsOrder Total Discountsorders
order_total_priceNUMERICOrder Total PriceOrder Total Priceorders
order_total_taxTEXTOrder Total TaxOrder Total Taxorders
order_updated_dateDATEOrder Updated DateOrder Updated Dateorders
product_account_idTEXTProduct Account IDProduct Account IDproducts
product_barcodeTEXTProduct BarcodeProduct Barcodeproducts
product_country_of_manufactureCOUNTRYProduct Country Of ManufactureProduct Country Of Manufactureproducts
product_created_atDATEProduct Created AtProduct Created Atproducts
product_customs_descriptionTEXTProduct Customs DescriptionProduct Customs Descriptionproducts
product_customs_valueTEXTProduct Customs ValueProduct Customs Valueproducts
product_dimensions_heightTEXTProduct HeightHeight in unit configured in the account (In by default)products
product_dimensions_lengthTEXTProduct LengthLenght in unit configured in the account (In by default)products
product_dimensions_weightTEXTProduct WeightWeight in unit configured in the account (Oz by default)products
product_dimensions_widthTEXTProduct WidthWidth in unit configured in the account (In by default)products
product_dropshipBOOLEANProduct DropshipProduct Dropshipproducts
product_final_saleBOOLEANProduct Final SaleProduct Final Saleproducts
product_idTEXTProduct IDProduct IDproducts
product_ignore_on_customsBOOLEANProduct Ignore On CustomsProduct Ignore On Customsproducts
product_ignore_on_invoiceBOOLEANProduct Ignore On InvoiceProduct Ignore On Invoiceproducts
product_kitBOOLEANProduct KitProduct Kitproducts
product_kit_buildBOOLEANProduct Kit BuildProduct Kit Buildproducts
product_large_thumbnailTEXTProduct Large ThumbnailProduct Large Thumbnailproducts
product_legacy_idNUMERICProduct Legacy IDProduct Legacy IDproducts
product_nameTEXTProduct NameName of the productproducts
product_needs_lot_trackingBOOLEANProduct Needs Lot TrackingProduct Needs Lot Trackingproducts
product_needs_serial_numberBOOLEANProduct Needs Serial NumberProduct Needs Serial Numberproducts
product_no_airBOOLEANProduct No AirProduct No Airproducts
product_not_ownedBOOLEANProduct Not OwnedProduct Not Ownedproducts
product_packer_noteTEXTProduct Packer NoteProduct Packer Noteproducts
product_product_noteTEXTProduct Product NoteProduct Product Noteproducts
product_skuTEXTProduct SkuStock Keeping Unitproducts
product_tariff_codeTEXTProduct Tariff CodeProduct Tariff Codeproducts
product_thumbnailTEXTProduct ThumbnailProduct Thumbnailproducts
product_updated_atDATEProduct Updated AtProduct Updated Atproducts
product_virtualBOOLEANProduct VirtualProduct Virtualproducts
purchase_order_account_idTEXTPurchase Order Account IDPurchase Order Account IDpurchase_orders
purchase_order_arrived_atDATEPurchase Order Arrived AtPurchase Order Arrived Atpurchase_orders
purchase_order_created_atDATEPurchase Order Created AtPurchase Order Created Atpurchase_orders
purchase_order_date_closedDATEPurchase Order Date ClosedPurchase Order Date Closedpurchase_orders
purchase_order_descriptionTEXTPurchase Order DescriptionPurchase Order Descriptionpurchase_orders
purchase_order_discountTEXTPurchase Order DiscountPurchase Order Discountpurchase_orders
purchase_order_fulfillment_statusTEXTPurchase Order Fulfillment StatusPurchase Order Fulfillment Statuspurchase_orders
purchase_order_idTEXTPurchase Order IDPurchase Order IDpurchase_orders
purchase_order_imagesTEXTPurchase Order ImagesPurchase Order Imagespurchase_orders
purchase_order_legacy_idTEXTPurchase Order Legacy IDPurchase Order Legacy IDpurchase_orders
purchase_order_locked_by_user_idTEXTPurchase Order Locked By User IDPurchase Order Locked By User IDpurchase_orders
purchase_order_lockingTEXTPurchase Order LockingPurchase Order Lockingpurchase_orders
purchase_order_origin_of_shipmentTEXTPurchase Order Origin Of ShipmentPurchase Order Origin Of Shipmentpurchase_orders
purchase_order_packing_noteTEXTPurchase Order Packing NotePurchase Order Packing Notepurchase_orders
purchase_order_partner_order_numberTEXTPurchase Order Partner Order NumberPurchase Order Partner Order Numberpurchase_orders
purchase_order_payment_due_byTEXTPurchase Order Payment Due ByPurchase Order Payment Due Bypurchase_orders
purchase_order_payment_methodTEXTPurchase Order Payment MethodPurchase Order Payment Methodpurchase_orders
purchase_order_payment_noteTEXTPurchase Order Payment NotePurchase Order Payment Notepurchase_orders
purchase_order_pdfTEXTPurchase Order PdfPurchase Order Pdfpurchase_orders
purchase_order_po_dateDATEPurchase Order Po DatePurchase Order Po Datepurchase_orders
purchase_order_po_noteTEXTPurchase Order Po NotePurchase Order Po Notepurchase_orders
purchase_order_po_numberTEXTPurchase Order Po NumberPurchase Order Po Numberpurchase_orders
purchase_order_ship_dateDATEPurchase Order Ship DatePurchase Order Ship Datepurchase_orders
purchase_order_shipping_carrierTEXTPurchase Order Shipping CarrierPurchase Order Shipping Carrierpurchase_orders
purchase_order_shipping_methodTEXTPurchase Order Shipping MethodPurchase Order Shipping Methodpurchase_orders
purchase_order_shipping_nameTEXTPurchase Order Shipping NamePurchase Order Shipping Namepurchase_orders
purchase_order_shipping_priceTEXTPurchase Order Shipping PricePurchase Order Shipping Pricepurchase_orders
purchase_order_subtotalTEXTPurchase Order SubtotalPurchase Order Subtotalpurchase_orders
purchase_order_taxTEXTPurchase Order TaxPurchase Order Taxpurchase_orders
purchase_order_total_priceTEXTPurchase Order Total PricePurchase Order Total Pricepurchase_orders
purchase_order_tracking_numberTEXTPurchase Order Tracking NumberPurchase Order Tracking Numberpurchase_orders
purchase_order_vendor_idTEXTPurchase Order Vendor IDPurchase Order Vendor IDpurchase_orders
purchase_order_warehouse_idTEXTPurchase Order Warehouse IDPurchase Order Warehouse IDpurchase_orders
return_account_idTEXTReturn Account IDReturn Account IDreturns
return_address_address1TEXTReturn Address Address1Address line 1returns
return_address_address2TEXTReturn Address Address2Address line 2returns
return_address_cityCITYReturn Address CityAddress's Cityreturns
return_address_countryCOUNTRYReturn Address CountryAddress's Countryreturns
return_address_nameTEXTReturn Address NameThe address's name or name of the person assigned to the addressreturns
return_address_phoneTEXTReturn Address PhoneReturn Address Phonereturns
return_address_stateTEXTReturn Address StateAddress's Statereturns
return_address_zipTEXTReturn Address ZipAddress's Postal Codereturns
return_cost_to_customerTEXTReturn Cost To CustomerReturn Cost To Customerreturns
return_created_atDATEReturn Created AtReturn Created Atreturns
return_dimensions_heightTEXTReturn Dimensions HeightHeight in unit configured in the account (In by default)returns
return_dimensions_lengthTEXTReturn Dimensions LengthLenght in unit configured in the account (In by default)returns
return_dimensions_weightTEXTReturn Dimensions WeightWeight in unit configured in the account (Oz by default)returns
return_dimensions_widthTEXTReturn Dimensions WidthWidth in unit configured in the account (In by default)returns
return_display_issue_refundBOOLEANReturn Display Issue RefundReturn Display Issue Refundreturns
return_idTEXTReturn IDReturn IDreturns
return_label_costTEXTReturn Label CostReturn Label Costreturns
return_label_typeTEXTReturn Label TypeReturn Label Typereturns
return_legacy_idNUMERICReturn Legacy IDReturn Legacy IDreturns
return_order_idTEXTReturn Order IDReturn Order IDreturns
return_partner_idTEXTReturn Partner IDReturn Partner IDreturns
return_reasonTEXTReturn ReasonReturn Reasonreturns
return_shipping_carrierTEXTReturn Shipping CarrierReturn Shipping Carrierreturns
return_shipping_methodTEXTReturn Shipping MethodReturn Shipping Methodreturns
return_statusTEXTReturn StatusReturn Statusreturns
return_total_items_expectedNUMERICReturn Total Items ExpectedReturn Total Items Expectedreturns
return_total_items_receivedNUMERICReturn Total Items ReceivedReturn Total Items Receivedreturns
return_total_items_restockedNUMERICReturn Total Items RestockedReturn Total Items Restockedreturns
shipment_address_address1TEXTShipment Address Address1Address line 1shipments
shipment_address_address2TEXTShipment Address Address2Address line 2shipments
shipment_address_cityCITYShipment Address CityAddress's Cityshipments
shipment_address_countryCOUNTRYShipment Address CountryAddress's Countryshipments
shipment_address_nameTEXTShipment Address NameThe address's name or name of the person assigned to the addressshipments
shipment_address_phoneTEXTShipment Address PhoneShipment Address Phoneshipments
shipment_address_stateTEXTShipment Address StateAddress's Stateshipments
shipment_address_zipTEXTShipment Address ZipAddress's Postal Codeshipments
shipment_completedBOOLEANShipment CompletedThis field indicates if store was notified about the shipment. It should be 'true' by default and 'false' when using the Bulk Ship UI.shipments
shipment_created_dateDATEShipment Created DateShipment Created Dateshipments
shipment_deliveredBOOLEANShipment DeliveredShipment Deliveredshipments
shipment_dropshipmentBOOLEANShipment DropshipmentShipment Dropshipmentshipments
shipment_idTEXTShipment IDShipment IDshipments
shipment_legacy_idNUMERICShipment Legacy IDShipment Legacy IDshipments
shipment_needs_refundBOOLEANShipment Needs RefundShipment Needs Refundshipments
shipment_order_idTEXTShipment Order IDShipment Order IDshipments
shipment_pending_shipment_idTEXTShipment Pending Shipment IDShipment Pending Shipment IDshipments
shipment_picked_upBOOLEANShipment Picked UpShipment Picked Upshipments
shipment_profileTEXTShipment ProfileShipment Profileshipments
shipment_refundedBOOLEANShipment RefundedShipment Refundedshipments
shipment_shipped_off_shipheroBOOLEANShipment Shipped Off ShipheroShipment Shipped Off Shipheroshipments
shipment_total_packagesNUMERICShipment Total PackagesShipment Total Packagesshipments
shipment_user_idTEXTShipment User IDShipment User IDshipments
shipment_warehouse_idTEXTShipment Warehouse IDShipment Warehouse IDshipments
sourceTEXTSourceThe name of the Windsor connector returning the row
todayDATETodayToday's date
warehouse_product_account_idTEXTWarehouse Product Account IDWarehouse Product Account IDwarehouse_products
warehouse_product_activeBOOLEANWarehouse Product ActiveWarehouse Product Activewarehouse_products
warehouse_product_allocatedNUMERICWarehouse Product AllocatedCount of how many units you have in stock and owe to customers for open orderswarehouse_products
warehouse_product_availableNUMERICWarehouse Product AvailableThe number of available stock for any given SKU that is pushed to any connected sales channel. This is On Hand minus any allocations to open orders.warehouse_products
warehouse_product_backorderNUMERICWarehouse Product BackorderCount of how many units you owe to customers for open orders and don’t have stock for in the warehousewarehouse_products
warehouse_product_created_atDATEWarehouse Product Created AtWarehouse Product Created Atwarehouse_products
warehouse_product_customBOOLEANWarehouse Product CustomWarehouse Product Customwarehouse_products
warehouse_product_customs_valueTEXTWarehouse Product Customs ValueWarehouse Product Customs Valuewarehouse_products
warehouse_product_idTEXTWarehouse Product IDWarehouse Product IDwarehouse_products
warehouse_product_inventory_binTEXTWarehouse Product Inventory BinThe name of the bin where the product is storedwarehouse_products
warehouse_product_inventory_overstock_binTEXTWarehouse Product Inventory Overstock BinThe name of the bin where overstock is storedwarehouse_products
warehouse_product_legacy_idNUMERICWarehouse Product Legacy IDWarehouse Product Legacy IDwarehouse_products
warehouse_product_non_sellable_quantityNUMERICWarehouse Product Non Sellable QuantityCount of non sellable units of a SKU in the warehouse.warehouse_products
warehouse_product_on_handNUMERICWarehouse Product On HandThe total count of a SKU physically in the warehouse. (Note, Available is the count indicated in your sales channels)warehouse_products
warehouse_product_priceTEXTWarehouse Product PricePrice of the productwarehouse_products
warehouse_product_reorder_amountNUMERICWarehouse Product Reorder AmountThe number that should be reordered when a SKU reaches the Reorder Levelwarehouse_products
warehouse_product_reorder_levelNUMERICWarehouse Product Reorder LevelThe Available value a SKU must reach to trigger a Reorder. (See Reorder Amount). Setting this to 0 will prevent a SKU from automatically being added to a POwarehouse_products
warehouse_product_replenishment_levelNUMERICWarehouse Product Replenishment LevelAvailable only for accounts that use Dynamic Slotting and used specifically for replenishment reports. SKUs will appear on the replenishment report if inventory allocated and not enough in pickable bins, or if the pickable bin inventory is less than the replenishment levelwarehouse_products
warehouse_product_reserve_inventoryNUMERICWarehouse Product Reserve InventoryCount of a SKU that is not to be sold in your sales channel.For example, if you’re running a flash sale and want to hold some stock for returns or exchanges, you would enter your full inventory of say 100 units as the On Hand and a Reserve of 5 units. We’ll then tell the platform that you have 95 available for sale (On Hand minus Reserve). The Available count will remain 100warehouse_products
warehouse_product_sell_aheadNUMERICWarehouse Product Sell AheadWarehouse Product Sell Aheadwarehouse_products
warehouse_product_skuTEXTWarehouse Product SkuStock Keeping Unitwarehouse_products
warehouse_product_updated_atDATEWarehouse Product Updated AtWarehouse Product Updated Atwarehouse_products
warehouse_product_valueTEXTWarehouse Product ValuePrice paid for the productwarehouse_products
warehouse_product_value_currencyTEXTWarehouse Product Value CurrencyWarehouse Product Value Currencywarehouse_products
warehouse_product_warehouse_idTEXTWarehouse Product Warehouse IDWarehouse Product Warehouse IDwarehouse_products
warehouse_product_warehouse_identifierTEXTWarehouse Product Warehouse IDentifierThe warehouse identifier, usually Primary/Secondarywarehouse_products
weekTEXTWeekWeek (Sun-Sat).
week_dayTEXTDay of week and day numberWeekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_isoTEXTDay of week and day number, ISOWeekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_isoTEXTWeek ISOWeek, ISO format (Mon-Sun).
yearTEXTYearYear
year_monthTEXTYearmonthYear and month, e.g. 2024|3
year_of_weekTEXTYear of weekThe year that contains first day of the week (Sun-Sat).
year_of_week_isoTEXTYear of week, ISOThe year that contains first day of the ISO week (Mon-Sun).
year_weekTEXTYear weekYear and week for US weeks (Sun-Sat), e.g. 2024|15
year_week_isoTEXTYear week ISOYear and week for ISO weeks (Mon-Sun), e.g. 2024|20