Skip to main content

API User Setup - For the External Team

Updated
Applies toAPIAudienceAll usersLast updatedNovember 12, 2025

API Login Credentials

A member of the internal team will send you the following credentials for both UAT and PROD instances. A Postman success screenshot will also be attached, showing that the credentials work as expected:

  • Consumer Key

  • Consumer Secret

  • Username

  • Password

  • Security Token

Test the Login Credentials

1. Download and install the Postman API Client https://www.getpostman.com/product/api-client.

2. Open the Postman Client. The Postman Client will open a new browser tab. Create a New Workspace:

3. Select HTTP Request:

4. Change Request type to Post.

5. Copy and paste https://test.salesforce.com/services/oauth2/token.

For live instance, use https://login.salesforce.com/services/oauth2/token.

6. In the Authorization tab, select oAuth 2.0. Do not change other parameters.

7. In the Body tab, select form-data.

8. You will get the error message "grant type not supported" if you use the Headers tab to test.

9. Provide the parameters in Key and Value; value in Key must be in lower case.


10. Password must be the password followed by the security token (do not provide any spaces in between).

11. Click Send.

12. If successful, you will receive an access token.

SOAP API

Use SoapUI to Help Construct and Test SOAP Requests

1. Download and install the SoapUI Open Source version from https://www.soapui.org/downloads/soapui/

2. Log in to the Salesforce instance, go to Setup, search for API, and download the Enterprise WSDL file.

3. Click Generate

4. Right-click on the page. Save as to save the file.

5. In SoapUI, click File => New SOAP Project

6. Enter Project Name, choose the wsdl.xml file you saved. Click OK.

7. You should see the available API actions you can perform.

8. First, perform a login action to get serverUrl and sessionId. Note, urn:password=salesforce password+security token

9. Perform a query to retrieve records

Examples of SOAP Requests to Integrate 3rd Apps with Salesforce

All read/write requests are a two-step process:

  1. Retrieve the Server URL and the Login Session Id

  2. Send the read / write request with the correct form fields

    1. Sales Orders and Sales Order Lines

    2. Import Sales Order

Retrieve the Server URL and the Login Session Id

Login Request

Endpoint: https://test.salesforce.com/services/Soap/c/[api version]/[organization id]

Example: https://test.salesforce.com/services/Soap/c/52.0/0DF1F0000008xct

Body:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:enterprise.soap.sforce.com">

<soapenv:Body>

<urn:login>

<urn:username>username@domain.com</urn:username>

<urn:password>salesforce password+security token</urn:password>

</urn:login>

</soapenv:Body>

</soapenv:Envelope>

Note:

  1. SOAP API only requires user name, password and security token.

  2. If you choose to use oauth2 to connect, you will need to provide Consumer Key and Consumer Secret.

Login Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:enterprise.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<soapenv:Body>

<loginResponse>

<result>

<metadataServerUrl>https://xyz.my.salesforce.com/services/Soap/m/52.0/00D1F00000099Uj</metadataServerUrl>

<passwordExpired>false</passwordExpired>

<sandbox>true</sandbox>

<serverUrl>https://xyz.my.salesforce.com/services/Soap/c/52.0/00D1F00000099Uj</serverUrl>

<sessionId>00D1F00000099Uj!ARcAQNdhMOwF5oN5yccgfRImb4XX8xS_28bErAGb4qoMmFhzWp4o8Aq2sed6VBe4jrSEeiRs5Y2OYjsPxfqDK1U0ploPXMVD</sessionId>

<userId>0051F00000oD3Q8QAK</userId>

<userInfo>

<accessibilityMode>false</accessibilityMode>

<chatterExternal>false</chatterExternal>

<currencySymbol xsi:nil="true"/>

<orgAttachmentFileSizeLimit>5242880</orgAttachmentFileSizeLimit>

<orgDefaultCurrencyIsoCode xsi:nil="true"/>

<orgDefaultCurrencyLocale xsi:nil="true"/>

<orgDisallowHtmlAttachments>false</orgDisallowHtmlAttachments>

<orgHasPersonAccounts>false</orgHasPersonAccounts>

<organizationId>00D1F00000099UjUAI</organizationId>

<organizationMultiCurrency>true</organizationMultiCurrency>

<organizationName>Client Name</organizationName>

<profileId>00e1F000000F9OnQAK</profileId>

<roleId xsi:nil="true"/>

<sessionSecondsValid>7200</sessionSecondsValid>

<userDefaultCurrencyIsoCode>USD</userDefaultCurrencyIsoCode>

<userEmail>username@mydomain.com</userEmail>

<userFullName>API Name</userFullName>

<userId>0051F00000oD3Q8QAK</userId>

<userLanguage>en_US</userLanguage>

<userLocale>en_US</userLocale>

<userName>username@domain.com</userName>

<userTimeZone>America/New_York</userTimeZone>

<userType>Standard</userType>

<userUiSkin>Theme3</userUiSkin>

</userInfo>

</result>

</loginResponse>

</soapenv:Body>

</soapenv:Envelope>

Query Sales Orders and Sales Order Lines

Query Sales Orders Request – use a subquery to include sales lines

Endpoint: serverUrl from the login response

Example: https://xyz.my.salesforce.com/services/Soap/c/52.0/00D1F00000099Uj

Comments:

Body:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:enterprise.soap.sforce.com">

<soapenv:Header>

<urn:QueryOptions>

<!--Optional:-->

<urn:batchSize>200</urn:batchSize>

</urn:QueryOptions>

<urn:SessionHeader>

<urn:sessionId>00D1F00000099Uj!ARcAQNdhMOwF5oN5yccgfRImb4XX8xS_28bErAGb4qoMmFhzWp4o8Aq2sed6VBe4jrSEeiRs5Y2OYjsPxfqDK1U0ploPXMVD</urn:sessionId>

</urn:SessionHeader>

</soapenv:Header>

<soapenv:Body>

<urn:query>

<urn:queryString>SELECT Id, Name, (SELECT Id FROM GFERP__Sales_Lines__r) FROM GFERP__Sales_Order__c WHERE GFERP__Document_Status__c = 'Open'</urn:queryString>

</urn:query>

</soapenv:Body>

</soapenv:Envelope>

Query Sales Orders Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:enterprise.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sf="urn:sobject.enterprise.soap.sforce.com">

<soapenv:Header>

<LimitInfoHeader>

<limitInfo>

<current>155</current>

<limit>5000000</limit>

<type>API REQUESTS</type>

</limitInfo>

</LimitInfoHeader>

</soapenv:Header>

<soapenv:Body>

<queryResponse>

<result>

<done>true</done>

<queryLocator xsi:nil="true"/>

<records xsi:type="sf:GFERP__Sales_Order__c">

<sf:Id>a0z1F000001PKigQAG</sf:Id>

<sf:GFERP__Sales_Lines__r>

<done>true</done>

<queryLocator xsi:nil="true"/>

<records xsi:type="sf:GFERP__Sales_Line__c">

<sf:Id>a0y1F000001iXeOQAU</sf:Id>

</records>

<records xsi:type="sf:GFERP__Sales_Line__c">

<sf:Id>a0y1F000001iXeNQAU</sf:Id>

</records>

<records xsi:type="sf:GFERP__Sales_Line__c">

<sf:Id>a0y1F000001iXeMQAU</sf:Id>

</records>

<records xsi:type="sf:GFERP__Sales_Line__c">

<sf:Id>a0y1F000001iXeLQAU</sf:Id>

</records>

<size>4</size>

</sf:GFERP__Sales_Lines__r>

<sf:Name>SO-1000411</sf:Name>

</records>

<records xsi:type="sf:GFERP__Sales_Order__c">

<sf:Id>a0z1F000001qHz0QAE</sf:Id>

<sf:GFERP__Sales_Lines__r>

<done>true</done>

<queryLocator xsi:nil="true"/>

<records xsi:type="sf:GFERP__Sales_Line__c">

<sf:Id>a0y1F000001jytkQAA</sf:Id>

</records>

<records xsi:type="sf:GFERP__Sales_Line__c">

<sf:Id>a0y1F000001jywPQAQ</sf:Id>

</records>

<size>2</size>

</sf:GFERP__Sales_Lines__r>

<sf:Name>SO-1000441</sf:Name>

</records>

<size>2</size>

</result>

</queryResponse>

</soapenv:Body>

</soapenv:Envelope>

Create Import Sales Order Request

Endpoint: serverUrl from the login response

Comments: example below show how to insert 2 import sales order records (with import sales lines using External ID)

Body:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:enterprise.soap.sforce.com" xmlns:urn1="urn:sobject.enterprise.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<soapenv:Header>

<urn:AllOrNoneHeader>

<urn:allOrNone>true</urn:allOrNone>

</urn:AllOrNoneHeader>

<urn:SessionHeader>

<urn:sessionId>00D1F00000099Uj!ARcAQNdhMOwF5oN5yccgfRImb4XX8xS_28bErAGb4qoMmFhzWp4o8Aq2sed6VBe4jrSEeiRs5Y2OYjsPxfqDK1U0ploPXMVD</urn:sessionId>

</urn:SessionHeader>

</soapenv:Header>

<soapenv:Body>

<urn:create>

<!--Zero or more repetitions:-->

<urn:sObjects xsi:type="urn1:GFCON__Import_Sales_Order__c">

<GFCON__X3PL_Order_No__c>ORD-10003</GFCON__X3PL_Order_No__c>

<External_ID__c>ORD-10003</External_ID__c>

</urn:sObjects>

<urn:sObjects xsi:type="urn1:GFCON__Import_Sales_Line__c">

<GFCON__Item_No__c>ITEM-001</GFCON__Item_No__c>

<GFCON__Import_Sales_Order__r>

<urn1:External_ID__c>ORD-10003</urn1:External_ID__c>

</GFCON__Import_Sales_Order__r>

</urn:sObjects>

<urn:sObjects xsi:type="urn1:GFCON__Import_Sales_Line__c">

<GFCON__Item_No__c>ITEM-002</GFCON__Item_No__c>

<GFCON__Import_Sales_Order__r>

<urn1:External_ID__c>ORD-10003</urn1:External_ID__c>

</GFCON__Import_Sales_Order__r>

</urn:sObjects>

<urn:sObjects xsi:type="urn1:GFCON__Import_Sales_Order__c">

<GFCON__X3PL_Order_No__c>ORD-10004</GFCON__X3PL_Order_No__c>

<External_ID__c>ORD-10004</External_ID__c>

</urn:sObjects>

<urn:sObjects xsi:type="urn1:GFCON__Import_Sales_Line__c">

<GFCON__Item_No__c>ITEM-001</GFCON__Item_No__c>

<GFCON__Import_Sales_Order__r>

<urn1:External_ID__c>ORD-10004</urn1:External_ID__c>

</GFCON__Import_Sales_Order__r>

</urn:sObjects>

<urn:sObjects xsi:type="urn1:GFCON__Import_Sales_Line__c">

<GFCON__Item_No__c>ITEM-002</GFCON__Item_No__c>

<GFCON__Import_Sales_Order__r>

<urn1:External_ID__c>ORD-10004</urn1:External_ID__c>

</GFCON__Import_Sales_Order__r>

</urn:sObjects>

</urn:create>

</soapenv:Body>

</soapenv:Envelope>

Create Import Sales Order Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:enterprise.soap.sforce.com">

<soapenv:Header>

<LimitInfoHeader>

<limitInfo>

<current>137</current>

<limit>5000000</limit>

<type>API REQUESTS</type>

</limitInfo>

</LimitInfoHeader>

</soapenv:Header>

<soapenv:Body>

<createResponse>

<result>

<id>a2A1F000000jttcUAA</id>

<success>true</success>

</result>

<result>

<id>a291F000000zHgLQAU</id>

<success>true</success>

</result>

<result>

<id>a291F000000zHgMQAU</id>

<success>true</success>

</result>

<result>

<id>a2A1F000000jttdUAA</id>

<success>true</success>

</result>

<result>

<id>a291F000000zHgNQAU</id>

<success>true</success>

</result>

<result>

<id>a291F000000zHgOQAU</id>

<success>true</success>

</result>

</createResponse>

</soapenv:Body>

</soapenv:Envelope>

REST API

Resources

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_composite.htm

Sample Code

To insert Import Shipment and Import Shipment Line.

{

"allOrNone": true,

"compositeRequest": [{

"method": "POST",

"url": "\/services\/data\/v45.0\/sobjects\/GFCON__Import_Shipment__c",

"referenceId": "NewShipment",

"body": {

"GFCON__Warehouse__c": "ADS",

"GFCON__Customer_PO_No__c": "5650602",

"GFCON__Shipment_Date__c": "2021-08-11",

"GFCON__Shipment_No__c": "3900",

"GFCON__Shipping_Agent__c": "BBT TRUCKING",

"GFCON__Customer_No__c": "SEPHORA-AU",

"GFCON__Invoice_No__c": "3900",

"GFCON__Order_Date__c": "2021-07-30",

"GFCON__Shipping_Name2__c": "96",

"GFCON__Shipping_Street__c": "Sephora Australia (DHL) Greystanes Campus (Building 2)",

"GFCON__Shipping_City__c": "GREYSTANES PARK",

"GFCON__Shipping_State__c": "NSW",

"GFCON__Shipping_Postal_Code__c": "2145",

"GFCON__Shipping_Country__c": "AU",

"GFCON__Order_Source__c": "3PL B2B"

}

}, {

"method": "POST",

"url": "\/services\/data\/v45.0\/sobjects\/GFCON__Import_Shipment_Line__c",

"referenceId": "Line1000",

"body": {

"GFCON__Transaction_No__c": "@{NewShipment.id}",

"GFCON__Line_No__c": "1000",

"GFCON__Item_No__c": "22021032",

"GFCON__Description__c": "SoftSculpt Bronzer- Dark",

"GFCON__Quantity__c": "108",

"GFCON__Unit_of_Measure__c": "EA",

"GFCON__Unit_Price__c": 28,

"GFCON__Discount__c": 0,

"GFCON__Tax__c": 0

}

}, {

"method": "POST",

"url": "\/services\/data\/v45.0\/sobjects\/GFCON__Import_Shipment_Line__c",

"referenceId": "Line2000",

"body": {

"GFCON__Transaction_No__c": "@{NewShipment.id}",

"GFCON__Line_No__c": "2000",

"GFCON__Item_No__c": "22021083",

"GFCON__Description__c": "SoftSculpt Bronzer- Dark Deep",

"GFCON__Quantity__c": "38",

"GFCON__Unit_of_Measure__c": "EA",

"GFCON__Unit_Price__c": 28,

"GFCON__Discount__c": 0,

"GFCON__Tax__c": 0

}

}]

}

Viewing Salesforce Tables and Sample Records

1. View Available Tables (Objects)

You can view all objects directly in Salesforce:

  1. Log in to Salesforce.

  2. Go to Setup → Object Manager to see all standard and custom objects.

Or, use the Salesforce REST API to retrieve a list of objects:
Reference: Salesforce REST API – Describe Global

2. View Sample Data

For testing, you can query data from the following objects:

  • GFERP__Sales_Order__c – Sales order headers

  • GFERP__Sales_Line__c – Sales order lines

Additional Support Documentation

Salesforce supports both SOAP and REST.

Salesforce API governor limits - https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm

Salesforce API documentation links - https://trailhead.salesforce.com/en/content/learn/modules/api_basics/api_basics_rest

Article API-User-Setup---For-the-External-Team  ·  Last updated November 12, 2025 · GoldFinch ERP Help Center

Comments

0 comments

Please sign in to leave a comment.