生成发货标签

通过这个API接口, 你可以直接要求Teapplix生成一个订单的发货标签, 并且把有关的信息,包括追踪号, 下载配送单PDF文件的链接,等, 用CSV方式返回给你。

接口地址
https://www.teapplix.com/h/[你的Teapplix Account Name]/ea/api.pl?User=xxxx&Passwd=xxxx

比如说:如果你的 Teapplix Account Name 叫 cybertest, 你的URL会是:

https://www.teapplix.com/h/cybertest/ea/api.pl?User=me@gmail.com&Passwd=password1234

生成发货标签
您需要用以下参数在 HTTP POST:

  • Subaction - 这个参数控制API接口做哪个工作。产生配送单, 用 "label" (不包括引号,下同)
  • shipping_profile_id - 整数, 选择哪个发货预设, 发货预设控制打印订单时采用的账户, 地址等信息。
  • provider - 哪个配送公司。 可能的值:"endicia", "stamps", "ups", "fedex", "chinapost". (DHL 用 "endicia")
  • id - 订单号。要给这个订单打印
  • ship_method - 配送方式。 这个值必须是Teapplix weigth_table 里的值
  • ship_weight - 重量,根据配送公司, 美国配送公司是盎司, 中国配送公司是克
  • dayadvance - (选项)如果你想打一个几天后可用的单,设为1就是1天后, 等
  • length, width, depth- (选项)包裹的长宽高, 英寸单位

以下是用 “curl” 写的一个范例:

curl -k -d Subaction='label' -d provider'' -d id='' -d ship_method='' -d ship_weight='' -d dayadvance='' -d length='' -d width='' -d depth='' "https://www.teapplix.com/h/[your Teapplix Account Name]/ea/api.pl&User=xxxx&Passwd=xxxx"

返回的CSV
返回的CSV有两行:
OrderId,ShipDate,ShipCarrier,ShipMethod,WeightOz,TrackingNumber,Postage,Status,URLMessage
123456,2013/09/01,USPS,FIRST/RECTPARCEL,4,9499907123456123456781,1.86,1,https://www.teapplix.com/h/teapplix/ea/api.pl?Subaction=download&b=435

返回的参数如下:

  • OrderID - 订单号
  • ShipDate - 配送单日期
  • ShipCarrier - 配送公司名称
  • ShipMethod - 配送方式
  • WeightOz - 重量
  • TrackingNumber - 追踪号
  • Postage - 邮资费用
  • Status - 配送单生成成功已否。 1为成功,0为不成功
  • URLMessage - 如果配送单成功,这个是下载PDF的URL, 如果不成功, 这是错误信息

下载PDF发货标签
Teapplix 生成发货标签的后, 您可以下载标签的 PDF 文件。

您需要用这些参数在 HTTP POST:

  • Subaction=download
  • b=435  —batch id.  这是生成订单后返回的 URL 里的b= 后面的数值。
  • clear_batch=435 — 这个参数是可选的。 这个参数的值应该和b=一样.
    如果你传了clear_batch, 那么这个batch号在Teapplix Open Orders上就不会显示为可能没打印好, 要重新打印的批次.

以下是用 “curl” 写的一个范例:

curl -k -L -o label.pdf "https://www.teapplix.com/h/[your Teapplix Account Name]/ea/api.pl?User=xxxx&Passwd=xxxx" -d Subaction=download -d b=435 -d clear_batch=435