Get stores

get
/stores

Get store results with multiple stores.

limit
string

The maximum number of results to show on a page. Default is 10.

page
string

Current page of the collection. Default is 1.

ids[]
string

Each element must contain fewer than 128 characters. The total number of elements should not exceed 50. Each id should be used as an independent query parameter in the URL, as demonstrated in the following example: GET /stores?ids[]=5247009653041&ids[]=5081836323059

meta
Meta

The Meta model holds the metadata of the API response, including relevant error details for debugging purposes.Show all...

Example:
{"code":20000,"type":"OK","message":"The request was successfully processed by AfterShip."}
code
number
required

Error code in integer format. For detailed information, please refer to the Request Error introduction page.

Default:
20000
Example:
20000
type
string
required

Response type string for the reference. For detailed information, please refer to the Request Error introduction page.

>= 1 characters
Example:
OK
message
string
required

Human-readable response message. For detailed information, please refer to the Request Error introduction page.

>= 1 characters
Example:
The request was successfully processed by AfterShip.
errors
array[Error]

Error detail object. Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.Show all...

data
object
stores
array[Store]

A Store represents your actual retail outlet or an online store. All other resources within the API, including orders and products, are linked to a specific store.Show all...

pagination
Pagination

The Pagination holds the information for the pagination when the response contains multiple objects.

Example:
{"page":1,"limit":10,"has_next_page":false}
parameter_string
string

A string that includes the request parameters.

Example:
page=1&limit=10
Auth
:
Parameters
:
:
:
Response Example
{ "meta": { "code": 20000, "type": "OK", "message": "The request was successfully processed by AfterShip." }, "data": { "stores": [ { "id": "my-store-1", "created_at": "2024-05-06T12:32:00+01:00", "updated_at": "2024-05-06T12:32:00+01:00", "source_created_at": "2024-05-06T12:32:00+01:00", "source_updated_at": "2024-05-06T12:32:00+01:00", "platform": "aftership", "name": "My Store", "owner_email": "[email protected]", "timezone_identifier": "America/New_York", "support_email": "[email protected]", "weight_unit": "lb", "currency": "USD", "phone": "+11234567890", "address": { "street_1": "98 Circle", "street_2": "", "street_3": "", "city": "Daug City", "state": "New York", "country_region": "USA", "postal_code": "10001", "latitude": 43, "longitude": -75 }, "url": "https://www.exmaple.com", "description": "My shop", "categories": [ "shoes", "bags" ] } ], "pagination": { "page": 1, "limit": 10, "has_next_page": true }, "parameter_string": "page=1&limit=10" } }