Account
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v202105/accounts | Get account list |
| POST | /api/v202105/accounts | Create a new account |
Header
| Key | Value |
|---|---|
| Authorization | Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi ... |
GET /api/v202105/accounts
Request
Parameters
| Type | Name | Description | Required/Optional | Schema |
|---|---|---|---|---|
| query | api | The API type Available Values: index.by-default | required | enum |
| query | account_id | The account ID | optional | integer |
| query | account_name | The sales account name | optional | string |
Response
| Key | Value |
|---|---|
| errcode | 0/4000 |
| errmsg | ok/Error Info |
| data | Data Properties |
Data Properties
| Name | Description | Schema |
|---|---|---|
| account_id | Account Id | integer |
| account_name | The sales account name | string |
| account_type | The third sales platform name. Available Values: Amazon, eBay, Wayfair, Walmart, Shopify, Chewy, HomeDepot,OTHER…… | enum |
Data Demo
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"account_id": "10001",
"account_name": "ShipSageAmazonTest",
"account_type": "Amazon"
},
{
"account_id": "10002",
"account_name": "ShipSageAmazonTest2",
"account_type": "Amazon"
}
]
}POST /api/v202105/accounts
Request
Parameters
| Type | Name | Description | Required/Optional | Schema |
|---|---|---|---|---|
| query | api | The API type Available Values: index.by-default | required | enum |
| body | account_name | The sales account name | required | string |
| body | account_type | The third sales platform name Available Values: Amazon, eBay, Wayfair, Walmart, Shopify, Chewy, HomeDepot，OTHER…… | required | enum |
body Demo
{
"account_name": "ShipSageAmazonTest",
"account_type": "Amazon"
}Response
| Key | Value |
|---|---|
| errcode | 0/4000 |
| errmsg | ok/Error Info |
| data | Data Properties |
Data properties
| Name | Description | Schema |
|---|---|---|
| account_id | Account Id | integer |
Data Demo
{
"errcode": 0,
"errmsg": "ok",
"data": {
"account_id": "10001"
}
}Modified at 2026-08-13 00:43:51