This API endpoint makes an HTTP GET request to retrieve information about a store.
The response to this request will have a status code of 200 if the request is successful. The response body will contain a JSON object with the following properties:
-
success: A boolean value indicating whether the request was successful or not. -
store: An object representing the store. It has the following properties:-
id: The ID of the store. -
name: The name of the store. -
ecommerce: The type of ecommerce platform used by the store. -
email: The email address associated with the store. -
url: The URL of the store. -
address: An object representing the store's address. It has the following properties:id: The ID of the address.address1: The first line of the address.address2: The second line of the address.address3: The third line of the address.country: An object representing the country of the address. It has the following properties:code: The code of the country.name: The name of the country.codeIso2: The ISO 2-letter code of the country.codeIso3: The ISO 3-letter code of the country.
state: An object representing the state of the address. It has the following properties:code: The code of the state.name: The name of the state.codeIso2: The ISO 2-letter code of the state.codeIso3: The ISO 3-letter code of the state.
city: The city of the address.postalCode: The postal code of the address.phone: The phone number associated with the address.
-
currency: The currency used by the store. -
units: An object representing the units used by the store. It has the following properties:width: The unit used for width measurements.height: The unit used for height measurements.length: The unit used for length measurements.weight: The unit used for weight measurements.
-
coordinates: An object representing the coordinates of the store's location. It has the following properties:latitude: The latitude of the location.longitude: The longitude of the location.
-
pages: An array of pages associated with the store. -
plan: The plan of the store. -
logistic: An object representing the logistics information of the store. It has the following properties:-
me1Supported: The ME1 shipping support status of the store. -
modes: An array of shipping modes supported by the store.
-
-
Here is an example response for this request:
{
"success": true,
"store": {
"id": "",
"name": null,
"ecommerce": null,
"email": "",
"url": "",
"address": {
"id": null,
"address1": "",
"address2": null,
"address3": null,
"country": {
"code": "",
"name": "",
"codeIso2": "",
"codeIso3": ""
},
"state": {
"code": null,
"name": "",
"codeIso2": null,
"codeIso3": null
},
"city": "",
"postalCode": "",
"phone": ""
},
"currency": null,
"units": {
"width": null,
"height": null,
"length": null,
"weight": null
},
"coordinates": {
"latitude": null,
"longitude": null
},
"pages": [],
"plan": null,
"logistic": {
"me1Supported": "",
"modes": [""]
}
}
}
Please note that the values in the example response are placeholders and may not represent actual data.