- Request
- Body
- NotificationType
- PingNotificationDTO
- OrderCreatedNotificationDTO
- OrderStatusUpdatedNotificationDTO
- OrderCancelledNotificationDTO
- OrderCancellationRequestNotificationDTO
- OrderReturnCreatedNotificationDTO
- OrderReturnStatusUpdatedNotificationDTO
- OrderUpdatedNotificationDTO
- GoodsFeedbackCreatedNotificationDTO
- GoodsFeedbackCommentCreatedNotificationDTO
- ChatCreatedNotificationDTO
- ChatMessageSentNotificationDTO
- ChatArbitrageStartedNotificationDTO
- ChatArbitrageFinishedNotificationDTO
- NotificationOrderItemDTO
- OrderStatusType
- OrderSubstatusType
- NotificationReturnItemDTO
- ReturnType
- NotificationUpdatedReturnStatusesDTO
- OrderUpdateType
- RefundStatusType
- ReturnShipmentStatusType
- Responses
- 200 OK
- 400 Bad Request
- 500 Internal Server Error
接收通知
市场向商店发送有关事件的通知:
- 创建新订单;
- 订单修改;
- 订单状态更改;
- 创建与客户的新聊天;
- 在聊天中添加新消息;
- 争端的开始;
- 争端的结束;
- 创建新产品评论;
- 创建新的评论评论;
- 创建订单取消请求;
- 取消订单;
- 创建新的非购买或退款;
- 更改非购买或退款状态。
使用通知时请记住这些功能。
-
燕基科斯.市场可以为同一事件发送多个通知。
在某些情况下,这是正常行为。 例如,由于搜索快递员,订单状态可能会发生变化。
-
通知中的时间、对市场请求的响应以及您的系统中的时间可能会有所不同。
这是由于在发送通知时,订单状态可能已经不同。
在请求
POST通知
活动时间到了createdAt
,updatedAt
或cancelledAt
. 参数的选择取决于通知的类型。
考虑事件的稍后时间是相关的。 它可以在通知中,响应市场请求返回,或存储在您的系统中。
接收响应超时:10秒。
Request
POST
/notification
Body
application/json
{
"notificationType": "PING",
"time": "2022-12-29T18:02:01Z"
}
Name |
Description |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
...rest |
oneOf PingNotificationDTO 验证通知。
|
...rest |
oneOf OrderCreatedNotificationDTO 创建新订单的通知。
获取有关订单的详细信息 |
...rest |
oneOf OrderStatusUpdatedNotificationDTO 订单状态更改的通知。
|
...rest |
oneOf OrderCancelledNotificationDTO 订单取消通知。
|
...rest |
oneOf OrderCancellationRequestNotificationDTO 发出取消订单要求的通知(适用于星展商店).
|
...rest |
oneOf OrderReturnCreatedNotificationDTO 创建新的非购买或退款的通知。
获取有关非购买或退款的详细信息 |
...rest |
oneOf OrderReturnStatusUpdatedNotificationDTO 非购买或退款状态更改的通知。
获取有关非购买或退款的详细信息 |
...rest |
oneOf OrderUpdatedNotificationDTO 订单变更通知。
获取有关订单的详细信息 |
...rest |
oneOf GoodsFeedbackCreatedNotificationDTO 创建新产品审核的通知。
燕基科斯.只有当评论被审核和发布时,市场才会发送有关评论的通知。 获取有关评论的详细信息 使用方法 POST v2/businesses/{businessId}/goods-feedback 在参数中指定它们的Id 如果客户或市场已删除评论,您将无法获得信息。 |
...rest |
oneOf GoodsFeedbackCommentCreatedNotificationDTO 创建新审核评论的通知。
获取有关评论的详细信息 使用方法 POST v2/businesses/{businessId}/goods-feedback/comments 在参数中指定它们的Id 如果用户或市场删除了添加评论或评论,您将无法收到信息。 |
...rest |
oneOf ChatCreatedNotificationDTO 与买方创建新聊天的通知。
它适用于所有类型的聊天。 与客户聊天 使用方法 GET v2/businesses/{businessId}/chat 在参数中指定聊天ID的地方 |
...rest |
oneOf ChatMessageSentNotificationDTO 聊天中新消息的通知。
它适用于所有类型的聊天。 接收来自买方的消息 使用方法 GET v2/businesses/{businessId}/chats/message 在哪里指定Id:
|
...rest |
oneOf ChatArbitrageStartedNotificationDTO 争议开始的通知。
不是来和那种人聊天的 |
...rest |
oneOf ChatArbitrageFinishedNotificationDTO 争议结束的通知。
不是来和那种类型的人聊天的 |
NotificationType
通知类型:
PING
-验证通知。ORDER_CREATED
-一个新的秩序已经建立。ORDER_CANCELLED
-订单已取消。ORDER_STATUS_UPDATED
-订单状态已更改。ORDER_RETURN_CREATED
—已创建新的非购买或退款。ORDER_CANCELLATION_REQUEST
-已创建订单取消请求(适用于DBS商店)。ORDER_RETURN_STATUS_UPDATED
-非购买或退款状态已更改。ORDER_UPDATED
-订单已更改。GOODS_FEEDBACK_CREATED
-已创建新产品评论。GOODS_FEEDBACK_COMMENT_CREATED
-已创建新的产品评论评论。CHAT_CREATED
-已创建与买家的新聊天。CHAT_MESSAGE_SENT
-添加了新的聊天消息。CHAT_ARBITRAGE_STARTED
-应买方的要求,开始了争议。CHAT_ARBITRAGE_FINISHED
-争端结束了。
Type |
Description |
Enum: |
PingNotificationDTO
验证通知。
notificationType
= PING
Name |
Description |
notificationType |
Type: NotificationType 通知类型:
Enum: |
time |
Type: string<date-time> 商店处理通知的日期和时间。 日期格式: ISO 8601 具有相对于 UTC. 例如, |
OrderCreatedNotificationDTO
创建新订单的通知。
notificationType
= ORDER_CREATED
获取有关订单的详细信息
Name |
Description |
campaignId* |
Type: integer<int64> 活动ID。 使用该方法可以找到 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
,不要发送商店ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。 |
createdAt* |
Type: string<date-time> 创建订单的日期和时间。 日期格式: ISO 8601 具有相对于 UTC. 例如, |
items* |
Type: NotificationOrderItemDTO[] 订单中的产品列表。 |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
orderId* |
Type: integer<int64> 的订单ID。 |
OrderStatusUpdatedNotificationDTO
订单状态更改的通知。
notificationType
= ORDER_STATUS_UPDATED
Name |
Description |
campaignId* |
Type: integer<int64> 活动ID。 使用该方法可以找到 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
,不要发送商店ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。 |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
orderId* |
Type: integer<int64> 的订单ID。 |
status* |
Type: OrderStatusType 订单状况:
也可以返回其他值。 您不需要处理它们。 Enum: |
substatus* |
Type: OrderSubstatusType 订单处理的阶段(如果它具有状态
也可以返回其他值。 您不需要处理它们。 Enum: |
updatedAt* |
Type: string<date-time> 订单状态更改的日期和时间。 日期格式: ISO 8601 具有相对于 UTC. 例如, |
OrderCancelledNotificationDTO
订单取消通知。
notificationType
= ORDER_CANCELLED
Name |
Description |
campaignId* |
Type: integer<int64> 活动ID。 使用该方法可以找到 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
,不要发送商店ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。 |
cancelledAt* |
Type: string<date-time> 取消订单的日期和时间。 日期格式: ISO 8601 具有相对于 UTC. 例如, |
items* |
Type: NotificationOrderItemDTO[] 订单中的产品列表。 |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
orderId* |
Type: integer<int64> 的订单ID。 |
OrderCancellationRequestNotificationDTO
发出取消订单要求的通知(适用于星展商店).
notificationType
= ORDER_CANCELLATION_REQUEST
Name |
Description |
campaignId* |
Type: integer<int64> 活动ID。 使用该方法可以找到 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
,不要发送商店ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。 |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
orderId* |
Type: integer<int64> 的订单ID。 |
requestedAt* |
Type: string<date-time> 创建取消请求的日期和时间。 日期格式: ISO 8601 具有相对于 UTC. 例如, |
OrderReturnCreatedNotificationDTO
创建新的非购买或退款的通知。
notificationType
= ORDER_RETURN_CREATED
获取有关非购买或退款的详细信息
Name |
Description |
campaignId* |
Type: integer<int64> 活动ID。 使用该方法可以找到 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
,不要发送商店ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。 |
createdAt* |
Type: string<date-time> 创建非购买或退款的日期和时间。 日期格式: ISO 8601 具有相对于 UTC. 例如, |
items* |
Type: NotificationReturnItemDTO[] 非购买或退货的项目列表。 |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
orderId* |
Type: integer<int64> 的订单ID。 |
returnId* |
Type: integer<int64> 非购买或退款的ID。 |
returnType* |
Type: ReturnType 用于过滤的订单类型:
如果您没有指定它,响应将包括非购买和退款。 Enum: |
OrderReturnStatusUpdatedNotificationDTO
非购买或退款状态更改的通知。
notificationType
= ORDER_RETURN_STATUS_UPDATED
获取有关非购买或退款的详细信息
Name |
Description |
campaignId* |
Type: integer<int64> 活动ID。 使用该方法可以找到 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
,不要发送商店ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。 |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
orderId* |
Type: integer<int64> 的订单ID。 |
returnId* |
Type: integer<int64> 非购买或退款的ID。 |
statuses* |
Type: NotificationUpdatedReturnStatusesDTO 有关更新非购买或退款状态的信息。 仅返回已更改的状态。 对于非购买,只 参数 |
updatedAt* |
Type: string<date-time> 更改非购买或退款状态的日期和时间。 日期格式: ISO 8601 具有相对于 UTC. 例如, |
OrderUpdatedNotificationDTO
订单变更通知。
notificationType
= ORDER_UPDATED
获取有关订单的详细信息
Name |
Description |
campaignId* |
Type: integer<int64> 活动ID。 使用该方法可以找到 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
,不要发送商店ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。 |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
orderId* |
Type: integer<int64> 的订单ID。 |
updateType* |
Type: OrderUpdateType Тип изменения заказа. Enum: |
updatedAt* |
Type: string<date-time> 订单更改的日期和时间。 日期格式: ISO 8601 具有相对于 UTC. 例如, |
GoodsFeedbackCreatedNotificationDTO
创建新产品审核的通知。
notificationType
= GOODS_FEEDBACK_CREATED
燕基科斯.只有当评论被审核和发布时,市场才会发送有关评论的通知。
获取有关评论的详细信息
使用方法 POST v2/businesses/{businessId}/goods-feedback 在参数中指定它们的Id feedbackIds
.
如果客户或市场已删除评论,您将无法获得信息。
Name |
Description |
businessId* |
Type: integer<int64> 内阁ID。 |
createdAt* |
Type: string<date-time> 创建审核的日期和时间。 它可能不同于 日期格式: ISO 8601 具有相对于 UTC. 例如, |
feedbackId* |
Type: integer<int64> 的审查ID。 |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
publishedAt* |
Type: string<date-time> 发表评论的日期和时间。 它可能不同于 日期格式: ISO 8601 具有相对于 UTC. 例如, |
GoodsFeedbackCommentCreatedNotificationDTO
创建新审核评论的通知。
notificationType
= GOODS_FEEDBACK_COMMENT_CREATED
获取有关评论的详细信息
使用方法 POST v2/businesses/{businessId}/goods-feedback/comments 在参数中指定它们的Id commentIds
.
如果用户或市场删除了添加评论或评论,您将无法收到信息。
Name |
Description |
businessId* |
Type: integer<int64> 内阁ID。 |
commentId* |
Type: integer<int64> 评论评论的ID。 |
createdAt* |
Type: string<date-time> 创建注释的日期和时间。 日期格式: ISO 8601 具有相对于 UTC. 例如, |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
ChatCreatedNotificationDTO
与买方创建新聊天的通知。
notificationType
= CHAT_CREATED
它适用于所有类型的聊天。
与客户聊天
使用方法 GET v2/businesses/{businessId}/chat 在参数中指定聊天ID的地方 chatId
.
Name |
Description |
businessId* |
Type: integer<int64> 内阁ID。 |
chatId* |
Type: integer<int64> 的聊天ID。 |
createdAt* |
Type: string<date-time> 创建聊天的日期和时间。 日期格式: ISO 8601 具有相对于 UTC. 例如, |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
ChatMessageSentNotificationDTO
聊天中新消息的通知。
notificationType
= CHAT_MESSAGE_SENT
它适用于所有类型的聊天。
接收来自买方的消息
使用方法 GET v2/businesses/{businessId}/chats/message 在哪里指定Id:
- 聊天室 —
chatId
; - 信息 —
messageId
.
Name |
Description |
businessId* |
Type: integer<int64> 内阁ID。 |
chatId* |
Type: integer<int64> 的聊天ID。 |
messageId* |
Type: string 消息的ID。 |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
sentAt* |
Type: string<date-time> 发送邮件的日期和时间。 日期格式: ISO 8601 具有相对于 UTC. 例如, |
ChatArbitrageStartedNotificationDTO
争议开始的通知。
notificationType
= CHAT_ARBITRAGE_STARTED
不是来和那种人聊天的 DIRECT
. 了解有关此类聊天的更多信息
Name |
Description |
businessId* |
Type: integer<int64> 内阁ID。 |
chatId* |
Type: integer<int64> 的聊天ID。 |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
startedAt* |
Type: string<date-time> 争议开始的日期和时间。 日期格式: ISO 8601 具有相对于 UTC. 例如, |
ChatArbitrageFinishedNotificationDTO
争议结束的通知。
notificationType
= CHAT_ARBITRAGE_FINISHED
不是来和那种类型的人聊天的 DIRECT
. 了解有关此类聊天的更多信息
Name |
Description |
businessId* |
Type: integer<int64> 内阁ID。 |
chatId* |
Type: integer<int64> 的聊天ID。 |
finishedAt* |
Type: string<date-time> 争议结束的日期和时间。 日期格式: ISO 8601 具有相对于 UTC. 例如, |
notificationType* |
Type: NotificationType 通知类型:
Enum: |
NotificationOrderItemDTO
订单中有关产品的信息。
Name |
Description |
count* |
Type: integer 品的数量。 |
offerId* |
Type: string 你的 SKU -系统中的产品ID。 使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读如何做到这一点。 在市场对卖家的帮助. Min length: Max length: Pattern: |
OrderStatusType
订单状况:
-
PLACING
-正在处理,准备预订。 -
RESERVED
-预订,但预订不足。 -
UNPAID
-已发出,但尚未付款(如果在结账时选择付款)。 -
PROCESSING
-正在处理中。 -
DELIVERY
-转移到送货服务。 -
PICKUP
-送到收货点。 -
DELIVERED
-买方收到。 -
CANCELLED
-取消。 -
PENDING
-等待卖方处理。 -
PARTIALLY_RETURNED
-部分返回。 -
RETURNED
-全额回来了。 -
UNKNOWN
-未知状态。
也可以返回其他值。 您不需要处理它们。
Type |
Description |
Enum: |
OrderSubstatusType
订单处理的阶段(如果它具有状态 PROCESSING
)或取消订单的原因(如果它具有状态 CANCELLED
).
-
状态中的订单值
PROCESSING
:-
STARTED
-订单已确认,可以处理。 -
READY_TO_SHIP
-订单已收集并准备装运。
-
-
状态中的订单值
CANCELLED
:-
RESERVATION_EXPIRED
-客户未在10分钟内完成预订订单。 -
USER_NOT_PAID
-买方未支付订单(对于付款类型PREPAID
)30分钟。 -
USER_UNREACHABLE
-无法联系买家。 为此取消,必须满足以下条件:- 至少3个电话从8到21在买方的时区;
- 第一次和第三次通话之间的休息时间至少为90分钟;
- 连接不短于5秒。
如果不满足其中至少一个条件(号码不可用时除外),您将无法取消订单。 将返回带有错误代码400的响应。
-
USER_CHANGED_MIND
-客户因个人原因取消订单。 -
USER_REFUSED_DELIVERY
-买方对交货条款不满意。 -
USER_REFUSED_PRODUCT
-该产品不适合买方。 -
SHOP_FAILED
-商店无法完成订单。 -
USER_REFUSED_QUALITY
-买方不满意的产品质量。 -
REPLACING_ORDER
-买方决定主动更换另一种产品。 -
PROCESSING_EXPIRED
-该值不再使用。 -
PICKUP_EXPIRED
-订单在PVZ中的存储期已过期。 -
TOO_MANY_DELIVERY_DATE_CHANGES
-订单被推迟了太多次。 -
TOO_LONG_DELIVERY
-订单需要太长的时间才能交付。 -
INCORRECT_PERSONAL_DATA
-对于来自国外的订单,收件人的信息不正确,订单将不会在海关检查。
-
-
TECHNICAL_ERROR
-市场方面的技术错误。 联系支持。
也可以返回其他值。 您不需要处理它们。
Type |
Description |
Enum: |
NotificationReturnItemDTO
关于非购买或退货的产品的信息。
Name |
Description |
count* |
Type: integer 品的数量。 |
offerId* |
Type: string 你的 SKU -系统中的产品ID。 使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读如何做到这一点。 在市场对卖家的帮助. Min length: Max length: Pattern: |
ReturnType
用于过滤的订单类型:
-
UNREDEEMED
-非购买。 -
RETURN
-退款。
如果您没有指定它,响应将包括非购买和退款。
Type |
Description |
Enum: |
NotificationUpdatedReturnStatusesDTO
有关更新非购买或退款状态的信息。
仅返回已更改的状态。
对于非购买,只 shipmentStatus
.
参数 shipmentStatus
没有到达退款与选项 廉价婚姻的快速退款,当产品仍然与买方。
Name |
Description |
refundStatus |
Type: RefundStatusType 退款状况:
Enum: |
shipmentStatus |
Type: ReturnShipmentStatusType 退款转移状况:
Enum: |
OrderUpdateType
订单变更类型:
SHIPMENT_DATE_UPDATED
-更改装运日期。DELIVERY_DATE_UPDATED
-更改交货日期。UNKNOWN
-未知类型。
Type |
Description |
Enum: |
RefundStatusType
退款状况:
-
STARTED_BY_USER
-由客户从他的个人帐户创建。 -
REFUND_IN_PROGRESS
-等待退款的决定。 -
REFUNDED
-钱已经退了。 -
FAILED
—不可能向买方退款。 -
WAITING_FOR_DECISION
-等待决定(DBS). -
DECISION_MADE
-已就退款作出决定(DBS). -
REFUNDED_WITH_BONUSES
-退款是用加分或促销代码进行的。 -
REFUNDED_BY_SHOP
-商店自行退款。 -
COMPLETE_WITHOUT_REFUND
-不需要退款。 -
CANCELLED
-退款已取消。 -
REJECTED
-退款被审核或PVZ拒绝。 -
PREMODERATION_DISPUTE
-退款有争议(FBY, FBS 和快递)。 -
PREMODERATION_DECISION_WAITING
-等待决定(FBY, FBS 和快递)。 -
PREMODERATION_DECISION_MADE
-已就退款作出决定(FBY, FBS 和快递)。 -
PREMODERATION_SELECT_DELIVERY
-用户选择送货方式(FBY, FBS 和快递)。 -
UNKNOWN
-未知状态。
Type |
Description |
Enum: |
ReturnShipmentStatusType
退款转移状况:
-
CREATED
-已创建退款。 -
RECEIVED
-从买方接受。 -
IN_TRANSIT
-回来的路上。 -
READY_FOR_PICKUP
-退款准备发放到商店。 -
PICKED
-已向商店退款。 -
LOST
-退款在运输过程中丢失。 -
EXPIRED
-买家没有按时带货退货。 -
CANCELLED
-退款已取消。 -
FULFILMENT_RECEIVED
-退款在市场仓库接受。 -
PREPARED_FOR_UTILIZATION
-退货已处理完毕。 -
NOT_IN_DEMAND
-退款没有从邮局领取。 -
UTILIZED
-退款已处理完毕。 -
READY_FOR_EXPROPRIATION
-退货中的商品发送转售。 -
RECEIVED_FOR_EXPROPRIATION
-退货中的商品可转售。 -
UNKNOWN
-未知状态。
Type |
Description |
Enum: |
Responses
200 OK
通知处理的信息的有效请求的响应。
Body
application/json
{
"version": "string",
"name": "string",
"time": "2022-12-29T18:02:01Z"
}
Name |
Description |
name* |
Type: string 集成的名称。 Min length: Max length: |
time* |
Type: string<date-time> 格式的通知处理开始的日期和时间 UTC. |
version* |
Type: string 的集成版本。 Min length: Max length: |
400 Bad Request
如果市场发送了错误的通知,返回状态 400
与错误的描述。
Body
application/json
{
"error": {
"type": "UNKNOWN",
"message": "string"
}
}
Name |
Description |
error |
Type: NotificationApiErrorDTO 处理通知时出错。 |
NotificationApiErrorDTO
处理通知时出错。
Name |
Description |
message |
Type: string 错误的描述。 |
type |
Type: NotificationApiErrorType 错误类型:
Enum: |
NotificationApiErrorType
错误类型:
UNKNOWN
-未知错误。WRONG_EVENT_FORMAT
-不正确的通知类型。DUPLICATED_EVENT
-重复通知。
Type |
Description |
Enum: |
500 Internal Server Error
如果您遇到技术错误,请返回状态 500
. 商店的API没有响应
Body
application/json
{
"error": {
"type": "UNKNOWN",
"message": "string"
}
}
Name |
Description |
error |
Type: NotificationApiErrorDTO 处理通知时出错。 |
No longer supported, please use an alternative and newer version.