FIT Product Ordering Management API
AG-FIT 622
| Release | Value |
|---|---|
Version |
2.0.3 |
Date |
2026-06-16 |
State |
released |
Description
The Product Ordering Management API provides a standardized mechanism for placing and managing product orders between customers, service providers, and partners.
See Auftrag (Neu) anlegen for sample use cases.
Managed entity resource model
Product Order
A Product Order places an order between a customer, service provider, or partner.
JSON representation sample
{
"$schema" : "../schema/fit-tmf622.schema.json",
"@type" : "ProductOrder",
"id" : "388a4963-f168-4603-99e8-477200099d91",
"href" : "https://api.example.org/tmf-api/productOrderingManagement/v5/productOrder/388a4963-f168-4603-99e8-477200099d91",
"category" : "new",
"creationDate" : "2022-05-11T10:30:30+02:00",
"orderPostedDate" : "2022-05-11T10:30:00+02:00",
"requestedCompletionDate" : "2022-12-01T12:00:00+01:00",
"agreement" : [ {
"@type" : "Agreement",
"name" : "buyerServiceContract",
"engagedParty" : [ {
"@type" : "Organization",
"businessId" : "500011"
} ],
"businessId" : "500012",
"agreementType" : "buyerServiceContract"
}, {
"@type" : "Agreement",
"name" : "ordererServiceContract",
"engagedParty" : [ {
"@type" : "Organization",
"businessId" : "500014"
} ],
"businessId" : "500013",
"agreementType" : "ordererServiceContract"
}, {
"@type" : "Agreement",
"name" : "providerChangeAgreement",
"businessId" : "DEU.VFD.V012345678",
"agreementType" : "providerChangeAgreement"
} ],
"externalId" : [ {
"@type" : "ExternalIdentifier",
"id" : "1000111",
"externalIdentifierType" : "externalOrderId",
"owner" : "DEU.VFD"
} ],
"productOrderItem" : [ {
"@type" : "ProductOrderItem",
"id" : "1",
"action" : "add",
"product" : {
"@type" : "BitstreamAccessProduct",
"creationDate" : "2022-05-11T10:30:30+02:00",
"relatedPlace" : [ {
"@type" : "RelatedPlaceRefOrValue",
"role" : "locationA",
"place" : {
"@type" : "GeographicAddress",
"city" : "Rheinhausen",
"country" : "DE",
"locality" : "Nordstadt",
"postcode" : "59055",
"streetName" : "Biberweg",
"streetNr" : "2",
"streetNrSuffix" : "a",
"geographicSubAddress" : [ {
"@type" : "GeographicSubAddress",
"buildingName" : "Einfamilienhaus"
} ]
}
} ],
"networkTerminationUnitLocation" : "Flur 3.OG",
"homeId" : "a12d5a4545"
},
"productOffering" : {
"@type" : "ProductOffering",
"name" : "FTTH 250000"
},
"requestedTimeSlot" : {
"@type" : "TimeSlot",
"validFor" : {
"startDateTime" : "2022-12-01T08:00:00+01:00",
"endDateTime" : "2022-12-01T12:00:00+01:00"
}
}
} ],
"relatedParty" : [ {
"@type" : "RelatedPartyOrPartyRole",
"role" : "orderManagementBuyerContact",
"partyOrPartyRole" : {
"@type" : "Individual",
"contactMedium" : [ {
"@type" : "PhoneContactMedium",
"contactType" : "fixed",
"phoneNumber" : "+49221456789"
}, {
"@type" : "PhoneContactMedium",
"contactType" : "mobile",
"phoneNumber" : "+4917754545454"
}, {
"@type" : "EmailContactMedium",
"contactType" : "email",
"emailAddress" : "j.kirk@example.net"
} ],
"familyName" : "Kirk",
"salutation" : "Herr",
"givenName" : "James T.",
"title" : "Captain"
}
}, {
"@type" : "RelatedPartyOrPartyRole",
"role" : "installationContact",
"partyOrPartyRole" : {
"@type" : "Individual",
"contactMedium" : [ {
"@type" : "PhoneContactMedium",
"contactType" : "fixed",
"phoneNumber" : "+49221145155"
}, {
"@type" : "PhoneContactMedium",
"contactType" : "mobile",
"phoneNumber" : "+4917878878788"
}, {
"@type" : "EmailContactMedium",
"contactType" : "email",
"emailAddress" : "a.fischer@example.net"
} ],
"familyName" : "Fischer",
"salutation" : "Herr",
"givenName" : "Alexander"
}
}, {
"@type" : "RelatedPartyOrPartyRole",
"role" : "locationAContact",
"partyOrPartyRole" : {
"@type" : "Individual",
"familyName" : "Müller",
"salutation" : "Herr",
"givenName" : "Maximilian"
}
} ],
"state" : "acknowledged",
"stateChangeDate" : "2022-05-11T10:30:00+02:00",
"additionalOrderInformation" : {
"campaignIdentifier" : [ "PromotionFiber" ],
"projectIdentifier" : "AB1234",
"couplingIdentifier" : "QW567",
"orderBindingId" : "AK45678",
"orderBindingNumberOfOrders" : 5,
"hardwareIdType" : "OntSerialNumber",
"hardwareIdValue" : "1234567890"
}
}
Notifications
The API reference documents create, state-change, attribute-value-change, information-required, jeopardy-alert, and milestone events, including state changes for the task resources in this release.