Store

id
string
read-only

Unique identifier generated by AfterShip.

<= 32 characters
name
string
required

The shop's name.

<= 256 characters
owner_email
string

Email of the owner.

<= 256 characters
timezone_identifier
string

The name of the timezone assigned by the IANA.

<= 256 characters
Default:
Etc/UTC
plan_name
string

The plan name represents the type of plan: Free, Basic, Enterprise, etc.

<= 256 characters
support_email
string

Email of the support team.

<= 256 characters
weight_unit
string

Weighing unit of the store.

<= 64 characters
currency
string
required

ISO 4217 Currency Codes.

<= 3 characters
source_created_at
string

The date and time when the store was created. ISO 8601.

source_updated_at
string

The date and time when the store was last modified. ISO 8601.

phone
string

Phone of the owner.

<= 256 characters
url
string

The URL of a shop.

<= 2083 characters
description
string

The description of a shop.

<= 10240 characters
categories
array[string]

The categories of a shop.

<= 100 items
address
StoreAddress
address_line_1
string

The store's mailing address.

<= 256 characters
address_line_2
string

An additional field for the store's mailing address.

<= 256 characters
address_line_3
string

An additional field for the store's mailing address.

<= 256 characters
city
string

The store’s city, town, or village.

<= 256 characters
state
string

The store’s region name. Typically a province, a state, or a prefecture.

<= 256 characters
country_region
string

The store's country.

<= 3 characters
postal_code
string

The store’s postal code, also known as zip, postcode, Eircode, etc.

<= 256 characters
latitude
number

The store’s latitude.

longitude
number

The store’s longitude.

created_at
string

The date and time (ISO 8601 format) when an store was created in AfterShip.

updated_at
string

The date and time (ISO 8601 format) when an store was updated in AfterShip.

Example
preparing...