OMS DOCUMENTATIONRESOURCE CENTER

These guides provide examples for many tasks that a developer will need to be familiar with during implementation.

KIBO OMS DEVELOPMENT

Documentation

Get User Information

The Get User Information API retrieves information about an OMS user.

Version2.0
Callhttps://integration.shopatron.com/api/usermgmt/v1/user/{userID}
Supported FormatsJSON
HTTP MethodGET
Schemahttps://integration.shopatron.com/api/usermgmt/v1/schema/user.json

Note that the core URL may be different from the standard production environment, depending on the configuration.

The .json address above can be used to access the schema within Postman. An example use of the User Management API follows below, or view the schema or the sample Postman collection.

Example

In this example, the user details included these particular properties:

  • User ID 00000
  • Name Example User
  • Part of the admin group for Manufacturer 111 and Fulfiller 22222

General Information

The response returns the following information about a user:

  • Identification (name)
  • Contact Information
  • Account Details (password expiration, last login)
  • Assignments (groups, manufacturers, fulfillers, locale)

Some users may not have all of this information set, so the exact parameter list may vary.

The Full Request

Using the URL format as outlined above, the entire call is simple to put together.

https://integration.shopatron.com/api/usermgmt/v1/user/00000

The Full Response

Recall that the user whose information is being retrieved is specified by their ID in the endpoint. This is the full response returned by the API.

{
 "userID": 00000,
 "username": "exampleu",
 "firstName": "Example",
 "lastName": "User",
 "email": "example@shopatron.com",
 "active": 1,
 "passwordExpires": "2017-10-14T00:24:58+00:00",
 "lastLogin": "2017-08-01T22:29:48-07:00",
 "groupID": 2,
 "groupName": "Manufacturer Admin",
 "manufacturerID": 111,
 "fulfillerID": 22222,
 "locale": "en-US",
 "admin": 0
}