Skip to main content
GET
List order batches

Recover an order batch after an ambiguous response

If a create request times out, look up the batch using the same credentials and the nonblank customer_reference_id you supplied when creating it:
The filter matches the reference exactly and returns the normal paginated list response. Matching batches appear in data, including their id and send_status. Only batches accessible to those credentials are returned. If data is empty immediately after a timeout, the original request may still be processing. Check again before deciding to retry creation. Omitting customer_reference_id leaves the normal list behavior unchanged. An empty or whitespace-only string is still an exact filter; use the original nonblank reference for recovery. Arrays and objects are rejected with HTTP 400.

Authorizations

Authorization
string
header
required

Your Goody API key.

Query Parameters

page
integer
default:1

Page for pagination, starting at 1

Required range: x >= 1
per_page
integer
default:20

Items per page for pagination

Required range: 1 <= x <= 100
customer_reference_id
string

Exact customer reference ID to filter by

Response

Order batches retrieved

data
object[]
list_meta
object