const{Fragment:e,jsx:n,jsxs:l}=arguments[0];function _createMdxContent(r){const a={a:"a",code:"code",figure:"figure",h2:"h2",h3:"h3",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",span:"span",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...r.components},{FAQ:i,RelatedCallout:s}=a;return i||_missingMdxReference("FAQ",!0),s||_missingMdxReference("RelatedCallout",!0),l(e,{children:[l(a.h2,{id:"netsuite-development-platform-an-honest-api-guide",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#netsuite-development-platform-an-honest-api-guide",children:n(a.span,{className:"icon icon-link"})}),"NetSuite development platform: an honest API guide"]}),"\n",n(a.p,{children:"If you've landed here, you're probably trying to connect something to NetSuite. Maybe it's a custom application, maybe it's syncing data with another platform, or maybe you're just exploring what's possible. Either way, you've got options — and they're not all created equal."}),"\n",n(a.p,{children:"NetSuite has accumulated several API approaches over the years, each with different strengths. The good news: for most new projects, the path is clear. The REST API is modern, well-documented, and handles the majority of use cases. Start there unless you have a specific reason not to."}),"\n",n(a.p,{children:"The overview below shows when each API type makes sense, but don't let the table fool you into thinking they're equivalent choices. REST is the default; the others exist for specific scenarios."}),"\n",l(a.table,{children:[n(a.thead,{children:l(a.tr,{children:[n(a.th,{children:"API Type"}),n(a.th,{children:"Best For"}),n(a.th,{children:"Protocol"}),n(a.th,{children:"Authentication"})]})}),l(a.tbody,{children:[l(a.tr,{children:[n(a.td,{children:n(a.strong,{children:"SuiteTalk REST"})}),n(a.td,{children:"Modern integrations, mobile apps"}),n(a.td,{children:"REST/JSON"}),n(a.td,{children:"OAuth 2.0, TBA"})]}),l(a.tr,{children:[n(a.td,{children:n(a.strong,{children:"SuiteTalk SOAP"})}),n(a.td,{children:"Legacy systems, complex transactions"}),n(a.td,{children:"SOAP/XML"}),n(a.td,{children:"TBA"})]}),l(a.tr,{children:[n(a.td,{children:n(a.strong,{children:"RESTlets"})}),n(a.td,{children:"Custom endpoints, specific business logic"}),n(a.td,{children:"REST/JSON"}),n(a.td,{children:"TBA, OAuth 2.0"})]}),l(a.tr,{children:[n(a.td,{children:n(a.strong,{children:"SuiteAnalytics Connect"})}),n(a.td,{children:"BI tools, data extraction"}),n(a.td,{children:"ODBC/JDBC"}),n(a.td,{children:"User credentials"})]})]})]}),"\n",n(a.hr,{}),"\n",l(a.h2,{id:"suitetalk-rest-api",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#suitetalk-rest-api",children:n(a.span,{className:"icon icon-link"})}),"SuiteTalk REST API"]}),"\n",n(a.p,{children:"The REST API is where you should start. Introduced in 2019 and continuously expanded, it covers most standard record types and operations with clean JSON payloads and sensible endpoint patterns. If you've worked with modern REST APIs elsewhere, this will feel familiar."}),"\n",l(a.h3,{id:"base-url-structure",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#base-url-structure",children:n(a.span,{className:"icon icon-link"})}),"Base URL Structure"]}),"\n",n(a.pre,{children:n(a.code,{children:"https://{accountId}.suitetalk.api.netsuite.com/services/rest/record/v1/{recordType}\n"})}),"\n",n(a.p,{children:"Example for a customer record:"}),"\n",n(a.pre,{children:n(a.code,{children:"https://1234567.suitetalk.api.netsuite.com/services/rest/record/v1/customer/123\n"})}),"\n",l(a.h3,{id:"common-operations",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#common-operations",children:n(a.span,{className:"icon icon-link"})}),"Common Operations"]}),"\n",n(a.p,{children:n(a.strong,{children:"GET a record:"})}),"\n",n(a.figure,{"data-rehype-pretty-code-figure":"",children:n(a.pre,{style:{backgroundColor:"#24292e",color:"#e1e4e8"},tabIndex:"0","data-language":"bash","data-theme":"github-dark",children:l(a.code,{"data-language":"bash","data-theme":"github-dark",style:{display:"grid"},children:[l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#B392F0"},children:"curl"}),n(a.span,{style:{color:"#79B8FF"},children:" -X"}),n(a.span,{style:{color:"#9ECBFF"},children:" GET"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#9ECBFF"},children:" 'https://1234567.suitetalk.api.netsuite.com/services/rest/record/v1/customer/123'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -H"}),n(a.span,{style:{color:"#9ECBFF"},children:" 'Authorization: Bearer {access_token}'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -H"}),n(a.span,{style:{color:"#9ECBFF"},children:" 'Content-Type: application/json'"})]})]})})}),"\n",n(a.p,{children:n(a.strong,{children:"Create a record (POST):"})}),"\n",n(a.figure,{"data-rehype-pretty-code-figure":"",children:n(a.pre,{style:{backgroundColor:"#24292e",color:"#e1e4e8"},tabIndex:"0","data-language":"bash","data-theme":"github-dark",children:l(a.code,{"data-language":"bash","data-theme":"github-dark",style:{display:"grid"},children:[l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#B392F0"},children:"curl"}),n(a.span,{style:{color:"#79B8FF"},children:" -X"}),n(a.span,{style:{color:"#9ECBFF"},children:" POST"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#9ECBFF"},children:" 'https://1234567.suitetalk.api.netsuite.com/services/rest/record/v1/customer'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -H"}),n(a.span,{style:{color:"#9ECBFF"},children:" 'Authorization: Bearer {access_token}'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -H"}),n(a.span,{style:{color:"#9ECBFF"},children:" 'Content-Type: application/json'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -d"}),n(a.span,{style:{color:"#9ECBFF"},children:" '{"})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#9ECBFF"},children:' "companyName": "Acme Corp",'})}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#9ECBFF"},children:' "email": "contact@acme.com",'})}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#9ECBFF"},children:' "subsidiary": {"id": "1"}'})}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#9ECBFF"},children:" }'"})})]})})}),"\n",n(a.p,{children:n(a.strong,{children:"Update a record (PATCH):"})}),"\n",n(a.figure,{"data-rehype-pretty-code-figure":"",children:n(a.pre,{style:{backgroundColor:"#24292e",color:"#e1e4e8"},tabIndex:"0","data-language":"bash","data-theme":"github-dark",children:l(a.code,{"data-language":"bash","data-theme":"github-dark",style:{display:"grid"},children:[l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#B392F0"},children:"curl"}),n(a.span,{style:{color:"#79B8FF"},children:" -X"}),n(a.span,{style:{color:"#9ECBFF"},children:" PATCH"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#9ECBFF"},children:" 'https://1234567.suitetalk.api.netsuite.com/services/rest/record/v1/customer/123'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -H"}),n(a.span,{style:{color:"#9ECBFF"},children:" 'Authorization: Bearer {access_token}'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -H"}),n(a.span,{style:{color:"#9ECBFF"},children:" 'Content-Type: application/json'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -d"}),n(a.span,{style:{color:"#9ECBFF"},children:" '{"})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#9ECBFF"},children:' "email": "newemail@acme.com"'})}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#9ECBFF"},children:" }'"})})]})})}),"\n",n(a.p,{children:n(a.strong,{children:"Search/Query (SuiteQL):"})}),"\n",n(a.figure,{"data-rehype-pretty-code-figure":"",children:n(a.pre,{style:{backgroundColor:"#24292e",color:"#e1e4e8"},tabIndex:"0","data-language":"bash","data-theme":"github-dark",children:l(a.code,{"data-language":"bash","data-theme":"github-dark",style:{display:"grid"},children:[l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#B392F0"},children:"curl"}),n(a.span,{style:{color:"#79B8FF"},children:" -X"}),n(a.span,{style:{color:"#9ECBFF"},children:" POST"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#9ECBFF"},children:" 'https://1234567.suitetalk.api.netsuite.com/services/rest/query/v1/suiteql'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -H"}),n(a.span,{style:{color:"#9ECBFF"},children:" 'Authorization: Bearer {access_token}'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -H"}),n(a.span,{style:{color:"#9ECBFF"},children:" 'Content-Type: application/json'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -H"}),n(a.span,{style:{color:"#9ECBFF"},children:" 'Prefer: transient'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -d"}),n(a.span,{style:{color:"#9ECBFF"},children:" '{"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#9ECBFF"},children:' "q": "SELECT id, companyname, email FROM customer WHERE isinactive = \''}),n(a.span,{style:{color:"#79B8FF"},children:"\\'"}),n(a.span,{style:{color:"#9ECBFF"},children:"'F'"}),n(a.span,{style:{color:"#79B8FF"},children:"\\'"}),n(a.span,{style:{color:"#9ECBFF"},children:"' ORDER BY id\""})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#9ECBFF"},children:" }'"})})]})})}),"\n",l(a.h3,{id:"supported-record-types",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#supported-record-types",children:n(a.span,{className:"icon icon-link"})}),"Supported Record Types"]}),"\n",n(a.p,{children:"The REST API supports most standard and custom record types:"}),"\n",l(a.ul,{children:["\n",l(a.li,{children:[n(a.strong,{children:"Transactions:"})," Sales Orders, Purchase Orders, Invoices, Payments, etc."]}),"\n",l(a.li,{children:[n(a.strong,{children:"Entities:"})," Customers, Vendors, Employees, Contacts"]}),"\n",l(a.li,{children:[n(a.strong,{children:"Items:"})," Inventory Items, Service Items, Non-Inventory Items"]}),"\n",l(a.li,{children:[n(a.strong,{children:"Custom Records:"})," Any custom record type you've created"]}),"\n",l(a.li,{children:[n(a.strong,{children:"Sublists:"})," Line items on transactions"]}),"\n"]}),"\n",l(a.p,{children:["Check the ",n(a.a,{href:"https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2024.1/index.html",children:"NetSuite REST API Browser"})," for the complete list."]}),"\n",n(a.hr,{}),"\n",l(a.h2,{id:"authentication-methods",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#authentication-methods",children:n(a.span,{className:"icon icon-link"})}),"Authentication Methods"]}),"\n",l(a.h3,{id:"token-based-authentication-tba",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#token-based-authentication-tba",children:n(a.span,{className:"icon icon-link"})}),"Token-Based Authentication (TBA)"]}),"\n",n(a.p,{children:"TBA is required for all production integrations. It uses OAuth 1.0 with four credentials:"}),"\n",l(a.ol,{children:["\n",l(a.li,{children:[n(a.strong,{children:"Consumer Key"})," (from integration record)"]}),"\n",l(a.li,{children:[n(a.strong,{children:"Consumer Secret"})," (from integration record)"]}),"\n",l(a.li,{children:[n(a.strong,{children:"Token ID"})," (from access token)"]}),"\n",l(a.li,{children:[n(a.strong,{children:"Token Secret"})," (from access token)"]}),"\n"]}),"\n",n(a.p,{children:n(a.strong,{children:"Setup Steps:"})}),"\n",l(a.ol,{children:["\n",l(a.li,{children:["Create an ",n(a.strong,{children:"Integration Record"})," (Setup > Integration > Manage Integrations > New)"]}),"\n",l(a.li,{children:["Enable ",n(a.strong,{children:"Token-Based Authentication"})]}),"\n",l(a.li,{children:["Create an ",n(a.strong,{children:"Access Token"})," for the integration"]}),"\n",n(a.li,{children:"Generate the OAuth signature for each request"}),"\n"]}),"\n",n(a.p,{children:n(a.strong,{children:"Example OAuth 1.0 Header:"})}),"\n",n(a.pre,{children:n(a.code,{children:'OAuth oauth_consumer_key="abc123",\n oauth_token="def456",\n oauth_signature_method="HMAC-SHA256",\n oauth_timestamp="1234567890",\n oauth_nonce="randomstring",\n oauth_version="1.0",\n oauth_signature="calculated_signature"\n'})}),"\n",l(a.h3,{id:"oauth-20-rest-api",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#oauth-20-rest-api",children:n(a.span,{className:"icon icon-link"})}),"OAuth 2.0 (REST API)"]}),"\n",n(a.p,{children:"For the REST API, OAuth 2.0 with Client Credentials flow is also supported:"}),"\n",n(a.figure,{"data-rehype-pretty-code-figure":"",children:n(a.pre,{style:{backgroundColor:"#24292e",color:"#e1e4e8"},tabIndex:"0","data-language":"bash","data-theme":"github-dark",children:l(a.code,{"data-language":"bash","data-theme":"github-dark",style:{display:"grid"},children:[n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#6A737D"},children:"# Get access token"})}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#B392F0"},children:"curl"}),n(a.span,{style:{color:"#79B8FF"},children:" -X"}),n(a.span,{style:{color:"#9ECBFF"},children:" POST"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#9ECBFF"},children:" 'https://1234567.suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/token'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -H"}),n(a.span,{style:{color:"#9ECBFF"},children:" 'Content-Type: application/x-www-form-urlencoded'"}),n(a.span,{style:{color:"#79B8FF"},children:" \\"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" -d"}),n(a.span,{style:{color:"#9ECBFF"},children:" 'grant_type=client_credentials&client_id={client_id}&client_secret={client_secret}'"})]})]})})}),"\n",n(a.hr,{}),"\n",l(a.h2,{id:"suitetalk-soap-api",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#suitetalk-soap-api",children:n(a.span,{className:"icon icon-link"})}),"SuiteTalk SOAP API"]}),"\n",n(a.p,{children:"The SOAP API is the original NetSuite API, still widely used for complex transactions and legacy integrations."}),"\n",l(a.h3,{id:"wsdl-location",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#wsdl-location",children:n(a.span,{className:"icon icon-link"})}),"WSDL Location"]}),"\n",n(a.pre,{children:n(a.code,{children:"https://webservices.netsuite.com/wsdl/v2024_1_0/netsuite.wsdl\n"})}),"\n",l(a.h3,{id:"example-soap-request-get-customer",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#example-soap-request-get-customer",children:n(a.span,{className:"icon icon-link"})}),"Example SOAP Request (Get Customer)"]}),"\n",n(a.figure,{"data-rehype-pretty-code-figure":"",children:n(a.pre,{style:{backgroundColor:"#24292e",color:"#e1e4e8"},tabIndex:"0","data-language":"xml","data-theme":"github-dark",children:l(a.code,{"data-language":"xml","data-theme":"github-dark",style:{display:"grid"},children:[l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:""})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:"<"}),n(a.span,{style:{color:"#85E89D"},children:"soap:Envelope"}),n(a.span,{style:{color:"#B392F0"},children:" xmlns:soap"}),n(a.span,{style:{color:"#E1E4E8"},children:"="}),n(a.span,{style:{color:"#9ECBFF"},children:'"http://schemas.xmlsoap.org/soap/envelope/"'})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#B392F0"},children:" xmlns:ns"}),n(a.span,{style:{color:"#E1E4E8"},children:"="}),n(a.span,{style:{color:"#9ECBFF"},children:'"urn:messages_2024_1.platform.webservices.netsuite.com"'}),n(a.span,{style:{color:"#E1E4E8"},children:">"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" <"}),n(a.span,{style:{color:"#85E89D"},children:"soap:Header"}),n(a.span,{style:{color:"#E1E4E8"},children:">"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" <"}),n(a.span,{style:{color:"#85E89D"},children:"ns:tokenPassport"}),n(a.span,{style:{color:"#E1E4E8"},children:">"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" <"}),n(a.span,{style:{color:"#85E89D"},children:"ns:account"}),n(a.span,{style:{color:"#E1E4E8"},children:">1234567"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" <"}),n(a.span,{style:{color:"#85E89D"},children:"ns:consumerKey"}),n(a.span,{style:{color:"#E1E4E8"},children:">abc123"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" <"}),n(a.span,{style:{color:"#85E89D"},children:"ns:token"}),n(a.span,{style:{color:"#E1E4E8"},children:">def456"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" <"}),n(a.span,{style:{color:"#85E89D"},children:"ns:nonce"}),n(a.span,{style:{color:"#E1E4E8"},children:">random"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" <"}),n(a.span,{style:{color:"#85E89D"},children:"ns:timestamp"}),n(a.span,{style:{color:"#E1E4E8"},children:">1234567890"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" <"}),n(a.span,{style:{color:"#85E89D"},children:"ns:signature"}),n(a.span,{style:{color:"#B392F0"},children:" algorithm"}),n(a.span,{style:{color:"#E1E4E8"},children:"="}),n(a.span,{style:{color:"#9ECBFF"},children:'"HMAC-SHA256"'}),n(a.span,{style:{color:"#E1E4E8"},children:">signature"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" "})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" "})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" <"}),n(a.span,{style:{color:"#85E89D"},children:"soap:Body"}),n(a.span,{style:{color:"#E1E4E8"},children:">"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" <"}),n(a.span,{style:{color:"#85E89D"},children:"ns:get"}),n(a.span,{style:{color:"#E1E4E8"},children:">"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" <"}),n(a.span,{style:{color:"#85E89D"},children:"ns:baseRef"}),n(a.span,{style:{color:"#B392F0"},children:" internalId"}),n(a.span,{style:{color:"#E1E4E8"},children:"="}),n(a.span,{style:{color:"#9ECBFF"},children:'"123"'}),n(a.span,{style:{color:"#B392F0"},children:" type"}),n(a.span,{style:{color:"#E1E4E8"},children:"="}),n(a.span,{style:{color:"#9ECBFF"},children:'"customer"'})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#B392F0"},children:" xsi:type"}),n(a.span,{style:{color:"#E1E4E8"},children:"="}),n(a.span,{style:{color:"#9ECBFF"},children:'"ns:RecordRef"'})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#B392F0"},children:" xmlns:xsi"}),n(a.span,{style:{color:"#E1E4E8"},children:"="}),n(a.span,{style:{color:"#9ECBFF"},children:'"http://www.w3.org/2001/XMLSchema-instance"'}),n(a.span,{style:{color:"#E1E4E8"},children:"/>"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" "})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" "})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:""})]})]})})}),"\n",l(a.h3,{id:"when-to-use-soap-vs-rest",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#when-to-use-soap-vs-rest",children:n(a.span,{className:"icon icon-link"})}),"When to Use SOAP vs REST"]}),"\n",l(a.table,{children:[n(a.thead,{children:l(a.tr,{children:[n(a.th,{children:"Use SOAP When"}),n(a.th,{children:"Use REST When"})]})}),l(a.tbody,{children:[l(a.tr,{children:[n(a.td,{children:"Complex transactions with many sublists"}),n(a.td,{children:"Simple CRUD operations"})]}),l(a.tr,{children:[n(a.td,{children:"Batch operations (addList, updateList)"}),n(a.td,{children:"Modern applications/mobile"})]}),l(a.tr,{children:[n(a.td,{children:"Integration with legacy systems"}),n(a.td,{children:"You prefer JSON over XML"})]}),l(a.tr,{children:[n(a.td,{children:"Specific operations not in REST API"}),n(a.td,{children:"SuiteQL queries needed"})]})]})]}),"\n",n(a.hr,{}),"\n",l(a.h2,{id:"restlets-custom-api-endpoints",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#restlets-custom-api-endpoints",children:n(a.span,{className:"icon icon-link"})}),"RESTlets (Custom API Endpoints)"]}),"\n",n(a.p,{children:"RESTlets are SuiteScript 2.x scripts that expose custom REST endpoints. They're perfect for:"}),"\n",l(a.ul,{children:["\n",n(a.li,{children:"Custom business logic not available via standard APIs"}),"\n",n(a.li,{children:"Aggregating data from multiple record types"}),"\n",l(a.li,{children:["Transforming data before/after ",n(a.a,{href:"/blog/netsuite-operations-guide",children:"NetSuite operations"})]}),"\n",n(a.li,{children:"Building microservices that interact with NetSuite"}),"\n"]}),"\n",l(a.h3,{id:"basic-restlet-structure",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#basic-restlet-structure",children:n(a.span,{className:"icon icon-link"})}),"Basic RESTlet Structure"]}),"\n",n(a.figure,{"data-rehype-pretty-code-figure":"",children:n(a.pre,{style:{backgroundColor:"#24292e",color:"#e1e4e8"},tabIndex:"0","data-language":"javascript","data-theme":"github-dark",children:l(a.code,{"data-language":"javascript","data-theme":"github-dark",style:{display:"grid"},children:[n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#6A737D"},children:"/**"})}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#6A737D"},children:" * "}),n(a.span,{style:{color:"#F97583"},children:"@NApiVersion"}),n(a.span,{style:{color:"#6A737D"},children:" 2.1"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#6A737D"},children:" * "}),n(a.span,{style:{color:"#F97583"},children:"@NScriptType"}),n(a.span,{style:{color:"#6A737D"},children:" Restlet"})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#6A737D"},children:" */"})}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#B392F0"},children:"define"}),n(a.span,{style:{color:"#E1E4E8"},children:"(["}),n(a.span,{style:{color:"#9ECBFF"},children:"'N/record'"}),n(a.span,{style:{color:"#E1E4E8"},children:", "}),n(a.span,{style:{color:"#9ECBFF"},children:"'N/search'"}),n(a.span,{style:{color:"#E1E4E8"},children:"], ("}),n(a.span,{style:{color:"#FFAB70"},children:"record"}),n(a.span,{style:{color:"#E1E4E8"},children:", "}),n(a.span,{style:{color:"#FFAB70"},children:"search"}),n(a.span,{style:{color:"#E1E4E8"},children:") "}),n(a.span,{style:{color:"#F97583"},children:"=>"}),n(a.span,{style:{color:"#E1E4E8"},children:" {"})]}),"\n",n(a.span,{"data-line":"",children:" "}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#6A737D"},children:" // Handle GET requests"})}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" const"}),n(a.span,{style:{color:"#B392F0"},children:" get"}),n(a.span,{style:{color:"#F97583"},children:" ="}),n(a.span,{style:{color:"#E1E4E8"},children:" ("}),n(a.span,{style:{color:"#FFAB70"},children:"requestParams"}),n(a.span,{style:{color:"#E1E4E8"},children:") "}),n(a.span,{style:{color:"#F97583"},children:"=>"}),n(a.span,{style:{color:"#E1E4E8"},children:" {"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" const"}),n(a.span,{style:{color:"#79B8FF"},children:" customerId"}),n(a.span,{style:{color:"#F97583"},children:" ="}),n(a.span,{style:{color:"#E1E4E8"},children:" requestParams.customerId;"})]}),"\n",n(a.span,{"data-line":"",children:" "}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" const"}),n(a.span,{style:{color:"#79B8FF"},children:" customerRecord"}),n(a.span,{style:{color:"#F97583"},children:" ="}),n(a.span,{style:{color:"#E1E4E8"},children:" record."}),n(a.span,{style:{color:"#B392F0"},children:"load"}),n(a.span,{style:{color:"#E1E4E8"},children:"({"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" type: record.Type."}),n(a.span,{style:{color:"#79B8FF"},children:"CUSTOMER"}),n(a.span,{style:{color:"#E1E4E8"},children:","})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#E1E4E8"},children:" id: customerId"})}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#E1E4E8"},children:" });"})}),"\n",n(a.span,{"data-line":"",children:" "}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" return"}),n(a.span,{style:{color:"#E1E4E8"},children:" {"})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#E1E4E8"},children:" id: customerRecord.id,"})}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" name: customerRecord."}),n(a.span,{style:{color:"#B392F0"},children:"getValue"}),n(a.span,{style:{color:"#E1E4E8"},children:"("}),n(a.span,{style:{color:"#9ECBFF"},children:"'companyname'"}),n(a.span,{style:{color:"#E1E4E8"},children:"),"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" email: customerRecord."}),n(a.span,{style:{color:"#B392F0"},children:"getValue"}),n(a.span,{style:{color:"#E1E4E8"},children:"("}),n(a.span,{style:{color:"#9ECBFF"},children:"'email'"}),n(a.span,{style:{color:"#E1E4E8"},children:"),"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" balance: customerRecord."}),n(a.span,{style:{color:"#B392F0"},children:"getValue"}),n(a.span,{style:{color:"#E1E4E8"},children:"("}),n(a.span,{style:{color:"#9ECBFF"},children:"'balance'"}),n(a.span,{style:{color:"#E1E4E8"},children:")"})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#E1E4E8"},children:" };"})}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#E1E4E8"},children:" };"})}),"\n",n(a.span,{"data-line":"",children:" "}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#6A737D"},children:" // Handle POST requests"})}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" const"}),n(a.span,{style:{color:"#B392F0"},children:" post"}),n(a.span,{style:{color:"#F97583"},children:" ="}),n(a.span,{style:{color:"#E1E4E8"},children:" ("}),n(a.span,{style:{color:"#FFAB70"},children:"requestBody"}),n(a.span,{style:{color:"#E1E4E8"},children:") "}),n(a.span,{style:{color:"#F97583"},children:"=>"}),n(a.span,{style:{color:"#E1E4E8"},children:" {"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" const"}),n(a.span,{style:{color:"#79B8FF"},children:" newCustomer"}),n(a.span,{style:{color:"#F97583"},children:" ="}),n(a.span,{style:{color:"#E1E4E8"},children:" record."}),n(a.span,{style:{color:"#B392F0"},children:"create"}),n(a.span,{style:{color:"#E1E4E8"},children:"({"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" type: record.Type."}),n(a.span,{style:{color:"#79B8FF"},children:"CUSTOMER"})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#E1E4E8"},children:" });"})}),"\n",n(a.span,{"data-line":"",children:" "}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" newCustomer."}),n(a.span,{style:{color:"#B392F0"},children:"setValue"}),n(a.span,{style:{color:"#E1E4E8"},children:"("}),n(a.span,{style:{color:"#9ECBFF"},children:"'companyname'"}),n(a.span,{style:{color:"#E1E4E8"},children:", requestBody.name);"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" newCustomer."}),n(a.span,{style:{color:"#B392F0"},children:"setValue"}),n(a.span,{style:{color:"#E1E4E8"},children:"("}),n(a.span,{style:{color:"#9ECBFF"},children:"'email'"}),n(a.span,{style:{color:"#E1E4E8"},children:", requestBody.email);"})]}),"\n",n(a.span,{"data-line":"",children:" "}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" const"}),n(a.span,{style:{color:"#79B8FF"},children:" customerId"}),n(a.span,{style:{color:"#F97583"},children:" ="}),n(a.span,{style:{color:"#E1E4E8"},children:" newCustomer."}),n(a.span,{style:{color:"#B392F0"},children:"save"}),n(a.span,{style:{color:"#E1E4E8"},children:"();"})]}),"\n",n(a.span,{"data-line":"",children:" "}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" return"}),n(a.span,{style:{color:"#E1E4E8"},children:" { success: "}),n(a.span,{style:{color:"#79B8FF"},children:"true"}),n(a.span,{style:{color:"#E1E4E8"},children:", customerId };"})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#E1E4E8"},children:" };"})}),"\n",n(a.span,{"data-line":"",children:" "}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" return"}),n(a.span,{style:{color:"#E1E4E8"},children:" { get, post };"})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#E1E4E8"},children:"});"})})]})})}),"\n",l(a.h3,{id:"deploying-a-restlet",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#deploying-a-restlet",children:n(a.span,{className:"icon icon-link"})}),"Deploying a RESTlet"]}),"\n",l(a.ol,{children:["\n",n(a.li,{children:"Upload the script to File Cabinet"}),"\n",n(a.li,{children:"Create a Script Record (Customization > Scripting > Scripts > New)"}),"\n",n(a.li,{children:"Create a Script Deployment"}),"\n",l(a.li,{children:["Note the ",n(a.strong,{children:"External URL"})," — this is your API endpoint"]}),"\n"]}),"\n",n(a.hr,{}),"\n",l(a.h2,{id:"suiteql-sql-like-queries",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#suiteql-sql-like-queries",children:n(a.span,{className:"icon icon-link"})}),"SuiteQL: SQL-like Queries"]}),"\n",l(a.p,{children:["SuiteQL allows SQL-like queries against NetSuite data via the REST API. It's faster and more flexible than ",n(a.a,{href:"/blog/saved-search-guide-netsuite",children:"saved searches"})," for data extraction."]}),"\n",l(a.h3,{id:"example-queries",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#example-queries",children:n(a.span,{className:"icon icon-link"})}),"Example Queries"]}),"\n",n(a.p,{children:n(a.strong,{children:"Basic query:"})}),"\n",n(a.figure,{"data-rehype-pretty-code-figure":"",children:n(a.pre,{style:{backgroundColor:"#24292e",color:"#e1e4e8"},tabIndex:"0","data-language":"sql","data-theme":"github-dark",children:l(a.code,{"data-language":"sql","data-theme":"github-dark",style:{display:"grid"},children:[l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:"SELECT"}),n(a.span,{style:{color:"#E1E4E8"},children:" id, companyname, email, balance"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:"FROM"}),n(a.span,{style:{color:"#E1E4E8"},children:" customer"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:"WHERE"}),n(a.span,{style:{color:"#E1E4E8"},children:" isinactive "}),n(a.span,{style:{color:"#F97583"},children:"="}),n(a.span,{style:{color:"#9ECBFF"},children:" 'F'"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:"ORDER BY"}),n(a.span,{style:{color:"#E1E4E8"},children:" balance "}),n(a.span,{style:{color:"#F97583"},children:"DESC"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:"LIMIT"}),n(a.span,{style:{color:"#79B8FF"},children:" 100"})]})]})})}),"\n",n(a.p,{children:n(a.strong,{children:"Join tables:"})}),"\n",n(a.figure,{"data-rehype-pretty-code-figure":"",children:n(a.pre,{style:{backgroundColor:"#24292e",color:"#e1e4e8"},tabIndex:"0","data-language":"sql","data-theme":"github-dark",children:l(a.code,{"data-language":"sql","data-theme":"github-dark",style:{display:"grid"},children:[n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#F97583"},children:"SELECT"})}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" t"}),n(a.span,{style:{color:"#E1E4E8"},children:"."}),n(a.span,{style:{color:"#79B8FF"},children:"id"}),n(a.span,{style:{color:"#E1E4E8"},children:","})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" t"}),n(a.span,{style:{color:"#E1E4E8"},children:"."}),n(a.span,{style:{color:"#79B8FF"},children:"tranid"}),n(a.span,{style:{color:"#E1E4E8"},children:","})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" t"}),n(a.span,{style:{color:"#E1E4E8"},children:"."}),n(a.span,{style:{color:"#79B8FF"},children:"trandate"}),n(a.span,{style:{color:"#E1E4E8"},children:","})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" c"}),n(a.span,{style:{color:"#E1E4E8"},children:"."}),n(a.span,{style:{color:"#79B8FF"},children:"companyname"}),n(a.span,{style:{color:"#F97583"},children:" as"}),n(a.span,{style:{color:"#E1E4E8"},children:" customer_name,"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" t"}),n(a.span,{style:{color:"#E1E4E8"},children:"."}),n(a.span,{style:{color:"#79B8FF"},children:"total"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:"FROM"}),n(a.span,{style:{color:"#F97583"},children:" transaction"}),n(a.span,{style:{color:"#E1E4E8"},children:" t"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:"JOIN"}),n(a.span,{style:{color:"#E1E4E8"},children:" customer c "}),n(a.span,{style:{color:"#F97583"},children:"ON"}),n(a.span,{style:{color:"#79B8FF"},children:" t"}),n(a.span,{style:{color:"#E1E4E8"},children:"."}),n(a.span,{style:{color:"#79B8FF"},children:"entity"}),n(a.span,{style:{color:"#F97583"},children:" ="}),n(a.span,{style:{color:"#79B8FF"},children:" c"}),n(a.span,{style:{color:"#E1E4E8"},children:"."}),n(a.span,{style:{color:"#79B8FF"},children:"id"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:"WHERE"}),n(a.span,{style:{color:"#79B8FF"},children:" t"}),n(a.span,{style:{color:"#E1E4E8"},children:"."}),n(a.span,{style:{color:"#79B8FF"},children:"type"}),n(a.span,{style:{color:"#F97583"},children:" ="}),n(a.span,{style:{color:"#9ECBFF"},children:" 'SalesOrd'"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" AND"}),n(a.span,{style:{color:"#79B8FF"},children:" t"}),n(a.span,{style:{color:"#E1E4E8"},children:"."}),n(a.span,{style:{color:"#79B8FF"},children:"trandate"}),n(a.span,{style:{color:"#F97583"},children:" >="}),n(a.span,{style:{color:"#9ECBFF"},children:" '2026-01-01'"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:"ORDER BY"}),n(a.span,{style:{color:"#79B8FF"},children:" t"}),n(a.span,{style:{color:"#E1E4E8"},children:"."}),n(a.span,{style:{color:"#79B8FF"},children:"trandate"}),n(a.span,{style:{color:"#F97583"},children:" DESC"})]})]})})}),"\n",n(a.p,{children:n(a.strong,{children:"Aggregate:"})}),"\n",n(a.figure,{"data-rehype-pretty-code-figure":"",children:n(a.pre,{style:{backgroundColor:"#24292e",color:"#e1e4e8"},tabIndex:"0","data-language":"sql","data-theme":"github-dark",children:l(a.code,{"data-language":"sql","data-theme":"github-dark",style:{display:"grid"},children:[n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#F97583"},children:"SELECT"})}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" BUILTIN"}),n(a.span,{style:{color:"#E1E4E8"},children:"."}),n(a.span,{style:{color:"#79B8FF"},children:"DF"}),n(a.span,{style:{color:"#E1E4E8"},children:"(subsidiary) "}),n(a.span,{style:{color:"#F97583"},children:"as"}),n(a.span,{style:{color:"#E1E4E8"},children:" subsidiary_name,"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" COUNT"}),n(a.span,{style:{color:"#E1E4E8"},children:"("}),n(a.span,{style:{color:"#F97583"},children:"*"}),n(a.span,{style:{color:"#E1E4E8"},children:") "}),n(a.span,{style:{color:"#F97583"},children:"as"}),n(a.span,{style:{color:"#E1E4E8"},children:" order_count,"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#79B8FF"},children:" SUM"}),n(a.span,{style:{color:"#E1E4E8"},children:"(total) "}),n(a.span,{style:{color:"#F97583"},children:"as"}),n(a.span,{style:{color:"#E1E4E8"},children:" total_revenue"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:"FROM"}),n(a.span,{style:{color:"#F97583"},children:" transaction"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:"WHERE"}),n(a.span,{style:{color:"#F97583"},children:" type"}),n(a.span,{style:{color:"#F97583"},children:" ="}),n(a.span,{style:{color:"#9ECBFF"},children:" 'SalesOrd'"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" AND"}),n(a.span,{style:{color:"#E1E4E8"},children:" trandate "}),n(a.span,{style:{color:"#F97583"},children:">="}),n(a.span,{style:{color:"#9ECBFF"},children:" '2026-01-01'"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:"GROUP BY"}),n(a.span,{style:{color:"#E1E4E8"},children:" subsidiary"})]})]})})}),"\n",n(a.hr,{}),"\n",l(a.h2,{id:"rate-limits--best-practices",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#rate-limits--best-practices",children:n(a.span,{className:"icon icon-link"})}),"Rate Limits & Best Practices"]}),"\n",l(a.h3,{id:"api-rate-limits",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#api-rate-limits",children:n(a.span,{className:"icon icon-link"})}),"API Rate Limits"]}),"\n",l(a.ul,{children:["\n",l(a.li,{children:[n(a.strong,{children:"Concurrent requests:"})," 10 per account (REST/SOAP)"]}),"\n",l(a.li,{children:[n(a.strong,{children:"Request timeout:"})," 5 minutes"]}),"\n",l(a.li,{children:[n(a.strong,{children:"Payload size:"})," 10 MB max"]}),"\n",l(a.li,{children:[n(a.strong,{children:"SuiteQL results:"})," 1000 rows per page (use offset for pagination)"]}),"\n"]}),"\n",l(a.h3,{id:"best-practices",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#best-practices",children:n(a.span,{className:"icon icon-link"})}),"Best Practices"]}),"\n",l(a.ol,{children:["\n",l(a.li,{children:["\n",l(a.p,{children:[n(a.strong,{children:"Use bulk operations"})," — addList/updateList in SOAP, or batch requests to minimize API calls"]}),"\n"]}),"\n",l(a.li,{children:["\n",l(a.p,{children:[n(a.strong,{children:"Implement retry logic"})," — Handle 429 (rate limit) and 503 (service unavailable) with exponential backoff"]}),"\n"]}),"\n",l(a.li,{children:["\n",l(a.p,{children:[n(a.strong,{children:"Cache reference data"})," — Don't fetch the same subsidiary/location/item repeatedly"]}),"\n"]}),"\n",l(a.li,{children:["\n",l(a.p,{children:[n(a.strong,{children:"Use SuiteQL for reads"})," — Faster than loading records individually"]}),"\n"]}),"\n",l(a.li,{children:["\n",l(a.p,{children:[n(a.strong,{children:"Filter at source"})," — Apply filters in your queries rather than fetching everything"]}),"\n"]}),"\n",l(a.li,{children:["\n",l(a.p,{children:[n(a.strong,{children:"Handle pagination"})," — Use ",n(a.code,{children:"offset"})," and ",n(a.code,{children:"limit"})," for large result sets"]}),"\n"]}),"\n",l(a.li,{children:["\n",l(a.p,{children:[n(a.strong,{children:"Monitor governance"})," — RESTlets and SuiteScript have governance limits"]}),"\n"]}),"\n",l(a.li,{children:["\n",l(a.p,{children:[n(a.strong,{children:"Use async for heavy operations"})," — Map/Reduce scripts for ",n(a.a,{href:"/tutorials/scheduled-scripts-guide",children:"batch processing"})]}),"\n"]}),"\n"]}),"\n",l(a.h3,{id:"error-handling",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#error-handling",children:n(a.span,{className:"icon icon-link"})}),"Error Handling"]}),"\n",n(a.figure,{"data-rehype-pretty-code-figure":"",children:n(a.pre,{style:{backgroundColor:"#24292e",color:"#e1e4e8"},tabIndex:"0","data-language":"javascript","data-theme":"github-dark",children:l(a.code,{"data-language":"javascript","data-theme":"github-dark",style:{display:"grid"},children:[l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:"try"}),n(a.span,{style:{color:"#E1E4E8"},children:" {"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" const"}),n(a.span,{style:{color:"#79B8FF"},children:" response"}),n(a.span,{style:{color:"#F97583"},children:" ="}),n(a.span,{style:{color:"#F97583"},children:" await"}),n(a.span,{style:{color:"#B392F0"},children:" fetch"}),n(a.span,{style:{color:"#E1E4E8"},children:"(endpoint, options);"})]}),"\n",n(a.span,{"data-line":"",children:" "}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" if"}),n(a.span,{style:{color:"#E1E4E8"},children:" (response.status "}),n(a.span,{style:{color:"#F97583"},children:"==="}),n(a.span,{style:{color:"#79B8FF"},children:" 429"}),n(a.span,{style:{color:"#E1E4E8"},children:") {"})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#6A737D"},children:" // Rate limited - wait and retry"})}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" await"}),n(a.span,{style:{color:"#B392F0"},children:" sleep"}),n(a.span,{style:{color:"#E1E4E8"},children:"(retryAfter);"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" return"}),n(a.span,{style:{color:"#B392F0"},children:" retry"}),n(a.span,{style:{color:"#E1E4E8"},children:"(endpoint, options);"})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#E1E4E8"},children:" }"})}),"\n",n(a.span,{"data-line":"",children:" "}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" if"}),n(a.span,{style:{color:"#E1E4E8"},children:" ("}),n(a.span,{style:{color:"#F97583"},children:"!"}),n(a.span,{style:{color:"#E1E4E8"},children:"response.ok) {"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" const"}),n(a.span,{style:{color:"#79B8FF"},children:" error"}),n(a.span,{style:{color:"#F97583"},children:" ="}),n(a.span,{style:{color:"#F97583"},children:" await"}),n(a.span,{style:{color:"#E1E4E8"},children:" response."}),n(a.span,{style:{color:"#B392F0"},children:"json"}),n(a.span,{style:{color:"#E1E4E8"},children:"();"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" throw"}),n(a.span,{style:{color:"#F97583"},children:" new"}),n(a.span,{style:{color:"#B392F0"},children:" Error"}),n(a.span,{style:{color:"#E1E4E8"},children:"("}),n(a.span,{style:{color:"#9ECBFF"},children:"`NetSuite API Error: ${"}),n(a.span,{style:{color:"#E1E4E8"},children:"error"}),n(a.span,{style:{color:"#9ECBFF"},children:"."}),n(a.span,{style:{color:"#E1E4E8"},children:"title"}),n(a.span,{style:{color:"#9ECBFF"},children:"} - ${"}),n(a.span,{style:{color:"#E1E4E8"},children:"error"}),n(a.span,{style:{color:"#9ECBFF"},children:"."}),n(a.span,{style:{color:"#E1E4E8"},children:"detail"}),n(a.span,{style:{color:"#9ECBFF"},children:"}`"}),n(a.span,{style:{color:"#E1E4E8"},children:");"})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#E1E4E8"},children:" }"})}),"\n",n(a.span,{"data-line":"",children:" "}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" return"}),n(a.span,{style:{color:"#E1E4E8"},children:" response."}),n(a.span,{style:{color:"#B392F0"},children:"json"}),n(a.span,{style:{color:"#E1E4E8"},children:"();"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:"} "}),n(a.span,{style:{color:"#F97583"},children:"catch"}),n(a.span,{style:{color:"#E1E4E8"},children:" (error) {"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#E1E4E8"},children:" console."}),n(a.span,{style:{color:"#B392F0"},children:"error"}),n(a.span,{style:{color:"#E1E4E8"},children:"("}),n(a.span,{style:{color:"#9ECBFF"},children:"'API call failed:'"}),n(a.span,{style:{color:"#E1E4E8"},children:", error);"})]}),"\n",l(a.span,{"data-line":"",children:[n(a.span,{style:{color:"#F97583"},children:" throw"}),n(a.span,{style:{color:"#E1E4E8"},children:" error;"})]}),"\n",n(a.span,{"data-line":"",children:n(a.span,{style:{color:"#E1E4E8"},children:"}"})})]})})}),"\n",n(a.hr,{}),"\n",l(a.h2,{id:"integration-patterns",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#integration-patterns",children:n(a.span,{className:"icon icon-link"})}),"Integration Patterns"]}),"\n",l(a.h3,{id:"direct-api-integration",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#direct-api-integration",children:n(a.span,{className:"icon icon-link"})}),"Direct API Integration"]}),"\n",n(a.p,{children:"Best for:"}),"\n",l(a.ul,{children:["\n",n(a.li,{children:"Simple, single-direction data flows"}),"\n",n(a.li,{children:"Low volume (< 1000 records/day)"}),"\n",n(a.li,{children:"Technical teams comfortable with API development"}),"\n"]}),"\n",l(a.h3,{id:"ipaas-celigo-boomi-n8n",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#ipaas-celigo-boomi-n8n",children:n(a.span,{className:"icon icon-link"})}),"iPaaS (Celigo, Boomi, n8n)"]}),"\n",n(a.p,{children:"Best for:"}),"\n",l(a.ul,{children:["\n",n(a.li,{children:"Complex multi-system integrations"}),"\n",n(a.li,{children:"High volume or real-time sync"}),"\n",n(a.li,{children:"Non-technical teams managing integrations"}),"\n",n(a.li,{children:"Pre-built connectors (Shopify, Salesforce, etc.)"}),"\n"]}),"\n",l(a.p,{children:["We offer ",n(a.a,{href:"/services/celigo-implementations",children:"Celigo implementation services"})," and ",n(a.a,{href:"/services/n8n-integration-netsuite",children:"n8n integration services"})," for complex integration needs."]}),"\n",l(a.h3,{id:"middlewarecustom-service",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#middlewarecustom-service",children:n(a.span,{className:"icon icon-link"})}),"Middleware/Custom Service"]}),"\n",n(a.p,{children:"Best for:"}),"\n",l(a.ul,{children:["\n",n(a.li,{children:"Heavy data transformation"}),"\n",n(a.li,{children:"Complex business logic"}),"\n",n(a.li,{children:"High-volume batch processing"}),"\n",n(a.li,{children:"Custom retry and error handling"}),"\n"]}),"\n",n(a.hr,{}),"\n",l(a.h2,{id:"tools--resources",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#tools--resources",children:n(a.span,{className:"icon icon-link"})}),"Tools & Resources"]}),"\n",l(a.h3,{id:"official-resources",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#official-resources",children:n(a.span,{className:"icon icon-link"})}),"Official Resources"]}),"\n",l(a.ul,{children:["\n",n(a.li,{children:n(a.a,{href:"https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2024.1/index.html",children:"NetSuite REST API Browser"})}),"\n",n(a.li,{children:n(a.a,{href:"https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/chapter_4387172221.html",children:"SuiteScript 2.x API Reference"})}),"\n",n(a.li,{children:n(a.a,{href:"https://netsuite.custhelp.com/",children:"SuiteAnswer Articles"})}),"\n"]}),"\n",l(a.h3,{id:"development-tools",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#development-tools",children:n(a.span,{className:"icon icon-link"})}),"Development Tools"]}),"\n",l(a.ul,{children:["\n",l(a.li,{children:[n(a.strong,{children:"Postman"})," — NetSuite collection available"]}),"\n",l(a.li,{children:[n(a.strong,{children:"SuiteCloud IDE"})," — Eclipse-based IDE for SuiteScript"]}),"\n",l(a.li,{children:[n(a.strong,{children:"SDF CLI"})," — Command-line deployment tool"]}),"\n"]}),"\n",l(a.h3,{id:"libraries",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#libraries",children:n(a.span,{className:"icon icon-link"})}),"Libraries"]}),"\n",l(a.ul,{children:["\n",l(a.li,{children:[n(a.strong,{children:"netsuite-rest"})," (Node.js) — Community REST API client"]}),"\n",l(a.li,{children:[n(a.strong,{children:"netsuite"})," (Python) — Python client for SOAP API"]}),"\n",l(a.li,{children:[n(a.strong,{children:"NetSuiteClient"})," (.NET) — .NET SOAP client"]}),"\n"]}),"\n",n(a.hr,{}),"\n",l(a.h2,{id:"wrapping-up-choosing-your-approach",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#wrapping-up-choosing-your-approach",children:n(a.span,{className:"icon icon-link"})}),"Wrapping up: choosing your approach"]}),"\n",l(a.p,{children:["After years of building ",n(a.a,{href:"/blog/netsuite-integration-platforms-compared",children:"NetSuite integrations"}),", our default recommendation is straightforward: start with the REST API. It handles CRUD operations cleanly, supports SuiteQL for efficient data extraction, and follows modern API conventions that your developers will find familiar."]}),"\n",n(a.p,{children:"When standard endpoints aren't enough — when you need custom business logic, data aggregation, or transformations that don't fit the standard patterns — that's when RESTlets earn their place. They require SuiteScript knowledge and deployment overhead, but they give you full control over what your endpoint does."}),"\n",n(a.p,{children:"The SOAP API is legacy territory. We still encounter it in older integrations, and some batch operations work better through SOAP, but there's rarely a reason to choose it for new development."}),"\n",l(a.p,{children:["For complex integration scenarios — multiple systems, high volumes, non-technical teams managing the flows — consider an iPaaS platform like ",n(a.a,{href:"/services/celigo-implementations",children:"Celigo"})," or ",n(a.a,{href:"/services/n8n-integration-netsuite",children:"n8n"}),". The development overhead is lower, and you get monitoring, error handling, and retry logic out of the box."]}),"\n",n(a.hr,{}),"\n",l(a.h2,{id:"need-help-with-netsuite-integrations",children:[n(a.a,{className:"subheading-anchor","aria-label":"Link to section",href:"#need-help-with-netsuite-integrations",children:n(a.span,{className:"icon icon-link"})}),"Need Help with NetSuite Integrations?"]}),"\n",l(a.p,{children:["We specialize in ",n(a.a,{href:"/services/integrations",children:"NetSuite integrations"})," — from simple API connections to complex multi-platform orchestrations. Whether you need a custom RESTlet, an iPaaS implementation, or a full integration architecture review, we can help."]}),"\n",n(i,{items:[{q:"What is the difference between NetSuite REST API and SOAP API?",a:"The REST API uses JSON payloads and modern HTTP methods, making it ideal for new integrations and mobile apps. The SOAP API uses XML and is better suited for legacy systems and complex batch operations. For most new projects, the REST API is the recommended starting point."},{q:"How do I authenticate with the NetSuite API?",a:"NetSuite supports Token-Based Authentication (TBA) using OAuth 1.0 and OAuth 2.0 Client Credentials flow for the REST API. TBA requires a Consumer Key, Consumer Secret, Token ID, and Token Secret. All production integrations require TBA."},{q:"What is the difference between SuiteScript 1.0 and SuiteScript 2.x?",a:"SuiteScript 2.x is the modern version with a modular architecture using AMD modules, better error handling, and support for promises. SuiteScript 1.0 is legacy and should not be used for new development. All new scripts should be written in SuiteScript 2.x."},{q:"What are RESTlets in NetSuite and when should I use them?",a:"RESTlets are custom REST endpoints built with SuiteScript that run inside NetSuite. Use them when standard API endpoints do not cover your needs, such as custom business logic, data aggregation across multiple record types, or complex transformations."},{q:"What are the NetSuite API rate limits?",a:"NetSuite allows 10 concurrent requests per account for REST and SOAP APIs, with a 5-minute request timeout and 10 MB maximum payload size. SuiteQL queries return up to 1,000 rows per page. Implement retry logic with exponential backoff for 429 and 503 errors."}]}),"\n",n(s,{title:"NetSuite Integration Services",href:"/services/integrations",description:"Connect NetSuite to your eCommerce, CRM, and business systems"})]})}return{default:function(e={}){const{wrapper:l}=e.components||{};return l?n(l,{...e,children:n(_createMdxContent,{...e})}):_createMdxContent(e)}};function _missingMdxReference(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}

API

Articles tagged API

NetSuite API Guide: REST, SOAP & SuiteScript for Developers