Create a new store.
Important: After creating a new store in Commerce API, please contact our support team to configure and enable the specific Commerce API features you need (such as
tracking,returns, etc.) for this store. This configuration is separate from any AfterShip products you may have already subscribed to.
The returnedstore.idvalue is essential, as you'll need to include it in the header of all subsequent Commerce API requests asas-store-idto identify which store you're operating on.
A unique identifier for the store in your system. It could be an ID, or a url-friendly name of your store.Show all...
Timestamp marking the creation of the store, formatted in ISO 8601 standard.
The timestamp indicating the last update to the store, formatted in ISO 8601 standard.
The shop's name.
The name of the timezone of your store located, as defined by the IANA timezone database standard.
Unit of measurement for weight used by the store, such as "lb" or "kg"
Indicates the currency used by the store. The currency should be specified using the ISO 4217 three-letter currency code (e.g., 'USD' for US Dollar, 'EUR' for Euro).
The URL of the store.
The text description of the store.
The supported product category name of the store.
The physical address of the store.
First line of the store's street address.
Second line of the store's street address.
Third line of the store's street address.
The city, town, or village where the store is located.
Indicates the state or region where the store is located, such as a province, state, or prefecture.
The postal code of the store (also known as zip code, postcode, Eircode, etc.).
The store's country/region in ISO 3166-1 alpha-3 format.
Store address coordinate.
The Meta model holds the metadata of the API response, including relevant error details for debugging purposes.Show all...
Error code in integer format. For detailed information, please refer to the Request Error introduction page.
Response type string for the reference. For detailed information, please refer to the Request Error introduction page.
Human-readable response message. For detailed information, please refer to the Request Error introduction page.
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...
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...
A unique resource ID generated by AfterShip.
The timestamp indicating when a store was created in AfterShip, formatted in ISO 8601 standard.
The timestamp indicating when a store was updated in AfterShip, formatted in ISO 8601 standard.
Timestamp marking the creation of the store, formatted in ISO 8601 standard.
The timestamp indicating the last update to the store, formatted in ISO 8601 standard.
A unique identifier for the store in your system. It could be an ID, or a url-friendly name of your store.Show all...
Identifies the platform associated with the store. For instance, a value of 'shopify' signifies that the store is based on Shopify, whereas a value of 'aftership' indicates the store originates from AfterShip.
The shop's name.
The name of the timezone of your store located, as defined by the IANA timezone database standard.
Unit of measurement for weight used by the store, such as "lb" or "kg"
Indicates the currency used by the store. The currency should be specified using the ISO 4217 three-letter currency code (e.g., 'USD' for US Dollar, 'EUR' for Euro).
The URL of the store.
The text description of the store.
The supported product category name of the store.
The physical address of the store.
{
"source_id": "my-store-1",
"source_created_at": "2024-05-06T12:32:00+01:00",
"source_updated_at": "2024-05-06T12:32:00+01:00",
"name": "My Store",
"support_email": "[email protected]",
"owner_email": "[email protected]",
"timezone_identifier": "America/New_York",
"weight_unit": "lb",
"currency": "USD",
"phone": "+11234567890",
"url": "https://www.example.com",
"description": "My shop",
"categories": [
"shoes",
"bags"
],
"address": {
"street_1": "98 Bofors Circle",
"city": "New York",
"state": "New York",
"postal_code": "10001",
"country_region": "USA",
"coordinate": {
"latitude": 40,
"longitude": 74
}
}
}{ "meta": { "code": 20100, "type": "Created", "message": "The request was successful, we created a new resource and the response body contains the representation." }, "data": { "id": "c10c3a0b90c24436bd158a0abbaf16d0", "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", "source_id": "my-store-1", "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" ] } }