Getbooth.
检索有关给定卖家展位的信息。
GetBooth输入
Getboothis具有以下URL和HTTP标头要求的非安全请求:
提交给URL: | //api.sanyili.com/api_requests/standard_request |
HTTP标题中需要: | x-bonanzle-api-dev-name设置为dev_id |
您请求的名称应该是 getboothrequest .
因此,例如,这里是Ruby代码提交您的请求:
require "json" require "net/http" # Open connection to api.bonanza.com over port 443 http = Net::HTTP.new("api.bonanza.com", 443) http.use_ssl = true http.post( "/api_requests/standard_request", # The path we're posting to "getboothrequest =your_serialized_JSON_data", # The data being posted { 'X-BONANZLE-API-DEV-NAME' => 'abcdef123456' } # The HTTP header, which gives your dev_id )
以下是可用的输入参数 序列化为json.:
争论 | 类型 | 发生 | 意义 |
---|---|---|---|
呼叫特定的输入字段 | |||
Boothid. | 细绳 | 选修的 | 这 URL标识符 或给定展位的id。 请参见下面的注意事项。 |
storeid. | 细绳 | 选修的 | Boothid的假名。 请参见下面的注意事项。 |
用户身份 | 细绳 | 选修的 | Boothid的假名。有效,因为逃逸的用户名相当于展位的 URL标识符 . 请参见下面的注意事项。 |
 | 笔记: 上述参数(BoOtnID,StoreID或UserID)中的一个必须传递给GetBooth |
Getbooth输出
从此请求返回的输出的名称是GetBoothresponse。因此,在将序列化响应解析为JSON之后,您可以使用类似的东西访问数据:
my_json_hash[' Getbooth. Response']
以下是所有可能的输出参数:
争论 | 类型 | 发生 | 意义 |
---|---|---|---|
标准输出字段 | |||
错误信息 | 容器 | 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..*] |
一个无法识别的参数数组。 |
呼叫特定的输出字段 | |||
店铺 | 容器 | 总是 | 用于更详细的展位信息的集装箱 |
店铺。 custom类别 | 大批 | 有条件的, 可重复: [0..*] |
此列表是一系列自定义类别,如卖家所指定的,以对其摊位进行分类。 |
店铺。 customcategory。 compouttsid. | ㈡ | 条件 | 此自定义类别的唯一ID。 |
店铺。 customcategory。 姓名 | 细绳 | 条件 | 名称给定自定义类别。 |
店铺。 customcategory。 命令 | ㈡ | 条件 | 定制类别列表中的位置。 |
店铺。 活性 | 布尔基 | 总是 | 如果展位已被激活,则为true。只有激活的展位可以将物品添加到它们中 |
店铺。 描述 | 细绳 | 总是 | 卖方的展位的描述。 最大字符: 1024 |
店铺。 标识 | 奥里瑞 | 总是 | 对展位的图像横幅的路径。 |
店铺。 姓名 | 细绳 | 总是 | 展位的标题。 最大字符: 35 |
店铺。 假期中 | 布尔基 | 总是 | 展位目前是否正在度假。 |
店铺。 政策 | 细绳 | 总是 | 卖方对展位的政策描述,可选择有关退货政策和合并运费折扣的信息。 最大字符: 60000 |
店铺。 SubscriptionLevel. | ㈡ | 总是 | 卖方在Bonanza的订阅级别。
|
店铺。 混合 | 布尔基 | 总是 | 如果展位已注册Bonanza的混合卖方计划,则为真,这使得卖方指定要支付给关联公司的佣金。 |
店铺。 URL. | 奥里瑞 | 总是 | 展位的完整URL。 |