Stores

You can manage the network of stores (company branches) via this resource. Many properties as address, GPS coordinates, opening hours or contact details can be synchronized with any other system.

Available methods

All available methods for resource stores.

HTTP method Endpoint Description
[badge-green POST] /stores Create a store
[badge-blue GET] /stores List of all store resources
[badge-blue GET] /stores/{store_id} Get a specific store data
[badge-grey PUT] /stores/{store_id} Update a specific store data


Create a store

Add a new store
[badge-green POST] /stores

Request

Parameter name Type Description Mandatory (Yes/No)
store Store Store structure Yes

Response

Status code: 201 Created
Output structure : object

Parameter name Type Description
store_id string The unique id for the store


Get all stores

Get information as a list of all stores.
[badge-blue GET] /stores

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
visible_for_customer integer State of the visibility for the customer
Possible values are: 0 - invisible / 1- visible. If query string is not used, return both.
No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
stores Store[] List of all stores
total_items integer Count of all found stores


Get a store

Get information about a specific store resource.
[badge-blue GET] /stores/{store_id}

Path parameters

Parameter name Type Description
store_id string The unique id for the store

Response

Status code: 200 OK
Output structure : Store


Update a store

This method updates a specific store resource.
[badge-grey PUT] /stores/{store_id}

Path parameters

Parameter name Type Description
store_id string The unique id for the store

Request

Parameter name Type Description Mandatory (Yes/No)
store Store Store structure Yes

Response

Status code: 204 No Content