How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bell Canada Service Order API

The serviceOrder API from Bell Canada — 2 operation(s) for serviceorder.

Bell Canada Service Order API is one of 9 APIs that Bell Canada publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version 4.6.0.

Requests are made against a single base URL, https://serverRoot/tmf-api/serviceOrdering/v4.

5 operations 2 paths 39 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.6.0
Server
https://serverRoot/tmf-api/serviceOrdering/v4
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

serviceOrder 5
GET
/serviceOrder
List or find ServiceOrder objects
listServiceOrder 6 params → 200400401403405409500
POST
/serviceOrder
Creates a ServiceOrder
createServiceOrder body → 201202400401403405409422
GET
/serviceOrder/{id}
Retrieves a ServiceOrder by ID
retrieveServiceOrder 4 params → 200400401403404405409500
PATCH
/serviceOrder/{id}
Updates partially a ServiceOrder
patchServiceOrder 1 param body → 200204400401403404405409
DELETE
/serviceOrder/{id}
Deletes a ServiceOrder
deleteServiceOrder 1 param → 204400401403404405409500

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are ServiceOrder_Update (13 properties), Feature (7 properties), Characteristic (7 properties), RelatedPlaceRefOrValue (6 properties). Each schema is shown below with its type and property counts.

OrderItemActionType
string
action to be performed on the product
RelatedParty
Related Party reference. A related party defines party or party role linked to a specific entity.
ServiceOrder
ConstraintRef
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
ServiceOrderMilestone
ServiceOrderMilestone represents an action or event marking a significant change or stage in processing of a service order.
FeatureRelationship
object
Configuration feature
4 properties 2 required
ServiceOrderRelationship
Linked service order to the one containing this attribute
Entity
object
Base entity schema for use in TMForum Open-APIs
3 properties
ResourceRef
ServiceSpecificationRef
Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
ServiceOrderItem
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
7 properties
Service
Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. Th…
ServiceOrderItemRef
ServiceOrder_Update
object
Skipped properties: id,href,orderDate,jeopardyAlert,errorMessage,milestone,@baseType,@schemaLocation,@type,cancellationDate,cancellationReason,category,complet…
13 properties
ServiceRef
Service reference, for when Service is used by other entities
ServiceOrderStateType
string
Possible values for the state of the order
Place
Place reference. Place defines the places where the products are sold or delivered.
ServiceOrderItemRelationship
Linked service order item to the one containing this attribute
RelatedServiceOrderItem
RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination.
ServiceOrderJeopardyAlert
A ServiceOrderJeopardyAlert represents a predicted exception during a service order processing that would brings risk to complete successfully the ordetr.
ServiceOrder_Create
Skipped properties: id,href,orderDate,completionDate,expectedCompletionDate,startDate,state,jeopardyAlert,errorMessage,milestone
CharacteristicRelationship
object
Another Characteristic that is related to the current Characteristic;
5 properties
ExternalReference
External reference of the individual or reference in other system
ServiceRelationship
ServiceOrderItemErrorMessage
AServiceOrderItemErrorMessage represents an error that causes a status change in a service order item.
Feature
object
Configuration feature.
7 properties 2 required
ServiceStateType
string
Valid values for the lifecycle state of the service
Note
Extra information about a given entity
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
AppointmentRef
Refers an appointment, such as a Customer presentation or internal meeting or site visit
ServiceRefOrValue
object
A Service to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the…
5 properties
RelatedPlaceRefOrValue
object
Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @sc…
6 properties
RelatedEntityRefOrValue
object
A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to…
6 properties
ServiceOrderItemStateType
string
Possible values for the state of the order item
ServiceOrderErrorMessage
A ServiceOrderErrorMessage represents an error that causes a status change in a service order.
PlaceRef
Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
EntityRef
Base entityRef schema for use in TMForum Open-APIs

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bell-canada-serviceorder-api-openapi.yml Raw ↑

Other APIs Bell Canada publishes across the network.

Bell Canada Cancel Service Order API
Bell Canada Change Request API
Bell Canada events subscription API
Bell Canada Logical Resource API
Bell Canada notification listeners (client side) API
Bell Canada Physical Resource API
Bell Canada Resource API
Bell Canada Trouble Ticket API
Where this information came from

This is an independent, third-party profile of Bell Canada Service Order API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.