发货 (Shipments)

概览

“发货”端点允许您查看客户发货单，并在订单进入派送工作流时更新履行状态。

身份验证

所有端点都需要身份验证。请在 Authorization 请求头中包含您的 API 令牌。有关获取令牌的更多信息，请参阅身份验证指南。

列出发货单

获取发货单列表。

端点： GET https://curosa.com/api/v1/shipments

请求

curl --location 'https://curosa.com/api/v1/shipments?status=pending' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

查询参数

列出待发货的发货单

获取当日待发货且尚未标记为已发货或已揽收的发货单。

端点： GET https://curosa.com/api/v1/shipments/ready-to-ship

请求

curl --location 'https://curosa.com/api/v1/shipments/ready-to-ship' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

响应行为

此端点返回满足以下条件的发货单：

• 预定于当天发货
• 当前未标记为已发货
• 当前未标记为已揽收

获取发货详情

通过订单号获取特定发货单。

端点： GET https://curosa.com/api/v1/shipments/{order_number}

请求

curl --location 'https://curosa.com/api/v1/shipments/OSN-01260312-002001' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

路径参数

将发货单标记为已发货

将发货单标记为已发货，并提供承运商/追踪信息。

端点： POST https://curosa.com/api/v1/shipments/{order_number}/shipped

请求

curl --location 'https://curosa.com/api/v1/shipments/OSN-01260312-002001/shipped' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
    "carrier": "DHL",
    "tracking_number": "DHL-123456789",
    "is_collected": false
}'

请求体

将发货单标记为已揽收

将发货单标记为已由承运商揽收。

端点： POST https://curosa.com/api/v1/shipments/{order_number}/collected

请求

curl --location 'https://curosa.com/api/v1/shipments/OSN-01260312-002001/collected' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
    "carrier": "DHL",
    "tracking_number": "DHL-123456789"
}'

请求体

速率限制

发货端点的速率限制为 每小时 3,600 次请求。当前的限制和剩余请求次数将在响应头的 x-ratelimit-limit 和 x-ratelimit-remaining 中返回。