Function Reference for SPS Commerce Connector
In general, Functions are used by Visual Data Mapper to transform or generate target data within a map.
SPS Commerce Connector provides several functions to aid with mappings in Visual Data Mapper.
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Date - Convert To B1 Date |
Attempts to convert the provided date string into B1-supported date string. Returns the date string or an invalid date message. | 1.2+ |
| SPS B1WebAPI | Date - Validate B1 Date |
Validates that the provided date is already in B1-supported date format. Outputs the date string as provided, or an invalid date message. | 1.2+ |
| SPS B1WebAPI | Item Price - Get Batch Price |
Get prices for the provided batch of items/card codes. | 1.2+ |
| SPS B1WebAPI | Item Price - Get Item Price |
Get pricing for the specified customer Card Code and Item Code. | 1.2+ |
| SPS B1WebAPI | Query - Get All Categories |
Get a list of all b1 query categories. | 1.2+ |
| SPS B1WebAPI | Query - Get Queries in Category |
Get a list of b1 queries in the provided Query Category Name. | 1.2+ |
| SPS B1WebAPI | Query - Get Query Results |
Run a B1 query for the supplied Query Category name and Query name. Optionally supply parameters as a string. Gets all results from the query. Note, parameter string must include the ? prefix. Example parameter string: ?CardCode=C20000&Param2=Value2&Param3=Value3. |
1.2+ |
| SPS B1WebAPI | Query - Get Query Results for Named Column |
Run a B1 query for the supplied Query Category name and Query name. Optionally supply a list of parameters. Gets data only for the specified column. | 1.2+ |
| SPS B1WebAPI | Query - Get Query Results for Named Column for XSLT |
Run a B1 query for the supplied Query Category name and Query name. Optionally supply parameters. Gets data only for the specified column.Note, parameter string must include the ? prefix. Example parameter string: ?CardCode=C20000&Param2=Value2&Param3=Value3 |
1.2+ |
| SPS B1WebAPI | Query - Get Query Results for XSLTs |
Run a B1 query for the supplied Query Category name and Query name. Optionally supply a list of parameters. Gets all results from the query. | 1.2+ |
| SPS B1WebAPI | Query - Get Scalar Result |
Execute a B1 query for the supplied Query name. Gets the scalar result (first column and row only) from the query and discards all other data. Query Parameters not supported. | 1.2+ |
| SPS B1WebAPI | Query - Has Results |
Returns true if the indicated query has results. Optionally provide query parameters. |
1.2+ |
| SPS B1WebAPI | Query - Run Query |
Run the B1 Query in the named Query and Query Category. Returns results in the selected output format. Query Parameters not supported. | 1.2+ |
| SPS B1WebAPI | UDT - Get All UDTs |
Get a list of all User Defined Tables (UDT). | 1.2+ |
| SPS B1WebAPI | UDT - Get Records for UDT |
Get all records from a User Defined Table (UDT). Requires the UDT name. | 1.2+ |
| SPS B1WebAPI | UDT - Get UDT Record by Key |
Get a record from a User Defined Table (UDT). Requires the UDT name and record Code. | 1.2+ |
Function Names
Date - Convert To B1 Date
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Date - Convert To B1 Date |
Attempts to convert the provided date string into B1-supported date string. Returns the date string or an invalid date message. | 1.2+ |
Date - Validate B1 Date
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Date - Validate B1 Date |
Validates that the provided date is already in B1-supported date format. Outputs the date string as provided, or an invalid date message. | 1.2+ |
Item Price - Get Batch Price
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Item Price - Get Batch Price |
Get prices for the provided batch of items/card codes. | 1.2+ |
Item Price - Get Item Price
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Item Price - Get Item Price |
Get pricing for the specified customer Card Code and Item Code. | 1.2+ |
Query - Get All Categories
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Query - Get All Categories |
Get a list of all b1 query categories. | 1.2+ |
Query - Get Queries in Category
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Query - Get Queries in Category |
Get a list of b1 queries in the provided Query Category Name. | 1.2+ |
Query - Get Query Results
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Query - Get Query Results |
Run a B1 query for the supplied Query Category name and Query name. Optionally supply parameters as a string. Gets all results from the query. Note, parameter string must include the ? prefix. Example parameter string: ?CardCode=C20000&Param2=Value2&Param3=Value3. |
1.2+ |
Query - Get Query Results for Named Column
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Query - Get Query Results for Named Column |
Run a B1 query for the supplied Query Category name and Query name. Optionally supply a list of parameters. Gets data only for the specified column. | 1.2+ |
Query - Get Query Results for Named Column for XSLT
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Query - Get Query Results for Named Column for XSLT |
Run a B1 query for the supplied Query Category name and Query name. Optionally supply parameters. Gets data only for the specified column.Note, parameter string must include the ? prefix. Example parameter string: ?CardCode=C20000&Param2=Value2&Param3=Value3 |
1.2+ |
Query - Get Query Results for XSLTs
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Query - Get Query Results for XSLTs |
Run a B1 query for the supplied Query Category name and Query name. Optionally supply a list of parameters. Gets all results from the query. | 1.2+ |
Query - Get Scalar Result
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Query - Get Scalar Result |
Execute a B1 query for the supplied Query name. Gets the scalar result (first column and row only) from the query and discards all other data. Query Parameters not supported. | 1.2+ |
Query - Has Results
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Query - Has Results |
Returns true if the indicated query has results. Optionally provide query parameters. |
1.2+ |
Query - Run Query
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | Query - Run Query |
Run the B1 Query in the named Query and Query Category. Returns results in the selected output format. Query Parameters not supported. | 1.2+ |
UDT - Get All UDTs
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | UDT - Get All UDTs |
Get a list of all User Defined Tables (UDT). | 1.2+ |
UDT - Get Records for UDT
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | UDT - Get Records for UDT |
Get all records from a User Defined Table (UDT). Requires the UDT name. | 1.2+ |
UDT - Get UDT Record by Key
| Category | Function Name | Description | Version |
|---|---|---|---|
| SPS B1WebAPI | UDT - Get UDT Record by Key |
Get a record from a User Defined Table (UDT). Requires the UDT name and record Code. | 1.2+ |