Create an Orders export (orders + product information)

curl --request POST \
  --url https://api.northbeam.io/v1/exports/data-export/orders \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Data-Client-ID: <api-key>' \
  --data '
{
  "bucket_name": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "aws_role": "<string>",
  "region": "<string>",
  "export_file_name": "<string>",
  "columns": []
}
'

const options = {
  method: 'POST',
  headers: {
    Authorization: '<api-key>',
    'Data-Client-ID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    bucket_name: '<string>',
    start_date: '2023-11-07T05:31:56Z',
    end_date: '2023-11-07T05:31:56Z',
    aws_role: '<string>',
    region: '<string>',
    export_file_name: '<string>',
    columns: []
  })
};

fetch('https://api.northbeam.io/v1/exports/data-export/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

payload = {
    "bucket_name": "<string>",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "aws_role": "<string>",
    "region": "<string>",
    "export_file_name": "<string>",
    "columns": []
}
headers = {
    "Authorization": "<api-key>",
    "Data-Client-ID": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.northbeam.io/v1/exports/data-export/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bucket_name' => '<string>',
    'start_date' => '2023-11-07T05:31:56Z',
    'end_date' => '2023-11-07T05:31:56Z',
    'aws_role' => '<string>',
    'region' => '<string>',
    'export_file_name' => '<string>',
    'columns' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "Data-Client-ID: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.northbeam.io/v1/exports/data-export/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Data-Client-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bucket_name\": \"<string>\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"aws_role\": \"<string>\",\n  \"region\": \"<string>\",\n  \"export_file_name\": \"<string>\",\n  \"columns\": []\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"bucket_name\": \"<string>\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"aws_role\": \"<string>\",\n  \"region\": \"<string>\",\n  \"export_file_name\": \"<string>\",\n  \"columns\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Data-Client-ID", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.northbeam.io/v1/exports/data-export/orders")
  .header("Authorization", "<api-key>")
  .header("Data-Client-ID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bucket_name\": \"<string>\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"aws_role\": \"<string>\",\n  \"region\": \"<string>\",\n  \"export_file_name\": \"<string>\",\n  \"columns\": []\n}")
  .asString();

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Data Export API

Create an Orders export

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}.

POST

data-export

orders

Create an Orders export (orders + product information)

curl --request POST \
  --url https://api.northbeam.io/v1/exports/data-export/orders \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Data-Client-ID: <api-key>' \
  --data '
{
  "bucket_name": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "aws_role": "<string>",
  "region": "<string>",
  "export_file_name": "<string>",
  "columns": []
}
'

const options = {
  method: 'POST',
  headers: {
    Authorization: '<api-key>',
    'Data-Client-ID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    bucket_name: '<string>',
    start_date: '2023-11-07T05:31:56Z',
    end_date: '2023-11-07T05:31:56Z',
    aws_role: '<string>',
    region: '<string>',
    export_file_name: '<string>',
    columns: []
  })
};

fetch('https://api.northbeam.io/v1/exports/data-export/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

payload = {
    "bucket_name": "<string>",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "aws_role": "<string>",
    "region": "<string>",
    "export_file_name": "<string>",
    "columns": []
}
headers = {
    "Authorization": "<api-key>",
    "Data-Client-ID": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.northbeam.io/v1/exports/data-export/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bucket_name' => '<string>',
    'start_date' => '2023-11-07T05:31:56Z',
    'end_date' => '2023-11-07T05:31:56Z',
    'aws_role' => '<string>',
    'region' => '<string>',
    'export_file_name' => '<string>',
    'columns' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "Data-Client-ID: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.northbeam.io/v1/exports/data-export/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Data-Client-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bucket_name\": \"<string>\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"aws_role\": \"<string>\",\n  \"region\": \"<string>\",\n  \"export_file_name\": \"<string>\",\n  \"columns\": []\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"bucket_name\": \"<string>\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"aws_role\": \"<string>\",\n  \"region\": \"<string>\",\n  \"export_file_name\": \"<string>\",\n  \"columns\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Data-Client-ID", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.northbeam.io/v1/exports/data-export/orders")
  .header("Authorization", "<api-key>")
  .header("Data-Client-ID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bucket_name\": \"<string>\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"aws_role\": \"<string>\",\n  \"region\": \"<string>\",\n  \"export_file_name\": \"<string>\",\n  \"columns\": []\n}")
  .asString();

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization

string

header

required

Data-Client-ID

string

header

required

Body

application/json

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.

start_date

string<date-time>

required

Start of the export window (inclusive).

end_date

string<date-time>

required

End of the export window (exclusive).

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

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

Minimum string length: 3

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

columns

enum<string>[]

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.

Minimum array length: 1

Available options:

order_id,

order_number,

order_ts,

platform,

order_revenue_total,

refund_amount_in_dollars,

attributed,

customer_type,

customer_first_name_sha256,

customer_email_sha256,

customer_phone_sha256,

customer_city_sha256,

customer_country_code_sha256,

customer_province_code_sha256,

customer_zip_sha256,

ip_address,

products,

order_tags,

source_name

Response

Orders export created successfully

string<uuid>

required