Skip to main content
POST
/
execution
/
sell
/
quote
/
v1
Create a sell quote
curl --request POST \
  --url https://api.collectpure.com/execution/sell/quote/v1 \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "items": [
    {
      "offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 500000
    }
  ],
  "selectedOptionalIds": [
    "<string>"
  ]
}
'
import requests

url = "https://api.collectpure.com/execution/sell/quote/v1"

payload = {
"items": [
{
"offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 500000
}
],
"selectedOptionalIds": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [{offerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', quantity: 500000}],
selectedOptionalIds: ['<string>']
})
};

fetch('https://api.collectpure.com/execution/sell/quote/v1', 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://api.collectpure.com/execution/sell/quote/v1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'offerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 500000
]
],
'selectedOptionalIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.collectpure.com/execution/sell/quote/v1"

payload := strings.NewReader("{\n \"items\": [\n {\n \"offerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 500000\n }\n ],\n \"selectedOptionalIds\": [\n \"<string>\"\n ]\n}")

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

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.collectpure.com/execution/sell/quote/v1")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"offerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 500000\n }\n ],\n \"selectedOptionalIds\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.collectpure.com/execution/sell/quote/v1")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"offerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 500000\n }\n ],\n \"selectedOptionalIds\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "quoteId": "<string>",
    "expiresAt": "<string>",
    "refreshedAt": "<string>",
    "lineItems": [
      {
        "id": "<string>",
        "quantity": 123,
        "price": 123,
        "status": "<string>",
        "disabled": true,
        "error": "<string>",
        "product": {
          "sku": "<string>",
          "title": "<string>",
          "fulfillmentDays": 123
        },
        "variant": {
          "title": "<string>"
        },
        "offer": {
          "id": "<string>",
          "productId": "<string>",
          "variantId": "<string>",
          "price": 123,
          "quantity": 123,
          "spotPremium": 123,
          "spotPremiumDollar": 123
        }
      }
    ],
    "fees": [
      {
        "id": "<string>",
        "label": "<string>",
        "amount": 123,
        "rate": 123
      }
    ],
    "optionals": [
      {
        "id": "<string>",
        "title": "<string>",
        "description": "<string>",
        "fee": 123,
        "selected": true,
        "enabled": true,
        "disabledReason": "<string>",
        "disclaimer": {
          "label": "<string>",
          "url": "<string>"
        }
      }
    ],
    "subtotal": 123,
    "total": 123
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication

Body

application/json
items
object[]
required

Items to include in the sell quote. Each item can specify an offerId or a productId+variantId pair.

Required array length: 1 - 50 elements
selectedOptionalIds
string[]

Optional IDs to select (e.g. instant payout). The quote will reflect fees for selected optionals.

Response

200 - application/json

Default Response

success
enum<boolean>
required
Available options:
true
data
object
required