Version: eXtendPS-SE 1.4.2 and
above
Audience: Administrator, Developer
Overview
The Product Data service must be
configured
before it can be made available to distributors. The
configuration maps fields from the
NetSuite item object to the
corresponding fields in the
PromoStandards Product
Data API response.
Configuration
To configure the Product
Data service for eXtendPS-SE, go to eXtendTech →
eXtendPS-SE → Product
Data Setup to access its configuration page.
Product Primary Information
Map the Product
Primary Information fields based on the following descriptions:
- Product
ID* - Item
id field in NetSuite. Recommended field: {itemid}.
- Product
Name* - Supplier name of the product
field in NetSuite. Recommended
field: {displayname}.
- Description*- Field
in NetSuite that contains the
product description or a
bulleted list of descriptions. Recommended field: {salesdescription}.
- Product
Brand -
Product brand field in
NetSuite. Included field: eXtendPS-SE
Product Brand
{custitem_extend_promo_product_brand}.
- Export -
Checkbox field in NetSuite
that determines if a product
can be
exported. Included field: eXtendPS-SE Product
Export
{custitem_extend_promo_api_prod_export}.
- Last Change
Date* -
Field in NetSuite that
specifies the date when the
product was
last changed. Recommended field: {lastmodifieddate}.
- Creation
Date* -
Field in NetSuite that
specifies the date when the
product was
created. Recommended field: {createddate}.
- End
Date - Field in NetSuite that
specifies the date when the
product will
be discontinued. Recommended field: {enddate}. Included field: eXtendPS-SE Product End
Date
{custitem_extend_promo_api_end_date}.
- Effective
Date - Field in NetSuite that
specifies the date when the
product will
be effective. Recommended field: {createddate}. Included field: eXtendPS-SE Product
Effective Date
{custitem_extend_promo_api_eff_date}.
- Is
Caution -
Checkbox field in NetSuite
that determines if there are
cautionary comments associated
with the product. Included field: eXtendPS-SE Product Is
Caution
{custitem_extend_promo_api_is_caution}.
- Caution
Comment - Field in NetSuite that lists
the cautionary comments
associated
with the product. Included field: eXtendPS-SE Product Is
Caution Comment
{custitem_extend_product_caution_commen}.
- Is Close
Out - Checkbox field in NetSuite
that indicates if the product
is a
closeout. Included field: eXtendPS-SE Product
Part - Is Close Out
{custitem_extend_promo_api_part_close}.
Note: If functional mappings are used for this field to send data in the PromoStandards response, then thegetProductCloseOut()
service call will not work as expected. - Line
Name -
Field in NetSuite that
contains the Line Name or
Division to which the product
belongs. Included field: eXtendPS-SE
Product Line Name
{custitem_extend_product_line_name}.
- Compliance Info
Available (2.0 Only) - Checkbox
field in NetSuite that
determines whether the
compliance
information is available for
the product or not. This field
is applicable only
for the Product Data 2.0.0
service.
- UNSPC Commodity Code
(2.0 Only) - Field
in NetSuite that contains the
UNSPC commodity code on the item
record.
- Validate Response - Checkbox field that
determines whether to validate the data type of the fields before returning the response or not.
Product Keyword Information
Map the Product
Keyword Information field based on the following description:
- Keyword - Field in
NetSuite that contains the
common keywords of the product
used by search or other
functions.
Product Part Primary Information
Map the Product
Part Primary Information fields based on the following descriptions:
- Product Part
ID* -
Product part id field in
NetSuite. Recommended
field: {itemid}.
- Product Part
Description -
Product description field in
NetSuite. Recommended
field: {salesdescription}.
- Product Part Country of
Origin -
Field in NetSuite that
contains the
country of origin for the
part. Recommended field: {countryofmanufacture}.
Note: The values of this field should conform to ISO 3166-1 Alpha 2 coding standards. Example: CA = Canada, US = United States - Product Part Primary
Material - Field
in NetSuite that contains the
primary material of
construction. Included field: eXtendPS-SE Product
Part Primary Material {custitem_extend_product_part_material}.
- Product Part
Shape -
Field in NetSuite that
contains the general shape of
the product
part. Included field: eXtendPS-SE
Product Part Shape
{custitem_extend_product_part_shape}.
- Product Part Lead
Time -
Field in NetSuite that
contains the lead time for the
product
part measured in days. Included field: eXtendPS-SE Product
Part Lead Time
{custitem_extend_product_part_lead_time}.
- Product Part
UNSPSC -
Field in NetSuite that
contains the United Nations
Standard
Products and Services Code
(UNSPSC). Included field: eXtendPS-SE Product
Part UNSPSC
{custitem_extend_product_part_unspsc}.
- Product Part
GTIN -
Field in NetSuite that
contains the Global Trade Item
Number
(GTIN). Included field: eXtendPS-SE Product
Part GTIN
{custitem_extend_product_part_gtin}.
- In Rush
Service -
Checkbox field in NetSuite
that indicates if the product
part is
Rush service. Included field: eXtendPS-SE Product
Part - Is Rush Service
{custitem_extend_promo_api_rush_service}.
- Part End
Date -
Field in NetSuite that
specifies when the product
part will be
discontinued. Included field: eXtendPS-SE Product
End Date
{custitem_extend_promo_api_end_date}.
- Part Effective
Date - Field in NetSuite that
specifies when the product
part will be
effective. Includd field: eXtendPS-SE Product
Part Effective Date
{custitem_extend_part_effective_date}.
- Part Is
Caution -
Checkbox field in NetSuite
that specifies if there are
cautionary
comments associated with the
product part. Included field: eXtendPS-SE Product
Is Caution
{custitem_extend_promo_api_is_caution}.
- Part Caution
Comment - Field in NetSuite
that lists the cautionary
comments associated with the
product part. Included field: eXtendPS-SE
Product Is Caution
Comment
{custitem_extend_product_caution_commen}.
- Part Is Close
Out -
Checkbox field in NetSuite
that indicates if the product
part is
a closeout. Included field: eXtendPS-SE Product
Part - Is Close Out
{custitem_extend_promo_api_part_close}.
- Part NMFC
Code -
Field in NetSuite that
contains the National Motor
Freight
Classification (NMFC) code for
the product part. Included field: eXtendPS-SE
Product Part NMFC
Code
{custitem_extend_product_part_nmfc_code}.
- Part NMFC
Description -
Field in NetSuite that
contains the National Motor
Freight
Classification (NMFC)
description for the product
part. Included field: eXtendPS-SE Product
Part NMFC Description
{custitem_extend_product_part_nmfc_desc}.
- Part NMFC
Number -
Field in NetSuite that
contains the National Motor
Freight
Classification (NMFC) number
for the product part. Included field: eXtendPS-SE
Product Part NMFC
number
{custitem_extend_product_part_nmfc_num}.
- Part Is On
Demand -
Checkbox field in NetSuite
that determines if the product
part is
manufactured on
demand.
- Part Is
HAZMAT -
Checkbox field in NetSuite
that indicates if the product
part as
a hazardous
material. Included field: eXtendPS-SE Product
Part - Is Hazmat
{custitem_extend_promo_api_part_is_hzmt}.
Note: A nil value (unchecked checkbox) indicates that HAZMAT information is unknown or unavailable.
Product Part Dimension
Map the Product
Part Dimension fields based on the following descriptions:
- Dimension UOM For
All* - The
unit of measure (UOM) being
used for product part
dimensions.
- Dimension UOM
Field -
Field in NetSuite that
contains the dimension unit of
measure
(UOM) for the product part. Included field: eXtendPS-SE
Product Part Dimension
Uom
Field
{custitem_extend_promo_api_dim_uomfield}.
- Depth -
Field in NetSuite that
contains the depth of the
product part
using the specified UOM. Included field: eXtendPS-SE
Product Part Dimension
Depth
{custitem_extend_promo_api_dim_depth}.
- Height -
Field in NetSuite that
contains the height of the
product part
using the specified UOM. Included field: eXtendPS-SE
Product Part Dimension
Height
{custitem_extend_promo_api_dim_height}.
- Width -
Field in NetSuite that
contains the width of the
product part
using the specified UOM. Included field: eXtendPS-SE
Product Part Dimension
Width {custitem_extend_promo_api_dim_width}.
- Weight UOM
Field* -
Field in NetSuite that
contains the weight unit of
measure (UOM)
for the product part. Recommended field: {weightunit}.
- Weight -
Field in NetSuite that
contains the weight of the
product part. Rrecommended
field: {weight}.
- In the “Dimension UOM
Map” sublist, create
mappings between NetSuite's
dimension unit values and PromoStandards' dimension unit
values. For detailed
information regarding
PromoStandards' API UOM, see: https://tools.promostandards.org/product-data-2-0-0.
- In the “Weight UOM Map” sublist, create mappings
between NetSuite's weight unit
values and
PromoStandards' weight unit
values. For detailed
information regarding
PromoStandards' API UOM, see https://tools.promostandards.org/product-data-2-0-0.
Product Part Color
Map the Product
Part Color fields based on the following descriptions:
- Part Color
Name - Field in NetSuite that
contains the color name of the
product
part. Included field: eXtendPS-SE
Product Part Color
Name
{custitem_extend_promo_api_part_color}.
- Part Color
Hex -
Field in NetSuite that
contains the hex-value of the
color of the
product part. Included field: eXtendPS-SE Product
Part Color Hex
{custitem_extend_promo_api_part_clr_hex}.
- Part Color Approximate
PMS -
Field in NetSuite that
contains the
approximate PMS of the color
of the product part. Included field: eXtendPS-SE
Product Part Color
Approximate PMS
{custitem_extend_promo_api_part_clr_pms}.
Product Part Apparel Size
Map the Product
Part Apparel Size fields based on the following descriptions:
- Part Apparel
Style -
Field in NetSuite that
contains the apparel size for
non-matrix
items. Included field: eXtendPS-SE Product
Part Apparel
Size Style {custitem_extend_promo_api_app_style}.
- Part Apparel Label
Size - Field in NetSuite that
contains the apparel label
size for
non-matrix items. Included field: eXtendPS-SE
Product Part Apparel
Label Size
{custitem_extend_promo_api_app_label_si}.
- In the "Apparel Size Map",
create mappings between the
values for apparel
sizes which are used in your
NetSuite account against the
enumerated values of
sizes supported by
PromoStandards. Note: This mapping will also be
used for generating
the inventory
service
response.
Product Part Specification
Map the Product
Part Specification fields based on the following descriptions:
- Specification
Type* - Specification
type of the product part
related to
PromoStandards.
- Specification
Unit -
Specification unit of the
product part against the
selected part
specification
type.
- Measurement
Value* - Field
in NetSuite that contains the
measurement value of the
product part.
Other Configuration
Map the Other Configuration fields based on the following descriptions:
General
- Suppress Assembly
Components - This
checkbox determines
whether to suppress
assembly components or
not.
- Suppress Kit
Components - This
checkbox
determines whether to
suppress kit components or
not.
- Additional Item
Search
Columns - Specify
the item field ID which is
used in
functional mappings. You
can specify multiple
fields in a
comma-separated
format.
- Product Search Filters - This field will work in conjunction with the Product ID field's value. The field specified in this field will be used for filtering the items for creating the product pricing and configuration response. The field specified in the Product ID field will be used for displaying the item name in the response. If this field is left empty, the field specified under Product ID will be used for both filtering and showing the item name in response. For more detail regarding the usage of this field, see Remove Parent Name from Part Name in PromoStandards Response.
- Product Search Column - Specify internal ID of the field used in any functional mapping created for product search.
- Part Search Filters - This field will work in conjunction with Part ID field's value. The field specified in this field will be used for filtering the items for creating pricing & configuration response. And the field specified in Part ID field will be used for displaying the item name in the response. If this field is left empty, then the field specified under Part ID field will be used for both filtering and showing the item name in response. For more detail regarding the usage of this field please refer this article.
- Part Search Column - Specify internal ID of the field used in any functional mapping created for part search.
- Part Search Max Count - Specify the maximum number of parts which will be sent in response.
- Assembly Component Search Max Count - Specify the maximum number of assembly components which will be sent in response.
- Kit Component Search Max Count - Specify the maximum number of assembly components which will be sent in response.
- Exclude Item Types - Select
the item types you want to
exclude from the
response.
Product 2.0 Specific
Configuration
- Fetch Product Primary
Image URL Realtime - In
general, the product
primary
image is fetched from a
custom item field. More
details regarding the
functionality of this
field can be found in Product
Primary Image URL
sourcing in Product
Data 2.0 response.
If this checkbox is
checked, then the primary
image URL will not be
sourced from
this custom item field and
it will be sourced in
real-time.
- Fetch Product
Decoration
Realtime - In
general, the product
decoration
information served in the
Product Data response from
the eXtendTech
Cache-Store custom
record. More details
regarding the
functionality of this
method can be found in How
the Location
Decoration Array is
Sent in the
eXtendPS-SE Product
Data 2.0.0
Response.
If this checkbox is
checked, then the primary
image URL will not be
sourced from
this custom record and it
will be sourced in
real-time.
- Fetch Product Price
Realtime - In
general, product pricing
is fetched
from a custom item field.
More details regarding the
functionality of this
field
can be found in this Configurations
for Product Data 2.0.0
Item Pricing.
If this checkbox is
checked, then the product
pricing will not be
sourced from
this custom item field and
it will be sourced in
real-time.
- Product Price Group
Search - Saved
search ID of the search
which will be used
for fetching the product
pricing group in
real-time. It will only be
used when
the Fetch Product
Price Realtime checkbox
is checked, otherwise the
product price group will
be in the Product Data
response from a
custom item field as
mentioned in Configurations
for Product Data 2.0.0
Item
Pricing.
- Fetch Product FOB
Points
Realtime - In
general, product FOB
points are
fetched from a custom item
field. More details
regarding the
functionality of
this field can be found in Configurations
for Product Data 2.0.0
Item Pricing.
If this checkbox is
checked, then the product
FOB points will not be
sourced
from this custom item
field and it will be
sourced in
real-time.
- Imprint Size - Field in NetSuite that contains the imprint size applied to the item.
Note: The field id can be specified using any of the formats below: - Use
text:{HARDCODED_VALUE}
if you want to include a static response. {fieldIdA},{fieldIdB},{fieldIdC}
if you want to include the first non-null field in the response.fn:{FUNCTION_NAME}
if you want to include response from a JavaScript function defined in the JavaScript filesuite_promoapi_invoice_transformers.js
.- Arguments passed (from script) for functional mapping:
itemSearchResult: MAIN_PRODUCT_SEARCH_RESULT
itemSearchResults: MAIN_PRODUCT_SEARCH_RESULTS
- Sample function:
/** * * @param {Object} args * @prop {Object} args.itemSearchResult * @prop {Object} args.itemSearchResults */ function product_getDefaultImprintSize(args) { return { attributes: { 'xmlns': 'http://www.promostandards.org/WSDL/ProductDataService/2.0.0/SharedObjects/' }, $value: 'Description of Imprint Size' }; }
- Default Set Up Charge - Field in
NetSuite that contains the
default setup charge
applied to the
item.
Note: The field id can be specified using any of the formats below: - Use
text:{HARDCODED_VALUE}
if you want to include a static response. {fieldIdA},{fieldIdB},{fieldIdC}
if you want to include the first non-null field in the response.fn:{FUNCTION_NAME}
if you want to include response from a JavaScript function defined in the JavaScript filesuite_promoapi_invoice_transformers.js
.- Arguments passed (from script) for functional mapping:
itemSearchResult: MAIN_PRODUCT_SEARCH_RESULT
itemSearchResults: MAIN_PRODUCT_SEARCH_RESULTS
- Sample function:
/** * * @param {Object} args * @prop {Object} args.itemSearchResult * @prop {Object} args.itemSearchResults */ function product_getDefaultSetupCharge(args) { return { attributes: { 'xmlns': 'http://www.promostandards.org/WSDL/ProductDataService/2.0.0/SharedObjects/' }, $value: 'Description of Default Setup Charge' }; }
- Default Run Charge - Field in NetSuite that
contains the default run
charge applied to the
item. Note: The
field id
can
be
specified using any of the formats below:
- Use
text:{HARDCODED_VALUE}
if you want to include a static response. {fieldIdA},{fieldIdB},{fieldIdC}
if you want to include the first non-null field in the response.fn:{FUNCTION_NAME}
if you want to include response from a JavaScript function defined in the JavaScript filesuite_promoapi_invoice_transformers.js
.- Arguments passed (from script) for functional mapping:
itemSearchResult: MAIN_PRODUCT_SEARCH_RESULT
itemSearchResults: MAIN_PRODUCT_SEARCH_RESULTS
- Sample function:
/** * * @param {Object} args * @prop {Object} args.itemSearchResult * @prop {Object} args.itemSearchResults */ function product_getDefaultRunCharge(args) { return { attributes: { 'xmlns': 'http://www.promostandards.org/WSDL/ProductDataService/2.0.0/SharedObjects/' }, $value: 'Description of Default Run Charge' }; }
Product 2.0 Pricing
Fields
- Industry Discount
Code - Field in
NetSuite that contains the
industry discount code
applied
to the item. Included field: eXtendPS-SE
Industry Discount
Code { custitem_extend_promo_ind_code}.
Note: After version 1.3.8, the Industry Discount Code will be read from the Product Pricing and Configuration Service Setup Configuration page's Discount Code Field field. - Price Group Name - Field in
NetSuite that contains the
price group name applied
to the
item.
- Price Group
Description - Field in
NetSuite that contains the
price group description of
the
price group applied to the
item.
Product Sellable Service
See Configure Product Data's getProductSellable Service for configuration of the Product Sellable Service subtab.
Additional Notes
- The Product Pricing and Configuration Service Setup Configuration must be completed to get a Product Data 2.0
response.
- After
version 1.3.8, the Industry
Discount Code will be read from the Product Pricing and Configuration Service Setup Configuration page's Discount
Code
Field field.