Skip to main content
POST
/
v1
/
orders
/
{orderId}
JavaScript
import BlueHive from '@bluehive/sdk';

const client = new BlueHive({
  apiKey: 'My API Key',
});

const order = await client.orders.update('orderId');

console.log(order.message);
{
  "success": true,
  "message": "<string>",
  "orderId": "<string>",
  "orderNumber": "<string>",
  "updatedFields": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

API key for accessing BlueHive API endpoints. Format: "ApiKey <your-api-key>" or "Bearer <your-api-key>"

Path Parameters

​
orderId
string
required

The ID of the order to update

Body

application/json
​
status
enum<string>
Available options:
order_sent,
order_accepted,
order_refused,
employee_confirmed,
order_fulfilled,
order_complete
​
metadata
object

Arbitrary metadata to update on the order (non-indexed passthrough, <=10KB when JSON stringified)

​
services
object[]
Maximum length: 50

Response

Default Response

​
success
boolean
required
​
message
string
required
​
orderId
string
required
​
orderNumber
string
required
​
updatedFields
string[]
⌘I