List the marketplace stores of the merchant

GET

/v1/stores

curl --request GET \
  --url 'https://open-api.live.gobots.com.br/v1/stores?marketplace=meli' \
  --header 'Authorization: Bearer <token>'

Returns the stores the merchant operates, optionally narrowed to one marketplace.

Authorizations

• ApiKey

Parameters

Query Parameters

marketplace

string

Allowed values: meli amazon magalu shopee viavarejo b2w whatsapp qa tiktok

Narrows the list to one marketplace.

Responses

200

The stores of the merchant.

Media typeapplication/json

object

stores

required

Array<object>

object

id

required

Opaque, stable identifier assigned by GoBots. Treat it as a string; its structure is not part of this contract.

string

marketplace

required

string

Allowed values: meli amazon magalu shopee viavarejo b2w whatsapp qa tiktok

label

required

string

country

required

ISO 3166-1 alpha-2, uppercase.

string

>= 2 characters <= 2 characters

currency

required

ISO 4217, uppercase.

string

>= 3 characters <= 3 characters

status

required

string

Allowed values: active inactive

meta

required

object

next_cursor

required

Cursor of the next page, or null when the collection ends here.

string | null

status

string

Allowed values: partial

warnings

Array<string>

Example

{
  "stores": [
    {
      "marketplace": "meli",
      "status": "active"
    }
  ],
  "meta": {
    "status": "partial"
  }
}

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>.

400

A query parameter carries a value the contract does not accept.

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

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

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

WWW-Authenticate

string

Bearer challenge for the API realm.

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
}

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

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

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

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.