Product Inventory Management

List or find Product objects

This operation lists or finds Product entities

Securityx-sonata-buyer-key-and-api-key

Request

query Parameters

status	string The status of the product Enum: "active" "active.pendingChange" "cancelled" "pendingActive" "pendingTerminate" "suspended" "suspendedPendingTerminate" "terminated"
productSpecificationId	string A reference to a Product specification by id
productOfferingId	string A reference to a Product offering by id
externalId	string A reference to the externalId provided in the order
geographicalSiteId	string A site identifier which is associated to the Product
relatedProductId	string This criteria allows to retrieve all Product records with a Product Relationship to a specified Product. E.g. All Products related to Product with ID 5
billingAccountId	string The Billing Account associated with the Product.
productOrderId	string Identifies Product Order associated with the Product
startDate.lt	string <date-time> Less than the date that is the initial install date for the Product
startDate.gt	string <date-time> Greater than the date that is the initial install date for the Product
lastUpdateDate.lt	string <date-time> Less than date that the last change affecting this Product was completed
lastUpdateDate.gt	string <date-time> Greater than the date that the last change affecting this Product was completed
buyerId	string The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. Reference: MEF 81 (Sn 8.3)
sellerId	string The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. Reference: MEF 81 (Sn 8.3)
offset	integer <int32> Requested index for start of item to be provided in response requested by client. Note that the index starts with "0".
limit	integer <int32> Requested number of items to be provided in response requested by client

Responses

200

OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable entity due to the business validation problems

500

Internal Server Error

get/mefApi/sonata/productInventory/v7/product

Response samples

application/json;charset=utf-8

[{"productSpecification": {"href": "string",
"id": "string"
},
"relatedSite": [{"role": "string",
"id": "string",
"href": "string"
}
],
"productOffering": {"href": "string",
"id": "string"
},
"lastUpdateDate": "2019-08-24T14:15:22Z",
"externalId": "string",
"productRelationship": [{"href": "string",
"id": "string",
"relationshipType": "string"
}
],
"id": "string",
"href": "string",
"billingAccount": {"id": "string"
},
"productOrderItem": [{"productOrderHref": "string",
"productOrderId": "string",
"productOrderItemId": "string"
}
],
"startDate": "2019-08-24T14:15:22Z",
"status": "active"
}
]

Retrieves a Product by ID

This operation retrieves a Product entity.

Securityx-sonata-buyer-key-and-api-key

Request

path Parameters

required

string

Identifier of the Product