cURL
curl --request POST \
--url https://api.treet-test.co/v1/listings \
--header 'Content-Type: application/json' \
--header 'X-Treet-Authentication-Key: <api-key>' \
--header 'X-Treet-Client-Id: <api-key>' \
--data '
{
"shopId": "boyish",
"condition": "GOOD",
"productDataSourceType": "SHOPIFY_PRODUCT_VARIANT_ID",
"productIdentifier": "gid://shopify/ProductVariant/36730646298791",
"externalIdentifier": "SKU325-good",
"description": "This item was used for sample sales. It has a loose thread on the bottom.",
"metadata": {
"locationId": "123456",
"uniqueUnitIdentifier": "SKU325-good"
},
"commercePlatformDomain": "shop.example.com",
"images": [
{
"url": "https://example.com/image1.jpg"
},
{
"url": "https://example.com/image2.jpg"
}
]
}
'import requests
url = "https://api.treet-test.co/v1/listings"
payload = {
"shopId": "boyish",
"condition": "GOOD",
"productDataSourceType": "SHOPIFY_PRODUCT_VARIANT_ID",
"productIdentifier": "gid://shopify/ProductVariant/36730646298791",
"externalIdentifier": "SKU325-good",
"description": "This item was used for sample sales. It has a loose thread on the bottom.",
"metadata": {
"locationId": "123456",
"uniqueUnitIdentifier": "SKU325-good"
},
"commercePlatformDomain": "shop.example.com",
"images": [{ "url": "https://example.com/image1.jpg" }, { "url": "https://example.com/image2.jpg" }]
}
headers = {
"X-Treet-Client-Id": "<api-key>",
"X-Treet-Authentication-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Treet-Client-Id': '<api-key>',
'X-Treet-Authentication-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
shopId: 'boyish',
condition: 'GOOD',
productDataSourceType: 'SHOPIFY_PRODUCT_VARIANT_ID',
productIdentifier: 'gid://shopify/ProductVariant/36730646298791',
externalIdentifier: 'SKU325-good',
description: 'This item was used for sample sales. It has a loose thread on the bottom.',
metadata: {locationId: '123456', uniqueUnitIdentifier: 'SKU325-good'},
commercePlatformDomain: 'shop.example.com',
images: [
{url: 'https://example.com/image1.jpg'},
{url: 'https://example.com/image2.jpg'}
]
})
};
fetch('https://api.treet-test.co/v1/listings', 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.treet-test.co/v1/listings",
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([
'shopId' => 'boyish',
'condition' => 'GOOD',
'productDataSourceType' => 'SHOPIFY_PRODUCT_VARIANT_ID',
'productIdentifier' => 'gid://shopify/ProductVariant/36730646298791',
'externalIdentifier' => 'SKU325-good',
'description' => 'This item was used for sample sales. It has a loose thread on the bottom.',
'metadata' => [
'locationId' => '123456',
'uniqueUnitIdentifier' => 'SKU325-good'
],
'commercePlatformDomain' => 'shop.example.com',
'images' => [
[
'url' => 'https://example.com/image1.jpg'
],
[
'url' => 'https://example.com/image2.jpg'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Treet-Authentication-Key: <api-key>",
"X-Treet-Client-Id: <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.treet-test.co/v1/listings"
payload := strings.NewReader("{\n \"shopId\": \"boyish\",\n \"condition\": \"GOOD\",\n \"productDataSourceType\": \"SHOPIFY_PRODUCT_VARIANT_ID\",\n \"productIdentifier\": \"gid://shopify/ProductVariant/36730646298791\",\n \"externalIdentifier\": \"SKU325-good\",\n \"description\": \"This item was used for sample sales. It has a loose thread on the bottom.\",\n \"metadata\": {\n \"locationId\": \"123456\",\n \"uniqueUnitIdentifier\": \"SKU325-good\"\n },\n \"commercePlatformDomain\": \"shop.example.com\",\n \"images\": [\n {\n \"url\": \"https://example.com/image1.jpg\"\n },\n {\n \"url\": \"https://example.com/image2.jpg\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Treet-Client-Id", "<api-key>")
req.Header.Add("X-Treet-Authentication-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.treet-test.co/v1/listings")
.header("X-Treet-Client-Id", "<api-key>")
.header("X-Treet-Authentication-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"shopId\": \"boyish\",\n \"condition\": \"GOOD\",\n \"productDataSourceType\": \"SHOPIFY_PRODUCT_VARIANT_ID\",\n \"productIdentifier\": \"gid://shopify/ProductVariant/36730646298791\",\n \"externalIdentifier\": \"SKU325-good\",\n \"description\": \"This item was used for sample sales. It has a loose thread on the bottom.\",\n \"metadata\": {\n \"locationId\": \"123456\",\n \"uniqueUnitIdentifier\": \"SKU325-good\"\n },\n \"commercePlatformDomain\": \"shop.example.com\",\n \"images\": [\n {\n \"url\": \"https://example.com/image1.jpg\"\n },\n {\n \"url\": \"https://example.com/image2.jpg\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.treet-test.co/v1/listings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Treet-Client-Id"] = '<api-key>'
request["X-Treet-Authentication-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"shopId\": \"boyish\",\n \"condition\": \"GOOD\",\n \"productDataSourceType\": \"SHOPIFY_PRODUCT_VARIANT_ID\",\n \"productIdentifier\": \"gid://shopify/ProductVariant/36730646298791\",\n \"externalIdentifier\": \"SKU325-good\",\n \"description\": \"This item was used for sample sales. It has a loose thread on the bottom.\",\n \"metadata\": {\n \"locationId\": \"123456\",\n \"uniqueUnitIdentifier\": \"SKU325-good\"\n },\n \"commercePlatformDomain\": \"shop.example.com\",\n \"images\": [\n {\n \"url\": \"https://example.com/image1.jpg\"\n },\n {\n \"url\": \"https://example.com/image2.jpg\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "550e8400-e29b-41d4-a716-446655440000",
"url": "boyish.treet.co/l/550e8400-e29b-41d4-a716-446655440000"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Listings API
Create Listing
Creates a new listing for a brand’s Treet shop. Product data can be pulled in directly from Shopify or manually entered. See productDataSourceType below for more info.
POST
/
v1
/
listings
cURL
curl --request POST \
--url https://api.treet-test.co/v1/listings \
--header 'Content-Type: application/json' \
--header 'X-Treet-Authentication-Key: <api-key>' \
--header 'X-Treet-Client-Id: <api-key>' \
--data '
{
"shopId": "boyish",
"condition": "GOOD",
"productDataSourceType": "SHOPIFY_PRODUCT_VARIANT_ID",
"productIdentifier": "gid://shopify/ProductVariant/36730646298791",
"externalIdentifier": "SKU325-good",
"description": "This item was used for sample sales. It has a loose thread on the bottom.",
"metadata": {
"locationId": "123456",
"uniqueUnitIdentifier": "SKU325-good"
},
"commercePlatformDomain": "shop.example.com",
"images": [
{
"url": "https://example.com/image1.jpg"
},
{
"url": "https://example.com/image2.jpg"
}
]
}
'import requests
url = "https://api.treet-test.co/v1/listings"
payload = {
"shopId": "boyish",
"condition": "GOOD",
"productDataSourceType": "SHOPIFY_PRODUCT_VARIANT_ID",
"productIdentifier": "gid://shopify/ProductVariant/36730646298791",
"externalIdentifier": "SKU325-good",
"description": "This item was used for sample sales. It has a loose thread on the bottom.",
"metadata": {
"locationId": "123456",
"uniqueUnitIdentifier": "SKU325-good"
},
"commercePlatformDomain": "shop.example.com",
"images": [{ "url": "https://example.com/image1.jpg" }, { "url": "https://example.com/image2.jpg" }]
}
headers = {
"X-Treet-Client-Id": "<api-key>",
"X-Treet-Authentication-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Treet-Client-Id': '<api-key>',
'X-Treet-Authentication-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
shopId: 'boyish',
condition: 'GOOD',
productDataSourceType: 'SHOPIFY_PRODUCT_VARIANT_ID',
productIdentifier: 'gid://shopify/ProductVariant/36730646298791',
externalIdentifier: 'SKU325-good',
description: 'This item was used for sample sales. It has a loose thread on the bottom.',
metadata: {locationId: '123456', uniqueUnitIdentifier: 'SKU325-good'},
commercePlatformDomain: 'shop.example.com',
images: [
{url: 'https://example.com/image1.jpg'},
{url: 'https://example.com/image2.jpg'}
]
})
};
fetch('https://api.treet-test.co/v1/listings', 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.treet-test.co/v1/listings",
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([
'shopId' => 'boyish',
'condition' => 'GOOD',
'productDataSourceType' => 'SHOPIFY_PRODUCT_VARIANT_ID',
'productIdentifier' => 'gid://shopify/ProductVariant/36730646298791',
'externalIdentifier' => 'SKU325-good',
'description' => 'This item was used for sample sales. It has a loose thread on the bottom.',
'metadata' => [
'locationId' => '123456',
'uniqueUnitIdentifier' => 'SKU325-good'
],
'commercePlatformDomain' => 'shop.example.com',
'images' => [
[
'url' => 'https://example.com/image1.jpg'
],
[
'url' => 'https://example.com/image2.jpg'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Treet-Authentication-Key: <api-key>",
"X-Treet-Client-Id: <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.treet-test.co/v1/listings"
payload := strings.NewReader("{\n \"shopId\": \"boyish\",\n \"condition\": \"GOOD\",\n \"productDataSourceType\": \"SHOPIFY_PRODUCT_VARIANT_ID\",\n \"productIdentifier\": \"gid://shopify/ProductVariant/36730646298791\",\n \"externalIdentifier\": \"SKU325-good\",\n \"description\": \"This item was used for sample sales. It has a loose thread on the bottom.\",\n \"metadata\": {\n \"locationId\": \"123456\",\n \"uniqueUnitIdentifier\": \"SKU325-good\"\n },\n \"commercePlatformDomain\": \"shop.example.com\",\n \"images\": [\n {\n \"url\": \"https://example.com/image1.jpg\"\n },\n {\n \"url\": \"https://example.com/image2.jpg\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Treet-Client-Id", "<api-key>")
req.Header.Add("X-Treet-Authentication-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.treet-test.co/v1/listings")
.header("X-Treet-Client-Id", "<api-key>")
.header("X-Treet-Authentication-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"shopId\": \"boyish\",\n \"condition\": \"GOOD\",\n \"productDataSourceType\": \"SHOPIFY_PRODUCT_VARIANT_ID\",\n \"productIdentifier\": \"gid://shopify/ProductVariant/36730646298791\",\n \"externalIdentifier\": \"SKU325-good\",\n \"description\": \"This item was used for sample sales. It has a loose thread on the bottom.\",\n \"metadata\": {\n \"locationId\": \"123456\",\n \"uniqueUnitIdentifier\": \"SKU325-good\"\n },\n \"commercePlatformDomain\": \"shop.example.com\",\n \"images\": [\n {\n \"url\": \"https://example.com/image1.jpg\"\n },\n {\n \"url\": \"https://example.com/image2.jpg\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.treet-test.co/v1/listings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Treet-Client-Id"] = '<api-key>'
request["X-Treet-Authentication-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"shopId\": \"boyish\",\n \"condition\": \"GOOD\",\n \"productDataSourceType\": \"SHOPIFY_PRODUCT_VARIANT_ID\",\n \"productIdentifier\": \"gid://shopify/ProductVariant/36730646298791\",\n \"externalIdentifier\": \"SKU325-good\",\n \"description\": \"This item was used for sample sales. It has a loose thread on the bottom.\",\n \"metadata\": {\n \"locationId\": \"123456\",\n \"uniqueUnitIdentifier\": \"SKU325-good\"\n },\n \"commercePlatformDomain\": \"shop.example.com\",\n \"images\": [\n {\n \"url\": \"https://example.com/image1.jpg\"\n },\n {\n \"url\": \"https://example.com/image2.jpg\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "550e8400-e29b-41d4-a716-446655440000",
"url": "boyish.treet.co/l/550e8400-e29b-41d4-a716-446655440000"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Body
application/json
Listing to add to a brand's Treet shop
Unique Treet shop identifier
Item’s condition
Available options:
NEW_WITH_TAGS, NEW_WITHOUT_TAGS, EXCELLENT, GOOD, MINOR_DEFECT Specifies the type of product data source.
- For
SHOPIFY_SKU,SHOPIFY_PRODUCT_VARIANT_ID,EXTERNAL_PRODUCT_VARIANT_IDENTIFIER, andEXTERNAL_PRODUCT_VARIANT_SKU,productIdentifiermust be defined. - For
MANUAL_PRODUCT_OPTIONS,manualProductOptionsandoriginalPricemust be defined.
Available options:
SHOPIFY_SKU, SHOPIFY_PRODUCT_VARIANT_ID, MANUAL_PRODUCT_OPTIONS, EXTERNAL_PRODUCT_VARIANT_IDENTIFIER, EXTERNAL_PRODUCT_VARIANT_SKU Depending on the productDataSourceType, this is either the Shopify Product Variant ID or the Shopify SKU of the item.
*Required if productDataSourceType is SHOPIFY_SKU, SHOPIFY_PRODUCT_VARIANT_ID, EXTERNAL_PRODUCT_VARIANT_IDENTIFIER, or EXTERNAL_PRODUCT_VARIANT_SKU
All information pertaining to a manually listed item for non-Shopify backed items. Title and category are required, and additional fields may be added that help identify the item.
*Required if productDataSourceType is MANUAL_PRODUCT_OPTIONS.
Show child attributes
Show child attributes
Unique identifier for the item that can be used to retrieve details about the item later. If this is not passed in, the unique ID that Treet creates must be used instead.
Treet listing description shown publicly to Treet resale customers.
The individual item's brand or manufacturer. Optional — only needed when uploading to a Treet shop that supports multiple different item brands. When provided, this is used as the listing's brand.
When listing is purchased, this will be pushed to the Shopify Order as Shopify Custom Attributes to sync to the fulfillment mechanism.
This object is limited to 3 properties and must be either a string or integer.
Show child attributes
Show child attributes
Example:
{
"locationId": "123456",
"uniqueUnitIdentifier": "SKU325-good"
}
Only enter this value to override the commerce platform for a shop.
For example, if the shop has more than one Shopify store, you will need to specify the domain of the Shopify store that you want to reference for this listing.
A list of images for this listing
Minimum array length:
1Show child attributes
Show child attributes
The item's original retail price, as a positive integer in the smallest unit of the shop's currency (for example, 12800 for $128.00).
*Required if productDataSourceType is MANUAL_PRODUCT_OPTIONS. For all other source types, this is optional and overrides the original price that Treet would evaluate from the product data.
Required range:
1 <= x <= 9999999Example:
12800