Partially update existing orders

patch

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

order_id

string

required

length ≥ 1

customer_id

string

required

length ≥ 1

time_of_purchase

date-time

customer_email

string | null

hashed_customer_email

string | null

customer_phone_number

string | null

hashed_customer_phone_number

string | null

customer_name

string | null

customer_ip_address

string | null

discount_codes

array of strings | null

discount_codes

discount_amount

number | null

≤ 100000000000000

order_tags

array of strings | null

order_tags

tax

number | null

≤ 100000000000000

is_recurring_order

boolean | null

currency

string | null

purchase_total

number | null

≤ 100000000000000

customer_shipping_address

object | null

shipping_cost

number | null

≤ 100000000000000

alternate_order_ids

array of objects | null

alternate_order_ids

Responses

400

Invalid input - validation error or order not found

401

Unauthenticated

413

Payload too large

500

Server error

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Orders successfully queued for update