Spendint API

</td></tr><tr><td>

products.available\_units

</td><td>

Required for products that are kept in stock. This value indicates the quantity of units that are available for this product.Data type: String

 Maximum length: 40

</td></tr><tr><td>

products.available\_for\_country

</td><td>

List of country codes where the supplier product can be purchased. If no country is provided, a user from any country can purchase the product.Data type: Array

 ```
"available_for_country": ["US","IN","GB"]

</td></tr><tr><td>

products.contract\_agreement

</td><td>

Details of the contract for a product.Data type: Object

 ```
"contract_agreement": {
  "contract_end_date": "String",
  "contract_number": "String",
  "contract_start_date": "String",
  "negotiated_currency ": "String",
  "negotiated_price": "String"
}

</td></tr><tr><td>

products.available\_units

</td><td>

Required for products that are kept in stock. Number of units available for this product.Data type: String

 Maximum length: 40

</td></tr><tr><td>

products.sku

</td><td>

Required. Number that is generated by a supplier that uniquely identifies a product sold by that supplier.Data type: String

 Maximum length: 100

</td></tr><tr><td>

products.unit

</td><td>

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

</td></tr><tr><td>

supplier\_id

</td><td>

Identifier for the reseller or supplier that the customer can place orders with.Data type: String

 Maximum length: 100

</td></tr><tr><td>

third\_party\_import\_id

</td><td>

Allows a third-party to pass a string value to uniquely identify a set of imported data.Data type: String

 Maximum length: 100

</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.

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

**Note:** Only the **application/json** data format is supported for Procurement Integration Framework.

|Header|Description|
|------|-----------|
|None| |

### Status codes

The following status codes apply to this HTTP action.

|Status code|Description|
|-----------|-----------|
|success|Successful. The request was successfully processed.|
|failure|Unsuccessful. The request was processed with errors.|

### Response body parameters \(JSON\)

These response body parameters are received when queried in synchronous mode.

<table id="table_vsm_1hk_ymb"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

error\_response\_body

</td><td>

Description of the errors, listed by sku and the error message.Data type: Array

</td></tr><tr><td>

error\_response\_body.error\_message

</td><td>

Detailed error message.Data type: String

</td></tr><tr><td>

status\_code

</td><td>

Response status such as "success" or "failure."Data type: String

</td></tr></tbody>
</table>

### cURL request

Possible responses:

## Spendint API - POST /sn\_spend\_intg/spendint/orderack

Updates order information for when a user shops for a product from a third-party catalog. When the user checks out, a purchase line is created so that approvals or other tasks for the purchase can be completed.

When a purchase order is generated in the ServiceNow database, the order is pushed into the following tables:

-   Outbound Order: Contains the order header.
-   Outbound Order Line: Contains the order lines.

Suppliers need to query these tables and fetch the orders that are pending against them. Suppliers should create a scoped app for Workflow Studio actions for integrating with the ServiceNow database.

Query the tables with the following parameters:

-   `sysparm_query=supplier_id=<supplier_id>^purchase_order.status=20 for header`
-   `sysparm_query=purchase_order.supplier_id=<supplier_id>^purchase_order.status=20 for header`

When a purchase line is converted to a purchase order line, the following processes are run:

1.  The purchase order and purchase order line are submitted to the Enterprise Resource Planning \(ERP\), if applicable.
2.  The purchase order and purchase order line are transferred through integration to the third party with the customer ID, supplier ID, purchase order number, order date, purchase order amount, purchase order amount currency, and purchase order lines.
3.  The purchase order and purchase order line remain in the Pending Submission state until confirmation messages are received by both the third-party catalog integration and the ERP. After confirmation is received, the state is updated to Ordered. If there is no ERP integration involved, a confirmation message is required only from the third-party integration.

### Status tables

To know the status of the order acknowledgment request, make a REST call into the ServiceNow database using the Table REST API. The response from the API lists the records where the order acknowledgment request failed. For an order acknowledgment response, query the Order Acknowledgment Error table with the following parameter:

`sysparm_query=outbound_error.supplier_id=<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

`/api/sn_spend_intg/spendint/orderack`

### Supported request parameters

|Name|Description|
|----|-----------|
|None| |

<table id="table_sd3_lck_ymb" class="rest_api_query_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

mode

</td><td>

Support for asynchronous and synchronous modes for third-party integration.Data type: String

 Valid values:

-   async: Asynchronous mode.
-   sync: Synchronous mode.

 Default: async

</td></tr></tbody>
</table>

<table class="rest_api_request_body"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

customer\_id

</td><td>

Required. Identifier for the customer.Data type: String

 Maximum length: 100

</td></tr><tr><td>

order\_number

</td><td>

Required. Purchase order number provided by the customer for this order.Data type: String

 Maximum length: 40

</td></tr><tr><td>

sales\_order\_lines

</td><td>

List of objects that define the sales order lines with unique updates for the purchases in this order.Data type: Array

 ```
"sales_order_lines":[
  {
    "estimated_arrival_date": "String",
    "line_number": "String",
    "sales_order_line_number": "String"
  }
]

</td></tr><tr><td>

shipment\_lines.actual\_shipment\_date

</td><td>

Date on which the shipment leaves the supplier’s location.Data type: String

 Maximum length: 40

 Format: YYYY-MM-DD

</td></tr><tr><td>

shipment\_lines.estimated\_arrival\_date

</td><td>

Date on which the shipment is expected to arrive at the specified location.Data type: String

 Maximum length: 40

 Format: YYYY-MM-DD

</td></tr><tr><td>

shipment\_lines.line\_number

</td><td>

Required. Purchase order line number that is generated by the customer for a particular purchase.Data type: String

 Maximum length: 40

</td></tr><tr><td>

shipment\_lines.planned\_shipment\_date

</td><td>

Date on which the shipment is planned to leave the supplier’s location.Data type: String

 Maximum length: 40

 Format: YYYY-MM-DD

</td></tr><tr><td>

shipment\_lines.product\_details

</td><td>

List of objects that define the details about the products being shipped. Options include the serial number, IMEI number, and asset tag details.Data type: Array

 ```
"product_details": [
  {
    "asset_tag": "String",
    "imei": "String",
    "serial_number": "String"
  }
]

</td></tr><tr><td>

shipment\_lines.shipping\_address.city

</td><td>

Name of the city where the products are shipped to.Data type: String

 Maximum length: 1000

</td></tr><tr><td>

shipment\_lines.shipping\_address.country

</td><td>

Country where the products are shipped to.Data type: String

 Maximum length: 40

</td></tr><tr><td>

shipment\_lines.shipping\_address.name

</td><td>

Name of the customer that the products are being shipped to.Data type: String

 Maximum length: 1000

</td></tr><tr><td>

shipment\_lines.shipping\_address.state

</td><td>

State where the products are shipped to.Data type: String

 Maximum length: 1000

</td></tr><tr><td>

shipment\_lines.shipping\_address.street

</td><td>

Name of the street where the products are shipped to.Data type: String

 Maximum length: 1000

</td></tr><tr><td>

shipment\_lines.shipping\_address.zip\_code

</td><td>

Zip code or pin code where the products are shipped to.Data type: String

 Maximum length: 40

</td></tr><tr><td>

shipment\_lines.shipment\_quantity

</td><td>

Required. Number of the products being shipped as physical goods. The number should contain the quantity of the products that are in the shipment.Data type: String

 Maximum length: 40

</td></tr><tr><td>

shipment\_lines.shipping\_carrier

</td><td>

Shipping carrier that is delivering the product to the specified location such as FedEx, UPS, USPS, and so on.Data type: String

 Maximum length: 100

</td></tr><tr><td>

shipment\_lines.ship\_to

</td><td>

Name of the recipient that the products are shipped to.Data type: String

 Maximum length: 100

</td></tr><tr><td>

shipment\_lines.tracking\_number

</td><td>

Tracking number that is provided by the shipping carrier for the whole or a portion of the purchase.Data type: String

 Maximum length: 100

</td></tr><tr><td>

supplier\_id

</td><td>

Required. Identifier for the reseller or supplier that the customer can place orders with.Data type: String

 Maximum length: 100

</td></tr><tr><td>

supplier\_shipment\_number

</td><td>

Required. Identification number that is generated for this shipment. Typically, this number is generated by an Enterprise Resource Planning \(ERP\) or order tracking system.Data type: String

 Maximum length: 100

</td></tr><tr><td>

third\_party\_import\_id

</td><td>

Identifier that enables a third party to pass a string value to uniquely identify a set of imported data.Data type: String

 Maximum length: 100

</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.

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

**Note:** Only the **application/json** data format is supported for Procurement Integration Framework.

|Header|Description|
|------|-----------|
|None| |

### Status codes

The following status codes apply to this HTTP action.

|Status code|Description|
|-----------|-----------|
|success|Successful. The request was successfully processed.|
|failure|Unsuccessful. The request was processed with errors.|

### Response body parameters \(JSON\)

These response body parameters are received when queried in synchronous mode.

<table id="table_igg_bhk_ymb"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

error\_response\_body

</td><td>

Description of the errors, listed by the sales order line number, sales order number, supplier shipment number, and the error message.Data type: Array

</td></tr><tr><td>

error\_response\_body.error\_message

</td><td>

Detailed error message.Data type: String

</td></tr><tr><td>

status\_code

</td><td>

Response status such as "success" or "failure."Data type: String

</td></tr></tbody>
</table>

### cURL request

Possible responses: