TMForum Open APIs (4.0.0)

Download OpenAPI specification:Download

Staqr Support: support@staqr.com URL: https://staqr.com/support

Industry-standard REST APIs for telecommunications (TMF620, TMF622, TMF648)

TMF622 - Product Ordering

Product order lifecycle management

TMForum TMF622 Specification

Create Product Order

Place a new product order with order items

Authorizations:

basicAuth

Request Body schema: application/json
required

externalId required	string External order identifier
category required	string Order category
description	string
requestedStartDate	string <date-time>
requestedCompletionDate	string <date-time>
	Array of objects (ProductOrderItem)
	Array of objects (RelatedParty)

Responses

Request samples

Payload

Content type

application/json

{"externalId": "string",
"category": "string",
"description": "string",
"requestedStartDate": "2019-08-24T14:15:22Z",
"requestedCompletionDate": "2019-08-24T14:15:22Z",
"orderItems": [{"id": "string",
"action": "add",
"quantity": 0,
"state": "string",
"product": {"id": "string",
"productOffering": "string",
"productCharacteristic": [{"name": "string",
"value": "string"
}
]
}
}
],
"relatedParty": [{"id": "string",
"role": "string",
"name": "string"
}
]
}

Response samples

201

Content type

application/json

{"id": "string",
"href": "string",
"externalId": "string",
"state": "acknowledged",
"orderDate": "2019-08-24T14:15:22Z",
"completionDate": "2019-08-24T14:15:22Z",
"expectedCompletionDate": "2019-08-24T14:15:22Z",
"orderItems": [{"id": "string",
"action": "add",
"quantity": 0,
"state": "string",
"product": {"id": "string",
"productOffering": "string",
"productCharacteristic": [{"name": "string",
"value": "string"
}
]
}
}
]
}

List Product Orders

Retrieve a list of product orders matching search criteria

Authorizations:

basicAuth

query Parameters

offset	integer Default: 0
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"href": "string",
"externalId": "string",
"state": "acknowledged",
"orderDate": "2019-08-24T14:15:22Z",
"completionDate": "2019-08-24T14:15:22Z",
"expectedCompletionDate": "2019-08-24T14:15:22Z",
"orderItems": [{"id": "string",
"action": "add",
"quantity": 0,
"state": "string",
"product": {"id": "string",
"productOffering": "string",
"productCharacteristic": [{"name": "string",
"value": "string"
}
]
}
}
]
}
]

Get Product Order

Retrieve details of a specific product order

Authorizations:

basicAuth

path Parameters

orderId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"href": "string",
"externalId": "string",
"state": "acknowledged",
"orderDate": "2019-08-24T14:15:22Z",
"completionDate": "2019-08-24T14:15:22Z",
"expectedCompletionDate": "2019-08-24T14:15:22Z",
"orderItems": [{"id": "string",
"action": "add",
"quantity": 0,
"state": "string",
"product": {"id": "string",
"productOffering": "string",
"productCharacteristic": [{"name": "string",
"value": "string"
}
]
}
}
]
}

Update Product Order

Partially update a product order

Authorizations:

basicAuth

path Parameters

orderId

required

string

Request Body schema: application/json
required

state	string
completionDate	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"state": "string",
"completionDate": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": "string",
"href": "string",
"externalId": "string",
"state": "acknowledged",
"orderDate": "2019-08-24T14:15:22Z",
"completionDate": "2019-08-24T14:15:22Z",
"expectedCompletionDate": "2019-08-24T14:15:22Z",
"orderItems": [{"id": "string",
"action": "add",
"quantity": 0,
"state": "string",
"product": {"id": "string",
"productOffering": "string",
"productCharacteristic": [{"name": "string",
"value": "string"
}
]
}
}
]
}

TMF648 - Quote Management

Product quote management

TMForum TMF648 Specification

Create Product Quote

Request a new product quote

Authorizations:

basicAuth

Request Body schema: application/json
required

externalId required	string
description	string
requestedQuoteCompletionDate	string <date-time>
	Array of objects (QuoteItem)

Responses

Request samples

Payload

Content type

application/json

{"externalId": "string",
"description": "string",
"requestedQuoteCompletionDate": "2019-08-24T14:15:22Z",
"quoteItem": [{"id": "string",
"action": "string",
"quantity": 0,
"product": {"id": "string",
"productOffering": "string",
"productCharacteristic": [{"name": "string",
"value": "string"
}
]
},
"quoteItemPrice": [{"priceType": "one-time",
"price": {"value": 0,
"unit": "AUD"
},
"recurringChargePeriod": "string",
"unitOfMeasure": "string"
}
]
}
]
}

Response samples

201

Content type

application/json

{"id": "string",
"href": "string",
"externalId": "string",
"state": "inProgress",
"quoteDate": "2019-08-24T14:15:22Z",
"validityPeriod": {"startDateTime": "2019-08-24T14:15:22Z",
"endDateTime": "2019-08-24T14:15:22Z"
},
"quoteItem": [{"id": "string",
"action": "string",
"quantity": 0,
"product": {"id": "string",
"productOffering": "string",
"productCharacteristic": [{"name": "string",
"value": "string"
}
]
},
"quoteItemPrice": [{"priceType": "one-time",
"price": {"value": 0,
"unit": "AUD"
},
"recurringChargePeriod": "string",
"unitOfMeasure": "string"
}
]
}
]
}

List Product Quotes

Retrieve a list of product quotes

Authorizations:

basicAuth

query Parameters

offset	integer Default: 0
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"href": "string",
"externalId": "string",
"state": "inProgress",
"quoteDate": "2019-08-24T14:15:22Z",
"validityPeriod": {"startDateTime": "2019-08-24T14:15:22Z",
"endDateTime": "2019-08-24T14:15:22Z"
},
"quoteItem": [{"id": "string",
"action": "string",
"quantity": 0,
"product": {"id": "string",
"productOffering": "string",
"productCharacteristic": [{"name": "string",
"value": "string"
}
]
},
"quoteItemPrice": [{"priceType": "one-time",
"price": {"value": 0,
"unit": "AUD"
},
"recurringChargePeriod": "string",
"unitOfMeasure": "string"
}
]
}
]
}
]

Get Product Quote

Retrieve details of a specific product quote

Authorizations:

basicAuth

path Parameters

quoteId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"href": "string",
"externalId": "string",
"state": "inProgress",
"quoteDate": "2019-08-24T14:15:22Z",
"validityPeriod": {"startDateTime": "2019-08-24T14:15:22Z",
"endDateTime": "2019-08-24T14:15:22Z"
},
"quoteItem": [{"id": "string",
"action": "string",
"quantity": 0,
"product": {"id": "string",
"productOffering": "string",
"productCharacteristic": [{"name": "string",
"value": "string"
}
]
},
"quoteItemPrice": [{"priceType": "one-time",
"price": {"value": 0,
"unit": "AUD"
},
"recurringChargePeriod": "string",
"unitOfMeasure": "string"
}
]
}
]
}

TMF620 - Product Catalog

Product catalog management

TMForum TMF620 Specification

Get Product Catalog

Retrieve the product catalog

Authorizations:

basicAuth

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"validFor": {"startDateTime": "2019-08-24T14:15:22Z",
"endDateTime": "2019-08-24T14:15:22Z"
}
}

List Product Offerings

Retrieve available product offerings

Authorizations:

basicAuth

query Parameters

offset	integer Default: 0
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"href": "string",
"name": "string",
"description": "string",
"lifecycleStatus": "string",
"validFor": {"startDateTime": "2019-08-24T14:15:22Z",
"endDateTime": "2019-08-24T14:15:22Z"
},
"productOfferingPrice": [{"priceType": "one-time",
"price": {"value": 0,
"unit": "AUD"
},
"recurringChargePeriod": "string",
"unitOfMeasure": "string"
}
],
"productSpecification": {"id": "string",
"href": "string",
"name": "string",
"description": "string"
}
}
]

TMForum Open APIs (4.0.0)

TMF622 - Product Ordering

Create Product Order

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List Product Orders

Authorizations:

query Parameters

Responses

Response samples

Get Product Order

Authorizations:

path Parameters

Responses

Response samples

Update Product Order

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

TMF648 - Quote Management

Create Product Quote

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List Product Quotes

Authorizations:

query Parameters

Responses

Response samples

Get Product Quote

Authorizations:

path Parameters

Responses

Response samples

TMF620 - Product Catalog

Get Product Catalog

Authorizations:

Responses

Response samples

List Product Offerings

Authorizations:

query Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required