Product Inventory Open API - GET /sn_prd_invt/productinventory/{inventoryId}

Product Inventory Open API Product Inventory Open API

The Product Inventory Open API provides endpoints to create and retrieve product inventories.

Use this API to manage product inventory information between external systems and the ServiceNow AI Platform .

This API is included in the Product Inventory Advanced application, which is available on the ServiceNow Store .

This API is provided within the sn_prd_invt namespace.

The calling user must have the sn_prd_invt.product_inventory_integrator role.

This API creates and updates data in the following tables. Product Characteristics [sn_prd_invt_product_characteristics] Product Inventory [sn_prd_invt_product_inventory] Product Model [cmdb_model] Product Model Characteristic [sn_prd_pm_product_model_characteristic]

The Product Inventory Open API is a ServiceNow® implementation of the TM Forum Product Inventory Management API REST specification. This implementation is based on the TMF637 Product Inventory Management API REST Specification Release 19 , August 2019. The Product Inventory Open API is conformance certified by TM Forum.

Parent Topic: REST API reference Product Inventory Open API - GET /sn_prd_invt/product

Retrieves a list of all product inventories.

URL format Default URL: api/sn_prd_invt/product

Supported request parameters Table 1. Path parameters Name Description None

Table 2. Query parameters Name Description customer Filter product inventories by customer. Only product offerings with a customer sys_id or external ID matching the value of this parameter are returned in the response. Data type: String

fields List of fields to return in the response. Invalid fields are ignored. If this parameter is not used, all fields are returned. Data type: String

limit Maximum number of records to return. For requests that exceed this number of records, use the offset parameter to paginate record retrieval. Default: 20

Maximum: 100

Data type: Number

offset Starting index at which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. Default: 0

Data type: Number

place Filter product inventories by place. Only product offerings with a place sys_id or external id matching the value of this parameter are returned in the response. Data type: String

status Filter product inventories by status. Only product inventories with a status matching the value of this parameter are returned in the response. Data type: String

Table 3. Request body parameters (JSON) Name Description None

Headers The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers .

Table 4. Request headers Header Description None

Table 5. Response headers Header Description Content-Range Specifies the range of content returned in a paginated call. For example, if offset=2 and limit=3 , the value of the Content-Range header is items 3-5 .

Content-Type Data format of the response body. Only supports application/json . Link Contains the following links to navigate through query results. first last next previous X-Total-Count For paginated queries, this header specifies the total number of records available on the server.

Status codes The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes .

Table 6. Status codes Status code Description 200 Request successfully processed. Full resource returned in response (no pagination). 206 Partial resource returned in response (with pagination). 400 Bad request. Possible reasons: Invalid path parameter Invalid URI 404 Record not found. No records matching the query parameters are found in the table.

Response body parameters (JSON) Name Description href Relative link to the product inventory record. Data type: String

id Sys_id of the product inventory from the Product Inventory [sn_prd_invt_product_inventory] table. Data type: String

name Name of the product inventory. Data type: String

place Place associated with the product. Data type: String

productCharacteristic List of product characteristics. Data type: Array

"productCharacteristic": [ { "name": "String", "value": "String" } ] productCharacteristic.name Name of the characteristic. Data type: String

productCharacteristic.value Value of the characteristic. Data type: String

productOffering Product offering that the product inventory is associated with. Data type: Object

"productOffering": { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } productOffering.id Initial_version or external_id of the product offering. Located in the Product Offering [sn_prd_pm_product_offering] table. Data type: String

productOffering.internalId Initial_version of the product offering. Located in the Product Offering [sn_prd_pm_product_offering] table. Data type: String

productOffering.internalVersion Version of the product offering. Located in the Product Offering [sn_prd_pm_product_offering] table. Data type: String

productOffering.name Name of the product offering. Located in the Product Offering [sn_prd_pm_product_offering] table. Data type: String

productOffering.version External_version of the product offering. Located in the Product Offering [sn_prd_pm_product_offering] table. Data type: String

productPrice Returns an empty array. Data type: Array

productRelationship List of related products. Data type: Array

"productRelationship": [ { "productId": "String", "relationshipType": "String" } ] productRelationship.productId Sys_id of the related product from the Product Inventory [sn_prd_invt_product_inventory] table. Data type: String

productRelationship.relationshipType Type of relationship. Data type: String

productSpecification Product specification for the product. Data type: Object

"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" } productSpecification.id Initial_version or external_id of the product specification. Located in the Product Specification [sn_prd_pm_product_specification] table. Data type: String

productSpecification.internalId Initial_version of the product specification. Located in the Product Specification [sn_prd_pm_product_specification] table. Data type: String

productSpecification.internalVersion Version of the product specification. Located in the Product Specification [sn_prd_pm_product_specification] table. Data type: String

productSpecification.version External_version of the product specification. Located in the Product Specification [sn_prd_pm_product_specification] table. Data type: String

realizingResource Resource that realizes the product. The realizing resource is a child product inventory of this product inventory. Data type: Object

"realizingResource": { "id": "String", "type": "String" } realizingResource.id Sys_id of the realizing resource. Located in the Product Inventory [sn_prd_invt_product_inventory] table. Data type: String

realizingResource.type Type of the realizing resource. Valid value: child

Data type: String

realizingService Service that realizes the product. The realizing service is a child product inventory of this product inventory. Data type: Object

"realizingService": { "id": "String", "type": "String" } realizingService.id Sys_id of the realizing service. Located in the Product Inventory [sn_prd_invt_product_inventory] table. Data type: String

realizingService.type Type of the realizing service. Valid value: child

Data type: String

relatedParty List of parties associated with the ticket. Data type: Array

"relatedParty": [ { "id": "String", "@referredType": "String" } ] relatedParty.id Sys_id of the account or customer contact associated with the ticket. Located in the Account [customer_account], Contact [customer_contact], or Consumer [csm_consumer] table. Data type: String

relatedParty.@referredType Type of customer. Possible values: Customer CustomerContact Consumer Data type: String

state Current state of the product. Data type: String

cURL request This example retrieves all product inventories.

curl --location --request GET "https://instance.service-now.com/api/sn_prd_invt/product" \ --user 'username':'password' Response body.

[ { "id": "037fd87ec3603010abc8b5183c40ddf2", "relatedParty": [ { "id": "ffc68911c35420105252716b7d40dd55", "name": "Example Company", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" } ], "name": "Routing and Configuration PI0000318", "productSpecification": { "id": "aec57e981bb420106ba59acf034bcb08", "name": "Routing and Configuration", "version": "", "internalVersion": "1", "internalId": "aec57e981bb420106ba59acf034bcb08" }, "status": "Active", "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "", "internalVersion": "1", "internalId": "69017a0f536520103b6bddeeff7b127d" }, "product": "ce0b52c7532520103b6bddeeff7b12f5", "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "name": "100 South Charles Street, Baltimore,MD" }, "productCharacteristic": [], "productRelationship": [], "realizingService": [], "realizingResource": [ { "id": "9b2fa60b536520103b6bddeeff7b1233", "name": "Route Target" } ], "productPrice": [], "href": "/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2", "billingAccount": "Not Specified." } ]

Product Inventory Open API - GET /sn_prd_invt/product/{id}

Retrieves a specified product inventory record.

URL format Default URL: /api/sn_prd_invt/product/{id}

Supported request parameters Table 7. Path parameters Name Description id Sys_id of the product inventory to retrieve. Located in the Product Inventory [sn_prd_invt_product_inventory] table. Data type: String

Table 8. Query parameters Name Description customer Filter product inventories by customer. Only product offerings with a customer sys_id or external id matching the value of this parameter are returned in the response. Data type: String

fields List of fields to return in the response. Invalid fields are ignored. If this parameter is not used, all fields are returned. Data type: String

place Filter product inventories by place. Only product offerings with a place sys_id or external id matching the value of this parameter are returned in the response. Data type: String

status Filter product inventories by status. Only product inventories with a status matching the value of this parameter are returned in the response. Data type: String

Table 9. Request body parameters (JSON) Name Description None

Headers The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers .

Table 10. Request headers Header Description None

Table 11. Response headers Header Description Content-Type Data format of the response body. Only supports application/json .

Status codes The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes .

Table 12. Status codes Status code Description 200 Request successfully processed. 400 Bad Request. Could be any of the following reasons: Invalid path parameter Invalid URI 404 Record not found. Record associated with the ID is not found in the table.