Jump to Content
Public API Gateway
Abstractions Reference
Home
Guides
Recipes
API Reference
Changelog
v1.0
v2.0
Public API Gateway
Abstractions Reference
Help Center
Ask a Dev
Log In
API Reference
Help Center
Ask a Dev
Log In
v2.0
API Reference
Getting Started with the Extension API
All
Pages
Start typing to search…
JUMP TO
Extension API
About The Extension API
Authentication & Authorization
Getting Started with the Extension API
Persisting Exceptions Through Hooks
Extension Services
About The Extension Service APIs
AddressesService
/api/extension/services/AddressesService/v1/GetAddress
post
/api/extension/services/AddressesService/v1/GetAddresses
post
/api/extension/services/AddressesService/v1/GetLocalization
post
AdjustmentService
/api/extension/services/AdjustmentService/v1/SaveAdjustment
post
/api/extension/services/AdjustmentService/v1/DeleteAdjustment
post
/api/extension/services/AdjustmentService/v1/GetAdjustment
post
/api/extension/services/AdjustmentService/v1/MarkAdjustmentsPaidByExternalMerchant
post
/api/extension/services/AdjustmentService/v1/MarkAdjustmentsPaidByMerchant
post
AssociateService
/api/extension/services/AssociateService/v1/GetAssociate
post
/api/extension/services/AssociateService/v1/GetAssociateByBackOfficeId
post
/api/extension/services/AssociateService/v1/FindAssociate
post
/api/extension/services/AssociateService/v1/GetAssociates
post
/api/extension/services/AssociateService/v1/UpdateAssociate
post
/api/extension/services/AssociateService/v1/GetProfileImageURL
post
/api/extension/services/AssociateService/v1/SetAssociateStatus
post
/api/extension/services/AssociateService/v1/GetAssociateTypeName
post
/api/extension/services/AssociateService/v1/GetRetailAssociateTypes
post
/api/extension/services/AssociateService/v1/GetSocialInfo
post
/api/extension/services/AssociateService/v1/GetLocalization
post
AutoshipService
/api/extension/services/AutoshipService/v1/CreateAutoship
post
/api/extension/services/AutoshipService/v1/UpdateAutoship
post
/api/extension/services/AutoshipService/v1/GetAutoship
post
/api/extension/services/AutoshipService/v1/GetAutoships
post
/api/extension/services/AutoshipService/v1/GetAutoshipsByProcessDate
post
/api/extension/services/AutoshipService/v1/ProcessAutoships
post
/api/extension/services/AutoshipService/v1/CalculateNextProcessDate
post
/api/extension/services/AutoshipService/v1/DeleteAutoship
post
BomService
/api/extension/services/BomService/v1/GetBOMGroups
post
/api/extension/services/BomService/v1/GetBOM
post
CategoryService
/api/extension/services/CategoryService/v1/GetCategories
post
CompanyService
/api/extension/services/CompanyService/v1/GetCompany
post
/api/extension/services/CompanyService/v1/GetReplicatedSiteUrl
post
/api/extension/services/CompanyService/v1/GetRootURL
post
CountryService
/api/extension/services/CountryService/v1/GetCountry
post
/api/extension/services/CountryService/v1/GetCountries
post
/api/extension/services/CountryService/v1/GetAllCountryLanguages
post
/api/extension/services/CountryService/v1/GetCountryLanguages
post
/api/extension/services/CountryService/v1/GetDefaultLanguageCode
post
/api/extension/services/CountryService/v1/GetState
post
/api/extension/services/CountryService/v1/GetStates
post
CouponService
/api/extension/services/CouponService/v1/GetCoupons
post
/api/extension/services/CouponService/v1/FindCoupons
post
/api/extension/services/CouponService/v1/DeleteCoupon
post
/api/extension/services/CouponService/v1/CalculateCoupon
post
/api/extension/services/CouponService/v1/IsCouponUsed
post
/api/extension/services/CouponService/v1/SaveCoupon
post
/api/extension/services/CouponService/v1/GetValidCartAssociateCoupons
post
/api/extension/services/CouponService/v1/GetValidCartAssociateCouponsWithPriceGroup
post
/api/extension/services/CouponService/v1/GetOrderCouponUsage
post
/api/extension/services/CouponService/v1/GetAssociateCouponUsage
post
/api/extension/services/CouponService/v1/GetValidAssociateCoupons
post
CurrencyService
/api/extension/services/CurrencyService/v1/MaskAmount
post
/api/extension/services/CurrencyService/v1/GetCurrencyCode
post
/api/extension/services/CurrencyService/v1/GetCurrency
post
/api/extension/services/CurrencyService/v1/Round
post
/api/extension/services/CurrencyService/v1/Convert
post
/api/extension/services/CurrencyService/v1/GetBaseCurrencyCode
post
/api/extension/services/CurrencyService/v1/GetCurrencies
post
CustomTreeService
/api/extension/services/CustomTreeService/v1/GetTrees
post
/api/extension/services/CustomTreeService/v1/GetEnrollerTree
post
/api/extension/services/CustomTreeService/v1/GetSponsorTree
post
/api/extension/services/CustomTreeService/v1/GetTree
post
DataService
/api/extension/services/DataService/v1/GetConnectionString
post
/api/extension/services/DataService/v1/GetClientConnectionString
post
EmailService
/api/extension/services/EmailService/v1/SendEmail
post
EnrollmentService
/api/extension/services/EnrollmentService/v1/WriteApplication
post
/api/extension/services/EnrollmentService/v1/SendWelcomeEmail
post
/api/extension/services/EnrollmentService/v1/ValidateEnrollerBirthDate
post
/api/extension/services/EnrollmentService/v1/ValidateEmail
post
/api/extension/services/EnrollmentService/v1/ValidateUsername
post
/api/extension/services/EnrollmentService/v1/ValidateUsernameUpgrade
post
EventService
/api/extension/services/EventService/v1/PostEvent
post
ExtensionLogger
/api/extension/services/LoggerService/v1/Log
post
HistoryService
/api/extension/services/HistoryService/v1/GetRuleResults
post
/api/extension/services/HistoryService/v1/GetCommissionHistory
post
/api/extension/services/HistoryService/v1/GetCommissionDetail
post
/api/extension/services/HistoryService/v1/GetHighRankDate
post
/api/extension/services/HistoryService/v1/GetLastRankDate
post
/api/extension/services/HistoryService/v1/IsLocked
post
/api/extension/services/HistoryService/v1/SetLockDate
post
ItemService
/api/extension/services/ItemService/v1/SaveItem
post
/api/extension/services/ItemService/v1/GetItem
post
/api/extension/services/ItemService/v1/GetLineItemById
post
/api/extension/services/ItemService/v1/GetLineItemBySku
post
/api/extension/services/ItemService/v1/GetLineItems
post
/api/extension/services/ItemService/v1/GetLineItemsForAssociate
post
MoneyInService
/api/extension/services/MoneyInService/v1/SavePaymentMethod
post
/api/extension/services/MoneyInService/v1/GetPaymentMethods
post
/api/extension/services/MoneyInService/v1/GetBalance
post
/api/extension/services/MoneyInService/v1/ValidateCurrency
post
/api/extension/services/MoneyInService/v1/GetAddPaymentIframe
post
MoneyOutService
/api/extension/services/MoneyOutService/v1/GetOnFileMerchants
post
/api/extension/services/MoneyOutService/v1/SetActiveOnFileMerchantPreference
post
/api/extension/services/MoneyOutService/v1/SetActiveOnFileMerchant
post
/api/extension/services/MoneyOutService/v1/AutoProvisionAccount
post
/api/extension/services/MoneyOutService/v1/GetCustomValuesActive
post
/api/extension/services/MoneyOutService/v1/GetCustomValues
post
NotificationService
/api/extension/services/NotificationService/v1/LogNotificationEvent
post
/api/extension/services/NotificationService/v1/GetNotificationEvents
post
OrderService
/api/extension/services/OrderService/v1/GetOrders
post
/api/extension/services/OrderService/v1/CancelOrder
post
/api/extension/services/OrderService/v1/Log
post
/api/extension/services/OrderService/v1/GetUnshippedPackages
post
/api/extension/services/OrderService/v1/IsMoveOrderPermitted
post
/api/extension/services/OrderService/v1/UpdateOrder
post
/api/extension/services/OrderService/v1/UpdateOrders
post
/api/extension/services/OrderService/v1/UpdateOrderTotal
post
/api/extension/services/OrderService/v1/IsOrderLocked
post
/api/extension/services/OrderService/v1/GetPackageDetail
post
/api/extension/services/OrderService/v1/UpdatePackage
post
/api/extension/services/OrderService/v1/RefundPayment
post
/api/extension/services/OrderService/v1/SubmitOrder
post
/api/extension/services/OrderService/v1/PayOrder
post
/api/extension/services/OrderService/v1/FinalizeAcceptedOrder
post
/api/extension/services/OrderService/v1/FinalizeNonAcceptedOrder
post
/api/extension/services/OrderService/v1/FinalizeOrderPaymentStatus
post
/api/extension/services/OrderService/v1/InsertOrderPayment
post
/api/extension/services/OrderService/v1/GetTotals
post
/api/extension/services/OrderService/v1/GetTotalsWithOverrides
post
/api/extension/services/OrderService/v1/GetOrderByOrderNumber
post
/api/extension/services/OrderService/v1/GetOrdersWSort
post
/api/extension/services/OrderService/v1/GetOrdersByAssociateId
post
/api/extension/services/OrderService/v1/GetAssociatesOrdersByModifiedDate
post
/api/extension/services/OrderService/v1/GetAssociatesOrdersByOrderDate
post
OverrideService
/api/extension/services/OverrideService/v1/SaveOverride
post
/api/extension/services/OverrideService/v1/GetOverrides
post
/api/extension/services/OverrideService/v1/DeleteOverride
post
PartyService
/api/extension/services/PartyService/v1/GetParty
post
/api/extension/services/PartyService/v1/CloseParty
post
/api/extension/services/PartyService/v1/GetParties
post
PaymentProcessingService
/api/extension/services/PaymentProcessingService/v1/GetPayments
post
/api/extension/services/PaymentProcessingService/v1/FindPaidPayments
post
/api/extension/services/PaymentProcessingService/v1/GetPaidPayments
post
/api/extension/services/PaymentProcessingService/v1/GetPaidPaymentByTransactionNumber
post
/api/extension/services/PaymentProcessingService/v1/GetPaidPaymentByCheckNumber
post
PeriodService
/api/extension/services/PeriodService/v1/GetCommittedPeriod
post
/api/extension/services/PeriodService/v1/GetUnCommittedPeriod
post
/api/extension/services/PeriodService/v1/GetCommittedPeriods
post
/api/extension/services/PeriodService/v1/GetPeriods
post
RankService
/api/extension/services/RankService/v1/GetRanks
post
/api/extension/services/RankService/v1/GetRankName
post
RegionService
/api/extension/services/RegionService/v1/GetRegionIdByAddress
post
/api/extension/services/RegionService/v1/GetRegionId
post
/api/extension/services/RegionService/v1/GetRegionName
post
RegistrationService
/api/extension/services/RegistrationService/v1/GetAllHookRegistrations
post
/api/extension/services/RegistrationService/v1/UpdateAllHookRegistrations
post
/api/extension/services/RegistrationService/v2/DeleteHookRegistration
post
/api/extension/services/RegistrationService/v1/DeleteHookRegistration
post
/api/extension/services/RegistrationService/v1/GetAllMerchantRegistrations
post
/api/extension/services/RegistrationService/v1/UpdateAllMerchantRegistrations
post
/api/extension/services/RegistrationService/v2/DeleteMerchantRegistration
post
/api/extension/services/RegistrationService/v1/DeleteMerchantRegistration
post
/api/extension/services/RegistrationService/v1/GetAllPageRegistrations
post
/api/extension/services/RegistrationService/v1/UpdateAllPageRegistrations
post
/api/extension/services/RegistrationService/v2/DeletePageRegistration
post
/api/extension/services/RegistrationService/v1/DeletePageRegistration
post
/api/extension/services/RegistrationService/v1/GetAllEventHandlerRegistrations
post
/api/extension/services/RegistrationService/v1/UpdateAllEventHandlerRegistrations
post
/api/extension/services/RegistrationService/v2/DeleteEventHandlerRegistration
post
/api/extension/services/RegistrationService/v1/DeleteEventHandlerRegistration
post
RewardPointsService
/api/extension/services/RewardPointsService/v1/AddRewardPoints
post
/api/extension/services/RewardPointsService/v1/AddRewardPointsWithExpiration
post
/api/extension/services/RewardPointsService/v1/GetRewardPoints
post
/api/extension/services/RewardPointsService/v1/GetRewardPointDetails
post
/api/extension/services/RewardPointsService/v1/GetAvailableRewardPoints
post
RmaService
/api/extension/services/RmaService/v1/GetRmas
post
/api/extension/services/RmaService/v1/GetRma
post
/api/extension/services/RmaService/v1/CreateRma
post
/api/extension/services/RmaService/v1/DeleteRma
post
/api/extension/services/RmaService/v1/MarkRmaShipped
post
/api/extension/services/RmaService/v1/CanOrderGenerateRma
post
/api/extension/services/RmaService/v1/ReceiveRma
post
/api/extension/services/RmaService/v1/GetOrderRmas
post
SettingsService
/api/extension/services/SettingsService/v1/GetColors
post
/api/extension/services/SettingsService/v1/GetImagePaths
post
/api/extension/services/SettingsService/v1/GetAvaliableComponents
post
/api/extension/services/SettingsService/v1/ExtensionContext
post
ShippingService
/api/extension/services/ShippingService/v1/GetShippingMethods
post
/api/extension/services/ShippingService/v1/GetShippingMethod
post
SourceService
/api/extension/services/SourceService/v1/PostSource
post
/api/extension/services/SourceService/v1/PostSources
post
StatsService
/api/extension/services/StatsService/v1/GetStats
post
/api/extension/services/StatsService/v1/RecalculateVolume
post
/api/extension/services/StatsService/v1/ProcessStatsQueue
post
StockLevelsService
/api/extension/services/StockLevelsService/v1/CancelReserve
post
/api/extension/services/StockLevelsService/v1/CommitReserve
post
/api/extension/services/StockLevelsService/v1/ReserveStock
post
/api/extension/services/StockLevelsService/v1/GetStockLevel
post
/api/extension/services/StockLevelsService/v1/GetStockLevels
post
/api/extension/services/StockLevelsService/v1/GetStockLevelsBulk
post
StoreService
/api/extension/services/StoreService/v1/GetStores
post
/api/extension/services/StoreService/v1/GetStoreByType
post
/api/extension/services/StoreService/v1/GetStore
post
/api/extension/services/StoreService/v1/DeleteStore
post
/api/extension/services/StoreService/v1/CreateStore
post
/api/extension/services/StoreService/v1/UpdateStore
post
SubscriptionService
/api/extension/services/SubscriptionService/v1/GetSubscription
post
/api/extension/services/SubscriptionService/v1/GetSubscriptions
post
/api/extension/services/SubscriptionService/v1/GetSubscriptionItems
post
/api/extension/services/SubscriptionService/v1/ProcessItems
post
/api/extension/services/SubscriptionService/v1/UpdateExpiration
post
/api/extension/services/SubscriptionService/v1/CancelSubscription
post
TaxService
/api/extension/services/TaxService/v1/GetOrderTax
post
/api/extension/services/TaxService/v1/GetOrderTaxUsd
post
/api/extension/services/TaxService/v1/GetTax
post
/api/extension/services/TaxService/v1/MarkTaxCommitted
post
/api/extension/services/TaxService/v1/MarkTaxRefunded
post
TicketService
/api/extension/services/TicketService/v1/LogEvent
post
/api/extension/services/TicketService/v1/SendNote
post
TreeService
/api/extension/services/TreeService/v1/GetMatrixDepth
post
/api/extension/services/TreeService/v1/GetFirstTreeNodeId
post
/api/extension/services/TreeService/v1/GetLastTreeNodeId
post
/api/extension/services/TreeService/v1/GetTreeIndexes
post
/api/extension/services/TreeService/v1/Place
post
/api/extension/services/TreeService/v1/ValidatePlacements
post
/api/extension/services/TreeService/v1/DeleteNodeAll
post
/api/extension/services/TreeService/v1/DeleteNode
post
/api/extension/services/TreeService/v1/GetUnplacedNodes
post
/api/extension/services/TreeService/v1/GetUplineIds
post
/api/extension/services/TreeService/v1/GetUplineIdsBulk
post
/api/extension/services/TreeService/v1/GetUplineIdsPartial
post
/api/extension/services/TreeService/v1/GetNodeDetail
post
/api/extension/services/TreeService/v1/GetTree
post
/api/extension/services/TreeService/v1/GetDownlineIds
post
/api/extension/services/TreeService/v1/GetBottomOfLeg
post
/api/extension/services/TreeService/v1/InDownline
post
/api/extension/services/TreeService/v1/GetLegCount
post
/api/extension/services/TreeService/v1/GetLevel
post
UserService
/api/extension/services/UserService/v1/ChangeStatus
post
/api/extension/services/UserService/v1/ChangeUsername
post
/api/extension/services/UserService/v1/GetUser
post
/api/extension/services/UserService/v1/GetUsername
post
/api/extension/services/UserService/v1/HasRight
post
/api/extension/services/UserService/v1/RegisterUser
post
/api/extension/services/UserService/v1/ResetPassword
post
/api/extension/services/UserService/v1/CheckPasswordRequirements
post
/api/extension/services/UserService/v1/ValidateUsername
post
WebsiteService
/api/extension/services/WebsiteService/v1/GetWebSites
post
/api/extension/services/WebsiteService/v1/CreateWebsite
post
/api/extension/services/WebsiteService/v1/GetPreferenceValue
post
/api/extension/services/WebsiteService/v1/UpdatePreferenceValue
post
/api/extension/services/WebsiteService/v1/ValidateURL
post
Extension Hooks
About The Extension Hook APIs
AchHooksCallback
/api/extension/hooks/Merchants.MoneyOut.Ach.AchUS
post
/api/extension/hooks/Merchants.MoneyOut.Ach.AchJP
post
/api/extension/hooks/Merchants.MoneyOut.Ach.AchTW
post
AssociatesHooksCallback
/api/extension/hooks/Associates.GetAssociateServiceAutoshipSettings
post
/api/extension/hooks/Associates.OnNotificationEvent
post
/api/extension/hooks/Associates.UpdateAssociate
post
/api/extension/hooks/Associates.GetAssociateTreeLabel
post
/api/extension/hooks/Associates.GetCommissionChecks
post
/api/extension/hooks/Associates.GetCommissionCheckDetails
post
/api/extension/hooks/Associates.GetAssociatesStats
post
/api/extension/hooks/Associates.UpdateVolume
post
AutoshipHooksCallback
/api/extension/hooks/Autoships.ApplyAutoshipCouponCodes
post
/api/extension/hooks/Autoships.GetAutoships
post
/api/extension/hooks/Autoships.GetAutoshipBackupPayment
post
/api/extension/hooks/Autoships.CancelAutoship
post
/api/extension/hooks/Autoships.ShouldRetryAutoshipOrder
post
/api/extension/hooks/Autoships.CreateAutoship
post
/api/extension/hooks/Autoships.UpdateAutoship
post
/api/extension/hooks/Autoships.ShouldChargeAutoship
post
/api/extension/hooks/Autoships.GetAutoshipChargeRules
post
/api/extension/hooks/Autoships.GetAutoshipOrderRetryRules
post
/api/extension/hooks/Autoships.DailyRun
post
CommissionHooksCallback
/api/extension/hooks/Commissions.GetSplitPayments
post
/api/extension/hooks/Commissions.GetCommissionBonusDetailsAfter
post
/api/extension/hooks/Commissions.GetCommissionBonusDetails
post
/api/extension/hooks/Commissions.GetCommissionDetails
post
/api/extension/hooks/Commissions.GetBonusDetailData
post
/api/extension/hooks/Commissions.GetMatchRuleForVisualTree
post
/api/extension/hooks/Commissions.CanViewDownlineNode
post
/api/extension/hooks/Commissions.CanPlaceAssociate
post
/api/extension/hooks/Commissions.GetPlaceToAssociates
post
/api/extension/hooks/Commissions.GetPlacementExpirationDates
post
/api/extension/hooks/Commissions.LogRealtimeRankAdvance
post
EmailTemplatesHooksCallback
/api/extension/hooks/EmailHooks.GetTemplateWelcomeCustomer
post
/api/extension/hooks/EmailHooks.GetTemplateWelcomeDistributor
post
/api/extension/hooks/EmailHooks.GetTemplateAutoshipFailed
post
/api/extension/hooks/EmailHooks.GetTemplateOrderReceipt
post
/api/extension/hooks/EmailHooks.GetTemplateOrderFailed
post
/api/extension/hooks/EmailHooks.GetTemplateSubscriptionAboutToExpire
post
/api/extension/hooks/EmailHooks.GetTemplateSubscriptionExpire
post
EmvioHooksCallback
/api/extension/hooks/Merchants.MoneyIn.Emvio.ModifyTransaction
post
EnrollmentHooksCallback
/api/extension/hooks/Associates.Enrollment.GetNewBackOfficeId
post
/api/extension/hooks/Associates.Enrollment.WriteApplication
post
/api/extension/hooks/Associates.Enrollment.ValidateApplication
post
/api/extension/hooks/Associates.Enrollment.IsEmailAvailable
post
/api/extension/hooks/Associates.Enrollment.IsTaxIdAvailable
post
/api/extension/hooks/Associates.Enrollment.UpdateAssociateBaseType
post
/api/extension/hooks/Associates.Enrollment.GetShouldSendNotification
post
FraudPreventionHooksCallback
/api/extension/hooks/FraudPrevention.GetOrderPaymentToReview
post
/api/extension/hooks/FraudPrevention.GetPreCheck
post
/api/extension/hooks/FraudPrevention.ParseCallbackData
post
/api/extension/hooks/FraudPrevention.GetFraudPreventionInfo
post
HyperwalletHooksCallback
/api/extension/hooks/Merchants.MoneyIn.Hyperwallet.GetProgramToken
post
InventoryHooksCallback
/api/extension/hooks/Inventory.Receive
post
KountHooksCallback
/api/extension/hooks/Merchants.Fraud.Kount.GetUserDefinedFields
post
MoneyInHooksCallback
/api/extension/hooks/Merchants.MoneyIn.DeletePaymentMethod
post
MoneyOutHooksCallback
/api/extension/hooks/Merchants.MoneyOut.SaveAdjustments
post
OrdersHooksCallback
/api/extension/hooks/Orders.FinalizeAcceptedOrder
post
/api/extension/hooks/Orders.FinalizeNonAcceptedOrder
post
/api/extension/hooks/Orders.FullRefundOrder
post
/api/extension/hooks/Orders.RefundPayment
post
/api/extension/hooks/Orders.AdjustNewOrderPayments
post
/api/extension/hooks/Orders.SubmitOrder
post
/api/extension/hooks/Orders.IsMoveOrderPermitted
post
/api/extension/hooks/Orders.ImportOrder
post
/api/extension/hooks/Orders.ProcessOrderPayment
post
/api/extension/hooks/Orders.CancelOrder
post
/api/extension/hooks/Orders.ProcessCouponCodes
post
/api/extension/hooks/Orders.GetCouponAdjustedVolume
post
PackagesHooksCallback
/api/extension/hooks/Orders.Packages.MarkPackagesShipped
post
PartyHooksCallback
/api/extension/hooks/Orders.Party.PayHostRewards
post
RmaHooksCallback
/api/extension/hooks/Orders.CreateRma
post
ShippingHooksCallback
/api/extension/hooks/Orders.Shipping.GetShipping
post
TaxHooksCallback
/api/extension/hooks/Taxes.GetTax
post
/api/extension/hooks/Taxes.CommitTax
post
Extension Page API
Validate Token
post
C# Middleware API
Getting Started With The C# Middleware API
Get Extension Version
get
Get Routes
get
Remove Deleted Registrations
post
Update All Registrations
post
Registrations
get
Powered by
Getting Started with the Extension API
Ask AI
