List All Orders - Venddor API

List All Orders

This endpoint allows you to retrieve a list of orders from your Venddor store.

Base URL: https://your-store-url.com/api

Endpoint Details

GET /api/orders/

This request returns details of up to 10 orders. You can use pagination parameters to retrieve more results.

Response Example

{
  "orders": [
    {
      "order_id": "12345",
      "status": "P",
      "timestamp": "1712345678",
      "firstname": "John",
      "lastname": "Doe",
      "email": "john.doe@example.com",
      "phone": "+1 234 567 8901",
      "total": "159.97",
      "subtotal": "149.97",
      "tax_subtotal": "0.00",
      "shipping_cost": "10.00",
      "discount": "0.00",
      "payment_id": "credit_card",
      "payment_method": "Credit Card",
      "need_shipping": "Y",
      "shipping_method": "Standard Shipping",
      "items_count": 3
    },
    {
      "order_id": "12346",
      "status": "C",
      "timestamp": "1712244678",
      "firstname": "Jane",
      "lastname": "Smith",
      "email": "jane.smith@example.com",
      "phone": "+1 987 654 3210",
      "total": "49.99",
      "subtotal": "49.99",
      "tax_subtotal": "0.00",
      "shipping_cost": "0.00",
      "discount": "0.00",
      "payment_id": "paypal",
      "payment_method": "PayPal",
      "need_shipping": "N",
      "shipping_method": "",
      "items_count": 1
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 2
  }
}

Response Fields

Field Type Description
orders array Array of order objects
order_id string Unique identifier of the order
status string Order status:
O — Open
P — Processing
C — Complete
F — Failed
D — Declined
B — Backordered
I — Canceled
Y — Awaiting call
timestamp string Unix timestamp when the order was placed
firstname string Customer's first name
lastname string Customer's last name
email string Customer's email address
phone string Customer's phone number
total string Total order amount
subtotal string Order amount before shipping and taxes
tax_subtotal string Tax amount
shipping_cost string Cost of shipping
discount string Discount amount applied to the order
payment_id string Payment method identifier
payment_method string Payment method name
need_shipping string Whether the order requires shipping:
Y — Yes
N — No (digital products)
shipping_method string Name of the shipping method selected
items_count integer Number of items in the order

Pagination Parameters

The API returns basic pagination information in the params object:

Field Type Description
page integer Current page number
items_per_page integer Number of items displayed per page
total_items integer Total number of orders matching the filter criteria
Tip: To view the complete details of a specific order, including products and shipping details, use the GET /api/orders/{order_id} endpoint.

Common Use Cases

Copyright © . Venddor Tecnologia S.A. All rights reserved.