Skip to content
UltimateTeam.ai Docs

Publish Listing

POST
/api/v1/commerce/listings
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/commerce/listings \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "category": "example", "description": "example", "kind": "digital", "livemode": true, "maximum_quantity": 1, "minimum_subtotal_cents": 1, "public_contact_email": "hello@example.com", "public_terms": "example", "request_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "title": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ListingRequest
object
category
required
Category
string
>= 1 characters <= 100 characters
description
required
Description
string
>= 10 characters <= 4000 characters
kind
required
Kind
string
Allowed values: digital service physical
livemode
required
Livemode
boolean
maximum_quantity
required
Maximum Quantity
integer
>= 1 <= 100000
minimum_subtotal_cents
required
Minimum Subtotal Cents
integer
>= 50 <= 99999999
public_contact_email
required
Public Contact Email
string format: email
public_terms
required
Public Terms
string
>= 5 characters <= 4000 characters
request_id
required
Request Id
string format: uuid
title
required
Title
string
>= 1 characters <= 255 characters

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

Media typeapplication/json
ListingResponse
object
category
required
Category
string
description
required
Description
string
id
required
Id
string format: uuid
kind
required
Kind
string
livemode
required
Livemode
boolean
maximum_quantity
required
Maximum Quantity
integer
minimum_subtotal_cents
required
Minimum Subtotal Cents
integer
public_contact_email
required
Public Contact Email
string format: email
public_terms
required
Public Terms
string
seller_account_id
required
Seller Account Id
string
status
required
Status
string
tenant_id
required
Tenant Id
string format: uuid
title
required
Title
string
Examplegenerated
{
  "category": "example",
  "description": "example",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "kind": "example",
  "livemode": true,
  "maximum_quantity": 1,
  "minimum_subtotal_cents": 1,
  "public_contact_email": "hello@example.com",
  "public_terms": "example",
  "seller_account_id": "example",
  "status": "example",
  "tenant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "title": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}