Upsert a list of orders to Northbeam

post

https://api.northbeam.io/v1/orders

Body Params

Orders list

order_id

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.

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.

time_of_purchase

date-time

required

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

customer_email

string

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

customer_phone_number

string

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

hashed_customer_email

string

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.

hashed_customer_phone_number

string

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.

customer_name

string

The name associated with the customer.

customer_ip_address

string

The IP address associated with the customer.

discount_codes

array of strings

A list of discount codes used in the order.

discount_codes

discount_amount

number

≤ 100000000000000

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

order_tags

array of strings

A list of internal tags describing the order.

order_tags

tax

number

required

≤ 100000000000000

The tax amount in the currency of the order.

is_recurring_order

boolean

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

currency

string

required

length ≥ 1

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.

purchase_total

number

required

≤ 100000000000000

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

products

array of objects

required

length ≥ 1

A list of objects describing the products in the order.

products*

string

required

length ≥ 1

A unique identifier describing the product in the order.

name

string

required

length ≥ 1

The name of the product.

quantity

number

required

≤ 100000000000000

How many of this product was sold in the order

price

number

required

≤ 100000000000000

The (per unit) price of the product in the currency of the order.

refunds

array of objects

A list of objects describing the refunded products.

refunds

customer_shipping_address

object

Responses

200

Orders succesfully upserted

400

Invalid input

401

Unauthenticated

500

Server error

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here!