...
Code Block |
---|
|
<netsuite.getAll>
<record>{$ctx:record}</record>
</netsuite.getAll> |
Properties
records:
The required record element to be retrieved.
...
Code Block |
---|
language | xml |
---|
title | Sample Request for getAll |
---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="wso2.connector.netsuite.getall">
<soapenv:Header></soapenv:Header>
<soapenv:Body>
<urn:apiUrl>https://webservices.na1.netsuite.com/services/NetSuitePort_2014_1</urn:apiUrl>
<urn:warningAsError>true</urn:warningAsError>
<urn:disableMandatoryCustomFieldValidation>false</urn:disableMandatoryCustomFieldValidation>
<urn:disableSystemNotesForCustomFields>true</urn:disableSystemNotesForCustomFields>
<urn:ignoreReadOnlyFields>true</urn:ignoreReadOnlyFields>
<urn:partnerId></urn:partnerId>
<urn:applicationId></urn:applicationId>
<urn:email>user@gmail.com</urn:email>
<urn:password>123</urn:password>
<urn:account>TVTDRV1193710</urn:account>
<urn:roleInternalId></urn:roleInternalId>
<urn:roleExternalId></urn:roleExternalId>
<urn:roleType></urn:roleType>
<urn:roleName></urn:roleName>
<urn:record>
<platformMsgs:record recordType="state" xmlns:platformMsgs="urn:messages_2014_1.platform.webservices.netsuite.com"/>
</urn:record>
</soapenv:Body>
</soapenv:Envelope> |
Related NetSuite documentation
...
Anchor |
---|
| getCustomizationId |
---|
| getCustomizationId |
---|
|
Retrieving customization ID
...
Once the IDs are returned, you can pass the ID value(s) to the getList
operation to obtain metadata for specific custom objects (see Using getList with getCustomizationId for more details). If you are returning large sets of metadata, the getCustomizationId
operation allows you to add pagination to break your response into multiple pieces.
Info |
---|
To see the UI equivalent of a NetSuite custom object, go to Customization > Lists, Records, and Fields > [custom object type]. For information on working with each object type in Web services, see SuiteBuilder Overview. For a more general understanding of the NetSuite customization model, see SuiteBuilder (Customization).Normally, you Normally, you cannot add or update the internalId of a NetSuite object. Custom objects are an exception to this rule. You can specify the ID on add, but you cannot update the ID thereafter. Also note that the internalId for custom objects can be set to any unique alphanumeric string up to 30 characters long. This string cannot include any spaces, but it can include underscores ( _ ).
|
Code Block |
---|
language | xml |
---|
title | getCustomizationId |
---|
|
<netsuite.getCustomizationId>
<customizationType>{$ctx:customizationType}</customizationType>
<includeInactives>{$ctx:includeInactives}</includeInactives>
</netsuite.getCustomizationId> |
Properties
customizationType:
Any of the custom object types enumerated in CustomizationType
.
includeInactives:
A value of "true" or "false" is required. A value of "false" means no inactive custom objects are returned in the response. A value of "true" means that both active and inactive custom objects are returned in the response.
...
Code Block |
---|
language | xml |
---|
title | Sample Request for getCustomizationId |
---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="wso2.connector.netsuite.getcustomizationid">
<soapenv:Header/>
<soapenv:Body>
<urn:apiUrl>https://webservices.na1.netsuite.com/services/NetSuitePort_2014_1</urn:apiUrl>
<urn:warningAsError/>
<urn:disableMandatoryCustomFieldValidation/>
<urn:disableSystemNotesForCustomFields/>
<urn:ignoreReadOnlyFields/>
<urn:partnerId/>
<urn:applicationId/>
<urn:email>user@gmail.com</urn:email>
<urn:password>123</urn:password>
<urn:account>TVTDRV1193710</urn:account>
<urn:roleInternalId/>
<urn:roleExternalId/>
<urn:roleType/>
<urn:roleName/>
<urn:customizationIdReferece >
<customizationType getCustomizationType="customRecordType"/>
<includeInactives>false</includeInactives>
</urn:customizationIdReferece>
</soapenv:Body>
</soapenv:Envelope> |
Related NetSuite documentation
...
Anchor |
---|
| getDataCenterUrls |
---|
| getDataCenterUrls |
---|
|
Retrieving data center URLs
...
Code Block |
---|
language | xml |
---|
title | getDataCenterUrls |
---|
|
<netsuite.getDataCenterUrls>
<accountRef>{$ctx:accountRef}</accountRef>
</netsuite.getDataCenterUrls> |
Properties
accountRef:
The details of the account.
...
Code Block |
---|
language | xml |
---|
title | Sample Request for getDataCenterUrls |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="wso2.connector.netsuite.getdatacenterurls">
<soapenv:Header>
</soapenv:Header>
<soapenv:Body>
<urn:apiUrl>https://webservices.na1.netsuite.com/services/NetSuitePort_2014_1</urn:apiUrl>
<urn:warningAsError></urn:warningAsError>
<urn:disableMandatoryCustomFieldValidation></urn:disableMandatoryCustomFieldValidation>
<urn:disableSystemNotesForCustomFields></urn:disableSystemNotesForCustomFields>
<urn:ignoreReadOnlyFields></urn:ignoreReadOnlyFields>
<urn:partnerId></urn:partnerId>
<urn:applicationId></urn:applicationId>
<urn:email>user@gmail.com</urn:email>
<urn:password>123</urn:password>
<urn:account>TVTDRV11937101</urn:account>
<urn:roleInternalId></urn:roleInternalId>
<urn:roleExternalId></urn:roleExternalId>
<urn:roleType></urn:roleType>
<urn:roleName></urn:roleName>
<urn:accountRef>
<account>TSTDRV11937101</account>
</urn:accountRef>
</soapenv:Body>
</soapenv:Envelope> |
Related NetSuite documentation
https://system.na1.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteTalkWebServices/getDataCenterUrls.html
...
Anchor |
---|
| getItemAvailability |
---|
| getItemAvailability |
---|
|
Retrieving item availabilityThe getItemAvailability
operation can be used to retrieve the inventory availability for a given list of items. You can filter the returned list using a lastQtyAvailableChange
filter. If set, only items with a quantity of available changes recorded as of this date are returned. If the Multi-Location Inventory feature is enabled, this operation returns results for all locations. For locations that do not have any items available, only location IDs and names are listed in results.
...
Code Block |
---|
language | xml |
---|
title | getItemAvailability |
---|
|
<netsuite.getItemAvailability>
<itemAvailabilityFilter>{$ctx:itemAvailabilityFilter}</itemAvailabilityFilter>
</netsuite.getItemAvailability> |
Properties
itemAvailabilityFilter:
Holds details about the item in which the availability data should be retrieved.
item:
References an existing item record in NetSuite.
lastQtyAvailableChange:
If set, only items with a quantity of available changes recorded as of the specified date are returned.
...
Code Block |
---|
language | xml |
---|
title | Sample Request for getItemAvailability |
---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="wso2.connector.netsuite.getitemavailability">
<soapenv:Header></soapenv:Header>
<soapenv:Body>
<urn:apiUrl>https://webservices.na1.netsuite.com/services/NetSuitePort_2014_1</urn:apiUrl>
<urn:warningAsError>true</urn:warningAsError>
<urn:disableMandatoryCustomFieldValidation>false</urn:disableMandatoryCustomFieldValidation>
<urn:disableSystemNotesForCustomFields>true</urn:disableSystemNotesForCustomFields>
<urn:ignoreReadOnlyFields>true</urn:ignoreReadOnlyFields>
<urn:partnerId></urn:partnerId>
<urn:applicationId></urn:applicationId>
<urn:email>user@gmail.com</urn:email>
<urn:password>123</urn:password>
<urn:account>TVTDRV1193710</urn:account>
<urn:roleInternalId></urn:roleInternalId>
<urn:roleExternalId></urn:roleExternalId>
<urn:roleType></urn:roleType>
<urn:roleName></urn:roleName>
<urn:itemAvailabilityFilter>
<platformMsgs:itemAvailabilityFilter xmlns:platformMsgs="urn:messages_2014_1.platform.webservices.netsuite.com"
xmlns:platformCore="urn:core_2014_1.platform.webservices.netsuite.com">
<platformCore:item>
<!--Zero or more repetitions:-->
<platformCore:recordRef internalId="387" type="inventoryItem">
<!--Optional:-->
<platformCore:name></platformCore:name>
</platformCore:recordRef>
</platformCore:item>
<!--Optional:-->
<!--if the date is not specified-->
<platformCore:lastQtyAvailableChange>2014-04-20T16:09:55.000-07:00</platformCore:lastQtyAvailableChange>
</platformMsgs:itemAvailabilityFilter>
</urn:itemAvailabilityFilter>
</soapenv:Body>
</soapenv:Envelope> |
Related NetSuite documentation
...
Retrieving one or more records
...
Code Block |
---|
|
<netsuite.getList>
<recordRef>{$ctx:recordRef}</recordRef>
</netsuite.getList> |
Properties
recordRef:
An array of recordRef
objects that specify the IDs of the records to be retrieved.
...
Code Block |
---|
language | xml |
---|
title | Sample Request for getList |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="wso2.connector.netsuite.getlist">
<soapenv:Header></soapenv:Header>
<soapenv:Body>
<urn:apiUrl>https://webservices.na1.netsuite.com/services/NetSuitePort_2014_1</urn:apiUrl>
<urn:warningAsError></urn:warningAsError>
<urn:disableMandatoryCustomFieldValidation></urn:disableMandatoryCustomFieldValidation>
<urn:disableSystemNotesForCustomFields></urn:disableSystemNotesForCustomFields>
<urn:ignoreReadOnlyFields></urn:ignoreReadOnlyFields>
<urn:partnerId></urn:partnerId>
<urn:applicationId></urn:applicationId>
<urn:email>user@gmail.com</urn:email>
<urn:password>123</urn:password>
<urn:account>TVTDRV1193710</urn:account>
<urn:roleInternalId></urn:roleInternalId>
<urn:roleExternalId></urn:roleExternalId>
<urn:roleType></urn:roleType>
<urn:roleName></urn:roleName>
<urn:recordRef>
<RecordRef internalId="2857" type="customer" xsi:type="platformCore:RecordRef" xmlns:platformCore="urn:core_2014_1.platform.webservices.netsuite.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<RecordRef internalId="3451" type="customer" xsi:type="platformCore:RecordRef" xmlns:platformCore="urn:core_2014_1.platform.webservices.netsuite.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</urn:recordRef>
</soapenv:Body>
</soapenv:Envelope> |
Related NetSuite documentation
https://system.na1.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteTalkWebServices/getList.html
Anchor |
---|
getSelectValue | getSelectValue | Retrieving a selected
Anchor |
---|
| getSelectValue |
---|
| getSelectValue |
---|
|
Retrieving a selected value
The getSelectValue
operation can be used to retrieve valid select options for a given RecordRef, CustomRecordRef, or enumerated static field. This is useful if you are writing an application UI that needs to mimic NetSuite UI logic, if the referenced record type is not yet exposed in SuiteTalk, or when the logged-in user's role does not have permission to the instances of the referenced record type. A call to getSelectValue
may return different results for the same field for different roles.
...
Code Block |
---|
language | xml |
---|
title | Sample Request for getSelectValue |
---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="wso2.connector.netsuite.getselectvalue">
<soapenv:Header></soapenv:Header>
<soapenv:Body>
<urn:apiUrl>https://webservices.na1.netsuite.com/services/NetSuitePort_2014_1</urn:apiUrl>
<urn:warningAsError></urn:warningAsError>
<urn:disableMandatoryCustomFieldValidation></urn:disableMandatoryCustomFieldValidation>
<urn:disableSystemNotesForCustomFields></urn:disableSystemNotesForCustomFields>
<urn:ignoreReadOnlyFields></urn:ignoreReadOnlyFields>
<urn:partnerId></urn:partnerId>
<urn:applicationId></urn:applicationId>
<urn:email>user@gmail.com</urn:email>
<urn:password>123</urn:password>
<urn:account>TVTDRV1193710</urn:account>
<urn:roleInternalId></urn:roleInternalId>
<urn:roleExternalId></urn:roleExternalId>
<urn:roleType></urn:roleType>
<urn:roleName></urn:roleName>
<urn:selectValue>
<fieldDescription xmlns:platformCore="urn:core_2014_1.platform.webservices.netsuite.com">
<platformCore:recordType>salesOrder</platformCore:recordType>
<platformCore:sublist>itemList</platformCore:sublist>
<platformCore:field>item</platformCore:field>
<platformCore:filterByValueList>
<platformCore:filterBy>
<platformCore:field>entity</platformCore:field>
<platformCore:internalId>8</platformCore:internalId>
</platformCore:filterBy>
</platformCore:filterByValueList>
</fieldDescription>
<pageIndex>1</pageIndex>
</urn:selectValue>
</soapenv:Body>
</soapenv:Envelope> |
...
https://system.na1.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteTalkWebServices/getSelectValue.html
Searching for records
...
Basic search — Execute a search on a record type based on search filter fields that are specific to that type. See Basic Searches in Web Services.
Joined search — Execute a search on a record type based on search filter fields on an associated record type. See Joined Searches in Web Services.
Advanced search — Execute a search on a record type in which you specify search filter fields and search return columns or joined search columns. Using advanced search, you can also return an existing saved search. See Advanced Searches in Web Services.
Remove the following parameters in the init
operation before executing the search
operation: warningAsError
, disableSystemNotesForCustomFields
, ignoreReadOnlyFields
, and disableMandatoryCustomFieldValidation
. For example:
Code Block |
---|
|
<netsuite.init>
<apiUrl>{$ctx:apiUrl}</apiUrl>
<roleInternalId>{$ctx:roleInternalId}</roleInternalId>
<partnerId>{$ctx:partnerId}</partnerId>
<applicationId>{$ctx:applicationId}</applicationId>
<roleName>{$ctx:roleName}</roleName>
<password>{$ctx:password}</password>
<roleExternalId>{$ctx:roleExternalId}</roleExternalId>
<email>{$ctx:email}</email>
<account>{$ctx:account}</account>
<roleType>{$ctx:roleType}</roleType>
</netsuite.init> |
...
Code Block |
---|
|
<netsuite.search>
<bodyFieldsOnly>{$ctx:bodyFieldsOnly}</bodyFieldsOnly>
<returnSearchColumns>{$ctx:returnSearchColumns}</returnSearchColumns>
<pageSize>{$ctx:pageSize}</pageSize>
<searchRecord>{$ctx:searchRecord}</searchRecord>
</netsuite.search> |
Properties
bodyFieldsOnly:
Defaults to "true" and indicates that the information in the body fields of the record is returned.returnSearchColumns:
Defaults to "true" meaning that only search columns will be returned in your search.pageSize:
Preferred pagination integer value.searchRecord:
The record or records that need to be searched for.
...
Code Block |
---|
language | xml |
---|
title | Sample Request for search |
---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="wso2.connector.netsuite.search">
<soapenv:Header></soapenv:Header>
<soapenv:Body>
<urn:apiUrl>https://webservices.na1.netsuite.com/services/NetSuitePort_2014_1</urn:apiUrl>
<urn:bodyFieldsOnly>true</urn:bodyFieldsOnly>
<urn:returnSearchColumns>true</urn:returnSearchColumns>
<urn:pageSize></urn:pageSize>
<urn:partnerId></urn:partnerId>
<urn:applicationId></urn:applicationId>
<urn:email>user@gmail.com</urn:email>
<urn:password>123</urn:password>
<urn:account>TVTDRV1193710</urn:account>
<urn:roleInternalId></urn:roleInternalId>
<urn:roleExternalId></urn:roleExternalId>
<urn:roleType></urn:roleType>
<urn:roleName></urn:roleName>
<urn:searchRecord>
<platformMsgs:searchRecord xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:EmployeeSearch" xmlns:ns1="urn:employees_2014_1.lists.webservices.netsuite.com" xmlns:platformMsgs="urn:messages_2014_1.platform.webservices.netsuite.com" xmlns:platformCore="urn:core_2014_1.platform.webservices.netsuite.com">
<basic>
<email operator="contains" xsi:type="platformCore:SearchStringField">
<searchValue>.com</searchValue>
</email>
</basic>
</platformMsgs:searchRecord>
</urn:searchRecord>
</soapenv:Body>
</soapenv:Envelope> |
Related NetSuite documentation
...
Sample configuration
...