Marketplace & Distribution Endpoints

Vendor Integrations: Marketplace & Distribution

This section covers HaloPSA integrations with third-party distribution and marketplace vendors including Pax8, Ingram Micro, Synnex, Arrow Sphere, StreamOne Ion, Tech Data, Datto Commerce, Adobe Commerce, Microsoft CSP, Amazon Seller, Shopify, and e-commerce order management.

---

Pax8Details

Manage Pax8 marketplace integration credentials and configuration.

GET /Pax8Details

List all Pax8 integration configurations. Requires authentication.

POST /Pax8Details

Create or update Pax8 integration configurations.

Request body: Array of Pax8Details

Pax8Details schema:

Property	Type	Description
id	integer	Record ID
guid	string (uuid)	Integration GUID
url	string	Pax8 API URL
new_client_secret	string	Client secret (write-only)
tenant	string	Tenant identifier
new_access_token	string	Access token (write-only)
new_refresh_token	string	Refresh token (write-only)
_exchangecode	boolean	Trigger OAuth code exchange
new_method	boolean	Use new auth method
auth_type	integer	Authentication type
environment	integer	Environment (sandbox/production)
import_inactive_and_deleted	boolean	Import inactive/deleted records
import_usage_lines	boolean	Import usage lines
allow_subscription_changes	boolean	Allow subscription changes via portal
import_entities	string	Comma-separated entity types to import
import_entities_list	array	Entity import list (KeyPair2 objects)
top_level	integer	Top-level client ID
top_level_name	string	Top-level client name
update_addresses	boolean	Sync addresses from Pax8
integrator_enabled	boolean	HaloIntegrator sync enabled
integrator_last_sync	string (date-time)	Last sync timestamp
integrator_last_sync_error	string	Last sync error message
client_mappings	array	Client mapping list (ExternalLink_List)
code	string	OAuth authorization code
code_verifier	string	OAuth PKCE code verifier
default_item_group	integer	Default item group ID
default_item_group_name	string	Default item group name
import_products	integer	Product import setting
deactivate_missing_licenses	boolean	Deactivate licenses not found in Pax8
_warning	string	Warning message

GET /Pax8Details/{id}

Get a single Pax8 integration by ID.

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

DELETE /Pax8Details/{id}

Delete a Pax8 integration configuration.

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

---

IngramMicroDetails

Manage Ingram Micro distribution integration credentials and configuration.

GET /IngramMicroDetails

List all Ingram Micro integration configurations. Requires authentication.

POST /IngramMicroDetails

Create or update Ingram Micro integration configurations.

Request body: Array of IngramMicroDetails

IngramMicroDetails schema:

Property	Type	Description
id	integer	Record ID
name	string	Integration name
new_method	boolean	Use new auth method
import_entities	string	Comma-separated entity types to import
toplevel	integer	Top-level client ID
update_addresses	boolean	Sync addresses
marketplace	string	Marketplace identifier
username	string	API username
guid	string (uuid)	Integration GUID
new_password	string	API password (write-only)
new_subscription_key	string	Subscription key (write-only)
new_access_token	string	Access token (write-only)
client_mappings	array	Client mapping list (ExternalLink_List)
top_level_name	string	Top-level client name
halointegrator	boolean	HaloIntegrator sync enabled
halointegrator_lastsync	string (date-time)	Last sync timestamp
halointegrator_lasterror	string	Last sync error message
deactivate_missing_licenses	boolean	Deactivate missing licenses
import_entities_list	array	Entity import list (KeyPair2 objects)
_warning	string	Warning message

GET /IngramMicroDetails/{id}

Get a single Ingram Micro integration. Returns a single instance of IngramMicroDetails. Requires authentication.

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

DELETE /IngramMicroDetails/{id}

Delete an Ingram Micro integration configuration.

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

---

IngramMicroReseller

Read-only endpoints for Ingram Micro reseller data retrieval.

GET /IngramMicroReseller/Get

Retrieve Ingram Micro reseller information.

GET /IngramMicroReseller/GetQuote

Retrieve a quote from Ingram Micro.

---

IngramMicroResellerDetails

Manage Ingram Micro reseller integration configuration with full order status mapping and webhook support.

GET /IngramMicroResellerDetails

List all Ingram Micro reseller configurations.

POST /IngramMicroResellerDetails

Create or update Ingram Micro reseller configurations.

Request body: Array of IngramMicroResellerDetails

IngramMicroResellerDetails schema:

Property	Type	Description
id	integer	Record ID
name	string	Integration name
new_method	boolean	Use new auth method
client_id	string	OAuth client ID
customer_number	string	Ingram customer number
country_code	string	Country code
correlation_id	string	Correlation ID for API requests
company_id	integer	Company ID
receive_order_status_updated	boolean	Receive order status update webhooks
receive_quote_to_order	boolean	Receive quote-to-order webhooks
auto_create_purchase_order	boolean	Auto-create purchase orders
sync_entities	string	Entities to sync
sync_entities_list	array	Sync entity list (KeyPair2 objects)
api_app_type	integer	API application type
reseller_site	integer	Reseller site ID
bill_to_address_id	string	Bill-to address ID
delivery_address_auto_po	integer	Delivery address for auto PO
order_status_canceled	integer	HaloPSA status for Canceled orders
order_status_backordered	integer	HaloPSA status for Backordered orders
order_status_invoiced	integer	HaloPSA status for Invoiced orders
order_status_processing	integer	HaloPSA status for Processing orders
order_status_hold	integer	HaloPSA status for Hold orders
order_status_delivered	integer	HaloPSA status for Delivered orders
order_status_shipped	integer	HaloPSA status for Shipped orders
order_status_ordered	integer	HaloPSA status for Ordered orders
new_client_secret	string	Client secret (write-only)
new_access_token	string	Access token (write-only)
new_webhook_signature	string	Webhook signature key (write-only)
guid	string (uuid)	Integration GUID
default_assetgroup_id	integer	Default asset group ID
default_assetgroup_name	string	Default asset group name
_warning	string	Warning message

GET /IngramMicroResellerDetails/{id}

Get a single Ingram Micro reseller configuration by ID.

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

DELETE /IngramMicroResellerDetails/{id}

Delete an Ingram Micro reseller configuration.

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

---

SynnexDetails

Manage TD Synnex distribution integration credentials and configuration.

GET /SynnexDetails

List all Synnex integration configurations.

POST /SynnexDetails

Create or update Synnex integration configurations.

Request body: Array of SynnexDetails

SynnexDetails schema:

Property	Type	Description
id	integer	Record ID
name	string	Integration name
new_method	boolean	Use new auth method
client_id	string	OAuth client ID
new_client_secret	string	Client secret (write-only)
new_access_token	string	Access token (write-only)
guid	string (uuid)	Integration GUID
client_mappings	array	Client mapping list (ExternalLink_List)
import_entities	string	Comma-separated entity types to import
toplevel	integer	Top-level client ID
top_level_name	string	Top-level client name
update_addresses	boolean	Sync addresses
application_region	integer	API application region
application_type	integer	API application type
halointegrator	boolean	HaloIntegrator sync enabled
halointegrator_lastsync	string (date-time)	Last sync timestamp
halointegrator_lasterror	string	Last sync error message
import_entities_list	array	Entity import list (KeyPair2 objects)
_warning	string	Warning message

GET /SynnexDetails/{id}

Get a single Synnex integration. Requires authentication.

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

DELETE /SynnexDetails/{id}

Delete a Synnex integration configuration.

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

---

ArrowSphereDetails

Manage Arrow Sphere cloud marketplace integration.

GET /ArrowSphereDetails

List all Arrow Sphere integration configurations.

POST /ArrowSphereDetails

Create or update Arrow Sphere integration configurations.

Request body: Array of ArrowSphereDetails

ArrowSphereDetails schema:

Property	Type	Description
id	integer	Record ID
name	string	Integration name
url	string	Arrow Sphere API URL
new_api_key	string	API key (write-only)
top_level	integer	Top-level client ID
top_level_name	string	Top-level client name
update_addresses	boolean	Sync addresses
guid	string (uuid)	Integration GUID
import_entities	string	Comma-separated entity types to import
import_entities_list	array	Entity import list (KeyPair2 objects)
halo_integrator	boolean	HaloIntegrator sync enabled
halo_integrator_last_sync	string (date-time)	Last sync timestamp
halo_integrator_error	string	Last sync error message
client_mappings	array	Client mapping list (ExternalLink_List)
_warning	string	Warning message

GET /ArrowSphereDetails/{id}

Get a single Arrow Sphere integration by ID.

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

DELETE /ArrowSphereDetails/{id}

Delete an Arrow Sphere integration configuration.

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

---

StreamOneIonDetails

Manage TD Synnex StreamOne Ion cloud marketplace integration.

GET /StreamOneIonDetails

List all StreamOne Ion integration configurations.

POST /StreamOneIonDetails

Create or update StreamOne Ion integration configurations.

Request body: Array of StreamOneIonDetails

StreamOneIonDetails schema:

Property	Type	Description
id	integer	Record ID
name	string	Integration name
account_id	string	StreamOne account ID
new_method	boolean	Use new auth method
guid	string (uuid)	Integration GUID
import_entities	string	Comma-separated entity types to import
top_level	integer	Top-level client ID
update_addresses	boolean	Sync addresses
halointegrator	boolean	HaloIntegrator sync enabled
halointegrator_lastsync	string (date-time)	Last sync timestamp
halointegrator_lasterror	string	Last sync error message
new_refresh_token	string	Refresh token (write-only)
new_access_token	string	Access token (write-only)
client_mappings	array	Client mapping list (ExternalLink_List)
top_level_name	string	Top-level client name
import_entities_list	array	Entity import list (KeyPair2 objects)
_warning	string	Warning message

GET /StreamOneIonDetails/{id}

Get a single StreamOne Ion integration by ID.

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

DELETE /StreamOneIonDetails/{id}

Delete a StreamOne Ion integration configuration.

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

---

TechDataResellerDetails

Manage TD Synnex (Tech Data) reseller integration.

GET /TechDataResellerDetails

List all Tech Data reseller configurations.

POST /TechDataResellerDetails

Create or update Tech Data reseller configurations.

Request body: Array of TechDataResellerDetails

TechDataResellerDetails schema:

Property	Type	Description
id	integer	Record ID
name	string	Integration name
new_method	boolean	Use new auth method
client_id	string	OAuth client ID
type	integer	Integration type
region	string	API region
api_to_use	integer	Which API version to use
customer_number	string	Tech Data customer number
application_type	integer	Application type
new_client_secret	string	Client secret (write-only)
guid	string (uuid)	Integration GUID
_warning	string	Warning message

GET /TechDataResellerDetails/{id}

Get a single Tech Data reseller configuration by ID.

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

DELETE /TechDataResellerDetails/{id}

Delete a Tech Data reseller configuration.

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

---

DattoCommerceDetails

Manage Datto Commerce integration for quote and purchase order workflows.

GET /DattoCommerceDetails

List all Datto Commerce integration configurations. Requires authentication.

Parameter	Type	Required	Description
includedetails	boolean	No (query)	Include additional detail objects

POST /DattoCommerceDetails

Create or update Datto Commerce integration configurations.

Request body: Array of DattoCommerceDetails

DattoCommerceDetails schema:

Property	Type	Description
id	integer	Record ID
url	string	Datto Commerce API URL
new_api_key	string	API key (write-only)
halointegratorenabled	boolean	HaloIntegrator sync enabled
halointegrator_lastsync	string (date-time)	Last sync timestamp
halointegrator_lasterror	string	Last sync error message
item_group	integer	Default item group ID
item_group_name	string	Default item group name
customer_field_mappings	array	Customer field mappings (IntegrationFieldMapping)
item_group_mappings	array	Item group mappings (ExternalLink_List)
quote_status_mappings	array	Quote status mappings (IntegrationFieldMapping)
create_items_on_import	boolean	Auto-create items on import
product_supplier_on_import	boolean	Set product supplier on import
sostatustoimport	string	Sales order status filter for import
sostatustoimport_list	array	Available SO status options (KeyPair2)
halo_integrator_import_list	string	Import list configuration
halo_integrator_import_types	array	Import type options (KeyPair2)
_warning	string	Warning message