The service plan object is included in the Create and Update Service Plan endpoints and may be included in some webhooks.
About the Service Plan Object
A service plan is a predefined commitment that specifies the type of service you provide to consumers, such as express delivery, basic delivery, or additional services like installation. Service plans help you meet service level agreements (SLAs) by informing the Bringg Platform, dispatchers, and drivers of any special requirements for a specific delivery or customer service, such as requiring a signature or scheduling a specific time for service.
Through Bringg's API, you can create, update, and get service plans.
You can also configure and utilize service plans directly in the Bringg Platform:
- Set up service plans in the Bringg UI
- Automate driver tasks
- Trigger automations
- Assign carriers using the Carrier Selector
- Use delivery terms to filter carriers by service plan
Assigning a Service Plan to an Order
To ensure that the right service plan and associated automations are applied to your order, include service_plan_external_id or service_plan_id in the Create Order (Task) payload.
Ensure proper naming
Use clear and consistent names for service plans, like 'Installation' or 'Express Delivery.' Make sure the names in your API requests exactly match those you’ve created in the UI or via the Create Service Plan endpoint to avoid mismatches.
Service Plan Details
Below is a list of parameters you can send to Bringg as part of the service_plan object when sending the Create Service Plan and Update Service Plan.
Read our Data Formatting article for more details about how different parameter types, such as datetime, are formatted and used in Bringg.
| Field | Description | Validations and Notes |
|---|---|---|
namestring | Describes the service plan, like basic, standard, and premium. | Required. Max length: 255 characters. |
external_idstring | Your external system's ID for the service plan. | |
task_configuration_idint32 | Also known as order configurations. Defines operational actions included in the service plan, like installation or requiring a customer signature. | Use Bringg's API to create order configurations. |
tag_idint32 | Defines the customer-facing notifications and styling, cancellation options, and driver actions for orders associated with this service plan. |
Response and Webhook Data
Below is a list of the data returned in webhooks and responses to your API requests. The inclusion of specific parameters may depend on your use case, your API request, and the webhook fields you have subscribed to.
| Field | Description |
|---|---|
idint32 | Bringg's ID for the service plan. |
merchant_idint32 | The ID of the merchant associated with the service plan. |
created_atdatetime | The timestamp when the service plan was created, formatted as %Y-%m-%dT%H:%M:%S%z |
updated_atdatetime | The timestamp when the service plan was last updated, formatted as %Y-%m-%dT%H:%M:%S%z |