Delete User Location
The Delete User Location API allows the admin to delete a particular user’s location assignment.
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.
In this example, the following location properties will be removed from the designated user:
- Location 5
- Being removed from User ID 00000
The only required information is already designated in the URL endpoint of the call, but there are a few additional details that can be supplied while deleting a new location:
|manufacturerID||string||A single or list of identifiers for manufacturers. They should be positive integers.|
|retailerID||string||A single or list of identifiers for manufacturers. They should be positive integers.|
|catalogID||integer||A unique identifier for the catalog associated with the user.|
The Full Request
This sample will delete the designated location from the user, using the URL structure as defined above. 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 successful response should be 204 No Content, to indicate that the location data is no longer registered with that user. A response in the 400s or 500s is an error.