Create an Orders export (orders + product information)

post

https://api.northbeam.io/v1/exports/data-export/orders

Trigger a one-off Orders export to your own GCS or S3 bucket. The export contains one row per order. By default it uses the default order columns (which include the customer type, first-time vs. returning); if you pass an explicit columns list you get exactly those columns. Product ids/SKUs, order tags, and the order source name are available as optional columns. Poll the returned id with GET /data-export/result/{export_id}.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to trigger a one-off Orders export (orders plus product information) to your own storage bucket. For an S3 destination provide both aws_role and region; omit them for a GCS destination.

bucket_name

string

required

Name of the external GCS or S3 bucket to export to.

aws_role

string | null

AWS role ARN with access to the S3 bucket (required for S3 exports).

region

string | null

AWS region of the S3 bucket (required for S3 exports).

export_file_name

string

length ≥ 3

^(?!/)(?!.*//)[A-Za-z0-9_/-]+(?<!/)$

Name of the exported file. A default name is used if omitted.

start_date

date-time

required

Start of the export window (inclusive).

end_date

date-time

required

End of the export window (exclusive).

columns

array of strings, unique

length ≥ 1

Optional list of column ids to include, in order. When omitted, the default columns are used. When provided, it must be a non-empty list of distinct ids, and you get exactly the columns you list — any subset of the allowed ids is valid and nothing is mandatory (customer_type is a default column, so include it here if you want it). products is a single column of comma-separated SKUs, falling back to the product id when a SKU is missing.

Responses

401

Unauthorized

422

Invalid Body Params

429

Too many requests

500

Internal server error

201Orders export created successfully