Get all Budget Orders
Fetches all assigned budget orders for an organization.
URL
GET https://api.searchads.apple.com/api/v5/budgetordersQuery Parameters
| Name | Type | Description |
|---|---|---|
limit Optional | int32 | The number of items to return per request. The maximum is 1000 for most objects. |
offset Optional | int32 | The offset pagination that limits the number of returned records. The start of each page is offset by the specified number. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | BudgetOrderInfoListResponse | If the call succeeds, the API returns the BudgetOrderInfoResponse object in the response payload with an HTTP status code of |
| 400 | Bad Request Content-Type: application/json | ApiErrorResponse | An invalid query or missing required parameters. |
| 401 | Unauthorized Content-Type: application/json | ApiErrorResponse | An unauthenticated call fails to get the requested response. |
| 403 | Forbidden Content-Type: application/json | ApiErrorResponse | Insufficient rights to the resource. |
| 404 | Not Found Content-Type: application/json | ApiErrorResponse | The API can’t locate the resource. |
| 429 | Content-Type: application/json | ApiErrorResponse | The API calls exceed rate-limit thresholds. See the Rate Limits subsection of Calling the Apple Ads API. |
| 500 | Internal Server Error Content-Type: application/json | ApiErrorResponse | The Apple Ads server is temporarily down or unreachable. The request may be valid, but you need to retry it later. |
Discussion
This call retrieves all assigned budget orders for your organization. It also returns completed and canceled orders. Budget orders also return when you use the Create a Campaign or Update a Campaign endpoints.
You can’t set budget order invoicing through the API. You can only fetch a budget order using Get a Budget Order or the Get all Budget Orders API call.