Get Store Orders

Get Store Orders

curl --request GET \
  --url 'https://api.example.com/{{micro_service_base_url}}/orders/'

const options = {method: 'GET'};

fetch('https://api.example.com/{{micro_service_base_url}}/orders/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/{{micro_service_base_url}}/orders/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/{{micro_service_base_url}}/orders/"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/{{micro_service_base_url}}/orders/")

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

request = Net::HTTP::Get.new(url)

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

{
  "orders": [
    {
      "id": "<string>",
      "original_subtotal": "<string>",
      "tax_amount": "<string>",
      "discount": "<string>",
      "original_price": "<string>",
      "price": "<string>",
      "final_price": "<string>",
      "createdAt": "<string>",
      "partner": "<string>",
      "status": "<string>",
      "special_instructions": "<string>",
      "customer": {},
      "fulfillments": [
        {}
      ],
      "orderItems": [
        {}
      ]
    }
  ],
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "total_orders": 123,
    "orders_per_page": 123,
    "has_next_page": true,
    "has_previous_page": true
  },
  "summary": {
    "total_revenue": "<string>",
    "average_order_value": "<string>",
    "status_breakdown": {},
    "partner_breakdown": {}
  }
}

GET

{micro_service_base_url}

orders

Get Store Orders

curl --request GET \
  --url 'https://api.example.com/{{micro_service_base_url}}/orders/'

const options = {method: 'GET'};

fetch('https://api.example.com/{{micro_service_base_url}}/orders/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/{{micro_service_base_url}}/orders/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/{{micro_service_base_url}}/orders/"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/{{micro_service_base_url}}/orders/")

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

request = Net::HTTP::Get.new(url)

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

{
  "orders": [
    {
      "id": "<string>",
      "original_subtotal": "<string>",
      "tax_amount": "<string>",
      "discount": "<string>",
      "original_price": "<string>",
      "price": "<string>",
      "final_price": "<string>",
      "createdAt": "<string>",
      "partner": "<string>",
      "status": "<string>",
      "special_instructions": "<string>",
      "customer": {},
      "fulfillments": [
        {}
      ],
      "orderItems": [
        {}
      ]
    }
  ],
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "total_orders": 123,
    "orders_per_page": 123,
    "has_next_page": true,
    "has_previous_page": true
  },
  "summary": {
    "total_revenue": "<string>",
    "average_order_value": "<string>",
    "status_breakdown": {},
    "partner_breakdown": {}
  }
}

This endpoint provides comprehensive access to all orders for a specific store with powerful filtering capabilities. Perfect for store management, reporting, and operational oversight.

This endpoint supports advanced filtering and pagination to efficiently handle large volumes of order data while providing flexible search capabilities.

Query Parameters

string

required

The unique identifier of the store whose orders you want to retrieve

string

Filter orders by status (e.g., “pending”, “accepted”, “in_progress”, “completed”, “canceled”)

string

Filter by delivery platform (e.g., “DoorDash”, “UberEats”, “GrubHub”, “LulaDirect”)

string

Start date for filtering orders (ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ)

string

End date for filtering orders (ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ)

integer

default:"1"

Page number for pagination

integer

default:"50"

Number of orders per page (max 100)

string

default:"createdAt"

Field to sort by (“createdAt”, “price”, “status”, “partner”)

string

default:"desc"

Sort direction (“asc” or “desc”)

Response

array

Array of order objects matching the filter criteria

Show Order Object

string

Unique order identifier

string

Order subtotal before taxes and fees

string

Tax amount applied to the order

string

Discount amount (null if no discount applied)

string

Original total price

string

Current order price

string

Final price after all modifications

string

Order creation timestamp

string

Delivery service platform name

string

Current order status

string

Customer-provided special instructions

object

Customer information including name and contact details

array

Fulfillment tracking information

array

Summary of items in the order

object

Pagination information for the response

Show Pagination Details

integer

Current page number

integer

Total number of pages available

integer

Total number of orders matching the criteria

integer

Number of orders in this page

boolean

Whether there are more pages available

boolean

Whether there are previous pages available

object

Summary statistics for the filtered orders

Show Summary Statistics

string

Total revenue from filtered orders

string

Average order value

object

Count of orders by status

object

Count of orders by delivery platform

Response Example

{
  "orders": [
    {
      "id": "35d18f08-6d54-421d-9476-8cef629111bc",
      "original_subtotal": "41.00",
      "tax_amount": "0.02",
      "discount": null,
      "original_price": "41.02",
      "price": "0.20",
      "final_price": "0.20",
      "createdAt": "2023-03-08T12:25:07.433Z",
      "partner": "UberEats",
      "status": "completed",
      "special_instructions": "Packing should be good.",
      "customer": {
        "customer_name": "Lula D.",
        "contact_phone": "+1 312-766-6835"
      },
      "fulfillments": [
        {
          "id": "f60a1ebf-c9fd-4c5a-b25f-db5f59e03851",
          "status": "delivered",
          "date_ready": "2023-04-04T22:10:33.233Z"
        }
      ],
      "orderItems": [
        {
          "id": "7fbe2819-5bc6-4340-8dfe-a5605272a32b",
          "quantity": 1,
          "store_item_name": "Jumbo Ring Pop - 1",
          "store_item_total_price": "1.00"
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 5,
    "total_orders": 247,
    "orders_per_page": 50,
    "has_next_page": true,
    "has_previous_page": false
  },
  "summary": {
    "total_revenue": "12,847.50",
    "average_order_value": "52.03",
    "status_breakdown": {
      "completed": 198,
      "in_progress": 15,
      "pending": 8,
      "canceled": 26
    },
    "partner_breakdown": {
      "UberEats": 95,
      "DoorDash": 87,
      "GrubHub": 45,
      "LulaDirect": 20
    }
  }
}

Filter Examples

Get Today’s Orders

GET {{micro_service_base_url}}/orders/?store_id=449235c1-3d04-4519-998b-40d2a621e5e0&date_from=2024-01-15T00:00:00Z&date_to=2024-01-15T23:59:59Z

Get Pending Orders from UberEats

GET {{micro_service_base_url}}/orders/?store_id=449235c1-3d04-4519-998b-40d2a621e5e0&status=pending&partner=UberEats

Get Last Week’s Completed Orders

GET {{micro_service_base_url}}/orders/?store_id=449235c1-3d04-4519-998b-40d2a621e5e0&status=completed&date_from=2024-01-08T00:00:00Z&date_to=2024-01-14T23:59:59Z

Performance Optimization: When querying large date ranges, consider using smaller page sizes (limit parameter) and implement pagination to maintain fast response times.

Time Zones: All timestamps are returned in UTC. Convert to your local timezone as needed for display purposes.

Rate Limiting: This endpoint is subject to rate limiting. For frequent polling, consider using webhooks or the order count endpoint for basic monitoring.

Use Cases

Common Use Cases

Daily Operations Dashboard

Get today’s orders with status filtering
Monitor pending orders requiring attention
Track fulfillment performance

Financial Reporting

Calculate daily/weekly/monthly revenue
Analyze order value trends
Track performance by delivery platform

Performance Analytics

Monitor order completion rates
Analyze peak order times
Track customer satisfaction metrics

Inventory Planning

Review historical order patterns
Identify popular items and trends
Plan inventory based on demand

API Documentation - Legacy

API Documentation - Latest

Query Parameters

Response

Response Example

Use Cases

​Query Parameters

​Response

​Response Example

​Use Cases

Query Parameters

Response

Response Example

Use Cases