Marketplace & Distribution Endpoints (cont.)

DattoCommerceDetails (continued)

GET /DattoCommerceDetails/{id}

Get a single Datto Commerce integration. Returns a single instance of DattoCommerceDetails. Requires authentication.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID
includedetails	boolean	No (query)	Include additional detail objects

DELETE /DattoCommerceDetails/{id}

Delete a Datto Commerce integration configuration.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

---

AdobeCommerceDetails

Manage Adobe Commerce (Magento) integration credentials and configuration.

GET /AdobeCommerceDetails

List all Adobe Commerce integration configurations.

POST /AdobeCommerceDetails

Create or update Adobe Commerce integration configurations.

Request body: Array of AdobeCommerceDetails

AdobeCommerceDetails schema (key fields):

Property	Type	Description
id	integer	Record ID
connectionname	string	Connection name
url	string	Adobe Commerce store URL
new_integration_method	boolean	Use new auth method
enabled	boolean	Integration enabled
integrator_last_sync	string (date-time)	Last sync timestamp
_warning	string	Warning message

GET /AdobeCommerceDetails/{id}

Get a single Adobe Commerce integration by ID.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

DELETE /AdobeCommerceDetails/{id}

Delete an Adobe Commerce integration configuration.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

---

AdobeCommerceIntegration

OAuth authorization flow for Adobe Commerce.

GET /AdobeCommerceIntegration

Get Adobe Commerce integration status.

POST /AdobeCommerceIntegration/auth

Authenticate with Adobe Commerce via OAuth. Accepts form data key-value pairs for the OAuth handshake.

Request body: multipart/form-data with obj field (array of StringStringValuesKeyValuePair)

---

CSPConsumptionData

Manage Microsoft CSP consumption/usage data records. Used for reconciliation billing.

GET /CSPConsumptionData

List all CSP consumption data records.

POST /CSPConsumptionData

Create or import CSP consumption data records.

Request body: Array of CSPConsumptionData

CSPConsumptionData schema (key fields):

Property	Type	Description
id	integer	Record ID
parentid	integer	Parent record ID
type	integer	Record type
partnerid / partnername	string	Partner ID and name
customerid / customername	string	Customer ID and name
customerdomainname	string	Customer domain
invoicenumber	string	Invoice number
skuid / skuname	string	SKU identifier and name
productname	string	Product name
subscriptionid	string	Subscription ID
subscriptiondescription	string	Subscription description
chargestartdate / chargeenddate	string (date-time)	Charge period
usagedate	string (date-time)	Usage date
quantity	number	Usage quantity
unitprice	number	Unit price
subtotal / taxtotal / total	number	Billing amounts
billingcurrency / pricingcurrency	string	Currency codes
meterid / metername / metercategory	string	Azure meter details
entitlementid / entitlementdescription	string	Entitlement info
creditpercentage / credittype	string	Credit information
termandbillingcycle	string	Term and billing cycle
subscriptionstartdate / subscriptionenddate	string (date-time)	Subscription period
isbilled	boolean	Whether record has been billed
_isimport	boolean	Import mode flag
_warning	string	Warning message

GET /CSPConsumptionData/{id}

Get a single CSP consumption data record by ID.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

DELETE /CSPConsumptionData/{id}

Delete a CSP consumption data record.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

POST /CSPConsumptionData/manage

Bulk manage (create/update) CSP consumption data records.

Request body: Array of CSPConsumptionData

DELETE /CSPConsumptionData/Parent/{id}

Delete all CSP consumption data records belonging to a parent record.

Parameter	Type	Required	Description
id	integer	Yes (path)	Parent record ID

---

CSPInvoice

Manage Microsoft CSP invoice records.

GET /cspinvoice

List all CSP invoice records.

POST /cspinvoice

Create or import CSP invoice records.

Request body: Array of CSPInvoice

CSPInvoice schema:

Property	Type	Description
haloid	integer	HaloPSA record ID
id	string	CSP invoice ID
tenantid	integer	Tenant ID
invoicedate	string (date-time)	Invoice date
totalcharges	number	Total charges
paidamount	number	Amount paid
currencycode / currencysymbol	string	Currency
pdfdownloadlink	string	PDF download URL
taxreceipts	array	Tax receipts (CSPTaxReceipt objects)
invoicedetails	array	Invoice line items (CSPInvoiceDetail objects)
documenttype	string	Document type
invoicetype	string	Invoice type
links	object	CSP links (CSPLinks)
isbilled	boolean	Whether invoice has been billed
isfullybilled	boolean	Whether invoice is fully billed
haslines	boolean	Whether invoice has line items
client_id	integer	Associated client ID
mark_as_billed	boolean	Mark invoice as billed
update_billed_state	boolean	Update billed state
_isimport	boolean	Import mode flag
_warning	string	Warning message

GET /cspinvoice/{id}

Get a single CSP invoice by ID.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

DELETE /cspinvoice/{id}

Delete a CSP invoice record.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

---

CSPSubscriptionPricing

Manage Microsoft CSP subscription pricing data.

POST /CSPSubscriptionPricing/manage

Bulk create or update CSP subscription pricing records.

Request body: Array of CSPSubscriptionPricing

CSPSubscriptionPricing schema:

Property	Type	Description
id	integer	Record ID
marketplace	string	Marketplace identifier
producttitle / productid	string	Product name and ID
skuid / skutitle	string	SKU identifier and title
skudescription	string	SKU description
publisher	string	Publisher name
unitofmeasure	string	Unit of measure
termduration	string	Term duration
billingplan	string	Billing plan
market	string	Market
currency	string	Currency code
unitprice	number	Unit price
pricingtierrangemin / pricingtierrangemax	number	Pricing tier range
effectivestartdate / effectiveenddate	string (date-time)	Effective date range
erp_price	number	ERP price
segment	string	Segment
tags	string	Tags
_warning	string	Warning message

---

MicrosoftSubscriptionMapping

Manage Microsoft SharePoint and subscription mappings for the HaloIntegrator.

GET /MicrosoftSubscriptionMapping

List all Microsoft subscription mappings.

POST /MicrosoftSubscriptionMapping

Create or update Microsoft subscription mappings.

Request body: Array of MicrosoftSubscriptionMapping

MicrosoftSubscriptionMapping schema (key fields):

Property	Type	Description
id	integer	Record ID
halo_id / halo_name	integer/string	HaloPSA entity reference
microsoft_id / microsoft_name	string	Microsoft entity reference
site_path / site_name	string	SharePoint site path and name
azure_connection_id	integer	Azure AD connection ID
subscription_id	string	Microsoft subscription ID
subscription_expiry	string (date-time)	Subscription expiry date
subscribed	boolean	Whether subscribed
new_subscription_key	string	New subscription key (write-only)
change_token	string	SharePoint change token
type	integer	Mapping type
sharing_type	integer	Sharing type
fullname	string	Full display name
mappings_folder	array	Field mappings (IntegrationFieldMapping)
_subscriptionaction	object	Webhook subscription action
azure_connection	object	Azure AD connection details
sharepoint_list / sharepoint_graph_list	object	SharePoint list references
sharepoint_site / sharepoint_graph_site	object	SharePoint site references

GET /MicrosoftSubscriptionMapping/{id}

Get a single Microsoft subscription mapping by ID.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

DELETE /MicrosoftSubscriptionMapping/{id}

Delete a Microsoft subscription mapping.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

---

AmazonSellerDetails

Manage Amazon Seller integration for e-commerce order ingestion.

GET /AmazonSellerDetails

List all Amazon Seller integration configurations.

POST /AmazonSellerDetails

Create or update Amazon Seller integration configurations.

Request body: Array of AmazonSellerDetails

AmazonSellerDetails schema:

Property	Type	Description
id	integer	Record ID
storefrontname	string	Storefront/shop name
new_integration_method	boolean	Use new auth method
redirect_uri	string	OAuth redirect URI
new_access_token	string	Access token (write-only)
new_refresh_token	string	Refresh token (write-only)
_code	string	OAuth authorization code
_exchangecode	boolean	Trigger OAuth code exchange
authorized	boolean	Whether integration is authorized
enabled	boolean	Integration enabled
endpoint	string	Amazon API endpoint
marketplace	string	Amazon marketplace identifier
_warning	string	Warning message

GET /AmazonSellerDetails/{id}

Get a single Amazon Seller integration by ID.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

DELETE /AmazonSellerDetails/{id}

Delete an Amazon Seller integration configuration.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

---

ShopifyDetails

Manage Shopify store integration for e-commerce order ingestion.

GET /ShopifyDetails

List all Shopify integration configurations.

POST /ShopifyDetails

Create or update Shopify integration configurations.

Request body: Array of ShopifyDetails

ShopifyDetails schema:

Property	Type	Description
id	integer	Record ID
shopname	string	Shopify store name
new_integration_method	boolean	Use new auth method
new_access_token	string	Access token (write-only)
code	string	OAuth authorization code
_exchangecode	boolean	Trigger OAuth code exchange
_disconnect	boolean	Disconnect the integration
authorized	boolean	Whether integration is authorized
enabled	boolean	Integration enabled
_warning	string	Warning message

GET /ShopifyDetails/{id}

Get a single Shopify integration by ID.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

DELETE /ShopifyDetails/{id}

Delete a Shopify integration configuration.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

---

EcommerceOrder

Manage e-commerce orders imported from Amazon, Shopify, or Adobe Commerce. These orders can be linked to HaloPSA tickets.

GET /EcommerceOrder

List all e-commerce order records.

POST /EcommerceOrder

Create or update e-commerce order records.

Request body: Array of EcommerceOrder

EcommerceOrder schema:

Property	Type	Description
id	integer	Record ID
moduleid	integer	Integration module ID
thirdpartyid	string	Order ID in third-party system
thirdpartyurl	string	URL to order in third-party system
thirdpartyordernumber	string	Human-readable order number
thirdpartycustomerid	string	Customer ID in third-party system
thirdpartystatus	string	Primary order status
thirdpartystatus2	string	Secondary order status
thirdpartycreateddate	string (date-time)	Order creation date
integration_name	string	Name of the integration source
ticket_id	integer	Linked HaloPSA ticket ID
details_id	integer	Integration details record ID
shop_name	string	Shop/storefront name
_unlink_from_ticket	boolean	Unlink order from ticket
jsonobj	string	Raw JSON from third-party
_amazon_buyer_info	object	Amazon buyer info (AmazonSellerBuyerInfo)
_adobecommerce_billing_address	object	Adobe Commerce billing address
linked_tickets	array	Linked ticket records (EcommerceOrderFault)

GET /EcommerceOrder/{id}

Get a single e-commerce order by ID.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID

DELETE /EcommerceOrder/{id}

Delete an e-commerce order record.

Parameter	Type	Required	Description
id	integer	Yes (path)	Record ID