QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
REFERENCE
API Overview
v1
Orders
Create an order
post
Get an order
get
Update an order
patch
Products
Create a product
post
Get a product
get
Update a product
patch
Stores
Create a store
post
Get a store
get
Update a store
patch
Webhook Server Overview
v1
GDPR
Receive GDPR webhooks
post
Model
Envelope
Meta
v1
Error
v1
Pagination
v1
Primitive
Address
v1
Customer
v1
Money
v1
Shipment
v1
Weight
v1
StoreAddress
v1
Resource
Order
v1
OrderItem
v1
Product
v1
Store
v1
Support
Contact Support

Store

id
string
read-onlyrequired

Unique identifier generated by AfterShip.

<= 32 characters
source_id
string
required

A unique identifier for the store.

<= 256 characters
name
string
required

The shop's name.

<= 256 characters
owner_email
string

Email of the owner.

<= 256 characters
timezone_identifier
string
required

The name of the timezone assigned by the IANA.

<= 256 characters
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
required

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.

Example
preparing...