Поделиться через


Etsy (независимый издатель)

Этот соединитель использует ключ API для доступа к различным функциям Etsy.com. Он поддерживает действия по инвентаризации, заказам на продажу и управлению магазинами. Все действия основаны на Etsy Open API версии 3, которая имеет конечные точки, которые по-прежнему находятся в бета-версии. Если такие действия используют бета-API, действие с включенной бета-версией в заголовок и возвращает код ответа 501.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Трой Тейлор
URL https://www.hitachisolutions.com
Адрес электронной почты ttaylor@hitachisolutions.com
Метаданные соединителя
Publisher Трой Тейлор, Решения Похасти
Website https://www.etsy.com/
Политика конфиденциальности https://www.etsy.com/legal/privacy/
Категории Commerce

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Ключ API securestring Ключ API для этого API True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Ping

Проверьте, чтобы подтвердить подключение к API Etsy с помощью приложения.

Обновление изображений вариантов в списке

Создает изображения вариантов в списке.

Обновление инвентаризации списка

Обновляет инвентаризацию для списка, определяемого идентификатором списка. Обновление завершается ошибкой, если указанные значения для номера SKU продукта, количество предложений и /или цена несовместимы со значениями в полях свойств. При задании цены назначьте значение float равно сумме, разделенной делителем, как указано в ресурсе денег.

Обновление магазина

Обновите магазин. Предполагается, что все строковые параметры предоставляются на основном языке магазина.

Обновление назначения профиля доставки

Обновляет существующее место назначения доставки, которое может задать или переназначить стоимость доставки, перевозчик и класс для назначения.

Обновление обновления профиля доставки

Обновляет обновление профиля доставки и обновляет все списки, использующие профиль доставки.

Обновление перевода списка

Обновляет перевод списка путем перечисления идентификатора и языка.

Обновление профиля доставки

Изменяет параметры в профиле доставки.

Обновление свойства перечисления

Обновляет или заполняет список свойств, определяющих предложения продуктов для перечисления. Для каждого предложения требуется как значение, так и идентификатор значения, допустимые для идентификатора масштабирования, назначенного списку или назначенные списку с этим запросом.

Обновление списка

Обновляет список, определенный идентификатором списка, для определенного магазина, определяемого идентификатором магазина.

Отправка изображения с описанием

Отправляет или назначает изображение в список, определяемый идентификатором магазина с идентификатором списка. Чтобы отправить новое изображение, задайте файл образа в качестве значения параметра изображения. Вы можете назначить ранее удаленное изображение списку с помощью идентификатора образа удаленного образа в параметре идентификатора изображения для перечисления. Если запрос содержит значения параметров идентификатора изображения и изображения, конечная точка отправляет изображение только в параметре изображения.

Отправка файла перечисления

Отправляет новый файл для цифрового описания или связывает существующий файл с определенным списком. Необходимо указать идентификатор файла перечисления существующего файла или имя и двоичные данные файла для отправки файла. Связывание существующего файла с физическим списком преобразует физический список в цифровой список, который удаляет все затраты на доставку и любые варианты продукта и инвентаризации.

Поиск магазинов

Возвращает список магазинов с соответствующим именем.

Получение адреса пользователя

Извлекает адрес пользователя. Разработка для этой конечной точки выполняется. Он возвращает только ответ 501.

Получение адресов пользователей

Получение списка адресов пользователей.

Получение активных списков

Список всех активных списков на страницы Etsy с разбивкой на страницы по дате их создания. Без списков заказов сортировки по умолчанию будут возвращены самые новые.

Получение активных списков по магазинам

Извлекает список всех активных списков в Etsy в определенном магазине, разбиение на страницы по дате создания списка.

Получение всех файлов списка

Извлекает все файлы, связанные с указанным цифровым списком. Запрос файлов из физического списка возвращает пустой результат.

Получение записей реестра счета оплаты магазина

Получение записей реестра учетных записей оплаты магазина.

Получение изображений вариантов описания

Получает все изображения вариантов в списке.

Получение изображений списка

Извлекает все ресурсы изображения для перечисления с определенным идентификатором списка.

Получение изображения с описанием

Извлекает ссылки и метаданные для изображения с определенным идентификатором изображения.

Получение инвентаризации списка

Извлекает запись инвентаризации для перечисления. Списки, которые вы не редактировали с помощью средств инвентаризации Etsy.com, не имеют записей инвентаризации. Эта конечная точка возвращает данные SKU, если вы являетесь владельцем записей инвентаризации, извлекаемых.

Получение квитанции

Получает квитанцию, определяемую идентификатором квитанции, из магазина Etsy.

Получение квитанций

Запрашивает квитанции магазина от определенного магазина, нефильтрованного или отфильтрованного по диапазону или смещением, дате, платным и/или отправленным покупкам.

Получение магазина по идентификатору владельца

Извлекает магазин, определенный идентификатором пользователя владельца магазина.

Получение назначений профилей по профилям доставки

Извлекает список объектов назначения доставки, связанных с профилем доставки.

Получение обновлений профиля доставки

Извлекает список обновлений профилей доставки, назначенных конкретному профилю доставки.

Получение отзывов

Извлекает отзывы из магазина с его идентификатором.

Получение перевода списка

Возвращает перевод для перечисления на данном языке.

Получение перевозчиков доставки

Извлекает список доступных перевозчиков доставки и классы почты, связанные с ними для данной страны.

Получение платежа из определенной квитанции

Извлекает платеж из определенного квитанции, определяемого идентификатором квитанции, из определенного магазина, определяемого идентификатором магазина.

Получение платежа с идентификатора записи реестра учетной записи оплаты

При необходимости получите платеж из идентификатора записи реестра учетной записи оплаты.

Получение пользователя

Возвращает профиль пользователя, определяемый идентификатором пользователя.

Получение предложения в списке

Получите предложение для перечисления.

Получение продукта списка

Получение описания продукта по идентификатору.

Получение профилей доставки

Извлекает список профилей доставки, доступных в определенном магазине Etsy, определяемом его идентификатором магазина.

Получение профиля доставки

Извлекает профиль доставки, на который ссылается идентификатор профиля доставки.

Получение раздела магазина

Извлекает раздел магазина, на который ссылается идентификатор раздела и идентификатор магазина.

Получение разделов магазина

Извлекает список разделов магазина в определенном магазине, определяемом идентификатором магазина.

Получение рекомендуемых списков по магазинам

Извлекает списки, связанные с магазином, который представлен.

Получение свойств продукта по идентификатору таксономии

Извлекает список свойств продукта с применимыми шкалами и значениями, поддерживаемыми для определенного идентификатора таксономии продавца.

Получение свойств списка

Возвращает список свойств списка.

Получение свойства описания (бета-версия)

Извлекает свойство перечисления. Разработка для этой конечной точки выполняется. Он возвращает только ответ 501.

Получение списка

Извлекает запись с описанием по идентификатору списка.

Получение списка платежей

Извлекает список платежей из магазина, определяемого идентификатором магазина. Вы также можете фильтровать результаты с помощью списка идентификаторов платежей.

Получение списков по идентификатору

Позволяет запрашивать несколько идентификаторов перечисления одновременно. Ограничение 100 идентификаторов на запрос.

Получение списков по идентификатору раздела магазина

Извлекает все списки из раздела определенного магазина.

Получение списков по квитанции магазина

Возвращает все перечисления, связанные с квитанцией.

Получение списков по магазинам

Возвращает списки, принадлежащие магазину. Списки можно фильтровать с помощью параметра состояния.

Получение транзакции

Извлекает транзакцию по идентификатору транзакции.

Получение транзакции квитанции

Извлекает список транзакций, связанных с определенной квитанцией.

Получение транзакции магазина

Извлекает список транзакций, связанных с магазином.

Получение транзакций списка

Извлекает список транзакций, связанных со списком.

Получение узлов таксономии продавца

Извлекает дерево полной иерархии узлов таксономии продавца.

Получение файла из списка

Извлекает один файл, связанный с заданным цифровым описанием. Запрос файла из физического списка возвращает пустой результат.

Создание квитанции о доставке

Отправляет сведения об отслеживании для квитанции магазина, которая создает запись отправки в магазин для указанного идентификатора квитанции. Каждый раз, когда вы успешно отправляете сведения об отслеживании, Etsy отправляет уведомление пользователю покупателя. При отправке BCC имеет значение true, Etsy также отправляет уведомления о доставке продавцу. Если код отслеживания и имя оператора не отправляются, квитанция помечается только как отправленная.

Создание назначения профиля доставки

Создает новое место назначения доставки, которое задает стоимость доставки, перевозчик и класс для назначения в профиле доставки. Это назначает затраты с помощью валюты связанного магазина. Задайте место назначения с помощью iso-адреса страны назначения или региона назначения; Страны назначения ISO и целевой регион являются взаимоисключающими — задают один или другой. Установка обоих триггеров ошибки 400. Если запрос не задает ни iso страны назначения, ни региона назначения, назначение по умолчанию везде. Кроме того, необходимо назначить как идентификатор перевозчика, так и класс почты, либо как минимальные дни доставки, так и максимальные дни доставки.

Создание обновления профиля доставки

Создает новое обновление профиля доставки, которое может установить цену на вариант доставки, например альтернативный перевозчик или более быструю доставку.

Создание перевода списка

Создает перевод перечисления по идентификатору и языку.

Создание профиля доставки

Создает новый профиль доставки. При создании профиля доставки можно передать iso-код страны или регион, но не оба. Требуется только один. Необходимо передать либо идентификатор перевозчика, либо класс почты, либо минимальное и максимальное время доставки.

Создание раздела магазина

Создает новый раздел в определенном магазине.

Создание черновика

Создает физический черновик описания продукта в магазине на канале Etsy.

Удаление изображения с описанием

Удаляет изображение с описанием. Копия файла остается на наших серверах, поэтому удаленный образ может быть повторно связан с описанием без повторной отправки исходного образа.

Удаление назначения профиля доставки

Удаляет место назначения доставки и удаляет вариант назначения из каждого списка, использующего связанный профиль доставки. Профиль доставки требует по крайней мере одного назначения доставки, поэтому эта конечная точка не может удалить конечное место назначения доставки для любого профиля доставки. Чтобы удалить окончательное назначение доставки из профиля доставки, необходимо удалить весь профиль доставки.

Удаление обновления профиля доставки

Удаляет обновление профиля доставки и удаляет параметр обновления из каждого списка, использующего связанный профиль доставки.

Удаление профиля доставки

Удаляет профиль доставки по указанному идентификатору.

Удаление свойства перечисления

Удаляет свойство из списка.

Удаление списка

Это действие удаляет список магазинов. Список можно удалить только в том случае, если состояние является одним из следующих: SOLD_OUT, ЧЕРНОВИК, СРОК ДЕЙСТВИЯ, НЕАКТИВНЫЙ, АКТИВНЫй и is_available или активный и имеет флаги продаж: SUPRESSED (заморожено), ОТПУСК, CUSTOM_SHOPS (шаблон), SELL_ON_FACEBOOK

Удаление файла из списка

При удалении окончательного файла для цифрового описания список преобразуется в физический список. Ответ на запрос на удаление возвращает список оставшихся записей файлов, связанных с указанным списком.

Ping

Проверьте, чтобы подтвердить подключение к API Etsy с помощью приложения.

Возвращаемое значение

Подтверждение того, что текущее приложение имеет доступ к Open API

Вонь
Pong

Обновление изображений вариантов в списке

Создает изображения вариантов в списке.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Изображения вариантов
variation_images True string

Массив данных изображения вариантов.

Возвращаемое значение

Представляет несколько изображений вариантов описания.

ListingVariationImages
ListingVariationImages

Обновление инвентаризации списка

Обновляет инвентаризацию для списка, определяемого идентификатором списка. Обновление завершается ошибкой, если указанные значения для номера SKU продукта, количество предложений и /или цена несовместимы со значениями в полях свойств. При задании цены назначьте значение float равно сумме, разделенной делителем, как указано в ресурсе денег.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор перечисления
listing_id True string

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Products
products True string

Массив json продуктов, доступных в списке, даже если только один продукт. Все имена полей в БОЛЬШИХ двоичных объектах JSON являются строчными буквами.

Цена на недвижимость
price_on_property string

Массив уникальных целых чисел идентификатора свойства для свойств, которые изменяют цены на продукты, если таковые есть. Например, если вы взимаете определенные цены на продукты разного размера в одном списке, этот массив содержит идентификатор свойства для размера.

Количество в свойстве
quantity_on_property string

Массив уникальных целых чисел идентификатора свойства перечисления для свойств, изменяющих количество продуктов, если таковые есть. Например, если вы запасаете определенное количество различных цветных продуктов в одном списке, этот массив содержит идентификатор свойства для цвета.

Номер SKU в свойстве
sku_on_property string

Массив уникальных чисел идентификатора свойства перечисления для свойств, изменяющих номер SKU продукта, если таковой есть. Например, если в одном и том же списке используются определенные номера skus для разных цветных продуктов, этот массив содержит идентификатор свойства для цвета.

Возвращаемое значение

Представление записи инвентаризации одного списка.

ЛистингInventory
ListingInventory

Обновление магазина

Обновите магазин. Предполагается, что все строковые параметры предоставляются на основном языке магазина.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Название
title string

Краткая строка заголовка для главной страницы магазина.

Объявление
announcement string

Строка объявления для покупателей, которые отображаются на домашней странице магазина.

Сообщение о продаже
sale_message string

Строка сообщения, отправленная пользователям, которые завершают покупку из этого магазина.

Сообщение о цифровой продаже
digital_sale_message string

Строка сообщения, отправленная пользователям, которые покупают цифровой элемент из этого магазина.

Возвращаемое значение

Магазин, созданный пользователем Etsy.

Магазин
Shop

Обновление назначения профиля доставки

Обновляет существующее место назначения доставки, которое может задать или переназначить стоимость доставки, перевозчик и класс для назначения.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор профиля доставки
shipping_profile_id True string

Числовые идентификаторы профиля доставки, связанного с описанием.

Идентификатор назначения профиля доставки
shipping_profile_destination_id True string

Числовые идентификаторы назначения профиля доставки, а также список.

primary_cost
primary_cost string

primary_cost

secondary_cost
secondary_cost string

secondary_cost

destination_country_iso
destination_country_iso string

destination_country_iso

destination_region
destination_region string

destination_region

shipping_carrier_id
shipping_carrier_id integer

shipping_carrier_id

mail_class
mail_class string

mail_class

min_delivery_days
min_delivery_days integer

min_delivery_days

max_delivery_days
max_delivery_days integer

max_delivery_days

Возвращаемое значение

Представляет место назначения доставки, назначенное профилею доставки.

ShopShippingProfileDestination
ShopShippingProfileDestination

Обновление обновления профиля доставки

Обновляет обновление профиля доставки и обновляет все списки, использующие профиль доставки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор профиля доставки
shipping_profile_id True integer

Числовые идентификаторы профиля доставки, связанного с описанием.

Идентификатор обновления
upgrade_id True integer

Числовой идентификатор, связанный с обновлением доставки

Тип
type string

Тип обновления доставки. Внутренний (0) или международный (1).

Имя обновления
upgrade_name string

Имя обновления доставки, отображаемое покупателям при извлечении, например приоритет USPS.

Цена
price float

Дополнительные затраты на добавление обновления доставки.

Вторичная цена
secondary_price float

Дополнительные затраты на добавление обновления доставки для каждого дополнительного элемента.

Идентификатор перевозчика доставки
shipping_carrier_id integer

Уникальный идентификатор поддерживаемого перевозчика доставки, который используется для вычисления предполагаемой даты доставки.

Класс Mail
mail_class string

Уникальная строка идентификатора класса почты перевозчика, которая используется для вычисления предполагаемой даты доставки.

Минимальные дни доставки
min_delivery_days integer

min_delivery_days

Максимальное количество дней доставки
max_delivery_days integer

Максимальное количество рабочих дней, которое покупатель может ожидать, чтобы получить свой приобретенный элемент после отправки.

Возвращаемое значение

Представление параметра обновления профиля доставки.

ShopShippingProfileUpgrade
ShopShippingProfileUpgrade

Обновление перевода списка

Обновляет перевод списка путем перечисления идентификатора и языка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Language
language True string

Тег языка IETF для языка этого перевода. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.

Название
title True string

Название перечисления этого перевода.

Description
description True string

Описание описания этого перевода.

Метки
tags string

Теги перечисления этого перевода.

Возвращаемое значение

Представляет данные перевода для перечисления.

ПеречислениеTranslation
ListingTranslation

Обновление профиля доставки

Изменяет параметры в профиле доставки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор профиля доставки
shipping_profile_id True integer

Числовые идентификаторы профиля доставки, связанного с описанием.

Название
title string

Строка имени этого профиля доставки.

ISO-код страны происхождения
origin_country_iso string

ISO-код страны, из которой выполняется перечисление.

Минимальное время обработки
min_processing_time integer

Минимальное время, необходимое для обработки для отправки списков с этим профилем доставки.

Максимальное время обработки
max_processing_time integer

Максимальное время обработки, необходимое для отправки списка.

Единица времени обработки
processing_time_unit string

Единица, используемая для представления времени обработки. Неделя эквивалентна 5 рабочих дней. Если этот параметр не указан, для единицы задано значение business_days.

Почтовый индекс источника
origin_postal_code string

Строка почтового кода (не обязательно номер) для расположения, из которого поставляется список.

Возвращаемое значение

Представляет профиль, используемый для задания сведений о доставке списка. Обратите внимание, что с помощью API невозможно создать вычисляемые шаблоны доставки. Однако вы можете связать вычисляемые профили доставки, созданные из Диспетчера магазинов, с описаниями с помощью API.

ShopShippingProfile
ShopShippingProfile

Обновление свойства перечисления

Обновляет или заполняет список свойств, определяющих предложения продуктов для перечисления. Для каждого предложения требуется как значение, так и идентификатор значения, допустимые для идентификатора масштабирования, назначенного списку или назначенные списку с этим запросом.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Идентификатор свойства
property_id True integer

Уникальный идентификатор свойства перечисления Etsy.

Идентификаторы значений
value_ids True integer

Числовый идентификатор одного Etsy.com шкалы измерения.

Ценности
values True string

Массив строк значений для нескольких значений свойств Etsy.

Идентификатор масштабирования
scale_id integer

Числовый идентификатор одного Etsy.com шкалы измерения.

Возвращаемое значение

Представление структурированных значений данных.

ЛистингPropertyValue
ListingPropertyValue

Обновление списка

Обновляет список, определенный идентификатором списка, для определенного магазина, определяемого идентификатором магазина.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Количество
quantity integer

Положительное ненулевое количество продуктов, доступных для покупки в списке.

Название
title string

Строка заголовка списка. Допустимые строки заголовка содержат только буквы, цифры, знаки препинания, математические символы, символы пробелов, ™ © и . ® (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) Вы можете использовать только %, :, и + символы один раз.

Description
description string

Строка описания продукта для продажи в списке.

Цена
price float

Положительная ненулевая цена продукта. (Списки проданных продуктов являются частными) Примечание. Цена является минимальной возможной ценой.

Кто сделал
who_made string

Строка идикнула, кто сделал продукт. Помогает покупателям найти список под заголовком Handmade. Требуется "is_supply" и "when_made".

Когда сделано
when_made string

Строка для эпохи, в которой производитель сделал продукт в этом списке. Помогает покупателям найти список под заголовком "Винтаж". Требуется "is_supply" и "who_made".

Идентификатор таксономии
taxonomy_id integer

Числовый идентификатор таксономии перечисления. Продавец управляет перечислением идентификаторов таксономии для своего магазина.

Идентификатор профиля доставки
shipping_profile_id integer

Числовые идентификаторы профиля доставки, связанного с описанием.

Materials
materials string

Массив строк материала для материалов, используемых в продукте. Допустимые строки материалов содержат только буквы, цифры и пробелы. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

Идентификатор раздела магазина
shop_section_id integer

Числовые идентификаторы раздела магазина для этого списка.

Минимальное значение обработки
processing_min integer

Минимальное количество дней, необходимых для обработки этого списка.

Максимальное значение обработки
processing_max integer

Максимальное количество дней, необходимых для обработки этого списка.

Метки
tags string

Массив строк тегов для перечисления. Допустимые строки тегов содержат только буквы, цифры, символы пробелов, -, ', ™ , © и ® . (regex: /[^\p{L}\p{Nd}\p{Zs}-'™©®]/u)

Recipient
recipient string

Строка, указывающая человека, для которого этот продукт сделает соответствующий подарок.

Случай
occasion string

Строка, указывающая случай, для которого этот продукт сделает соответствующий подарок.

Стили
styles string

Массив строк стилей для этого списка, каждый из которых является текстовой строкой свободной формы, такой как "Формальный" или "Steampunk". Список может содержать до двух стилей. Допустимые строки стиля содержат только буквы, цифры и пробелы. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

Вес элемента
item_weight float

Числовой вес продукта, измеряемого в единицах, заданных в единицах веса элемента.

Длина элемента
item_length integer

Числовая длина продукта, измеряемого в единицах измерения элемента.

Ширина элемента
item_width float

Числовая ширина продукта, измеряемая в единицах, заданных в единицах измерения элемента.

Высота элемента
item_height float

Числовая высота продукта, измеряемого в единицах, заданных в единицах измерения элемента.

Единица веса элемента
item_weight_unit string

Строка, определяющая единицы, используемые для измерения веса продукта.

Единица измерения элементов
item_dimensions_unit string

Строка, определяющая единицы, используемые для измерения измерений продукта.

Персонализировано
is_personalizable boolean

Если значение true, это описание является персонализированным.

Идентификаторы изображений
image_ids string

Массив числовых идентификаторов изображений в списке, который может содержать до 10 изображений.

Предоставляется
is_supply boolean

Если задано значение true, теги списка как продукта поставки, в противном случае указывает, что это готовый продукт. Помогает покупателям найти список под заголовком "Поставки". Требует ,кто сделал" и "когда сделал".

Настраивается
is_customizable boolean

Если верно, покупатель может обратиться к продавцу за настраиваемым заказом. Значение по умолчанию имеет значение true, если магазин принимает пользовательские заказы. Не применяется к магазинам, которые не принимают пользовательские заказы.

Является налогооблагаемым
is_taxable boolean

Если верно, применимые налоговые ставки магазина применяются к этому списку при выходе.

Избранный ранг
featured_ rank integer

Положительное ненулевое числовое положение в рекомендуемых списках магазина с рангом 1 списки, отображаемых в левой части списка в описанном списке на домашней странице магазина.

Автоматическое продление
should_auto_renew boolean

Когда значение true, продлевает список в течение четырех месяцев после эксприации. Если задано значение true, если ранее значение false, etsy.com продлевает список до истечения срока действия, но период продления начинается без необходимости, а не продление срока действия списка. Любое неиспользуемое время, оставшееся в списке, теряется. Продление приводит к оплате счета пользователя.

Тип
type string

Указывает, является ли перечисление физическим или цифровым скачиванием.

Каналы
channels string

Массив строк идентификатора перечисленного канала. Канал является местом для продавцов, чтобы достичь покупателей, чтобы сделать продажи.

Возвращаемое значение

Список из магазина, который содержит количество продуктов, название, описание, цену и т. д.

ShopListing
ShopListing

Отправка изображения с описанием

Отправляет или назначает изображение в список, определяемый идентификатором магазина с идентификатором списка. Чтобы отправить новое изображение, задайте файл образа в качестве значения параметра изображения. Вы можете назначить ранее удаленное изображение списку с помощью идентификатора образа удаленного образа в параметре идентификатора изображения для перечисления. Если запрос содержит значения параметров идентификатора изображения и изображения, конечная точка отправляет изображение только в параметре изображения.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Изображение
image string

Строка имени файла для отправки.

Перечисление идентификатора изображения
listing_image_id integer

Числовые идентификаторы первичного изображения перечисления для этой транзакции.

Ранг
rank integer

Положительное числовое положение, отличное от нуля, в изображениях, отображаемых в списке, с рангом 1 изображения отображаются в левой позиции в списке.

Перезаписать
overwrite boolean

Если задано значение true, этот запрос заменяет существующий образ на заданном ранге.

Подложка
is_watermarked boolean

Если значение true, указывает, что отправленное изображение имеет подложку.

Возвращаемое значение

Url-адреса и метаданные для изображения, связанного с определенным списком. Параметр url_fullxfull содержит URL-адрес для файла двоичного образа полного размера.

ПеречислениеImage
ListingImage

Отправка файла перечисления

Отправляет новый файл для цифрового описания или связывает существующий файл с определенным списком. Необходимо указать идентификатор файла перечисления существующего файла или имя и двоичные данные файла для отправки файла. Связывание существующего файла с физическим списком преобразует физический список в цифровой список, который удаляет все затраты на доставку и любые варианты продукта и инвентаризации.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Идентификатор файла перечисления
listing_file_id integer

Уникальный числовый идентификатор файла, связанного с цифровым листингом.

Файл
file True string

Двоичный файл для отправки.

Имя
name string

Строка имени файла для отправки

Ранг
rank integer

Положительное числовое положение, отличное от нуля, в изображениях, отображаемых в списке, с рангом 1 изображения отображаются в левой позиции в списке.

Возвращаемое значение

Файл, связанный с цифровым списком.

ShopListingFile
ShopListingFile

Поиск магазинов

Возвращает список магазинов с соответствующим именем.

Параметры

Имя Ключ Обязательно Тип Описание
Название магазина
shop_name True string

Строка имени магазина.

Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Возвращаемое значение

Набор записей Магазина.

Магазины
Shops

Получение адреса пользователя

Извлекает адрес пользователя. Разработка для этой конечной точки выполняется. Он возвращает только ответ 501.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор адреса пользователя
user_address_id True integer

Числовой идентификатор адреса пользователя.

Возвращаемое значение

Представляет адрес пользователя.

UserAddress
UserAddress

Получение адресов пользователей

Получение списка адресов пользователей.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Возвращаемое значение

Представляет несколько записей UserAddress.

UserAddresses
UserAddresses

Получение активных списков

Список всех активных списков на страницы Etsy с разбивкой на страницы по дате их создания. Без списков заказов сортировки по умолчанию будут возвращены самые новые.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Includes
keywords string

Поисковый термин или фраза, которые должны отображаться во всех результатах.

Сортировка по
sort_on string

Значение для сортировки результата поиска списков. ПРИМЕЧАНИЕ. Сортировка выполняется только в сочетании с одним из вариантов поиска (ключевые слова, регион и т. д.).

Порядок сортировки
sort_order string

Порядок сортировки по возрастанию (вверх) или убыванию (вниз) для сортировки списков. ПРИМЕЧАНИЕ. sort_order работает только в сочетании с одним из вариантов поиска (ключевые слова, регион и т. д.).

Минимальная цена
min_price float

Минимальная цена листингов, возвращаемая результатом поиска.

Максимальная цена
max_price float

Максимальная цена списков, возвращаемая результатом поиска.

Идентификатор таксономии
taxonomy_id integer

Числовый идентификатор таксономии перечисления. Продавец управляет перечислением идентификаторов таксономии для своего магазина.

Расположение магазина
shop_location string

Фильтры по расположению магазина. Если не удается проанализировать расположение, Etsy отвечает ошибкой.

Возвращаемое значение

Набор ресурсов для описания магазинов.

ShopListings
ShopListings

Получение активных списков по магазинам

Извлекает список всех активных списков в Etsy в определенном магазине, разбиение на страницы по дате создания списка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Includes
keywords string

Поисковый термин или фраза, которые должны отображаться во всех результатах.

Возвращаемое значение

Набор ресурсов для описания магазинов.

ShopListings
ShopListings

Получение всех файлов списка

Извлекает все файлы, связанные с указанным цифровым списком. Запрос файлов из физического списка возвращает пустой результат.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Идентификатор перечисления
listing_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Возвращаемое значение

Представляет несколько shopListingFiles.

ShopListingFiles
ShopListingFiles

Получение записей реестра счета оплаты магазина

Получение записей реестра учетных записей оплаты магазина.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Минимальное создание
min_created True integer

Самая ранняя метка времени unix для момента создания записи.

Максимальное число созданных
max_created True integer

Последняя метка времени unix для момента создания записи.

Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Возвращаемое значение

Набор ресурсов записи реестра учетных записей оплаты

PaymentAccountLedgerEntries
PaymentAccountLedgerEntries

Получение изображений вариантов описания

Получает все изображения вариантов в списке.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Возвращаемое значение

Представляет несколько изображений вариантов описания.

ListingVariationImages
ListingVariationImages

Получение изображений списка

Извлекает все ресурсы изображения для перечисления с определенным идентификатором списка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Возвращаемое значение

Представляет список ресурсов изображения, каждый из которых содержит URL-адреса ссылок и метаданные для изображения.

ПеречислениеImages
ListingImages

Получение изображения с описанием

Извлекает ссылки и метаданные для изображения с определенным идентификатором изображения.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Перечисление идентификатора изображения
listing_image_id True integer

Числовые идентификаторы первичного изображения перечисления для этой транзакции.

Возвращаемое значение

Url-адреса и метаданные для изображения, связанного с определенным списком. Параметр url_fullxfull содержит URL-адрес для файла двоичного образа полного размера.

ПеречислениеImage
ListingImage

Получение инвентаризации списка

Извлекает запись инвентаризации для перечисления. Списки, которые вы не редактировали с помощью средств инвентаризации Etsy.com, не имеют записей инвентаризации. Эта конечная точка возвращает данные SKU, если вы являетесь владельцем записей инвентаризации, извлекаемых.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Includes
includes string

Перечисленная строка, которая присоединяет допустимую связь.

Возвращаемое значение

Представление записи инвентаризации одного списка с сопоставлениями

ЛистингInventoryWithAssociations
ListingInventoryWithAssociations

Получение квитанции

Получает квитанцию, определяемую идентификатором квитанции, из магазина Etsy.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор квитанции
receipt_id True integer

Числовый идентификатор для квитанции, связанной с этой транзакцией.

Возвращаемое значение

Запись покупки из магазина. Чеки магазина отображают денежные значения с помощью валюты магазина.

ShopReceipt
ShopReceipt

Получение квитанций

Запрашивает квитанции магазина от определенного магазина, нефильтрованного или отфильтрованного по диапазону или смещением, дате, платным и/или отправленным покупкам.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Минимальное создание
min_created integer

Самая ранняя метка времени unix для момента создания записи.

Максимальное число созданных
max_created integer

Последняя метка времени unix для момента создания записи.

Самое раннее последнее изменение
min_last_modified integer

Самая ранняя метка времени unix для момента последнего изменения записи.

Последнее последнее изменение
max_last_modified integer

Последняя метка времени unix для момента последнего изменения записи.

Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Было оплачено
was_paid boolean

Когда значение true, продавец получил платеж за продукт в этом квитанции.

Отправлено
was_shipped boolean

Когда значение true, продавец погрузил продукты в этом квитанции.

Возвращаемое значение

Квитанции для определенного магазина.

ShopReceipts
ShopReceipts

Получение магазина по идентификатору владельца

Извлекает магазин, определенный идентификатором пользователя владельца магазина.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
user_id True string

Числовой идентификатор пользователя, который владеет этим магазином.

Возвращаемое значение

Магазин, созданный пользователем Etsy.

Магазин
Shop

Получение назначений профилей по профилям доставки

Извлекает список объектов назначения доставки, связанных с профилем доставки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор профиля доставки
shipping_profile_id True integer

Числовые идентификаторы профиля доставки, связанного с описанием.

Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Возвращаемое значение

Представляет список объектов назначения доставки.

ShopShippingProfileDestinations
ShopShippingProfileDestinations

Получение обновлений профиля доставки

Извлекает список обновлений профилей доставки, назначенных конкретному профилю доставки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор профиля доставки
shipping_profile_id True integer

Числовые идентификаторы профиля доставки, связанного с описанием.

Возвращаемое значение

Список вариантов обновления доставки.

ShopShippingProfileUpgrades
ShopShippingProfileUpgrades

Получение отзывов

Извлекает отзывы из магазина с его идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Возвращаемое значение

Набор записей проверки транзакций, оставленных пользователями.

TransactionReviews
TransactionReviews

Получение перевода списка

Возвращает перевод для перечисления на данном языке.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Language
language True string

Тег языка IETF для языка этого перевода. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.

Возвращаемое значение

Представляет данные перевода для перечисления.

ПеречислениеTranslation
ListingTranslation

Получение перевозчиков доставки

Извлекает список доступных перевозчиков доставки и классы почты, связанные с ними для данной страны.

Параметры

Имя Ключ Обязательно Тип Описание
ISO-код страны происхождения
origin_country_iso True string

ISO-код страны, из которой выполняется перечисление.

Возвращаемое значение

Представляет несколько судоходных карриеров.

ShippingCarriers
ShippingCarriers

Получение платежа из определенной квитанции

Извлекает платеж из определенного квитанции, определяемого идентификатором квитанции, из определенного магазина, определяемого идентификатором магазина.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор квитанции
receipt_id True string

Числовый идентификатор для квитанции, связанной с этой транзакцией.

Возвращаемое значение

Представляет несколько платежей, сделанных с помощью Etsy Payments. Все денежные суммы находятся в долларах США, если иное не указано.

Payments
Payments

Получение платежа с идентификатора записи реестра учетной записи оплаты

При необходимости получите платеж из идентификатора записи реестра учетной записи оплаты.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификаторы записи реестра
ledger_entry_ids True string

Массив целых чисел.

Возвращаемое значение

Представляет несколько платежей, сделанных с помощью Etsy Payments. Все денежные суммы находятся в долларах США, если иное не указано.

Payments
Payments

Получение пользователя

Возвращает профиль пользователя, определяемый идентификатором пользователя.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
user_id True integer

Уникальный положительный ненулевой числовый идентификатор для пользователя.

Возвращаемое значение

Представляет одного пользователя сайта

User
User

Получение предложения в списке

Получите предложение для перечисления.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Код продукта
product_id True integer

Числовой идентификатор продукта, связанного с этой транзакцией.

Идентификатор предложения продукта
product_offering_id True integer

Числовой идентификатор предложения продукта, связанного с этой транзакцией.

Возвращаемое значение

Представление предложения для перечисления.

ЛистингInventoryProductOffering
ListingInventoryProductOffering

Получение продукта списка

Получение описания продукта по идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор перечисления
listing_id True integer

Список для возврата продукта с описанием.

Код продукта
product_id True integer

Числовые идентификаторы для определенного продукта, приобретенного в списке.

Возвращаемое значение

Представление продукта для перечисления.

ЛистингInventoryProduct
ListingInventoryProduct

Получение профилей доставки

Извлекает список профилей доставки, доступных в определенном магазине Etsy, определяемом его идентификатором магазина.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Возвращаемое значение

Представляет профиль, используемый для задания сведений о доставке списка. Обратите внимание, что с помощью API невозможно создать вычисляемые шаблоны доставки. Однако вы можете связать вычисляемые профили доставки, созданные из Диспетчера магазинов, с описаниями с помощью API.

ShopShippingProfile
ShopShippingProfile

Получение профиля доставки

Извлекает профиль доставки, на который ссылается идентификатор профиля доставки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор профиля доставки
shipping_profile_id True integer

Числовые идентификаторы профиля доставки, связанного с описанием.

Получение раздела магазина

Извлекает раздел магазина, на который ссылается идентификатор раздела и идентификатор магазина.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор раздела магазина
shop_section_id True integer

Числовые идентификаторы раздела в определенном магазине Etsy.

Возвращаемое значение

Раздел в магазине, в котором пользователь может сортировать списки.

ShopSection
ShopSection

Получение разделов магазина

Извлекает список разделов магазина в определенном магазине, определяемом идентификатором магазина.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Возвращаемое значение

Все разделы в хреновом магазине.

Магазины
ShopSections

Получение рекомендуемых списков по магазинам

Извлекает списки, связанные с магазином, который представлен.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Возвращаемое значение

Набор ресурсов для описания магазинов.

ShopListings
ShopListings

Получение свойств продукта по идентификатору таксономии

Извлекает список свойств продукта с применимыми шкалами и значениями, поддерживаемыми для определенного идентификатора таксономии продавца.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таксономии
taxonomy_id True string

Уникальный числовый идентификатор узла таксономии Etsy, который является категорией метаданных для перечислений, организованных в дерево иерархии таксономии продавца.

Возвращаемое значение

Список определений свойств продукта.

ТаксономияNodeProperties
TaxonomyNodeProperties

Получение свойств списка

Возвращает список свойств списка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Возвращаемое значение

Представляет несколько значений свойств перечисления.

ЛистингPropertyValues
ListingPropertyValues

Получение свойства описания (бета-версия)

Извлекает свойство перечисления. Разработка для этой конечной точки выполняется. Он возвращает только ответ 501.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Идентификатор свойства
property_id True integer

Уникальный идентификатор свойства перечисления Etsy.

Возвращаемое значение

Представление структурированных значений данных.

ЛистингPropertyValue
ListingPropertyValue

Получение списка

Извлекает запись с описанием по идентификатору списка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Includes
includes string

Перечисленная строка, которая присоединяет допустимую связь. Допустимые входные данные: "магазин", "изображения" и "пользователь".

Получение списка платежей

Извлекает список платежей из магазина, определяемого идентификатором магазина. Вы также можете фильтровать результаты с помощью списка идентификаторов платежей.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор оплаты
payment-ids True string

Разделенный запятыми массив номеров идентификаторов оплаты.

Возвращаемое значение

Представляет несколько платежей, сделанных с помощью Etsy Payments. Все денежные суммы находятся в долларах США, если иное не указано.

Payments
Payments

Получение списков по идентификатору

Позволяет запрашивать несколько идентификаторов перечисления одновременно. Ограничение 100 идентификаторов на запрос.

Параметры

Имя Ключ Обязательно Тип Описание
Перечисление идентификаторов
listing_ids True string

Массив числовых идентификаторов для списков в определенном магазине Etsy.

Includes
includes string

Перечисленная строка, которая присоединяет допустимую связь.

Возвращаемое значение

Набор ресурсов списка магазинов с ассоциациями.

ShopListingsWithAssociations
ShopListingsWithAssociations

Получение списков по идентификатору раздела магазина

Извлекает все списки из раздела определенного магазина.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификаторы разделов магазина
shop_section_ids True string

Массив числовых идентификаторов для всех разделов в определенном магазине Etsy.

Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Сортировка по
sort_on string

Значение для сортировки результата поиска списков.

Порядок сортировки
sort_order string

Порядок сортировки по возрастанию (вверх) или убыванию (вниз) для сортировки списков.

Возвращаемое значение

Набор ресурсов для описания магазинов.

ShopListings
ShopListings

Получение списков по квитанции магазина

Возвращает все перечисления, связанные с квитанцией.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Числовый идентификатор для квитанции, связанной с этой транзакцией.

Идентификатор квитанции
receipt_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Возвращаемое значение

Набор ресурсов для описания магазинов.

ShopListings
ShopListings

Получение списков по магазинам

Возвращает списки, принадлежащие магазину. Списки можно фильтровать с помощью параметра состояния.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Государство
State string

Перечисленная строка из любого из: активной или неактивной.

Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Сортировка по
Sort On string

Значение для сортировки результата поиска списков.

Порядок сортировки
Sort Order string

Порядок сортировки по возрастанию (вверх) или убыванию (вниз) для сортировки списков.

Возвращаемое значение

Набор ресурсов для описания магазинов.

ShopListings
ShopListings

Получение транзакции

Извлекает транзакцию по идентификатору транзакции.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Код проводки
transaction_id True integer

Уникальный числовой идентификатор транзакции.

Возвращаемое значение

Объект транзакции, связанный с квитанцией магазина. Etsy создает одну транзакцию для каждого перечисления, приобретенного как записанное в квитанции заказа.

ShopReceiptTransaction
ShopReceiptTransaction

Получение транзакции квитанции

Извлекает список транзакций, связанных с определенной квитанцией.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор квитанции
receipt_id True integer

Числовый идентификатор для квитанции, связанной с этой транзакцией.

Возвращаемое значение

Набор ресурсов транзакций с квитанцией магазина

ShopReceiptTransactions
ShopReceiptTransactions

Получение транзакции магазина

Извлекает список транзакций, связанных с магазином.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Возвращаемое значение

Набор ресурсов транзакций с квитанцией магазина

ShopReceiptTransactions
ShopReceiptTransactions

Получение транзакций списка

Извлекает список транзакций, связанных со списком.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Лимит
limit integer

Максимальное количество возвращаемых результатов.

Смещение
offset integer

Количество записей, пропускаемых перед выбором первого результата.

Возвращаемое значение

Набор ресурсов транзакций с квитанцией магазина

ShopReceiptTransactions
ShopReceiptTransactions

Получение узлов таксономии продавца

Извлекает дерево полной иерархии узлов таксономии продавца.

Возвращаемое значение

Список узлов таксономии из дерева таксономии продавца.

SellerTaxonomyNodes
SellerTaxonomyNodes

Получение файла из списка

Извлекает один файл, связанный с заданным цифровым описанием. Запрос файла из физического списка возвращает пустой результат.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Идентификатор файла перечисления
listing_file_id True integer

Уникальный числовый идентификатор файла, связанного с цифровым листингом.

Возвращаемое значение

Файл, связанный с цифровым списком.

ShopListingFile
ShopListingFile

Создание квитанции о доставке

Отправляет сведения об отслеживании для квитанции магазина, которая создает запись отправки в магазин для указанного идентификатора квитанции. Каждый раз, когда вы успешно отправляете сведения об отслеживании, Etsy отправляет уведомление пользователю покупателя. При отправке BCC имеет значение true, Etsy также отправляет уведомления о доставке продавцу. Если код отслеживания и имя оператора не отправляются, квитанция помечается только как отправленная.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор квитанции
receipt_id True integer

Квитанция для отправки отслеживания.

Код отслеживания
tracking_code string

Код отслеживания для этой квитанции.

Имя оператора
carrier_name string

Имя оператора для этой квитанции.

Отправка BCC
send_bcc boolean

Если значение true, уведомление о доставке будет отправлено продавцу, а также

Возвращаемое значение

Запись покупки из магазина. Чеки магазина отображают денежные значения с помощью валюты магазина.

ShopReceipt
ShopReceipt

Создание назначения профиля доставки

Создает новое место назначения доставки, которое задает стоимость доставки, перевозчик и класс для назначения в профиле доставки. Это назначает затраты с помощью валюты связанного магазина. Задайте место назначения с помощью iso-адреса страны назначения или региона назначения; Страны назначения ISO и целевой регион являются взаимоисключающими — задают один или другой. Установка обоих триггеров ошибки 400. Если запрос не задает ни iso страны назначения, ни региона назначения, назначение по умолчанию везде. Кроме того, необходимо назначить как идентификатор перевозчика, так и класс почты, либо как минимальные дни доставки, так и максимальные дни доставки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор профиля доставки
shipping_profile_id True integer

Числовые идентификаторы профиля доставки, связанного с описанием.

Основные затраты
primary_cost True float

Стоимость доставки в эту страну или регион только измеряется в валюте по умолчанию магазина.

Вторичные затраты
secondary_cost True string

Стоимость доставки в эту страну или регион с другим элементом, измеряемым в валюте по умолчанию магазина.

destination_country_iso
destination_country_iso string

destination_country_iso

destination_region
destination_region string

destination_region

shipping_carrier_id
shipping_carrier_id integer

shipping_carrier_id

mail_class
mail_class string

mail_class

min_delivery_days
min_delivery_days integer

min_delivery_days

max_delivery_days
max_delivery_days integer

max_delivery_days

Возвращаемое значение

Представляет место назначения доставки, назначенное профилею доставки.

ShopShippingProfileDestination
ShopShippingProfileDestination

Создание обновления профиля доставки

Создает новое обновление профиля доставки, которое может установить цену на вариант доставки, например альтернативный перевозчик или более быструю доставку.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор профиля доставки
shipping_profile_id True integer

Числовые идентификаторы профиля доставки, связанного с описанием.

Тип
type True string

Тип обновления доставки. Внутренний (0) или международный (1).

Имя обновления
upgrade_name True string

Имя обновления доставки, отображаемое покупателям при извлечении, например приоритет USPS.

Цена
price True float

Дополнительные затраты на добавление обновления доставки.

Вторичная цена
secondary_price True float

Дополнительные затраты на добавление обновления доставки для каждого дополнительного элемента.

Идентификатор перевозчика доставки
shipping_carrier_id integer

Уникальный идентификатор поддерживаемого перевозчика доставки, который используется для вычисления предполагаемой даты доставки.

Класс Mail
mail_class string

Уникальная строка идентификатора класса почты перевозчика, которая используется для вычисления предполагаемой даты доставки.

Минимальные дни доставки
min_delivery_days integer

min_delivery_days

Максимальное количество дней доставки
max_delivery_days integer

Максимальное количество рабочих дней, которое покупатель может ожидать, чтобы получить свой приобретенный элемент после отправки.

Возвращаемое значение

Представление параметра обновления профиля доставки.

ShopShippingProfileUpgrade
ShopShippingProfileUpgrade

Создание перевода списка

Создает перевод перечисления по идентификатору и языку.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Language
language True string

Тег языка IETF для языка этого перевода. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.

Название
title True string

Название перечисления этого перевода.

Description
description True string

Описание описания этого перевода.

Метки
tags string

Теги перечисления этого перевода.

Возвращаемое значение

Представляет данные перевода для перечисления.

ПеречислениеTranslation
ListingTranslation

Создание профиля доставки

Создает новый профиль доставки. При создании профиля доставки можно передать iso-код страны или регион, но не оба. Требуется только один. Необходимо передать либо идентификатор перевозчика, либо класс почты, либо минимальное и максимальное время доставки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Название
title True string

Строка имени этого профиля доставки.

ISO-код страны происхождения
origin_country_iso True string

ISO-код страны, из которой выполняется перечисление.

Основные затраты
primary_cost True float

Стоимость доставки в эту страну или регион только измеряется в валюте по умолчанию магазина.

Вторичные затраты
secondary_cost True float

Стоимость доставки в эту страну или регион с другим элементом, измеряемым в валюте по умолчанию магазина.

Минимальное время обработки
min_processing_time True integer

Минимальное время, необходимое для обработки для отправки списков с этим профилем доставки.

Максимальное время обработки
max_processing_time True integer

Максимальное время обработки, необходимое для отправки списка.

Единица времени обработки
processing_time_unit string

Единица, используемая для представления времени обработки. Неделя эквивалентна 5 рабочих дней.

ISO-код целевой страны
destination_country_iso string

ISO-код страны, в которую отправляется список. Если значение NULL, запрос задает назначение в целевой регион.

Целевой регион
destination_region string

Код региона, в который отправляется перечисление. Регион представляет набор стран. Поддерживаемые регионы — Это Европейский союз и Неевропейский союз (страны в Европе, а не в ЕС). Если нет, запрос задает назначение для целевой страны ISO или везде, если iso страны назначения также имеет значение NULL.

Почтовый индекс источника
origin_postal_code string

Строка почтового кода (не обязательно номер) для расположения, из которого поставляется список.

Идентификатор перевозчика доставки
shipping_carrier_id integer

Уникальный идентификатор поддерживаемого перевозчика доставки, который используется для вычисления предполагаемой даты доставки.

Класс Mail
mail_class string

Уникальная строка идентификатора класса почты перевозчика, которая используется для вычисления предполагаемой даты доставки.

Минимальные дни доставки
min_delivery_days integer

Минимальное количество рабочих дней, которое покупатель может ожидать, чтобы получить свой приобретенный элемент после отправки.

Максимальное количество дней доставки
max_delivery_days integer

Максимальное количество рабочих дней, которое покупатель может ожидать, чтобы получить свой приобретенный элемент после отправки.

Возвращаемое значение

Представляет профиль, используемый для задания сведений о доставке списка. Обратите внимание, что с помощью API невозможно создать вычисляемые шаблоны доставки. Однако вы можете связать вычисляемые профили доставки, созданные из Диспетчера магазинов, с описаниями с помощью API.

ShopShippingProfile
ShopShippingProfile

Создание раздела магазина

Создает новый раздел в определенном магазине.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Название
title True string

Строка заголовка для раздела магазина.

Возвращаемое значение

Раздел в магазине, в котором пользователь может сортировать списки.

ShopSection
ShopSection

Создание черновика

Создает физический черновик описания продукта в магазине на канале Etsy.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Количество
quantity True integer

Положительное ненулевое количество продуктов, доступных для покупки в списке.

Название
title True string

Строка заголовка списка. Допустимые строки заголовка содержат только буквы, цифры, знаки препинания, математические символы, символы пробелов, ™ © и . ® (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) Вы можете использовать только %, :, и + символы один раз.

Description
description True string

Строка описания продукта для продажи в списке.

Цена
price True float

Положительная ненулевая цена продукта. (Списки проданных продуктов являются частными) Примечание. Цена является минимальной возможной ценой.

Кто сделал
who_made True string

Строка идикнула, кто сделал продукт. Помогает покупателям найти список под заголовком Handmade. Требуется "is_supply" и "when_made".

Когда сделано
when_made string

Строка для эпохи, в которой производитель сделал продукт в этом списке. Помогает покупателям найти список под заголовком "Винтаж". Требуется "is_supply" и "who_made".

Идентификатор таксономии
taxonomy_id True integer

Числовый идентификатор таксономии перечисления. Продавец управляет перечислением идентификаторов таксономии для своего магазина.

Идентификатор профиля доставки
shipping_profile_id True integer

Числовые идентификаторы профиля доставки, связанного с описанием.

Materials
materials string

Массив строк материала для материалов, используемых в продукте. Допустимые строки материалов содержат только буквы, цифры и пробелы. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

Идентификатор раздела магазина
shop_section_id integer

Числовые идентификаторы раздела магазина для этого списка.

Минимальное значение обработки
processing_min integer

Минимальное количество дней, необходимых для обработки этого списка.

Максимальное значение обработки
processing_max integer

Максимальное количество дней, необходимых для обработки этого списка.

Метки
tags string

Массив строк тегов для перечисления. Допустимые строки тегов содержат только буквы, цифры, символы пробелов, -, ', ™ , © и ® . (regex: /[^\p{L}\p{Nd}\p{Zs}-'™©®]/u)

Recipient
recipient string

Строка, указывающая человека, для которого этот продукт сделает соответствующий подарок.

Случай
occasion string

Строка, указывающая случай, для которого этот продукт сделает соответствующий подарок.

Стили
styles string

Массив строк стилей для этого списка, каждый из которых является текстовой строкой свободной формы, такой как "Формальный" или "Steampunk". Список может содержать до двух стилей. Допустимые строки стиля содержат только буквы, цифры и пробелы. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

Вес элемента
item_weight float

Числовой вес продукта, измеряемого в единицах, заданных в единицах веса элемента.

Длина элемента
item_length integer

Числовая длина продукта, измеряемого в единицах измерения элемента.

Ширина элемента
item_width float

Числовая ширина продукта, измеряемая в единицах, заданных в единицах измерения элемента.

Высота элемента
item_height float

Числовая высота продукта, измеряемого в единицах, заданных в единицах измерения элемента.

Единица веса элемента
item_weight_unit string

Строка, определяющая единицы, используемые для измерения веса продукта.

Единица измерения элементов
item_dimensions_unit string

Строка, определяющая единицы, используемые для измерения измерений продукта.

Персонализировано
is_personalizable boolean

Если значение true, это описание является персонализированным.

Идентификаторы изображений
image_ids string

Массив числовых идентификаторов изображений в списке, который может содержать до 10 изображений.

Предоставляется
is_supply boolean

Если задано значение true, теги списка как продукта поставки, в противном случае указывает, что это готовый продукт. Помогает покупателям найти список под заголовком "Поставки". Требует ,кто сделал" и "когда сделал".

Настраивается
is_customizable boolean

Если верно, покупатель может обратиться к продавцу за настраиваемым заказом. Значение по умолчанию имеет значение true, если магазин принимает пользовательские заказы. Не применяется к магазинам, которые не принимают пользовательские заказы.

Является налогооблагаемым
is_taxable boolean

Если верно, применимые налоговые ставки магазина применяются к этому списку при выходе.

Возвращаемое значение

Список из магазина, который содержит количество продуктов, название, описание, цену и т. д.

ShopListing
ShopListing

Удаление изображения с описанием

Удаляет изображение с описанием. Копия файла остается на наших серверах, поэтому удаленный образ может быть повторно связан с описанием без повторной отправки исходного образа.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Перечисление идентификатора изображения
listing_image_id True integer

Числовые идентификаторы первичного изображения перечисления для этой транзакции.

Удаление назначения профиля доставки

Удаляет место назначения доставки и удаляет вариант назначения из каждого списка, использующего связанный профиль доставки. Профиль доставки требует по крайней мере одного назначения доставки, поэтому эта конечная точка не может удалить конечное место назначения доставки для любого профиля доставки. Чтобы удалить окончательное назначение доставки из профиля доставки, необходимо удалить весь профиль доставки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор профиля доставки
shipping_profile_id True integer

Числовые идентификаторы профиля доставки, связанного с описанием.

Идентификатор назначения профиля доставки
shipping_profile_destination_id True integer

Числовой идентификатор назначения профиля доставки в профиле доставки, связанном с списком.

Удаление обновления профиля доставки

Удаляет обновление профиля доставки и удаляет параметр обновления из каждого списка, использующего связанный профиль доставки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор профиля доставки
shipping_profile_id True integer

Числовой идентификатор профиля доставки.

Идентификатор обновления
upgrade_id True integer

Числовой идентификатор, связанный с обновлением доставки

Удаление профиля доставки

Удаляет профиль доставки по указанному идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор профиля доставки
shipping_profile_id True integer

Числовые идентификаторы профиля доставки, связанного с описанием.

Возвращаемое значение

Представляет профиль, используемый для задания сведений о доставке списка. Обратите внимание, что с помощью API невозможно создать вычисляемые шаблоны доставки. Однако вы можете связать вычисляемые профили доставки, созданные из Диспетчера магазинов, с описаниями с помощью API.

ShopShippingProfile
ShopShippingProfile

Удаление свойства перечисления

Удаляет свойство из списка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Идентификатор свойства
property_id True integer

Уникальный идентификатор свойства перечисления Etsy.

Удаление списка

Это действие удаляет список магазинов. Список можно удалить только в том случае, если состояние является одним из следующих: SOLD_OUT, ЧЕРНОВИК, СРОК ДЕЙСТВИЯ, НЕАКТИВНЫЙ, АКТИВНЫй и is_available или активный и имеет флаги продаж: SUPRESSED (заморожено), ОТПУСК, CUSTOM_SHOPS (шаблон), SELL_ON_FACEBOOK

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Удаление файла из списка

При удалении окончательного файла для цифрового описания список преобразуется в физический список. Ответ на запрос на удаление возвращает список оставшихся записей файлов, связанных с указанным списком.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор магазина
shop_id True integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор перечисления
listing_id True integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Идентификатор файла перечисления
listing_file_id True integer

Уникальный числовый идентификатор файла, связанного с цифровым листингом.

Определения

ShopListing

Список из магазина, который содержит количество продуктов, название, описание, цену и т. д.

Имя Путь Тип Описание
Идентификатор перечисления
listing_id integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Идентификатор пользователя
user_id integer

Числовые идентификаторы для пользователя, публикующего список.

Идентификатор магазина
shop_id integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Название
title string

Строка заголовка списка. Допустимые строки заголовка содержат только буквы, цифры, знаки препинания, математические символы, символы пробелов, ™ © и . ® (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) Вы можете использовать только %, :, и + символы один раз.

Description
description string

Строка описания продукта для продажи в списке.

Государство
state State

Перечисленная строка из любого из: активной или неактивной. Примечание. Настройка черновика для активного также будет публиковать список на etsy.com.

Метка времени создания
creation_timestamp integer

Время создания описания в секундах эпохи.

Окончание метки времени
ending_timestamp integer

Время истечения срока действия списка в секундах эпохи.

Метка времени создания исходного создания
original_creation_timestamp integer

Время создания описания в секундах эпохи.

Метка времени последнего изменения
last_modified_timestamp integer

Время последнего обновления в списке в секундах эпохи.

Метка времени последнего изменения состояния
state_timestamp integer

Дата и время последнего изменения состояния этого списка.

Количество
quantity integer

Положительное ненулевое количество продуктов, доступных для покупки в списке. Примечание. Количество перечисления — это сумма доступных объемов предложений. Вы можете запросить количество отдельных предложений из ресурса ListingInventory с помощью конечной точки получения списка инвентаризации.

Идентификатор раздела магазина
shop_section_id integer

Числовые идентификаторы раздела в определенном магазине Etsy.

Избранный ранг
featured_rank integer

Положительное ненулевое числовое положение в рекомендуемых списках магазина, с рангом 1 списки отображаются в левой позиции в описанном списке на домашней странице магазина.

URL
url string

Полный URL-адрес страницы описания в Etsy.

Количество благоприятелей
num_favorers integer

Число пользователей, помеченных как избранное.

Не облагаемый налогом
non_taxable boolean

Если верно, применимые налоговые ставки магазина не применяются к этому списку при извлечении.

Настраивается
is_customizable boolean

Если верно, покупатель может обратиться к продавцу за настраиваемым заказом. Значение по умолчанию имеет значение true, если магазин принимает пользовательские заказы. Не применяется к магазинам, которые не принимают пользовательские заказы.

Является перональизируемым
is_personalizable boolean

Если значение true, это описание является персонализированным. По умолчанию используется значение NULL.

Персонализация является обязательной
personalization_is_required boolean

Если задано значение true, для этого перечисления требуется персонализация. По умолчанию используется значение NULL.

Максимальное число символов персонализации
personalization_char_count_max integer

Это целочисленное значение, представляющее максимальную длину сообщения персонализации, введенного покупателем.

Инструкции по персонализации
personalization_instructions string

Если задано значение true, для этого перечисления требуется персонализация. По умолчанию используется значение NULL.

Тип перечисления
listing_type boolean

Строка перечисленного типа, указывающая, является ли перечисление физическим или цифровым скачиванием.

Метки
tags array of string

Список строк тегов для перечисления. Допустимые строки тегов содержат только буквы, цифры, символы пробелов, -, ', ™ , © и ® . (regex: /[^\p{L}\p{Nd}\p{Zs}\-'™©®]/u) Значение по умолчанию равно NULL.

Materials
materials array of string

Список строк материала для материалов, используемых в продукте. Допустимые строки материалов содержат только буквы, цифры и пробелы. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) Значение по умолчанию равно NULL.

Идентификатор профиля доставки
shipping_profile_id integer

Числовые идентификаторы профиля доставки, связанного с описанием.

Минимальные дни обработки
processing_min integer

Минимальное количество дней, необходимых для обработки этого списка. Значение по умолчанию равно NULL.

Максимальное число дней обработки
processing_max integer

Максимальное количество дней, необходимых для обработки этого списка. Значение по умолчанию равно NULL.

WhoMade
who_made WhoMade

Перечисляемая строка идикатирована, которая сделала продукт. Помогает покупателям найти список под заголовком Handmade. Требуется "is_supply" и "when_made".

WhenMade
when_made WhenMade

Перечисленная строка для эпохи, в которой производитель сделал продукт в этом списке. Помогает покупателям найти список под заголовком "Винтаж". Требуется "is_supply" и "who_made".

Поставка продукта
is_supply boolean

Если задано значение true, теги списка как продукта поставки, в противном случае указывает, что это готовый продукт. Помогает покупателям найти список под заголовком "Поставки". Требуется "who_made" и "when_made".

Вес элемента
item_weight double

Числовой вес продукта, измеряемого в единицах, заданных в единицах веса элемента. Значение по умолчанию равно NULL. Если задано, значение должно быть больше 0.

ItemWeightUnit
item_weight_unit ItemWeightUnit

Строка, определяющая единицы, используемые для измерения веса продукта. Значение по умолчанию равно NULL.

Длина элемента
item_length double

Числовая длина продукта, измеряемого в единицах измерения элемента. Значение по умолчанию равно NULL. Если задано, значение должно быть больше 0.

Ширина элемента
item_width double

Числовая ширина продукта, измеряемого в единицах измерения элемента. Значение по умолчанию равно NULL. Если задано, значение должно быть больше 0.

Высота элемента
item_height double

Числовая длина продукта, измеряемого в единицах измерения элемента. Значение по умолчанию равно NULL. Если задано, значение должно быть больше 0.

ItemDimensionsUnit
item_dimensions_unit ItemDimensionsUnit

Строка, определяющая единицы, используемые для измерения измерений продукта. Значение по умолчанию равно NULL.

Является частным
is_private boolean

Если это правда, это частный листинг, предназначенный для конкретного покупателя и скрытый от просмотра магазина.

Recipient
recipient Recipient

Перечисленная строка, указывающая человека, для которого этот продукт сделает соответствующий подарок. Значение по умолчанию равно NULL.

Случай
occasion Occasion

Перечисленная строка, указывающая случай, для которого этот продукт сделает соответствующий подарок. Значение по умолчанию равно NULL.

Style
style array of string

Массив строк стилей для этого списка, каждый из которых является текстовой строкой свободной формы, такой как "Формальный" или "Steampunk". Список может содержать до двух стилей. Допустимые строки стиля содержат только буквы, цифры и пробелы. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) Значение по умолчанию равно NULL.

Данные файлов
file_data string

Строка, описывающая файлы, присоединенные к цифровому списку.

Имеет варианты
has_variations boolean

Если значение true, в списке есть варианты.

Автоматическое продление
should_auto_renew boolean

Когда значение true, продлевает список в течение четырех месяцев после эксприации. Если задано значение true, если ранее значение false, etsy.com продлевает список до истечения срока действия, но период продления начинается без необходимости, а не продление срока действия списка. Любое неиспользуемое время, оставшееся в списке, теряется. Продление приводит к оплате счета пользователя.

Language
language string

Тег языка IETF для языка по умолчанию для списка. Ex: de, enjafresnlplit, . rupt

Деньги
price Money

Представление суммы денег.

Идентификатор таксономии
taxonomy_id integer

Числовый идентификатор таксономии перечисления. Продавец управляет перечислением идентификаторов таксономии для своего магазина. Дополнительные сведения см. в таксономии продавца.

Деньги

Представление суммы денег.

Имя Путь Тип Описание
Сумма
amount integer

Объем представленных данными.

Делитель
divisor integer

Делитель для отрисовки суммы.

Код Валюты
currency_code string

Код валюты ISO для этих данных.

ShopListingFile

Файл, связанный с цифровым списком.

Имя Путь Тип Описание
Идентификатор файла перечисления
listing_file_id integer

Уникальный числовый идентификатор файла, связанного с цифровым листингом.

Идентификатор перечисления
listing_id integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Ранг
rank integer

Числовый индекс позиции порядка отображения этого файла в списке, начиная с 1.

Filename
filename string

Строка имени файла для файла, связанного с цифровым листингом.

Файлы
filesize string

Строка размера формата, доступного для чтения человека, для размера файла.

Размер в байтах
size_bytes integer

Число, указывающее размер файла, измеряемое в байтах.

Тип файла
filetype string

Строка типа, указывающая тип MIME файла.

Создание метки времени
create_timestamp integer

Уникальная числовая метка времени файла, связанного с цифровым списком.

ShopListingFiles

Представляет несколько shopListingFiles.

Имя Путь Тип Описание
Численность
count integer

Число возвращаемых файлов ShopListingFiles..

Results
results array of ShopListingFile

Массив ресурсов ShopListingFile.

ShopListings

Набор ресурсов для описания магазинов.

Имя Путь Тип Описание
Численность
count integer

Количество найденных ресурсов в магазине.

Results
results array of ShopListing

Магазин содержит найденные ресурсы.

User

Представляет одного пользователя сайта

Имя Путь Тип Описание
Идентификатор пользователя
user_id integer

Числовой идентификатор пользователя. Этот номер также является допустимым идентификатором магазина для магазина пользователя.

Имя входа
login_name string

Строка имени входа пользователя.

Основной адрес эл. почты
primary_email string

Строка адреса электронной почты для основного адреса электронной почты пользователя.

Имя (Первое имя)
first_name string

Имя пользователя.

Фамилия
last_name string

Фамилия пользователя.

Созданная временная метка
create_timestamp integer

Дата и время создания учетной записи пользователя в секундах эпохи.

На который ссылается идентификатор пользователя
referred_by_user_id integer

Числовой идентификатор пользователя, на который ссылается этот пользователь.

Использование новых конечных точек инвентаризации
use_new_inventory_endpoints boolean

Устарело. Всегда верно.

Продавец
is_seller boolean

Значение True, если пользователь является продавцом.

Биография
bio string

Биография пользователя.

Gender
gender string

Пол пользователя.

Месяц рождения
birth_month string

Месяц рождения пользователя.

День рождения
birth_day string

День рождения пользователя.

Приобретение счетчика транзакций
transaction_buy_count integer

Количество транзакций, приобретенных пользователем.

Количество проданных транзакций
transaction_sold_count integer

Количество транзакций, в которых пользователь продал.

Магазин

Магазин, созданный пользователем Etsy.

Имя Путь Тип Описание
Идентификатор магазина
shop_id integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор пользователя
user_id integer

Числовой идентификатор пользователя, который владеет этим магазином.

Название магазина
shop_name string

Строка имени магазина.

Дата создания
create_date integer

Дата и время создания этого магазина в секундах эпохи.

Название
title string

Краткая строка заголовка для главной страницы магазина.

Объявление
announcement string

Строка объявления для покупателей, которые отображаются на домашней странице магазина.

Код Валюты
currency_code string

Код ISO (алфавитный) для валюты магазина. Магазин отображает все цены в этой валюте по умолчанию.

Находится в отпуске
is_vacation boolean

Если верно, этот магазин не принимает покупки.

Сообщение о отпуске
vacation_message string

Строка сообщения магазина отображается, когда is_vacation имеет значение true.

Сообщение о продаже
sale_message string

Строка сообщения, отправленная пользователям, которые завершают покупку из этого магазина.

Сообщение о цифровой продаже
digital_sale_message string

Строка сообщения, отправленная пользователям, которые покупают цифровой элемент из этого магазина.

Дата обновления
update_date integer

Дата и время последнего обновления магазина в секундах эпохи.

Число активных листингов
listing_active_count integer

Количество активных списков в магазине.

Число цифровых листингов
digital_listing_count integer

Количество цифровых листингов в магазине.

Имя входа
login_name string

Строка имени входа владельца магазина.

Принимает пользовательские запросы
accepts_custom_requests boolean

Если значение true, магазин принимает запросы на настройку.

Политика приветствия
policy_welcome string

Строка приветствия политики магазина (может быть пустой).

Политика оплаты
policy_payment string

Строка политики оплаты магазина (может быть пустой).

Политика доставки
policy_shipping string

Строка политики доставки магазина (может быть пустой).

Политика возврата средств
policy_refunds string

Строка политики возврата магазина (может быть пустой).

Дополнительные политики
policy_additional string

Строка дополнительных политик магазина (может быть пустой).

Сведения о продавце
policy_seller_info string

Строка сведений о продавце магазина (может быть пустой).

Дата обновления политики
policy_update_date integer

Дата и время последнего обновления политик магазина в секундах эпохи.

Имеет политику приватного получения
policy_has_private_receipt_info boolean

При значении true квитанции ЕС отображают частную информацию.

Имеет неструктурированные политики
has_unstructured_policies boolean

При значении true магазин отображает дополнительные неструктурированные поля политики.

Privacy Policy (Политика конфиденциальности)
policy_privacy string

Строка политики конфиденциальности магазина (может быть пустой).

Автовосплашение отпусков
vacation_autoreply string

Строка автоматического ответа магазина отображается в новых беседах, когда is_vacation имеет значение true.

URL
url string

Строка URL-адреса для этого магазина.

URL-адрес изображения баннера
image_url_760x100 string

Строка URL-адреса для изображения баннера этого магазина.

Количество благоприятелей
num_favorers integer

Число пользователей, которые помечают этот магазин избранным.

Languages
languages array of string

Список строк языка для зарегистрированных языков магазина.

URL-адрес изображения значка
icon_url_fullxfull string

Строка URL-адреса для изображения значка этого магазина.

Использование структурированных политик
is_using_structured_policies boolean

Если значение true, магазин принял использование структурированных политик.

Имеет встроенные структурированные политики
has_onboarded_structured_policies boolean

Если значение true, магазин принял ИЛИ отказался после просмотра структурированных политик подключения.

Включение ссылки на форму спора
include_dispute_form_link boolean

Если верно, политика этого магазина включает ссылку на форму спора в Интернете ЕС.

Подключение прямого заказа
is_direct_checkout_onboarded boolean

Когда правда, магазин подключен к Etsy Payments.

Имеет право на вычисленную доставку
is_calculated_eligible boolean

Если задано значение true, магазин является элегируемым для вычисляемых профилей доставки. (Доступно только в США и Канаде)

Отказ в обещании покупателя
is_opted_in_to_buyer_promise boolean

Когда правда, магазин отказался от покупателя обещание.

Основан на США
is_shop_us_based boolean

Когда правда, магазин базируется в США.

Количество транзакций продаж
transaction_sold_count integer

Общее количество транзакций по продажам для этого магазина

Доставка из страны ISO
shipping_from_country_iso string

Страна iso магазин доставки из.

Расположение магазина ISO
shop_location_country_iso string

Страна iso, где находится магазин.

Количество просмотров
review_count integer

Количество отзывов о списках магазинов за прошлый год.

Просмотр среднего
review_average double

Средняя оценка на основе отзывов о списках магазинов в прошлом году.

ПеречислениеImage

Url-адреса и метаданные для изображения, связанного с определенным списком. Параметр url_fullxfull содержит URL-адрес для файла двоичного образа полного размера.

Имя Путь Тип Описание
Идентификатор перечисления
listing_id integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Перечисление идентификатора изображения
listing_image_id integer

Числовые идентификаторы первичного изображения перечисления для этой транзакции.

Шестнадцатеричный код
hex_code string

Строка webhex для среднего цвета изображения в нотации webhex.

Красное значение
red integer

Числовое красное значение, равное среднему красному значению изображения, от 0 до 255 (цвет RGB).

Зеленое значение
green integer

Числовое красное значение, равное среднему красному значению изображения, от 0 до 255 (цвет RGB).

Синее значение
blue integer

Числовое красное значение, равное среднему красному значению изображения, от 0 до 255 (цвет RGB).

Значение Hue
hue integer

Числовой оттенок, равный среднему оттенок изображения, от 0 до 360 (цвет HSV).

Значение насыщенности
saturation integer

Числовое насыщенность, равное средней насыщенности изображения, от 0 до 100 (цвет HSV).

Значение яркости
brightness integer

Числовое значение яркости, равное средней яркости изображения, от 0 до 100 (цвет HSV).

Черный и белый
is_black_and_white boolean

Если значение true, изображение находится в черном и белом цвете.

Время создания
creation_tsz integer

Время создания изображения перечисления в секундах эпохи.

Ранг
rank integer

Положительное числовое положение, отличное от нуля, в изображениях, отображаемых в списке, с рангом 1 изображения отображаются в левой позиции в списке.

URL-адрес изображения 75x75
url_75x75 string

Строка URL-адреса для эскиза изображения 75x75 пикселей.

URL-адрес изображения 170x135
url_170x135 string

Строка URL-адреса для эскиза изображения 170x135 пикселей.

URL-адрес изображения 570xN
url_570xN string

Строка URL-адреса для эскиза изображения не более 570 пикселей с переменной высотой.

URL-адрес изображения полного размера
url_fullxfull string

Строка URL-адреса для полного размера изображения до 3000 пикселей в каждом измерении.

Высота изображения полного размера
full_height integer

Числовая высота, измеряемая в пикселях, полноразмерного изображения, на который ссылается url_fullxfull.

Ширина изображения полного размера
full_width integer

Числовая ширина, измеряемая в пикселях, полноразмерного изображения, на который ссылается url_fullxfull.

ПеречислениеImages

Представляет список ресурсов изображения, каждый из которых содержит URL-адреса ссылок и метаданные для изображения.

Имя Путь Тип Описание
Численность
count integer

Количество результатов.

Results
results array of ListingImage

Список запрошенных ресурсов.

ЛистингInventoryWithAssociations

Представление записи инвентаризации одного списка с сопоставлениями

Имя Путь Тип Описание
Products
products array of ListingInventoryProduct

Массив json продуктов, доступных в списке, даже если только один продукт. Все имена полей в БОЛЬШИХ двоичных объектах JSON являются строчными буквами.

Цена на свойства
price_on_property array of integer

Массив уникальных целых чисел идентификатора свойства для свойств, которые изменяют цены на продукты, если таковые есть. Например, если вы взимаете определенные цены на продукты разного размера в одном списке, этот массив содержит идентификатор свойства для размера.

Количество свойств
quantity_on_property array of integer

Массив уникальных целых чисел идентификатора свойства перечисления для свойств, изменяющих количество продуктов, если таковые есть. Например, если вы запасаете определенное количество различных цветных продуктов в одном списке, этот массив содержит идентификатор свойства для цвета.

Номер SKU для свойств
sku_on_property array of integer

Массив уникальных чисел идентификатора свойства перечисления для свойств, изменяющих номер SKU продукта, если таковой есть. Например, если в одном и том же списке используются определенные номера skus для разных цветных продуктов, этот массив содержит идентификатор свойства для цвета.

ShopListing
listing ShopListing

Список из магазина, который содержит количество продуктов, название, описание, цену и т. д.

ЛистингInventoryProduct

Представление продукта для перечисления.

Имя Путь Тип Описание
Код продукта
product_id integer

Числовые идентификаторы для определенного продукта, приобретенного в списке.

Артикул (SKU)
sku string

Строка SKU для продукта

Удаляется
is_deleted boolean

Когда значение true, кто-то удалил этот продукт.

Offerings
offerings array of ListingInventoryProductOffering

Список предложений продуктов для этого продукта.

Значения свойств
property_values array of ListingPropertyValue

Список записей значений свойств для этого продукта.

ЛистингInventoryProductOffering

Представление предложения для перечисления.

Имя Путь Тип Описание
Идентификатор предложения
offering_id integer

Идентификатор предложения продукта

Количество
quantity integer

Количество предложения продукта

Включен
is_enabled boolean

Независимо от того, может ли предложение отображаться покупателям.

Удаляется
is_deleted boolean

Удалено ли предложение.

Деньги
price Money

Представление суммы денег.

ЛистингPropertyValue

Представление структурированных значений данных.

Имя Путь Тип Описание
Идентификатор свойства
property_id integer

Числовой идентификатор свойства.

Имя
property_name string

Имя свойства.

Идентификатор масштабирования
scale_id integer

Числовые идентификаторы шкалы (если таковые есть).

Имя масштабирования
scale_name string

Метка, используемая для описания выбранного масштаба (при наличии).

Идентификаторы значений
value_ids array of integer

Числовые идентификаторы значений свойств

Ценности
values array of string

Значения свойств

ЛистингInventory

Представление записи инвентаризации одного списка.

Имя Путь Тип Описание
Products
products array of ListingInventoryProduct

Массив json продуктов, доступных в списке, даже если только один продукт. Все имена полей в БОЛЬШИХ двоичных объектах JSON являются строчными буквами.

Цена на свойства
price_on_property array of integer

Массив уникальных целых чисел идентификатора свойства для свойств, которые изменяют цены на продукты, если таковые есть. Например, если вы взимаете определенные цены на продукты разного размера в одном списке, этот массив содержит идентификатор свойства для размера.

Количество свойств
quantity_on_property array of integer

Массив уникальных целых чисел идентификатора свойства перечисления для свойств, изменяющих количество продуктов, если таковые есть. Например, если вы запасаете определенное количество различных цветных продуктов в одном списке, этот массив содержит идентификатор свойства для цвета.

Номер SKU для свойств
sku_on_property array of integer

Массив уникальных чисел идентификатора свойства перечисления для свойств, изменяющих номер SKU продукта, если таковой есть. Например, если в одном и том же списке используются определенные номера skus для разных цветных продуктов, этот массив содержит идентификатор свойства для цвета.

ShopListingsWithAssociations

Набор ресурсов списка магазинов с ассоциациями.

Имя Путь Тип Описание
Численность
count integer

Количество найденных ресурсов в магазине.

Results
results array of ShopListing

Магазин содержит найденные ресурсы.

ЛистингPropertyValues

Представляет несколько значений свойств перечисления.

Имя Путь Тип Описание
Численность
count integer

Количество найденных ресурсов в магазине.

Results
results array of ListingPropertyValue

Магазин содержит найденные ресурсы.

ShopReceiptTransactions

Набор ресурсов транзакций с квитанцией магазина

Имя Путь Тип Описание
Численность
count integer

Количество найденных ресурсов транзакций с квитанцией магазина.

Results
results array of ShopReceiptTransaction

Найденные ресурсы транзакций с квитанцией магазина.

ShopReceiptTransaction

Объект транзакции, связанный с квитанцией магазина. Etsy создает одну транзакцию для каждого перечисления, приобретенного как записанное в квитанции заказа.

Имя Путь Тип Описание
Код проводки
transaction_id integer

Уникальный числовой идентификатор транзакции.

Название
title string

Строка заголовка списка, приобретенного в этой транзакции.

Description
description string

Строка описания списка, приобретенного в этой транзакции.

Идентификатор пользователя продавца
seller_user_id integer

Числовой идентификатор пользователя для продавца в этой транзакции.

Идентификатор пользователя покупателя
buyer_user_id integer

Числовой идентификатор пользователя для покупателя в этой транзакции.

Созданная временная метка
create_timestamp integer

Дата и время создания транзакции в секундах эпохи.

Платная метка времени
paid_timestamp integer

Платная дата и время транзакции в секундах эпохи.

Метка времени доставки
shipped_timestamp integer

Дата и время доставки транзакции в секундах эпохи.

Количество
quantity integer

Числовое количество продуктов, приобретенных в этой транзакции.

Перечисление идентификатора изображения
listing_image_id integer

Числовые идентификаторы первичного изображения перечисления для этой транзакции.

Идентификатор квитанции
receipt_id integer

Числовый идентификатор для квитанции, связанной с этой транзакцией.

Цифровой
is_digital boolean

Если значение true, транзакция записала покупку цифрового листинга.

Данные файлов
file_data string

Строка, описывающая файлы, приобретенные в этой транзакции.

Идентификатор перечисления
listing_id integer

Числовые идентификаторы для перечисления, связанного с этой транзакцией.

Тип проводки
transaction_type string

Строка типа для транзакции, как правило, перечисление

Код продукта
product_id integer

Числовые идентификаторы для определенного продукта, приобретенного в списке.

Деньги
price Money

Представление суммы денег.

Деньги
shipping_cost Money

Представление суммы денег.

ПеречислениеTranslation

Представляет данные перевода для перечисления.

Имя Путь Тип Описание
Идентификатор перечисления
listing_id integer

Числовые идентификаторы для перечисления.

Language
language string

Тег языка IETF (например, fr) для языка этого перевода.

Название
title string

Название перечисления этого перевода.

Description
description string

Описание описания этого перевода.

Метки
tags array of string

Теги перечисления этого перевода.

ListingVariationImages

Представляет несколько изображений вариантов описания.

Имя Путь Тип Описание
Численность
count integer

Количество изображений вариантов.

Results
results array of ListingVariationImage

Результаты вариантов изображений.

ЛистингVariationImage

Представление ассоциаций вариантов и изображений в списке.

Имя Путь Тип Описание
Идентификатор свойства
property_id integer

Числовой идентификатор свойства.

Идентификатор значения
value_id integer

Числовой идентификатор значения.

Идентификатор изображения
image_id integer

Числовой идентификатор изображения.

PaymentAccountLedgerEntries

Набор ресурсов записи реестра учетных записей оплаты

Имя Путь Тип Описание
Численность
count integer

Количество найденных ресурсов записи реестра учетных записей оплаты.

Results
results array of PaymentAccountLedgerEntry

Найденные ресурсы записи реестра учетной записи оплаты.

PaymentAccountLedgerEntry

Представляет запись в реестре магазина.

Имя Путь Тип Описание
Идентификатор записи
entry_id integer

Числовые идентификаторы записи реестра.

Идентификатор реестра
ledger_id integer

Числовые идентификаторы реестра.

Порядковый номер
sequence_number integer

Последовательность позволяет отсортировать записи реестра в хронологическом порядке. Чем выше последовательность, тем больше последней записи.

Сумма
amount integer

Сумма денег, зачисленная в реестр.

Валюта
currency string

Валюта записи в реестре.

Description
description string

Сведения о том, какой тип записи реестра это: платеж, возврат, отмена невыполненного возврата, выплаты, возвращенные выплаты, повторное выделение, прочие кредиты, прочие платежи, прочие дебетовые средства или платеж по счету.

Сальдо
balance integer

Сумма денег в реестре магазина момент после применения этой записи.

Дата создания
create_date integer

Дата и время создания записи реестра в секундах эпохи.

Payments

Представляет несколько платежей, сделанных с помощью Etsy Payments. Все денежные суммы находятся в долларах США, если иное не указано.

Имя Путь Тип Описание
Численность
count integer

Количество платежей в ответе.

Results
results array of Payment

Список платежей.

Уплата

Представляет платеж, сделанный с помощью Etsy Payments. Все денежные суммы находятся в долларах США, если иное не указано.

Имя Путь Тип Описание
Идентификатор оплаты
payment_id integer

Уникальный числовые идентификаторы для оплаты определенного магазина Etsy.

Идентификатор пользователя покупателя
buyer_user_id integer

Числовой идентификатор пользователя, который заплатил покупку.

Идентификатор магазина
shop_id integer

Уникальный положительный ненулевой числовый идентификатор для магазина Etsy.

Идентификатор квитанции
receipt_id integer

Числовый идентификатор для квитанции, связанной с этой транзакцией.

Деньги
amount_gross Money

Представление суммы денег.

Деньги
amount_fees Money

Представление суммы денег.

Деньги
amount_net Money

Представление суммы денег.

Деньги
posted_gross Money

Представление суммы денег.

Деньги
posted_fees Money

Представление суммы денег.

Деньги
posted_net Money

Представление суммы денег.

Деньги
adjusted_gross Money

Представление суммы денег.

Деньги
adjusted_fees Money

Представление суммы денег.

Деньги
adjusted_net Money

Представление суммы денег.

Валюта
currency string

Строка кода ISO (алфавита) для валюты оплаты.

Магазин валюты
shop_currency string

Код ISO (алфавитный) для валюты магазина. Магазин отображает все цены в этой валюте по умолчанию.

Валюта покупателя
buyer_currency string

Валютная строка покупателя.

Идентификатор доставки пользователей
shipping_user_id integer

Числовый идентификатор пользователя, которому продавец отправляет заказ.

Идентификатор адреса доставки
shipping_address_id integer

Числовой идентификатор, определяющий адрес доставки.

Идентификатор адреса выставления счетов
billing_address_id integer

Числовой идентификатор, определяющий адрес выставления счетов покупателя.

Состояние
status string

Строка, указывающая текущее состояние платежа, наиболее часто урегулированное или защищенное.

Метка времени доставки
shipped_timestamp integer

Дата и время доставки транзакции в секундах эпохи.

Созданная временная метка
create_timestamp integer

Дата и время создания транзакции в секундах эпохи.

Обновление метки времени
update_timestamp integer

Дата и время последнего изменения в корректировке оплаты в секундах эпохи.

Корректировки оплаты
payment_adjustments array of PaymentAdjustment

Список объектов возврата для транзакции Etsy Payments. Все денежные суммы находятся в долларах США, если иное не указано.

PaymentAdjustment

Представляет возмещение, которое применяется к предыдущей выплате Etsy. Все денежные суммы находятся в долларах США, если иное не указано.

Имя Путь Тип Описание
Идентификатор корректировки оплаты
payment_adjustment_id integer

Числовые идентификаторы для корректировки оплаты.

Идентификатор оплаты
payment_id integer

Уникальный числовые идентификаторы для оплаты определенного магазина Etsy.

Состояние
status string

Строка состояния корректировки платежа.

Успех
is_success boolean

Когда значение true, корректировка оплаты была или, скорее всего, успешно завершена.

Идентификатор пользователя
user_id integer

Числовой идентификатор для пользователя (продавца), выполняющего покупку.

Код причины
reason_code string

Читаемая человеком строка, описывающая причину возврата.

Общая сумма корректировки
total_adjustment_amount integer

Общая числовая сумма возврата в валюте оплаты.

Сумма корректировки магазина
shop_total_adjustment_amount integer

Числовое количество возврата в валюте магазина.

Общая сумма корректировки
buyer_total_adjustment_amount integer

Числовое количество возврата в валюте покупателя.

Общая сумма корректировки платы
total_fee_adjustment_amount integer

Числовое количество сборов за обработку карт, связанных с корректировкой платежа.

Созданная временная метка
create_timestamp integer

Дата и время создания транзакции в секундах эпохи.

Обновление метки времени
update_timestamp integer

Дата и время последнего изменения в корректировке оплаты в секундах эпохи.

Вонь

Подтверждение того, что текущее приложение имеет доступ к Open API

Имя Путь Тип Описание
Идентификатор приложения
application_id integer

Идентификатор приложения, прошедшего проверку подлинности

ShopReceipt

Запись покупки из магазина. Чеки магазина отображают денежные значения с помощью валюты магазина.

Имя Путь Тип Описание
Идентификатор квитанции
receipt_id integer

Числовый идентификатор для квитанции, связанной с этой транзакцией.

Тип квитанции
receipt_type integer

Числовое значение для канала Etsy, который обслуживал покупку: 0 для Etsy.com, 1 для магазина Шаблонов.

Идентификатор пользователя продавца
seller_user_id integer

Числовой идентификатор для пользователя (продавца), выполняющего покупку.

Адрес электронной почты продавца
seller_email string

Строка адреса электронной почты для продавца списка.

Идентификатор пользователя покупателя
buyer_user_id integer

Числовой идентификатор для пользователя, выполняющего покупку.

Адрес электронной почты покупателя
buyer_email string

Строка адреса электронной почты для покупателя списка.

Имя
name string

Строка имени получателя в адресе доставки.

Первая строка адреса
first_line string

Первая строка адресной строки получателя в адресе доставки.

Вторая адресная строка
second_line string

Необязательная строка второй адресной строки получателя в адресе доставки.

Город
city string

Строка города для получателя в адресе доставки.

Государство
state string

Строка состояния получателя в адресе доставки.

Почтовый индекс
zip string

Строка zip-кода (не обязательно число) для получателя в адресе доставки.

Форматированный адрес
formatted_address string

Отформатированная строка адреса доставки для получателя в адресе доставки.

Код страны ISO
country_iso string

Строка кода страны ISO-3166 альфа-2 для получателя в адресе доставки.

Способ оплаты
payment_method string

Строка метода оплаты, определяющая метод оплаты покупателя, которые должны быть одним из следующих: "cc" (кредитная карта), "PayPal", "check", "mo" (денежный заказ), "bt" (банковский перевод), "other", "ideal", "sofort", "apple_pay", "google", "android_pay", "google_pay", "klarna", "k_pay_in_4" (klarna) или "k_financing" (klarna).

Адрес электронной почты оплаты
payment_email string

Строка адреса электронной почты для адреса электронной почты, на который необходимо отправить подтверждение оплаты

Сообщение от продавца
message_from_seller string

Необязательная строка сообщения от продавца.

Сообщение от покупателя
message_from_buyer string

Необязательная строка сообщения от покупателя.

Сообщение от системы оплаты
message_from_payment string

Строка подтверждения, созданная компьютером, из платежной системы.

Оплачивается
is_paid boolean

Когда правда, покупатель заплатил за эту покупку.

Поставляется
is_shipped boolean

Когда значение true, продавец погрузил продукты.

Созданная временная метка
create_timestamp integer

Время создания квитанции в секундах эпохи.

Обновление метки времени
update_timestamp integer

Время последнего обновления до квитанции в секундах эпохи.

Сообщение о подарке
gift_message string

Строка сообщения о подарке, запрашиваемая покупателем, доставленная с продуктом.

Деньги
grandtotal Money

Представление суммы денег.

Деньги
subtotal Money

Представление суммы денег.

Деньги
total_price Money

Представление суммы денег.

Деньги
total_shipping_cost Money

Представление суммы денег.

Деньги
total_tax_cost Money

Представление суммы денег.

Деньги
total_vat_cost Money

Представление суммы денег.

Деньги
discount_amt Money

Представление суммы денег.

Деньги
gift_wrap_price Money

Представление суммы денег.

Поставки
shipments array of ShopReceiptShipment

Список заявлений о доставке для этой квитанции.

ShopReceiptShipment

Запись одного события отправки для ShopReceipt. У квитанции может быть много записей ShopReceiptShipment.

Имя Путь Тип Описание
Идентификатор доставки квитанций
receipt_shipping_id integer

Уникальный числовый идентификатор записи отправки из магазина.

Метка времени отправки уведомлений
shipment_notification_timestamp integer

Время, когда Etsy уведомил покупателя о событии отгрузки, в секундах эпохи.

Имя оператора
carrier_name string

Строка имени для перевозчика или компании, ответственной за доставку отгрузки.

Код отслеживания
tracking_code string

Строка кода отслеживания, предоставляемая перевозчиком или компанией для отправки.

ShopReceipts

Квитанции для определенного магазина.

Имя Путь Тип Описание
Численность
count integer

Количество найденных квитанций магазина.

Results
results array of ShopReceipt

Список найденных ресурсов квитанции магазина со всеми полями квитанции магазина для каждого ресурса.

TransactionReviews

Набор записей проверки транзакций, оставленных пользователями.

Имя Путь Тип Описание
Численность
count integer

Количество найденных ресурсов TransactionReview.

Results
results array of TransactionReview

Найденные ресурсы TransactionReview.

TransactionReview

Запись проверки транзакций, оставленная пользователем.

Имя Путь Тип Описание
Идентификатор магазина
shop_id integer

Числовые идентификаторы магазина.

Идентификатор перечисления
listing_id integer

Идентификатор списка магазина, к которому принадлежит ТранзакцияReview.

Идентификатор пользователя покупателя
buyer_user_id integer

Числовой идентификатор пользователя, который был покупателем в этой транзакции. Примечание. Это поле может быть отсутствует в зависимости от параметров конфиденциальности покупателя.

Rating
rating integer

Оценка по шкале от 1 до 5

Просмотр сообщения
review string

Сообщение, оставленное автором, объясняя отзыв.

Language
language string

Язык TransactionReview

URL-адрес полного изображения
image_url_fullxfull string

URL-адрес фотографии, предоставленной с отзывом, измерения fullxfull. Примечание. Это поле может быть отсутствует в зависимости от параметров конфиденциальности покупателя.

Созданная временная метка
create_timestamp integer

Дата и время создания TransactionReview в секундах эпохи.

Обновление метки времени
update_timestamp integer

Дата и время обновления TransactionReview в секундах эпохи.

SellerTaxonomyNodes

Список узлов таксономии из дерева таксономии продавца.

Имя Путь Тип Описание
Численность
count integer

Количество результатов.

Results
results array of SellerTaxonomyNode

Список запрошенных ресурсов.

SellerTaxonomyNode

Узел таксономии в дереве таксономии продавца.

Имя Путь Тип Описание
Идентификатор
id integer

Уникальный числовый идентификатор узла таксономии Etsy, который является категорией метаданных для перечислений, организованных в дерево иерархии таксономии продавца. Например, узел таксономии обуви (идентификатор: 1429, уровень: 1) выше в иерархии, чем обувь девочек (идентификатор: 1440, уровень: 2). Узлы таксономии, назначенные списку, поддерживают доступ к определенным стандартизированным масштабам продуктов и свойствам. Например, списки, назначаемые таксономии узлам обувь или обувь девочек, поддерживают доступ к масштабу размера обуви ЕС с соответствующими именами свойств и идентификаторами для размеров обуви ЕС, таких как свойство value_id:1394 и name:38.

Level
level integer

Целочисленная глубина этого таксономии узла в дереве таксономии продавца с корнями на уровне 0.

Имя
name string

Строка имени для этого узла таксономии.

Родительский идентификатор
parent_id integer

Числовый идентификатор таксономии родительского узла.

Дети
children array of SellerTaxonomyNode

Массив узлов таксономии для всех прямых дочерних узлов этого таксономии узла в дереве таксономии продавца.

Идентификаторы пути таксономии
full_path_taxonomy_ids array of integer

Массив идентификаторов таксономии, включая этот узел и все его прямые родители в дереве таксономии продавца до корневого узла. Они перечислены в порядке от корневого до конечного.

ТаксономияNodeProperties

Список определений свойств продукта.

Имя Путь Тип Описание
Численность
count integer

Количество результатов.

Results
results array of TaxonomyNodeProperty

Список запрошенных ресурсов.

ТаксономияNodeProperty

Определение свойства продукта.

Имя Путь Тип Описание
Идентификатор свойства
property_id integer

Уникальный числовой идентификатор этого свойства продукта.

Имя
name string

Строка имени для этого узла таксономии.

Отображаемое имя
display_name string

Строка имени свойства продукта, доступного для чтения пользователем.

Весы
scales array of TaxonomyPropertyScale

Список доступных масштабов.

Требуется
is_required boolean

Если задано значение true, для списков, назначенных соответствующим идентификаторам таксономии, требуется это свойство.

Поддержка атрибутов
supports_attributes boolean

Если значение true, это свойство можно использовать в атрибутах перечисления.

Поддерживает варианты
supports_variations boolean

Если значение true, это свойство можно использовать в вариантах перечисления.

Имеет многозначное значение
is_multivalued boolean

Если значение true, можно назначить этому свойству несколько значений свойств.

Возможные значения
possible_values array of TaxonomyPropertyValue

Список поддерживаемых строк значений свойства для этого свойства.

Выбранные значения
selected_values array of TaxonomyPropertyValue

Список строк значений свойства автоматически и всегда выбирается для данного свойства.

TaxonomyPropertyScale

Масштабирование, преобразующее назначаемые добавочные значения свойств, доступные определенным свойствам продукта.

Имя Путь Тип Описание
Идентификатор масштабирования
scale_id integer

Уникальный числовой идентификатор шкалы.

Отображаемое имя
display_name string

Строка имени для шкалы.

Description
description string

Строка описания для масштабирования.

TaxonomyPropertyValue

Значение свойства для определенного свойства продукта, которое также может использовать определенный масштаб.

Имя Путь Тип Описание
Идентификатор значения
value_id integer

Числовые идентификаторы этого значения свойства.

Имя
name string

Строка имени этого значения свойства.

Идентификатор масштабирования
scale_id integer

Числовые идентификаторы масштабирования шкалы, к которой принадлежит это значение свойства.

Равно
equal_to array of integer

Список идентификаторов числовых значений свойств, равных значению этого свойства (если таковой имеется).

ShippingCarriers

Представляет несколько судоходных карриеров.

Имя Путь Тип Описание
count
count integer
results
results array of ShippingCarrier

ShippingCarrier

Поддерживаемый перевозчик доставки, который используется для вычисления предполагаемой даты доставки.

Имя Путь Тип Описание
Идентификатор перевозчика доставки
shipping_carrier_id integer

Числовой идентификатор этого перевозчика доставки.

Имя
name string

Имя этого перевозчика доставки.

Внутренние классы
domestic_classes array of ShippingCarrierMailClass

Набор внутренних классов почты этого перевозчика доставки.

Международные классы
international_classes array of ShippingCarrierMailClass

Набор международных классов почты этого перевозчика.

ShippingCarrierMailClass

Класс почты перевозчика доставки, который используется для вычисления предполагаемой даты доставки.

Имя Путь Тип Описание
Идентификатор класса почты
mail_class_key string

Уникальный идентификатор этого класса почты.

Имя
name string

Имя этого класса почты.

Магазины

Набор записей Магазина.

Имя Путь Тип Описание
Численность
count integer

Общее количество магазинов

Results
results array of Shop

Ресурсы магазина.

ShopSection

Раздел в магазине, в котором пользователь может сортировать списки.

Имя Путь Тип Описание
Идентификатор раздела магазина
shop_section_id integer

Числовые идентификаторы раздела в определенном магазине Etsy.

Название
title string

Строка заголовка для раздела магазина.

Ранг
rank integer

Положительное ненулевое числовое положение этого раздела в заказе на отображение магазина с рангом 1, отображаемым первым.

Идентификатор пользователя
user_id integer

Числовой идентификатор пользователя, которому принадлежит этот раздел магазина.

Число активных листингов
active_listing_count integer

Количество активных списков в одном разделе определенного магазина Etsy.

Магазины

Все разделы в хреновом магазине.

Имя Путь Тип Описание
Численность
count integer

Количество результатов.

Results
results array of ShopSection

Список запрошенных ресурсов.

ShopShippingProfile

Представляет профиль, используемый для задания сведений о доставке списка. Обратите внимание, что с помощью API невозможно создать вычисляемые шаблоны доставки. Однако вы можете связать вычисляемые профили доставки, созданные из Диспетчера магазинов, с описаниями с помощью API.

Имя Путь Тип Описание
Идентификатор профиля доставки
shipping_profile_id integer

Числовой идентификатор профиля доставки.

Название
title string

Строка имени этого профиля доставки.

Идентификатор пользователя
user_id integer

Числовой идентификатор пользователя, которому принадлежит профиль доставки.

Минимальные дни обработки
min_processing_days integer

Минимальное количество дней для обработки списка.

Максимальное число дней обработки
max_processing_days integer

Максимальное количество дней для обработки перечисления.

Метка "Обработка дней"
processing_days_display_label string

Переведенная строка метки отображения для дней обработки.

ISO-код страны происхождения
origin_country_iso string

ISO-код страны, из которой выполняется перечисление.

Удаляется
is_deleted boolean

Когда значение true, кто-то удалил этот профиль доставки.

Назначения профиля доставки
shipping_profile_destinations array of ShopShippingProfileDestination

Список назначений профилей доставки, доступных для этого профиля доставки.

Обновления профиля доставки
shipping_profile_upgrades array of ShopShippingProfileUpgrade

Список обновлений профиля доставки, доступных для этого профиля доставки.

Почтовый индекс источника
origin_postal_code string

Строка почтового кода (не обязательно номер) для расположения, из которого поставляется список.

Тип профиля
profile_type ProfileType

ShopShippingProfileDestination

Представляет место назначения доставки, назначенное профилею доставки.

Имя Путь Тип Описание
Идентификатор назначения профиля доставки
shipping_profile_destination_id integer

Числовой идентификатор назначения профиля доставки в профиле доставки, связанном с списком.

Идентификатор профиля доставки
shipping_profile_id integer

Числовой идентификатор профиля доставки.

ISO-код страны происхождения
origin_country_iso string

ISO-код страны, из которой выполняется перечисление.

ISO-код целевой страны
destination_country_iso string

ISO-код страны, в которую отправляется список. Если значение NULL, запрос задает назначение для destination_region

DestinationRegion
destination_region DestinationRegion

Код региона, в который отправляется перечисление. Регион представляет набор стран. Поддерживаемые регионы — Это Европейский союз и Неевропейский союз (страны в Европе, а не в ЕС). Если нет, запрос задает назначение для destination_country_iso или везде, если destination_country_iso также имеет значение NULL

Деньги
primary_cost Money

Представление суммы денег.

Деньги
secondary_cost Money

Представление суммы денег.

Идентификатор перевозчика доставки
shipping_carrier_id integer

Уникальный идентификатор поддерживаемого перевозчика доставки, который используется для вычисления предполагаемой даты доставки.

Класс Mail
mail_class string

Уникальная строка идентификатора класса почты перевозчика, которая используется для вычисления предполагаемой даты доставки.

Минимальные дни доставки
min_delivery_days integer

Минимальное количество рабочих дней, которое покупатель может ожидать, чтобы получить свой приобретенный элемент после отправки.

Максимальное количество дней доставки
max_delivery_days integer

Максимальное количество рабочих дней, которое покупатель может ожидать, чтобы получить свой приобретенный элемент после отправки.

ShopShippingProfileUpgrade

Представление параметра обновления профиля доставки.

Имя Путь Тип Описание
Идентификатор профиля доставки
shipping_profile_id integer

Числовой идентификатор базового профиля доставки.

Идентификатор обновления
upgrade_id integer

Числовой идентификатор, связанный с обновлением доставки

Имя обновления
upgrade_name string

Имя обновления доставки, отображаемое покупателям при извлечении, например приоритет USPS.

Тип
type Type

Тип обновления доставки. Внутренний (0) или международный (1).

Ранг
rank integer

Положительное числовое положение, отличное от нуля, в изображениях, отображаемых в списке, с рангом 1 изображения отображаются в левой позиции в списке.

Language
language string

Тег языка IETF для языка профиля доставки. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.

Деньги
price Money

Представление суммы денег.

Деньги
secondary_price Money

Представление суммы денег.

Идентификатор перевозчика доставки
shipping_carrier_id integer

Уникальный идентификатор поддерживаемого перевозчика доставки, который используется для вычисления предполагаемой даты доставки.

Класс Mail
mail_class string

Уникальная строка идентификатора класса почты перевозчика, которая используется для вычисления предполагаемой даты доставки.

Минимальные дни доставки
min_delivery_days integer

Минимальное количество рабочих дней, которое покупатель может ожидать, чтобы получить свой приобретенный элемент после отправки.

Максимальное количество дней доставки
max_delivery_days integer

Максимальное количество рабочих дней, которое покупатель может ожидать, чтобы получить свой приобретенный элемент после отправки.

ShopShippingProfileDestinations

Представляет список объектов назначения доставки.

Имя Путь Тип Описание
Численность
count integer

Количество результатов.

Results
results array of ShopShippingProfileDestination

Список запрошенных ресурсов.

ShopShippingProfileUpgrades

Список вариантов обновления доставки.

Имя Путь Тип Описание
Численность
count integer

Количество результатов.

Results
results array of ShopShippingProfileUpgrade

Список запрошенных ресурсов.

UserAddress

Представляет адрес пользователя.

Имя Путь Тип Описание
Идентификатор адреса пользователя
user_address_id integer

Числовой идентификатор адреса пользователя.

Идентификатор пользователя
user_id integer

Числовые идентификаторы пользователя.

Имя
name string

Имя пользователя для этого адреса.

Первая строка адреса
first_line string

Первая строка адреса пользователя.

Вторая адресная строка
second_line string

Вторая строка адреса пользователя.

Город
city string

Поле города адреса пользователя.

Государство
state string

Поле состояния адреса пользователя.

Почтовый индекс
zip string

Поле zip-кода адреса пользователя.

Код страны ISO
iso_country_code string

Iso-код страны в этом адресе.

Страна
country_name string

Имя страны пользователя.

Адрес доставки по умолчанию
is_default_shipping_address boolean

Это адрес доставки пользователя по умолчанию.

UserAddresses

Представляет несколько записей UserAddress.

Имя Путь Тип Описание
Численность
count integer

Число возвращаемых записей UserAddress.

Results
results array of UserAddress

Массив ресурсов UserAddress.

DestinationRegion

Код региона, в который отправляется перечисление. Регион представляет набор стран. Поддерживаемые регионы — Это Европейский союз и Неевропейский союз (страны в Европе, а не в ЕС). Если нет, запрос задает назначение для destination_country_iso или везде, если destination_country_iso также имеет значение NULL

Код региона, в который отправляется перечисление. Регион представляет набор стран. Поддерживаемые регионы — Это Европейский союз и Неевропейский союз (страны в Европе, а не в ЕС). Если нет, запрос задает назначение для destination_country_iso или везде, если destination_country_iso также имеет значение NULL

DestinationRegion
string

ItemDimensionsUnit

Строка, определяющая единицы, используемые для измерения измерений продукта. Значение по умолчанию равно NULL.

Строка, определяющая единицы, используемые для измерения измерений продукта. Значение по умолчанию равно NULL.

ItemDimensionsUnit
string

ItemWeightUnit

Строка, определяющая единицы, используемые для измерения веса продукта. Значение по умолчанию равно NULL.

Строка, определяющая единицы, используемые для измерения веса продукта. Значение по умолчанию равно NULL.

ItemWeightUnit
string

Случай

Перечисленная строка, указывающая случай, для которого этот продукт сделает соответствующий подарок. Значение по умолчанию равно NULL.

Перечисленная строка, указывающая случай, для которого этот продукт сделает соответствующий подарок. Значение по умолчанию равно NULL.

Случай
string

Тип профиля

Тип профиля
string

Recipient

Перечисленная строка, указывающая человека, для которого этот продукт сделает соответствующий подарок. Значение по умолчанию равно NULL.

Перечисленная строка, указывающая человека, для которого этот продукт сделает соответствующий подарок. Значение по умолчанию равно NULL.

Recipient
string

Государство

Перечисленная строка из любого из: активной или неактивной. Примечание. Настройка черновика для активного также будет публиковать список на etsy.com.

Перечисленная строка из любого из: активной или неактивной. Примечание. Настройка черновика для активного также будет публиковать список на etsy.com.

Государство
integer

Тип

Тип обновления доставки. Внутренний (0) или международный (1).

Тип обновления доставки. Внутренний (0) или международный (1).

Тип
integer

WhenMade

Перечисленная строка для эпохи, в которой производитель сделал продукт в этом списке. Помогает покупателям найти список под заголовком "Винтаж". Требуется "is_supply" и "who_made".

Перечисленная строка для эпохи, в которой производитель сделал продукт в этом списке. Помогает покупателям найти список под заголовком "Винтаж". Требуется "is_supply" и "who_made".

WhenMade
string

WhoMade

Перечисляемая строка идикатирована, которая сделала продукт. Помогает покупателям найти список под заголовком Handmade. Требуется "is_supply" и "when_made".

Перечисляемая строка идикатирована, которая сделала продукт. Помогает покупателям найти список под заголовком Handmade. Требуется "is_supply" и "when_made".

WhoMade
string