Provision Detail
A ProvisionDetail
contains information a user entered at checkout. Pax8 can dynamically add extra provisioning detail data points to enhance the ordering experience as needed.
Since this data may change if a user or system discovers incorrect information, a ProvisionRequest
may have multiple ProvisionDetail
objects. Each ProvisionDetail
is immutable and represents a snapshot of the user's information at a specific moment in time.
Pax8 creates a new ProvisionDetail
during:
- Initial checkout
- Any time a user corrects errors in their checkout information
Endpoints
List All Provision Details for a Provision Request
- Retrieves a list of all
ProvisionDetail
objects for aProvisionRequest
- GET /provision-requests/:provisionRequestId/details
Get One Detail for a Provision Request
- Retrieves one
ProvisionDetail
for aProvisionRequest
- GET /provision-requests/:provisionRequestId/details/:detailId
Get Latest Detail for an Provision Request
- Retrieves the most recent
ProvisionDetail
for aProvisionRequest
- GET /provision-requests/:provisionRequestId/details/latest
The Provision Detail Object
{
"id": "5c425efa-60be-4bac-98b4-d3dff9099143",
"provisionRequestId": "50f31e66-9a01-43a8-b0f8-14c288bac5da",
"details": {
"firstName": "John Doe",
"lastName": "Doe",
"email": "[email protected]",
"changeOfChannel": "Yes"
},
"createdDate": "2025-07-03T02:51:59.552059Z"
}
In the example above, ProvisionDetails
were configured in Pax8's system. This is information that the Partner will fill in during checkout. These are custom data points beyond the standard dataset we already provide in ProvisionRequest
.
Work with your Pax8 support person to configure these custom checkout details.
Additional Information
External Identifiers
- If you've previously saved an External Identifier in Pax8 at the
Partner
,PartnerEnrollment
,Company
, orSubscription
level, these will appear in thedetails
map like so:
{
"details": {
"externalProvisionerPartnerId": "53b97015-19e0-4fac-aa07-56188c6580c2",
"externalProvisionerPartnerEnrollmentId": "50b7c771-fdf7-4eb5-80fb-2aaf1eba640e",
"externalProvisionerCompanyId": "29cf7b7d-08e3-4dcb-a4f8-493788d1fb09",
"externalProvisionerSubscriptionId": "0148b5ee-dd60-441e-9501-5a7056cb6be7",
"key": "value"
}
}
Updated 8 days ago