DoctorX logoDoctorX Get an API key

Templates

Listing templates and live marketplace taxonomy.

The reusable library. One-off templates bound to a single product are excluded (they are reached through their product), which is why this count is far smaller than the raw template row count. Set preset=true for the preset library instead: this tenant’s presets plus every global preset for a channel this workspace can hold.

Parameters

NameInTypeDescription
limit
queryinteger

Page size, 1..200. Defaults to 50.

min 1 · max 200 · default 50

cursor
querystring

Opaque cursor from a previous response meta.pagination.nextCursor.

order
querystring

Sort direction on the collection sort key.

One of: "asc", "desc"

default "desc"

includeTotal
querystring

When true, meta.pagination.total carries the full matching count (an extra COUNT query).

channel
querystring

Marketplace channel.

One of: "tiktok", "ebay", "etsy", "amazon"

category
querystring
search
querystring

Free-text match on template name, seller template code and search terms, and on the category and title template of each of its channels (a term may mix the template text with one channel). A channel name in English or Vietnamese matches the channel. Whitespace is collapsed and the term is folded, so the match is case- and accent-insensitive (Dat matches Đạt). Every word must match: more words narrow the result, they do not widen it. A word of letters matches at the start of a word in the text (dad matches Dad and Daddy, not Trinidad); a word containing a digit matches anywhere, so the tail of an order, tracking or SKU number still finds it. Punctuation separates words (t-shirt matches T-Shirt and t shirt). Wrap words in double quotes to require them adjacent. % and _ are not wildcards: punctuation only separates words, so a term of punctuation alone matches nothing. A term that is a valid UUID also matches the record id exactly.

includeHidden
querystring
preset
querystring

Return the PRESET library instead: this tenant’s presets plus every GLOBAL preset.

updatedSince
querystring (date-time) | string (date)

Only templates changed at or after this instant. Pair it with sortBy=updatedAt for an incremental walk, which is what /changes/templates does for you.

sortBy
querystring

Sort key. STATED rather than inferred from updatedSince, deliberately: a cursor is minted against a column, so an inferred key changes the moment a caller drops a filter and turns a resumed walk into invalid_cursor.

One of: "createdAt", "updatedAt"

default "createdAt"

Responses

200TemplateListResponse
StatusMeaning (body: error envelope)
400

Validation failed, or the request is not valid for this resource.

401

The API key is missing, unknown, revoked or expired.

403

The API key lacks the required scope, or is not bound to this shop.

404

No such resource for this tenant.

409

The request conflicts with the current state (see error.code).

422

The marketplace rejected the request; error.details carries its own message.

429

Back off and retry. error.code says whose limit was hit: rate_limited is ours (honour Retry-After), channel_rate_limited is the marketplace throttling us, channel_unavailable is the marketplace being unreachable.

500

A defect on our side (internal_error), and the only status left outside the 4xx range. The origin emits the envelope below, but the edge in front of api.doctorx.vn replaces the body of a 5xx with its own plain-text page, so do NOT require this body to parse: branch on the status.

Request sample

curl -X GET 'https://api.doctorx.vn/api/public/v1/templates' \
  -H "Authorization: Bearer $DOCTORX_API_KEY"
POST/templates

Send categoryId (a LEAF id from GET /templates/categories) alongside category, which is only the display NAME. On TikTok, Etsy and Amazon a template with no bound leaf id cannot publish at all, so the create is REFUSED rather than stored: those publishers never accept a category name. If you send only category the server resolves the id from the live taxonomy, matching an id first and then an exact leaf name, and refuses when the name is ambiguous. eBay is the exception and falls back to the name, so it is warned about rather than refused. variantGrid rows are regenerated and merged against variantOptions server-side, and each row’s options is its identity: omit it on an N-axis template and the row matches no combination.

Request body

namestringrequired

min length 1 · max length 300

codestring

The seller's own handle for this template. Must be unique among the tenant's live templates - a duplicate is refused, naming the template that holds it. Send an empty string to clear it. This is the value a partner should join on rather than name, so it is writable as well as readable: exposing it read-only would document a key an integration could never establish.

max length 100

channelstringrequired

Primary channel.

One of: "tiktok", "ebay", "etsy", "amazon"

categorystringrequired

Category DISPLAY NAME for the primary channel. Send categoryId alongside it: this field is the label, not the marketplace id.

min length 1

categoryIdstring

Live channel category LEAF id for the primary channel, from GET /templates/categories (isLeaf: true). On Amazon this is the product type. REQUIRED IN PRACTICE for TikTok, Etsy and Amazon: without it publish is refused with category "(empty)" is not a valid leaf category id, because those channels never accept a category name. Send this instead of hand-writing the per-channel key into channelMeta; the server writes it to the right one. If you send only category, the server resolves the id from the live taxonomy when it can.

max length 100

categoryVersionstring

TikTok taxonomy version for categoryId (v1 / v2). Ignored on other channels. A leaf id only means something against the version it was picked from, so send them together.

max length 20

categoryPathstring[]

default []

default []

default []

titleTemplatestringrequired

min length 1

descriptionTemplatestring

default ""

sampleImagesstring (uri)[]

Reference photos stored on the template; not published and not copied into listings created from it (see fixedImages). Same bound as the dashboard write path.

max items 500 · default []

fixedImagesstring (uri)[]

Images every listing built from this template publishes after its own gallery, in this order; the WHOLE list, so send it complete and [] to remove them all. At most 8, and fewer when the template publishes to a channel with a smaller gallery: each fixed image keeps a place in the channel's gallery and the listing's own cover always keeps one, so a TikTok template (9 gallery images) holds at most 8. A list over the bound is refused, naming the channel that sets it. A url repeated in the list is stored once. Refused on a template that belongs to a single product.

max items 8

Per-SKU defaults. Regenerated and merged against variantOptions server-side. price, listPrice and cost are at most 9999999999.99 and quantity at most 2147483647: these seed the variants of every product created from the template, and a variant cannot store more. cost null clears the row’s own cost, so it takes pricingRule.baseCost; on an update, a row sent without the key keeps the cost it holds. A changed cost also moves existing products’ variants that still hold the row’s previous cost; a variant whose cost was set by hand keeps it, and nothing is sent to a marketplace.

searchTermsstring[]
sizeChartUrlstring (uri) | null
videoUrlstring (uri) | null
channelMetaobject

Per-channel bindings, merged KEY BY KEY on update: an absent key keeps the stored value, an explicit null deletes it. Prefer the top-level categoryId for the category; the server writes it to the right key below. TikTok: tiktokCategoryId, tiktokCategoryVersion, tiktokWarehouseId, tiktokSizeChartTemplateId, tiktokIsCodAllowed, tiktokRegion, tiktokCategoryByRegion, tiktokPriceMultiplierByRegion, tiktokProductHighlights. tiktokProductHighlights is the Product highlights every listing built from the template publishes unless it states its own (a product’s highlights): a list of texts, one per bullet, at most 5 entries and 1,500 characters (Unicode code points) across them, else validation_failed. Entries are trimmed and blank ones dropped; an empty list or null removes the key, and a listing whose template states none keeps the highlights TikTok already shows on its next update. eBay: ebayCategoryId, ebayFulfillmentPolicyId, ebayPaymentPolicyId, ebayReturnPolicyId, ebayMerchantLocationKey, ebayCondition, ebayMarketplace. Etsy: etsyCategoryId, etsyShippingProfileId, etsyReturnPolicyId, etsyProcessingProfileId, etsyShopSectionId, etsyPersonalizationId, etsyWhoMade, etsyWhenMade, etsyIsSupply, etsyMaterials. Amazon: amazonProductType, amazonBulletPoints, amazonBulletTemplateId, amazonGenericKeyword, amazonBrand, amazonLeadTimeToShipMaxDays, amazonFulfillmentChannelCode, amazonShippingPackageTemplateId, amazonContentId, amazonMarketplace, amazonAttributes. Any channel: brandId, brandName. A key differing from one of these only in case or punctuation is REFUSED, naming the key you meant. An unrecognised key is stored and reported in meta.warnings, because it is never published. Every id has a listing endpoint: GET /ebay/policies, /ebay/locations, /etsy/policies, /etsy/personalizations, /amazon/contents, /amazon/product-types, /amazon/bullet-templates, /templates/brands, /templates/size-charts and /authorize/shops/{id}/warehouses.

Extra publish targets beyond the primary channel, each with its own taxonomy.

hiddenboolean

Responses

201TemplateResponse
StatusMeaning (body: error envelope)
400

Validation failed, or the request is not valid for this resource.

401

The API key is missing, unknown, revoked or expired.

403

The API key lacks the required scope, or is not bound to this shop.

404

No such resource for this tenant.

409

The request conflicts with the current state (see error.code).

422

The marketplace rejected the request; error.details carries its own message.

429

Back off and retry. error.code says whose limit was hit: rate_limited is ours (honour Retry-After), channel_rate_limited is the marketplace throttling us, channel_unavailable is the marketplace being unreachable.

500

A defect on our side (internal_error), and the only status left outside the 4xx range. The origin emits the envelope below, but the edge in front of api.doctorx.vn replaces the body of a 5xx with its own plain-text page, so do NOT require this body to parse: branch on the status.

Request sample

curl -X POST 'https://api.doctorx.vn/api/public/v1/templates' \
  -H "Authorization: Bearer $DOCTORX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "channel": "tiktok",
  "category": "string",
  "titleTemplate": "string"
}'
GET/templates/categories

Calls the marketplace. Returns a FLAT list: build the tree from parentId. Only a node with isLeaf: true may be set on a template. TikTok resolves per region; eBay categories and aspects are per marketplace.

Parameters

NameInTypeDescription
channelrequired
querystring

Marketplace channel.

One of: "tiktok", "ebay", "etsy", "amazon"

shopId
querystring

Resolve against this shop’s taxonomy. Omit to use any connected shop on the channel.

pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

keyword
querystring

Filter categories by name.

categoryId
querystring

Scope brands to a category leaf.

region
querystring

TikTok region override, e.g. US. Ignored by other channels.

marketplace
querystring

eBay marketplace, e.g. EBAY_US. Categories AND aspect names are per-marketplace. Ignored by other channels.

One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR"

Responses

200CategoryListResponse
StatusMeaning (body: error envelope)
400

Validation failed, or the request is not valid for this resource.

401

The API key is missing, unknown, revoked or expired.

403

The API key lacks the required scope, or is not bound to this shop.

404

No such resource for this tenant.

409

The request conflicts with the current state (see error.code).

422

The marketplace rejected the request; error.details carries its own message.

429

Back off and retry. error.code says whose limit was hit: rate_limited is ours (honour Retry-After), channel_rate_limited is the marketplace throttling us, channel_unavailable is the marketplace being unreachable.

500

A defect on our side (internal_error), and the only status left outside the 4xx range. The origin emits the envelope below, but the edge in front of api.doctorx.vn replaces the body of a 5xx with its own plain-text page, so do NOT require this body to parse: branch on the status.

Request sample

curl -X GET 'https://api.doctorx.vn/api/public/v1/templates/categories?channel=tiktok' \
  -H "Authorization: Bearer $DOCTORX_API_KEY"
GET/templates/categories/{categoryId}/attributes

The item specifics / product attributes the marketplace defines for this leaf, with their predefined values, whether each may be multi-valued, and whether it can act as a variation axis. An attribute with no values takes free text.

Parameters

NameInTypeDescription
categoryIdrequired
pathstring
channelrequired
querystring

Marketplace channel.

One of: "tiktok", "ebay", "etsy", "amazon"

shopId
querystring

Resolve against this shop’s taxonomy. Omit to use any connected shop on the channel.

pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

keyword
querystring

Filter categories by name.

categoryId
querystring

Scope brands to a category leaf.

region
querystring

TikTok region override, e.g. US. Ignored by other channels.

marketplace
querystring

eBay marketplace, e.g. EBAY_US. Categories AND aspect names are per-marketplace. Ignored by other channels.

One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR"

Responses

200CategoryAttributeListResponse
StatusMeaning (body: error envelope)
400

Validation failed, or the request is not valid for this resource.

401

The API key is missing, unknown, revoked or expired.

403

The API key lacks the required scope, or is not bound to this shop.

404

No such resource for this tenant.

409

The request conflicts with the current state (see error.code).

422

The marketplace rejected the request; error.details carries its own message.

429

Back off and retry. error.code says whose limit was hit: rate_limited is ours (honour Retry-After), channel_rate_limited is the marketplace throttling us, channel_unavailable is the marketplace being unreachable.

500

A defect on our side (internal_error), and the only status left outside the 4xx range. The origin emits the envelope below, but the edge in front of api.doctorx.vn replaces the body of a 5xx with its own plain-text page, so do NOT require this body to parse: branch on the status.

Request sample

curl -X GET 'https://api.doctorx.vn/api/public/v1/templates/categories/string/attributes?channel=tiktok' \
  -H "Authorization: Bearer $DOCTORX_API_KEY"
GET/templates/brands

Optionally scoped to a category leaf via categoryId.

Parameters

NameInTypeDescription
channelrequired
querystring

Marketplace channel.

One of: "tiktok", "ebay", "etsy", "amazon"

shopId
querystring

Resolve against this shop’s taxonomy. Omit to use any connected shop on the channel.

pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

keyword
querystring

Filter categories by name.

categoryId
querystring

Scope brands to a category leaf.

region
querystring

TikTok region override, e.g. US. Ignored by other channels.

marketplace
querystring

eBay marketplace, e.g. EBAY_US. Categories AND aspect names are per-marketplace. Ignored by other channels.

One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR"

Responses

200BrandListResponse
StatusMeaning (body: error envelope)
400

Validation failed, or the request is not valid for this resource.

401

The API key is missing, unknown, revoked or expired.

403

The API key lacks the required scope, or is not bound to this shop.

404

No such resource for this tenant.

409

The request conflicts with the current state (see error.code).

422

The marketplace rejected the request; error.details carries its own message.

429

Back off and retry. error.code says whose limit was hit: rate_limited is ours (honour Retry-After), channel_rate_limited is the marketplace throttling us, channel_unavailable is the marketplace being unreachable.

500

A defect on our side (internal_error), and the only status left outside the 4xx range. The origin emits the envelope below, but the edge in front of api.doctorx.vn replaces the body of a 5xx with its own plain-text page, so do NOT require this body to parse: branch on the status.

Request sample

curl -X GET 'https://api.doctorx.vn/api/public/v1/templates/brands?channel=tiktok' \
  -H "Authorization: Bearer $DOCTORX_API_KEY"
GET/templates/pre-sale-options

Whether writing channelMeta.tiktokPreSaleType on a template will do anything. The permission is TikTok’s and belongs to the SELLER, not to DoctorX: it is reported per category but granted per shop, so ask about the shop and the category you intend to publish into. An EMPTY list is the normal answer - measured across every connected shop, 1 in 129 is entitled - and publishing pre_sale without it is refused by TikTok with 12052712. Other channels have no pre-sale concept and answer an empty list.

Parameters

NameInTypeDescription
channelrequired
querystring

Only tiktok returns values today; the other channels have no pre-sale concept and answer an empty list.

One of: "tiktok", "ebay", "etsy", "amazon"

categoryIdrequired
querystring

The channel LEAF category id. TikTok reports the permission per category even though it is a per-SHOP grant, so ask about the category you intend to publish into.

min length 1

shopId
querystring

Scope to one shop. The permission is per SHOP, so omitting this answers for whichever shop the key resolves first and is rarely what you want.

pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Responses

200PreSaleOptionsResponse

PreSaleOptions

StatusMeaning (body: error envelope)
400

Validation failed, or the request is not valid for this resource.

401

The API key is missing, unknown, revoked or expired.

403

The API key lacks the required scope, or is not bound to this shop.

404

No such resource for this tenant.

409

The request conflicts with the current state (see error.code).

422

The marketplace rejected the request; error.details carries its own message.

429

Back off and retry. error.code says whose limit was hit: rate_limited is ours (honour Retry-After), channel_rate_limited is the marketplace throttling us, channel_unavailable is the marketplace being unreachable.

500

A defect on our side (internal_error), and the only status left outside the 4xx range. The origin emits the envelope below, but the edge in front of api.doctorx.vn replaces the body of a 5xx with its own plain-text page, so do NOT require this body to parse: branch on the status.

Request sample

curl -X GET 'https://api.doctorx.vn/api/public/v1/templates/pre-sale-options?channel=tiktok&categoryId=string' \
  -H "Authorization: Bearer $DOCTORX_API_KEY"
GET/templates/size-charts

The ids for channelMeta.tiktokSizeChartTemplateId. TikTok only: the other channels have no shop-level size-chart templates and answer an empty list. Charts belong to a SHOP, so each row carries its shopId and an id is not valid on a different shop. TikTok has no API to CREATE one, so binding an id from this list is the only route. A key bound to specific shops sees only those shops.

Parameters

NameInTypeDescription
channelrequired
querystring

Only tiktok returns rows today; the others have no shop-level size-chart templates and answer an empty list.

One of: "tiktok", "ebay", "etsy", "amazon"

shopId
querystring

Scope to one shop. Omit for the union across every shop of that channel.

pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Responses

200SizeChartListResponse
StatusMeaning (body: error envelope)
400

Validation failed, or the request is not valid for this resource.

401

The API key is missing, unknown, revoked or expired.

403

The API key lacks the required scope, or is not bound to this shop.

404

No such resource for this tenant.

409

The request conflicts with the current state (see error.code).

422

The marketplace rejected the request; error.details carries its own message.

429

Back off and retry. error.code says whose limit was hit: rate_limited is ours (honour Retry-After), channel_rate_limited is the marketplace throttling us, channel_unavailable is the marketplace being unreachable.

500

A defect on our side (internal_error), and the only status left outside the 4xx range. The origin emits the envelope below, but the edge in front of api.doctorx.vn replaces the body of a 5xx with its own plain-text page, so do NOT require this body to parse: branch on the status.

Request sample

curl -X GET 'https://api.doctorx.vn/api/public/v1/templates/size-charts?channel=tiktok' \
  -H "Authorization: Bearer $DOCTORX_API_KEY"

Parameters

NameInTypeDescription
idrequired
pathstring

Responses

200TemplateResponse
StatusMeaning (body: error envelope)
400

Validation failed, or the request is not valid for this resource.

401

The API key is missing, unknown, revoked or expired.

403

The API key lacks the required scope, or is not bound to this shop.

404

No such resource for this tenant.

409

The request conflicts with the current state (see error.code).

422

The marketplace rejected the request; error.details carries its own message.

429

Back off and retry. error.code says whose limit was hit: rate_limited is ours (honour Retry-After), channel_rate_limited is the marketplace throttling us, channel_unavailable is the marketplace being unreachable.

500

A defect on our side (internal_error), and the only status left outside the 4xx range. The origin emits the envelope below, but the edge in front of api.doctorx.vn replaces the body of a 5xx with its own plain-text page, so do NOT require this body to parse: branch on the status.

Request sample

curl -X GET 'https://api.doctorx.vn/api/public/v1/templates/string' \
  -H "Authorization: Bearer $DOCTORX_API_KEY"
PATCH/templates/{id}

Partial. channelMeta MERGES key by key: an absent key keeps the stored value and an explicit null deletes it, so changing one binding no longer drops the others (it used to replace the whole blob). additionalChannels is gated on PRESENCE: omit it to leave the extra publish targets untouched, send [] to prune back to the primary channel only, send a list to reconcile to exactly that set.

Parameters

NameInTypeDescription
idrequired
pathstring

Request body

namestring

min length 1 · max length 300

codestring

The seller's own handle for this template. Must be unique among the tenant's live templates - a duplicate is refused, naming the template that holds it. Send an empty string to clear it. This is the value a partner should join on rather than name, so it is writable as well as readable: exposing it read-only would document a key an integration could never establish.

max length 100

channelstring

Primary channel.

One of: "tiktok", "ebay", "etsy", "amazon"

categorystring

Category DISPLAY NAME, e.g. "Women's T-shirts". This is NOT the marketplace id: it is what the dashboard shows, and the id the channel requires goes in categoryId. The description used to say "LEAF id" here, which was true only for eBay (where publish falls back to this value) and false for TikTok, Etsy and Amazon, whose publisher refuses to treat a name as an id.

min length 1

categoryIdstring

Live channel category LEAF id for the primary channel, from GET /templates/categories (isLeaf: true). On Amazon this is the product type. REQUIRED IN PRACTICE for TikTok, Etsy and Amazon: without it publish is refused with category "(empty)" is not a valid leaf category id, because those channels never accept a category name. Send this instead of hand-writing the per-channel key into channelMeta; the server writes it to the right one. If you send only category, the server resolves the id from the live taxonomy when it can.

max length 100

categoryVersionstring

TikTok taxonomy version for categoryId (v1 / v2). Ignored on other channels. A leaf id only means something against the version it was picked from, so send them together.

max length 20

categoryPathstring[]
titleTemplatestring

min length 1

descriptionTemplatestring
sampleImagesstring (uri)[]

Reference photos stored on the template; not published and not copied into listings created from it (see fixedImages). Bounded by the same constant the dashboard write path uses; the grid APPENDS, so this is the stored TOTAL rather than how many may be sent at once.

max items 500

fixedImagesstring (uri)[]

Images every listing built from this template publishes after its own gallery, in this order; the WHOLE list, so send it complete and [] to remove them all. At most 8, and fewer when the template publishes to a channel with a smaller gallery: each fixed image keeps a place in the channel's gallery and the listing's own cover always keeps one, so a TikTok template (9 gallery images) holds at most 8. A list over the bound is refused, naming the channel that sets it. A url repeated in the list is stored once. Refused on a template that belongs to a single product.

max items 8

Per-SKU defaults. Regenerated and merged against variantOptions server-side. price, listPrice and cost are at most 9999999999.99 and quantity at most 2147483647: these seed the variants of every product created from the template, and a variant cannot store more. cost null clears the row’s own cost, so it takes pricingRule.baseCost; on an update, a row sent without the key keeps the cost it holds. A changed cost also moves existing products’ variants that still hold the row’s previous cost; a variant whose cost was set by hand keeps it, and nothing is sent to a marketplace.

searchTermsstring[]
sizeChartUrlstring (uri) | null
videoUrlstring (uri) | null
channelMetaobject

Per-channel bindings, merged KEY BY KEY on update: an absent key keeps the stored value, an explicit null deletes it. Prefer the top-level categoryId for the category; the server writes it to the right key below. TikTok: tiktokCategoryId, tiktokCategoryVersion, tiktokWarehouseId, tiktokSizeChartTemplateId, tiktokIsCodAllowed, tiktokRegion, tiktokCategoryByRegion, tiktokPriceMultiplierByRegion, tiktokProductHighlights. tiktokProductHighlights is the Product highlights every listing built from the template publishes unless it states its own (a product’s highlights): a list of texts, one per bullet, at most 5 entries and 1,500 characters (Unicode code points) across them, else validation_failed. Entries are trimmed and blank ones dropped; an empty list or null removes the key, and a listing whose template states none keeps the highlights TikTok already shows on its next update. eBay: ebayCategoryId, ebayFulfillmentPolicyId, ebayPaymentPolicyId, ebayReturnPolicyId, ebayMerchantLocationKey, ebayCondition, ebayMarketplace. Etsy: etsyCategoryId, etsyShippingProfileId, etsyReturnPolicyId, etsyProcessingProfileId, etsyShopSectionId, etsyPersonalizationId, etsyWhoMade, etsyWhenMade, etsyIsSupply, etsyMaterials. Amazon: amazonProductType, amazonBulletPoints, amazonBulletTemplateId, amazonGenericKeyword, amazonBrand, amazonLeadTimeToShipMaxDays, amazonFulfillmentChannelCode, amazonShippingPackageTemplateId, amazonContentId, amazonMarketplace, amazonAttributes. Any channel: brandId, brandName. A key differing from one of these only in case or punctuation is REFUSED, naming the key you meant. An unrecognised key is stored and reported in meta.warnings, because it is never published. Every id has a listing endpoint: GET /ebay/policies, /ebay/locations, /etsy/policies, /etsy/personalizations, /amazon/contents, /amazon/product-types, /amazon/bullet-templates, /templates/brands, /templates/size-charts and /authorize/shops/{id}/warehouses.

Extra publish targets beyond the primary channel, each with its own taxonomy.

hiddenboolean

Responses

200TemplateResponse
StatusMeaning (body: error envelope)
400

Validation failed, or the request is not valid for this resource.

401

The API key is missing, unknown, revoked or expired.

403

The API key lacks the required scope, or is not bound to this shop.

404

No such resource for this tenant.

409

The request conflicts with the current state (see error.code).

422

The marketplace rejected the request; error.details carries its own message.

429

Back off and retry. error.code says whose limit was hit: rate_limited is ours (honour Retry-After), channel_rate_limited is the marketplace throttling us, channel_unavailable is the marketplace being unreachable.

500

A defect on our side (internal_error), and the only status left outside the 4xx range. The origin emits the envelope below, but the edge in front of api.doctorx.vn replaces the body of a 5xx with its own plain-text page, so do NOT require this body to parse: branch on the status.

Request sample

curl -X PATCH 'https://api.doctorx.vn/api/public/v1/templates/string' \
  -H "Authorization: Bearer $DOCTORX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
DELETE/templates/{id}

Refused while products still reference it.

Parameters

NameInTypeDescription
idrequired
pathstring

Responses

200DeleteResultResponse
StatusMeaning (body: error envelope)
400

Validation failed, or the request is not valid for this resource.

401

The API key is missing, unknown, revoked or expired.

403

The API key lacks the required scope, or is not bound to this shop.

404

No such resource for this tenant.

409

The request conflicts with the current state (see error.code).

422

The marketplace rejected the request; error.details carries its own message.

429

Back off and retry. error.code says whose limit was hit: rate_limited is ours (honour Retry-After), channel_rate_limited is the marketplace throttling us, channel_unavailable is the marketplace being unreachable.

500

A defect on our side (internal_error), and the only status left outside the 4xx range. The origin emits the envelope below, but the edge in front of api.doctorx.vn replaces the body of a 5xx with its own plain-text page, so do NOT require this body to parse: branch on the status.

Request sample

curl -X DELETE 'https://api.doctorx.vn/api/public/v1/templates/string' \
  -H "Authorization: Bearer $DOCTORX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
POST/templates/{id}/duplicate

Parameters

NameInTypeDescription
idrequired
pathstring

Responses

201TemplateResponse
StatusMeaning (body: error envelope)
400

Validation failed, or the request is not valid for this resource.

401

The API key is missing, unknown, revoked or expired.

403

The API key lacks the required scope, or is not bound to this shop.

404

No such resource for this tenant.

409

The request conflicts with the current state (see error.code).

422

The marketplace rejected the request; error.details carries its own message.

429

Back off and retry. error.code says whose limit was hit: rate_limited is ours (honour Retry-After), channel_rate_limited is the marketplace throttling us, channel_unavailable is the marketplace being unreachable.

500

A defect on our side (internal_error), and the only status left outside the 4xx range. The origin emits the envelope below, but the edge in front of api.doctorx.vn replaces the body of a 5xx with its own plain-text page, so do NOT require this body to parse: branch on the status.

Request sample

curl -X POST 'https://api.doctorx.vn/api/public/v1/templates/string/duplicate' \
  -H "Authorization: Bearer $DOCTORX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"