Pular para o conteúdo
GoBots Open API

Read one write action

GET
/v1/ads/{marketplace}/actions/{action_id}
curl --request GET \
  --url https://open-api.live.gobots.com.br/v1/ads/meli/actions/example \
  --header 'Authorization: Bearer <token>'

The poll target of every 202. It does not count toward the monthly quota and is never cached. An action of another merchant, an unknown id and a malformed id all answer the same 404.

Authorizations

Seção intitulada “Authorizations”

Parameters

Seção intitulada “Parameters”

Path Parameters

Seção intitulada “Path Parameters”
marketplace
required
string
Allowed values: meli amazon magalu shopee viavarejo b2w whatsapp qa tiktok

Marketplace of the Ads account. Only meli has an adapter in v1; the others answer 501.

action_id
required
string
/^act_[0-9A-HJKMNP-TV-Z]{26}$/

The meta.action_id a write answered. Another merchant’s action answers 404.

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

The action and its current state.

Media typeapplication/json
object
action
required
object
id
required
string
/^act_[0-9A-HJKMNP-TV-Z]{26}$/
marketplace
required
string
Allowed values: meli amazon magalu shopee viavarejo b2w whatsapp qa tiktok
status
required

The state of an action. applied, partially_applied, failed and dismissed are terminal.

string
Allowed values: awaiting_confirmation pending reconciling unknown applied partially_applied failed dismissed
source
required
string
Allowed values: rest mcp panel
route
required
string
Allowed values: campaign_update ad_group_update ad_group_pause opportunity_flags opportunity_apply opportunities_apply
api_key_id
required
string
oauth_token_id
required
string | null
tool
required
string | null
resource
required
object
type
required
string
Allowed values: campaign ad_group opportunity opportunity_batch
id
required
string | null
campaign_id
required
string | null
before
required

The fields an action changed, as values; nothing the marketplace said is ever kept.

object
name
string
status
string
budget
object
amount
string
strategy
object
roas_target
string
favorite
boolean
hidden
boolean
dismiss
boolean
feedback
object
useful
boolean
comment
string
ad_group_ids
Array<string>
item_ids
Array<string>
opportunity_ids
Array<string>
after
required

The fields an action changed, as values; nothing the marketplace said is ever kept.

object
name
string
status
string
budget
object
amount
string
strategy
object
roas_target
string
favorite
boolean
hidden
boolean
dismiss
boolean
feedback
object
useful
boolean
comment
string
ad_group_ids
Array<string>
item_ids
Array<string>
opportunity_ids
Array<string>
idempotency_key
required
string
result
required
One of:
object
status
required

The state of an action. applied, partially_applied, failed and dismissed are terminal.

string
Allowed values: awaiting_confirmation pending reconciling unknown applied partially_applied failed dismissed
reason

A closed code, never free text. outcome_unknown means the marketplace’s answer could not be read and the change must be verified by hand.

string
Allowed values: budget_below_minimum budget_above_maximum campaign_ended invalid_roas_target advertiser_suspended campaign_not_editable ad_group_not_found opportunity_not_found opportunity_not_applicable opportunity_locked not_found unmapped origin_misconfigured origin_overloaded origin_rejected_request origin_protocol_error outcome_unknown not_dispatched
applied_as

Present when an opportunity that proposed removing an ad was applied as a pause.

string
Allowed values: pause
details
required

One entry per requested target on a batch; the targets that failed on partially_applied.

Array<object>
object
target_type
required
string
Allowed values: campaign ad_group opportunity
target_id
required
string
status
required
string
Allowed values: applied failed pending
reason

A closed code, never free text. outcome_unknown means the marketplace’s answer could not be read and the change must be verified by hand.

string
Allowed values: budget_below_minimum budget_above_maximum campaign_ended invalid_roas_target advertiser_suspended campaign_not_editable ad_group_not_found opportunity_not_found opportunity_not_applicable opportunity_locked not_found unmapped origin_misconfigured origin_overloaded origin_rejected_request origin_protocol_error outcome_unknown not_dispatched
created_at
required
string format: date-time
updated_at
required
string format: date-time
settled_at
required
string | null format: date-time
confirmation_expires_at
required
string | null format: date-time
meta
required
object

Example 

{
  "action": {
    "marketplace": "meli",
    "status": "awaiting_confirmation",
    "source": "rest",
    "route": "campaign_update",
    "resource": {
      "type": "campaign"
    },
    "result": {
      "status": "awaiting_confirmation",
      "reason": "budget_below_minimum",
      "applied_as": "pause",
      "details": [
        {
          "target_type": "campaign",
          "status": "applied",
          "reason": "budget_below_minimum"
        }
      ]
    }
  }
}

Headers

Seção intitulada “Headers”
RateLimit-Policy
required
string

The policies that apply to this endpoint group, as draft-ietf-httpapi-ratelimit-headers policy members: "<group>";q=<quota>;w=<window seconds>.

RateLimit
required
string

The state of the endpoint group’s window: "<group>";r=<remaining>;t=<seconds to reset>.

401

Seção intitulada “401”

The API key is missing, malformed, unknown, revoked or expired.

Media typeapplication/json
object
code
required

Stable machine readable error code.

string
message
required

Human readable explanation. Never carries raw upstream text.

string
retry_after

Seconds to wait before retrying.

integer
limit

Limit that was exceeded.

integer
remaining

Remaining allowance in the current window.

integer

Example generated

{
  "code": "example",
  "message": "example",
  "retry_after": 1,
  "limit": 1,
  "remaining": 1
}

Headers

Seção intitulada “Headers”
WWW-Authenticate
string

Bearer challenge for the API realm.

403

Seção intitulada “403”

The merchant does not have the Open API add-on active.

Media typeapplication/json
object
code
required

Stable machine readable error code.

string
message
required

Human readable explanation. Never carries raw upstream text.

string
retry_after

Seconds to wait before retrying.

integer
limit

Limit that was exceeded.

integer
remaining

Remaining allowance in the current window.

integer

Example generated

{
  "code": "example",
  "message": "example",
  "retry_after": 1,
  "limit": 1,
  "remaining": 1
}

404

Seção intitulada “404”

The resource, or a requested store, is not this merchant’s or does not exist; the two are indistinguishable.

Media typeapplication/json
object
code
required

Stable machine readable error code.

string
message
required

Human readable explanation. Never carries raw upstream text.

string
retry_after

Seconds to wait before retrying.

integer
limit

Limit that was exceeded.

integer
remaining

Remaining allowance in the current window.

integer

Example generated

{
  "code": "example",
  "message": "example",
  "retry_after": 1,
  "limit": 1,
  "remaining": 1
}

Headers

Seção intitulada “Headers”
RateLimit-Policy
required
string

The policies that apply to this endpoint group, as draft-ietf-httpapi-ratelimit-headers policy members: "<group>";q=<quota>;w=<window seconds>.

RateLimit
required
string

The state of the endpoint group’s window: "<group>";r=<remaining>;t=<seconds to reset>.

429

Seção intitulada “429”

The requests-per-minute limit of the endpoint group was exceeded (rate_limited), or the monthly request quota of the merchant is exhausted (quota_exceeded).

Media typeapplication/json
object
code
required

Stable machine readable error code.

string
message
required

Human readable explanation. Never carries raw upstream text.

string
retry_after

Seconds to wait before retrying.

integer
limit

Limit that was exceeded.

integer
remaining

Remaining allowance in the current window.

integer

Example generated

{
  "code": "example",
  "message": "example",
  "retry_after": 1,
  "limit": 1,
  "remaining": 1
}

Headers

Seção intitulada “Headers”
RateLimit-Policy
required
string

The policies that apply to this endpoint group, as draft-ietf-httpapi-ratelimit-headers policy members: "<group>";q=<quota>;w=<window seconds>.

RateLimit
required
string

The state of the endpoint group’s window: "<group>";r=<remaining>;t=<seconds to reset>.

Retry-After
required
integer

Seconds to wait before retrying, per RFC 9110.

503

Seção intitulada “503”

The upstream source is unavailable. When the merchant’s entitlement could not be resolved the request is refused before rate limiting, so the RateLimit headers are absent.

Media typeapplication/json
object
code
required

Stable machine readable error code.

string
message
required

Human readable explanation. Never carries raw upstream text.

string
retry_after

Seconds to wait before retrying.

integer
limit

Limit that was exceeded.

integer
remaining

Remaining allowance in the current window.

integer

Example generated

{
  "code": "example",
  "message": "example",
  "retry_after": 1,
  "limit": 1,
  "remaining": 1
}

Headers

Seção intitulada “Headers”
RateLimit-Policy
string

As the RateLimit-Policy response header; absent when entitlement could not be resolved.

RateLimit
string

As the RateLimit response header; absent when entitlement could not be resolved.