Upsert a list of orders to Northbeam

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Orders list

order_id

string

required

length ≥ 1

customer_id

string

required

length ≥ 1

time_of_purchase

date-time

required

customer_email

string

customer_phone_number

string

hashed_customer_email

string

hashed_customer_phone_number

string

customer_name

string

customer_ip_address

string

discount_codes

array of strings

discount_codes

discount_amount

number

≤ 100000000000000

order_tags

array of strings

order_tags

tax

number

required

≤ 100000000000000

is_recurring_order

boolean

currency

string

required

length ≥ 1

purchase_total

number

required

≤ 100000000000000

products

array of objects

required

length ≥ 1

products*

string

required

length ≥ 1

name

string

required

length ≥ 1

quantity

number

required

≤ 100000000000000

price

number

required

≤ 100000000000000

refunds

array of objects

refunds

customer_shipping_address

object

Responses

200

Orders succesfully upserted

400

Invalid input

401

Unauthenticated

500

Server error

Language

Credentials

URL

Loading…

Response

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