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 Locations

The Get User Locations API retrieves information about the location(s) that a user is associated with. This call effectively acts like a Search API, returning a list of location results based on the userID criteria provided in the endpoint.

Version2.0
Callhttps://integration.shopatron.com/api/usermgmt/v1/user/{userID}/location
Supported FormatsJSON
HTTP MethodGET
Schemahttps://integration.shopatron.com/api/v2/schema/location.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 sample Postman collection.

Example

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

  • User ID 00000
  • Has one location assigned (Location ID 5)

General Information

The response returns the following information about a user’s locations:

  • Identification (Location, Store, Retailer, and Fulfiller IDs)
  • Address and Contact Information (address, phone, fax, email)
  • Configuration Details (active status, enabled featured, last updated)

The Full Request

This is the full request that would filter results that belong to a particular retailer or manufacturer.

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

The Full Response

This is the full response returned by the API.

{
 "collection": [
 {
  "locationID": 5,
  "externalStoreID": "Ext ID 4",
  "retailerID": 11111,
  "fulfillerID": 10101,
  "name": "Example Store",
  "addressLine1": "111 Test St",
  "addressLine2": "",
  "addressLine3": "",
  "city": "Dallas",
  "state": "TX",
  "countryCode": "US",
  "postalCode": "75201",
  "latitude": 43.6633,
  "longitude": -70.1908,
  "contact": " ",
  "contactPhone": "000.111.2222",
  "phone": "001112222",
  "fax": "",
  "email": "example@shopatron.com",
  "localSalesTax": 0,
  "active": true,
  "shippingLocation": true,
  "restockEnabled": false,
  "pickupEnabled": false,
  "showInAggregateReport": true,
  "taxableLocation": false,
  "mainLocation": false,
  "lastUpdated": "2016-04-26T23:51:04+0000"
 }
 ]
}