Update store by ID

patch
/stores/{id}

Update a store by ID.

id
string
required

The ID of the store.

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
name
string

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
phone
string

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

<= 256 characters
Example:
+11234567890
address
object

The physical address of the store.

street_1
string

First line of the store's street address.

<= 256 characters
street_2
string

Second line of the store's street address.

<= 256 characters
street_3
string

Third line of the store's street address.

<= 256 characters
city
string

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

<= 256 characters
state
string

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

<= 256 characters
postal_code
string

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

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

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

Auth
:
Parameters
:
Body
{ "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", "phone": "+11234567890", "address": { "street_1": "98 Bofors Circle", "city": "New York", "state": "New York", "postal_code": "10001", "country_region": "USA", "coordinate": { "latitude": 40, "longitude": 74 } } }
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" ] } }