QUICKSTART
API Quick Start
Authentication
SignString
Versioning
Rate Limit
Body Envelope
Request Errors
Common Scenarios
Tracking
Sending Notifications
Estimated Delivery Date
Branded Tracking Page
Product Recommendation
Buy Online, Pickup In Store (BOPIS)
Next Couriers
Other Scenarios
Shipping
Returns
CHANGELOG
Changelog
Migration Guide
Past Changelog
REFERENCE
API Overview
Orders
Create an order
post
Get orders
get
Get order by ID
get
Update order by ID
patch
Products
Create a product
post
Get product by ID
get
Update product by ID
patch
Stores
Create a store
post
Get stores
get
Get store by ID
get
Update store by ID
patch
Fulfillments
Create a fulfillment
post
Get fulfillments
get
Get fulfillment by ID
get
Update fulfillment by ID
patch
Update fulfillment status
post
Ship fulfillment
post
Model
Envelope
Meta
v1
Error
v1
Pagination
v2
Primitive
Address
v1
AddressWithCoordinate
v1
Customer
v1
Location
v1
Money
v1
OpeningHours
v1
OpeningHourPeriod
v1
OrderItem
v1
Pickup
v1
PickupLocation
v1
Tracking
v1
Weight
v1
OrderCustomFields
v1
StatusTimestamps
v1
Resource
Order
v1
Product
v1
Fulfillment
v1
Store
v1
Support
Contact Support

Get store by ID

get
/stores/{id}

Get a store by ID.

Request

Path Parameters

id
string
required

The ID of the store.

Responses

200

Body

meta
Meta

The Meta model holds the metadata of the API response, including relevant error details for debugging purposes.Show all...

Example:
{"code":20000,"type":"OK","message":"The request was successfully processed by AfterShip."}
code
number
required

Error code in integer format. For detailed information, please refer to the Request Error introduction page.

Default:
20000
Example:
20000
type
string
required

Response type string for the reference. For detailed information, please refer to the Request Error introduction page.

>= 1 characters
Example:
OK
message
string
required

Human-readable response message. For detailed information, please refer to the Request Error introduction page.

>= 1 characters
Example:
The request was successfully processed by AfterShip.
errors
array[Error]

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

data
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.Show all...

Example:
{"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","support_email":"[email protected]","owner_email":"[email protected]","timezone_identifier":"America/New_York","weight_unit":"lb","currency":"USD","phone":"+13525554500","url":"https://www.example.com","description":"My shop","categories":["shoes"],"address":{"street_1":"98 Circle","street_2":null,"street_3":null,"city":"Daug City","state":"New York","postal_code":"10001","country_region":"USA","coordinate":{"latitude":40,"longitude":74}}}
id
string

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

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
Example:
[email protected]
owner_email
string

The email address of the store owner.

<= 256 characters
Example:
[email protected]
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.

Auth
:
Parameters
:
Response Example
{
  "meta": {
    "code": 20000,
    "type": "OK",
    "message": "The request was successfully processed by AfterShip."
  },
  "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"
    ]
  }
}