Skip to content
Space Invoices Documentation

Orders

Orders

Order management for e-commerce integrations.
Receive, store, and process orders from external platforms into invoices.

Endpoints
IntroductionPOST/ordersGET/ordersGET/orders/{id}PATCH/orders/{id}DELETE/orders/{id}POST/orders/{id}/processPOST/orders/{id}/cancelPOST/orders/{id}/reissue

The Order object

object

Attributes

idstring
Other attributes
entity_idstring
order_integration_idstring
sourcestring
source_idstring
source_order_numberstring
statusstring
paidboolean
paid_atstring<date-time>
fulfilledboolean
fulfilled_atstring<date-time>
cancelledboolean
cancelled_atstring<date-time>
refundedboolean
refunded_atstring<date-time>
customer_namestring
customer_emailstring
customerobject
billing_addressobject
shipping_addressobject
customer_idstring
currency_codestring
totalnumber
total_with_taxnumber
total_discountnumber
total_shippingnumber
itemsarray of objects
payment_statusstring
payment_methodstring
payment_gatewaystring
invoice_idstring
estimate_idstring
process_afterstring<date-time>
transactionsarray of objects
completeboolean
items_changed_after_processingboolean
raw_dataobject
source_event_idstring
errorstring
ordered_atstring<date-time>
processed_atstring<date-time>
metadata
deleted_atstring<date-time>
created_atstring<date-time>
updated_atstring<date-time>
Examplejson
{
  "id": "ord_6595a27b5d35015c3ef0c3fd",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "order_integration_id": "oint_6595a27b5d35015c3ef0c3fd",
  "source": "manual",
  "source_id": "manual-001",
  "source_order_number": null,
  "status": "pending",
  "paid": false,
  "paid_at": null,
  "fulfilled": false,
  "fulfilled_at": null,
  "cancelled": false,
  "cancelled_at": null,
  "refunded": false,
  "refunded_at": null,
  "customer_name": null,
  "customer_email": null,
  "customer": null,
  "billing_address": null,
  "shipping_address": null,
  "customer_id": null,
  "currency_code": "EUR",
  "total": 100,
  "total_with_tax": 122,
  "total_discount": 0,
  "total_shipping": 0,
  "items": [
    {
      "name": "Widget Pro",
      "quantity": 2,
      "price": 50,
      "gross_price": 61,
      "total": 100,
      "total_with_tax": 122,
      "tax_rate": 22
    }
  ],
  "payment_status": "unpaid",
  "payment_method": null,
  "payment_gateway": null,
  "invoice_id": null,
  "estimate_id": null,
  "process_after": null,
  "transactions": [],
  "complete": false,
  "items_changed_after_processing": false,
  "raw_data": null,
  "source_event_id": null,
  "error": null,
  "ordered_at": null,
  "processed_at": null,
  "metadata": {},
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-09-01T00:00:00.000Z",
  "deleted_at": null
}

Create a new order

POST/orders

Create a new order manually or from an external source.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Body parameters

order_integration_idstringrequired
sourcestringrequired

Order source platform

Possible values: "shopify", "woocommerce", "manual"

source_idstringrequired
currency_codestringrequired
totalnumberrequired
total_with_taxnumberrequired
itemsarray of objectsrequired
Other parameters
source_order_numberstringoptional
customer_namestringoptional
customer_emailstringoptional
customerobjectoptional
billing_addressobjectoptional
shipping_addressobjectoptional
total_discountnumberoptional
total_shippingnumberoptional
payment_statusstringoptional
payment_methodstringoptional
payment_gatewaystringoptional
ordered_atstring<date-time>optional
metadataobjectoptional
curl -X POST "https://eu.spaceinvoices.com/orders" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "order_integration_id": "oint_6595a27b5d35015c3ef0c3fd",
    "source": "manual",
    "source_id": "manual-001",
    "currency_code": "EUR",
    "total": 100,
    "total_with_tax": 122,
    "items": [
      {
        "name": "Widget Pro",
        "quantity": 2,
        "price": 50,
        "gross_price": 61,
        "total": 100,
        "total_with_tax": 122,
        "tax_rate": 22
      }
    ]
  }'
Example:
Response

Returns

idstring
Other parameters
entity_idstring
order_integration_idstring
sourcestring
source_idstring
source_order_numberstring
statusstring
paidboolean
paid_atstring<date-time>
fulfilledboolean
fulfilled_atstring<date-time>
cancelledboolean
cancelled_atstring<date-time>
refundedboolean
refunded_atstring<date-time>
customer_namestring
customer_emailstring
customerobject
billing_addressobject
shipping_addressobject
customer_idstring
currency_codestring
totalnumber
total_with_taxnumber
total_discountnumber
total_shippingnumber
itemsarray of objects
payment_statusstring
payment_methodstring
payment_gatewaystring
invoice_idstring
estimate_idstring
process_afterstring<date-time>
transactionsarray of objects
completeboolean
items_changed_after_processingboolean
raw_dataobject
source_event_idstring
errorstring
ordered_atstring<date-time>
processed_atstring<date-time>
metadata
deleted_atstring<date-time>
created_atstring<date-time>
updated_atstring<date-time>
json
{
  "id": "ord_6595a27b5d35015c3ef0c3fd",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "order_integration_id": "oint_6595a27b5d35015c3ef0c3fd",
  "source": "manual",
  "source_id": "manual-001",
  "source_order_number": null,
  "status": "pending",
  "paid": false,
  "paid_at": null,
  "fulfilled": false,
  "fulfilled_at": null,
  "cancelled": false,
  "cancelled_at": null,
  "refunded": false,
  "refunded_at": null,
  "customer_name": null,
  "customer_email": null,
  "customer": null,
  "billing_address": null,
  "shipping_address": null,
  "customer_id": null,
  "currency_code": "EUR",
  "total": 100,
  "total_with_tax": 122,
  "total_discount": 0,
  "total_shipping": 0,
  "items": [
    {
      "name": "Widget Pro",
      "quantity": 2,
      "price": 50,
      "gross_price": 61,
      "total": 100,
      "total_with_tax": 122,
      "tax_rate": 22
    }
  ],
  "payment_status": "unpaid",
  "payment_method": null,
  "payment_gateway": null,
  "invoice_id": null,
  "estimate_id": null,
  "process_after": null,
  "transactions": [],
  "complete": false,
  "items_changed_after_processing": false,
  "raw_data": null,
  "source_event_id": null,
  "error": null,
  "ordered_at": null,
  "processed_at": null,
  "metadata": {},
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-09-01T00:00:00.000Z",
  "deleted_at": null
}

List all orders

GET/orders

Retrieve a paginated list of orders with optional filtering and sorting.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Query parameters

limitintegeroptional

Number of results per request.

Default: 10

next_cursorstringoptional

Cursor to fetch the next page of results. Use the value from pagination.next_cursor in the previous response.

prev_cursorstringoptional

Cursor to fetch the previous page of results. Use the value from pagination.prev_cursor in the previous response.

include_total_countbooleanoptional

Whether to include the total count of items in pagination.total.
Default is true.
When false, pagination.total returns -1 for better performance.

order_byoptional
querystring<json>optional

JSON query object for filtering results. Supports MongoDB-style operators.

Supported operators:
- equals or direct value - Exact match (default)
- gte - Greater than or equal
- lte - Less than or equal
- gt - Greater than
- lt - Less than
- in - Value in array
- notIn - Value not in array
- contains - String contains (case-insensitive)
- startsWith - String starts with
- endsWith - String ends with
- between - Value between two numbers/dates [min, max]

Allowed fields: id, status, source, source_id, customer_name, customer_email, payment_status, order_integration_id, created_at, updated_at

Examples:
- {"total": {"gte": 1000}} - Invoices over 1000
- {"customer.name": {"contains": "Acme"}} - Customer name contains "Acme"
- {"date": {"between": ["2025-01-01", "2025-12-31"]}} - Date range

searchstringoptional

Full-text search query to filter results across multiple fields.
Searches are case-insensitive and match partial strings.
Searches across all text fields including names, descriptions, addresses, and metadata values.

deletedbooleanoptional

When true, returns only soft-deleted (trashed) items. Default false excludes deleted items.

curl "https://eu.spaceinvoices.com/orders" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"
Response

Returns

dataarray of objects
paginationobject

Pagination metadata including cursors and result counts

json
{
  "data": [
    {
      "id": "ord_6595a27b5d35015c3ef0c3fd",
      "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
      "order_integration_id": "oint_6595a27b5d35015c3ef0c3fd",
      "source": "manual",
      "source_id": "manual-001",
      "source_order_number": null,
      "status": "pending",
      "paid": false,
      "paid_at": null,
      "fulfilled": false,
      "fulfilled_at": null,
      "cancelled": false,
      "cancelled_at": null,
      "refunded": false,
      "refunded_at": null,
      "customer_name": null,
      "customer_email": null,
      "customer": null,
      "billing_address": null,
      "shipping_address": null,
      "customer_id": null,
      "currency_code": "EUR",
      "total": 100,
      "total_with_tax": 122,
      "total_discount": 0,
      "total_shipping": 0,
      "items": [
        {
          "name": "Widget Pro",
          "quantity": 2,
          "price": 50,
          "gross_price": 61,
          "total": 100,
          "total_with_tax": 122,
          "tax_rate": 22
        }
      ],
      "payment_status": "unpaid",
      "payment_method": null,
      "payment_gateway": null,
      "invoice_id": null,
      "estimate_id": null,
      "process_after": null,
      "transactions": [],
      "complete": false,
      "items_changed_after_processing": false,
      "raw_data": null,
      "source_event_id": null,
      "error": null,
      "ordered_at": null,
      "processed_at": null,
      "metadata": {},
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-09-01T00:00:00.000Z",
      "deleted_at": null
    }
  ],
  "pagination": {
    "total": 1,
    "next_cursor": null,
    "prev_cursor": null,
    "has_more": false
  }
}

Get order by ID

GET/orders/{id}

Retrieve a single order by its unique identifier.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstring<resource-id>required

Unique resource identifier

curl "https://eu.spaceinvoices.com/orders/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"
Response

Returns

idstring
Other parameters
entity_idstring
order_integration_idstring
sourcestring
source_idstring
source_order_numberstring
statusstring
paidboolean
paid_atstring<date-time>
fulfilledboolean
fulfilled_atstring<date-time>
cancelledboolean
cancelled_atstring<date-time>
refundedboolean
refunded_atstring<date-time>
customer_namestring
customer_emailstring
customerobject
billing_addressobject
shipping_addressobject
customer_idstring
currency_codestring
totalnumber
total_with_taxnumber
total_discountnumber
total_shippingnumber
itemsarray of objects
payment_statusstring
payment_methodstring
payment_gatewaystring
invoice_idstring
estimate_idstring
process_afterstring<date-time>
transactionsarray of objects
completeboolean
items_changed_after_processingboolean
raw_dataobject
source_event_idstring
errorstring
ordered_atstring<date-time>
processed_atstring<date-time>
metadata
deleted_atstring<date-time>
created_atstring<date-time>
updated_atstring<date-time>
json
{
  "id": "ord_6595a27b5d35015c3ef0c3fd",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "order_integration_id": "oint_6595a27b5d35015c3ef0c3fd",
  "source": "manual",
  "source_id": "manual-001",
  "source_order_number": null,
  "status": "pending",
  "paid": false,
  "paid_at": null,
  "fulfilled": false,
  "fulfilled_at": null,
  "cancelled": false,
  "cancelled_at": null,
  "refunded": false,
  "refunded_at": null,
  "customer_name": null,
  "customer_email": null,
  "customer": null,
  "billing_address": null,
  "shipping_address": null,
  "customer_id": null,
  "currency_code": "EUR",
  "total": 100,
  "total_with_tax": 122,
  "total_discount": 0,
  "total_shipping": 0,
  "items": [
    {
      "name": "Widget Pro",
      "quantity": 2,
      "price": 50,
      "gross_price": 61,
      "total": 100,
      "total_with_tax": 122,
      "tax_rate": 22
    }
  ],
  "payment_status": "unpaid",
  "payment_method": null,
  "payment_gateway": null,
  "invoice_id": null,
  "estimate_id": null,
  "process_after": null,
  "transactions": [],
  "complete": false,
  "items_changed_after_processing": false,
  "raw_data": null,
  "source_event_id": null,
  "error": null,
  "ordered_at": null,
  "processed_at": null,
  "metadata": {},
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-09-01T00:00:00.000Z",
  "deleted_at": null
}

Update an order

PATCH/orders/{id}

Update an existing order. Only the provided fields will be updated.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstring<resource-id>required

Unique resource identifier

Body parameters

source_order_numberstringoptional
customer_namestringoptional
customer_emailstringoptional
customerobjectoptional
billing_addressobjectoptional
shipping_addressobjectoptional
currency_codestringoptional
totalnumberoptional
total_with_taxnumberoptional
total_discountnumberoptional
total_shippingnumberoptional
itemsarray of objectsoptional
payment_statusstringoptional
payment_methodstringoptional
payment_gatewaystringoptional
ordered_atstring<date-time>optional
metadataobjectoptional
curl -X PATCH "https://eu.spaceinvoices.com/orders/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_name": "Updated Customer Name",
    "customer_email": "updated@example.com"
  }'
Response

Returns

idstring
Other parameters
entity_idstring
order_integration_idstring
sourcestring
source_idstring
source_order_numberstring
statusstring
paidboolean
paid_atstring<date-time>
fulfilledboolean
fulfilled_atstring<date-time>
cancelledboolean
cancelled_atstring<date-time>
refundedboolean
refunded_atstring<date-time>
customer_namestring
customer_emailstring
customerobject
billing_addressobject
shipping_addressobject
customer_idstring
currency_codestring
totalnumber
total_with_taxnumber
total_discountnumber
total_shippingnumber
itemsarray of objects
payment_statusstring
payment_methodstring
payment_gatewaystring
invoice_idstring
estimate_idstring
process_afterstring<date-time>
transactionsarray of objects
completeboolean
items_changed_after_processingboolean
raw_dataobject
source_event_idstring
errorstring
ordered_atstring<date-time>
processed_atstring<date-time>
metadata
deleted_atstring<date-time>
created_atstring<date-time>
updated_atstring<date-time>
json
{
  "id": "ord_6595a27b5d35015c3ef0c3fd",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "order_integration_id": "oint_6595a27b5d35015c3ef0c3fd",
  "source": "manual",
  "source_id": "manual-001",
  "source_order_number": null,
  "status": "pending",
  "paid": false,
  "paid_at": null,
  "fulfilled": false,
  "fulfilled_at": null,
  "cancelled": false,
  "cancelled_at": null,
  "refunded": false,
  "refunded_at": null,
  "customer_name": null,
  "customer_email": null,
  "customer": null,
  "billing_address": null,
  "shipping_address": null,
  "customer_id": null,
  "currency_code": "EUR",
  "total": 100,
  "total_with_tax": 122,
  "total_discount": 0,
  "total_shipping": 0,
  "items": [
    {
      "name": "Widget Pro",
      "quantity": 2,
      "price": 50,
      "gross_price": 61,
      "total": 100,
      "total_with_tax": 122,
      "tax_rate": 22
    }
  ],
  "payment_status": "unpaid",
  "payment_method": null,
  "payment_gateway": null,
  "invoice_id": null,
  "estimate_id": null,
  "process_after": null,
  "transactions": [],
  "complete": false,
  "items_changed_after_processing": false,
  "raw_data": null,
  "source_event_id": null,
  "error": null,
  "ordered_at": null,
  "processed_at": null,
  "metadata": {},
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-09-01T00:00:00.000Z",
  "deleted_at": null
}

Delete an order

DELETE/orders/{id}

Soft delete an order by its unique identifier.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstring<resource-id>required

Unique resource identifier

curl -X DELETE "https://eu.spaceinvoices.com/orders/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Process an order into an invoice

POST/orders/{id}/process

Process a pending order: resolve or create customer, generate invoice, and optionally record payment.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstring<resource-id>required

Unique resource identifier

curl -X POST "https://eu.spaceinvoices.com/orders/{id}/process" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"
Response

Returns

idstring
Other parameters
entity_idstring
order_integration_idstring
sourcestring
source_idstring
source_order_numberstring
statusstring
paidboolean
paid_atstring<date-time>
fulfilledboolean
fulfilled_atstring<date-time>
cancelledboolean
cancelled_atstring<date-time>
refundedboolean
refunded_atstring<date-time>
customer_namestring
customer_emailstring
customerobject
billing_addressobject
shipping_addressobject
customer_idstring
currency_codestring
totalnumber
total_with_taxnumber
total_discountnumber
total_shippingnumber
itemsarray of objects
payment_statusstring
payment_methodstring
payment_gatewaystring
invoice_idstring
estimate_idstring
process_afterstring<date-time>
transactionsarray of objects
completeboolean
items_changed_after_processingboolean
raw_dataobject
source_event_idstring
errorstring
ordered_atstring<date-time>
processed_atstring<date-time>
metadata
deleted_atstring<date-time>
created_atstring<date-time>
updated_atstring<date-time>
json
{
  "id": "ord_6595a27b5d35015c3ef0c3fd",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "order_integration_id": "oint_6595a27b5d35015c3ef0c3fd",
  "source": "manual",
  "source_id": "manual-001",
  "source_order_number": null,
  "status": "invoiced",
  "paid": false,
  "paid_at": null,
  "fulfilled": false,
  "fulfilled_at": null,
  "cancelled": false,
  "cancelled_at": null,
  "refunded": false,
  "refunded_at": null,
  "customer_name": null,
  "customer_email": null,
  "customer": null,
  "billing_address": null,
  "shipping_address": null,
  "customer_id": null,
  "currency_code": "EUR",
  "total": 100,
  "total_with_tax": 122,
  "total_discount": 0,
  "total_shipping": 0,
  "items": [
    {
      "name": "Widget Pro",
      "quantity": 2,
      "price": 50,
      "gross_price": 61,
      "total": 100,
      "total_with_tax": 122,
      "tax_rate": 22
    }
  ],
  "payment_status": "unpaid",
  "payment_method": null,
  "payment_gateway": null,
  "invoice_id": "inv_7595a27b5d35015c3ef0c3fe",
  "estimate_id": null,
  "process_after": null,
  "transactions": [],
  "complete": false,
  "items_changed_after_processing": false,
  "raw_data": null,
  "source_event_id": null,
  "error": null,
  "ordered_at": null,
  "processed_at": "2024-01-15T12:00:00.000Z",
  "metadata": {},
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-09-01T00:00:00.000Z",
  "deleted_at": null
}

Cancel an order

POST/orders/{id}/cancel

Cancel a pending order. Already invoiced orders cannot be cancelled.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstring<resource-id>required

Unique resource identifier

curl -X POST "https://eu.spaceinvoices.com/orders/{id}/cancel" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"
Response

Returns

idstring
Other parameters
entity_idstring
order_integration_idstring
sourcestring
source_idstring
source_order_numberstring
statusstring
paidboolean
paid_atstring<date-time>
fulfilledboolean
fulfilled_atstring<date-time>
cancelledboolean
cancelled_atstring<date-time>
refundedboolean
refunded_atstring<date-time>
customer_namestring
customer_emailstring
customerobject
billing_addressobject
shipping_addressobject
customer_idstring
currency_codestring
totalnumber
total_with_taxnumber
total_discountnumber
total_shippingnumber
itemsarray of objects
payment_statusstring
payment_methodstring
payment_gatewaystring
invoice_idstring
estimate_idstring
process_afterstring<date-time>
transactionsarray of objects
completeboolean
items_changed_after_processingboolean
raw_dataobject
source_event_idstring
errorstring
ordered_atstring<date-time>
processed_atstring<date-time>
metadata
deleted_atstring<date-time>
created_atstring<date-time>
updated_atstring<date-time>
json
{
  "id": "ord_6595a27b5d35015c3ef0c3fd",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "order_integration_id": "oint_6595a27b5d35015c3ef0c3fd",
  "source": "manual",
  "source_id": "manual-001",
  "source_order_number": null,
  "status": "cancelled",
  "paid": false,
  "paid_at": null,
  "fulfilled": false,
  "fulfilled_at": null,
  "cancelled": true,
  "cancelled_at": "2024-01-15T12:00:00.000Z",
  "refunded": false,
  "refunded_at": null,
  "customer_name": null,
  "customer_email": null,
  "customer": null,
  "billing_address": null,
  "shipping_address": null,
  "customer_id": null,
  "currency_code": "EUR",
  "total": 100,
  "total_with_tax": 122,
  "total_discount": 0,
  "total_shipping": 0,
  "items": [
    {
      "name": "Widget Pro",
      "quantity": 2,
      "price": 50,
      "gross_price": 61,
      "total": 100,
      "total_with_tax": 122,
      "tax_rate": 22
    }
  ],
  "payment_status": "unpaid",
  "payment_method": null,
  "payment_gateway": null,
  "invoice_id": null,
  "estimate_id": null,
  "process_after": null,
  "transactions": [],
  "complete": false,
  "items_changed_after_processing": false,
  "raw_data": null,
  "source_event_id": null,
  "error": null,
  "ordered_at": null,
  "processed_at": null,
  "metadata": {},
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-09-01T00:00:00.000Z",
  "deleted_at": null
}

Reissue an order invoice

POST/orders/{id}/reissue

Credit the existing invoice and create a new one with current order items. Only available when order items have changed after initial processing.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstring<resource-id>required

Unique resource identifier

curl -X POST "https://eu.spaceinvoices.com/orders/{id}/reissue" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"
Response

Returns

idstring
Other parameters
entity_idstring
order_integration_idstring
sourcestring
source_idstring
source_order_numberstring
statusstring
paidboolean
paid_atstring<date-time>
fulfilledboolean
fulfilled_atstring<date-time>
cancelledboolean
cancelled_atstring<date-time>
refundedboolean
refunded_atstring<date-time>
customer_namestring
customer_emailstring
customerobject
billing_addressobject
shipping_addressobject
customer_idstring
currency_codestring
totalnumber
total_with_taxnumber
total_discountnumber
total_shippingnumber
itemsarray of objects
payment_statusstring
payment_methodstring
payment_gatewaystring
invoice_idstring
estimate_idstring
process_afterstring<date-time>
transactionsarray of objects
completeboolean
items_changed_after_processingboolean
raw_dataobject
source_event_idstring
errorstring
ordered_atstring<date-time>
processed_atstring<date-time>
metadata
deleted_atstring<date-time>
created_atstring<date-time>
updated_atstring<date-time>
json
{
  "id": "ord_6595a27b5d35015c3ef0c3fd",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "order_integration_id": "oint_6595a27b5d35015c3ef0c3fd",
  "source": "manual",
  "source_id": "manual-001",
  "source_order_number": null,
  "status": "invoiced",
  "paid": false,
  "paid_at": null,
  "fulfilled": false,
  "fulfilled_at": null,
  "cancelled": false,
  "cancelled_at": null,
  "refunded": false,
  "refunded_at": null,
  "customer_name": null,
  "customer_email": null,
  "customer": null,
  "billing_address": null,
  "shipping_address": null,
  "customer_id": null,
  "currency_code": "EUR",
  "total": 100,
  "total_with_tax": 122,
  "total_discount": 0,
  "total_shipping": 0,
  "items": [
    {
      "name": "Widget Pro",
      "quantity": 2,
      "price": 50,
      "gross_price": 61,
      "total": 100,
      "total_with_tax": 122,
      "tax_rate": 22
    }
  ],
  "payment_status": "unpaid",
  "payment_method": null,
  "payment_gateway": null,
  "invoice_id": "inv_8595a27b5d35015c3ef0c3ff",
  "estimate_id": null,
  "process_after": null,
  "transactions": [],
  "complete": false,
  "items_changed_after_processing": false,
  "raw_data": null,
  "source_event_id": null,
  "error": null,
  "ordered_at": null,
  "processed_at": "2024-01-16T12:00:00.000Z",
  "metadata": {},
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-09-01T00:00:00.000Z",
  "deleted_at": null
}