Orders
Get multiple orders
Read the current status of several orders.
/api/v1/orders/get_many- Authentication
- OAuth 2.0 access token
- Required scopes
orders.read- Idempotency key
- Not required
- Rate-limit cost
- 1 unit
How to use this endpoint
Results keep the request order and report missing IDs separately. Use deliverable endpoints for downloadable files.
Invoice PDFs show the recorded card/ACH payment ending or approved A/R terms. Totals end Total, Paid, Balance Due; authorization alone is not payment. New invoice copies reflect confirmed payments. Historical originals remain unchanged; unavailable legacy payment-ending evidence does not prevent an invoice download.
The efile service is displayed as Combined Federal/State e-File (CF/SF). E-File Magic participates in the IRS CF/SF program for eligible filings. The API service_code remains efile; this display name does not change pricing or filing eligibility.
Customers can add Print & Mail or State Reporting File to an eligible existing order through Add services in the signed-in Dashboard or Order Tracking checkout. This is an interactive customer payment flow, not an External API mutation. Subsequent reads include the added services and updated totals on the same order; invoice payment labels reflect multiple payments without attributing the total to the original card.
Request example
curl --request POST 'https://api.efilemagic.com/api/v1/orders/get_many' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data '{"order_ids":["11111111-1111-4111-8111-111111111111"]}'Replace placeholders with your own values. Use the API resource origin provided for your environment.
Request fields
1 fieldsorder_idsRequiredarray<string (uuid)>
Order IDs to read in request order. Minimum items: 1. Maximum items: 100. Items must be unique.
Headers (2)
AuthorizationRequired- OAuth RS256 access token issued for the EFM API resource. Interactive EFM session tokens are rejected.
DPoPConditional / optional- Required when the application, connection, or credential is proof-of-possession bound.
Request example
curl --request POST 'https://api.efilemagic.com/api/v1/orders/get_many' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data '{"order_ids":["11111111-1111-4111-8111-111111111111"]}'Replace placeholders with your own values. Use the API resource origin provided for your environment.
On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.
Response fields
2 fieldsitemsAlways returnedarray<object>
Maximum items: 100.
Nested fields (4)
invoiceAlways returnedobject
Type: object.
orderAlways returnedobject
Unknown fields are rejected.
Nested fields (33)
balance_due_minorAlways returnedinteger
Minimum: 0.
created_atAlways returnedstring (date-time)
Type: string (date-time).
currencyAlways returned"USD"
Value: "USD".
customer_deposit_applied_minorAlways returnedinteger
Minimum: 0.
customer_deposit_reserved_minorAlways returnedinteger
Minimum: 0.
filer_idAlways returnedstring (uuid)
Type: string (uuid).
from_importAlways returnedboolean
Type: boolean.
fulfillment_statusAlways returnedstring
Type: string.
holdAlways returnedobject
Type: object.
import_run_idMay be omittedstring | null
Type: string | null.
import_sourceMay be omittedstring | null
Type: string | null.
imported_atMay be omittedstring (date-time) | null
Type: string (date-time) | null.
last_errorMay be omittedstring | null
Type: string | null.
order_idAlways returnedstring (uuid)
Type: string (uuid).
payment_due_minorAlways returnedinteger
Minimum: 0.
payment_statusAlways returnedstring
Type: string.
public_order_refMay be omittedstring | null
Type: string | null.
snapshot_chunk_completedAlways returnedinteger
Minimum: 0.
snapshot_chunk_totalAlways returnedinteger
Minimum: 0.
snapshot_copied_recipientsAlways returnedinteger
Minimum: 0.
snapshot_statusAlways returnedstring
Type: string.
snapshot_total_recipientsAlways returnedinteger
Minimum: 0.
source_digestMay be omittedstring | null
Type: string | null.
source_external_idMay be omittedstring | null
Type: string | null.
source_external_refMay be omittedstring | null
Type: string | null.
source_filing_systemMay be omittedstring | null
Type: string | null.
source_platformMay be omittedstring | null
Type: string | null.
statusAlways returnedstring
Type: string.
tax_yearMay be omittedinteger | null
Type: integer | null.
tenant_idAlways returnedstring (uuid)
Type: string (uuid).
total_minorAlways returnedinteger
Minimum: 0.
updated_atAlways returnedstring (date-time)
Type: string (date-time).
versionAlways returnedinteger
Minimum: 1.
order_confirmationAlways returnedobject
Type: object.
servicesAlways returnedarray<object>
Type: array<object>.
missingAlways returnedarray<string (uuid)>
Maximum items: 100.
{
"data": {
"items": "array<object>",
"missing": "array<string (uuid)>"
},
"meta": {
"api_version": "v1",
"request_id": "string"
}
}Successful response structure. This outline shows field types, not a response to copy. Expand Response fields for nested properties and optional values.
Errors to handle
Errors use {error: {code, message}, meta}. Check the code and message before retrying. Authentication, validation and availability errors can occur before the operation runs.
- 400
invalid_request - Check required fields, selectors and supported values.
- 401
invalid_token - Obtain a valid OAuth token for this resource. Check its expiry and current authorization.
- 403
insufficient_scope - Request the listed scopes through the application's authorization flow.
- 403
forbidden - Check the connection's permissions and allowed filers. More scopes alone may not grant access.
- 404
not_found - Check the resource ID and its owning filer. Batch reads report missing IDs as documented.
- 422
validation_failed - Correct the reported validation issues before retrying.
- 429
rate_limited - Wait for Retry-After before retrying. Avoid concurrent retries.
- 500
internal_error - Retain request_id; retry with bounded backoff.
- 503
service_unavailable - Retry with bounded backoff.