使是

购买,销售和发货买方或卖方的订单。

看一看 在C#,Java,Python和Ruby中的一些示例。

使徒输入

Getorders是一种安全的API方法,具有以下URL和HTTP标头要求:

提交给URL: //api.sanyili.com/api_requests/secure_request
HTTP标题中需要: x-bonanzle-api-dev-name设置为dev_id
  x-bonanzle-api-cert-name设置为您的cert_id

请注意,除此之外的所有安全方法 fetchtoken.GetboothItems. 要求您提交用户令牌,以便我们知道您代表的用户帐户。 有关设置和提交用户令牌的详细信息,请参阅我们的 介绍用户令牌.

您请求的名称应该是 GetOrderSrequest..

以下是可用的输入参数 序列化为json.:

争论 类型 发生 意义
请求幸置性 容器 必需的 用于用户凭据的容器
请求幸置性 .bolanzleauthtoken. 细绳 必需的 验证 用户令牌 对于您代表行事的用户。
呼叫特定的输入字段
createTimefrom. 约会时间 选修的 createTimefrom和createTimeto字段指定检索订单的日期范围。 createTimefrom字段是启动日期范围。在此日期范围内创建的所有Bonanza订单都在输出中返回。如果请求中传递一个或多个订单ID,则此字段不适用。
createTimeto. 约会时间 选修的 createTimefrom和createTimeto字段指定检索订单的日期范围。 CreateTimeto字段是终止日期范围。在此日期范围内创建的所有Bonanza订单都在输出中返回。如果请求中传递一个或多个订单ID,则此字段不适用。
modtimefrom. 约会时间 选修的 modtimefrom和modtimeto字段指定检索订单的日期范围。 modtimefrom字段是启动日期范围。在此日期范围内修改的所有Bonanza订单都在输出中返回。如果请求中传递一个或多个订单ID,则此字段不适用。
modtimeto. 约会时间 选修的 modtimefrom和modtimeto字段指定检索订单的日期范围。 modtimeto字段是结束日期范围。在此日期范围内修改的所有Bonanza订单都在输出中返回。如果请求中传递一个或多个订单ID,则此字段不适用。
OrderIdarray. 整数数组 选修的 用于抓住特定订单ID的阵列的容器。

ortrolole.
细绳 选修的 指定谁返回订单:
  • 买方:“买方”的价值返回此用户是买方的所有订单。
  • 卖方:“卖方”的价值返回此用户是卖家的所有订单。
订单状态 歌舞术 选修的

订单的状态。可能的值包括

  • 积极的:订单在购物车中,尚未被检查过
  • 取消:订单被取消
  • 完全的:售出订单(付款已成功处理)但尚未标记为发货。这包括发票和接受的优惠。
  • 不完整:提供的收到收到错误处理
  • inprocess.:订单已被买方签出,我们正在等待付款处理器的付款验证
  • 驾驶:卖家已向买方发送发票,以便为售出提供,提供买方付款
  • 建议的:提供的提议由买方提出,正在等待接受
  • 发货:订单已被标记为已发货
SoldtimeFrom. 约会时间 选修的 SoldtimeFrom和SoldTimeto字段指定了检索订单的日期范围。 SoldtimeFrom字段是起始日期范围。在此日期范围内销售的所有Bonanza订单都在输出中返回。如果请求中传递一个或多个订单ID,则此字段不适用。
Soldtimeto. 约会时间 选修的 SoldtimeFrom和SoldTimeto字段指定了检索订单的日期范围。 Soldtimeto字段是结束日期范围。在此日期范围内销售的所有Bonanza订单都在输出中返回。如果请求中传递一个或多个订单ID,则此字段不适用。
PaginationInpul. 容器 Optional 控制结果集的分页。子元素指定每个呼叫返回的最大项目列表数量和数据页面返回。控制响应中返回的列表数量,但未指定为每个列表返回的详细信息。

笔记: 对于给定的搜索,无论找到多种匹配,都无法检索超过10,000个项目。该限制由允许的最大页码(100)和允许的最大条目强制执行(100)。
paginationInput.entriesperpage. int Optional 指定单个呼叫中返回的最大条目数。如果指定的pageNumber上的条目数小于此处指定的值,则返回的项目数将小于entriessperpage的值。这表示结果集的结尾。

如果entriessperpage设置为大于100的数字,则将使用默认值100。
最大限度: 100. 默认: 100.
paginationInput.Pagenumber. int Optional 指定要在呼叫响应中返回的数据(或“页面”)的子集。数据页数由匹配请求搜索条件(在PaginationOutput.Totalentries中返回的项目的总数决定)除以每个响应中显示的条目数(entriesperpage)。您可以通过发出多个请求并按顺序指定要返回的页面来返回结果集的前100页。
最大限度: 100. 默认: 1.

 

销售商输出

从此请求返回的输出的名称是GetOrdersResponse。因此,在将序列化响应解析为JSON之后,您可以使用类似的东西访问数据 my_json_hash ['getordersresponse']

以下是所有可能的输出参数:

 

争论 类型 发生 意义
标准输出字段
错误信息 容器 Conditionally 当Bonanza处理请求时发生错误或警告的描述。如果ACK值为成功,则不返回。
errorMessage.错误 容器 Conditionally,
repeatable: [0..*]
errorMessage.error.类别 ErrorCategory Conditionally Currently unused.
errorMessage.error.信息 string Conditionally 错误描述
errorMessage.error.类型 纠刊 Conditionally 错误的唯一描述性名称。
时间戳 约会时间 总是 该值表示Bonanza处理请求的日期和时间。此值的时区为GMT,格式为ISO 8601日期和时间格式(YYYY-MM-DDTHH:MM:SS.SSZ)。有关此时间格式和转换为GMT时区的信息,请参阅“DateTime”类型。
警告 容器 Conditionally 当Bonanza处理请求时发生的警告说明。
warnings.未识别的_分数 容器 Conditionally,
repeatable: [0..*]
一个无法识别的参数数组。
呼叫特定的输出字段
hasmoreorders. 布尔基 总是 如果存在超过此处返回的订单,则返回true,如果不是,则为false。
PaginationResult 容器 有条件的 表示结果集的分页。子元素表示返回的页码,每页返回的最大项目列表数,可以返回的总页数以及与搜索条件匹配的列表总数。
PaginationResult。TotalNumberofentries. 有条件的 发现的项目总数与您的请求中的搜索条件匹配。根据intriesperpage的输入值,响应可能仅包括整个结果集的一部分(a页)。如果BONANZA没有找到与搜索条件匹配的任何项目,则返回“0”的值。
PaginationResult。TotalNumberofpages. 有条件的 重复搜索请求可以返回的数据总数。请注意,如果在请求中修改InputPagimination.entriesPage的值,则总页数的值输出将会更改。如果BONANZA没有找到与搜索条件匹配的任何项目,则返回“0”的值。
Pagenumber. 有条件的 在当前响应中返回的项目数据的子集。搜索结果分为套装或项目数据的“页面”。页数等于与搜索条件匹配的项目总数除以要求在请求中为entriberPage指定的值。对请求的响应包含项目数据的一个“页面”。此返回值表示返回的项目数据(完整结果集的子集)。如果此字段包含1,则响应包含项目数据的第一页(默认值)。如果在rotentries中返回的值小于entriesperpage的值,则pagenumber返回1,响应包含整个结果集。 pagenumber的值通常等于paginationInput.pagenumber的值输入。但是,如果PageNumber的数字输入大于输出总可能的页面,则Bonanza返回结果集中的项目数据的最后一页,并且PageNumber的值设置为相应的(最后)页码。
orterarray. 容器 总是 返回订单数组的容器。
OrderArray。命令 容器 总是 用于个人订单的容器。
OrderArray.Order。
支付的金额
金额(双) 总是 订单的最终价格。
OrderArray.Order。
金额落实
金额(双) 总是 适用于此订单的所有折扣(运输和项目)的总和。
OrderArray.Order。
买方买卖
细绳 总是 从买方到卖方在结账时提供的消息。
OrderArray.Order。
BuyeRuserid.
整数 总是

Bonanza为买方的唯一用户身份证。

OrderArray.Order。
买方Username.
细绳 总是

Bonanza买方的用户名。

OrderArray.Order。
checkoutstatus.
容器 总是 容器有关结帐状态的详细信息。
OrderArray.Order。
checkoutStatus.
状态
细绳 总是 结账时序的状态。可能的值包括:
  • 完全的:结帐完成此订单
  • 不完整:订单尚未通过结账,或者订单除了上面的两个之外还有其他状态。
  • inprocess.:卖家已完成结账,我们目前正在等待处理器的付款信息。
  • 驾驶:卖家已接受提供优惠,发票买家和结账正在等待买方采取行动。
  • 待办的: 
OrderArray.Order。
创造时间
约会时间 总是 订单创建的时间。
OrderArray.Order。
创造errole.
细绳 总是 此订单是由买方或卖方发起的。可能的值包括:
  • 买方:此订单由买方发起
  • 卖方:此订单由卖方启动(即,作为对比)
OrderArray.Order。
Itemarray.
容器 总是 数组根据订单提供有关项目的详细信息。
OrderArray.Order。
itemArray.
物品
容器 总是 有关单个项目的详细信息。
OrderArray.Order。
itemArray.
item.
物品id.
整数 总是 Bonanza的这个项目的唯一身份证。对于多数量项目,此项目表示历史快照。
OrderArray.Order。
itemArray.
item.
闺头emid
整数 条件 销售多数量项目时,会创建重复的历史项目。 ParentItemid是原始(非历史)项目的ID。
OrderArray.Order。
itemArray.
item.
eBayid
整数 选修的 此项目的独特eBay ID。
OrderArray.Order。
itemArray.
item.
MPN.
细绳 选修的 如果指定,则此项目的MPN。
OrderArray.Order。
itemArray.
个性化文本
容器 选修的 有关单个项目的详细信息。
OrderArray.Order。
itemArray.
item.
personalizedText.
标签
细绳 总是 此项目个性化字段的标签。
OrderArray.Order。
itemArray.
item.
personalizedText.
身体
细绳 总是 此个性化字段的买方提供的文本。
OrderArray.Order。
itemArray.
item.
价格
金额(双) 总是 此项目的每个项目的价格。
OrderArray.Order。
itemArray.
item.
斯太基ventoryid
整数 总是 卖方为此项目提供的SKU。
OrderArray.Order。
itemArray.
item.
thumbnailurl.
细绳 总是 项目图像缩略图的URL。
OrderArray.Order。
itemArray.
item.
数量
整数 总是 此订单中包含此项目的数量。
OrderArray.Order。
itemArray.
item.
标题
细绳 总是 此项目的标题。
OrderArray.Order。
itemArray.
item.
变化
容器 选修的 物品变体的容器
OrderArray.Order。
itemArray.
item.
variations.
变化
逐项,可选地[0 .. *] 选修的 有关此项目所选变化的详细信息
OrderArray.Order。
itemArray.
item.
variations.
variation.
姓名valuelist.
名称valuelist容器,可选择[0 .. *] 选修的 项目变体的一个或多个名称/值对的容器
OrderArray.Order。
itemArray.
item.
variations.
variation.
nameValueList.
姓名
细绳 选修的 被指定的属性的名称,即“size”。从getCategorytraits收集。
OrderArray.Order。
itemArray.
item.
variations.
variation.
nameValueList.
价值
细绳 选修的 “名称”称为“名称”的属性值。例如,如果名称为“尺寸”值可能是“L”。可以从getCategorytraits中收集潜在值。
OrderArray.Order。
itemArray.
item.
variations.
variation.
斯科
细绳 选修的 SKU的变化。
OrderArray.Order。
命令id.
整数 总是 Bonanza为此订单的唯一数字标识符
OrderArray.Order。
订单状态
歌舞术 总是

订单的状态。可能的值包括

  • 积极的:订单在购物车中,尚未被检查过
  • 取消:订单被取消
  • 完全的:订单已售出(付款已成功处理)但尚未标记为已发货
  • 不完整:提供的收到收到错误处理
  • inprocess.:订单已被买方签出,我们正在等待付款处理器的付款验证
  • 驾驶:卖家已向买方发送发票,以便为售出提供,提供买方付款
  • 建议的:提供的提议由买方提出,正在等待接受
  • 发货:订单已被标记为已发货
OrderArray.Order。
薪水时间
约会时间 总是 此订单已支付的时间(如适用)。
OrderArray.Order。
收件地址
容器 有条件的 有关运输目的地的详细信息。未取消的订单不存在。
OrderArray.Order。
shippingAddress.
地址
整数 总是 Bonanza这个送货地址的唯一标识符
OrderArray.Order。
shippingAddress.
城市名
细绳 总是 城市的名称发货
OrderArray.Order。
shippingAddress.
国家
细绳 总是 被运往国家的两个字母代码
OrderArray.Order。
shippingAddress.
国家的名字
细绳 总是 该国的全名被运送到
OrderArray.Order。
shippingAddress.
姓名
细绳 总是 被运送的人的全名
OrderArray.Order。
shippingAddress.
邮政编码
细绳 总是 发货目的地的邮政编码
OrderArray.Order。
shippingAddress.
伦敦
细绳 总是 州或省运目的地
OrderArray.Order。
shippingAddress.
Street1.
细绳 总是 发货目的地的第一行街道地址
OrderArray.Order。
shippingAddress.
街2
细绳 总是 发货目的地的街道地址的第二行
OrderArray.Order。
送货细节
容器 总是 容器有关订单运输的详细信息
OrderArray.Order。
shippingDetails.
数量
金额(双) 总是 按此订单运输的金额。
OrderArray.Order。
shippingDetails.
保险费
金额(双) 总是 如果适用,则在此订单上收取运输保险金额。
OrderArray.Order。
shippingDetails.
笔记
细绳 总是 留给买方的笔记
OrderArray.Order。
shippingDetails.
服务阵列
串数量 总是 所有运输服务卖方为此订单中包含的物品提供。
OrderArray.Order。
shippingDetails.
Shippingservice.
细绳 总是 有关为项目指定的送货服务的任何可用详细信息。未指定运输的默认值为“标准运输”。如果买方选择了更具体的送货选择(例如,“USPS Express Mail(1个工作日)”)将提供。

OrderArray.Order。
shippingDetails.
shipling trackingnumber.

容器 总是 将将项目ID映射到装运追踪号码的容器(S)

OrderArray.Order。
shippingDetails.
shippledrackingnumber。
物品id.

容器 选修的 列出订单中此项目提交的所有跟踪ID

OrderArray.Order。
shippingDetails.
shippledrackingnumber。
ItemId.
跟踪号码

字符串,可选地[0 .. *] 选修的 跟踪卖方提供的代码 完成 或销售仪表板
OrderArray.Order。
发货Time.
约会时间 总是 订单发货的时间(如适用)。
OrderArray.Order。
小计
金额(双) 总是 税前,运费和折扣前的订单金额
OrderArray.Order。
税额
金额(双) 有条件的 订单收取的税款金额
OrderArray.Order。
电话号码
细绳 总是 买方的电话号码
OrderArray.Order。
全部的
金额(双) 总是 税后,运费和折扣后的订单金额
OrderArray.Order。
货币代码
细绳 总是 用于购买的货币代码
OrderArray.Order。
TransactionArray.
容器 总是 有关此交易的详细信息数组
OrderArray.Order。
transactionArray.
交易
容器 总是 有关此交易的详细信息
OrderArray.Order。
transactionArray.
transaction.
买方
容器 总是 容器有关此交易中买方的详细信息
OrderArray.Order。
transactionArray.
transaction.
FinalValueFee.
金额(双) 总是 本订单的总费用为卖方
OrderArray.Order。
transactionArray.
transaction.
提供服务名称
细绳 总是 交易服务提供商名称,之一:
  • PayPal.
  • 亚马逊结账
  • 谷歌结账
  • 汇票
  • 礼物卡
OrderArray.Order。
transactionArray.
transaction.
Providerid.
细绳 总是 交易服务提供商的此交易的ID

使徒例子