Northbeam DashboardQuestions? Reach out to our team!
API Reference

Partially update existing orders

patch
https://api.northbeam.io/v2/orders

Update specific fields of existing orders. Only fields present in the request payload will be modified. Omitted fields retain their existing values. Use explicit null to clear optional field values.

Note: The products and refunds fields currently cannot be patched. To modify products or refunds, re-submit the full order via POST.

Array fields (order_tags, discount_codes) are replaced entirely when present - no per-item merging is performed.

The entire batch fails if any order_id does not exist or any entry fails validation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

This must be a universal id that must be unique across all of your existing orders. It should exactly match the ID that you send using firePurchaseEvent if that is a part of your workflow. For documentation on firePurchaseEvent please review our Northbeam Pixel API. This must not be the customer ID.

string
required
length ≥ 1

This must be a universal id that must be unique across all of your existing customers. The internal customer ID. This must not be the order ID. This should not be an email.

date-time

The time the order was placed by the customer. ISO-8601 timestamp.

string | null

The email associated with the customer. Cannot be provided if hashed_customer_email is present.

string | null

Pre-hashed (SHA-256) email associated with the customer. Cannot be provided if customer_email is present.

Important: Email must be normalized before hashing. See the Hashing Customer Data guide for normalization rules and implementation examples.

string | null

The phone number associated with the customer. Cannot be provided if hashed_customer_phone_number is present.

string | null

Pre-hashed (SHA-256) phone number associated with the customer. Cannot be provided if customer_phone_number is present.

Important: Phone number must be normalized to E.164 format before hashing. See the Hashing Customer Data guide for normalization rules and implementation examples.

string | null

The name associated with the customer.

string | null

The IP address associated with the customer.

discount_codes
array of strings | null

A list of discount codes used in the order.

discount_codes
number | null
≤ 100000000000000

The amount of money discounted due to discount codes in the currency of the order.

order_tags
array of strings | null

A list of internal tags describing the order.

order_tags
number | null
≤ 100000000000000

The tax amount in the currency of the order.

boolean | null

Whether or not this order is part of a recurring purchase.

string | null

The currency of the order. Note, all subsequent fields will assume that the currency is the one passed in this field. Please use standard ISO-4217 currency codes.

number | null
≤ 100000000000000

The amount of money collected from the customer (including taxes, shipping, and other fees) in the currency of the order.

customer_shipping_address
object | null
number | null
≤ 100000000000000

The amount that was paid for shipping for this order

alternate_order_ids
array of objects | null

Alternate identifiers for this order

alternate_order_ids
Responses

400

Invalid input - validation error or order not found

401

Unauthenticated

413

Payload too large

500

Server error

Updated about 1 month ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago