Deliverables
List deliverables
Find order deliverables and their current availability.
/api/v1/orders/deliverables/list- Authentication
- OAuth 2.0 access token
- Required scopes
deliverables.read- Idempotency key
- Not required
- Rate-limit cost
- 1 unit
How to use this endpoint
Provide filer_id when the connection is limited to selected filers. Follow the returned cursor to continue the list.
curl --request GET 'https://api.efilemagic.com/api/v1/orders/deliverables/list' \
--header 'Authorization: Bearer <access-token>' \
--get \
--data-urlencode 'limit=25'Replace placeholders with your own values. Use the API resource origin provided for your environment.
Request fields
8 fieldsquery.filer_idOptionalstring (uuid)
ID of the filer that owns this operation's records.
query.qOptionalstring
Search text used to filter this collection. Maximum characters: 256.
query.service_codeOptionalstring
Service whose deliverable you want to read or request. Allowed values: "efile", "e_delivery", "state_efile", "print_mail", "irs_spec_file".
query.statusOptionalstring
Allowed values: "snapshot_pending", "materializing", "ready", "failed", "canceled".
query.sort_byOptionalstring
Field used to order results. Allowed values: "updated_at", "relevance".
query.sort_orderOptionalstring
Ascending or descending result order. Allowed values: "asc", "desc".
query.limitOptionalinteger
Maximum number of results requested for this page. Minimum: 1. Maximum: 100.
query.cursorOptionalstring
Opaque next_cursor from the previous page. Keep the other filters unchanged. Minimum characters: 1. Maximum characters: 2048.
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.
curl --request GET 'https://api.efilemagic.com/api/v1/orders/deliverables/list' \
--header 'Authorization: Bearer <access-token>' \
--get \
--data-urlencode 'limit=25'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
3 fieldsitemsAlways returnedarray<object>
Maximum items: 100.
Nested fields (14)
created_atAlways returnedstring (date-time)
Type: string (date-time).
filer_idAlways returnedstring (uuid)
Type: string (uuid).
filer_nameMay be omittedstring | null
Maximum characters: 512.
group_countAlways returnedinteger
Minimum: 0.
last_errorMay be omittedstring | null
Maximum characters: 2048.
materialization_statusAlways returnedstring
Allowed values: "snapshot_pending", "materializing", "ready", "failed", "canceled".
order_idAlways returnedstring (uuid)
Type: string (uuid).
public_order_refMay be omittedstring | null
Maximum characters: 128.
recipient_countAlways returnedinteger
Minimum: 0.
record_countAlways returnedinteger
Minimum: 0.
service_codeAlways returnedstring
Allowed values: "efile", "e_delivery", "state_efile", "print_mail", "irs_spec_file".
service_nameAlways returnedstring
Minimum characters: 1. Maximum characters: 128.
tax_yearAlways returnedinteger
Allowed values: 2022, 2023, 2024, 2025, 2026.
updated_atAlways returnedstring (date-time)
Type: string (date-time).
next_cursorMay be omittedstring | null
Maximum characters: 4096.
total_countMay be omittedinteger | null
Minimum: 0.
{
"data": {
"items": [],
"next_cursor": null,
"total_count": null
},
"meta": {
"api_version": "v1",
"request_id": "example-request-id"
}
}No matching records. Synthetic empty-page example. Follow a non-null next_cursor even when items is empty. A null total_count means no count was supplied.
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.