OneTouchPoint Suite of Brokers APIs (Internal Documentation)

This documentation provides an overview of OneTouchPoint's Suite of Brokers APIs for internal team reference. These APIs are crucial for our system integrations and brokerage operations.

CAUTION: Please note the following schema changes are in-flight and will change in a future version. Contact the OneTouchPoint development team for any questions regarding timing.

Schema Object Documentation

REST API

CustomerBroker

• CreateCustomerParameters

• CreateCustomerRequest

• CreateCustomerResponse

• GetBillingEntitiesParameters

• GetBillingEntitiesResponse

• GetBillingEntityDetailsParameters

• GetBillingEntityDetailsResponse

• GetCustomerIdParameters

• GetCustomerIdResponse

• GetCustomerParameters

• GetCustomerResponse

• GetCustomersParameters

• GetCustomersResponse

• UpdateCustomerParameters

• UpdateCustomerRequest

• UpdateCustomerResponse

IdentityBroker

• GetClientSecretParameters

• GetClientSecretResponse

• GetCustomerTokenParameters

• GetCustomerTokenRequest

• GetCustomerTokenResponse

• GetTokenParameters

• GetTokenRequest

• GetTokenResponse

OfferBroker

• CreateCategoryParameters

• CreateCategoryRequest

• CreateCategoryResponse

• CreateOfferParameters

• CreateOfferRequest

• CreateOfferResponse

• DeleteCategoryParameters

• DeleteCategoryRequest

• DeleteCategoryResponse

• DeleteOfferParameters

• DeleteOfferRequest

• DeleteOfferResponse

• GetFileParameters

• GetFileResponse

• GetOfferCategoriesParameters

• GetOfferCategoriesResponse

• GetOfferInventoryParameters

• GetOfferInventoryResponse

• GetOfferParameters

• GetOfferResponse

• GetOffersParameters

• GetOffersResponse

• InternalGetOffersParameters

• InternalGetOffersResponse

• UpdateCategoryParameters

• UpdateCategoryRequest

• UpdateCategoryResponse

• UpdateOfferParameters

• UpdateOfferRequest

• UpdateOfferResponse

OrderBroker

• GetOrderParameters

• GetOrderResponse

• InternalGetOrderParameters

• InternalGetOrderResponse

• InternalNewOrderParameters

• InternalNewOrderRequest

• InternalUpdateOrderRequest

• InternalUpdateOrderResponse

• NewOrderParameters

• NewOrderRequest

• UpdateFulfillmentOrderParameters

• UpdateFulfillmentOrderRequest

• UpdateFulfillmentOrderResponse

• UpdateOrderRequest

• UpdateOrderResponse

ProductBroker

• GetAllProductsParameters

• GetAllProductsResponse

• GetProductInventoryParameters

• GetProductInventoryResponse

• GetProductsInventoryParameters

• GetProductsInventoryResponse

ShippingBroker

• GetShippingratesParameters

• GetShippingratesRequest

• GetShippingratesResponse

Events

Customer

• Customer

• CustomerEvent

FulfillmentOrder

• FulfillmentOrder

• FulfillmentOrderEvent

Offer

• Offer

• OfferEvent

OfferCategory

• OfferCategory

• OfferCategoryEvent

Order

• Order

• OrderEvent

OrderView

• OrderView

• OrderViewEvent

C# Downloads

• downloads

API Outstanding Issues

Swagger API

Provides services for external services to interact with OneTouchPoint Suite of Brokers print service.

Authentication

All API calls require authentication using JWT Bearer tokens. Tokens can be obtained through the IdentityBroker endpoint.

Error Handling

The API uses conventional HTTP response codes to indicate success or failure.

• 2xx: Success
• 4xx: Client errors

Error responses include a consistent error payload with details about the problem.

• REST API