Skip to main content
PATCH
Edit one of your top-up listings

Autorizzazioni

Authorization
string
header
obbligatorio

Your API key, from the cabinet under Seller → API keys.

Parametri del percorso

id
string<uuid>
obbligatorio

Corpo

application/json

Every field optional; absent means "leave unchanged".

title
string
Required string length: 8 - 128
description
string
Maximum string length: 4096
price
integer<int64>

US cents.

images
string<uri>[]

Replaces the whole gallery.

Maximum array length: 10
tags
string[]

Replaces the whole list. Same limits as on create.

attributes
object

Replaces the whole map — send every field the category asks for, not only the one that changed.

delivery_type
enum<string>

Changing it replaces the listing's unit pool.

Opzioni disponibili:
instant,
manual
units
object[]

Read only when delivery_type switches to instant, as the pool the listing starts over with. Ignored otherwise: stock is added through POST .../units.

manual_delivery_value
integer<int32>

The handover time you promise.

manual_delivery_unit
enum<string>

What the value counts.

Opzioni disponibili:
minutes,
hours,
days
delivery_method
string

A key from GET /v1/offers/delivery-methods.

delivery_instructions
string

What the buyer is told to do at handover.

Maximum string length: 2048

Risposta

OK

How a listing sold by hand promises to hand over.

id
string<uuid>
title
string
description
string
attributes
object

The category's own fields, keyed by the schema's key.

tags
string[]
status
enum<string>

draft on create, then active once you publish it; unpublish takes it back to draft. archived is yours too, through DELETE. sold follows an order: the last unit went to a closed one. changes_requested is moderation sending a live listing back: it is off the marketplace, moderation_reason_code says why, and your next PATCH makes it a draft to publish again.

Opzioni disponibili:
draft,
active,
changes_requested,
sold,
archived
created_at
string<date-time> | null
updated_at
string<date-time> | null
published_at
string<date-time> | null

When publish put it on the marketplace. null while it is a draft, and written once — pausing and unpausing leave it alone.

moderation_reason_code
enum<string> | null

Why moderation asked for changes. Kept through the PATCH that makes the listing a draft, null once it is published again.

Opzioni disponibili:
prohibited_item,
misleading_description,
stolen_images,
invalid_price,
insufficient_details,
other,
null
moderation_note
string | null

What moderation wrote to you along with the reason, if anything.

manual_delivery_value
integer<int32> | null

The handover time promised, read together with the unit — 2 and hours.

manual_delivery_unit
enum<string> | null

What the value counts. Both are null on a listing delivered instantly.

Opzioni disponibili:
minutes,
hours,
days,
null
price
integer<int64>

US cents.

currency
string

Always USD.

Esempio:

"USD"

images
string<uri>[]
delivery_type
enum<string>

instant sells out of the unit pool; manual you hand over yourself.

Opzioni disponibili:
instant,
manual
delivery_method
string | null

The key this listing hands over by.

delivery_instructions
string

What the buyer is told to do at handover.