Skip to content

API Reference ​

Zymeup REST API 参考文档。所有接口均通过 Bearer Token 认证,生产环境 Base URL:

https://api.zymeup.com/api/v1

按模块浏览 ​

模块端点说明
OrderCreate Order + Docs创建订单并可选生成 EPOD/ECMR
EPODEPOD Overview电子签收全流程
ECMRECMR Overview电子运单与 CMR 签名
Address商户地址簿地址簿 CRUD、默认地址
Validation校验 Overview邮箱/电话/邮编/税号校验

快速示例 ​

bash
# 创建订单
curl -X POST "https://api.zymeup.com/api/v1/order/create-with-documents" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sender_address": { ... },
    "receiver_address": { ... },
    "parcels": [{"weight": 1.5, "length": 30, "width": 20, "height": 15}]
  }'
typescript
const sdk = new ZymeupClient({
  apiKey: 'your-api-key',
  baseUrl: 'https://api.zymeup.com/api/v1',
  role: 'merchant'
})

const order = await sdk.order.createWithDocuments({
  sender_address: { ... },
  receiver_address: { ... },
  parcels: [{ weight: 1.5, length: 30, width: 20, height: 15 }]
})

Released under the MIT License.