Jump to Content
Guides
API Reference
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Guides
API Reference
/api/v1/Orders
Search
All
Pages
Start typing to search…
JUMP TO
OverView
Authenticating to the REST API
Single Sign-On
Commission Service
Bonuses
/api/v1/Bonuses/Unreleased
get
/api/v1/Bonuses/Release
put
/api/v1/Bonuses/Released
get
/api/v1/CompensationPlans/{compensationPlanId}/Periods/{periodId}/Bonuses
get
/api/v1/CompensationPlans/{compensationPlanId}/Periods/{periodId}/Bonuses/Details
get
/api/v1/Snapshot/{snapshotId}/Bonuses
get
/api/v1/Bonuses
get
/api/v1/Bonuses/Details
get
/api/v1/Bonuses/Titles
get
CompensationPlans
/api/v1/CompensationPlans
get
/api/v1/CompensationPlans/{compensationPlanId}
get
HistoricalBonuses
/api/v1/CompensationPlans/{compensationPlanId}/Periods/{periodId}/HistoricalBonuses
get
/api/v1/Snapshot/{snapshotId}/HistoricalBonuses
get
/api/v1/HistoricalBonuses
post
/api/v1/HistoricalBonuses/{id}
get
/api/v1/HistoricalBonuses/{id}
delete
HistoricalValues
/api/v1/CompensationPlans/{compensationPlanId}/Periods/{periodId}/HistoricalValues
get
/api/v1/Snapshot/{snapshotId}/HistoricalValues
get
/api/v1/HistoricalValues
post
/api/v1/HistoricalValues/{id}
get
/api/v1/HistoricalValues/{id}
delete
ManualBonuses
/api/v1/Bonuses/Manual
get
/api/v1/Bonuses/Manual
post
/api/v1/Bonuses/Manual/{id}
get
/api/v1/Bonuses/Manual/{id}
delete
Nodes
/api/v1/Trees/{treeId}/Nodes
get
/api/v1/Trees/{treeId}/Nodes/{nodeId}
get
/api/v1/Trees/{treeId}/Nodes/{nodeId}
put
/api/v1/Trees/{treeId}/Nodes/{nodeId}/downline
get
/api/v1/Trees/{treeId}/Nodes/{nodeId}/upline
get
NodeSettings
/api/v1/NodeSettings
get
/api/v1/NodeSettings/{nodeId}
get
/api/v1/NodeSettings/{nodeId}
put
Periods
/api/v1/CompensationPlans/{compensationPlanId}/Periods
get
/api/v1/CompensationPlans/{compensationPlanId}/Periods/{periodId}
get
Placements
/api/v1/Placements
get
/api/v1/Placements
post
/api/v1/Placements/{placementId}
get
/api/v1/Placements/{placementId}
delete
RankAdvance
/api/v1/CompensationPlans/{compensationPlanId}/Periods/{periodId}/RankAdvance
get
/api/v1/Snapshot/{snapshotId}/RankAdvance
get
Snapshots
/api/v1/Snapshots
get
/api/v1/Snapshots
post
/api/v1/Snapshots/{snapshotId}
get
/api/v1/Snapshots/{snapshotId}
delete
SourceGroups
/api/v1/SourceGroups
get
/api/v1/SourceGroups/{sourceGroupId}
put
/api/v1/SourceGroups/{sourceGroupId}
get
/api/v1/SourceGroups/{sourceGroupId}
delete
Sources
/api/v1/Sources
get
/api/v1/Sources
post
/api/v1/Sources/{sourceId}
get
/api/v1/Sources/{sourceId}
delete
Trees
/api/v1/Trees
get
/api/v1/Trees
post
/api/v1/Trees/{treeId}
get
/api/v1/Trees/{treeId}
put
/api/v1/Trees/{treeId}
patch
/api/v1/Trees/{treeId}
delete
Values
/api/v1/CompensationPlans/{compensationPlanId}/Periods/{periodId}/Values
get
/api/v1/CompensationPlans/{compensationPlanId}/Periods/{periodId}/Values/Details
get
/api/v1/Snapshot/{snapshotId}/Values
get
Customer Service
Appointments
/api/v1/Appointments
get
/api/v1/Appointments
post
/api/v1/Appointments/{appointmentId}
get
/api/v1/Appointments/{appointmentId}
put
/api/v1/Appointments/{appointmentId}
delete
Batches
/api/v1/Batches
get
/api/v1/Batches
post
/api/v1/Batches/{id}
put
/api/v1/Batches/{id}
get
/api/v1/Batches/{id}/Nacha
get
/api/v1/Batches/Settings
get
/api/v1/Batches/Settings
put
/api/v1/Batches/{id}/process
post
Customers
/api/v1/Customers/Find
get
/api/v1/Customers
get
/api/v1/Customers
post
/api/v1/Customers/{id}
patch
/api/v1/Customers/{id}
get
/api/v1/Customers/{id}
put
/api/v1/Customers/{id}
delete
Documents
/api/v1/Documents/Find
get
/api/v1/Documents
get
/api/v1/Documents
put
/api/v1/Documents/{documentId}
get
/api/v1/Documents/{documentId}
delete
/api/v1/Documents/tags
get
Statuses
/api/v1/Statuses
get
/api/v1/Statuses
post
/api/v1/Statuses/{statusId}
get
/api/v1/Statuses/{statusId}
put
/api/v1/Statuses/{statusId}
delete
Recent
/api/v1/Recent
get
/api/v1/Recent
post
/api/v1/Recent/{customerId}
delete
Web Hook Service
Getting Started with Webhooks
Topics
WebHooks
/api/v1/WebHooks
get
/api/v1/WebHooks
post
/api/v1/WebHooks/{subscriptionId}
get
/api/v1/WebHooks/{subscriptionId}
delete
Access Control Service
Introduction to Access Control
Managing User Tokens
Managing Access Tokens
Generating an Access Token
Keeping your Access Tokens secure
Authentication
/Authentication/token/{token}
get
/Authentication/token/{token}/Environments
get
/Authentication/refresh/{token}
get
/Authentication
get
/Authentication/UserToken
get
/Authentication/ResetPassword
post
/Authentication/ResetPassword
put
Roles
/api/v1/Roles
get
/api/v1/Roles
post
/api/v1/Roles/{id}
get
/api/v1/Roles/{id}
put
/api/v1/Roles/{id}
delete
Users
/api/v1/Users/Find
get
/api/v1/Users
get
/api/v1/Users
post
/api/v1/Users/{id}
get
/api/v1/Users/{id}
put
/api/v1/Users/{id}
delete
Inventory Service
Categories
/api/v1/Categories
get
/api/v1/Categories
post
/api/v1/Categories/{categoryId}
get
/api/v1/Categories/{categoryId}
put
/api/v1/Categories/{categoryId}
delete
Countries
/api/v1/Countries
get
/api/v1/Countries/{countryId}
get
/api/v1/Countries/{countryId}
put
Currencies
/api/v1/Currencies
get
/api/v1/Currencies/{currencyId}
get
/api/v1/Currencies/{currencyId}
put
Images
/api/v1/Products/{productId}/Images
get
/api/v1/Products/{productId}/Images
post
/api/v1/Products/{productId}/Images/{imageId}
get
/api/v1/Products/{productId}/Images/{imageId}
put
/api/v1/Products/{productId}/Images/{imageId}
delete
Languages
/api/v1/Languages
get
/api/v1/Languages/{languageCode}
get
Prices
/api/v1/Products/Prices/Find
get
/api/v1/Products/{productId}/Prices
get
/api/v1/Products/{productId}/Prices
post
/api/v1/Products/{productId}/Prices/{priceId}
get
/api/v1/Products/{productId}/Prices/{priceId}
put
/api/v1/Products/{productId}/Prices/{priceId}
delete
Products
/api/v1/Products/Find
get
/api/v1/Products
get
/api/v1/Products
post
/api/v1/Products/{productId}
get
/api/v1/Products/{productId}
put
/api/v1/Products/{productId}
delete
Regions
/api/v1/Regions
get
/api/v1/Regions
post
/api/v1/Regions/{regionId}
get
/api/v1/Regions/{regionId}
put
/api/v1/Regions/{regionId}
delete
States
/api/v1/Countries/{countryCode}/States
get
/api/v1/Countries/{countryCode}/States/{stateCode}
get
Stores
/api/v1/Stores
get
/api/v1/Stores
post
/api/v1/Stores/{storeId}
get
/api/v1/Stores/{storeId}
put
/api/v1/Stores/{storeId}
delete
Order Service
Orders
/api/v1/Orders/Find
get
/api/v1/Orders
get
/api/v1/Orders
post
/api/v1/Orders/{id}
patch
/api/v1/Orders/{id}
get
/api/v1/Orders/{id}
put
/api/v1/Orders/{id}
delete
PaymentMethods
/api/v1/PaymentMethods
get
/api/v1/PaymentMethods
post
/api/v1/PaymentMethods/{paymentMethodId}
get
/api/v1/PaymentMethods/{paymentMethodId}
put
/api/v1/PaymentMethods/{paymentMethodId}
delete
TaxClasses
/api/v1/TaxClasses
get
/api/v1/TaxClasses
post
/api/v1/TaxClasses/{taxClassId}
get
/api/v1/TaxClasses/{taxClassId}
put
/api/v1/TaxClasses/{taxClassId}
delete
Autoship Service
Autoships
/api/v1/Customers/{customerId}/Autoships
get
/api/v1/Customers/{customerId}/Autoships
post
/api/v1/Customers/{customerId}/Autoships/{autoshipId}
get
/api/v1/Customers/{customerId}/Autoships/{autoshipId}
put
/api/v1/Customers/{customerId}/Autoships/{autoshipId}
patch
/api/v1/Customers/{customerId}/Autoships/{autoshipId}
delete
Powered by
/api/v1/Orders
get
https://api.pillarshub.com/api/v1/Orders
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!