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 User Guide v5.0.0, September 2024. The Product Inventory Open API is conformance certified by TM Forum.
[Omitted image "tmf-conformance.png"] Alt text: TMF conformance logo
Note: By default, POST /sn_prd_invt/product accepts and returns a single JSON object. GET endpoints return status as a display label, such as Installation pending, and the product reference field is named product. To change the default behavior, create a system property sn_prd_invt.tmf637.version4 and set the value to true. When true, POST /sn_prd_invt/product accepts and returns a JSON array. GET endpoints return status as an internal value, such as installation_pending, and the product reference field is named productId. Set the property to false to return to the default behavior.
Note: By default, GET endpoints on this API return valueType as a display value, such as Choice. To change the default behavior and return the backend value instead (for example, choice) — matching the format used by the Product Order Open API — create a system property sn_prd_invt.enableseamlessvaluetype and set the value to true. Set the property to false, or leave it unset, to return to the default behavior.
Parent Topic:REST API reference
Product Inventory Open API – DELETE /sn_prd_invt/order/product/{id}
Deletes a specified product inventory record.
URL format
Default URL: /api/sn_prd_invt/order/product/{id}
Supported request parameters
|
Name |
Description |
|---|---|
|
id |
Sys_id of the product inventory to delete.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
| 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.
| Header | Description |
|---|---|
| Accept | Data format of the response body. Only supports application/json. |
| Header | Description |
|---|---|
| None |
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.
| Status code | Description |
|---|---|
| 204 | No Content. Record successfully deleted. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
Response body parameters (JSON)
| Name | Description |
|---|---|
| None |
cURL request
This example deletes a product inventory record.
curl "https://instance.service-now.com/api/sn_prd_invt/product/01b2f9972b8c72d07a83f395f291bf53" \--request DELETE \--header "Accept:application/json" \--user 'username':'password'No response body is returned when a product inventory record is successfully deleted.
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
| Name | Description |
|---|---|
| None |
|
Name |
Description |
|---|---|
|
account |
Filter product inventories by account. Only inventories associated with the specified account are returned in the response.Data type: String Default: Don't filter by account. |
|
billingAccount |
Filter product inventories by billing account. Only inventories associated with the specified billing account are returned in the response.Data type: String Default: Don't filter by billing account |
|
contact and consumer (Related Party) |
Filter product inventories by associated contact or related party. Only inventories linked to the specified contact or consumer record are returned in the response.Data type: String Default: Don't filter by contact or consumer |
|
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 Default: Don't filter by customer. |
|
externalID |
Filter product inventories by external identifier. Only inventories with an externalID matching the value of this parameter are returned in the response. Data type: String Default: Don't filter by externalID |
|
fields |
List of fields to return in the response. Invalid fields are ignored.Data type: String Default: Return all fields. |
|
limit |
Maximum number of records to return. For requests that exceed this number of records, use the offset parameter to paginate record retrieval. Data type: Number Default: 20 Maximum: 100 |
|
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.Data type: Number Default: 0 |
|
place |
Filter product inventories by location.Data type: Object Text |
|
place.id |
Sys_id or external id of the location associated with the product inventory record.Data type: String Table: Location [cmn_location] Field: sys_id or sn_tmt_core_external_id |
|
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 Default: Don't filter by status. |
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.
| Header | Description |
|---|---|
| None |
|
Header |
Description |
|---|---|
|
Content-Range |
Range of content returned in a paginated call. For example, if |
|
Content-Type |
Data format of the response body. Only supports application/json. |
|
Link |
Contains the following links to navigate through query results.- first
|
|
X-Total-Count |
For paginated queries, this header specifies the total number of records available on the server. |
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.
|
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:
|
|
404 |
Record not found. No records matching the query parameters are found in the table. |
|
Name |
Description |
|---|---|
|
href |
Relative link to the product inventory record.Data type: String |
|
id |
Sys_id of the product inventory.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
name |
Name of the product inventory.Data type: String |
|
place |
Location of the product.Data type: Array Text |
|
place.id |
Location sys_id or external id.Data type: String Table: Location [cmn_location] Field: sys_id or sn_tmt_core_external_id |
|
place.name |
Name of the location.Data type: String Table: Location [cmn_location] Field: name |
|
productCharacteristic |
List of product characteristics.For additional information on product characteristics, see Create a product offering category. Data type: Array of Objects JSON |
|
productCharacteristic.name |
Name of the characteristic.Data type: String |
|
productCharacteristic.value |
Value of the characteristic.Data type: String |
|
productCharacteristic.valueType |
Type of characteristic value.Possible values:
Note: By default, or if this property doesn't exist, this field returns the display values listed above. To return the internal value instead (matching the value format the TMF622 Product Order API already uses by default), create a true/false system property named sn_prd_invt.enableseamlessvaluetype and set it to Default: Data type: String |
|
productId |
Sys_id of the product model for the product inventory.Data type: String Table: Product Model [cmdb_model] |
|
productOffering |
Product offering that the product inventory is associated with.Data type: Object JSON |
|
productOffering.id |
Initial version or external ID of the product offering. Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: initial_version or external_id |
|
productOffering.internalId |
Internal version of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: internal_version |
|
productOffering.internalVersion |
Version of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: version |
|
productOffering.name |
Name of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] |
|
productOffering.version |
External version of the product offering. Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: external_version |
|
productPrice |
Returns an empty array.Data type: Array |
|
productRelationship |
List of related products.Data type: Array of Objects Text |
|
productRelationship.productId |
Sys_id of the related product.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
productRelationship.relationshipType |
Type of relationship.Data type: String |
|
productSpecification |
Product specification for the product.Data type: Object JSON |
|
productSpecification.id |
Initial version or external ID of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: internal_version or external_id |
|
productSpecification.internalId |
Initial version of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: initial_version |
|
productSpecification.internalVersion |
Version of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: version |
|
productSpecification.version |
External version of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: external_version |
|
realizingResource |
Resource that realizes the product. The realizing resource is a child product inventory of this product inventory.Data type: Object Text |
|
realizingResource.id |
Sys_id of the realizing resource. Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
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 Text |
|
realizingService.id |
Sys_id of the realizing service. Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
realizingService.type |
Type of the realizing service.Valid value: child Data type: String |
|
relatedParty |
List of parties associated with the ticket.Data type: Array of Objects Text |
|
relatedParty.id |
Sys_id of the account or customer contact associated with the ticket.Data type: String Table: Account [customer_account], Contact [customer_contact], or Consumer [csm_consumer] |
|
relatedParty.@referredType |
Type of customer.Possible values:
Data type: String |
|
state |
Current state of the product.Data type: String |
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" }, "productId": "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
|
Name |
Description |
|---|---|
|
id |
Sys_id of the product inventory to retrieve.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
Name |
Description |
|---|---|
|
account |
Filter product inventories by account. Only inventories associated with the specified account are returned in the response.Data type: String Default: Don't filter by account. |
|
billingAccount |
Filter product inventories by billing account. Only inventories associated with the specified billing account are returned in the response.Data type: String Default: Don't filter by billing account |
|
contact and consumer (Related Party) |
Filter product inventories by associated contact or related party. Only inventories linked to the specified contact or consumer record are returned in the response.Data type: String Default: Don't filter by contact or consumer |
|
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 Default: Don't filer y customer. |
|
externalID |
Filter product inventories by external identifier. Only inventories with an externalID matching the value of this parameter are returned in the response. Data type: String Default: Don't filter by externalID |
|
fields |
List of fields to return in the response. Invalid fields are ignored.Data type: String Default: All fields returned. |
|
place |
Filter product inventories by location.Data type: Object Text |
|
place.id |
Sys_id or external id of the location associated with the product inventory record.Data type: String Table: Location [cmn_location] Field: sys_id or sn_tmt_core_external_id |
|
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 Default: Don't filter by status. |
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.
| Header | Description |
|---|---|
| None |
| 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.
|
Status code |
Description |
|---|---|
|
200 |
Request successfully processed. |
|
400 |
Bad Request. Could be any of the following reasons:
|
|
404 |
Record not found. Record associated with the ID is not found in the table. |
|
Name |
Description |
|---|---|
|
billingAccount |
Billing account of the product inventory record.Data type: String |
|
href |
Relative link to the product inventory record.Data type: String |
|
id |
Sys_id of the product inventoryData type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
name |
Name of the product inventory.Data type: String |
|
place |
Location of the product.Data type: Array Text |
|
place.id |
Location sys_id or external id.Data type: String Table: Location [cmn_location] Field: sys_id or sn_tmt_core_external_id |
|
place.name |
Name of the location.Data type: String Table: Location [cmn_location] Field: name |
|
productCharacteristic |
List of product characteristics.For additional information on product characteristics, see Create a product offering category. Data type: Array of Objects JSON |
|
productCharacteristic.name |
Name of the characteristic.Data type: String |
|
productCharacteristic.value |
Value of the characteristic.Data type: String |
|
productCharacteristic.valueType |
Type of characteristic value.Possible values:
Note: By default, or if this property doesn't exist, this field returns the display values listed above. To return the internal value instead (matching the value format the TMF622 Product Order API already uses by default), create a true/false system property named sn_prd_invt.enableseamlessvaluetype and set it to Default: Data type: String |
|
productId |
Sys_id of the product model for the product inventory.Data type: String Table: Product Model [cmdb_model] |
|
productOffering |
Product offering that the product inventory is associated with.Data type: Object JSON |
|
productOffering.id |
Initial version or external ID of the product offering. Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: initial_version or external_id |
|
productOffering.internalId |
Internal version of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: internal_version |
|
productOffering.internalVersion |
Version of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: version |
|
productOffering.name |
Name of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] |
|
productOffering.version |
External version of the product offering. Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: external_version |
|
productPrice |
Returns an empty array.Data type: Array |
|
productRelationship |
List of related products.Data type: Array of Objects Text |
|
productRelationship.productId |
Sys_id of the related product.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
productRelationship.relationshipType |
Type of relationship.Data type: String |
|
productSpecification |
Product specification for the product.Data type: Object JSON |
|
productSpecification.id |
Initial version or external ID of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: internal_version or external_id |
|
productSpecification.internalId |
Initial version of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: initial_version |
|
productSpecification.internalVersion |
Version of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: version |
|
productSpecification.version |
External version of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: external_version |
|
realizingResource |
Resource that realizes the product. The realizing resource is a child product inventory of this product inventory.Data type: Object Text |
|
realizingResource.id |
Sys_id of the realizing resource. Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
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 Text |
|
realizingService.id |
Sys_id of the realizing service. Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
realizingService.type |
Type of the realizing service.Valid value: child Data type: String |
|
relatedParty |
List of parties associated with the ticket.Data type: Array of Objects Text |
|
relatedParty.id |
Sys_id of the account or customer contact associated with the ticket.Data type: String Table: Account [customer_account], Contact [customer_contact], or Consumer [csm_consumer] |
|
relatedParty.type |
Type of related party. Value is always |
|
relatedParty.@referredType |
Type of customer, such as a customer or customer contact.Data type: String |
|
status |
Current state of the product.Data type: String |
This example retrieves a specified product inventory.
curl -X GET 'https://instance.service-now.com/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2' \--user 'username':'password'Output:
{ "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" }, "productId": "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/productinventory
Retrieves a list of all product inventories.
Important: Starting with the Tokyo release, this endpoint is deprecated. The new version of this endpoint is Product Inventory Open API - GET /sn_prd_invt/product.
URL format
Default URL: api/sn_prd_invt/productinventory
Supported request parameters
| Name | Description |
|---|---|
| None |
|
Name |
Description |
|---|---|
|
account |
Filter product inventories by account. Only inventories associated with the specified account are returned in the response.Data type: String Default: Don't filter by account. |
|
billingAccount |
Filter product inventories by billing account. Only inventories associated with the specified billing account are returned in the response.Data type: String Default: Don't filter by billing account |
|
contact and consumer (Related Party) |
Filter product inventories by associated contact or related party. Only inventories linked to the specified contact or consumer record are returned in the response.Data type: String Default: Don't filter by contact or consumer |
|
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 Default: Don't filter by customer. |
|
externalID |
Filter product inventories by external identifier. Only inventories with an externalID matching the value of this parameter are returned in the response. Data type: String Default: Don't filter by externalID |
|
fields |
List of fields to return in the response. Invalid fields are ignored.Data type: String Default: All fields are returned. |
|
limit |
Maximum number of records to return. For requests that exceed this number of records, use the offset parameter to paginate record retrieval. Data type: Number Default: 20 Maximum: 100 |
|
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.Data type: Number Default: 0 |
|
place |
Filter product inventories by location.Data type: Object Text |
|
place.id |
Sys_id or external id of the location associated with the product inventory record.Data type: String Table: Location [cmn_location] Field: sys_id or sn_tmt_core_external_id |
|
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 Default: Don't filter by inventory status. |
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.
| Header | Description |
|---|---|
| None |
|
Header |
Description |
|---|---|
|
Content-Range |
Range of content returned in a paginated call. For example, if |
|
Content-Type |
Data format of the response body. Only supports application/json. |
|
Link |
Contains the following links to navigate through query results.- first
|
|
X-Total-Count |
For paginated queries, this header specifies the total number of records available on the server. |
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.
|
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:
|
|
404 |
Record not found. No records matching the query parameters are found in the table. |
|
Name |
Description |
|---|---|
|
id |
Sys_id of the product inventory.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
name |
Name of the product inventory.Data type: String |
|
place |
Place associated with the product.Data type: Object Text |
|
place.id |
Location sys_id or external_id of the product inventory.Table: Location [cmn_location] Data: String |
|
place.name |
Name of the location associated with the product inventory.Table: Location [cmn_location] Data: String |
|
productCharacteristic |
List of product characteristics.For additional information on product characteristics, see Create a product offering category. Data type: Array of Objects JSON |
|
productCharacteristic.name |
Name of the characteristic.Data type: String |
|
productCharacteristic.value |
Value of the characteristic.Data type: String |
|
productCharacteristic.valueType |
Type of characteristic value.Possible values:
Note: By default, or if this property doesn't exist, this field returns the display values listed above. To return the internal value instead (matching the value format the TMF622 Product Order API already uses by default), create a true/false system property named sn_prd_invt.enableseamlessvaluetype and set it to Default: Data type: String |
|
productOffering |
Product offering that the product inventory is associated with.Data type: Object Text |
|
productOffering.id |
Sys_id of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] |
|
productOffering.name |
Name of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] |
|
productRelationship |
List of related products.Data type: Array of Objects Text |
|
productRelationship.productId |
Sys_id of the related product.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
productRelationship.relationshipType |
Type of relationship.Data type: String |
|
productSpecification |
Product specification for the product.Data type: Object Text |
|
productSpecification.id |
Sys_id of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] |
|
realizingResource |
Realizing resource.Data type: Object Text |
|
realizingResource.id |
Sys_id of the realizing resource.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
realizingResource.type |
Type of the realizing resource.Data type: String |
|
realizingService |
Realizing service.Data type: Object Text |
|
realizingService.id |
Sys_id of the realizing service.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
realizingService.type |
Type of the realizing service.Data type: String |
|
relatedParty |
List of parties associated with the ticket.Data type: Array of Objects Text |
|
relatedParty.id |
Sys_id of the account or customer contact associated with the ticket.Data type: String Table: Account [customer_account], Contact [customer_contact] or Consumer [csm_consumer] |
|
relatedParty.@referredType |
Type of related party. Value is always |
|
relatedParty.type |
Type of customer.Possible values:
Data type: String |
|
status |
Current state of the product.Data type: String |
This example retrieves all product inventories.
curl "https://instance.servicenow.com/api/sn_prd_invt/productinventory" \--request GET \--user 'username':'password'Response body.
[ { "id": "075072aec3a83010abc8b5183c40dd44", "relatedParty": [ { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" } ], "name": "Firewall Administration PI0000300", "productSpecification": { "id": "31c5caff07266010a7955b7e0ad3006b", "name": "Firewall Administration" }, "status": "Active", "productOffering": { "id": "", "name": "" }, "place": { "id": "920cf6ac73d423002728660c4cf6a799", "name": "200 South James street,Atlanta, GA" }, "productCharacteristic": [ { "name": "Firewall Administration CPE Type", "valueType": "Choice", "value": "Physical" }, { "name": "Configuration and Policy backup", "valueType": "Choice", "value": "" }, { "name": "Firewall Administration CPE ID", "valueType": "Single Line Text", "value": "CPE123456789" }, { "name": "Remote CLI troubleshoot support", "valueType": "Choice", "value": "" }, { "name": "Firewall Administration CPE Model", "valueType": "Choice", "value": "9300 series" } ], "productRelationship": [], "realizingService": [], "realizingResource": [ { "id": "3546463307666010a7955b7e0ad3005d", "name": "Cisco Firewall Management system" } ] }, { "id": "0303a8ea74418510f877ca57242ff96d", "relatedParty": [ { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" } ], "name": "SD-WAN Edge Device PI0001114", "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device" }, "status": "Installation Pending", "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "place": "", "productCharacteristic": [], "productRelationship": [], "realizingService": [ { "id": "bf65eadc1b7420106ba59acf034bcb57", "name": "SD-WAN Routing" }, { "id": "16d79ec3532520103b6bddeeff7b12a6", "name": "SD WAN Optimization Service" }, { "id": "16d79ec3532520103b6bddeeff7b12a6", "name": "SD WAN Optimization Service" }, { "id": "bf65eadc1b7420106ba59acf034bcb57", "name": "SD-WAN Routing" }, { "id": "bf65eadc1b7420106ba59acf034bcb57", "name": "SD-WAN Routing" }, { "id": "bf65eadc1b7420106ba59acf034bcb57", "name": "SD-WAN Routing" } ], "realizingResource": [ { "id": "493fa60b536520103b6bddeeff7b12b6", "name": "Customer Premise SD-WAN Router" } ] }]Product Inventory Open API - GET /sn_prd_invt/productinventory/{inventoryId}
Retrieves a product inventory.
Important: Starting with the Tokyo release, this endpoint is deprecated. The new version of this endpoint is Product Inventory Open API - GET /sn_prd_invt/product/{id}.
URL format
Default URL: /api/sn_prd_invt/productinventory/{inventoryId}
Supported request parameters
|
Name |
Description |
|---|---|
|
inventoryId |
Sys_id of the product inventory to retrieve.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
Name |
Description |
|---|---|
|
account |
Filter product inventories by account. Only inventories associated with the specified account are returned in the response.Data type: String Default: Don't filter by account. |
|
billingAccount |
Filter product inventories by billing account. Only inventories associated with the specified billing account are returned in the response.Data type: String Default: Don't filter by billing account |
|
contact and consumer (Related Party) |
Filter product inventories by associated contact or related party. Only inventories linked to the specified contact or consumer record are returned in the response.Data type: String Default: Don't filter by contact or consumer |
|
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 |
|
externalID |
Filter product inventories by external identifier. Only inventories with an externalID matching the value of this parameter are returned in the response. Data type: String Default: Don't filter by externalID |
|
fields |
List of fields to return in the response. Invalid fields are ignored.Data type: String Default: All fields returned. |
|
place |
Filter product inventories by location.Data type: Object Text |
|
place.id |
Sys_id or external id of the location associated with the product inventory record.Data type: String Table: Location [cmn_location] Field: sys_id or sn_tmt_core_external_id |
|
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 |
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.
| Header | Description |
|---|---|
| None |
| 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.
|
Status code |
Description |
|---|---|
|
200 |
Request successfully processed. |
|
400 |
Bad Request. Could be any of the following reasons: - Invalid path parameter
|
|
404 |
Record not found. Record associated with the ID is not found in the table. |
|
Name |
Description |
|---|---|
|
id |
Sys_id of the product inventory Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
name |
Name of the product inventory.Data type: String |
|
place |
Place associated with the product.Data type: Object Text |
|
place.id |
Location sys_id or external_id of the product inventory.Table: Location [cmn_location] Data: String |
|
place.name |
Name of the location associated with the product inventory.Table: Location [cmn_location] Data: String |
|
productCharacteristic |
List of product characteristics.For additional information on product characteristics, see Create a product offering category. Data type: Array of Objects JSON |
|
productCharacteristic.name |
Name of the characteristic.Data type: String |
|
productCharacteristic.value |
Value of the characteristic.Data type: String |
|
productCharacteristic.valueType |
Type of characteristic value.Possible values:
Note: By default, or if this property doesn't exist, this field returns the display values listed above. To return the internal value instead (matching the value format the TMF622 Product Order API already uses by default), create a true/false system property named sn_prd_invt.enableseamlessvaluetype and set it to Default: Data type: String |
|
productOffering |
Product offering that the product inventory is associated with.Data type: Object Text |
|
productOffering.id |
Sys_id of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] |
|
productOffering.name |
Name of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] |
|
productRelationship |
List of related products.Data type: Array of Objects Text |
|
productRelationship.productId |
Sys_id of the related product.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
productRelationship.relationshipType |
Type of relationship.Data type: String |
|
productSpecification |
Product specification for the product.Data type: Object Text |
|
productSpecification.id |
Sys_id of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] |
|
realizingResource |
Realizing resource.Data type: Object Text |
|
realizingResource.id |
Sys_id of the realizing resource.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
realizingResource.type |
Type of the realizing resource.Data type: String |
|
realizingService |
Realizing service.Data type: Object Text |
|
realizingService.id |
Sys_id of the realizing service.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
realizingService.type |
Type of the realizing service.Data type: String |
|
relatedParty |
List of parties associated with the ticket.Data type: Array of Objects Text |
|
relatedParty.id |
Sys_id of the account or customer contact associated with the ticket.Data type: String Table: Account [customer_account], Contact [customer_contact], or Consumer [csm_consumer] |
|
relatedParty.@referredType |
Type of related party. Value is always |
|
relatedParty.type |
Type of customer.Possible values:
Data type: String |
|
status |
Current state of the product.Data type: String |
This example retrieves a product inventory for an SD-WAN service package.
curl --location --request GET 'https:// instance.servicenow.com/api/sn_prd_invt/productinventory/074450fc74918d10f877ca57242ff9e3' \--user 'username':'password'Output:
{ "id": "074450fc74918d10f877ca57242ff9e3", "relatedParty": [ { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" } ], "name": "SD-WAN Service Package PI0001576", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package" }, "status": "Installation Pending", "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "place": "", "productCharacteristic": [], "productRelationship": [ { "id": "a74490fc74918d10f877ca57242ff942", "name": "SD-WAN Edge Device PI0001582", "relationshipType": "Bundles" }, { "id": "b85414fc74918d10f877ca57242ff90e", "name": "SD-WAN Controller PI0001602", "relationshipType": "Bundles" }, { "id": "d74490fc74918d10f877ca57242ff907", "name": "SD-WAN Security PI0001577", "relationshipType": "Bundles" } ], "realizingService": [], "realizingResource": []}Product Inventory Open API – PATCH /sn_prd_invt/order/product/{id}
Updates a specified product inventory record.
URL format
Default URL: /api/sn_prd_invt/order/product/{id}
Supported request parameters
|
Name |
Description |
|---|---|
|
id |
Sys_id of the product inventory to update.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
Name |
Description |
|---|---|
|
bundle |
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
Data type: Boolean |
|
name |
Name of the product inventory.Data type: String |
|
place |
Location of the product.Data type: Array Text |
|
place.id |
Location sys_id or external id.Data type: String Table: Location [cmn_location] Field: sys_id or sn_tmt_core_external_id |
|
place.name |
Name of the location.Data type: String Table: Location [cmn_location] Field: name |
|
productOffering |
Product offering that the product inventory is associated with.Data type: Object JSON |
|
productOffering.@referredType |
This value is always |
|
productOffering.id |
Initial version or external ID of the product offering. Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: initial_version or external_id |
|
productOffering.internalId |
Internal version of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: internal_version |
|
productOffering.internalVersion |
Version of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: version |
|
productOffering.name |
Name of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: name |
|
productOffering.status |
Status of the product offering.Possible values:
Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: status |
|
productOffering.version |
External version of the product offering. Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: external_version |
|
relatedParty |
List of parties associated with the ticket.Data type: Array of Objects JSON |
|
relatedParty.@referredType |
Type of related party.Possible values:
Data type: String |
|
relatedParty.@type |
This value is always |
|
relatedParty.id |
Sys_id of the account or customer contact associated with the ticket.Data type: String Table: Account [customer_account], Contact [customer_contact], or Consumer [csm_consumer] |
|
relatedParty.name |
Name of the of the account or customer contact associated with the ticket.Data type: String Table: Account [customer_account], Contact [customer_contact], or Consumer [csm_consumer] |
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.
| Header | Description |
|---|---|
| Accept | Data format of the response body. Only supports application/json. |
| Content-Type | Data format of the request body. Only supports application/json. |
| Header | Description |
|---|---|
| None |
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.
| Status code | Description |
|---|---|
| 200 | Successful. The request was successfully processed. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 404 | Not found. The requested item wasn't found. |
Response body parameters (JSON)
|
Name |
Description |
|---|---|
|
bundle |
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
Data type: Boolean |
|
name |
Name of the product inventory.Data type: String |
|
place |
Location of the product.Data type: Array Text |
|
place.id |
Location sys_id or external id.Data type: String Table: Location [cmn_location] Field: sys_id or sn_tmt_core_external_id |
|
place.name |
Name of the location.Data type: String Table: Location [cmn_location] Field: name |
|
productOffering |
Product offering that the product inventory is associated with.Data type: Object JSON |
|
productOffering.@referredType |
This value is always |
|
productOffering.id |
Initial version or external ID of the product offering. Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: initial_version or external_id |
|
productOffering.internalId |
Internal version of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: internal_version |
|
productOffering.internalVersion |
Version of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: version |
|
productOffering.name |
Name of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: name |
|
productOffering.status |
Status of the product offering.Possible values:
Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: status |
|
productOffering.version |
External version of the product offering. Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: external_version |
|
relatedParty |
List of parties associated with the ticket.Data type: Array of Objects JSON |
|
relatedParty.@referredType |
Type of related party.Possible values:
Data type: String |
|
relatedParty.@type |
This value is always |
|
relatedParty.id |
Sys_id of the account or customer contact associated with the ticket.Data type: String Table: Account [customer_account], Contact [customer_contact], or Consumer [csm_consumer] |
|
relatedParty.name |
Name of the of the account or customer contact associated with the ticket.Data type: String Table: Account [customer_account], Contact [customer_contact], or Consumer [csm_consumer] |
This example updates a product inventory record.
curl "https://instance.service-now.com/api/sn_prd_invt/product/036e506510322250f8777d910acbd77f" \ --request PATCH \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\": \"Internet Plan\", \"productOffering\": { \"@referredType\": \"ProductOffering\", \"name\": \"Premium SD-WAN Offering\", \"id\": \"0361dd9fd0a63110f8770dbf976be16f\" }, \"relatedParty\": [ { \"@referredType\": \"CustomerContact\", \"@type\": \"RelatedParty\", \"name\": \"Sally Thomas\", \"id\": \"f3af54c413651200042ab3173244b053\" }, { \"@referredType\": \"Customer\", \"@type\": \"RelatedParty\", \"name\": \"Funco Intl\", \"id\": \"ffc68911c35420105252716b7d40dd55\" } ], \"bundle\": false, \"place\": [ { \"id\": \"25ab9c4d0a0a0bb300f7dabdc0ca7c1c\", \"name\": \"100 South Charles Street, Baltimore, MD\" } ] }" \ --user 'username':'password'Response body.
{ "name": "Internet Plan", "productOffering": { "@referredType": "ProductOffering", "name": "Premium SD-WAN Offering", "id": "0361dd9fd0a63110f8770dbf976be16f", "internalVersion": "1", "version": "", "status": "published", "internalId": "0361dd9fd0a63110f8770dbf976be16f" }, "relatedParty": [ { "@referredType": "CustomerContact", "@type": "RelatedParty", "name": "Sally Thomas", "id": "f3af54c413651200042ab3173244b053" }, { "@referredType": "Customer", "@type": "RelatedParty", "name": "Funco Intl", "id": "ffc68911c35420105252716b7d40dd55" } ], "bundle": false, "place": [ { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "name": "100 South Charles Street, Baltimore, MD" } ], "productPrice": [], "id": "036e506510322250f8777d910acbd77f", "href": "/api/sn_prd_invt/product/036e506510322250f8777d910acbd77f"}Product Inventory Open API - POST /sn_prd_invt/product
Creates a product inventory record.
URL format
Default URL: /api/sn_prd_invt/product
Supported request parameters
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| None |
|
Name |
Description |
|---|---|
|
bundle |
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
Data type: Boolean Default: false |
|
isBundle |
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
Data type: Boolean Default: false |
|
name |
Required. Name of the product inventory.Data type: String |
|
pid |
Unique identifier for the product inventory from the external system.Data type: String Default: Blank string |
|
productCharacteristic |
List of product characteristics.For additional information on product characteristics, see Create a product offering category. Data type: Array of Objects JSON |
|
productCharacteristic.name |
Name of the characteristic.Data type: String Default: Blank string |
|
productCharacteristic.value |
Value of the characteristic.Data type: String Default: Blank string |
|
productCharacteristic.valueType |
Type of characteristic value.Possible values:
Note: By default, or if this property doesn't exist, this field returns the display values listed above. To return the internal value instead (matching the value format the TMF622 Product Order API already uses by default), create a true/false system property named sn_prd_invt.enableseamlessvaluetype and set it to Default: Data type: String |
|
productOffering |
Required. Product offering that the product inventory is associated with.Data type: Object JSON |
|
productOffering.id |
Required. Initial_version or external_id of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] |
|
productOffering.internalVersion |
Version of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: version |
|
productOffering.name |
Name of the product offering.Data type: String Default: Blank string Table: Product Offering [sn_prd_pm_product_offering] |
|
productOffering.version |
External version of the product offering. Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: external_version |
|
productRelationship |
List of related products.Data type: Array of Objects Text |
|
productRelationship.productId |
Required if using the productRelationship parameter. Sys_id of the related product.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
productRelationship.relationshipType |
Type of relationship. The only valid value is Data type: String Default: Blank string |
|
productSpecification |
Required. Product specification for the product.Data type: Object JSON |
|
productSpecification.id |
Required. Initial_version or external_id of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] |
|
productSpecification.internalVersion |
Version of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: version |
|
productSpecification.version |
External version of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: external_version |
|
realizingResource |
Resource that realizes the product. The realizing resource is a child product inventory of this product inventory.Data type: Object Text |
|
realizingResource.id |
Required if using the realizingResource parameter. Sys_id of the realizing resource. 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 Text |
|
realizingService.id |
Required if using the realizingService parameter. Sys_id of the realizing service. 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 of Objects Text |
|
relatedParty.@referredType |
Type of customer.Possible values:
Data type: String Default: Blank string |
|
relatedParty.id |
Required if using the relatedParty parameter. Sys_id of the account or customer contact associated with the ticket.Data type: String Table: Account [customer_account], Contact [customer_contact], or Consumer [csm_consumer] |
|
state |
Current state of the product.Possible values:
Data type: String Default: installation_pending |
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.
| Header | Description |
|---|---|
| Accept | Data format of the response body. Only supports application/json. |
| Content-Type | Data format of the request body. Only supports application/json. |
| 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.
|
Status code |
Description |
|---|---|
|
201 |
Request successfully processed. |
|
400 |
Bad Request. Could be any of the following reasons: - Empty payload.
|
|
Name |
Description |
|---|---|
|
bundle |
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
Data type: Boolean |
|
href |
Relative link to the product inventory record.Data type: String |
|
id |
Sys_id of the product inventory.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
isBundle |
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
Data type: Boolean |
|
name |
Name of the product inventory.Data type: String |
|
pid |
Unique identifier for the product inventory from the external system.Data type: String |
|
productCharacteristic |
List of product characteristics.Data type: Array of Objects Text |
|
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 JSON |
|
productOffering.id |
Initial version or external ID of the product offering. Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: initial_version or external_id |
|
productOffering.internalId |
Internal version of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: internal_version |
|
productOffering.internalVersion |
Version of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: version |
|
productOffering.name |
Name of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] |
|
productOffering.version |
External version of the product offering. Data type: String Table: Product Offering [sn_prd_pm_product_offering] Field: external_version |
|
productPrice |
Returns an empty array.Data type: Array |
|
productRelationship |
List of related products.Data type: Array of Objects Text |
|
productRelationship.productId |
Sys_id of the related product.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
productRelationship.relationshipType |
Type of relationship.Data type: String |
|
productSpecification |
Product specification for the product.Data type: Object JSON |
|
productSpecification.id |
Initial version or external ID of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: internal_version or external_id |
|
productSpecification.internalId |
Initial version of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: initial_version |
|
productSpecification.internalVersion |
Version of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: version |
|
productSpecification.version |
External version of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] Field: external_version |
|
realizingResource |
Resource that realizes the product. The realizing resource is a child product inventory of this product inventory.Data type: Object Text |
|
realizingResource.id |
Sys_id of the realizing resource. Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
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 Text |
|
realizingService.id |
Sys_id of the realizing service. Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
realizingService.type |
Type of the realizing service.Valid value: child Data type: String |
|
relatedParty |
List of parties associated with the ticket.Data type: Array of Objects Text |
|
relatedParty.@referredType |
Type of related party. Value is always |
|
relatedParty.id |
Sys_id of the account or customer contact associated with the ticket.Data type: String Table:Account [customer_account], Contact [customer_contact], or Consumer [csm_consumer] |
|
relatedParty.type |
Type of customer.Possible values:
Data type: String |
|
status |
Current state of the product.Data type: String |
This example creates a product inventory for a voice over IP solution for a user.
curl -X POST "https://instance.service-now.com/api/sn_prd_invt/product" \--header "Accept: application/json" \--header "Content-Type: application/json" \--user "username":"password" \--data "[ { "pid": "PO-456", "description": "inventory description", "isBundle": false, "name": "Voice Over IP Basic instance for Jean", "productOffering": { "@referredType": "ProductOffering", "name": "Premium SD-WAN Offering", "id": "69017a0f536520103b6bddeeff7b127d" }, "productCharacteristic": [], "productRelationship": [ { "productId": "fa6d13f45b5620102dff5e92dc81c77f", "relationshipType": "child" } ], "realizingService": { "id": "fe6d13f45b5620102dff5e92dc81c786", "relationshipType": "child" }, "realizingResource": { "id": "326d13f45b5620102dff5e92dc81c78c", "relationshipType": "child" }, "relatedParty": [ { "@referredType": "CustomerContact", "@type": "RelatedParty", "name": "Sally Thomas", "id": "eaf68911c35420105252716b7d40ddde" }, { "@referredType": "Customer", "@type": "RelatedParty", "name": "Funco Intl", "id": "ffc68911c35420105252716b7d40dd55" } ], "productSpecification": { "@referredType": "ProductSpecification", "@type": null, "name": null, "id": "3ee1fdb1c3331010d216b5183c40dd81", "internalVersion": "1" }, "bundle": false }]"Response body.
{ "pid": "PO-456", "description": "inventory description", "isBundle": false, "name": "Voice Over IP Basic instance for Jean", "productOffering": { "@referredType": "ProductOffering", "name": "Premium SD-WAN Offering", "id": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1", "version": null, "status": "published", "internalId": "69017a0f536520103b6bddeeff7b127d" }, "productCharacteristic": [], "productRelationship": [ { "productId": "fa6d13f45b5620102dff5e92dc81c77f", "relationshipType": "child" } ], "realizingService": { "id": "fe6d13f45b5620102dff5e92dc81c786", "relationshipType": "child" }, "realizingResource": { "id": "326d13f45b5620102dff5e92dc81c78c", "relationshipType": "child" }, "relatedParty": [ { "@referredType": "CustomerContact", "@type": "RelatedParty", "name": "Sally Thomas", "id": "eaf68911c35420105252716b7d40ddde" }, { "@referredType": "Customer", "@type": "RelatedParty", "name": "Example Company", "id": "ffc68911c35420105252716b7d40dd55" } ], "productSpecification": { "@referredType": "ProductSpecification", "@type": null, "name": null, "id": "3ee1fdb1c3331010d216b5183c40dd81", "internalVersion": "1", "version": null, "status": "published", "internalId": "3ee1fdb1c3331010d216b5183c40dd81" }, "bundle": false, "productPrice": [], "id": "25b07475471789108761b955d36d439d", "href": "/api/sn_prd_invt/product/25b07475471789108761b955d36d439d"}Product Inventory Open API - POST /sn_prd_invt/productinventory
Creates a product inventory.
Important: Starting with the Tokyo release, this endpoint is deprecated. The new version of this endpoint is Product Inventory Open API - POST /sn_prd_invt/product.
URL format
Default URL: /api/sn_prd_invt/productinventory
Supported request parameters
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| None |
|
Name |
Description |
|---|---|
|
isBundle |
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
Data type: Boolean Default: false |
|
name |
Required. Name of the product inventory.Data type: String |
|
pid |
Unique identifier for the product inventory from the external system.Data type: String Default: Blank string |
|
productCharacteristic |
List of product characteristics.For additional information on product characteristics, see Create a product offering category. Data type: Array of Objects JSON |
|
productCharacteristic.name |
Name of the characteristic.Data type: String Default: Blank string |
|
productCharacteristic.value |
Value of the characteristic.Data type: String Default: Blank string |
|
productCharacteristic.valueType |
Type of characteristic value.Possible values:
Note: By default, or if this property doesn't exist, this field returns the display values listed above. To return the internal value instead (matching the value format the TMF622 Product Order API already uses by default), create a true/false system property named sn_prd_invt.enableseamlessvaluetype and set it to Default: Data type: String |
|
productOffering |
Required. Product offering that the product inventory is associated with.Data type: Object Text |
|
productOffering.id |
Required. Sys_id of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] |
|
productOffering.name |
Name of the product offering.Data type: String Default: Blank string Table: Product Offering [sn_prd_pm_product_offering] |
|
productRelationship |
List of related products.Data type: Array of Objects Text |
|
productRelationship.productId |
Required if using the productRelationship parameter. Sys_id of the related product.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
productRelationship.relationshipType |
Type of relationship. The only valid value is Data type: String Default: Blank string |
|
productSpecification |
Required. Product specification for the product.Data type: Object Text |
|
productSpecification.id |
Required. Sys_id of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] |
|
realizingResource |
Realizing resource.Data type: Object Text |
|
realizingResource.id |
Required if using the realizingResource parameter. Sys_id of the realizing resource.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
realizingResource.type |
Type of the realizing resource.The only valid value is Data type: String Default: Blank string |
|
realizingService |
Realizing service.Data type: Object Text |
|
realizingService.id |
Required if using the realizingService parameter. Sys_id of the realizing service.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
realizingService.type |
Type of the realizing service.The only valid value is Data type: String Default: Blank string |
|
relatedParty |
List of parties associated with the ticket.Data type: Array of Objects Text |
|
relatedParty.@referredType |
Type of customer.Possible values:
Data type: String Default: Blank string |
|
relatedParty.id |
Required if using the relatedParty parameter. Sys_id of the account or customer contact associated with the ticket.Data type: String Table: Account [customer_account], Contact [customer_contact], or Consumer [csm_Consumer] |
|
state |
Current state of the product.Possible values:
Data type: String Default: installation_pending |
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.
| Header | Description |
|---|---|
| Accept | Data format of the response body. Only supports application/json. |
| Content-Type | Data format of the request body. Only supports application/json. |
| 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.
|
Status code |
Description |
|---|---|
|
201 |
Request successfully processed. |
|
400 |
Bad Request. Could be any of the following reasons: - Empty payload.
|
|
Name |
Description |
|---|---|
|
id |
Sys_id of the product inventory.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
isBundle |
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
Data type: Boolean |
|
name |
Name of the product inventory.Data type: String |
|
pid |
Unique identifier for the product inventory from the external system.Data type: String |
|
productCharacteristic |
List of product characteristics.Data type: Array of Objects Text |
|
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 Text |
|
productOffering.id |
Sys_id of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] |
|
productOffering.name |
Name of the product offering.Data type: String Table: Product Offering [sn_prd_pm_product_offering] |
|
productRelationship |
List of related products.Data type: Array of Objects Text |
|
productRelationship.productId |
Sys_id of the related product.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
productRelationship.relationshipType |
Type of relationship.Data type: String |
|
productSpecification |
Product specification for the product.Data type: Object Text |
|
productSpecification.id |
Sys_id of the product specification.Data type: String Table: Product Specification [sn_prd_pm_product_specification] |
|
realizingResource |
Realizing resource.Data type: Object Text |
|
realizingResource.id |
Sys_id of the realizing resourceData type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
realizingResource.type |
Type of the realizing resource.Data type: String |
|
realizingService |
Realizing service.Data type: Object Text |
|
realizingService.id |
Sys_id of the realizing service.Data type: String Table: Product Inventory [sn_prd_invt_product_inventory] |
|
realizingService.type |
Type of the realizing service.Data type: String |
|
relatedParty |
List of parties associated with the ticket.Data type: Array of Objects Text |
|
relatedParty.id |
Sys_id of the account or customer contact associated with the ticket.Data type: String Table: Account [customer_account], Contact [customer_contact], or Consumer [csm_consumer] |
|
relatedParty.@referredType |
Type of customer.Possible values:
Data type: String |
|
state |
Current state of the product.Data type: String |
This example creates a product inventory for a voice over IP solution for a user.
curl --location --request POST "https://instance.servicenow.com/api/sn_prd_invt/productinventory" \--header "Content-Type: application/json" \--data-raw '[ { "pid": "demoInventory", "description": "inventory description", "isBundle": false, "name": "Voice Over IP Basic instance for Jean", "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "@referredType": "ProductOffering" }, "productCharacteristic": [ { "name": "CPE Type", "valueType": "choice", "value": "Virtual" }, { "name":"Routing", "valueType": "choice", "value": "Premium" } ], "productRelationship": [ { "productId": "7e6d13f45b5620102dff5e92dc81c787", "relationshipType": "child" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "role": "User", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" } ], "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "@referredType": "ProductSpecification", "version": "1" } }]'--user 'username':'password'Response body.
{ "pid": "demoInventory", "description": "inventory description", "isBundle": false, "name": "Voice Over IP Basic instance for Jean", "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "@referredType": "ProductOffering" }, "productCharacteristic": [ { "name": "CPE Type", "valueType": "choice", "value": "Virtual" }, { "name": "Routing", "valueType": "choice", "value": "Premium" } ], "productRelationship": [ { "productId": "7e6d13f45b5620102dff5e92dc81c787", "relationshipType": "child" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "role": "User", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" } ], "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "@referredType": "ProductSpecification", "version": "1" }, "id": "3ac715c6745d8150f877ca57242ff97a"}---
title: Product Inventory Open API
description: The Product Inventory Open API provides endpoints to create and retrieve product inventories.Deletes a specified product inventory record.Retrieves a list of all product inventories.Retrieves a specified product inventory record.Retrieves a list of all product inventories.Retrieves a product inventory.Updates a specified product inventory record.Creates a product inventory record.Creates a product inventory.
locale: en-US
canonical_url: https://www.servicenow.com/docs/r/api-reference/rest-apis/product-inventory-open-api.html
release: brazil
product: REST APIs
classification: rest-apis
topic_type: concept
last_updated: "2026-09-10"
reading_time_minutes: 52
breadcrumb: [REST API reference, API reference, API implementation and reference]
---
# 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 User Guide v5.0.0](https://www.tmforum.org/resources/specifications/tmf637-product-inventory-management-api-user-guide-v5-0-0/), September 2024. The Product Inventory Open API is conformance certified by TM Forum.
\[Omitted image "tmf-conformance.png"\] Alt text: TMF conformance logo
**Note:** By default, POST /sn\_prd\_invt/product accepts and returns a single JSON object. `GET` endpoints return **status** as a display label, such as `Installation pending`, and the product reference field is named **product**. To change the default behavior, create a system property **sn\_prd\_invt.tmf637.version4** and set the value to `true`. When `true`, POST /sn\_prd\_invt/product accepts and returns a JSON array. `GET` endpoints return **status** as an internal value, such as `installation_pending`, and the product reference field is named **productId**. Set the property to `false` to return to the default behavior.
**Note:** By default, `GET` endpoints on this API return **valueType** as a display value, such as `Choice`. To change the default behavior and return the backend value instead \(for example, `choice`\) — matching the format used by the [Product Order Open API](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-apis/tmf622_product_ordering-api.md) — create a system property **sn\_prd\_invt.enableseamlessvaluetype** and set the value to `true`. Set the property to `false`, or leave it unset, to return to the default behavior.
**Parent Topic:**[REST API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-apis/api-rest.md)
## Product Inventory Open API – DELETE /sn\_prd\_invt/order/product/\{id\}
Deletes a specified product inventory record.
### URL format
Default URL: `/api/sn_prd_invt/order/product/{id}`
### Supported request parameters
<table class="rest_api_path_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
id
</td><td>
Sys\_id of the product inventory to delete.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr></tbody>
</table>|Name|Description|
|----|-----------|
|None| |
|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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Header|Description|
|------|-----------|
|Accept|Data format of the response body. Only supports **application/json**.|
|Header|Description|
|------|-----------|
|None| |
### 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|204|No Content. Record successfully deleted.|
|400|Bad Request. A bad request type or malformed request was detected.|
### Response body parameters \(JSON\)
|Name|Description|
|----|-----------|
|None||
### cURL request
This example deletes a product inventory record.
```
curl "https://instance.service-now.com/api/sn_prd_invt/product/01b2f9972b8c72d07a83f395f291bf53" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'
```
No response body is returned when a product inventory record is successfully deleted.
## 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
|Name|Description|
|----|-----------|
|None| |
<table id="table_pfr_vgy_fsb" class="rest_api_query_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
account
</td><td>
Filter product inventories by account. Only inventories associated with the specified account are returned in the response.Data type: String
Default: Don't filter by account.
</td></tr><tr><td>
billingAccount
</td><td>
Filter product inventories by billing account. Only inventories associated with the specified billing account are returned in the response.Data type: String
Default: Don't filter by billing account
</td></tr><tr><td>
contact and consumer \(Related Party\)
</td><td>
Filter product inventories by associated contact or related party. Only inventories linked to the specified contact or consumer record are returned in the response.Data type: String
Default: Don't filter by contact or consumer
</td></tr><tr><td>
customer
</td><td>
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
Default: Don't filter by customer.
</td></tr><tr><td>
externalID
</td><td>
Filter product inventories by external identifier. Only inventories with an externalID matching the value of this parameter are returned in the response. Data type: String
Default: Don't filter by externalID
</td></tr><tr><td>
fields
</td><td>
List of fields to return in the response. Invalid fields are ignored.Data type: String
Default: Return all fields.
</td></tr><tr><td>
limit
</td><td>
Maximum number of records to return. For requests that exceed this number of records, use the **offset** parameter to paginate record retrieval. Data type: Number
Default: 20
Maximum: 100
</td></tr><tr><td>
offset
</td><td>
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.Data type: Number
Default: 0
</td></tr><tr><td>
place
</td><td>
Filter product inventories by location.Data type: Object
```
"place": {
"id": "String"
}
```
</td></tr><tr><td>
place.id
</td><td>
Sys\_id or external id of the location associated with the product inventory record.Data type: String
Table: Location \[cmn\_location\]
Field: sys\_id or sn\_tmt\_core\_external\_id
</td></tr><tr><td>
status
</td><td>
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
Default: Don't filter by status.
</td></tr></tbody>
</table>|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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Header|Description|
|------|-----------|
|None| |
<table id="table_idy_qgm_lsb" class="rest_api_response_headers"><thead><tr><th>
Header
</th><th>
Description
</th></tr></thead><tbody><tr id="content-range-row"><td>
Content-Range
</td><td>
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`.
</td></tr><tr id="content-type-row"><td>
Content-Type
</td><td>
Data format of the response body. Only supports **application/json**.
</td></tr><tr id="links-pagination-row"><td>
Link
</td><td>
Contains the following links to navigate through query results.- first
- last
- next
- previous
</td></tr><tr id="x-total-count-row"><td id="x-total-count">
X-Total-Count
</td><td>
For paginated queries, this header specifies the total number of records available on the server.
</td></tr></tbody>
</table>### 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table id="table_hl1_rcm_lsb"><thead><tr><th>
Status code
</th><th>
Description
</th></tr></thead><tbody><tr><td>
200
</td><td id="tmf-get-status-200-entry">
Request successfully processed. Full resource returned in response \(no pagination\).
</td></tr><tr><td>
206
</td><td id="tmf-get-status-206-entry">
Partial resource returned in response \(with pagination\).
</td></tr><tr><td>
400
</td><td id="tmf-get-status-400-entry">
Bad request. Possible reasons:
- Invalid path parameter
- Invalid URI
</td></tr><tr><td>
404
</td><td id="tmf-get-status-404-entry">
Record not found. No records matching the query parameters are found in the table.
</td></tr></tbody>
</table>### Response body parameters \(JSON\)
<table id="table_shr_nvy_3sb"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
href
</td><td>
Relative link to the product inventory record.Data type: String
</td></tr><tr><td>
id
</td><td>
Sys\_id of the product inventory.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
name
</td><td>
Name of the product inventory.Data type: String
</td></tr><tr><td>
place
</td><td>
Location of the product.Data type: Array
```
"place": [
{
"id": "String",
"name": "String"
}
]
```
</td></tr><tr><td>
place.id
</td><td>
Location sys\_id or external id.Data type: String
Table: Location \[cmn\_location\]
Field: sys\_id or sn\_tmt\_core\_external\_id
</td></tr><tr><td>
place.name
</td><td>
Name of the location.Data type: String
Table: Location \[cmn\_location\]
Field: name
</td></tr><tr><td>
productCharacteristic
</td><td>
List of product characteristics.For additional information on product characteristics, see [Create a product offering category](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/order-management/som-create-product-offering-category.md).
Data type: Array of Objects
```
"productCharacteristic": [
{
"name": "String",
"value": "String",
"valueType": "String"
}
]
```
</td></tr><tr><td>
productCharacteristic.name
</td><td>
Name of the characteristic.Data type: String
</td></tr><tr><td>
productCharacteristic.value
</td><td>
Value of the characteristic.Data type: String
</td></tr><tr><td>
productCharacteristic.valueType
</td><td>
Type of characteristic value.Possible values:
- `Address`
- `Array Date`
- `Array Datetime`
- `Array Decimal`
- `Array Integer`
- `Array Object`
- `Array Single Line Test`
- `CheckBox`
- `Choice`
- `Date`
- `Date / Time`
- `Email`
- `Integer`
- `Object`
- `Single Line Text`
- `Yes / No`
**Note:** By default, or if this property doesn't exist, this field returns the display values listed above. To return the internal value instead \(matching the value format the TMF622 Product Order API already uses by default\), create a true/false system property named **sn\_prd\_invt.enableseamlessvaluetype** and set it to `true`: `address`, `array.date`, `array.datetime`, `array.decimal`, `array.integer`, `array.object`, `array.single_line_text`, `attachment`, `checkbox`, `choice`, `date`, `date_time`, `decimal`, `duration`, `email`, `integer`, `object`, `single_line_text`, `yes_no`.
Default: `false`
Data type: String
</td></tr><tr><td>
productId
</td><td>
Sys\_id of the product model for the product inventory.Data type: String
Table: Product Model \[cmdb\_model\]
</td></tr><tr><td>
productOffering
</td><td>
Product offering that the product inventory is associated with.Data type: Object
```
"productOffering": {
"id": "String",
"internalId": "String",
"internalVersion": "String",
"name": "String",
"version": "String"
}
```
</td></tr><tr><td>
productOffering.id
</td><td>
Initial version or external ID of the product offering. Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: initial\_version or external\_id
</td></tr><tr><td>
productOffering.internalId
</td><td>
Internal version of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: internal\_version
</td></tr><tr><td>
productOffering.internalVersion
</td><td>
Version of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: version
</td></tr><tr><td>
productOffering.name
</td><td>
Name of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
</td></tr><tr><td>
productOffering.version
</td><td>
External version of the product offering. Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: external\_version
</td></tr><tr><td>
productPrice
</td><td>
Returns an empty array.Data type: Array
</td></tr><tr><td>
productRelationship
</td><td>
List of related products.Data type: Array of Objects
```
"productRelationship": [
{
"productId": "String",
"relationshipType": "String"
}
]
```
</td></tr><tr><td>
productRelationship.productId
</td><td>
Sys\_id of the related product.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
productRelationship.relationshipType
</td><td>
Type of relationship.Data type: String
</td></tr><tr><td>
productSpecification
</td><td>
Product specification for the product.Data type: Object
```
"productSpecification": {
"id": "String",
"internalId": "String",
"internalVersion": "String",
"version": "String"
}
```
</td></tr><tr><td>
productSpecification.id
</td><td>
Initial version or external ID of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: internal\_version or external\_id
</td></tr><tr><td>
productSpecification.internalId
</td><td>
Initial version of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: initial\_version
</td></tr><tr><td>
productSpecification.internalVersion
</td><td>
Version of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: version
</td></tr><tr><td>
productSpecification.version
</td><td>
External version of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: external\_version
</td></tr><tr><td>
realizingResource
</td><td>
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"
}
```
</td></tr><tr><td>
realizingResource.id
</td><td>
Sys\_id of the realizing resource. Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingResource.type
</td><td>
Type of the realizing resource.Valid value: child
Data type: String
</td></tr><tr><td>
realizingService
</td><td>
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"
}
```
</td></tr><tr><td>
realizingService.id
</td><td>
Sys\_id of the realizing service. Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingService.type
</td><td>
Type of the realizing service.Valid value: child
Data type: String
</td></tr><tr><td>
relatedParty
</td><td>
List of parties associated with the ticket.Data type: Array of Objects
```
"relatedParty": [
{
"id": "String",
"@referredType": "String"
}
]
```
</td></tr><tr><td>
relatedParty.id
</td><td>
Sys\_id of the account or customer contact associated with the ticket.Data type: String
Table: Account \[customer\_account\], Contact \[customer\_contact\], or Consumer \[csm\_consumer\]
</td></tr><tr><td>
relatedParty.@referredType
</td><td>
Type of customer.Possible values:
- Consumer
- Customer
- CustomerContact
Data type: String
</td></tr><tr><td>
state
</td><td>
Current state of the product.Data type: String
</td></tr></tbody>
</table>### 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"
},
"productId": "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 id="table_apt_nkz_gsb" class="rest_api_path_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
id
</td><td>
Sys\_id of the product inventory to retrieve.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr></tbody>
</table><table id="table_pfr_vgy_fsb" class="rest_api_query_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
account
</td><td>
Filter product inventories by account. Only inventories associated with the specified account are returned in the response.Data type: String
Default: Don't filter by account.
</td></tr><tr><td>
billingAccount
</td><td>
Filter product inventories by billing account. Only inventories associated with the specified billing account are returned in the response.Data type: String
Default: Don't filter by billing account
</td></tr><tr><td>
contact and consumer \(Related Party\)
</td><td>
Filter product inventories by associated contact or related party. Only inventories linked to the specified contact or consumer record are returned in the response.Data type: String
Default: Don't filter by contact or consumer
</td></tr><tr><td>
customer
</td><td>
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
Default: Don't filer y customer.
</td></tr><tr><td>
externalID
</td><td>
Filter product inventories by external identifier. Only inventories with an externalID matching the value of this parameter are returned in the response. Data type: String
Default: Don't filter by externalID
</td></tr><tr><td>
fields
</td><td>
List of fields to return in the response. Invalid fields are ignored.Data type: String
Default: All fields returned.
</td></tr><tr><td>
place
</td><td>
Filter product inventories by location.Data type: Object
```
"place": {
"id": "String"
}
```
</td></tr><tr><td>
place.id
</td><td>
Sys\_id or external id of the location associated with the product inventory record.Data type: String
Table: Location \[cmn\_location\]
Field: sys\_id or sn\_tmt\_core\_external\_id
</td></tr><tr><td>
status
</td><td>
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
Default: Don't filter by status.
</td></tr></tbody>
</table>|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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Header|Description|
|------|-----------|
|None| |
|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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table id="table_nxj_ykz_gsb"><thead><tr><th>
Status code
</th><th>
Description
</th></tr></thead><tbody><tr><td>
200
</td><td>
Request successfully processed.
</td></tr><tr><td>
400
</td><td>
Bad Request. Could be any of the following reasons:
- Invalid path parameter
- Invalid URI
</td></tr><tr><td>
404
</td><td>
Record not found. Record associated with the ID is not found in the table.
</td></tr></tbody>
</table>### Response body parameters \(JSON\)
<table id="table_shr_nvy_3sb"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
billingAccount
</td><td>
Billing account of the product inventory record.Data type: String
</td></tr><tr><td>
href
</td><td>
Relative link to the product inventory record.Data type: String
</td></tr><tr><td>
id
</td><td>
Sys\_id of the product inventoryData type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
name
</td><td>
Name of the product inventory.Data type: String
</td></tr><tr><td>
place
</td><td>
Location of the product.Data type: Array
```
"place": [
{
"id": "String",
"name": "String"
}
]
```
</td></tr><tr><td>
place.id
</td><td>
Location sys\_id or external id.Data type: String
Table: Location \[cmn\_location\]
Field: sys\_id or sn\_tmt\_core\_external\_id
</td></tr><tr><td>
place.name
</td><td>
Name of the location.Data type: String
Table: Location \[cmn\_location\]
Field: name
</td></tr><tr><td>
productCharacteristic
</td><td>
List of product characteristics.For additional information on product characteristics, see [Create a product offering category](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/order-management/som-create-product-offering-category.md).
Data type: Array of Objects
```
"productCharacteristic": [
{
"name": "String",
"value": "String",
"valueType": "String"
}
]
```
</td></tr><tr><td>
productCharacteristic.name
</td><td>
Name of the characteristic.Data type: String
</td></tr><tr><td>
productCharacteristic.value
</td><td>
Value of the characteristic.Data type: String
</td></tr><tr><td>
productCharacteristic.valueType
</td><td>
Type of characteristic value.Possible values:
- `Address`
- `Array Date`
- `Array Datetime`
- `Array Decimal`
- `Array Integer`
- `Array Object`
- `Array Single Line Test`
- `CheckBox`
- `Choice`
- `Date`
- `Date / Time`
- `Email`
- `Integer`
- `Object`
- `Single Line Text`
- `Yes / No`
**Note:** By default, or if this property doesn't exist, this field returns the display values listed above. To return the internal value instead \(matching the value format the TMF622 Product Order API already uses by default\), create a true/false system property named **sn\_prd\_invt.enableseamlessvaluetype** and set it to `true`: `address`, `array.date`, `array.datetime`, `array.decimal`, `array.integer`, `array.object`, `array.single_line_text`, `attachment`, `checkbox`, `choice`, `date`, `date_time`, `decimal`, `duration`, `email`, `integer`, `object`, `single_line_text`, `yes_no`.
Default: `false`
Data type: String
</td></tr><tr><td>
productId
</td><td>
Sys\_id of the product model for the product inventory.Data type: String
Table: Product Model \[cmdb\_model\]
</td></tr><tr><td>
productOffering
</td><td>
Product offering that the product inventory is associated with.Data type: Object
```
"productOffering": {
"id": "String",
"internalId": "String",
"internalVersion": "String",
"name": "String",
"version": "String"
}
```
</td></tr><tr><td>
productOffering.id
</td><td>
Initial version or external ID of the product offering. Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: initial\_version or external\_id
</td></tr><tr><td>
productOffering.internalId
</td><td>
Internal version of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: internal\_version
</td></tr><tr><td>
productOffering.internalVersion
</td><td>
Version of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: version
</td></tr><tr><td>
productOffering.name
</td><td>
Name of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
</td></tr><tr><td>
productOffering.version
</td><td>
External version of the product offering. Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: external\_version
</td></tr><tr><td>
productPrice
</td><td>
Returns an empty array.Data type: Array
</td></tr><tr><td>
productRelationship
</td><td>
List of related products.Data type: Array of Objects
```
"productRelationship": [
{
"productId": "String",
"relationshipType": "String"
}
]
```
</td></tr><tr><td>
productRelationship.productId
</td><td>
Sys\_id of the related product.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
productRelationship.relationshipType
</td><td>
Type of relationship.Data type: String
</td></tr><tr><td>
productSpecification
</td><td>
Product specification for the product.Data type: Object
```
"productSpecification": {
"id": "String",
"internalId": "String",
"internalVersion": "String",
"version": "String"
}
```
</td></tr><tr><td>
productSpecification.id
</td><td>
Initial version or external ID of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: internal\_version or external\_id
</td></tr><tr><td>
productSpecification.internalId
</td><td>
Initial version of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: initial\_version
</td></tr><tr><td>
productSpecification.internalVersion
</td><td>
Version of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: version
</td></tr><tr><td>
productSpecification.version
</td><td>
External version of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: external\_version
</td></tr><tr><td>
realizingResource
</td><td>
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"
}
```
</td></tr><tr><td>
realizingResource.id
</td><td>
Sys\_id of the realizing resource. Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingResource.type
</td><td>
Type of the realizing resource.Valid value: child
Data type: String
</td></tr><tr><td>
realizingService
</td><td>
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"
}
```
</td></tr><tr><td>
realizingService.id
</td><td>
Sys\_id of the realizing service. Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingService.type
</td><td>
Type of the realizing service.Valid value: child
Data type: String
</td></tr><tr><td>
relatedParty
</td><td>
List of parties associated with the ticket.Data type: Array of Objects
```
"relatedParty": [
{
"id": "String",
"@referredType": "String"
}
]
```
</td></tr><tr><td>
relatedParty.id
</td><td>
Sys\_id of the account or customer contact associated with the ticket.Data type: String
Table: Account \[customer\_account\], Contact \[customer\_contact\], or Consumer \[csm\_consumer\]
</td></tr><tr><td>
relatedParty.type
</td><td>
Type of related party. Value is always `Related Party`.Data type: String
</td></tr><tr><td>
relatedParty.@referredType
</td><td>
Type of customer, such as a customer or customer contact.Data type: String
</td></tr><tr><td>
status
</td><td>
Current state of the product.Data type: String
</td></tr></tbody>
</table>### cURL request
This example retrieves a specified product inventory.
```
curl -X GET 'https://instance.service-now.com/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2' \
--user 'username':'password'
```
Output:
```
{
"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"
},
"productId": "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/productinventory
Retrieves a list of all product inventories.
**Important:** Starting with the Tokyo release, this endpoint is deprecated. The new version of this endpoint is [Product Inventory Open API - GET /sn\_prd\_invt/product](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-apis/product-inventory-open-api.md).
### URL format
Default URL: `api/sn_prd_invt/productinventory`
### Supported request parameters
|Name|Description|
|----|-----------|
|None| |
<table id="table_pfr_vgy_fsb" class="rest_api_query_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
account
</td><td>
Filter product inventories by account. Only inventories associated with the specified account are returned in the response.Data type: String
Default: Don't filter by account.
</td></tr><tr><td>
billingAccount
</td><td>
Filter product inventories by billing account. Only inventories associated with the specified billing account are returned in the response.Data type: String
Default: Don't filter by billing account
</td></tr><tr><td>
contact and consumer \(Related Party\)
</td><td>
Filter product inventories by associated contact or related party. Only inventories linked to the specified contact or consumer record are returned in the response.Data type: String
Default: Don't filter by contact or consumer
</td></tr><tr><td>
customer
</td><td>
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
Default: Don't filter by customer.
</td></tr><tr><td>
externalID
</td><td>
Filter product inventories by external identifier. Only inventories with an externalID matching the value of this parameter are returned in the response. Data type: String
Default: Don't filter by externalID
</td></tr><tr><td>
fields
</td><td>
List of fields to return in the response. Invalid fields are ignored.Data type: String
Default: All fields are returned.
</td></tr><tr><td>
limit
</td><td>
Maximum number of records to return. For requests that exceed this number of records, use the **offset** parameter to paginate record retrieval. Data type: Number
Default: 20
Maximum: 100
</td></tr><tr><td>
offset
</td><td>
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.Data type: Number
Default: 0
</td></tr><tr><td>
place
</td><td>
Filter product inventories by location.Data type: Object
```
"place": {
"id": "String"
}
```
</td></tr><tr><td>
place.id
</td><td>
Sys\_id or external id of the location associated with the product inventory record.Data type: String
Table: Location \[cmn\_location\]
Field: sys\_id or sn\_tmt\_core\_external\_id
</td></tr><tr><td>
status
</td><td>
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
Default: Don't filter by inventory status.
</td></tr></tbody>
</table>|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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Header|Description|
|------|-----------|
|None| |
<table id="table_idy_qgm_lsb" class="rest_api_response_headers"><thead><tr><th>
Header
</th><th>
Description
</th></tr></thead><tbody><tr id="content-range-row"><td>
Content-Range
</td><td>
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`.
</td></tr><tr id="content-type-row"><td>
Content-Type
</td><td>
Data format of the response body. Only supports **application/json**.
</td></tr><tr id="links-pagination-row"><td>
Link
</td><td>
Contains the following links to navigate through query results.- first
- last
- next
- previous
</td></tr><tr id="x-total-count-row"><td id="x-total-count">
X-Total-Count
</td><td>
For paginated queries, this header specifies the total number of records available on the server.
</td></tr></tbody>
</table>### 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table id="table_hl1_rcm_lsb"><thead><tr><th>
Status code
</th><th>
Description
</th></tr></thead><tbody><tr><td>
200
</td><td id="tmf-get-status-200-entry">
Request successfully processed. Full resource returned in response \(no pagination\).
</td></tr><tr><td>
206
</td><td id="tmf-get-status-206-entry">
Partial resource returned in response \(with pagination\).
</td></tr><tr><td>
400
</td><td id="tmf-get-status-400-entry">
Bad request. Possible reasons:
- Invalid path parameter
- Invalid URI
</td></tr><tr><td>
404
</td><td id="tmf-get-status-404-entry">
Record not found. No records matching the query parameters are found in the table.
</td></tr></tbody>
</table>### Response body parameters \(JSON\)
<table id="table_shr_nvy_3sb"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
id
</td><td>
Sys\_id of the product inventory.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
name
</td><td>
Name of the product inventory.Data type: String
</td></tr><tr><td>
place
</td><td>
Place associated with the product.Data type: Object
```
"place": {
"id": "String",
"name": "String"
}
```
</td></tr><tr><td>
place.id
</td><td>
Location sys\_id or external\_id of the product inventory.Table: Location \[cmn\_location\]
Data: String
</td></tr><tr><td>
place.name
</td><td>
Name of the location associated with the product inventory.Table: Location \[cmn\_location\]
Data: String
</td></tr><tr><td>
productCharacteristic
</td><td>
List of product characteristics.For additional information on product characteristics, see [Create a product offering category](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/order-management/som-create-product-offering-category.md).
Data type: Array of Objects
```
"productCharacteristic": [
{
"name": "String",
"value": "String",
"valueType": "String"
}
]
```
</td></tr><tr><td>
productCharacteristic.name
</td><td>
Name of the characteristic.Data type: String
</td></tr><tr><td>
productCharacteristic.value
</td><td>
Value of the characteristic.Data type: String
</td></tr><tr><td>
productCharacteristic.valueType
</td><td>
Type of characteristic value.Possible values:
- `Address`
- `Array Date`
- `Array Datetime`
- `Array Decimal`
- `Array Integer`
- `Array Object`
- `Array Single Line Test`
- `CheckBox`
- `Choice`
- `Date`
- `Date / Time`
- `Email`
- `Integer`
- `Object`
- `Single Line Text`
- `Yes / No`
**Note:** By default, or if this property doesn't exist, this field returns the display values listed above. To return the internal value instead \(matching the value format the TMF622 Product Order API already uses by default\), create a true/false system property named **sn\_prd\_invt.enableseamlessvaluetype** and set it to `true`: `address`, `array.date`, `array.datetime`, `array.decimal`, `array.integer`, `array.object`, `array.single_line_text`, `attachment`, `checkbox`, `choice`, `date`, `date_time`, `decimal`, `duration`, `email`, `integer`, `object`, `single_line_text`, `yes_no`.
Default: `false`
Data type: String
</td></tr><tr><td>
productOffering
</td><td>
Product offering that the product inventory is associated with.Data type: Object
```
"productOffering": {
"id": "String",
"name": "String"
}
```
</td></tr><tr><td>
productOffering.id
</td><td>
Sys\_id of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
</td></tr><tr><td>
productOffering.name
</td><td>
Name of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
</td></tr><tr><td>
productRelationship
</td><td>
List of related products.Data type: Array of Objects
```
"productRelationship": [
{
"productId": "String",
"relationshipType": "String"
}
]
```
</td></tr><tr><td>
productRelationship.productId
</td><td>
Sys\_id of the related product.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
productRelationship.relationshipType
</td><td>
Type of relationship.Data type: String
</td></tr><tr><td>
productSpecification
</td><td>
Product specification for the product.Data type: Object
```
"productSpecification": {
"id": "String"
}
```
</td></tr><tr><td>
productSpecification.id
</td><td>
Sys\_id of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
</td></tr><tr><td>
realizingResource
</td><td>
Realizing resource.Data type: Object
```
"realizingResource": {
"id": "String",
"type": "String"
}
```
</td></tr><tr><td>
realizingResource.id
</td><td>
Sys\_id of the realizing resource.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingResource.type
</td><td>
Type of the realizing resource.Data type: String
</td></tr><tr><td>
realizingService
</td><td>
Realizing service.Data type: Object
```
"realizingService": {
"id": "String",
"type": "String"
}
```
</td></tr><tr><td>
realizingService.id
</td><td>
Sys\_id of the realizing service.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingService.type
</td><td>
Type of the realizing service.Data type: String
</td></tr><tr><td>
relatedParty
</td><td>
List of parties associated with the ticket.Data type: Array of Objects
```
"relatedParty": [
{
"id": "String",
"@referredType": "String"
}
]
```
</td></tr><tr><td>
relatedParty.id
</td><td>
Sys\_id of the account or customer contact associated with the ticket.Data type: String
Table: Account \[customer\_account\], Contact \[customer\_contact\] or Consumer \[csm\_consumer\]
</td></tr><tr><td>
relatedParty.@referredType
</td><td>
Type of related party. Value is always `Related Party`.Data type: String
</td></tr><tr><td>
relatedParty.type
</td><td>
Type of customer.Possible values:
- consumer
- customer
- customerContact
Data type: String
</td></tr><tr><td>
status
</td><td>
Current state of the product.Data type: String
</td></tr></tbody>
</table>### cURL request
This example retrieves all product inventories.
```
curl "https://instance.servicenow.com/api/sn_prd_invt/productinventory" \
--request GET \
--user 'username':'password'
```
Response body.
```
[
{
"id": "075072aec3a83010abc8b5183c40dd44",
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"name": "Firewall Administration PI0000300",
"productSpecification": {
"id": "31c5caff07266010a7955b7e0ad3006b",
"name": "Firewall Administration"
},
"status": "Active",
"productOffering": {
"id": "",
"name": ""
},
"place": {
"id": "920cf6ac73d423002728660c4cf6a799",
"name": "200 South James street,Atlanta, GA"
},
"productCharacteristic": [
{
"name": "Firewall Administration CPE Type",
"valueType": "Choice",
"value": "Physical"
},
{
"name": "Configuration and Policy backup",
"valueType": "Choice",
"value": ""
},
{
"name": "Firewall Administration CPE ID",
"valueType": "Single Line Text",
"value": "CPE123456789"
},
{
"name": "Remote CLI troubleshoot support",
"valueType": "Choice",
"value": ""
},
{
"name": "Firewall Administration CPE Model",
"valueType": "Choice",
"value": "9300 series"
}
],
"productRelationship": [],
"realizingService": [],
"realizingResource": [
{
"id": "3546463307666010a7955b7e0ad3005d",
"name": "Cisco Firewall Management system"
}
]
},
{
"id": "0303a8ea74418510f877ca57242ff96d",
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"name": "SD-WAN Edge Device PI0001114",
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device"
},
"status": "Installation Pending",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"place": "",
"productCharacteristic": [],
"productRelationship": [],
"realizingService": [
{
"id": "bf65eadc1b7420106ba59acf034bcb57",
"name": "SD-WAN Routing"
},
{
"id": "16d79ec3532520103b6bddeeff7b12a6",
"name": "SD WAN Optimization Service"
},
{
"id": "16d79ec3532520103b6bddeeff7b12a6",
"name": "SD WAN Optimization Service"
},
{
"id": "bf65eadc1b7420106ba59acf034bcb57",
"name": "SD-WAN Routing"
},
{
"id": "bf65eadc1b7420106ba59acf034bcb57",
"name": "SD-WAN Routing"
},
{
"id": "bf65eadc1b7420106ba59acf034bcb57",
"name": "SD-WAN Routing"
}
],
"realizingResource": [
{
"id": "493fa60b536520103b6bddeeff7b12b6",
"name": "Customer Premise SD-WAN Router"
}
]
}
]
```
## Product Inventory Open API - GET /sn\_prd\_invt/productinventory/\{inventoryId\}
Retrieves a product inventory.
**Important:** Starting with the Tokyo release, this endpoint is deprecated. The new version of this endpoint is [Product Inventory Open API - GET /sn\_prd\_invt/product/\{id\}](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-apis/product-inventory-open-api.md).
### URL format
Default URL: `/api/sn_prd_invt/productinventory/{inventoryId}`
### Supported request parameters
<table id="table_apt_nkz_gsb" class="rest_api_path_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
inventoryId
</td><td>
Sys\_id of the product inventory to retrieve.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr></tbody>
</table><table id="table_pfr_vgy_fsb" class="rest_api_query_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
account
</td><td>
Filter product inventories by account. Only inventories associated with the specified account are returned in the response.Data type: String
Default: Don't filter by account.
</td></tr><tr><td>
billingAccount
</td><td>
Filter product inventories by billing account. Only inventories associated with the specified billing account are returned in the response.Data type: String
Default: Don't filter by billing account
</td></tr><tr><td>
contact and consumer \(Related Party\)
</td><td>
Filter product inventories by associated contact or related party. Only inventories linked to the specified contact or consumer record are returned in the response.Data type: String
Default: Don't filter by contact or consumer
</td></tr><tr><td>
customer
</td><td>
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
</td></tr><tr><td>
externalID
</td><td>
Filter product inventories by external identifier. Only inventories with an externalID matching the value of this parameter are returned in the response. Data type: String
Default: Don't filter by externalID
</td></tr><tr><td>
fields
</td><td>
List of fields to return in the response. Invalid fields are ignored.Data type: String
Default: All fields returned.
</td></tr><tr><td>
place
</td><td>
Filter product inventories by location.Data type: Object
```
"place": {
"id": "String"
}
```
</td></tr><tr><td>
place.id
</td><td>
Sys\_id or external id of the location associated with the product inventory record.Data type: String
Table: Location \[cmn\_location\]
Field: sys\_id or sn\_tmt\_core\_external\_id
</td></tr><tr><td>
status
</td><td>
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
</td></tr></tbody>
</table>|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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Header|Description|
|------|-----------|
|None| |
|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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table id="table_nxj_ykz_gsb"><thead><tr><th>
Status code
</th><th>
Description
</th></tr></thead><tbody><tr><td>
200
</td><td>
Request successfully processed.
</td></tr><tr><td>
400
</td><td>
Bad Request. Could be any of the following reasons: - Invalid path parameter
- Invalid URI
</td></tr><tr><td>
404
</td><td>
Record not found. Record associated with the ID is not found in the table.
</td></tr></tbody>
</table>### Response body parameters \(JSON\)
<table id="table_shr_nvy_3sb"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
id
</td><td>
Sys\_id of the product inventory Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
name
</td><td>
Name of the product inventory.Data type: String
</td></tr><tr><td>
place
</td><td>
Place associated with the product.Data type: Object
```
"place": {
"id": "String",
"name": "String"
}
```
</td></tr><tr><td>
place.id
</td><td>
Location sys\_id or external\_id of the product inventory.Table: Location \[cmn\_location\]
Data: String
</td></tr><tr><td>
place.name
</td><td>
Name of the location associated with the product inventory.Table: Location \[cmn\_location\]
Data: String
</td></tr><tr><td>
productCharacteristic
</td><td>
List of product characteristics.For additional information on product characteristics, see [Create a product offering category](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/order-management/som-create-product-offering-category.md).
Data type: Array of Objects
```
"productCharacteristic": [
{
"name": "String",
"value": "String",
"valueType": "String"
}
]
```
</td></tr><tr><td>
productCharacteristic.name
</td><td>
Name of the characteristic.Data type: String
</td></tr><tr><td>
productCharacteristic.value
</td><td>
Value of the characteristic.Data type: String
</td></tr><tr><td>
productCharacteristic.valueType
</td><td>
Type of characteristic value.Possible values:
- `Address`
- `Array Date`
- `Array Datetime`
- `Array Decimal`
- `Array Integer`
- `Array Object`
- `Array Single Line Test`
- `CheckBox`
- `Choice`
- `Date`
- `Date / Time`
- `Email`
- `Integer`
- `Object`
- `Single Line Text`
- `Yes / No`
**Note:** By default, or if this property doesn't exist, this field returns the display values listed above. To return the internal value instead \(matching the value format the TMF622 Product Order API already uses by default\), create a true/false system property named **sn\_prd\_invt.enableseamlessvaluetype** and set it to `true`: `address`, `array.date`, `array.datetime`, `array.decimal`, `array.integer`, `array.object`, `array.single_line_text`, `attachment`, `checkbox`, `choice`, `date`, `date_time`, `decimal`, `duration`, `email`, `integer`, `object`, `single_line_text`, `yes_no`.
Default: `false`
Data type: String
</td></tr><tr><td>
productOffering
</td><td>
Product offering that the product inventory is associated with.Data type: Object
```
"productOffering": {
"id": "String",
"name": "String"
}
```
</td></tr><tr><td>
productOffering.id
</td><td>
Sys\_id of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
</td></tr><tr><td>
productOffering.name
</td><td>
Name of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
</td></tr><tr><td>
productRelationship
</td><td>
List of related products.Data type: Array of Objects
```
"productRelationship": [
{
"productId": "String",
"relationshipType": "String"
}
]
```
</td></tr><tr><td>
productRelationship.productId
</td><td>
Sys\_id of the related product.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
productRelationship.relationshipType
</td><td>
Type of relationship.Data type: String
</td></tr><tr><td>
productSpecification
</td><td>
Product specification for the product.Data type: Object
```
"productSpecification": {
"id": "String"
}
```
</td></tr><tr><td>
productSpecification.id
</td><td>
Sys\_id of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
</td></tr><tr><td>
realizingResource
</td><td>
Realizing resource.Data type: Object
```
"realizingResource": {
"id": "String",
"type": "String"
}
```
</td></tr><tr><td>
realizingResource.id
</td><td>
Sys\_id of the realizing resource.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingResource.type
</td><td>
Type of the realizing resource.Data type: String
</td></tr><tr><td>
realizingService
</td><td>
Realizing service.Data type: Object
```
"realizingService": {
"id": "String",
"type": "String"
}
```
</td></tr><tr><td>
realizingService.id
</td><td>
Sys\_id of the realizing service.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingService.type
</td><td>
Type of the realizing service.Data type: String
</td></tr><tr><td>
relatedParty
</td><td>
List of parties associated with the ticket.Data type: Array of Objects
```
"relatedParty": [
{
"id": "String",
"@referredType": "String"
}
]
```
</td></tr><tr><td>
relatedParty.id
</td><td>
Sys\_id of the account or customer contact associated with the ticket.Data type: String
Table: Account \[customer\_account\], Contact \[customer\_contact\], or Consumer \[csm\_consumer\]
</td></tr><tr><td>
relatedParty.@referredType
</td><td>
Type of related party. Value is always `Related Party`.Data type: String
</td></tr><tr><td>
relatedParty.type
</td><td>
Type of customer.Possible values:
- consumer
- customer
- customerContact
Data type: String
</td></tr><tr><td>
status
</td><td>
Current state of the product.Data type: String
</td></tr></tbody>
</table>### cURL request
This example retrieves a product inventory for an SD-WAN service package.
```
curl --location --request GET 'https:// instance.servicenow.com/api/sn_prd_invt/productinventory/074450fc74918d10f877ca57242ff9e3' \
--user 'username':'password'
```
Output:
```
{
"id": "074450fc74918d10f877ca57242ff9e3",
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"name": "SD-WAN Service Package PI0001576",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package"
},
"status": "Installation Pending",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"place": "",
"productCharacteristic": [],
"productRelationship": [
{
"id": "a74490fc74918d10f877ca57242ff942",
"name": "SD-WAN Edge Device PI0001582",
"relationshipType": "Bundles"
},
{
"id": "b85414fc74918d10f877ca57242ff90e",
"name": "SD-WAN Controller PI0001602",
"relationshipType": "Bundles"
},
{
"id": "d74490fc74918d10f877ca57242ff907",
"name": "SD-WAN Security PI0001577",
"relationshipType": "Bundles"
}
],
"realizingService": [],
"realizingResource": []
}
```
## Product Inventory Open API – PATCH /sn\_prd\_invt/order/product/\{id\}
Updates a specified product inventory record.
### URL format
Default URL: `/api/sn_prd_invt/order/product/{id}`
### Supported request parameters
<table id="table_vvs_bvr_1hc" class="rest_api_path_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
id
</td><td>
Sys\_id of the product inventory to update.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr></tbody>
</table>|Name|Description|
|----|-----------|
|None| |
<table class="rest_api_request_body"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
bundle
</td><td>
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
- true: Is part of a bundle.
- false: Isn't part of a bundle.
Data type: Boolean
</td></tr><tr><td>
name
</td><td>
Name of the product inventory.Data type: String
</td></tr><tr><td>
place
</td><td>
Location of the product.Data type: Array
```
"place": [
{
"id": "String",
"name": "String"
}
]
```
</td></tr><tr><td>
place.id
</td><td>
Location sys\_id or external id.Data type: String
Table: Location \[cmn\_location\]
Field: sys\_id or sn\_tmt\_core\_external\_id
</td></tr><tr><td>
place.name
</td><td>
Name of the location.Data type: String
Table: Location \[cmn\_location\]
Field: name
</td></tr><tr><td>
productOffering
</td><td>
Product offering that the product inventory is associated with.Data type: Object
```
"productOffering": {
"@referredType": "String",
"id": "String",
"internalId": "String",
"internalVersion": "String",
"name": "String",
"status": "String",
"version": "String"
}
```
</td></tr><tr><td>
productOffering.@referredType
</td><td>
This value is always `ProductOffering`.Data type: String
</td></tr><tr><td>
productOffering.id
</td><td>
Initial version or external ID of the product offering. Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: initial\_version or external\_id
</td></tr><tr><td>
productOffering.internalId
</td><td>
Internal version of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: internal\_version
</td></tr><tr><td>
productOffering.internalVersion
</td><td>
Version of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: version
</td></tr><tr><td>
productOffering.name
</td><td>
Name of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: name
</td></tr><tr><td>
productOffering.status
</td><td>
Status of the product offering.Possible values:
- archived
- draft
- published
- retired
Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: status
</td></tr><tr><td>
productOffering.version
</td><td>
External version of the product offering. Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: external\_version
</td></tr><tr><td>
relatedParty
</td><td>
List of parties associated with the ticket.Data type: Array of Objects
```
"relatedParty": [
{
"@referredType": "String",
"@type": "String",
"id": "String",
"name": "String"
}
]
```
</td></tr><tr><td>
relatedParty.@referredType
</td><td>
Type of related party.Possible values:
- Consumer
- Customer
- CustomerContact
Data type: String
</td></tr><tr><td>
relatedParty.@type
</td><td>
This value is always `RelatedParty`.Data type: String
</td></tr><tr><td>
relatedParty.id
</td><td>
Sys\_id of the account or customer contact associated with the ticket.Data type: String
Table: Account \[customer\_account\], Contact \[customer\_contact\], or Consumer \[csm\_consumer\]
</td></tr><tr><td>
relatedParty.name
</td><td>
Name of the of the account or customer contact associated with the ticket.Data type: String
Table: Account \[customer\_account\], Contact \[customer\_contact\], or Consumer \[csm\_consumer\]
</td></tr></tbody>
</table>### 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Header|Description|
|------|-----------|
|Accept|Data format of the response body. Only supports **application/json**.|
|Content-Type|Data format of the request body. Only supports **application/json**.|
|Header|Description|
|------|-----------|
|None| |
### 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|200|Successful. The request was successfully processed.|
|400|Bad Request. A bad request type or malformed request was detected.|
|404|Not found. The requested item wasn't found.|
### Response body parameters \(JSON\)
<table><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
bundle
</td><td>
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
- true: Is part of a bundle.
- false: Isn't part of a bundle.
Data type: Boolean
</td></tr><tr><td>
name
</td><td>
Name of the product inventory.Data type: String
</td></tr><tr><td>
place
</td><td>
Location of the product.Data type: Array
```
"place": [
{
"id": "String",
"name": "String"
}
]
```
</td></tr><tr><td>
place.id
</td><td>
Location sys\_id or external id.Data type: String
Table: Location \[cmn\_location\]
Field: sys\_id or sn\_tmt\_core\_external\_id
</td></tr><tr><td>
place.name
</td><td>
Name of the location.Data type: String
Table: Location \[cmn\_location\]
Field: name
</td></tr><tr><td>
productOffering
</td><td>
Product offering that the product inventory is associated with.Data type: Object
```
"productOffering": {
"@referredType": "String",
"id": "String",
"internalId": "String",
"internalVersion": "String",
"name": "String",
"status": "String",
"version": "String"
}
```
</td></tr><tr><td>
productOffering.@referredType
</td><td>
This value is always `ProductOffering`.Data type: String
</td></tr><tr><td>
productOffering.id
</td><td>
Initial version or external ID of the product offering. Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: initial\_version or external\_id
</td></tr><tr><td>
productOffering.internalId
</td><td>
Internal version of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: internal\_version
</td></tr><tr><td>
productOffering.internalVersion
</td><td>
Version of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: version
</td></tr><tr><td>
productOffering.name
</td><td>
Name of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: name
</td></tr><tr><td>
productOffering.status
</td><td>
Status of the product offering.Possible values:
- archived
- draft
- published
- retired
Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: status
</td></tr><tr><td>
productOffering.version
</td><td>
External version of the product offering. Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: external\_version
</td></tr><tr><td>
relatedParty
</td><td>
List of parties associated with the ticket.Data type: Array of Objects
```
"relatedParty": [
{
"@referredType": "String",
"@type": "String",
"id": "String",
"name": "String"
}
]
```
</td></tr><tr><td>
relatedParty.@referredType
</td><td>
Type of related party.Possible values:
- Consumer
- Customer
- CustomerContact
Data type: String
</td></tr><tr><td>
relatedParty.@type
</td><td>
This value is always `RelatedParty`.Data type: String
</td></tr><tr><td>
relatedParty.id
</td><td>
Sys\_id of the account or customer contact associated with the ticket.Data type: String
Table: Account \[customer\_account\], Contact \[customer\_contact\], or Consumer \[csm\_consumer\]
</td></tr><tr><td>
relatedParty.name
</td><td>
Name of the of the account or customer contact associated with the ticket.Data type: String
Table: Account \[customer\_account\], Contact \[customer\_contact\], or Consumer \[csm\_consumer\]
</td></tr></tbody>
</table>### cURL request
This example updates a product inventory record.
```
curl "https://instance.service-now.com/api/sn_prd_invt/product/036e506510322250f8777d910acbd77f" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"name\": \"Internet Plan\",
\"productOffering\": {
\"@referredType\": \"ProductOffering\",
\"name\": \"Premium SD-WAN Offering\",
\"id\": \"0361dd9fd0a63110f8770dbf976be16f\"
},
\"relatedParty\": [
{
\"@referredType\": \"CustomerContact\",
\"@type\": \"RelatedParty\",
\"name\": \"Sally Thomas\",
\"id\": \"f3af54c413651200042ab3173244b053\"
},
{
\"@referredType\": \"Customer\",
\"@type\": \"RelatedParty\",
\"name\": \"Funco Intl\",
\"id\": \"ffc68911c35420105252716b7d40dd55\"
}
],
\"bundle\": false,
\"place\": [
{
\"id\": \"25ab9c4d0a0a0bb300f7dabdc0ca7c1c\",
\"name\": \"100 South Charles Street, Baltimore, MD\"
}
]
}" \
--user 'username':'password'
```
Response body.
```
{
"name": "Internet Plan",
"productOffering": {
"@referredType": "ProductOffering",
"name": "Premium SD-WAN Offering",
"id": "0361dd9fd0a63110f8770dbf976be16f",
"internalVersion": "1",
"version": "",
"status": "published",
"internalId": "0361dd9fd0a63110f8770dbf976be16f"
},
"relatedParty": [
{
"@referredType": "CustomerContact",
"@type": "RelatedParty",
"name": "Sally Thomas",
"id": "f3af54c413651200042ab3173244b053"
},
{
"@referredType": "Customer",
"@type": "RelatedParty",
"name": "Funco Intl",
"id": "ffc68911c35420105252716b7d40dd55"
}
],
"bundle": false,
"place": [
{
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"name": "100 South Charles Street, Baltimore, MD"
}
],
"productPrice": [],
"id": "036e506510322250f8777d910acbd77f",
"href": "/api/sn_prd_invt/product/036e506510322250f8777d910acbd77f"
}
```
## Product Inventory Open API - POST /sn\_prd\_invt/product
Creates a product inventory record.
### URL format
Default URL: `/api/sn_prd_invt/product`
### Supported request parameters
|Name|Description|
|----|-----------|
|None| |
|Name|Description|
|----|-----------|
|None| |
<table class="rest_api_request_body"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
bundle
</td><td>
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
- true: Is part of a bundle.
- false: Isn't part of a bundle.
Data type: Boolean
Default: false
</td></tr><tr><td>
isBundle
</td><td>
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
- true: Is part of a bundle.
- false: Isn't part of a bundle.
Data type: Boolean
Default: false
</td></tr><tr><td>
name
</td><td>
Required. Name of the product inventory.Data type: String
</td></tr><tr><td>
pid
</td><td>
Unique identifier for the product inventory from the external system.Data type: String
Default: Blank string
</td></tr><tr><td>
productCharacteristic
</td><td>
List of product characteristics.For additional information on product characteristics, see [Create a product offering category](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/order-management/som-create-product-offering-category.md).
Data type: Array of Objects
```
"productCharacteristic": [
{
"name": "String",
"value": "String",
"valueType": "String"
}
]
```
</td></tr><tr><td>
productCharacteristic.name
</td><td>
Name of the characteristic.Data type: String
Default: Blank string
</td></tr><tr><td>
productCharacteristic.value
</td><td>
Value of the characteristic.Data type: String
Default: Blank string
</td></tr><tr><td>
productCharacteristic.valueType
</td><td>
Type of characteristic value.Possible values:
- `Address`
- `Array Date`
- `Array Datetime`
- `Array Decimal`
- `Array Integer`
- `Array Object`
- `Array Single Line Test`
- `CheckBox`
- `Choice`
- `Date`
- `Date / Time`
- `Email`
- `Integer`
- `Object`
- `Single Line Text`
- `Yes / No`
**Note:** By default, or if this property doesn't exist, this field returns the display values listed above. To return the internal value instead \(matching the value format the TMF622 Product Order API already uses by default\), create a true/false system property named **sn\_prd\_invt.enableseamlessvaluetype** and set it to `true`: `address`, `array.date`, `array.datetime`, `array.decimal`, `array.integer`, `array.object`, `array.single_line_text`, `attachment`, `checkbox`, `choice`, `date`, `date_time`, `decimal`, `duration`, `email`, `integer`, `object`, `single_line_text`, `yes_no`.
Default: `false`
Data type: String
</td></tr><tr><td>
productOffering
</td><td>
Required. Product offering that the product inventory is associated with.Data type: Object
```
"productOffering": {
"id": "String",
"internalVersion": "String",
"name": "String",
"version": "String"
}
```
</td></tr><tr><td>
productOffering.id
</td><td>
Required. Initial\_version or external\_id of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
</td></tr><tr><td>
productOffering.internalVersion
</td><td>
Version of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: version
</td></tr><tr><td>
productOffering.name
</td><td>
Name of the product offering.Data type: String
Default: Blank string
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
</td></tr><tr><td>
productOffering.version
</td><td>
External version of the product offering. Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: external\_version
</td></tr><tr><td>
productRelationship
</td><td>
List of related products.Data type: Array of Objects
```
"productRelationship": [
{
"productId": "String",
"relationshipType": "String"
}
]
```
</td></tr><tr><td>
productRelationship.productId
</td><td>
Required if using the **productRelationship** parameter. Sys\_id of the related product.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
productRelationship.relationshipType
</td><td>
Type of relationship. The only valid value is `child`.
Data type: String
Default: Blank string
</td></tr><tr><td>
productSpecification
</td><td>
Required. Product specification for the product.Data type: Object
```
"productSpecification": {
"id": "String",
"internalVersion": "String",
"version": "String"
}
```
</td></tr><tr><td>
productSpecification.id
</td><td>
Required. Initial\_version or external\_id of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
</td></tr><tr><td>
productSpecification.internalVersion
</td><td>
Version of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: version
</td></tr><tr><td>
productSpecification.version
</td><td>
External version of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: external\_version
</td></tr><tr><td>
realizingResource
</td><td>
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"
}
```
</td></tr><tr><td>
realizingResource.id
</td><td>
Required if using the **realizingResource** parameter. Sys\_id of the realizing resource. Data type: String
</td></tr><tr><td>
realizingResource.type
</td><td>
Type of the realizing resource.Valid value: child
Data type: String
</td></tr><tr><td>
realizingService
</td><td>
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"
}
```
</td></tr><tr><td>
realizingService.id
</td><td>
Required if using the **realizingService** parameter. Sys\_id of the realizing service. Data type: String
</td></tr><tr><td>
realizingService.type
</td><td>
Type of the realizing service.Valid value: child
Data type: String
</td></tr><tr><td>
relatedParty
</td><td>
List of parties associated with the ticket.Data type: Array of Objects
```
"relatedParty": [
{
"id": "String",
"@referredType": "String"
}
]
```
</td></tr><tr><td>
relatedParty.@referredType
</td><td>
Type of customer.Possible values:
- consumer
- customer
- customer\_contact
Data type: String
Default: Blank string
</td></tr><tr><td>
relatedParty.id
</td><td>
Required if using the **relatedParty** parameter. Sys\_id of the account or customer contact associated with the ticket.Data type: String
Table: Account \[customer\_account\], Contact \[customer\_contact\], or Consumer \[csm\_consumer\]
</td></tr><tr><td>
state
</td><td>
Current state of the product.Possible values:
- active
- change\_pending
- inactivation\_pending
- inactive
- installation\_pending
Data type: String
Default: installation\_pending
</td></tr></tbody>
</table>### 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Header|Description|
|------|-----------|
|Accept|Data format of the response body. Only supports **application/json**.|
|Content-Type|Data format of the request body. Only supports **application/json**.|
|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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table id="table_fbw_k3z_gsb"><thead><tr><th>
Status code
</th><th>
Description
</th></tr></thead><tbody><tr><td>
201
</td><td>
Request successfully processed.
</td></tr><tr><td>
400
</td><td>
Bad Request. Could be any of the following reasons: - Empty payload.
- Invalid payload. Mandatory field missing: <field name>
</td></tr></tbody>
</table>### Response body parameters \(JSON\)
<table><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
bundle
</td><td>
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
- true: Is part of a bundle.
- false: Isn't part of a bundle.
Data type: Boolean
</td></tr><tr><td>
href
</td><td>
Relative link to the product inventory record.Data type: String
</td></tr><tr><td>
id
</td><td>
Sys\_id of the product inventory.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
isBundle
</td><td>
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
- true: Is part of a bundle.
- false: Isn't part of a bundle.
Data type: Boolean
</td></tr><tr><td>
name
</td><td>
Name of the product inventory.Data type: String
</td></tr><tr><td>
pid
</td><td>
Unique identifier for the product inventory from the external system.Data type: String
</td></tr><tr><td>
productCharacteristic
</td><td>
List of product characteristics.Data type: Array of Objects
```
"productCharacteristic": [
{
"name": "String",
"value": "String"
}
]
```
</td></tr><tr><td>
productCharacteristic.name
</td><td>
Name of the characteristic.Data type: String
</td></tr><tr><td>
productCharacteristic.value
</td><td>
Value of the characteristic.Data type: String
</td></tr><tr><td>
productOffering
</td><td>
Product offering that the product inventory is associated with.Data type: Object
```
"productOffering": {
"id": "String",
"internalId": "String",
"internalVersion": "String",
"name": "String",
"version": "String"
}
```
</td></tr><tr><td>
productOffering.id
</td><td>
Initial version or external ID of the product offering. Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: initial\_version or external\_id
</td></tr><tr><td>
productOffering.internalId
</td><td>
Internal version of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: internal\_version
</td></tr><tr><td>
productOffering.internalVersion
</td><td>
Version of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: version
</td></tr><tr><td>
productOffering.name
</td><td>
Name of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
</td></tr><tr><td>
productOffering.version
</td><td>
External version of the product offering. Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
Field: external\_version
</td></tr><tr><td>
productPrice
</td><td>
Returns an empty array.Data type: Array
</td></tr><tr><td>
productRelationship
</td><td>
List of related products.Data type: Array of Objects
```
"productRelationship": [
{
"productId": "String",
"relationshipType": "String"
}
]
```
</td></tr><tr><td>
productRelationship.productId
</td><td>
Sys\_id of the related product.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
productRelationship.relationshipType
</td><td>
Type of relationship.Data type: String
</td></tr><tr><td>
productSpecification
</td><td>
Product specification for the product.Data type: Object
```
"productSpecification": {
"id": "String",
"internalId": "String",
"internalVersion": "String",
"version": "String"
}
```
</td></tr><tr><td>
productSpecification.id
</td><td>
Initial version or external ID of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: internal\_version or external\_id
</td></tr><tr><td>
productSpecification.internalId
</td><td>
Initial version of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: initial\_version
</td></tr><tr><td>
productSpecification.internalVersion
</td><td>
Version of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: version
</td></tr><tr><td>
productSpecification.version
</td><td>
External version of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
Field: external\_version
</td></tr><tr><td>
realizingResource
</td><td>
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"
}
```
</td></tr><tr><td>
realizingResource.id
</td><td>
Sys\_id of the realizing resource. Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingResource.type
</td><td>
Type of the realizing resource.Valid value: child
Data type: String
</td></tr><tr><td>
realizingService
</td><td>
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"
}
```
</td></tr><tr><td>
realizingService.id
</td><td>
Sys\_id of the realizing service. Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingService.type
</td><td>
Type of the realizing service.Valid value: child
Data type: String
</td></tr><tr><td>
relatedParty
</td><td>
List of parties associated with the ticket.Data type: Array of Objects
```
"relatedParty": [
{
"id": "String",
"@referredType": "String"
}
]
```
</td></tr><tr><td>
relatedParty.@referredType
</td><td>
Type of related party. Value is always `Related Party`.Data type: String
</td></tr><tr><td>
relatedParty.id
</td><td>
Sys\_id of the account or customer contact associated with the ticket.Data type: String
Table:Account \[customer\_account\], Contact \[customer\_contact\], or Consumer \[csm\_consumer\]
</td></tr><tr><td>
relatedParty.type
</td><td>
Type of customer.Possible values:
- consumer
- customer
- customerContact
Data type: String
</td></tr><tr><td>
status
</td><td>
Current state of the product.Data type: String
</td></tr></tbody>
</table>### cURL request
This example creates a product inventory for a voice over IP solution for a user.
```
curl -X POST "https://instance.service-now.com/api/sn_prd_invt/product" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password" \
--data "[
{
"pid": "PO-456",
"description": "inventory description",
"isBundle": false,
"name": "Voice Over IP Basic instance for Jean",
"productOffering": {
"@referredType": "ProductOffering",
"name": "Premium SD-WAN Offering",
"id": "69017a0f536520103b6bddeeff7b127d"
},
"productCharacteristic": [],
"productRelationship": [
{
"productId": "fa6d13f45b5620102dff5e92dc81c77f",
"relationshipType": "child"
}
],
"realizingService": {
"id": "fe6d13f45b5620102dff5e92dc81c786",
"relationshipType": "child"
},
"realizingResource": {
"id": "326d13f45b5620102dff5e92dc81c78c",
"relationshipType": "child"
},
"relatedParty": [
{
"@referredType": "CustomerContact",
"@type": "RelatedParty",
"name": "Sally Thomas",
"id": "eaf68911c35420105252716b7d40ddde"
},
{
"@referredType": "Customer",
"@type": "RelatedParty",
"name": "Funco Intl",
"id": "ffc68911c35420105252716b7d40dd55"
}
],
"productSpecification": {
"@referredType": "ProductSpecification",
"@type": null,
"name": null,
"id": "3ee1fdb1c3331010d216b5183c40dd81",
"internalVersion": "1"
},
"bundle": false
}
]"
```
Response body.
```
{
"pid": "PO-456",
"description": "inventory description",
"isBundle": false,
"name": "Voice Over IP Basic instance for Jean",
"productOffering": {
"@referredType": "ProductOffering",
"name": "Premium SD-WAN Offering",
"id": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1",
"version": null,
"status": "published",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productCharacteristic": [],
"productRelationship": [
{
"productId": "fa6d13f45b5620102dff5e92dc81c77f",
"relationshipType": "child"
}
],
"realizingService": {
"id": "fe6d13f45b5620102dff5e92dc81c786",
"relationshipType": "child"
},
"realizingResource": {
"id": "326d13f45b5620102dff5e92dc81c78c",
"relationshipType": "child"
},
"relatedParty": [
{
"@referredType": "CustomerContact",
"@type": "RelatedParty",
"name": "Sally Thomas",
"id": "eaf68911c35420105252716b7d40ddde"
},
{
"@referredType": "Customer",
"@type": "RelatedParty",
"name": "Example Company",
"id": "ffc68911c35420105252716b7d40dd55"
}
],
"productSpecification": {
"@referredType": "ProductSpecification",
"@type": null,
"name": null,
"id": "3ee1fdb1c3331010d216b5183c40dd81",
"internalVersion": "1",
"version": null,
"status": "published",
"internalId": "3ee1fdb1c3331010d216b5183c40dd81"
},
"bundle": false,
"productPrice": [],
"id": "25b07475471789108761b955d36d439d",
"href": "/api/sn_prd_invt/product/25b07475471789108761b955d36d439d"
}
```
## Product Inventory Open API - POST /sn\_prd\_invt/productinventory
Creates a product inventory.
**Important:** Starting with the Tokyo release, this endpoint is deprecated. The new version of this endpoint is [Product Inventory Open API - POST /sn\_prd\_invt/product](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-apis/product-inventory-open-api.md).
### URL format
Default URL: `/api/sn_prd_invt/productinventory`
### Supported request parameters
|Name|Description|
|----|-----------|
|None| |
|Name|Description|
|----|-----------|
|None| |
<table class="rest_api_request_body"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
isBundle
</td><td>
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
- true: Is part of a bundle.
- false: Isn't part of a bundle.
Data type: Boolean
Default: false
</td></tr><tr><td>
name
</td><td>
Required. Name of the product inventory.Data type: String
</td></tr><tr><td>
pid
</td><td>
Unique identifier for the product inventory from the external system.Data type: String
Default: Blank string
</td></tr><tr><td>
productCharacteristic
</td><td>
List of product characteristics.For additional information on product characteristics, see [Create a product offering category](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/order-management/som-create-product-offering-category.md).
Data type: Array of Objects
```
"productCharacteristic": [
{
"name": "String",
"value": "String",
"valueType": "String"
}
]
```
</td></tr><tr><td>
productCharacteristic.name
</td><td>
Name of the characteristic.Data type: String
Default: Blank string
</td></tr><tr><td>
productCharacteristic.value
</td><td>
Value of the characteristic.Data type: String
Default: Blank string
</td></tr><tr><td>
productCharacteristic.valueType
</td><td>
Type of characteristic value.Possible values:
- `Address`
- `Array Date`
- `Array Datetime`
- `Array Decimal`
- `Array Integer`
- `Array Object`
- `Array Single Line Test`
- `CheckBox`
- `Choice`
- `Date`
- `Date / Time`
- `Email`
- `Integer`
- `Object`
- `Single Line Text`
- `Yes / No`
**Note:** By default, or if this property doesn't exist, this field returns the display values listed above. To return the internal value instead \(matching the value format the TMF622 Product Order API already uses by default\), create a true/false system property named **sn\_prd\_invt.enableseamlessvaluetype** and set it to `true`: `address`, `array.date`, `array.datetime`, `array.decimal`, `array.integer`, `array.object`, `array.single_line_text`, `attachment`, `checkbox`, `choice`, `date`, `date_time`, `decimal`, `duration`, `email`, `integer`, `object`, `single_line_text`, `yes_no`.
Default: `false`
Data type: String
</td></tr><tr><td>
productOffering
</td><td>
Required. Product offering that the product inventory is associated with.Data type: Object
```
"productOffering": {
"id": "String",
"name": "String"
}
```
</td></tr><tr><td>
productOffering.id
</td><td>
Required. Sys\_id of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
</td></tr><tr><td>
productOffering.name
</td><td>
Name of the product offering.Data type: String
Default: Blank string
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
</td></tr><tr><td>
productRelationship
</td><td>
List of related products.Data type: Array of Objects
```
"productRelationship": [
{
"productId": "String",
"relationshipType": "String"
}
]
```
</td></tr><tr><td>
productRelationship.productId
</td><td>
Required if using the **productRelationship** parameter. Sys\_id of the related product.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
productRelationship.relationshipType
</td><td>
Type of relationship. The only valid value is `child`.
Data type: String
Default: Blank string
</td></tr><tr><td>
productSpecification
</td><td>
Required. Product specification for the product.Data type: Object
```
"productSpecification": {
"id": "String"
}
```
</td></tr><tr><td>
productSpecification.id
</td><td>
Required. Sys\_id of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
</td></tr><tr><td>
realizingResource
</td><td>
Realizing resource.Data type: Object
```
"realizingResource": {
"id": "String",
"type": "String"
}
```
</td></tr><tr><td>
realizingResource.id
</td><td>
Required if using the **realizingResource** parameter. Sys\_id of the realizing resource.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingResource.type
</td><td>
Type of the realizing resource.The only valid value is `child`.
Data type: String
Default: Blank string
</td></tr><tr><td>
realizingService
</td><td>
Realizing service.Data type: Object
```
"realizingService": {
"id": "String",
"type": "String"
}
```
</td></tr><tr><td>
realizingService.id
</td><td>
Required if using the **realizingService** parameter. Sys\_id of the realizing service.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingService.type
</td><td>
Type of the realizing service.The only valid value is `child`.
Data type: String
Default: Blank string
</td></tr><tr><td>
relatedParty
</td><td>
List of parties associated with the ticket.Data type: Array of Objects
```
"relatedParty": [
{
"id": "String",
"@referredType": "String"
}
]
```
</td></tr><tr><td>
relatedParty.@referredType
</td><td>
Type of customer.Possible values:
- consumer
- customer
- customer\_contact
Data type: String
Default: Blank string
</td></tr><tr><td>
relatedParty.id
</td><td>
Required if using the **relatedParty** parameter. Sys\_id of the account or customer contact associated with the ticket.Data type: String
Table: Account \[customer\_account\], Contact \[customer\_contact\], or Consumer \[csm\_Consumer\]
</td></tr><tr><td>
state
</td><td>
Current state of the product.Possible values:
- active
- change\_pending
- inactivation\_pending
- inactive
- installation\_pending
Data type: String
Default: installation\_pending
</td></tr></tbody>
</table>### 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Header|Description|
|------|-----------|
|Accept|Data format of the response body. Only supports **application/json**.|
|Content-Type|Data format of the request body. Only supports **application/json**.|
|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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table id="table_fbw_k3z_gsb"><thead><tr><th>
Status code
</th><th>
Description
</th></tr></thead><tbody><tr><td>
201
</td><td>
Request successfully processed.
</td></tr><tr><td>
400
</td><td>
Bad Request. Could be any of the following reasons: - Empty payload.
- Invalid payload. Mandatory field missing: <field name>
</td></tr></tbody>
</table>### Response body parameters \(JSON\)
<table><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
id
</td><td>
Sys\_id of the product inventory.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
isBundle
</td><td>
Flag that indicates whether the product inventory record is part of a bundled product.Valid values:
- true: Is part of a bundle.
- false: Isn't part of a bundle.
Data type: Boolean
</td></tr><tr><td>
name
</td><td>
Name of the product inventory.Data type: String
</td></tr><tr><td>
pid
</td><td>
Unique identifier for the product inventory from the external system.Data type: String
</td></tr><tr><td>
productCharacteristic
</td><td>
List of product characteristics.Data type: Array of Objects
```
"productCharacteristic": [
{
"name": "String",
"value": "String"
}
]
```
</td></tr><tr><td>
productCharacteristic.name
</td><td>
Name of the characteristic.Data type: String
</td></tr><tr><td>
productCharacteristic.value
</td><td>
Value of the characteristic.Data type: String
</td></tr><tr><td>
productOffering
</td><td>
Product offering that the product inventory is associated with.Data type: Object
```
"productOffering": {
"id": "String",
"name": "String"
}
```
</td></tr><tr><td>
productOffering.id
</td><td>
Sys\_id of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
</td></tr><tr><td>
productOffering.name
</td><td>
Name of the product offering.Data type: String
Table: Product Offering \[sn\_prd\_pm\_product\_offering\]
</td></tr><tr><td>
productRelationship
</td><td>
List of related products.Data type: Array of Objects
```
"productRelationship": [
{
"productId": "String",
"relationshipType": "String"
}
]
```
</td></tr><tr><td>
productRelationship.productId
</td><td>
Sys\_id of the related product.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
productRelationship.relationshipType
</td><td>
Type of relationship.Data type: String
</td></tr><tr><td>
productSpecification
</td><td>
Product specification for the product.Data type: Object
```
"productSpecification": {
"id": "String"
}
```
</td></tr><tr><td>
productSpecification.id
</td><td>
Sys\_id of the product specification.Data type: String
Table: Product Specification \[sn\_prd\_pm\_product\_specification\]
</td></tr><tr><td>
realizingResource
</td><td>
Realizing resource.Data type: Object
```
"realizingResource": {
"id": "String",
"type": "String"
}
```
</td></tr><tr><td>
realizingResource.id
</td><td>
Sys\_id of the realizing resourceData type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingResource.type
</td><td>
Type of the realizing resource.Data type: String
</td></tr><tr><td>
realizingService
</td><td>
Realizing service.Data type: Object
```
"realizingService": {
"id": "String",
"type": "String"
}
```
</td></tr><tr><td>
realizingService.id
</td><td>
Sys\_id of the realizing service.Data type: String
Table: Product Inventory \[sn\_prd\_invt\_product\_inventory\]
</td></tr><tr><td>
realizingService.type
</td><td>
Type of the realizing service.Data type: String
</td></tr><tr><td>
relatedParty
</td><td>
List of parties associated with the ticket.Data type: Array of Objects
```
"relatedParty": [
{
"id": "String",
"@referredType": "String"
}
]
```
</td></tr><tr><td>
relatedParty.id
</td><td>
Sys\_id of the account or customer contact associated with the ticket.Data type: String
Table: Account \[customer\_account\], Contact \[customer\_contact\], or Consumer \[csm\_consumer\]
</td></tr><tr><td>
relatedParty.@referredType
</td><td>
Type of customer.Possible values:
- Consumer
- Customer
- CustomerContact
Data type: String
</td></tr><tr><td>
state
</td><td>
Current state of the product.Data type: String
</td></tr></tbody>
</table>### cURL request
This example creates a product inventory for a voice over IP solution for a user.
```
curl --location --request POST "https://instance.servicenow.com/api/sn_prd_invt/productinventory" \
--header "Content-Type: application/json" \
--data-raw '[
{
"pid": "demoInventory",
"description": "inventory description",
"isBundle": false,
"name": "Voice Over IP Basic instance for Jean",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"@referredType": "ProductOffering"
},
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "choice",
"value": "Virtual"
},
{
"name":"Routing",
"valueType": "choice",
"value": "Premium"
}
],
"productRelationship": [
{
"productId": "7e6d13f45b5620102dff5e92dc81c787",
"relationshipType": "child"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"role": "User",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@referredType": "ProductSpecification",
"version": "1"
}
}
]'
--user 'username':'password'
```
Response body.
```
{
"pid": "demoInventory",
"description": "inventory description",
"isBundle": false,
"name": "Voice Over IP Basic instance for Jean",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"@referredType": "ProductOffering"
},
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "choice",
"value": "Virtual"
},
{
"name": "Routing",
"valueType": "choice",
"value": "Premium"
}
],
"productRelationship": [
{
"productId": "7e6d13f45b5620102dff5e92dc81c787",
"relationshipType": "child"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"role": "User",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@referredType": "ProductSpecification",
"version": "1"
},
"id": "3ac715c6745d8150f877ca57242ff97a"
}
```
| title | Product Inventory Open API |
| description | The Product Inventory Open API provides endpoints to create and retrieve product inventories.Deletes a specified product inventory record.Retrieves a list of all product inventories.Retrieves a specified product inventory record.Retrieves a list of all product inventories.Retrieves a product inventory.Updates a specified product inventory record.Creates a product inventory record.Creates a product inventory. |
| locale | en-US |
| canonical_url | https://www.servicenow.com/docs/r/api-reference/rest-apis/product-inventory-open-api.html |
| release | brazil |
| product | REST APIs |
| classification | rest-apis |
| topic_type | concept |
| last_updated | 2026-09-10 |
| reading_time_minutes | 52 |
| breadcrumb | REST API referenceAPI referenceAPI implementation and reference |