管理api
构建应用程序
快速启动
指南
教程
建立渠道
快速启动
指南
教程
建筑店面
管理货币
指南
合作伙伴信息
成为合作伙伴
开始
POS解决方案
ERP解决方案
PIM解决方案
OMS的解决方案
营销解决方案
运输解决方案
支付解决方案

订单的概述

本文介绍BigCommerce的订单V2V3的订单REST API的伟德棋牌大全资源。订单V2公开端点创建,阅读,更新,删除订单;它还包括用于管理的端点订单出货订单发货地址V3的订单表面订单交易订单退款端点。有关通过API处理订单支付的信息,请参阅支付API概述

先决条件:

创建一个订单

创建一个订单、发送帖子请求/商店/ {{STORE_HASH}} / v2 /订单

文章https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v2 /订单X-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json{“billing_address”:{“first_name”:“简”,“last_name”:“母鹿”,“street_1”:“123大街”,“城市”:“奥斯汀”,“状态”:“德州”,“邮政编码”:“78751”,“国家”:“美国”,“country_iso2”:“我们”,“电子邮件”:“janedoe.com”},“产品”:({“名称”:“BigCommerce咖啡杯”,“数量”:1,“price_inc_tax”:50,“price_ex_tax”:45}]}

在请求运行程序中打开

请注意

  • 上面的示例包含a的最小必需字段创建订单请求。
  • 订购的产品是a自定义产品;目录中不存在自定义产品。

改变订单状态

指定订单状态通过包括status_id财产的创建订单请求。来更新的订单并改变它的状态,发送a请求/ v2 /订单/ {order_id}

将https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v2 /订单/ {order_id}X-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json{“status_id”:2}

在请求运行程序中打开

获取订单状态列表、发送得到请求/商店/ {{STORE_HASH}} / v2 / order_statuses

得到https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v2 / order_statusesX-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json

在请求运行程序中打开

回应:

({“id”:0,“名称”:“不完整”,“system_label”:“不完整”,“custom_label”:“不完整——测试”,“system_description”:当购物者到达付款页面但没有完成交易时,就会发生不完整的订单。,“秩序”:0},]

请注意

  • 如果不指定,status_id默认为1
  • 退款状态既没有支付也没有支付。
  • 有关更改custom_label在控制面板中,可以看到订单状态

指定的订单客户

指定客户包括一个customer_id创建订单请求。

文章https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v2 /订单X-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json{“customer_id”:1,“billing_address”:{},“产品”:(]}

在请求运行程序中打开

获取客户列表、发送得到请求/商店/ {{STORE_HASH}} / v3 /客户

得到https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v3 /客户X-Auth-Token:{{ACCESS_TOKEN}}接受:application / json

在请求运行程序中打开

请注意

  • customer_id0创建客人订单。

包括航运地址

添加航运地址包括一个shipping_address数组创建订单请求。

文章https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v2 /订单X-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json{“billing_address”:{},“shipping_addresses”:({“first_name”:“生锈”,“last_name”:“盖茨”,“公司”:“有限责任公司”,“street_1”:“123例ST”,“street_2”:”“,“城市”:“奥斯汀”,“状态”:“德州”,“邮政编码”:“12345”,“国家”:“美国”,“country_iso2”:“我们”,“电话”:“5128675309”,“电子邮件”:“rusty.gates@example.com”}],“产品”:(]}

在请求运行程序中打开

请注意

添加产品

指定目录上的产品包括一个产品数组创建订单请求。

文章https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v2 /订单X-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json{“billing_address”:{},“产品”:({“名称”:“BigCommerce咖啡杯”,#定制产品“数量”:1,“price_inc_tax”:50,“price_ex_tax”:45},{“product_id”:184,#产品目录“数量”:1,“product_options”:({“id”:200,“价值”:“180”},{“id”:230,“价值”:“192”}]}]}

在请求运行程序中打开

得到product_options.idproduct_options.value订购产品的价格产品数组,发送一个得到请求/商店/ {{STORE_HASH}} / v3 /目录/产品/ {product_id} /变体

得到https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v3 /目录/产品/ {product_id} /变体X-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json

在请求运行程序中打开

回应:

{“数据”:({“id”:421,“product_id”:184,“option_values”:({“id”:180,/ / product_options.value“标签”:“红色”,“option_id”:200,/ / product_options.id“option_display_name”:“颜色”},{“id”:192,“标签”:“小”,“option_id”:230,“option_display_name”:”t恤尺寸”}]}]}

请注意

  • 定制产品不会添加到目录中。
  • 如果产品的价格没有注明创建订单请求时,bigcommerce的定价服务通过应用适用的货币转换和计算价格定价操作(如价格列表客户群体的折扣)对产品的目录价格;使用price_inc_taxprice_ex_tax来推翻计算好的价格。
  • 市场推广目前不适用于通过订单API创建的订单。
  • 如果你覆盖price_ex_taxprice_inc_tax,覆盖;否则,订单总数将不能正确计算。
  • 压倒一切的price_inc_taxprice_ex_tax不改变不同的定价。

创建订单出货

一旦订单有了产品、账单地址和发货地址,就可以创建订单发货。

创建订单发货、发送帖子请求/商店/ {{STORE_HASH}} / v2 /订单/ {{order_id}} /出货

文章https://api.bigcommerce.com/stores/ {{STORE_HASH}}} / v2 /订单/ {{order_id}} /出货X-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json“tracking_number”:“EJ958083578UK”,“评论”:“琼斯秩序”,“order_address_id”:“128”,“shipping_provider”:”“,“项目”:({“order_product_id”:194,“数量”:1},{“order_product_id”:195,“数量”:1}]}

在请求运行程序中打开

财产 描述
tracking_number 航运供应商跟踪号;用于生成跟踪链接
评论 可选的评论
order_address_id 获得通过获取订单发货地址
shipping_provider 可选的;用于创建跟踪链接;看到创建订单装运对于接受的值
items.order_product_id 获得通过得到订购产品

请注意

  • 通过在每个发货中指定产品和数量的子集来创建多个发货帖子请求。
  • 创建订单发货触发电子邮件通知;调整订单通知设置在控制面板改变这种行为。
  • 删除一个货物就可以了把订单移出去的地位。

运送到多个地点

您可以为订单创建多个配送,每个配送可以有不同的order_address_id

文章https://api.bigcommerce.com/stores/ {{STORE_HASH}}} / v2 /订单/ {{order_id}} /出货X-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json{“order_address_id”:“123”,“shipping_provider”:“美国邮政总局”,“项目”:({“order_product_id”:2,“数量”:1}]}
文章https://api.bigcommerce.com/stores/ {{STORE_HASH}}} / v2 /订单/ {{order_id}} /出货X-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json{“order_address_id”:“456”,“shipping_provider”:”“,“项目”:({“order_product_id”:5,“数量”:1}]}

在请求运行程序中打开

财产 描述
order_address_id 获得通过获取订单发货地址
shipping_provider 可选的;用于创建跟踪链接;看到创建订单装运对于接受的值
items.order_product_id 获得通过得到订购产品

得到航运报价

得到航运报价、发送得到请求/ v2 /订单/ {order_id} / shipping_addresses / {shipping_address_id} / shipping_quotes

得到https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v2 /订单/ {order_id} / shipping_addresses / {shipping_address_id} / shipping_quotesX-Auth-Token:{{ACCESS_TOKEN}}接受:application / json

在请求运行程序中打开

回应:

{“id”:“16”,“uuid”:“18 aaa5eb-3c7a-4bf8-bfaa-d14d155606f1”,“时间戳”:“周一,2018年7月30日15:32:35 +0000”,“shipping_provider_id”:“bcproductbased”,“shipping_provider_quote”:(],“provider_code”:“productfixedshipping”,“carrier_code”:”“,“rate_code”:”“,“rate_id”:”“}

不支持通过运输承运人生成报价。您可以在创建订单运输时指定运输承运人。可以在其他地方生成报价,然后更新shipping_cost_ex_taxshipping_cost_inc_tax为了确保订单总数正确。

得到订单税

得到订单税、发送得到请求/商店/ {{STORE_HASH}} / v2 /订单/ {order_id} /税

得到https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v2 /订单/ {order_id} /税X-Auth-Token:{{ACCESS_TOKEN}}接受:application / json

在请求运行程序中打开

回应:

({“id”:13,“order_id”:138,“order_address_id”:39,“tax_rate_id”:1,“tax_class_id”:0,“名称”:“税”,“类”:“默认税收类”,“速度”:“8.0000”,“优先”:0,“priority_amount”:“17.6400”,“line_amount”:“17.6400”}]

响应的税收对象顺序的名字属性设置为API税收覆盖当产生的第三方税务服务,如Avalara溢价

({“id”:13,“order_id”:138,“order_address_id”:39,“tax_rate_id”:1,“tax_class_id”:0,“名称”:“API税收覆盖”,}]

当订单从an转移时,BigCommerce会向Avalara提交税务文件无薪状态,支付当订单从a转移时,身份和无效的税务文件支付状态到一个没有报酬的状态。

现有的状态 状态通过 合状态 提交税务文件
任何 没有一个 等待 没有一个
支付或退还 支付 支付 没有一个
无薪或退还 无薪 无薪 没有一个
支付或退还 无薪 无薪 税收文件无效
无薪或退还 支付 支付 税收文档提交

请注意

  • 缩写的州名(例如:CA而不是加州),会导致提交税务文件失败。
  • 可以使用商店中指定的规则计算税款,除非自动的税收启用。
  • 您可以通过指定来替代税收值price_inc_taxprice_ex_tax在一个更新订单请求
  • 如果商店有自动的税收启用该功能后,BigCommerce不会计算通过API创建的订单的销售税。

得到订单交易

得到订单交易、发送得到请求/商店/ {{STORE_HASH}} / v3 /订单/ {order_id} /交易

得到https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v3 /订单/ {order_id} /交易X-Auth-Token:{{ACCESS_TOKEN}}接受:application / json

在请求运行程序中打开

回应:

{“数据”:({“id”:85926313,“order_id”:“121”,“事件”:“购买”,“方法”:“强奸犯”,“数量”:1,“货币”:“美元”,“网关”:“squarev2”,“gateway_transaction_id”:“pN5Kd7R9ilEI2ygBawCy7tMF | qwnAFAxRZ7tYRtIpZULg1yMF”,“状态”:“ok”,“测试”:,“fraud_review”:,“reference_transaction_id”:{},“date_created”:“2018 - 05 - 08 - t15:06:12 + 00:00”,“avs_result”:{},“cvv_result”:{},“credit_card”:{},“gift_certificate”:{},“store_credit”:{},“离线”:{},“自定义”:{},“payment_instrument_token”:{},“payment_method_id”:“squarev2.card”}],“元”:{}}

请注意

  • 并不是所有的支付网关都返回完整的卡或欺诈细节。根据不同的支付方式,将提供不同的信息。
  • 您不能为下列付款方式创建交易:
    • 测试支付网关
    • 贝宝表示
    • 亚马逊支付

处理退款

V3的订单公开要管理的端点订单退款。有关使用这些端点的概述,请参见API文档中的订单退款

计算总数

订单小计总计自动计算;对以下属性的编辑将触发重新计算。

财产 类型 描述
产品 数组(obj) 用于计算航运、税收和小计
shipping_cost_ex_tax 浮动 运费,不含税
shipping_cost_inc_tax 浮动 运费,含税
handling_cost_ex_tax 浮动 处理成本的价值,不含税
handling_cost_inc_tax 浮动 处理成本的价值,包括税金
wrapping_cost_ex_tax 浮动 包装成本的价值,不含税
wrapping_cost_inc_tax 浮动 包装成本的价值,包括税收
billing_address obj 用于计算航运和税收
shipping_addresses 数组(obj) 用于计算航运和税收

通过在请求中发送一个固定的值,可以覆盖产品价格、小计和总数等计算值。如果不为这些属性提供值,则将根据预设的存储值和税务规则自动计算它们。

请注意

  • 如果你覆盖小计总计,覆盖;系统将不会重新计算其他。
  • 若要添加手动折扣,请覆盖产品价格或discount_amount

常见问题解答

可以添加优惠券吗?

无法兑换优惠券。你不能写信给coupon_discount字段。可以为订单添加折扣discount_amount

如何为客人创建订单?

要指定客人结帐,请设置customer_id为0。

如何设置订单来源?

您不能指定order_source;它的价值是外在的。可以选择指定的值external_source定义订单的外部来源,例如POS系统X,会计系统Y,等等。

我可以只创建定制产品的订单吗?

是的,商店的目录不包括产品。

country_ISO2和country的区别是什么?

指定时不需要指定国家country_ISO2在运输和结算地址,反之亦然。

我如何接受订单付款?

您可以通过第三方或使用控制面板进行支付。

我可以使用API从承运人生成运输报价吗?

现在不行。如果您在控制面板或通过API创建订单,它将在尝试获取运输报价时返回204。

相关资源伟德棋牌大全

文章

端点

人则