Get Sample Request
curl --request GET \
--url https://api.growi.io/api/public/v1/sample_requests/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.growi.io/api/public/v1/sample_requests/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.growi.io/api/public/v1/sample_requests/{id}', 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.growi.io/api/public/v1/sample_requests/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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://api.growi.io/api/public/v1/sample_requests/{id}"
req, _ := http.NewRequest("GET", 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))
}HttpResponse<String> response = Unirest.get("https://api.growi.io/api/public/v1/sample_requests/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growi.io/api/public/v1/sample_requests/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"status": "pending",
"campaign_id": 123,
"campaign_name": "<string>",
"campaign_affiliate_id": 123,
"source": "<string>",
"creator": {
"user_id": 123,
"name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"product": {
"id": 123,
"title": "<string>",
"sku": "<string>",
"url": "<string>",
"image_url": "<string>",
"shopify_id": "<string>",
"tik_tok_id": "<string>",
"amazon_product_id": "<string>"
},
"variant": {
"id": 123,
"title": "<string>",
"display_name": "<string>",
"sku": "<string>",
"external_id": "<string>",
"price": 123
},
"quantity": 123,
"shipping_address": {
"first_name": "<string>",
"last_name": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"order_id": "<string>",
"order_name": "<string>",
"tracking_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Get sample request
Returns one sample request.
GET
/
sample_requests
/
{id}
Get Sample Request
curl --request GET \
--url https://api.growi.io/api/public/v1/sample_requests/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.growi.io/api/public/v1/sample_requests/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.growi.io/api/public/v1/sample_requests/{id}', 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.growi.io/api/public/v1/sample_requests/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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://api.growi.io/api/public/v1/sample_requests/{id}"
req, _ := http.NewRequest("GET", 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))
}HttpResponse<String> response = Unirest.get("https://api.growi.io/api/public/v1/sample_requests/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growi.io/api/public/v1/sample_requests/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"status": "pending",
"campaign_id": 123,
"campaign_name": "<string>",
"campaign_affiliate_id": 123,
"source": "<string>",
"creator": {
"user_id": 123,
"name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"product": {
"id": 123,
"title": "<string>",
"sku": "<string>",
"url": "<string>",
"image_url": "<string>",
"shopify_id": "<string>",
"tik_tok_id": "<string>",
"amazon_product_id": "<string>"
},
"variant": {
"id": 123,
"title": "<string>",
"display_name": "<string>",
"sku": "<string>",
"external_id": "<string>",
"price": 123
},
"quantity": 123,
"shipping_address": {
"first_name": "<string>",
"last_name": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"order_id": "<string>",
"order_name": "<string>",
"tracking_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Returns one sample request with the creator, product, variant and shipping address. The fields are the same as in List sample requests.
Path parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
id | Integer | Sample request id, from the list endpoint or the sample_request.id of a webhook event | Yes |
Request example
curl "https://api.growi.io/api/public/v1/sample_requests/812345" \
-H "Authorization: Bearer YOUR_PUBLIC_API_KEY"
Error responses
404: not found for your organization{ "error": "Sample request not found" }