Skip to main content
PATCH
Edit one of your gift-card listings

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Body

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>
images
string<uri>[]
Maximum array length: 10
tags
string[]
attributes
object
delivery_method
string
units
object[]

Response

OK

What every category's listing carries, whatever it sells.

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>

pending_moderation on create, then active or rejected. paused and archived are yours, through pause and DELETE. reserved and sold follow an order. removed is a moderation takedown after publishing, which no call in this API performs.

Available options:
pending_moderation,
active,
paused,
reserved,
sold,
rejected,
removed,
archived
created_at
string<date-time> | null
updated_at
string<date-time> | null
published_at
string<date-time> | null
rejection_reason_code
enum<string> | null

Why moderation refused the last version, if it ever did. It stays on the listing after you resubmit, so read it together with status.

Available options:
prohibited_item,
misleading_description,
stolen_images,
invalid_price,
insufficient_details,
other,
null
rejection_note
string | null
price
integer<int64>
currency
string
Example:

"USD"

images
string<uri>[]
delivery_method
string | null