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

Add User Location

The Add User Location API allows the admin to add a location assignment to a particular user. This user will only be able to manage the orders and shipments of their specified location in the OMS interfaces.

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

Example

In this example, the user will be assigned the following location properties:

  • User ID 00000
  • Being assigned to Location 5

Required Parameters

The following parameters are required for all instances of this call:

ParameterTypeDescription
locationIDintegerThe fulfillment location ID that the user is being assigned to.

Optional Parameters

These are the other details that can be supplied while adding a new location:

ParameterTypeDescription
manufacturerIDintegerA unique identifier for the manufacturer that the user is associated with. Note that this will be read-only.
retailerIDintegerA unique identifier for the retailer associated with this user.
catalogIDintegerA unique identifier for the catalog associated with this user.

The Full Request

Using the URL format as outlined above, the entire call is fairly simple to put together. This sample will add the designated location to the user. The Shopatron-User-ID key will need to be added to the header and filled with the ID of the user making the request, for security purposes.

The user being modified is designated in the URL endpoint:

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

Meanwhile, the location and any other optional parameters are noted in the body of the request:

{
 "locationID":"5"
}

The returned response should be 200 OK. There will not be any data returned, but using the Get User Locations request will allow one to confirm that the change was made.