⬆️Request and Response

Request to the API endpoint

Get stores -or branches- and pickups type stores associated with the provided account

GET https://api.alephcrm.com/v2/accounts/{accountId}/stores

Query Parameters

Name	Type	Description
API_KEY*	String	(default=none)
accountId	Integer	(default=none)
allowPickupInStores	boolean	(default=NULL)
withAccountPickup	boolean	(default=NULL)
marketplace	Integer
sort	String	(default=ID)
offset	Integer	(default=0)
limit	Integer	(default=100)

200: OK {"Total": integer, "Paging": { "Limit": integer, "Offset": integer, "Total": integer,}, "SortBy": {"Id": string, "Name": string}, "AvailableSorts": [{"Id": string, "Name": string }], "Results":[ StoreType ] }

400: Bad Request {"Status": integer, "Message": string}

401 {"Status": integer, "Message": string}

403: Forbidden {"Status": integer, "Message": string}

404: Not Found {"Status": integer, "Message": string}

412: Precondition Failed {"Status": integer, "Message": string}

416: Range Not Satisfiable {"Status": integer, "Message": string}

429: Too Many Requests {"Status": integer, "Message": string}

500: Internal Server Error string

Parameters details

API_KEY

The API_KEY that was provided.

accountId

The Alephee account ID of the marketplaces you are trying to get.

allowPickupInStores

Filter the stores that are enabled to work as a “Pickup in store” branch. If true, the endpoint will return only those stores that are enabled as “Pickup in store” If false, the endpoint will return only those stores that are not enabled as “Pickup in store” If null (default) the endpoint will return all the stores.

withAccountPickup

Filter the stores that have an associated seller account. If true, the endpoint will return only those stores that have an associated seller account. If false, the endpoint will return only those stores that have no seller account registered. If null (default) the endpoint will return all the stores.

marketplace

Filters stores belonging to the provided marketplace. See marketplaces ID section and the GET marketplaces endpoint for the coding reference.

sort

Indicates the field to be sorted by (ascending only). Available fields: ID, dateCreated

offset

Used for paging. Moves the inferior limit of the records to the provided one. For example, offset=50 gets the rows skipping the first 50 records.

limit

Used for paging. Defines the number of records to be returned. For example, limit=10 gets only 10 records.