Provision Detail

A ProvisionDetail contains information a user entered at checkout. Pax8 can dynamically add extra provisioning detail data points to requests to enhance the ordering experience whenever necessary. This data may change if a user or system discovers the data is incorrect. As a result, a ProvisionRequest may have 1-to-Many ProvisionDetail. Each ProvisionDetail is immutable and represents the user's information at a moment in time. Pax8 creates a new ProvisionDetail during checkout and any time a user fixes errors in their checkout information.

Endpoints

GET /provision-requests/{provisionRequestId}/details
GET /provision-requests/{provisionRequestId}/details/{detailId}
GET /provision-requests/{provisionRequestId}/details/latest

External Identifiers

If you've previously saved an External Identifier in Pax8 at the Partner, PartnerEnrollment, Company, or Subscription level, these will appear in the details 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"
    }
}

More details on what External Identifiers are and how to use them can be found here

The Provision Detail Object

{
    "id": "5c425efa-60be-4bac-98b4-d3dff9099143",
    "provisionRequestId": "50f31e66-9a01-43a8-b0f8-14c288bac5da",
    "details": {
        "key": "value"
    },
    "createdDate": "2022-10-03T10:15:30Z"
}

Get All Provision Details for a Provision Request

Retrieves a list of all ProvisionDetail objects for a ProvisionRequest

GET /provision-requests/{provisionRequestId}/details

{
    "page": {
        "size": 10,
        "totalElements": 10,
        "totalPages": 10,
        "number": 1
    },
    "content": [
        {
            "id": "5c425efa-60be-4bac-98b4-d3dff9099143",
            "provisionRequestId": "50f31e66-9a01-43a8-b0f8-14c288bac5da",
            "details": {
                "key": "value" // customizable key/values for each product
            },
            "createdDate": "2022-10-03T10:15:30Z"
        }
    ]
}

Get One Detail for an Provision Request

Retrieves one ProvisionDetail for a ProvisionRequest

GET /provision-requests/{provisionRequestId}/details/{detailId}

{
    "id": "5c425efa-60be-4bac-98b4-d3dff9099143",
    "provisionRequestId": "50f31e66-9a01-43a8-b0f8-14c288bac5da",
    "details": {
        "key": "value"
    },
    "createdDate": "2022-10-03T10:15:30Z"
}

Get Latest Detail for an Order

Retrieves the most recent ProvisionDetail for a ProvisionRequest

GET /provision-requests/{provisionRequestId}/details/latest

{
    "id": "5c425efa-60be-4bac-98b4-d3dff9099143",
    "provisionRequestId": "50f31e66-9a01-43a8-b0f8-14c288bac5da",
    "details": {
        "key": "value"
    },
    "createdDate": "2022-10-03T10:15:30Z"
}