Competitor

You can create competitor records to track how other businesses in your industry impact your sales. In the UI, this is a user defined list at Lists > Relationships > Competitors > New.

Use the competitor record to create new competitors and expose them to REST web services.

To learn more, see Competitor.

This record:

The REST API Browser includes information about the field names and field types of the competitor record, and about the HTTP methods, request parameters, and operations available to this record. For details, see the REST API Browser’s competitor reference page.

For information about using the REST API Browser, see The REST API Browser.

Record ID

The record ID for a competitor REST record is competitor.

Prerequisites

You must enable Permissions > Lists > Competitors before you can use this record through REST web services.

Elements Not Accessible Through REST Web Services

The following elements are not accessible through REST web services:

  • opportunities

Usage Notes

Review the following notes on working with the competitor REST record:

  • name is required, all other fields are optional

Code Sample

The following samples show common use cases for competitor.

Creating a Competitor

              POST https://demo123.suitetalk.api.snap.netsuite.com/services/rest/record/v1/competitor
Body: { "name": "A Competitor", "description": "Description of competitor", "strengths": "Competitor's strengths", "weaknesses": "Competitor's weaknesses", "strategy": "Strategy for winning against competitor", "productService": "Competitor's products and services", "isInactive": false
} 

            

Retrieving a Competitor

              GET https://demo123.suitetalk.api.snap.netsuite.com/services/rest/record/v1/competitor/2 

            

Updating a Competitor

              PATCH https://demo123.suitetalk.api.snap.netsuite.com/services/rest/record/v1/competitor/2
Body:
{ "name": "Updated Competitor", "description": "Updated description of competitor", "strengths": "Updated Competitor's strengths", "weaknesses": "Updated competitor's weaknesses", "strategy": "Updated strategy for winning against competitor", "productService": "Updated competitor's products and services", "isInactive": true
} 

            

Deleting a Competitor

              DELETE https://demo123.suitetalk.api.snap.netsuite.com/services/rest/record/v1/ competitor/2 

            

Related Topics

REST Web Services Supported Records
SuiteTalk REST Web Services Overview and Setup
Working with Records
NetSuite Record Structure
The REST API Browser

General Notices