Get a Budget Order
Fetches a specific budget order using a budget order identifier.
URL
GET https://api.searchads.apple.com/api/v5/budgetorders/{boId}Path Parameters
| Name | Type | Description |
|---|---|---|
boId Required | int64 | The unique identifier for the budget order. You set the |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | BudgetOrderInfoResponse | 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
When you create a budget order through Apple Ads Advanced, the system returns a budget order ID (boId) that you can use with to return details of a specific budget order for an organization or campaign group. Through the API, you can only fetch a budget order using Get a Budget Order or Get all Budget Orders.
This call retrieves a specific assigned budget order 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.