Additional DocsArchiveB2B EditionV2 APIOrder

Update Company Order With BC OrderId

Deprecated
Update order, billingAddress and products cannot be omitted. products can be two format. 1. Product with variants. 2. Base product

Authentication

authTokenstring
API Key authentication via header

Headers

authTokenstringRequired
Auth token in header.

Request

Request body
baseHandlingCoststringOptional

The value of the base handling cost. (Float, Float-As-String, Integer).

baseShippingCoststringOptional

The value of the base shipping cost. (Float, Float-As-String, Integer)

baseWrappingCoststringOptional

The value of the base wrapping cost. (Float, Float-As-String, Integer).

billingAddressobjectOptional
channelIdstringOptional

BigCommerce channel id. Shows where the order originated. The channel_id will default to 1.

creditCardTypestringOptional
Credit card type.
customerMessagestringOptional

Message that the customer entered (number, optiona) -o the Order Comments box during checkout.

dateCreatedstringOptional
Date created.
discountAmountstringOptional

Amount of discount for this transaction. (Float, Float-As-String, Integer)

ebayOrderIdstringOptional
If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be 0.
externalIdstringOptional
ID of the order in another system. For example, the Amazon Order ID if this is an Amazon order. This field can be updated in a /POST, but using a /PUT to update the order will return a 400 error. The field ‘external_id’ cannot be written to. Please remove it from your request before trying again. It cannot be overwritten once set..
externalMerchantIdstringOptional
Id of the external merchant.
externalSourcestringOptional

For orders submitted or modified via the API, using a PUT or POST operation, you can optionally pass in a value identifying the system used to generate the order. For example: POS. Otherwise, the value will be null.

geoipCountrystringOptional
The full name of the country where the customer made the purchase, based on the IP.
geoipCountryIso2stringOptional
The country where the customer made the purchase, in ISO2 format, based on the IP.
giftCertificateAmountstringOptional

A read-only value. Do not pass in a POST or PUT. (Float, Float-As-String, Integer)

handlingCostExTaxstringOptional

The value of the handling cost, excluding tax. (Float, Float-As-String, Integer)

handlingCostIncTaxstringOptional

The value of the handling cost, including tax. (Float, Float-As-String, Integer).

ipAddressstringOptional
IP Address of the customer, if known.
isDeletedstringOptional

Indicates whether the order was deleted (archived). Set to true to archive an order.

itemsShippedstringOptional
The number of items that have been shipped.
itemsTotalstringOptional
The total number of items in the order.
orderIdstringOptional
BigCommerce order id
orderIsDigitalstringOptional
Whether this is an order for digital products.
paymentMethodstringOptional

The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc.

paymentProviderIdstringOptional

The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used).

poNumberstringOptional
PoNumber
productslist of objectsOptional
refundedAmountstringOptional

The amount refunded from this transaction. (Float, Float-As-String, Integer)

shippingCostExTaxstringOptional

The value of shipping cost, excluding tax. (Float, Float-As-String, Integer).

shippingCostIncTaxstringOptional

The value of shipping cost, including tax. (Float, Float-As-String, Integer).

staffNotesstringOptional
Any additional notes for staff.
statusIdstringOptional
The status ID of the order.
subtotalExTaxstringOptional

Override value for subtotal excluding tax. If specified, the field subtotal_inc_tax is also required. (Float, Float-As-String, Integer)

subtotalIncTaxstringOptional

TOverride value for subtotal including tax. If specified, the field subtotal_ex_tax is also required. (Float, Float-As-String, Integer)

taxProviderIdstringOptional
Tax provider id.
totalExTaxstringOptional

Override value for the total, excluding tax. If specified, the field total_inc_tax is also required. (Float, Float-As-String, Integer)

wrappingCostExTaxstringOptional

The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer).

wrappingCostIncTaxstringOptional

The value of the wrapping cost, including tax. (Float, Float-As-String, Integer).

Response

Response Success
codedoubleOptional
Response status code
dataobjectOptional
Response data
messagestringOptional
Response message

Errors

400
Bad Request Error
404
Not Found Error