Update Order

PUT

https://api-b2b.bigcommerce.com/api/v3/io/orders/:bcOrderId

PUT

/api/v3/io/orders/:bcOrderId

curl -X PUT https://api-b2b.bigcommerce.com/api/v3/io/orders/123 \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "code": 200,
  "data": {
    "id": 12345,
    "bcOrderId": 123,
    "totalIncTax": 2210.47,
    "poNumber": "04152025-0002",
    "status": "Awaiting Payment",
    "customStatus": "Invoice Sent",
    "cartId": "095a15a6-8a27-4c20-b357-36b82e9d5929",
    "items": 50,
    "usdIncTax": 2210.47,
    "companyId": 12345,
    "currencyCode": "USD",
    "money": [
      {
        "currencyLocation": "left",
        "currencyToken": "$",
        "decimalToken": ".",
        "decimalPlaces": 2,
        "thousandsToken": ","
      }
    ],
    "statusCode": 7,
    "isArchived": false,
    "channelId": 1,
    "channelName": "B2B Store",
    "isInvoiceOrder": 0,
    "invoiceId": 12345,
    "invoiceNumber": 12345678,
    "invoiceStatus": 2,
    "extraInt1": 12345,
    "extraInt2": 12345,
    "extraInt3": 12345,
    "extraInt4": 12345,
    "extraInt5": 12345,
    "extraStr1": "Great Buys Incorporated",
    "extraStr2": "Great Buys Incorporated",
    "extraStr3": "Great Buys Incorporated",
    "extraStr4": "Great Buys Incorporated",
    "extraStr5": "Great Buys Incorporated",
    "extraText": "Great Buys Incorporated",
    "extraInfo": [
      {
        "billingAddressId": 12345,
        "shippingAddressId": 12345
      }
    ],
    "extraFields": [
      {
        "fieldName": "Fintech ID",
        "fieldValue": "1234567890"
      }
    ],
    "createdAt": 1744735719,
    "updatedAt": 1744735734
  },
  "meta": {
    "message": "SUCCESS"
  }
}

Updates B2B information on a specific order based on the bcOrderId provided.

The bcOrderId parameter must include a valid BigCommerce Order ID (not the B2B Edition order ID returned in certain Orders endpoints) for the request to be successful. You must also include at least one of the following fields in the request body:

poNumber
extraFields (array with fieldName and fieldValue)
- This array must be included if your store has required order extra fields.

Authentication

X-Auth-Tokenstring

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Path parameters

bcOrderIdintegerRequired

The BigCommerce order ID.

Request

This endpoint expects an object.

poNumberstringOptional

The order’s Purchase Order (PO), if used.

extraFieldslist of anyOptional

Contains extra field information associated with the order.

Response

codeintegerOptionalDefaults to 200

HTTP Response Code

dataobjectOptional

metaobjectOptional

Errors

404

Not Found Error

422

Unprocessable Entity Error