Skip to content
トレカクラウド
Esc
↑↓navigate↵open⌘Jpreview

List buy boosts

Returns the buy boosts that are open now, highest boosted price first. Boosts that have not started, are paused, ended or expired are left out.

The member who approved the connection needs the purchases.read permission in the shop.

GET/purchase-boosts
Authorization
AuthorizationOAuth2 access token · headerrequired

Authorization code flow (PKCE S256 required). Send resource=https://api.toreca-cloud.com/partner/v1 with the authorization, token and refresh requests. Access tokens last 15 minutes; refresh tokens last 90 days and rotate on every refresh.

Scopes:purchase-boosts:read
Query parameters
includestring

filled also returns boosts with none left, as status: "filled".

default: "open"
Allowed:openfilled
Responses
200

The buy boosts

boostsPurchaseBoost[]required
Show properties
Array of PurchaseBoost
idstring<uuid>required
targetobjectrequired
Show properties
One of:
object
kindstringrequired
cardBoostCardrequired

The card

Show properties
idstring<uuid>
namestring
localizedNamesobject
cardNumberstring | null
setTotalRawstring | null
languageCodestring
imageUrlstring<uri> | null
rarityobject | null
Show properties
codestring
namestring
setobject | null
Show properties
idstring<uuid>
codestring
namestring
gameGame
Show properties
idstring<uuid>
codestring
namestring
gradeGrade | nullrequired

The grade. null means any grade.

Show properties
One of:
Grade
idstring<uuid>
codestring
labelstring

Display name (e.g. PSA 10)

serviceCodestring
serviceNamestring
serviceKindstring

third_party is a grading service, internal the shop's own condition rank

Allowed:third_partyinternal
null
null
object
kindstringrequired
productBoostProductrequired

The BOX, pack or deck

Show properties
idstring<uuid>
namestring
productKindstring

box, pack, deck and so on

janCodestring | null
languageCodestring
imageUrlstring<uri> | null
gameGame
Show properties
idstring<uuid>
codestring
namestring
priceMinorintegerrequired

Boosted price per piece, in the currency's minor unit (whole yen for JPY)

currencystringrequired

ISO 4217 (e.g. JPY)

remainingQuantityinteger | nullrequired

How many more the shop will buy. null means no limit.

min 0
statusstringrequired

filled appears only with include=filled.

Allowed:openfilled
startsAtstring<date-time> | nullrequired

When the boost starts. null means not set.

endsAtstring<date-time> | nullrequired

When the boost ends; it closes at this instant. null means not set.

notestring | nullrequired

A line the shop wrote for landing pages and posts (up to 200 characters)

updatedAtstring<date-time>required
generatedAtstring<date-time>required

When the list was made

400

invalid_request: a parameter is invalid.

errorstringrequired

The error code

scopestring

With insufficient_scope, the missing scope

401

invalid_token: the token is missing, expired, or for another resource.

errorstringrequired

The error code

scopestring

With insufficient_scope, the missing scope

403

One of insufficient_scope, connection_revoked, client_disabled or forbidden.

errorstringrequired

The error code

scopestring

With insufficient_scope, the missing scope

Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.toreca-cloud.com/partner/v1/purchase-boosts' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Response
{
  "boosts": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "target": {
        "kind": "card",
        "card": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "localizedNames": {
            "property1": "string",
            "property2": "string"
          },
          "cardNumber": "string",
          "setTotalRaw": "string",
          "languageCode": "string",
          "imageUrl": "http://example.com",
          "rarity": {
            "code": "string",
            "name": "string"
          },
          "set": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "code": "string",
            "name": "string"
          },
          "game": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "code": "string",
            "name": "string"
          }
        },
        "grade": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "code": "string",
          "label": "string",
          "serviceCode": "string",
          "serviceName": "string",
          "serviceKind": "third_party"
        }
      },
      "priceMinor": 0,
      "currency": "string",
      "remainingQuantity": 0,
      "status": "open",
      "startsAt": "2019-08-24T14:15:22Z",
      "endsAt": "2019-08-24T14:15:22Z",
      "note": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "generatedAt": "2019-08-24T14:15:22Z"
}