Skip to main content
GET
/
v1
/
listings
/
{id}
Get listing
curl --request GET \
  --url https://api.treet-test.co/v1/listings/{id} \
  --header 'X-Treet-Authentication-Key: <api-key>' \
  --header 'X-Treet-Client-Id: <api-key>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "state": "OPEN",
  "condition": "GOOD",
  "sku": "SKU325",
  "availableInventory": 1,
  "externalIdentifier": "SKU325-good"
}

Authorizations

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

Path Parameters

​
id
string
required

The Treet listing ID (UUID).

Example:

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

Response

Listing response

​
id
string
required

Unique Treet identifier

Example:

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

​
state
enum<string>
required

Current state of the listing

Available options:
OPEN,
CLOSED
Example:

"OPEN"

​
condition
enum<string>
required

Item's condition

Available options:
NEW_WITH_TAGS,
NEW_WITHOUT_TAGS,
EXCELLENT,
GOOD,
MINOR_DEFECT
Example:

"GOOD"

​
sku
string | null
required

SKU on the underlying product variant (sourced from the connected commerce platform, e.g. Shopify). For the partner-supplied identifier passed at listing creation, see externalIdentifier.

Example:

"SKU325"

​
availableInventory
integer | null
required

Number of units currently available for sale.

Example:

1

​
externalIdentifier
string | null
required

Partner-supplied identifier for the listing, set via the externalIdentifier field on listing creation. null if none was provided.

Example:

"SKU325-good"