POST
/
v1
/
listings
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"
    }
  ]
}'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "url": "boyish.treet.co/l/550e8400-e29b-41d4-a716-446655440000"
}

Authorizations

​
X-Treet-Client-Id
string
header
required
​
X-Treet-Authentication-Key
string
header
required

Body

application/json
Listing to add to a brand's Treet shop
​
shopId
string
required

Unique Treet shop identifier

​
condition
enum<string>
required

Item’s condition

Available options:
NEW_WITH_TAGS,
NEW_WITHOUT_TAGS,
EXCELLENT,
GOOD,
MINOR_DEFECT
​
productDataSourceType
enum<string>
required

Specifies the type of product data source.

  • For SHOPIFY_SKU, SHOPIFY_PRODUCT_VARIANT_ID, EXTERNAL_PRODUCT_VARIANT_IDENTIFIER, and EXTERNAL_PRODUCT_VARIANT_SKU, productIdentifier must be defined.
  • For MANUAL_PRODUCT_OPTIONS, productOptions field must be defined.
Available options:
SHOPIFY_SKU,
SHOPIFY_PRODUCT_VARIANT_ID,
MANUAL_PRODUCT_OPTIONS,
EXTERNAL_PRODUCT_VARIANT_IDENTIFIER,
EXTERNAL_PRODUCT_VARIANT_SKU
​
productIdentifier
string

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

​
manualProductOptions
object

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.

​
externalIdentifier
string

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.

​
description
string

Treet listing description shown publicly to Treet resale customers.

​
metadata
object

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.

Example:
{
  "locationId": "123456",
  "uniqueUnitIdentifier": "SKU325-good"
}
​
commercePlatformDomain
string

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.

​
images
object[]

A list of images for this listing

Response

200
application/json
listing response
​
id
string
required

Unique Treet identifier

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
url
string
required

Listing link on Treet site

Example:

"boyish.treet.co/l/550e8400-e29b-41d4-a716-446655440000"