API docs by Redocly

馬可系統API (0.0.1)

Download OpenAPI specification:Download

提供其他系統串接馬可系統的API

客戶

取得客戶列表與專屬價格

query Parameters
page
integer >= 1
Default: 1

頁碼

pageSize
integer [ 1 .. 100 ]
Default: 20

每頁數量

LastModifiedDate
string <date-time>
Example: LastModifiedDate=2025-01-01T00:00:00Z

過濾在此日期後更新的客戶

Responses

Response samples

Content type
application/json
{
  • "customers": [
    ],
  • "pagination": {
    }
}

批量新增/更新客戶資訊

Request Body schema: application/json
required
Array of objects (CustomerInput)

Responses

Request samples

Content type
application/json
{
  • "customers": [
    ]
}

取得特定客戶的資訊

path Parameters
CustomerID
required
string

客戶ID

Responses

Response samples

Content type
application/json
{
  • "customer": {
    }
}

品項

取得品項與價格資訊

query Parameters
page
integer >= 1
Default: 1

頁碼

pageSize
integer [ 1 .. 100 ]
Default: 20

每頁數量

LastModifiedDate
string <date-time>
Example: LastModifiedDate=2025-01-01T00:00:00Z

過濾在此日期後更新的品項

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

批量新增/更新品項資訊

Request Body schema: application/json
required
Array of objects (Item)

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

取得特定商品的資訊

path Parameters
ItemID
required
string

商品ID

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

庫存

取得所有庫存資訊

query Parameters
page
integer >= 1
Default: 1

頁碼

pageSize
integer [ 1 .. 100 ]
Default: 20

每頁數量

Responses

Response samples

Content type
application/json
{
  • "inventory": [
    ],
  • "pagination": {
    }
}

批量更新庫存資訊

Request Body schema: application/json
required
Array of objects (Inventory)

Responses

Request samples

Content type
application/json
{
  • "inventory": [
    ]
}

取得特定商品的庫存資訊

path Parameters
ItemID
required
string

商品ID

Responses

Response samples

Content type
application/json
{
  • "inventory": {
    }
}

訂單

取得訂單資訊

query Parameters
page
integer >= 1
Default: 1

頁碼

pageSize
integer [ 1 .. 100 ]
Default: 20

每頁數量

Status
string
Enum: "Pending" "Received" "Picked" "Sending" "Sent" "Cancelled"

過濾特定狀態的訂單，狀態enum可以根據實際情況調整

LastModifiedDate
string <date-time>
Example: LastModifiedDate=2025-01-01T00:00:00Z

過濾在此日期後更新的訂單，ISO 8601 格式

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ],
  • "pagination": {
    }
}

批量新增/更新訂單資訊

Request Body schema: application/json
required
Array of objects (OrderInput)

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

取得特定訂單的資訊

path Parameters
OrderID
required
string

訂單ID

Responses

Response samples

Content type
application/json
{
  • "order": {
    }
}

訂單webhook

串接方提供接口，接收訂單資訊；接口路徑僅供參考，實際路徑以串接方提供為準

Request Body schema: application/json
required
OrderID
string

訂單ID

CustomerID
string

客戶ID

Status
string
Enum: "Pending" "Received" "Picked" "Sending" "Sent" "Cancelled"

訂單狀態

DiscountAmount
number

折扣金額，單位為元

FreightAmount
number

運費金額，單位為元

Amount
number

訂單縂金額，單位為元，訂單縂金額 = 商品金額 - 折扣金額 + 運費金額

CreatedAt
string <date-time>

訂單創建時間，ISO 8601 格式

UpdatedAt
string <date-time>

訂單更新時間，ISO 8601 格式

Array of objects

Responses

Request samples

Content type
application/json
{
  • "OrderID": "string",
  • "CustomerID": "string",
  • "Status": "Pending",
  • "DiscountAmount": 0,
  • "FreightAmount": 0,
  • "Amount": 0,
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Items": [
    ]
}