Archive
B2B Edition
V2 API
Order

Order

Create Order Without CompanyID

POST /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 - string
    required
  • authToken in header - string
    required
    Auth token in header.

Body

object | application/json
Request body

  • orderId    string
    required

    BigCommerce order id

  • poNumber    string

    PoNumber

  • totalIncTax    number
    required

    Total incTax

example

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

    Response data

  • message    string

    Response message

example

Get Company Orders

GET /companies/{companyId}/orders
⚠️
This endpoint is deprecated.

Request

Get company all orders, with pagination data

Authentication

  • authToken in header

Parameters

  • companyId in path - string
    required
  • authToken in header - string
    required
    Auth token in header.
  • offset in query - number
    Pagination offset default: 0
  • limit in query - number
    Pagination limit default: 10
  • orderBy in query - string
    in ['bcOrderId', 'totalIncTax', 'createdAt']
  • beginDateAt in query - string
    End date filter, in format '12/31/2019'
  • endDateAt in query - string
    End date filter, in format '12/31/2019'
  • includeExtra in query - string
    Switch show extra fields, allow: 0, 1
  • channelId in query - number
    BigComerce channel id

example

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

    Response data

  • message    string

    Response message

example

Create An Order

POST /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 - string
    required
  • customerId in path - string
    required
  • authToken in header - string
    required
    Auth token in header.

Body

object | application/json
Request body

  • orderId    string
    required

    BigCommerce order id

  • poNumber    string

    PoNumber

  • totalIncTax    number
    required

    Total incTax

example

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

    Response data

  • message    string

    Response message

example

Update Company Order With BC OrderId

PUT /orders
⚠️
This endpoint is deprecated.

Request

Update order, billingAddress and products can not be omitted. products can be two format.

  1. Product with variants.
  2. Base product

Authentication

  • authToken in header

Parameters

  • authToken in header - string
    required
    Auth token in header.

Body

object | application/json
Request body

  • baseHandlingCost    string

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

  • baseShippingCost    string

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

  • baseWrappingCost    string

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

  • billingAddress    object

  • channelId    string

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

  • creditCardType    string

    Credit card type.

  • customerMessage    string

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

  • dateCreated    string

    Date created.

  • discountAmount    string

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

  • ebayOrderId    string

    If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be 0.

  • externalId    string

    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..

  • externalMerchantId    string

    Id of the external merchant.

  • externalSource    string

    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.

  • geoipCountry    string

    The full name of the country where the customer made the purchase, based on the IP.

  • geoipCountryIso2    string

    The country where the customer made the purchase, in ISO2 format, based on the IP.

  • giftCertificateAmount    string

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

  • handlingCostExTax    string

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

  • handlingCostIncTax    string

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

  • ipAddress    string

    IP Address of the customer, if known.

  • isDeleted    string

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

  • itemsShipped    string

    The number of items that have been shipped.

  • itemsTotal    string

    The total number of items in the order.

  • orderId    string

    BigCommerce order id

  • orderIsDigital    string

    Whether this is an order for digital products.

  • paymentMethod    string

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

  • paymentProviderId    string

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

  • poNumber    string

    PoNumber

  • products    array[object]

  • refundedAmount    string

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

  • shippingCostExTax    string

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

  • shippingCostIncTax    string

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

  • staffNotes    string

    Any additional notes for staff.

  • statusId    string

    The status ID of the order.

  • subtotalExTax    string

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

  • subtotalIncTax    string

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

  • taxProviderId    string

    Tax provider id.

  • totalExTax    string

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

  • wrappingCostExTax    string

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

  • wrappingCostIncTax    string

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

example

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

    Response data

  • message    string

    Response message

example

Update B2BE User's Orders' company attribute.

PUT /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 - string
    required
    Auth token in header.

Body

object | application/json
Request body

  • customerGroupID    string
    required

    BigCommerce customer group id.

  • customerID    string
    required

    BigCommerce user id.

example

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

    Response data

  • message    string

    Response message

example

Update BC Order's 'Company attribute'

POST /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 - string
    required
    Auth token in header.

Body

object | application/json
Request body

  • customerID    string
    required

    BigCommerce user id.

example

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

    Response data

  • message    string

    Response message

example

Get Orders Images

GET /orders/images
⚠️
This endpoint is deprecated.

Request

Get all orders' images

Authentication

  • authToken in header

Parameters

  • authToken in header - string
    required
    Auth token in header.
  • orderIds in query - string
    Query order ids

example

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    array[object]

  • message    string

    Response message

example

Get Company By BC OrderId

GET /orders/{orderBCId}/companyIdBCId
⚠️
This endpoint is deprecated.

Request

Get company basic info by bc order id

Authentication

  • authToken in header

Parameters

  • orderBCId in path - string
    required
  • authToken in header - string
    required
    Auth token in header.

example

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

  • message    string

    Response message

example

Get Company Id By Order Id

GET /orders/{orderId}/companyId
⚠️
This endpoint is deprecated.

Request

Get company ID by order id

Authentication

  • authToken in header

Parameters

  • orderId in path - string
    required
  • authToken in header - string
    required
    Auth token in header.

example

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

  • message    string

    Response message

example

Get Order Detail

GET /orders/{orderId}/details
⚠️
This endpoint is deprecated.

Request

Get order's Detail

Authentication

  • authToken in header

Parameters

  • orderId in path - string
    required
  • authToken in header - string
    required
    Auth token in header.

example

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

  • message    string

    Response message

example

Get Order Product

GET /orders/{orderId}/products
⚠️
This endpoint is deprecated.

Request

Get order's products info

Authentication

  • authToken in header

Parameters

  • orderId in path - string
    required
  • authToken in header - string
    required
    Auth token in header.

example

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

  • message    string

    Response message

example

Did you find what you were looking for?
Get Company By CustomerIdCreate Order Without CompanyID