2Service Services API

<back to all web services

Authenticate

The following routes are available for this service:
POST/dealers/authenticateAuthenticate with user name and password. Returns session token. Note: the token expires after 5 minutes of inactivity.
Authenticate Parameters:
NameParameterData TypeRequiredDescription
UserNamequerystringYesUser name for your account.
PasswordquerystringYesPassword provided by your supplier.
OperationResult<T> Parameters:
NameParameterData TypeRequiredDescription
ResultmodelPartResultsNoResult value
OperationResult Parameters:
NameParameterData TypeRequiredDescription
IsSuccessfulmodelboolNoSpecifies if the operation was successful.
ErrorMessagemodelstringNoStates error message in case of unsuccessful operation.
PartResults Parameters:
NameParameterData TypeRequiredDescription
TotalNumberOfPartsformintNoTotal number of parts available.
HasMoreRecordsformboolNoIndication if there are more parts to retrieve.
PartsformList<PartInfoResult>NoPart records.
PartInfoResult Parameters:
NameParameterData TypeRequiredDescription
IdformintNoUnique ID for the part.
PartNumberformstringNoPart number.
DescriptionformstringNoDescription of the part.
ManufacturerformstringNoPart manufacturer.
CanBeOrderedformboolNoDetermines if the part can be ordered.
StatusTextformstringNoTextual representation of the status of the part.
AvailableStockQuantityformintNoAvailable stock to order.
AverageDeliveryInDaysformint?NoAverage days needed for delivery.
UnitPriceformdecimal?NoPrice of a single unit, excluding VAT.
EanNumberformstringNoEAN number.
ImagesformList<PartInfoResultImage>NoImages
SecondaryArticleNumbersformList<string>NoSecondary article numbers
ReplacementArticleNumbersformList<string>NoReplacement article numbers
StockQuantitiesformList<PartStockQuantity>NoStock quantities
PartInfoResultImage Parameters:
NameParameterData TypeRequiredDescription
ImageNumberformintNoImage number
ImageUrlformstringNoImage URL
PartStockQuantity Parameters:
NameParameterData TypeRequiredDescription
LocationIdformintNoLocation ID
LocationCodeformstringNoLocation code
StockQuantityformintNoStock quantity in location
AuthenticateResult Parameters:
NameParameterData TypeRequiredDescription
SessionTokenmodelstringNoSession token to use in successive calls to the services.

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /dealers/authenticate HTTP/1.1 
Host: services.acct.2service.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"UserName":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Result":{"SessionToken":"String"},"IsSuccessful":false,"ErrorMessage":"String"}