Execute a buy order
curl --request POST \
--url https://api.collectpure.com/execution/buy/v1 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"quoteId": "<string>",
"expectedTotal": 4503599627370495,
"paymentMethod": "<string>",
"shipping": {
"name": "<string>",
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"line2": "<string>",
"phone": "<string>"
}
}
'import requests
url = "https://api.collectpure.com/execution/buy/v1"
payload = {
"quoteId": "<string>",
"expectedTotal": 4503599627370495,
"paymentMethod": "<string>",
"shipping": {
"name": "<string>",
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"line2": "<string>",
"phone": "<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({
quoteId: '<string>',
expectedTotal: 4503599627370495,
paymentMethod: '<string>',
shipping: {
name: '<string>',
line1: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
line2: '<string>',
phone: '<string>'
}
})
};
fetch('https://api.collectpure.com/execution/buy/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/buy/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([
'quoteId' => '<string>',
'expectedTotal' => 4503599627370495,
'paymentMethod' => '<string>',
'shipping' => [
'name' => '<string>',
'line1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'line2' => '<string>',
'phone' => '<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/buy/v1"
payload := strings.NewReader("{\n \"quoteId\": \"<string>\",\n \"expectedTotal\": 4503599627370495,\n \"paymentMethod\": \"<string>\",\n \"shipping\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"line2\": \"<string>\",\n \"phone\": \"<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/buy/v1")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"quoteId\": \"<string>\",\n \"expectedTotal\": 4503599627370495,\n \"paymentMethod\": \"<string>\",\n \"shipping\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"line2\": \"<string>\",\n \"phone\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.collectpure.com/execution/buy/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 \"quoteId\": \"<string>\",\n \"expectedTotal\": 4503599627370495,\n \"paymentMethod\": \"<string>\",\n \"shipping\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"line2\": \"<string>\",\n \"phone\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"orderId": 123,
"items": [
{
"lineItemId": "<string>",
"productId": "<string>",
"variantId": "<string>",
"quantity": 123,
"price": 123,
"total": 123,
"success": true
}
],
"checkout": {
"id": "<string>",
"currency": "<string>",
"expiresAt": "<string>",
"lineItems": [
{
"id": "<string>",
"quantity": 123,
"price": 123,
"status": "<string>",
"disabled": true,
"error": "<string>",
"product": {
"sku": "<string>",
"title": "<string>"
},
"variant": {
"title": "<string>"
}
}
],
"fees": [
{
"id": "<string>",
"label": "<string>",
"amount": 123,
"rate": 123
}
],
"salesTax": 123,
"subtotal": 123,
"total": 123,
"availableCount": 123,
"unavailableCount": 123,
"allowCardPayments": true,
"allowAch": true
}
}
}Execution - Buy
Execute a buy order
Execute a previously created buy quote. Validates the quote, charges payment, and creates orders. The quote must not be expired.
Rate limit: 120 requests burst, 60 requests/minute sustained.
POST
/
execution
/
buy
/
v1
Execute a buy order
curl --request POST \
--url https://api.collectpure.com/execution/buy/v1 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"quoteId": "<string>",
"expectedTotal": 4503599627370495,
"paymentMethod": "<string>",
"shipping": {
"name": "<string>",
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"line2": "<string>",
"phone": "<string>"
}
}
'import requests
url = "https://api.collectpure.com/execution/buy/v1"
payload = {
"quoteId": "<string>",
"expectedTotal": 4503599627370495,
"paymentMethod": "<string>",
"shipping": {
"name": "<string>",
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"line2": "<string>",
"phone": "<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({
quoteId: '<string>',
expectedTotal: 4503599627370495,
paymentMethod: '<string>',
shipping: {
name: '<string>',
line1: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
line2: '<string>',
phone: '<string>'
}
})
};
fetch('https://api.collectpure.com/execution/buy/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/buy/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([
'quoteId' => '<string>',
'expectedTotal' => 4503599627370495,
'paymentMethod' => '<string>',
'shipping' => [
'name' => '<string>',
'line1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'line2' => '<string>',
'phone' => '<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/buy/v1"
payload := strings.NewReader("{\n \"quoteId\": \"<string>\",\n \"expectedTotal\": 4503599627370495,\n \"paymentMethod\": \"<string>\",\n \"shipping\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"line2\": \"<string>\",\n \"phone\": \"<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/buy/v1")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"quoteId\": \"<string>\",\n \"expectedTotal\": 4503599627370495,\n \"paymentMethod\": \"<string>\",\n \"shipping\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"line2\": \"<string>\",\n \"phone\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.collectpure.com/execution/buy/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 \"quoteId\": \"<string>\",\n \"expectedTotal\": 4503599627370495,\n \"paymentMethod\": \"<string>\",\n \"shipping\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"line2\": \"<string>\",\n \"phone\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"orderId": 123,
"items": [
{
"lineItemId": "<string>",
"productId": "<string>",
"variantId": "<string>",
"quantity": 123,
"price": 123,
"total": 123,
"success": true
}
],
"checkout": {
"id": "<string>",
"currency": "<string>",
"expiresAt": "<string>",
"lineItems": [
{
"id": "<string>",
"quantity": 123,
"price": 123,
"status": "<string>",
"disabled": true,
"error": "<string>",
"product": {
"sku": "<string>",
"title": "<string>"
},
"variant": {
"title": "<string>"
}
}
],
"fees": [
{
"id": "<string>",
"label": "<string>",
"amount": 123,
"rate": 123
}
],
"salesTax": 123,
"subtotal": 123,
"total": 123,
"availableCount": 123,
"unavailableCount": 123,
"allowCardPayments": true,
"allowAch": true
}
}
}Authorizations
API key for authentication
Body
application/json
The quote ID from /execution/buy/quote/v1
The total from the quote response, in cents. The order is rejected if the current total exceeds this value.
Required range:
0 <= x <= 9007199254740991'wire_transfer' or a Stripe payment method ID (pm_... or ba_...)
Show child attributes
Show child attributes
Was this page helpful?
⌘I