productOrderById

get

productOrderById

Retrieves ProductOrder by the Order identifier.

Resource URL

 
Environment URL
Production

https://digitalconnectproxy-qa.ebiz.verizon.com//usp/productOrderById/serviceorder/{sorId}    

Test

https://digitalconnectproxy-qa.ebiz.verizon.com//usp/productOrderById/serviceorder/{sorId}    

Query Parameters


Name Values Description
sorId
(required)

Identifier of the ProductOrder


Attribute NameTypeDescription
instantSyncQualificationbooleanIf this flag is set to Yes, Buyer requests to have an instant qualification to be provided in operation POST response
externalIdstringID given by the consumer and only understandable by him (to facilitate his searches afterwards)
provideAlternativebooleanAllows the Buyer to indicate if he is willing to get an alternate proposal if requested product not available.
projectIdstringThis value MAY be assigned by the Buyer to identify a project the serviceability request is associated with.
requestedPOQCompletionDatestringThe latest date a the POQ completion is expected. This attribute is required when instantSyncQualification=false
relatedContactInformation(Json Array)
role(Json Array)
name
optional
stringName of the contact
emailAddress
optional
string Email address
number string Phone number
note(Json Array)
idstringIdentifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)
text
optional
string Content of the Note
productOfferingQualificationItem(Json Array)
Attribute NameTypeDescription
actionstringAction to be performed on the Product Item. The action types are described in MEF 79 (Sn 8.4.1.1).
idstringId of this POQ item which is unique within the POQ. Assigned by the Buyer.
agreementNamestringName of the agreement. The name is unique between the Buyer and the Seller.
Attribute NameTypeDescription
Attribute NameTypeDescription
idstringThe unique identifier of an in-service Product that is the qualifications subject. This field MUST be populated if an item action is either modify or delete. This field MUST NOT be populated if an item action is add.
Attribute NameTypeDescription
idstringid of a Product Offering. It is assigned by the Seller. The Buyer and the Seller exchange information about offerings ids during the onboarding process.
Attribute NameTypeDescription
typestringThe name of the type that uniquely identifies the type of the product that is the subject of the POQ Request. In case of MEF product this is the URN provided in the Product Specification.
Attribute NameTypeDescription
namestringName of the product characteristic
valueTypestringTBD
Attribute NameTypeDescription
physicalLayerstringWhich could be one of the following PHY interfaceIEEE Std 802.3 – 2015 but excluding 1000BASE-PX-D and 1000BASE-PX-U,IEEE Std 802.3bp – 2016,IEEE Std 802.3bq – 2016,IEEE Std 802.3bs – 2017,IEEE Std 802.3bu – 2016,IEEE Std 802.3bv – 2017,IEEE Std 802.3by – 2016,IEEE Std 802.3bz – 2016;
accessSpeedstringSpeed of access link to Verizon POP
uniSpeedstringUNI Speed
connectorTypestringType of connector such as Single Mode or Multi-mode
powerstringDC or AC Power
customerHandoffstringAll types of access out of PQ i.e, Ethernet
accessDesignstringStandalone Loop (Customer direct access to Verizon network where UNI is at customer location)
accessOwnerstringTBD
Attribute Name Type Description
instantSyncQualification boolean If this flag is set to Yes, Buyer requests to have an instant qualification to be provided in operation POST response
externalId string ID given by the consumer and only understandable by him (to facilitate his searches afterwards)
provideAlternative boolean Allows the Buyer to indicate if he is willing to get an alternate proposal if requested product not available.
projectId string This value MAY be assigned by the Buyer to identify a project the serviceability request is associated with.
requestedPOQCompletionDate string The latest date a the POQ completion is expected. This attribute is required when instantSyncQualification=false
relatedContactInformation(Json Array)
role(Json Array)
name
optional
string Name of the contact
emailAddress
optional
string Email address
number string Phone number
note(Json Array)
id string Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)
text
optional
string Content of the Note
productOfferingQualificationItem(Json Array)
Attribute Name Type Description
action string Action to be performed on the Product Item. The action types are described in MEF 79 (Sn 8.4.1.1).
id string Id of this POQ item which is unique within the POQ. Assigned by the Buyer.
agreementName string Name of the agreement. The name is unique between the Buyer and the Seller.
Attribute NameTypeDescription
Attribute Name Type Description
id string The unique identifier of an in-service Product that is the qualifications subject. This field MUST be populated if an item action is either modify or delete. This field MUST NOT be populated if an item action is add.
Attribute Name Type Description
id string id of a Product Offering. It is assigned by the Seller. The Buyer and the Seller exchange information about offerings ids during the onboarding process.
Attribute Name Type Description
type string The name of the type that uniquely identifies the type of the product that is the subject of the POQ Request. In case of MEF product this is the URN provided in the Product Specification.
Attribute Name Type Description
name string Name of the product characteristic
valueType string Payload value
Attribute Name Type Description
physicalLayer string Which could be one of the following PHY interfaceIEEE Std 802.3 – 2015 but excluding 1000BASE-PX-D and 1000BASE-PX-U,IEEE Std 802.3bp – 2016,IEEE Std 802.3bq – 2016,IEEE Std 802.3bs – 2017,IEEE Std 802.3bu – 2016,IEEE Std 802.3bv – 2017,IEEE Std 802.3by – 2016,IEEE Std 802.3bz – 2016;
accessSpeed string Speed of access link to Verizon POP
uniSpeed string UNI Speed
connectorType string Type of connector such as Single Mode or Multi-mode
power string DC or AC Power
customerHandoff string All types of access out of PQ i.e, Ethernet
accessDesign string Standalone Loop (Customer direct access to Verizon network where UNI is at customer location)
accessOwner string Verizon
Attribute NameTypeDescription
instantSyncQualificationbooleanIf this flag is set to Yes, Buyer requests to have an instant qualification to be provided in operation POST response
externalIdstringID given by the consumer and only understandable by him (to facilitate his searches afterwards)
provideAlternativebooleanAllows the Buyer to indicate if he is willing to get an alternate proposal if requested product not available.
projectIdstringThis value MAY be assigned by the Buyer to identify a project the serviceability request is associated with.
requestedPOQCompletionDatestringThe latest date a the POQ completion is expected. This attribute is required when instantSyncQualification=false
relatedContactInformation(Json Array)
role(Json Array)
name
optional
stringName of the contact
emailAddress
optional
string Email address
number string Phone number
note(Json Array)
idstringIdentifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)
text
optional
string Content of the Note
productOfferingQualificationItem(Json Array)
Attribute NameTypeDescription
actionstringAction to be performed on the Product Item. The action types are described in MEF 79 (Sn 8.4.1.1).
idstringId of this POQ item which is unique within the POQ. Assigned by the Buyer.
agreementNamestringName of the agreement. The name is unique between the Buyer and the Seller.
Attribute NameTypeDescription
Attribute NameTypeDescription
idstringThe unique identifier of an in-service Product that is the qualifications subject. This field MUST be populated if an item action is either modify or delete. This field MUST NOT be populated if an item action is add.
Attribute NameTypeDescription
idstringid of a Product Offering. It is assigned by the Seller. The Buyer and the Seller exchange information about offerings ids during the onboarding process.
Attribute NameTypeDescription
typestringThe name of the type that uniquely identifies the type of the product that is the subject of the POQ Request. In case of MEF product this is the URN provided in the Product Specification.
Attribute NameTypeDescription
namestringName of the product characteristic
valueTypestringTBD
Attribute NameTypeDescription
physicalLayerstringWhich could be one of the following PHY interfaceIEEE Std 802.3 – 2015 but excluding 1000BASE-PX-D and 1000BASE-PX-U,IEEE Std 802.3bp – 2016,IEEE Std 802.3bq – 2016,IEEE Std 802.3bs – 2017,IEEE Std 802.3bu – 2016,IEEE Std 802.3bv – 2017,IEEE Std 802.3by – 2016,IEEE Std 802.3bz – 2016;
accessSpeedstringSpeed of access link to Verizon POP
uniSpeedstringUNI Speed
connectorTypestringType of connector such as Single Mode or Multi-mode
powerstringDC or AC Power
customerHandoffstringAll types of access out of PQ i.e, Ethernet
accessDesignstringStandalone Loop (Customer direct access to Verizon network where UNI is at customer location)
accessOwnerstringTBD
Attribute Name Type Description
instantSyncQualification boolean If this flag is set to Yes, Buyer requests to have an instant qualification to be provided in operation POST response
externalId string ID given by the consumer and only understandable by him (to facilitate his searches afterwards)
provideAlternative boolean Allows the Buyer to indicate if he is willing to get an alternate proposal if requested product not available.
projectId string This value MAY be assigned by the Buyer to identify a project the serviceability request is associated with.
requestedPOQCompletionDate string The latest date a the POQ completion is expected. This attribute is required when instantSyncQualification=false
relatedContactInformation(Json Array)
role(Json Array)
name
optional
string Name of the contact
emailAddress
optional
string Email address
number string Phone number
note(Json Array)
id string Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)
text
optional
string Content of the Note
productOfferingQualificationItem(Json Array)
Attribute Name Type Description
action string Action to be performed on the Product Item. The action types are described in MEF 79 (Sn 8.4.1.1).
id string Id of this POQ item which is unique within the POQ. Assigned by the Buyer.
agreementName string Name of the agreement. The name is unique between the Buyer and the Seller.
Attribute NameTypeDescription
Attribute Name Type Description
id string The unique identifier of an in-service Product that is the qualifications subject. This field MUST be populated if an item action is either modify or delete. This field MUST NOT be populated if an item action is add.
Attribute Name Type Description
id string id of a Product Offering. It is assigned by the Seller. The Buyer and the Seller exchange information about offerings ids during the onboarding process.
Attribute Name Type Description
type string The name of the type that uniquely identifies the type of the product that is the subject of the POQ Request. In case of MEF product this is the URN provided in the Product Specification.
Attribute Name Type Description
name string Name of the product characteristic
valueType string Payload value
Attribute Name Type Description
physicalLayer string Which could be one of the following PHY interfaceIEEE Std 802.3 – 2015 but excluding 1000BASE-PX-D and 1000BASE-PX-U,IEEE Std 802.3bp – 2016,IEEE Std 802.3bq – 2016,IEEE Std 802.3bs – 2017,IEEE Std 802.3bu – 2016,IEEE Std 802.3bv – 2017,IEEE Std 802.3by – 2016,IEEE Std 802.3bz – 2016;
accessSpeed string Speed of access link to Verizon POP
uniSpeed string UNI Speed
connectorType string Type of connector such as Single Mode or Multi-mode
power string DC or AC Power
customerHandoff string All types of access out of PQ i.e, Ethernet
accessDesign string Standalone Loop (Customer direct access to Verizon network where UNI is at customer location)
accessOwner string Verizon

Body Parameters


Name Values Description
response
(required)

Sample Request

 

sorId Identifier of the ProductOrder null true

Please login to send the sample request and get a reponse back.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    Invalid status value

Working...