Northbeam Orders API
The Orders API from Northbeam — 2 operation(s) for orders.
Operations 4
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“How do I send new orders from my shop into Northbeam?”
“Can I resubmit a full order to change its products or refunds?”
Tell an agent
Upsert this batch of full orders from my store.
Resubmit the complete order record, including products and refunds, to replace it.
Ask an LLM
“How do I change just a few fields on orders I already synced to Northbeam?”
“Can I clear an optional field on an existing order by sending null?”
Tell an agent
Patch the order tags on my existing synced orders, leaving every other field unchanged.
Partially update the discount codes on orders already in the app without resubmitting them.
Ask an LLM
“Which orders has Northbeam received between two dates?”
“Can I pull back the orders I synced for last month?”
Tell an agent
List orders from {start_date} to {end_date}.
Fetch the synced orders placed between {start_date} and {end_date}.
Ask an LLM
“Can I link an alternate order ID to an order that's already been synced?”
“What happens if I add an order alias that already exists?”
Tell an agent
Add these alternate order IDs as aliases: {aliases}.
Attach aliases {aliases} to my existing orders so both IDs map to the same order.
Documentation
Documentation
https://docs.northbeam.io/docs/orders-api
APIReference
https://docs.northbeam.io/reference/post_orders-1
Documentation
https://docs.northbeam.io/docs/spend-api
APIReference
https://docs.northbeam.io/reference/post_spend-hourly
Documentation
https://docs.northbeam.io/docs/northbeam-api-data-export-1
APIReference
https://docs.northbeam.io/reference/post_data-export-1
RateLimits
https://docs.northbeam.io/docs/northbeam-api-data-export-rate-limits-1