--- sourceDocument: Xanadu Finance and Supply Chain sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/source-to-pay-operations Release : - xanadu ft:locale : - en-US ft:publication_title : - Xanadu Finance and Supply Chain ft:clusterId : - stpop bundleId : - stpop workflow : - Creator --- # Spendint API - POST /sn_spend_intg/spendint/availability # Spendint API - POST /sn_spend_intg/spendint/availability {#ariaid-title1} * Release version: Xanadu * * Updated August 1, 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read Updates the availability for supplier product records. When supplier product records are available, the API uses the product SKU to find an existing supplier product. If a matching supplier product exists, the corresponding available_units field is updated. If no matching supplier product is found, an error message generates stating that the product for which you are trying to update availability for does not exist. ## Status tables {#spendint-POST-availability__section_hrm_qts_knb} To know the status of the update availability request, make a REST call into the ServiceNow database using the Table REST API. The response from the API lists the records where the update availability request failed. For update availability response, query the Availability Error table with the following parameter: `sysparm_query=outbound_error.supplier_id=^outbound_error.state=20` The details on the customer ID, supplier ID, error type, unique import set ID, and state can be found in the Outbound Status table, which is the parent error table. ## URL format {#spendint-POST-availability__section_alq_xd2_dmb} /api/sn_spend_intg/spendint/availability ## Supported request parameters {#spendint-POST-availability__entry__2} | Name | Description | |-|-| | None | | [Table 1. Path parameters] {#spendint-POST-availability__table_rdf_2ck_ymb__entry__2} | Name | Description | |-|-| | mode | Support for asynchronous and synchronous modes for third-party integration. Data type: String Valid values: * async: Asynchronous mode. * sync: Synchronous mode. {#spendint-POST-availability__ul_hdr_tkg_ymb} Default: async | [Table 2. Query parameters] {#spendint-POST-availability__table_rdf_2ck_ymb} {#spendint-POST-availability__entry__10} | Name | Description | |-|-| | catalog_id | Required. Identifier for the catalog content that can be purchased by a customer. Data type: String Maximum length: 100 | | customer_id | Required. Identifier for the customer. Data type: String Maximum length: 100 | | products | List of objects that define the products to update. Each transaction has a limit of 1000 products. Data type: Array "products": [ { "available_units": "String", "sku": "String", "unit": "String" } ] | | products.available_units | Required for products that are kept in stock. Number of units available for this product. Data type: String Maximum length: 40 | | products.sku | Required. Number that is generated by a supplier that uniquely identifies a product sold by that supplier. Data type: String Maximum length: 100 | | products.unit | Required. Unit or rate at which the product is sold by the supplier. For example, pieces, hours, and so on. Data type: String Maximum length: 100 | | supplier_id | Identifier for the reseller or supplier that the customer can place orders with. Data type: String Maximum length: 100 | | third_party_import_id | Allows a third-party to pass a string value to uniquely identify a set of imported data. Data type: String Maximum length: 100 | [Table 3. Request body parameters (XML or JSON)] ## Headers The following request and response headers apply to this HTTP action only or apply to this action in a distinct way. {#spendint-POST-availability__entry__28}{#spendint-POST-availability__accept-RESTAPI} | Header | Description | |-|-| | Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json | [Table 4. Request headers] Note: Only the application/json data format is supported for Procurement Integration Framework. {#spendint-POST-availability__entry__32} | Header | Description | |-|-| | None | | [Table 5. Response headers] ## Status codes The following status codes apply to this HTTP action. {#spendint-POST-availability__table_lml_1qg_ymb__entry__2} | Status code | Description | |-|-| | success | Successful. The request was successfully processed. | | failure | Unsuccessful. The request was processed with errors. | [Table 6. Status codes] {#spendint-POST-availability__table_lml_1qg_ymb} ## Response body parameters (JSON) {#spendint-POST-availability__section_usm_1hk_ymb} These response body parameters are received when queried in synchronous mode.{#spendint-POST-availability__table_vsm_1hk_ymb__entry__2} | Name | Description | |-|-| | error_response_body | Description of the errors, listed by sku and the error message. Data type: Array | | error_response_body.error_message | Detailed error message. Data type: String | | status_code | Response status such as "success" or "failure." Data type: String | [ ] {#spendint-POST-availability__table_vsm_1hk_ymb} ## cURL request curl "https://instance.servicenow.com/api/sn_spend_intg/spendint/availability" \ --request POST \ --header "Accept:application/json" \ --user 'username':'password' {"root": [{ "customer_id": "AB-1234323", "catalog_id": "ACME CORP", "supplier_id": "SUP-123456", "third_party_import_id": "DEL6789876", "products": [ { "sku": "5578874", "unit": "Each", "available_units": "20" } ] } ]} Possible responses: // Success response: { "result": { "response": "success" } } Error response: { "result": { "response": [ { "customer_id": "AB-1234323", "supplier_id": "SUP-123456", "third_party_import_id": "DEL6789876", "status_code": "failure", "error_response_body": [ { "sku": "5578874", "error_message": "The product for which you are trying to update availability does not exist\nField Value empty/Formatting issue Unit\n" } ] } ] } }