NetSuite PHP API Client

To use the client, instantiate NetSuite\NetSuiteService. You must use Token-Based Authentication (TBA), as user credential authentication is no longer supported.

You can provide configuration via an associative array or by setting environment variables (the constructor will automatically extract values from $_ENV).

require 'vendor/autoload.php';

use NetSuite\NetSuiteService;

$config = [
    // required -------------------------------------
    "endpoint"       => "2021_1",
    "host"           => "https://webservices.netsuite.com",
    "account"        => "MYACCT1",
    "consumerKey"    => "0123456789ABCDEF",
    "consumerSecret" => "0123456789ABCDEF",
    "token"          => "0123456789ABCDEF",
    "tokenSecret"    => "0123456789ABCDEF",
    // optional -------------------------------------
    "signatureAlgorithm" => 'sha256', // Defaults to 'sha256'
    "logging"  => true,
    "log_path" => "/var/www/myapp/logs/netsuite",
    "log_format"     => "netsuite-php-%date-%operation",
    "log_dateformat" => "Ymd.His.u",
];

$service = new NetSuiteService($config);

To perform a search, use a SearchRequest containing a search record object (e.g., CustomerSearchBasic). You can define search criteria using field objects like SearchStringField to specify operators (e.g., startsWith) and values. You can also control pagination using $service->setSearchPreferences(false, limit). The results are accessed via $searchResponse->searchResult->recordList.

// Find a record whose first name starts with "Justin"
use NetSuite\\Classes\\SearchStringField;
use NetSuite\\Classes\\CustomerSearchBasic;
use NetSuite\\Classes\\SearchRequest;

// Limit to 20 results per page
$service->setSearchPreferences(false, 20);

$searchField = new SearchStringField();
$searchField->operator = "startsWith";
$searchField->searchValue = "Justin";

$search = new CustomerSearchBasic();
$search->firstName = $searchField;

$request = new SearchRequest();
$request->searchRecord = $search;

$searchResponse = $service->search($request);

if (!$searchResponse->searchResult->status->isSuccess) {
    echo "SEARCH ERROR";
} else {
    $result = $searchResponse->searchResult;
    $count = $result->totalRecords;
    $records = $result->recordList;

    echo $count . " records were found.";
}

When creating a SalesOrder, you can associate existing records using RecordRef (e.g., for the entity field). To add custom fields, create instances of custom field classes (like StringCustomFieldRef), set their scriptId and value, collect them into an array, and assign them to a CustomFieldList on the record.

use NetSuite\\Classes\\AddRequest;
use NetSuite\\Classes\\CustomFieldList;
use NetSuite\\Classes\\RecordRef;
use NetSuite\\Classes\\SalesOrder;
use NetSuite\\Classes\\StringCustomField;

$sale = new SalesOrder();

// Associate a customer record with this order
$sale->entity = new RecordRef();
$sale->entity->type = 'customer';
$sale->entity->internalId = $myCustomerInternalId;

// Set the date of the order
$sale->tranDate = $myOrderDate;

// Set the shipping method and price for the order
$sale->shipMethod = new RecordRef();
$sale->shipMethod->internalId = $myShipMethodId;
$sale->shippingCost = $myShippingTotal;

// Create a sample string-type custom field to the order which represents
// the ID of the order in our source platform:
$cfOrderNum = new StringCustomFieldRef();
$cfOrderNum->scriptId = 'custbody_order_id';
$cfOrderNum->value = $myOrderId; // Some value from your application

// Collect all custom fields into an array and add the list of fields to the
// order add request:
$customFields[] = $cfOrderNum;
$sale->customFieldList = new CustomFieldList();
$sale->customFieldList->customField = $customFields;

// Submit the sales order create request
$request = new AddRequest();
$request->record = $sale;
$addResponse = $service->add($request);

if (!$addResponse->writeResponse->status->isSuccess) {
    echo "ADD ERROR";
} else {
    echo "ADD SUCCESS, id " . $addResponse->writeResponse->baseRef->internalId;
}

To create a new record, instantiate the specific record class (e.g., Customer), populate its properties, wrap it in an AddRequest, and pass it to $service->add($request). On success, the new record's ID is available in $addResponse->writeResponse->baseRef->internalId.

// Create a new Customer record
use NetSuite\\Classes\\Customer;
use NetSuite\\Classes\\RecordRef;
use NetSuite\\Classes\\AddRequest;

$customer = new Customer();
$customer->firstName = "John";
$customer->lastName = "Doe";
$customer->companyName = "Bobby's Bits";
$customer->phone = "123456789";
$customer->email = "test@example.com";
// ... add all of your fields, then create the request
$request = new AddRequest();
$request->record = $customer;

$addResponse = $service->add($request);

if (!$addResponse->writeResponse->status->isSuccess) {
    echo "ADD ERROR";
} else {
    echo "ADD SUCCESS, id " . $addResponse->writeResponse->baseRef->internalId;
}

To create an ItemFulfillment based on an existing record (like a SalesOrder), use an InitializeRequest. This requires an InitializeRecord object specifying the target type and an InitializeRef object pointing to the source record's internalId and type. Once the record is initialized via $service->initialize($request), you can modify it (e.g., adding packages via ItemFulfillmentPackageList) and then submit it using an AddRequest.

use NetSuite\\Classes\\AddRequest;
use NetSuite\\Classes\\InitializeRecord;
use NetSuite\\Classes\\InitializeRef;
use NetSuite\\Classes\\InitializeRequest;
use NetSuite\\Classes\\ItemFulfillmentPackage;
use NetSuite\\Classes\\ItemFulfillmentPackageList;

// Initialize an item fulfillment from an existing Sales Order
$reference = new InitializeRef();
$reference->type = InitializeRefType::salesOrder;
$reference->internalId = $mySalesOrderInternalId;

$record = new InitializeRecord();
$record->type = InitializeType::itemFulfillment;
$record->reference = $reference;

$request = new InitializeRequest();
$request->initializeRecord = $record;

$initResponse = $service->initialize($request);

if (!$initResponse->readResponse->status->isSuccess) {
    echo "INIT ERROR";
}

$itemFulfillment = $initResponse->readResponse->record;

// Create and add a package object to the ItemFulfillment
$package = new ItemFulfillmentPackage();
$package->packageWeight = 1;
$package->packageTrackingNumber = $myTrackingNumber;

$packageList = new ItemFulfillmentPackageList();
$packageList->package = $package;
$itemFulfillment->packageList = $packageList;

$request = new AddRequest();
$request->record = $itemFulfillment;

$addResponse = $service->add($request);

if (!$addResponse->writeResponse->status->isSuccess) {
    echo "ADD ERROR";
} else {
    echo "ADD SUCCESS, id " . $addResponse->writeResponse->baseRef->internalId;
}