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.

Before you can utilize any features of the Commerce API, you must first create a store. After the store has been created, you will obtain a store ID. This ID is necessary for creating subsequent resources within the API.

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...

id
string
read-only

A unique resource ID generated by AfterShip.

<= 32 characters
Example:
c10c3a0b90c24436bd158a0abbaf16d0
created_at
string

The timestamp indicating when a store was created in AfterShip, formatted in ISO 8601 standard.

Example:
2024-05-06T12:32:00+01:00
updated_at
string

The timestamp indicating when a store was updated in AfterShip, formatted in ISO 8601 standard.

Example:
2024-05-06T12:32:00+01:00
source_created_at
string

Timestamp marking the creation of the store, formatted in ISO 8601 standard.

Example:
2024-05-06T12:32:00+01:00
source_updated_at
string

The timestamp indicating the last update to the store, formatted in ISO 8601 standard.

Example:
2024-05-06T12:32:00+01:00
source_id
string
required

A unique identifier for the store in your system. It could be an ID, or a url-friendly name of your store.Show all...

<= 32 characters
Example:
my-store-1
platform
string
read-only

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.

Example:
aftership
name
string
required

The shop's name.

<= 256 characters
Example:
My Store
support_email
string

Support email address for your store.

<= 256 characters
owner_email
string

The email address of the store owner.

<= 256 characters
timezone_identifier
string

The name of the timezone of your store located, as defined by the IANA timezone database standard.

<= 256 characters
Example:
America/New_York
weight_unit
string

Unit of measurement for weight used by the store, such as "lb" or "kg"

<= 64 characters
Example:
lb
currency
string
required

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).

<= 3 characters
Example:
USD
phone
string

The store's phone number in E.164 format.

<= 256 characters
Example:
+13525554500
url
string

The URL of the store.

<= 2083 characters
Example:
https://www.example.com
description
string

The text description of the store.

<= 10240 characters
Example:
My shop
categories
array[string]

The supported product category name of the store.

<= 100 items
address
object

The physical address of the store.

street_1
string

First line of the store's street address.

<= 256 characters
Example:
98 Circle
street_2
string or null

Second line of the store's street address.

<= 256 characters
street_3
string or null

Third line of the store's street address.

<= 256 characters
city
string

The city, town, or village where the store is located.

<= 256 characters
Example:
Daug City
state
string

Indicates the state or region where the store is located, such as a province, state, or prefecture.

<= 256 characters
Example:
New York
postal_code
string

The postal code of the store (also known as zip code, postcode, Eircode, etc.).

<= 256 characters
Example:
10001
country_region
string

The store's country/region in ISO 3166-1 alpha-3 format.

Example:
USA
Match pattern:
^[A-Z]{3}$
coordinate
object

Store address coordinate.

Example
preparing...