POST /v1/orders/:id/claim — забрать заказ из холда

POST

orders

{id}

claim

Claim a held order

curl --request POST \
  --url https://csboard.com/v1/orders/{id}/claim \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://csboard.com/v1/orders/{id}/claim', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://csboard.com/v1/orders/{id}/claim",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://csboard.com/v1/orders/{id}/claim"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://csboard.com/v1/orders/{id}/claim")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "order_id": "ord_01J9Z3K8Q2",
  "status": "delivering",
  "claimed": true,
  "steam_trade_offer_id": "5512345678"
}

Часть заказов попадает в состояние холда: предмет находится под эскроу-блокировкой маркетплейса и не может быть доставлен, пока блокировка не снята. Заказ в холде виден как status: "hold" с меткой hold_until в GET /v1/orders и GET /v1/orders/{id}. После того как hold_until прошёл:

Часть заказов доставляется автоматически — делать ничего не нужно, вызов этого эндпоинта вернёт claimed: false (безвредный no-op).
Часть заказов нужно забрать вручную (claim) — вызываете этот эндпоинт, чтобы запустить трейд. Без claim они остаются в холде бесконечно.

Снаружи отличить одно от другого нельзя, поэтому безопасный паттерн: после hold_until вызвать claim один раз. Если заказ был авто-типа — получите no-op; если требовал claim — он запустится.

Не хотите поллить и клеймить каждый заказ? Включите на уровне аккаунта флаг autoclaim в true — и каждый заказ из холда будет забираться автоматически в момент снятия блокировки, без вызовов claim.

Ответы кратко

Статус	Значение
`200` `claimed: true`	Трейд запущен, возвращён `steam_trade_offer_id`. Принять за ~15 мин.
`200` `claimed: false`	Заказ доставляется автоматически, делать ничего не нужно.
`409 not_claimable`	Заказ не в состоянии холда (уже доставляется/завершён/провален).
`425 hold_not_cleared`	Ещё внутри окна холда — повторить после возвращённого `hold_until`.
`502 delivery_failed`	Маркетплейс отклонил запуск. Если холд отменён на стороне маркета — `refunded: true`.
`404 order_not_found`	Такого заказа на этом аккаунте нет.

Claim идемпотентен, пока запуск в процессе — повторный вызов вернёт конфликт, а не двойную доставку. Ретрай после сетевого таймаута безопасен.

Авторизации

Authorization

string

header

обязательно

Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile.

Параметры пути

string

обязательно

CSBoard order id of the held order to claim.

Ответ

Claim accepted. claimed: true means the trade was released now; claimed: false means this order delivers automatically and no action was needed.

order_id

string

обязательно

status

enum<string>

обязательно

Доступные опции:

delivering,

hold

claimed

boolean

обязательно

steam_trade_offer_id

string | null

Present when claimed just released a trade offer.

detail

string

Present on the auto-delivering no-op case.

Claim a held order

curl --request POST \
  --url https://csboard.com/v1/orders/{id}/claim \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://csboard.com/v1/orders/{id}/claim', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://csboard.com/v1/orders/{id}/claim",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://csboard.com/v1/orders/{id}/claim"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://csboard.com/v1/orders/{id}/claim")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "order_id": "ord_01J9Z3K8Q2",
  "status": "delivering",
  "claimed": true,
  "steam_trade_offer_id": "5512345678"
}

Рыночные данные

Торговля

Аккаунт

Статус

POST /v1/orders/:id/claim — забрать заказ из холда

Рекомендуемый флоу

Ответы кратко

Авторизации

Параметры пути

Ответ

​Рекомендуемый флоу

​Ответы кратко

Авторизации

Параметры пути

Ответ

Рекомендуемый флоу

Ответы кратко