Important: After creating a new store in Commerce API, please contact our support team to configure and enable the specific Commerce API features you need (such as tracking, returns, etc.) for this store. This configuration is separate from any AfterShip products you may have already subscribed to.
The returned store.id value is essential, as you'll need to include it in the header of all subsequent Commerce API requests as as-store-id to identify which store you're operating on.

Request

Security: API Key

Body

source_id

string

required

The identifier of your store.Show all...

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

<= 2048 characters

description

string

The description of a shop.

<= 10240 characters

Responses

Body

meta

Meta

Meta data object.

Example:

{"code":20000,"type":"OK","message":"The request was successfully processed by Automizely."}

code

number

required

Default:

20000

Example:

20000

type

string

required

>= 1 characters

Example:

message

string

required

>= 1 characters

Example:

The request was successfully processed by Automizely.

errors

array[Error]

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.

data

Store

Example:

{"id":"0b45336d08f5415eb9e85613a49b6d71","source_id":"test-store-1","plaform":"aftership","name":"Turn","owner_email":"[email protected]","timezone_identifier":"Africa/Johannesburg","plan_name":"basic","support_email":"[email protected]","weight_unit":"kg","currency":"ZAR","source_created_at":"2020-03-20T07:48:25Z","source_updated_at":"2021-03-18T15:36:04Z","created_at":"2020-03-20T07:48:26Z","updated_at":"2021-03-18T15:36:05Z","phone":"+8618824131200","address":{"address_line_1":"98 Circle","address_line_2":"Unit","address_line_3":null,"city":"Fale Town","state":"Fake City","country_region":"ZAF","postal_code":"7460","latitude":-23.935,"longitude":38.5652778},"url":"https://www.mystore.com","description":"a shop","categories":["shoes","bags"]}

string

Unique identifier generated by AfterShip.

<= 32 characters

source_id

string

required

A unique identifier for the store in your system.

<= 32 characters

Example:

5187092316403

platform

string

The platform to which the store belongs. For example, if the value is 'shopify', it indicates that the store originates from Shopify. If the value is 'aftership', it implies that the store comes from AfterShip.

Example:

aftership

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

400

Bad Request

Body

meta

Meta

Meta data object.

Example:

{"code":20000,"type":"OK","message":"The request was successfully processed by Automizely."}

code

number

required

Default:

20000

Example:

20000

type

string

required

>= 1 characters

Example:

message

string

required

>= 1 characters

Example:

The request was successfully processed by Automizely.

errors

array[Error]

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.

data

object

401

Unauthorized

Body

meta

Meta

Meta data object.

Example:

{"code":20000,"type":"OK","message":"The request was successfully processed by Automizely."}

code

number

required

Default:

20000

Example:

20000

type

string

required

>= 1 characters

Example:

message

string

required

>= 1 characters

Example:

The request was successfully processed by Automizely.

errors

array[Error]

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.

data

object

403

Forbidden

Body

meta

Meta

Meta data object.

Example:

{"code":20000,"type":"OK","message":"The request was successfully processed by Automizely."}

code

number

required

Default:

20000

Example:

20000

type

string

required

>= 1 characters

Example:

message

string

required

>= 1 characters

Example:

The request was successfully processed by Automizely.

errors

array[Error]

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.

data

object

412

Precondition Failed

Body

meta

Meta

Meta data object.

Example:

{"code":20000,"type":"OK","message":"The request was successfully processed by Automizely."}

code

number

required

Default:

20000

Example:

20000

type

string

required

>= 1 characters

Example:

message

string

required

>= 1 characters

Example:

The request was successfully processed by Automizely.

errors

array[Error]

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.

data

object

422

Unprocessable Entity (WebDAV)

Body

meta

Meta

Meta data object.

Example:

{"code":20000,"type":"OK","message":"The request was successfully processed by Automizely."}

code

number

required

Default:

20000

Example:

20000

type

string

required

>= 1 characters

Example:

message

string

required

>= 1 characters

Example:

The request was successfully processed by Automizely.

errors

array[Error]

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.

data

object

429

Too Many Requests

Body

meta

Meta

Meta data object.

Example:

{"code":20000,"type":"OK","message":"The request was successfully processed by Automizely."}

code

number

required

Default:

20000

Example:

20000

type

string

required

>= 1 characters

Example:

message

string

required

>= 1 characters

Example:

The request was successfully processed by Automizely.

errors

array[Error]

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.

data

object

500

Internal Server Error

Body

meta

Meta

required

Meta data object.

Example:

{"code":20000,"type":"OK","message":"The request was successfully processed by Automizely."}

code

number

required

Default:

20000

Example:

20000

type

string

required

>= 1 characters

Example:

message

string

required

>= 1 characters

Example:

The request was successfully processed by Automizely.

errors

array[Error]

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.

data

object

required

Auth

Body

{
  "source_id": "test-store-1",
  "name": "Turn",
  "owner_email": "[email protected]",
  "timezone_identifier": "Africa/Johannesburg",
  "plan_name": "basic",
  "support_email": "[email protected]",
  "weight_unit": "kg",
  "currency": "ZAR",
  "source_created_at": "2020-03-20T07:48:25Z",
  "source_updated_at": "2021-03-18T15:36:04Z",
  "phone": "+8618824131200",
  "address": {
    "address_line_1": "98 Bofors Circle",
    "address_line_2": "Unit",
    "address_line_3": "",
    "city": "Fake Town",
    "state": "Fake City",
    "country_region": "ZAF",
    "postal_code": "7460",
    "latitude": -23.935,
    "longitude": 38.5652778
  },
  "url": "https://www.mystore.com",
  "description": "a shop",
  "categories": [
    "shoes",
    "bags"
  ]
}

Response Example

{
  "meta": {
    "code": 20100,
    "type": "Created",
    "message": "The request was successful, we created a new resource and the response body contains the representation."
  },
  "data": {
    "id": "0b45336d08f5415eb9e85613a49b6d71",
    "source_id": "test-store-1",
    "plaform": "aftership",
    "name": "Turn",
    "owner_email": "[email protected]",
    "timezone_identifier": "Africa/Johannesburg",
    "plan_name": "basic",
    "support_email": "[email protected]",
    "weight_unit": "kg",
    "currency": "ZAR",
    "source_created_at": "2020-03-20T07:48:25Z",
    "source_updated_at": "2021-03-18T15:36:04Z",
    "created_at": "2020-03-20T07:48:26Z",
    "updated_at": "2021-03-18T15:36:05Z",
    "phone": "+8618824131200",
    "address": {
      "address_line_1": "98 Circle",
      "address_line_2": "Unit",
      "address_line_3": null,
      "city": "Fale Town",
      "state": "Fake City",
      "country_region": "ZAF",
      "postal_code": "7460",
      "latitude": -23.935,
      "longitude": 38.5652778
    },
    "url": "https://www.mystore.com",
    "description": "a shop",
    "categories": [
      "shoes",
      "bags"
    ]
  }
}