API Reference

Order

字段类型描述是否必填
idstring订单唯一idY
customer_idstring顾客IdY
namestring订单的唯一编号Y
emailstring邮箱Y
phonestring手机号码N
country_codestring国家二代码N
cart_tokenstring引用与购物车时关联的的唯一值N
checkout_tokenstring引用与结帐时关联的的唯一值N
order_statusstring订单状态:
PENDING 待处理
PAID 已支付
PARTIALLY_PAID 部分支付
PARTIALLY_REFUNDED 部分退款
REFUNDED 退款
CANCELLED 订单取消
FAILED失败
Y
fulfillment_statusstring订单配送状态:
FULFILLED 已发货
PARTIAL 部分完成
UNFULFILLED 未完成
RESTOCKED 取消
FINISHED 发货完成
N
shipping_addressobjectAddress 对象N
billing_addressobjectAddress 对象N
line_itemsarrayLine_items对象Y
order_status_urlstring指向订单状态网页的 URL (未结账或者已结账的页面)N
currencystring币种因为缩写如 USDY
total_discountstring订单折扣总金额N
subtotal_pricestring小计N
total_shippingstring运费N
total_taxstring税费N
total_pricestring订单总价格Y
payment_methodstring支付方式N
payment_atnumber支付时间11位时间戳精确到秒,我们系统所有显示订单时间的地方使用的是支付时间N
shipping_methodstring运输方式N
updated_atnumber更新时间11位时间戳精确到秒Y
created_atnumber创建时间11位时间戳精确到秒Y

Address

字段类型描述是否必填
first_namestringFIrst nameN
last_namestringLast nameN
phonestring手机号码N
country_codestring国家二代代码N
country_namestring国家名称N
province_codestring洲/省编码N
provincestring洲/省N
citystring城市N
zipstring邮编N
address1string详细地址1N
address2string详细地址2N

Line_items

字段类型描述是否必填
idstring订单项目唯一idY
srcstring产品变体图片Y
namestring产品变体的名称Y
skustring产品变体的SKU编号Y
variant_titlestring产品变体的标题Y
variant_idstring产品变体唯一idY
quantityinteger购买数量Y
line_pricestring单价Y
titlestring产品的标题Y
product_idstring产品idY
product_urlstring产品urlY
fulfillment_statusstring发货状态N
tracking_companystring货运公司N
tracking_numberstring快递单号N