Deletes personalization for a listing.'
tags:
- ShopListing Personalization
parameters:
- name: shop_id
in: path
description: The unique positive non-zero numeric ID for an Etsy Shop.
required: true
schema:
type: integer
description: The unique positive non-zero numeric ID for an Etsy Shop.
format: int64
minimum: 1
example: 123456
- name: listing_id
in: path
description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
required: true
schema:
type: integer
description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
format: int64
minimum: 1
example: 123456789
responses:
'204':
description: The ListingPersonalization resource was correctly deleted
'404':
description: A resource could not be found. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
DeleteListingPersonalization404Example:
summary: Default deleteListingPersonalization 404 response
x-microcks-default: true
value:
error: example string
'400':
description: There was a problem with the request data. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
DeleteListingPersonalization400Example:
summary: Default deleteListingPersonalization 400 response
x-microcks-default: true
value:
error: example string
'403':
description: The request attempted to perform an operation it is not allowed to. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
DeleteListingPersonalization403Example:
summary: Default deleteListingPersonalization 403 response
x-microcks-default: true
value:
error: example string
'401':
description: The request lacks valid authentication credentials. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
DeleteListingPersonalization401Example:
summary: Default deleteListingPersonalization 401 response
x-microcks-default: true
value:
error: example string
'500':
description: The server encountered an internal error. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
DeleteListingPersonalization500Example:
summary: Default deleteListingPersonalization 500 response
x-microcks-default: true
value:
error: example string
security:
- api_key: []
oauth2:
- listings_w
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Etsy Delete Listing Personalization
post:
operationId: updateListingPersonalization
description: '
Creates or updates personalization settings for a listing, allowing the seller to collect personalization from the buyer. This endpoint will fully replace any existing personalization on the listing.'
tags:
- ShopListing Personalization
parameters:
- name: shop_id
in: path
description: The unique positive non-zero numeric ID for an Etsy Shop.
required: true
schema:
type: integer
description: The unique positive non-zero numeric ID for an Etsy Shop.
format: int64
minimum: 1
example: 123456
- name: listing_id
in: path
description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
required: true
schema:
type: integer
description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
format: int64
minimum: 1
example: 123456789
- name: supports_multiple_personalization_questions
in: query
description: 'This query parameter indicates that the caller supports up to 5 personalization questions and the following question types: ''text_input'', ''dropdown'', ''unlabeled_upload'', ''labeled_upload''. Sending this param without updating your application can lead to inadvertently deleting seller-entered data.'
required: false
schema:
type: boolean
description: 'This query parameter indicates that the caller supports up to 5 personalization questions and the following question types: ''text_input'', ''dropdown'', ''unlabeled_upload'', ''labeled_upload''. Sending this param without updating your application can lead to inadvertently deleting seller-entered data.'
nullable: true
example: true
requestBody:
content:
application/json:
schema:
type: object
required:
- personalization_questions
properties:
personalization_questions:
type: array
items:
type: object
properties:
question_id:
type: integer
description: 'The ID of the personalization question. This field is optional. Include it when updating an existing question; omit it when creating a new question. Note: This value may change if the personalization question is updated.'
format: int64
nullable: true
minimum: 1
question_text:
type: string
description: 'The title of the personalization question. Must be between 1 and 45 characters. Note: During the migration to the new personalization endpoints, if you''re still using a legacy UI (without a title input),please send the default value ''Personalization''.'
instructions:
type: string
description: Optional instructions for a personalization question. This field is not allowed for 'dropdown' questions. For legacy, single personalization, max length is 256 characters. Once multiple personalization questions are enabled, the max length will be 120 characters.
nullable: true
question_type:
type: string
description: 'The type of the personalization question. Note: Currently, only a single question with type ''text_input'' is supported. See https://developers.etsy.com/documentation/tutorials/personalization-migration for details about new question types.'
enum:
- text_input
- dropdown
- unlabeled_upload
- labeled_upload
required:
type: boolean
description: When true, the personalization question is required.
max_allowed_files:
type: integer
description: The maximum number of files the buyer may upload in response to a personalization question. This field is optional and only applicable to 'unlabeled_upload' and 'labeled_upload' questions.
nullable: true
max_allowed_characters:
type: integer
description: The maximum number of characters the buyer may enter in response to a personalization question. This field is optional and only applicable to 'text_input' questions.
nullable: true
options:
type: array
description: The list of options for a personalization question. For 'dropdown' questions, this list contains the options for the dropdown. For 'labeled_upload' questions, this list contains the labels for the files that the buyer may upload, and must match the max_allowed_files value..
nullable: true
items:
type: object
properties:
option_id:
type: integer
description: 'The ID of the option. This field is optional. Include it when updating an existing option; omit it when creating a new option. Note: This value may change if the option or question is updated.'
format: int64
nullable: true
minimum: 1
label:
type: string
description: 'The option label. Note: For ''dropdown'' questions, max length is 20 characters. For ''labeled_upload'' questions, max length is 45 characters.'
required:
- label
required:
- question_text
- question_type
- required
examples:
UpdateListingPersonalizationRequestExample:
summary: Default updateListingPersonalization request
x-microcks-default: true
value:
personalization_questions:
- question_id: 1
question_text: example string
instructions: example string
question_type: text_input
required: true
max_allowed_files: 1
max_allowed_characters: 1
options:
- option_id: 1
label: example string
responses:
'201':
description: A single Listing Personalization record
content:
application/json:
schema:
$ref: '#/components/schemas/Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_ListingPersonalization'
examples:
UpdateListingPersonalization201Example:
summary: Default updateListingPersonalization 201 response
x-microcks-default: true
value:
personalization_questions:
- question_id: 1
question_text: example string
instructions: example string
question_type: example string
required: true
max_allowed_characters: 1
max_allowed_files: 1
options:
- {}
'400':
description: There was a problem with the request data. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
UpdateListingPersonalization400Example:
summary: Default updateListingPersonalization 400 response
x-microcks-default: true
value:
error: example string
'401':
description: The request lacks valid authentication credentials. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
UpdateListingPersonalization401Example:
summary: Default updateListingPersonalization 401 response
x-microcks-default: true
value:
error: example string
'403':
description: The request attempted to perform an operation it is not allowed to. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
UpdateListingPersonalization403Example:
summary: Default updateListingPersonalization 403 response
x-microcks-default: true
value:
error: example string
'404':
description: A resource could not be found. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
UpdateListingPersonalization404Example:
summary: Default updateListingPersonalization 404 response
x-microcks-default: true
value:
error: example string
'409':
description: There was a request conflict with the current state of the target resource. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
UpdateListingPersonalization409Example:
summary: Default updateListingPersonalization 409 response
x-microcks-default: true
value:
error: example string
'500':
description: The server encountered an internal error. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
UpdateListingPersonalization500Example:
summary: Default updateListingPersonalization 500 response
x-microcks-default: true
value:
error: example string
security:
- api_key: []
oauth2:
- listings_w
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Etsy Update Listing Personalization
/v3/application/listings/{listing_id}/personalization:
get:
operationId: getListingPersonalization
description: '