订单的概述

本文介绍了BigCommerce的订单v2.和订单v3休息API资源。订单v2.公开端点创建那阅读那更新， 和删除命令;它还包括用于管理的端点订单出货量和订单发货地址。订单v3表面订购交易和订单退款端点。有关通过API处理订单支付的信息，请参见付款API概述。

先决条件:

• 一个bigcommerce商店
• 访问令牌API身份验证用下面的范围：
  • 命令 -调整
  • 产品 -读
• 产品和变体。

创建订单

来创建一个订单， 寄一个邮政请求/ stores / {{store_hash}} / v2 /订单。

post https://api.bigcommerce.com/store/ {store_hash}命中} }/v2/ orders.X-auth-token：{{access_token}}内容类型：application / json接受：application / json{“帐单地址”：{“first_name”：“简”那“姓”：“母鹿”那“street_1”：“123主街”那“城市”：“奥斯汀”那“状态”：“德克萨斯州”那“邮政编码”：“78751”那“国家”：“美国”那“country_iso2”：“我们”那“电子邮件”：“Janedoe@email.com”}那“产品”：[{“名称”：“Bigcommerce咖啡杯”那“数量”：1那“price_inc_tax”：50那“price_ex_tax”：45}]}

更改订单状态

指定订单状态包括包括status_id.物业在创建订单请求。来更新的订单并改变其状态，发送一个把请求/ v2 / orders / {server_id}。

将https://api.bigcommerce.com/store/ {store_hash}} }/v2/orders/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_Statuses.X-auth-token：{{access_token}}内容类型：application / json接受：application / json

回复：

[{“id”：0.那“名称”：“不完整”那“system_label”：“不完整”那“custom_label”：“不完整 - 测试”那“系统描述”：“当购物者到达付款页面时，会发生不完整的顺序，但没有完成交易。”那“秩序”：0.}那…]

指定订单客户

指定顾客包括A.customer_id在里面创建订单请求。

post https://api.bigcommerce.com/store/ {store_hash}命中} }/v2/ orders.X-auth-token：{{access_token}}内容类型：application / json接受：application / json{“客户ID”：1那“帐单地址”：{…}那“产品”：[…]}

来获取客户列表， 寄一个得到请求/商店/ {{store_hash}} / v3 /客户。

得到https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v3 /客户X-auth-token：{{access_token}}接受：application / json

包括送货地址

添加运输地址包括A.送货地址大批在里面创建订单请求。

post https://api.bigcommerce.com/store/ {store_hash}命中} }/v2/ orders.X-auth-token：{{access_token}}内容类型：application / json接受：application / json{“帐单地址”：{…}那“shipping_addresses”：[{“first_name”：“生锈”那“姓”：“盖茨”那“公司”：“示例llc”那“street_1”：“123例ST”那“street_2”：“那“城市”：“奥斯汀”那“状态”：“德克萨斯州”那“邮政编码”：“12345”那“国家”：“美国”那“country_iso2”：“我们”那“电话”：“5128675309”那“电子邮件”：“Rusty.gates@example.com”}]那“产品”：[…]}

添加产品

指定目录的产品包括A.产品大批在里面创建订单请求。

post https://api.bigcommerce.com/store/ {store_hash}命中} }/v2/ orders.X-auth-token：{{access_token}}内容类型：application / json接受：application / json{“帐单地址”：{…}那“产品”：[{“名称”：“Bigcommerce咖啡杯”那＃自定义产品“数量”：1那“price_inc_tax”：50那“price_ex_tax”：45}那{“product_id”：184那#产品从目录“数量”：1那“product_options”：[{“id”：200.那“价值”：“180”}那{“id”：230那“价值”：“192”}]}]}

得到这一点product_options.id和product_options.Value.订单的产品产品数组，发送一个得到请求/存储/ {{store_hash}} / v3 /目录/产品/ {product_id} / variants。

得到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恤尺寸”}]}…]}

创建订单货物

订单有产品，计费地址和送货地址，您可以创建订单发货。

来创建一个订单发货， 寄一个邮政请求/商店/ {{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}]}

财产	描述
追踪号码	运输提供商跟踪号码;用于生成跟踪链接
注释	可选评论
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”：“USPS”那“项目”：[{“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 / orders / {server_id} / shipping_addresses / {shinking_address_id} / shipping_quotes。

获取https://api.bigcommerce.com/store/ {store_hash}} }/v2/orders/（orderess/X-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”：“BcProduct基本”那“shipping_provider_quote”：[]那“Provider_code”：“ProductFixEdShipping”那“carrier_code”：“那“rate_code”：“那“rate_id”：“}

不支持通过船运公司生成报价。您可以在创建订单发货时指定发货承运人。您可以在其他地方生成引用，然后更新shipping_cost_ex_tax.和shipping_cost_inc_tax.订单总数是正确的。

获得订单税

来得到订单税， 寄一个得到请求/商店/ {{STORE_HASH}} / v2 /订单/ {order_id} /税。

获取https://api.bigcommerce.com/stores/ {store_hash}} }/v2/orders/（order_id）/ staxes.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税收覆盖”那…}]

当订单从中移动时，BIGCommerce向Avalara提交税务文件未付到A的状态支付订单从a移动时状态和空白税务文件支付状态到无偿的状态。

现有状态	状态通过	结果状态	提交Avalara税务文件
任何	没有一个	待办的	没有一个
支付或退款	支付	支付	没有一个
无薪或退款	无薪	无薪	没有一个
支付或退款	无薪	无薪	税务文件无效
无薪或退款	支付	支付	提交税务文件

获取订单交易

来得到订单交易， 寄一个得到请求/商店/ {{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”那“事件”：“购买”那“方法”：“omce”那“数量”：1那“货币”：“美元”那“网关”：“squarev2”那“gateway_transaction_id”：“pn5kd7r9ilei2ygbawcy7tmf | qwnafaxrz7tyrtipzulg1ymf”那“状态”：“ok”那“测试”：错误的那“fraud_review”：错误的那“reference_transaction_id”：{}那“创建日期”：“2018 - 05 - 08 - t15:06:12 + 00:00”那“avs_result”：{…}那“cvv_result”：{…}那“credit_card”：{}那“gift_certificate”：{}那“store_credit”：{}那“离线”：{}那“自定义”：{}那“payment_instrument_token”：{}那“付款_method_id”：“squarev2.card”}]那“meta”：{…}}

处理退款

订单v3公开用于管理的端点订单退款。有关使用这些端点的概述，请参阅在API文档中订购退款。

计算总数

命令小计和全部的自动计算;编辑到以下属性触发重新计算。

财产	类型	描述
产品	阵列[obj]	用于计算运输，税和小计
shipping_cost_ex_tax.	浮动	运费成本，不包括税款
shipping_cost_inc_tax.	浮动	运费成本，包括税
handling_cost_ex_tax	浮动	处理成本价值，不含税
handling_cost_inc_tax.	浮动	办理成本价值，含税金
wraping_cost_ex_tax.	浮动	包装成本的价值，不包括税款
wrapping_cost_inc_tax	浮动	包装成本价值，含税
billing_address	obj.	用于计算运费和税收
shipping_addresses	阵列[obj]	用于计算运费和税收

您可以通过在请求中发送固定值来覆盖计算值，例如产品价格，计数器和总计。如果您不向这些属性提供值，您将根据预设商店值和税务规则自动计算它们。

常见问题解答

添加优惠券可用吗？

优惠券无法兑换。你不能写信给coupon_discount场地。您可以通过使用折扣来为订单添加折扣折扣_mount.。

如何为客人创建订单？

指定访客结账，设置customer_id为0。

如何设置订单源？

您无法指定ORDER_SOURCE.;它的价值是外在的。您可以选择指定外部源定义订单来自哪个外部来源，例如POS系统X，会计系统Y等。

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

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

country_ISO2和country有什么区别?

在指定时，不需要指定国家/地区country_ISO2在送货和付款地址，反之亦然。

如何为订单付款？

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

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

现在不行。如果您在控制面板中或通过API创建一个订单，它将在试图获得运输报价时返回204。

相关资源

文章

• 付款API概述
• 订单退款
• 订单状态
• 订单通知

终点

• 店面订单
• 订单v2.
• 订单v3

Webhooks.

• 订单