- Request
- Responses
- 200 OK
- Body
- OrderDTO
- FlippingPagerDTO
- ForwardScrollingPagerDTO
- OrderBuyerDTO
- CurrencyType
- OrderDeliveryDTO
- OrderItemDTO
- OrderPaymentMethodType
- OrderPaymentType
- OrderTaxSystemType
- OrderSubsidyDTO
- OrderDeliveryDatesDTO
- OrderDeliveryPartnerType
- OrderDeliveryType
- OrderDeliveryAddressDTO
- OrderCourierDTO
- OrderDeliveryEacType
- OrderLiftType
- RegionDTO
- OrderShipmentDTO
- OrderTrackDTO
- OrderVatType
- OrderItemDetailDTO
- OrderItemInstanceDTO
- OrderItemPromoDTO
- OrderItemInstanceType
- OrderItemSubsidyDTO
- OrderItemTagType
- OrderSubsidyType
- GpsDTO
- RegionType
- OrderParcelBoxDTO
- OrderItemStatusType
- OrderPromoType
- OrderItemSubsidyType
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 420 Method Failure
- 500 Internal Server Error
有关多个订单的信息
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
返回有关订单的信息。 您可以使用查询来查找是否有任何新订单。
默认情况下,不会接收有关测试订单的数据。 要获取它们,请传递值 true
在参数中 fake
.
您还可以设置API通知。
燕基科斯.市场会送你 请求 当新订单出现或其状态发生变化时。 和完整的信息可以使用此方法或 GET v2/campaigns/{campaignId}/orders/{orderId}.
可按多个顺序特性进行过滤:
-
登记日期;
-
状况;
-
订单Id;
-
处理的阶段或取消的原因;
-
类型(真实或测试);
-
发货到送货服务的日期;
-
订单更新的日期和时间。
超过30天前交付或取消订单的信息将不予退还。 可以通过请求关于特定订单的信息来获得。 GET v2/campaigns/{campaignId}/orders/{orderId} (如果您有订单ID)或请求订单报告 POST v2/campaigns/{campaignId}/stats/orders.
单个资源请求的最大日期范围为30天。
结果逐页返回。 要浏览页面,请使用参数 page_token
和 limit
.
您可以通过请求获取有关买家及其电话号码的更多详细信息 GET v2/campaigns/{campaignId}/orders/{orderId}/buyer.
参数的限制 limit
不要传输大于50的值。
**⚙️ 限制:**每小时100,000次请求 |
---|
Request
GET
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders
Path parameters
Name |
Description |
campaignId* |
Type: integer<int64> 活动ID。 您可以使用查询找到它 :no-translate[GET v2/campaigns] 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
,不要发送商店ID代替,这是在卖方的帐户在市场上的商店名称旁边和一些报告。
Min value: |
Query parameters
Name |
Description |
buyerType |
Type: OrderBuyerType 按客户类型过滤订单。 |
dispatchType |
Type: OrderDeliveryDispatchType 装运方法 |
fake |
Type: boolean 按类型过滤订单:
Default: |
fromDate |
Type: string<date> 按结帐日期筛选订单的开始日期。 日期格式: 开始和结束日期之间(参数 默认值:从当前日期起30天前. |
hasCis |
Type: boolean 我是否需要只退回系统中至少包含一个带有识别码的商品的订单? «Честный ЗНАК» 或 «ASL BELGISI» (对于卖家 Market Yandex Go):
这些代码被分配给需要贴标签并属于某些类别的产品。
Default: |
limit |
Type: integer<int32> 每页的值数。
Min value: |
onlyEstimatedDelivery |
Type: boolean 按已确认的交货日期过滤长交货(31-60天)的订单:
Default: |
onlyWaitingForCancellationApprove |
Type: boolean 仅适用于DBS型号 根据客户的取消请求过滤订单。 与值 要确认或拒绝取消,请发送请求 PUT v2/campaigns/{campaignId}/orders/{orderId}/cancellation/accept.
Default: |
orderIds |
Type: integer<int64>[] 按Id过滤订单。
Min items: Max items: |
page |
Type: integer<int32> 如果方法有 用它代替参数 结果页的编号。 与参数一起使用
Default: Max value: |
pageSize |
Type: integer<int32> 页面大小。 与参数一起使用
|
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 |
status |
Type: OrderStatusType[] 订单状况:
|
substatus |
Type: OrderSubstatusType[] 订单处理的阶段(如果它具有状态 状态中订单的可能值
状态中订单的可能值
|
supplierShipmentDateFrom |
Type: string<date> 按发货到送货服务的日期筛选订单的开始日期(参数 日期格式: 开始和结束日期之间(参数 开始日期包含在筛选的间隔中。 |
supplierShipmentDateTo |
Type: string<date> 按发货到送货服务的日期筛选订单的结束日期(参数 日期格式: 在初始(参数 结束日期不包括在过滤间隔中。 如果之间的时间间隔 |
toDate |
Type: string<date> 按结帐日期筛选订单的结束日期。 显示指定日期00:00之前创建的订单。 日期格式: 在初始(参数 默认值:当前日期。 如果之间的时间间隔 |
updatedAtFrom |
Type: string<date-time> 按更新日期和时间筛选订单的开始日期(参数 日期格式: ISO 8601 具有相对于 UTC. 例如, 开始日期和结束日期之间(参数 开始日期包含在筛选的间隔中。 |
updatedAtTo |
Type: string<date-time> 按更新日期和时间筛选订单的结束日期(参数 日期格式: ISO 8601 具有相对于 UTC. 例如, 在初始(参数 结束日期不包括在过滤间隔中。 |
OrderBuyerType
买方类型:
-
PERSON
-个人。 -
BUSINESS
-组织。
Type |
Description |
Enum: |
OrderDeliveryDispatchType
装运方法:
-
BUYER
-快递交付给买方。 -
MARKET_BRANDED_OUTLET
-送货到市场的提货点。 -
SHOP_OUTLET
-送货到商店的订单提货点。 -
UNKNOWN
-未知类型。
Type |
Description |
Enum: |
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: |
Responses
200 OK
关于订单的信息。
Body
application/json
{
"pager": {
"total": 0,
"from": 0,
"to": 0,
"currentPage": 0,
"pagesCount": 0,
"pageSize": 0
},
"orders": [
{
"id": 0,
"externalOrderId": "string",
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"creationDate": "23-09-2022 09:12:41",
"updatedAt": "23-09-2022 09:12:41",
"currency": "RUR",
"itemsTotal": 0,
"deliveryTotal": 0,
"buyerItemsTotal": 0,
"buyerTotal": 0,
"buyerItemsTotalBeforeDiscount": 0,
"buyerTotalBeforeDiscount": 0,
"paymentType": "PREPAID",
"paymentMethod": "CASH_ON_DELIVERY",
"fake": false,
"items": [
{
"id": 0,
"offerId": "string",
"offerName": "string",
"price": 0,
"buyerPrice": 0,
"buyerPriceBeforeDiscount": 0,
"priceBeforeDiscount": 0,
"count": 0,
"vat": "NO_VAT",
"shopSku": "string",
"subsidy": 0,
"partnerWarehouseId": "string",
"promos": [
{
"type": "DIRECT_DISCOUNT",
"discount": 0,
"subsidy": 0,
"shopPromoId": "string",
"marketPromoId": "string"
}
],
"instances": [
{
"cis": "string",
"cisFull": "string",
"uin": "string",
"rnpt": "string",
"gtd": "string",
"countryCode": "RU"
}
],
"details": [
{
"itemCount": 0,
"itemStatus": "REJECTED",
"updateDate": "23-09-2022"
}
],
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0
}
],
"requiredInstanceTypes": [
"CIS"
],
"tags": [
"ULTIMA"
]
}
],
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0
}
],
"delivery": {
"id": "string",
"type": "DELIVERY",
"serviceName": "string",
"price": 0,
"deliveryPartnerType": "SHOP",
"courier": {
"fullName": "string",
"phone": "string",
"phoneExtension": "string",
"vehicleNumber": "string",
"vehicleDescription": "string"
},
"dates": {
"fromDate": "23-09-2022",
"toDate": "23-09-2022",
"fromTime": "string",
"toTime": "string",
"realDeliveryDate": "23-09-2022"
},
"region": {
"id": 0,
"name": "string",
"type": "OTHER"
},
"address": {
"country": "string",
"postcode": "string",
"city": "string",
"district": "string",
"subway": "string",
"street": "string",
"house": "string",
"estate": "string",
"block": "string",
"building": "string",
"entrance": "string",
"entryphone": "string",
"floor": "string",
"apartment": "string",
"phone": "string",
"recipient": "string",
"gps": {
"latitude": 0,
"longitude": 0
}
},
"vat": "NO_VAT",
"deliveryServiceId": 0,
"liftType": "NOT_NEEDED",
"liftPrice": 0,
"outletCode": "string",
"outletStorageLimitDate": "23-09-2022",
"dispatchType": "UNKNOWN",
"tracks": [
{
"trackCode": "string",
"deliveryServiceId": 0
}
],
"shipments": [
{
"id": 0,
"shipmentDate": "23-09-2022",
"shipmentTime": "string",
"tracks": [
{
"trackCode": "string",
"deliveryServiceId": 0
}
],
"boxes": [
{
"id": 0,
"fulfilmentId": "string"
}
]
}
],
"estimated": false,
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "string"
},
"buyer": {
"id": "string",
"lastName": "string",
"firstName": "string",
"middleName": "string",
"type": "PERSON"
},
"notes": "string",
"taxSystem": "OSN",
"cancelRequested": false,
"expiryDate": "23-09-2022 09:12:41"
}
],
"paging": {
"nextPageToken": "string"
}
}
Name |
Description |
orders* |
Type: OrderDTO[] 的订单模型。
Max items: |
pager |
Type: FlippingPagerDTO 分页的模型。 |
paging |
Type: ForwardScrollingPagerDTO Информация о страницах с результатами. |
OrderDTO
秩序。
Name |
Description |
buyer* |
Type: OrderBuyerDTO 有关买方的信息。 参数 |
buyerItemsTotalBeforeDiscount* |
Type: number 订单中所有项目的成本以买方的货币计算,不包括运费和在:
|
creationDate* |
Type: string<date-dd-MM-yyyy-HH-mm-ss> 订单的日期和时间。 日期和时间格式: Example: |
currency* |
Type: CurrencyType Валюта, в которой указаны цены на товары в заказе. Enum: |
delivery* |
Type: OrderDeliveryDTO 交付信息。 |
deliveryTotal* |
Type: number 交付的成本。 |
fake* |
Type: boolean 订单类型:
|
id* |
Type: integer<int64> 的订单ID。 |
items* |
Type: OrderItemDTO[] 订单中的产品列表。 |
itemsTotal* |
Type: number 买方付款。 |
paymentMethod* |
Type: OrderPaymentMethodType 订购付款方法:
默认值: Enum: |
paymentType* |
Type: OrderPaymentType 订购付款类别:
如果省略此参数,订单将在收到时支付。 Enum: |
status* |
Type: OrderStatusType 订单状况:
也可以返回其他值。 您不需要处理它们。 Enum: |
substatus* |
Type: OrderSubstatusType 订单处理的阶段(如果它具有状态
也可以返回其他值。 您不需要处理它们。 Enum: |
taxSystem* |
Type: OrderTaxSystemType 下订单时商店的税收制度:
Enum: |
buyerItemsTotal ⦸
|
Type: number 订单中所有物品的成本在应用折扣后以买方的货币计算,不包括运费。 |
buyerTotal ⦸
|
Type: number 订单中所有项目的成本,在应用折扣后,以买方的货币计算,并考虑到运输成本。 |
buyerTotalBeforeDiscount ⦸
|
Type: number 订单中所有项目在应用折扣之前以买方货币计算的成本,包括运费( |
cancelRequested |
Type: boolean 仅适用于DBS型号 是否已要求取消。 |
expiryDate |
Type: string<date-dd-MM-yyyy-HH-mm-ss> 如果订单不改变其状态,订单将被取消的日期。 日期格式: Example: |
externalOrderId |
Type: string 您提交的订单的外部ID POST v2/campaigns/{campaignId}/orders/{orderId}/external-id. Min length: |
notes |
Type: string 对订单进行评论。 |
subsidies |
Type: OrderSubsidyDTO[] 按类型划分的补贴清单。
包括增值税。 Min items: |
updatedAt |
Type: string<date-dd-MM-yyyy-HH-mm-ss> 上次订单更新的日期和时间。 日期和时间格式: Example: |
FlippingPagerDTO
分页的模型。
Name |
Description |
currentPage |
Type: integer<int32> 当前页面。 |
from |
Type: integer<int32> 页上找到的元素的初始编号。 |
pageSize |
Type: integer<int32> 页面大小。 |
pagesCount |
Type: integer<int32> 的总页数。 |
to |
Type: integer<int32> 页上找到的元素的最终编号。 |
total |
Type: integer<int32> 总共找到了多少件物品。 |
ForwardScrollingPagerDTO
下一页的ID。
Name |
Description |
nextPageToken |
Type: string 下一个结果页面的ID。 |
OrderBuyerDTO
有关买方的信息。
参数 id
, lastName
, firstName
和 middleName
只有当您根据模型工作时,才会返回它们。 DBS.
Name |
Description |
type* |
Type: OrderBuyerType Тип покупателя: физическое лицо или организация. Этот параметр используется FBS- и FBY-магазинами, размещающими товары на витрине business.market.yandex.ru. Enum: |
firstName |
Type: string 买家的名字。 |
id |
Type: string 买方的ID。 |
lastName |
Type: string 买方的姓氏。 |
middleName |
Type: string 买方的父权。 |
CurrencyType
货币代码:
RUR
-俄罗斯卢布。UAH
-乌克兰格里夫纳。BYR
-白俄罗斯卢布。KZT
-哈萨克斯坦坚戈。UZS
-乌兹别克总和。
Type |
Description |
Enum: |
OrderDeliveryDTO
交付信息。
Name |
Description |
dates* |
Type: OrderDeliveryDatesDTO 交货日期的范围。 |
deliveryPartnerType* |
Type: OrderDeliveryPartnerType Тип сотрудничества со службой доставки в рамках конкретного заказа. Enum: |
deliveryServiceId* |
Type: integer<int64> 送服务ID。 |
serviceName* |
Type: string 送货服务的名称。 |
type* |
Type: OrderDeliveryType Способ доставки заказа. Enum: |
address |
Type: OrderDeliveryAddressDTO 送货地址。 如果参数指定 |
courier |
Type: OrderCourierDTO 关于快递员的信息。 |
dispatchType |
Type: OrderDeliveryDispatchType 装运方法:
Enum: |
eacCode |
Type: string EAPP确认码(适用于类型 |
eacType |
Type: OrderDeliveryEacType Тип кода подтверждения ЭАПП. Enum: |
estimated |
Type: boolean 交货日期是否近似。 |
id ⦸
|
Type: string 店分配的配送ID。 仅当存储使用该方法在对请求的响应中传递此标识符时,才指定此标识符 |
liftPrice |
Type: number 上地板的费用。 |
liftType |
Type: OrderLiftType 将订单提升到地板的类型:
Enum: |
outletCode |
Type: string 店分配的取件点ID。 |
outletStorageLimitDate |
Type: string<date-dd-MM-yyyy> 日期格式: Example: |
price ⦸
|
Type: number 请参阅参数中的运费 以订单货币交付的成本。 |
region |
Type: RegionDTO 的输送区域。 |
shipments |
Type: OrderShipmentDTO[] 有关包裹的信息。 可以在参数中指定多个宗地。 Min items: |
tracks |
Type: OrderTrackDTO[] 跟踪包裹移动的信息。 Min items: |
vat |
Type: OrderVatType 产品的增值税(VAT):
仅与参数结合使用 Enum: |
OrderItemDTO
订单中的产品列表。
Name |
Description |
buyerPrice* |
Type: number 以买方货币计算的产品价格。 价格已经包括折扣:
|
buyerPriceBeforeDiscount* |
Type: number 在应用折扣之前,以买方货币计算的产品成本:
|
count* |
Type: integer 积单元的数量。 |
id* |
Type: integer<int64> 订单中的产品ID。 允许您在此订单范围内识别产品。 |
offerId* |
Type: string Идентификатор вашего товарного предложения для определенного товара. Описание поля в Справке Маркета для продавцов Min length: Max length: Pattern: |
offerName* |
Type: string 产品名称。 |
price* |
Type: number 以订单货币计算的产品价格,不包括促销代码、优惠券和促销折扣给卖方的报酬(参数) 包括增值税。 |
vat* |
Type: OrderVatType Налог на добавленную стоимость (НДС) на товар. Enum: |
details ⦸
|
Type: OrderItemDetailDTO[] 要获取有关非购买和退款的信息,请使用 GET v2/campaigns/{campaignId}/returns. 有关订单中未购买或退回物品的信息。
Min items: |
instances |
Type: OrderItemInstanceDTO[] 品单元的标签的信息。 请求中传递的标记数据返回。 PUT v2/campaigns/{campaignId}/orders/{orderId}/identifiers. 如果商店尚未发送此订单的代码, Min items: |
partnerWarehouseId |
Type: string 只适用于型号 FBY 订单所在仓库的ID。 |
priceBeforeDiscount ⦸
|
Type: number 在应用折扣之前,以商店货币计算的产品成本。 |
promos |
Type: OrderItemPromoDTO[] 有关使用促销代码,优惠券和促销活动向卖家提供商品折扣的奖励的信息。 Min items: |
requiredInstanceTypes |
Type: OrderItemInstanceType[] 所需产品标记的列表。
Enum: Min items: Unique items |
shopSku ⦸
|
Type: string Вместо него используйте Ваш SKU — идентификатор товара в вашей системе. Min length: Max length: Pattern: |
subsidies |
Type: OrderItemSubsidyDTO[] 按类型划分的补贴清单。
包括增值税。 Min items: |
subsidy ⦸
|
Type: number 相反,使用 DBS交付给卖方的总报酬和产品的所有折扣:
|
tags |
Type: OrderItemTagType[] 产品属性。
Enum: Min items: Unique items |
OrderPaymentMethodType
订购付款方法:
-
如果在结账时选择付款,则值(
"paymentType":"预付费"
):-
YANDEX
-银行卡。 -
APPLE_PAY
-苹果支付。 -
GOOGLE_PAY
-谷歌支付。 -
CREDIT
-信贷。 -
TINKOFF_CREDIT
-从Tinkoff银行信贷。 -
TINKOFF_INSTALLMENTS
-分期付款在Tinkoff银行。 -
EXTERNAL_CERTIFICATE
-礼券(例如,来自Sberbank在线申请)。 -
SBP
—通过快速支付系统。 -
B2B_ACCOUNT_PREPAYMENT
-组织支付订单。
-
-
如果在收到订单时选择付款的值(
"paymentType":"POSTPAYED"
):-
CARD_ON_DELIVERY
-银行卡。 -
BOUND_CARD_ON_DELIVERY
-收到连结银行卡。 -
BNPL_BANK_ON_DELIVERY
-超级分裂。 -
BNPL_ON_DELIVERY
-分裂。 -
CASH_ON_DELIVERY
-现金。 -
B2B_ACCOUNT_POSTPAYMENT
-订单在交付后由组织支付。
-
-
UNKNOWN
-未知类型。
默认值: CASH_ON_DELIVERY
.
Type |
Description |
Enum: |
OrderPaymentType
订购付款类别:
-
PREPAID
-付款时。 -
POSTPAID
-收到订单后付款。 -
UNKNOWN
-未知类型。
如果省略此参数,订单将在收到时支付。
Type |
Description |
Enum: |
OrderTaxSystemType
下订单时商店的税收制度:
-
ECHN
-统一农业税(UST)。 -
ENVD
-统一计算所得税(UTII)。 -
OSN
-税收的一般制度(OSN)。 -
PSN
-专利税制(PSN)。 -
USN
-简化税制(STS)。 -
USN_MINUS_COST
-简化的税收制度,收入减少的费用数额(USN"收入减去费用")。 -
NPD
-专业所得税(NAP)。 -
UNKNOWN_VALUE
-未知值。 仅与参数结合使用付款方法=氨纶
.
Type |
Description |
Enum: |
OrderSubsidyDTO
DBS交付给卖方的总报酬和产品的所有折扣:
- 通过促销代码、优惠券和促销;
- 按加分;
- 货到付款(DBS).
包括增值税。
Name |
Description |
amount* |
Type: number 补助金额。 |
type* |
Type: OrderSubsidyType 资助类别:
Enum: |
OrderDeliveryDatesDTO
交货日期的范围。
Name |
Description |
fromDate* |
Type: string<date-dd-MM-yyyy> 日期格式: Example: |
fromTime |
Type: string<time> 送时间间隔的开始。 它仅与参数一起传递 时间格式:24小时, 最小值: |
realDeliveryDate |
Type: string<date-dd-MM-yyyy> 日期格式: Example: |
toDate |
Type: string<date-dd-MM-yyyy> 日期格式: Example: |
toTime |
Type: string<time> 送时间间隔的结束。 它仅与参数一起传递 时间格式:24小时, 最大值: |
OrderDeliveryPartnerType
在特定订单内与送货服务的合作类型:
-
SHOP
-商店直接与送货服务合作或独立交付订单。 -
YANDEX_MARKET
-这家商店通过市场提供送货服务。 -
UNKNOWN
-未知类型。
Type |
Description |
Enum: |
OrderDeliveryType
订单交付方式:
-
DELIVERY
-快递送货。 -
PICKUP
-皮卡。 -
POST
-邮件。 -
DIGITAL
-对于数字商品。 -
UNKNOWN
-未知类型。
Type |
Description |
Enum: |
OrderDeliveryAddressDTO
送货地址。
如果参数指定 type
取值 DELIVERY
, POST
或 PICKUP
(仅适用于DBS型号)。 如果 类型=皮卡
,返回取件点的地址。
Name |
Description |
apartment |
Type: string 公寓或办公室号码。 |
block |
Type: string 身体。 |
building |
Type: string 建筑。 |
city |
Type: string 一个城市或地方。 |
country |
Type: string 一个国家。 |
district |
Type: string 区。 |
entrance |
Type: string 入口号码。 |
entryphone |
Type: string 的对讲代码。 |
estate |
Type: string 所有权号码。 |
floor |
Type: string 地板。 |
gps |
Type: GpsDTO GPS-координаты. |
house |
Type: string 门牌号。 |
phone |
Type: string 订单的收件人的电话号码。 |
postcode |
Type: string 邮政编码。 如果选择了邮件传递,则表示( |
recipient |
Type: string 订单收件人的姓氏,名字和父名。 |
street |
Type: string 街道。 |
subway |
Type: string 地铁站。 |
OrderCourierDTO
关于快递员的信息。
Name |
Description |
fullName |
Type: string 快递员的全名。 |
phone |
Type: string 快递员的电话号码。 |
phoneExtension |
Type: string 分机电话号码。 |
vehicleDescription |
Type: string 汽车的描述。 例如,模型和颜色。 |
vehicleNumber |
Type: string 车辆号码。 |
OrderDeliveryEacType
EAPP确认码的类型:
-
MERCHANT_TO_COURIER
(暂时不可退款)-卖方将代码发送给快递员以接收非购买。 -
COURIER_TO_MERCHANT
-快递员将代码传送给卖方以接收订单。 -
CHECKING_BY_MERCHANT
-卖方检查他身边的代码。
Type |
Description |
Enum: |
OrderLiftType
将订单提升到地板的类型:
-
NOT_NEEDED
-不需要。 -
MANUAL
-手册。 -
ELEVATOR
-电梯。 -
CARGO_ELEVATOR
-货运电梯。 -
FREE
—上述任何一项,如果启用了免费电梯选项。 -
UNKNOWN
-未知类型。
Type |
Description |
Enum: |
RegionDTO
的输送区域。
Name |
Description |
id* |
Type: integer<int64> 区域的ID。 |
name* |
Type: string 区域的名称。 |
type* |
Type: RegionType 区域的类型。 可能的值:
Enum: |
parent |
Type: RegionDTO 的输送区域。 |
OrderShipmentDTO
的包列表。
可以在参数中指定多个宗地。
Name |
Description |
boxes |
Type: OrderParcelBoxDTO[] 货物位置列表。 Min items: |
id ⦸
|
Type: integer<int64> Yandex分配的包裹ID。市场。 |
shipmentDate |
Type: string<date-dd-MM-yyyy> 日期格式: Example: |
shipmentTime |
Type: string 仅适用于Express型号 商店必须打包订单并将其设置为状态的时间 该字段可能不会立即显示。 在5-10分钟内请求有关订单的信息,直到它被退回。 时间格式:24小时, 如果订单是由组织发出的,则在商定交货日期之前不会返回参数。 |
tracks |
Type: OrderTrackDTO[] 只适用于型号 DBS 跟踪包裹移动的信息。
Min items: |
OrderTrackDTO
有关包裹轨道号码的资料(DBS).
Name |
Description |
deliveryServiceId* |
Type: integer<int64> 送服务ID。 有关派递服务的资料,可透过要求 GET delivery/services. |
trackCode |
Type: string 包裹的轨道号码。 |
OrderVatType
产品的增值税(VAT):
-
NO_VAT
-不收取增值税,仅用于某些类型的服务。 -
VAT_0
-0%增值税。 例如,它用于销售在出口海关程序中出口的货物,或为国际货物运输提供服务。 -
VAT_10
-10%增值税。 例如,它用于销售某些食品和医疗产品。 -
VAT_10_110
-增值税 10/110. 10%增值税,仅适用于预付款。 -
VAT_20
-20%增值税。 基本增值税从2019年开始。 -
VAT_20_120
-增值税 20/120. 增值税为20%,仅适用于预付款。 -
VAT_18
-增值税18%。 基本增值税至2019年。 -
VAT_18_118
-增值税 18/118. 增值税用于预付款,直到2019年1月1日。 -
VAT_12
-12%增值税。 它仅在乌兹别克斯坦使用。 -
VAT_05
-5%增值税。 简化税制(USN)的增值税。 -
VAT_07
-7%增值税。 简化税制(USN)的增值税。 -
UNKNOWN_VALUE
-未知类型。
仅与参数结合使用 付款方法=氨纶
.
Type |
Description |
Enum: |
OrderItemDetailDTO
订单中的产品详细信息。
Name |
Description |
itemCount* |
Type: integer<int64> 积单元的数量。 |
itemStatus* |
Type: OrderItemStatusType 非购买或退货的商品:
Enum: |
updateDate* |
Type: string<date-dd-MM-yyyy> 日期格式: Example: |
OrderItemInstanceDTO
您为此职位提供的标记或故障代码。 "诚实的标志"代码以两个版本返回—有和没有密码。
Name |
Description |
cis |
Type: string 系统中的单元识别码 "诚实的标志" 没有密码或 "ASL BELGISI" (对于Yandex Go市场的卖家)。 |
cisFull |
Type: string 系统中的单元识别码 "诚实的标志" 用一个密码。 |
countryCode |
Type: string 生产国采用ISO3166-1alpha-2格式。 如何获得 Example: Min length: Max length: Pattern: |
gtd |
Type: string 货物报关。 它是由斜杠分隔的三个数字组成的字符串:XXXXXXX/XXXXXXXXX/XXXXXXXXXXX。 第一部分是登记进口货物申报的海关编码。 接下来是声明的日期和编号。 |
rnpt |
Type: string 品批次的注册号。 它是由斜杠分隔的四个数字组成的字符串:XXXXXXX/XXXXXXX/XXXXXXX/XXX。 第一部分是注册货物申报的海关办公室的代码。 接下来是日期,声明的编号以及声明中标记产品的编号。 |
uin |
Type: string 珠宝的UIN(16位数字代码) 当制造商在贵金属和宝石周转控制系统中注册产品时,他会收到UIN—GIIS DMDK。 |
OrderItemPromoDTO
有关使用促销代码,优惠券和促销活动向卖家提供商品折扣的奖励的信息。
Name |
Description |
subsidy* |
Type: number 作为促销活动的一部分销售的产品从市场上向卖方支付报酬。 |
type* |
Type: OrderPromoType Тип скидки. Enum: |
discount |
Type: number 以买方货币计算的用户折扣金额。 |
marketPromoId |
Type: string 在市场和卖方之间提供服务以促进服务的协议框架内的促销标识符。 |
shopPromoId |
Type: string 供应商促销的ID。 |
OrderItemInstanceType
产品标签类型:
-
CIS
-KIZ,系统中产品单元的标识符 "诚实的标志" 或 "ASL BELGISI" (对于Yandex Go市场的卖家)。 需要填写。 -
CIS_OPTIONAL
-KIZ,系统中产品单元的标识符 "诚实的标志". 填写是可选的,但在不久的将来需要转移。 -
UIN
-赢,一个唯一的识别号码。 -
RNPT
-RNPT,批次注册号。 -
GTD
-GTD号码,货物报关。
Type |
Description |
Enum: |
OrderItemSubsidyDTO
对产品的所有折扣给卖方的总报酬:
- 通过促销代码、优惠券和促销;
- 加分。
包括增值税。
Name |
Description |
amount* |
Type: number 补助金额。 |
type* |
Type: OrderItemSubsidyType 资助类别:
Enum: |
OrderItemTagType
产品属性:
ULTIMA
-优质产品。SAFE_TAG
-产品与 一种保护标签.TURBO
-销售迅速的产品。
Type |
Description |
Enum: |
OrderSubsidyType
资助类别:
-
YANDEX_CASHBACK
-Yandex Plus订阅折扣。 -
SUBSIDY
-Yandex的。 市场折扣(促销、促销代码、优惠券等)) -
DELIVERY
-航运折扣(DBS)。
Type |
Description |
Enum: |
GpsDTO
纬度和经度的GPS坐标。
Name |
Description |
latitude* |
Type: number 宽度。 |
longitude* |
Type: number 经度。 |
RegionType
区域的类型。
可能的值:
-
CITY_DISTRICT
-城市的面积。 -
CITY
-一个大城市。 -
CONTINENT
-大陆。 -
COUNTRY_DISTRICT
-区域。 -
COUNTRY
-国家。 -
REGION
-地区。 -
REPUBLIC_AREA
-联邦主体区。 -
REPUBLIC
-联邦的主题。 -
SUBWAY_STATION
-地铁站。 -
VILLAGE
-城市。 -
OTHER
-未知区域。
Type |
Description |
Enum: |
OrderParcelBoxDTO
有关货物位置的信息。
Name |
Description |
fulfilmentId* |
Type: string 店的信息系统中的货位的标识符。 |
id* |
Type: integer<int64> 货物位置ID。 |
OrderItemStatusType
非购买或退货的商品:
-
REJECTED
-不买。 -
RETURNED
-回来了。
Type |
Description |
Enum: |
OrderPromoType
折扣类型:
-
DIRECT_DISCOUNT
-直接折扣,这是由卖方或市场设置。 -
BLUE_SET
-工具包。 -
BLUE_FLASH
-flash促销。 -
MARKET_COUPON
-市场促销代码的折扣。 -
MARKET_PROMOCODE
-商店促销代码的折扣。 -
MARKET_BLUE
-市场上的折扣。 -
CHEAPEST_AS_GIFT
-最便宜的项目作为礼物。 -
CASHBACK
-现金返还。 -
SPREAD_DISCOUNT_COUNT
-相同商品数量的折扣。 -
SPREAD_DISCOUNT_RECEIPT
-收据金额的折扣。 -
DISCOUNT_BY_PAYMENT_TYPE
-使用Plus卡付款时的直接折扣。 -
PERCENT_DISCOUNT
-直接百分比折扣。 -
DCO_EXTRA_DISCOUNT
—从市场计算补贴所需的额外折扣。 -
UNKNOWN
-未知类型。
过时的类型:
-
GENERIC_BUNDLE
. -
MARKET_COIN
. -
PRICE_DROP_AS_YOU_SHOP
. -
SECRET_SALE
.
Type |
Description |
Enum: |
OrderItemSubsidyType
资助类别:
-
YANDEX_CASHBACK
-Yandex Plus订阅折扣。 -
SUBSIDY
-折扣市场(用于促销,促销代码,优惠券等。).
Type |
Description |
Enum: |
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
ApiErrorDTO
一般错误格式。
Name |
Description |
code* |
Type: string 的错误代码。 |
message |
Type: string 错误的描述。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK
-没有错误。ERROR
-处理请求时发生错误。
Type |
Description |
Enum: |
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
404 Not Found
找不到请求的资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
市场的内部错误。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.
Защитная метка помогает исключить подмену товара при возврате. Вернуть товар без защитной метки, которая была при покупке, не получится.