Order
Create Order Without CompanyID
POST https://api-b2b.bigcommerce.com/api/v2/io/companies/users/{customerId}/orders⚠️
This endpoint is deprecated.
Request
Create an order from bigCommerce, you must known order id
Authentication
- authToken in header
Parameters
- customerId in path - stringrequired
- authToken in header - stringrequiredAuth token in header.
Body
object | application/json
Request body
orderIdstring
requiredBigCommerce order idpoNumberstring
PoNumbertotalIncTaxnumber
requiredTotal incTax
example
Response
Response Success
Body
object | application/json
codenumber
Response status codedataobject
Response data
example
Get Company Orders
GET https://api-b2b.bigcommerce.com/api/v2/io/companies/{companyId}/orders⚠️
This endpoint is deprecated.
Request
Get company all orders, with pagination data
Authentication
- authToken in header
Parameters
- companyId in path - stringrequired
- authToken in header - stringrequiredAuth token in header.
- offset in query - numberPagination offset default: 0
- limit in query - numberPagination limit default: 10
- orderBy in query - stringin ['bcOrderId', 'totalIncTax', 'createdAt']
- beginDateAt in query - stringEnd date filter, in format '12/31/2019'
- endDateAt in query - stringEnd date filter, in format '12/31/2019'
- includeExtra in query - stringSwitch show extra fields, allow: 0, 1
- channelId in query - numberBigComerce channel id
example
Response
Response Success
Body
object | application/json
codenumber
Response status codedataobject
Response data
example
Create An Order
POST https://api-b2b.bigcommerce.com/api/v2/io/companies/{companyId}/user/{customerId}/orders⚠️
This endpoint is deprecated.
Request
Create an order from bigCommerce, you must known order id
Authentication
- authToken in header
Parameters
- companyId in path - stringrequired
- customerId in path - stringrequired
- authToken in header - stringrequiredAuth token in header.
Body
object | application/json
Request body
orderIdstring
requiredBigCommerce order idpoNumberstring
PoNumbertotalIncTaxnumber
requiredTotal incTax
example
Response
Response Success
Body
object | application/json
codenumber
Response status codedataobject
Response data
example
Update Company Order With BC OrderId
PUT https://api-b2b.bigcommerce.com/api/v2/io/orders⚠️
This endpoint is deprecated.
Request
Update order, billingAddress and products can not be omitted. products can be two format.
- Product with variants.
- Base product
Authentication
- authToken in header
Parameters
- authToken in header - stringrequiredAuth token in header.
Body
object | application/json
Request body
baseHandlingCoststring
The value of the base handling cost. (Float, Float-As-String, Integer).baseShippingCoststring
The value of the base shipping cost. (Float, Float-As-String, Integer)baseWrappingCoststring
The value of the base wrapping cost. (Float, Float-As-String, Integer).billingAddressobject
channelIdstring
BigCommerce channel id. Shows where the order originated. The channel_id will default to 1.creditCardTypestring
Credit card type.customerMessagestring
Message that the customer entered (number, optiona) -o the Order Comments box during checkout.dateCreatedstring
Date created.discountAmountstring
Amount of discount for this transaction. (Float, Float-As-String, Integer)ebayOrderIdstring
If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be 0.externalIdstring
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 can not be overwritten once set..externalMerchantIdstring
Id of the external merchant.externalSourcestring
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.geoipCountrystring
The full name of the country where the customer made the purchase, based on the IP.geoipCountryIso2string
The country where the customer made the purchase, in ISO2 format, based on the IP.giftCertificateAmountstring
A read-only value. Do not pass in a POST or PUT. (Float, Float-As-String, Integer)handlingCostExTaxstring
The value of the handling cost, excluding tax. (Float, Float-As-String, Integer)handlingCostIncTaxstring
The value of the handling cost, including tax. (Float, Float-As-String, Integer).ipAddressstring
IP Address of the customer, if known.isDeletedstring
Indicates whether the order was deleted (archived). Set to to true, to archive an order.itemsShippedstring
The number of items that have been shipped.itemsTotalstring
The total number of items in the order.orderIdstring
BigCommerce order idorderIsDigitalstring
Whether this is an order for digital products.paymentMethodstring
The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc.paymentProviderIdstring
The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used).poNumberstring
PoNumberproductsarray[object]
refundedAmountstring
The amount refunded from this transaction. (Float, Float-As-String, Integer)shippingCostExTaxstring
The value of shipping cost, excluding tax. (Float, Float-As-String, Integer).shippingCostIncTaxstring
The value of shipping cost, including tax. (Float, Float-As-String, Integer).staffNotesstring
Any additional notes for staff.statusIdstring
The status ID of the order.subtotalExTaxstring
Override value for subtotal excluding tax. If specified, the field subtotal_inc_tax is also required. (Float, Float-As-String, Integer)subtotalIncTaxstring
TOverride value for subtotal including tax. If specified, the field subtotal_ex_tax is also required. (Float, Float-As-String, Integer)taxProviderIdstring
Tax provider id.totalExTaxstring
Override value for the total, excluding tax. If specified, the field total_inc_tax is also required. (Float, Float-As-String, Integer)wrappingCostExTaxstring
The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer).wrappingCostIncTaxstring
The value of the wrapping cost, including tax. (Float, Float-As-String, Integer).
example
Response
Response Success
Body
object | application/json
codenumber
Response status codedataobject
Response data
example
Update B2BE User's Orders' company attribute.
PUT https://api-b2b.bigcommerce.com/api/v2/io/orders/company⚠️
This endpoint is deprecated.
Request
Update the orders belong to a B2BE company to another B2BE company.
Authentication
- authToken in header
Parameters
- authToken in header - stringrequiredAuth token in header.
Body
object | application/json
Request body
customerGroupIDstring
requiredBigCommerce customer group id.customerIDstring
requiredBigCommerce user id.
example
Response
Response Success
Body
object | application/json
codenumber
Response status codedataobject
Response data
example
Update BC Order's 'Company attribute'
POST https://api-b2b.bigcommerce.com/api/v2/io/orders/company⚠️
This endpoint is deprecated.
Request
Add Company identifier for BigCommerce Customer Individual Orders, which can be used to convert BigCommerce Customer Individual Orders to Company-level Orders.
Authentication
- authToken in header
Parameters
- authToken in header - stringrequiredAuth token in header.
Body
object | application/json
Request body
customerIDstring
requiredBigCommerce user id.
example
Response
Response Success
Body
object | application/json
codenumber
Response status codedataobject
Response data
example
Get Orders Images
GET https://api-b2b.bigcommerce.com/api/v2/io/orders/images⚠️
This endpoint is deprecated.
Request
Get all orders' images
Authentication
- authToken in header
Parameters
- authToken in header - stringrequiredAuth token in header.
- orderIds in query - stringQuery order ids
example
Response
Response Success
Body
object | application/json
codenumber
Response status codedataarray[object]
example
Get Company By BC OrderId
GET https://api-b2b.bigcommerce.com/api/v2/io/orders/{orderBCId}/companyIdBCId⚠️
This endpoint is deprecated.
Request
Get company basic info by bc order id
Authentication
- authToken in header
Parameters
- orderBCId in path - stringrequired
- authToken in header - stringrequiredAuth token in header.
example
Response
Response Success
Body
object | application/json
codenumber
Response status codedataobject
example
Get Company Id By Order Id
GET https://api-b2b.bigcommerce.com/api/v2/io/orders/{orderId}/companyId⚠️
This endpoint is deprecated.
Request
Get company ID by order id
Authentication
- authToken in header
Parameters
- orderId in path - stringrequired
- authToken in header - stringrequiredAuth token in header.
example
Response
Response Success
Body
object | application/json
codenumber
Response status codedataobject
example
Get Order Detail
GET https://api-b2b.bigcommerce.com/api/v2/io/orders/{orderId}/details⚠️
This endpoint is deprecated.
Request
Get order's Detail
Authentication
- authToken in header
Parameters
- orderId in path - stringrequired
- authToken in header - stringrequiredAuth token in header.
example
Response
Response Success
Body
object | application/json
codenumber
Response status codedataobject
example
Get Order Product
GET https://api-b2b.bigcommerce.com/api/v2/io/orders/{orderId}/products⚠️
This endpoint is deprecated.
Request
Get order's products info
Authentication
- authToken in header
Parameters
- orderId in path - stringrequired
- authToken in header - stringrequiredAuth token in header.
example
Response
Response Success
Body
object | application/json
codenumber
Response status codedataobject
example
Did you find what you were looking for?