Ecommerce Objects
- Products
- Orders
- Fulfillments
- Customers
Orders
Retrieve Orders
Retrieve orders from any connected Ats software
GET
/
ecommerce
/
orders
/
{id}
import { Panora } from "@panora/sdk";
const panora = new Panora({
apiKey: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await panora.ecommerce.orders.retrieve({
xConnectionToken: "<value>",
id: "<id>",
});
// Handle the result
console.log(result)
}
run();
{
"order_status": "UNSHIPPED",
"order_number": 19823838833,
"payment_status": "SUCCESS",
"currency": "AUD",
"total_price": 300,
"total_discount": 10,
"total_shipping": 120,
"total_tax": 120,
"fulfillment_status": "PENDING",
"customer_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"items": [
{
"remote_id": "12345",
"product_id": "prod_001",
"variant_id": "var_001",
"sku": "SKU123",
"title": "Sample Product",
"quantity": 2,
"price": "19.99",
"total": "39.98",
"fulfillment_status": "PENDING",
"requires_shipping": true,
"taxable": true,
"weight": 1.5,
"variant_title": "Size M",
"vendor": "Sample Vendor",
"properties": [
{
"name": "Color",
"value": "Red"
}
],
"tax_lines": [
{
"title": "Sales Tax",
"price": "3.00",
"rate": 0.075
}
],
"discount_allocations": [
{
"amount": "5.00",
"discount_application_index": 0
}
]
}
],
"field_mappings": {
"fav_dish": "broccoli",
"fav_color": "red"
},
"id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"remote_id": "id_1",
"remote_data": {
"fav_dish": "broccoli",
"fav_color": "red"
},
"created_at": "2024-10-01T12:00:00Z",
"modified_at": "2024-10-01T12:00:00Z"
}
Authorizations
Headers
The connection token
Path Parameters
id of the order you want to retrieve.
Query Parameters
Set to true to include data from the original Ats software.
Response
200 - application/json
The response is of type object
.
Was this page helpful?
import { Panora } from "@panora/sdk";
const panora = new Panora({
apiKey: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await panora.ecommerce.orders.retrieve({
xConnectionToken: "<value>",
id: "<id>",
});
// Handle the result
console.log(result)
}
run();
{
"order_status": "UNSHIPPED",
"order_number": 19823838833,
"payment_status": "SUCCESS",
"currency": "AUD",
"total_price": 300,
"total_discount": 10,
"total_shipping": 120,
"total_tax": 120,
"fulfillment_status": "PENDING",
"customer_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"items": [
{
"remote_id": "12345",
"product_id": "prod_001",
"variant_id": "var_001",
"sku": "SKU123",
"title": "Sample Product",
"quantity": 2,
"price": "19.99",
"total": "39.98",
"fulfillment_status": "PENDING",
"requires_shipping": true,
"taxable": true,
"weight": 1.5,
"variant_title": "Size M",
"vendor": "Sample Vendor",
"properties": [
{
"name": "Color",
"value": "Red"
}
],
"tax_lines": [
{
"title": "Sales Tax",
"price": "3.00",
"rate": 0.075
}
],
"discount_allocations": [
{
"amount": "5.00",
"discount_application_index": 0
}
]
}
],
"field_mappings": {
"fav_dish": "broccoli",
"fav_color": "red"
},
"id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"remote_id": "id_1",
"remote_data": {
"fav_dish": "broccoli",
"fav_color": "red"
},
"created_at": "2024-10-01T12:00:00Z",
"modified_at": "2024-10-01T12:00:00Z"
}