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

Shopify (независимый издатель) (предварительная версия)

ИНТЕРФЕЙС REST для продавцов Shopify для получения, обработки и управления их заказами.

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

Услуга 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)
Контакт
Имя Microsoft Dynamics
URL https://dynamics.microsoft.com/en-us/support/
Адрес электронной почты bennettray@microsoft.com
Метаданные соединителя
Publisher Рэй Беннетт (MSFT)
Website https://www.shopify.com/
Политика конфиденциальности https://www.shopify.com/legal/privacy
Категории Продуктивность

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

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

По умолчанию

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

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

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

Имя Тип Description Обязательно
Ключ API securestring Маркер доступа для этого API. True
URL-адрес хранилища струна URL-адрес магазина Shopify True

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

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

Действия

Извлекает список заказов

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

Извлекает список клиентов, удовлетворяющих указанным условиям.
Обновляет заказ

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

Отмена заказа по идентификатору.

Извлекает список заказов

Идентификатор операции:
RetrieveAllOrders

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

Параметры

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

Получение только заказов, указанных в разделенном запятыми списке идентификаторов заказов.
Лимит
 limit string

Максимальное количество результатов для отображения на странице.
С идентификатором
 since_id string

Отображение заказов после указанного идентификатора.
Создано в мин.
 created_at_min string

Показывать заказы, созданные по дате или после нее (формат: 2014-04-25T16:15:47-04:00).
Создано в максимальном значении
 created_at_max string

Показывать заказы, созданные по дате или раньше (формат: 2014-04-25T16:15:47-04:00).
Обновлено в мин.
 updated_at_min string

Показывать заказы после последнего обновления по дате или после нее (формат: 2014-04-25T16:15:47-04:00).
Обновлено в максимальном значении
 updated_at_max string

Показывать заказы после последнего обновления по дате или до даты (формат: 2014-04-25T16:15:47-04:00).
Обработано в мин.
 processed_at_min string

Отображение заказов, импортированных по дате или после нее (формат: 2014-04-25T16:15:47-04:00).
Обработано в максимальном значении
 processed_at_max string

Показывать заказы, импортированные по дате или раньше (формат: 2014-04-25T16:15:47-04:00).
Идентификатор приложения attribution
 attribution_app_id string

Отображение заказов, которые относятся к определенному приложению, заданному идентификатором приложения.
Состояние заказа
 status string

Фильтрация заказов по их состоянию.
Финансовое состояние
 financial_status string

Фильтрация заказов по их финансовому состоянию.
Состояние выполнения
 fulfillment_status string

Фильтрация заказов по их состоянию выполнения.
Fields
 fields string

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

Поле и направление сортировки заказов. Чтобы указать направление, добавьте asc или desc в конец параметра запроса. Например, order=updated_at asc.

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

Имя Путь Тип Описание
orders
 orders array of order

Извлекает список клиентов

Идентификатор операции:
RetrieveListOfCustomers

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

Параметры

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

Ограничить результаты клиентами, указанными в списке идентификаторов, разделенных запятыми.
С идентификатором
 since_id string

Ограничить результаты после указанного идентификатора.
Создано в мин.
 created_at_min string

Показывать клиентам, созданным после указанной даты (формат: 2014-04-25T16:15:47-04:00).
Создано в максимальном значении
 created_at_max string

Показывать клиентам, созданным до указанной даты (формат: 2014-04-25T16:15:47-04:00).
Обновлено в мин.
 updated_at_min string

Показывать клиентам последнее обновление после указанной даты (формат: 2014-04-25T16:15:47-04:00).
Обновлено в максимальном значении
 updated_at_max string

Показывать клиентам последнее обновление до указанной даты (формат: 2014-04-25T16:15:47-04:00).
Лимит
 limit string

Максимальное число результатов для отображения. (по умолчанию: 50)(максимум: 250).
Fields
 fields string

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

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

Имя Путь Тип Описание
customers
 customers array of customer

Обновляет заказ

Идентификатор операции:
UpdateAnOrder

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

Параметры

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

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

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

Заказ

Тело
order

Отмена заказа

Идентификатор операции:
CancelAnOrder

Отмена заказа по идентификатору.

Параметры

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

Идентификатор заказа, который будет отменен.
Возврат фактической суммы
 amount string

Сумма возврата. Если задано, Shopify пытается аннулировать или вернуть платеж в зависимости от его состояния. Возмещение покупок через ручной шлюз в случаях, когда исходная транзакция не была выполнена в Shopify. Возврат средств через ручной шлюз записывается как возврат средств на Shopify, но клиент не возвращается.
Валюта возврата денежных средств
 currency string

Валюта возврата, выданная при отмене заказа. Требуется для многовалюты заказов всякий раз, когда предоставляется свойство суммы.
Перезаготовка возвращаемых товаров
 restock string

Следует ли перезаготовить возвращенные товары обратно в инвентаризацию вашего магазина.
Причина отмены заказа
 reason string

Причина отмены заказа. Допустимые значения: клиент, инвентаризация, мошенничество, отклонены и другие.
Сообщение электронной почты об отмене
 email string

Следует ли отправлять клиенту сообщение электронной почты, уведомляющее об отмене.
Возмещение
 refund string

Выполняемые операции возврата средств.
object

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

Заказ

Тело
order

Определения

заказ

Заказ

Имя Путь Тип Описание
id
 id integer

Идентификатор приложения, создавшего заказ.
электронная почта
 email string

Адрес электронной почты клиента.
closed_at
 closed_at string

Дата и время (формат ISO 8601) при закрытии заказа. Возвращает значение NULL, если заказ не закрыт.
создано_в
 created_at string

Трехбуквенный код (формат ISO 4217) для валюты магазина.
updated_at
 updated_at string

Дата и время (формат ISO 8601) при последнем изменении заказа.
число/номер
 number integer

Позиция заказа в количестве заказов в магазине. Числа являются последовательными и начинаются с 1.
заметка
 note string

Необязательно обратите внимание, что владелец магазина может присоединиться к заказу.
token
 token string

Уникальное значение при ссылке на порядок.
шлюз
 gateway string

Используемый шлюз платежей.
test
 test boolean

Указывает, является ли это тестовый заказ.
total_price
 total_price string

Сумма всех цен на товары линии, скидки, доставка, налоги и советы в валюте магазина. Должно быть положительным.
subtotal_price
 subtotal_price string

Цена заказа в валюте магазина после скидок, но перед доставкой, пошлинами, налогами и советами.
total_weight
 total_weight integer

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

Сумма всех налогов, примененных к заказу в валюте магазина. Должно быть положительным.
taxes_included
 taxes_included boolean

Включаются ли налоги в промежуточный итог заказа.
currency
 currency string

Трехбуквенный код (формат ISO 4217) для валюты магазина.
financial_status
 financial_status string

Состояние платежей, связанных с заказом. Можно задать только при создании заказа.
хронический
 confirmed boolean

Подтверждение заказа.
total_discounts
 total_discounts string

Общие скидки, примененные к цене заказа в валюте магазина.
total_line_items_price
 total_line_items_price string

Сумма всех цен на товары в валюте магазина.
cart_token
 cart_token string

Уникальное значение при ссылке на корзину, связанную с порядком.
buyer_accepts_marketing
 buyer_accepts_marketing boolean

Дает ли клиенту согласие на получение обновлений электронной почты из магазина.
имя
 name string

Имя заказа, созданное путем объединения свойства order_number с префиксом заказа и суффиксом, заданными в общих параметрах продавца.
referring_site
 referring_site string

Веб-сайт, на котором клиент щелкнул ссылку на магазин.
landing_site
 landing_site string

URL-адрес страницы, где покупатель приземлился, когда они вошли в магазин.
отменено_в
 cancelled_at string

Дата и время отмены заказа. Возвращает значение NULL, если заказ не отменен.
cancel_reason
 cancel_reason string

Причина отмены заказа.
total_price_usd
 total_price_usd string

Общая цена в долларах США.
checkout_token
 checkout_token string

Уникальное значение при ссылке на выход, связанный с порядком.
справочник
 reference string

Справочник по заказу.
user_id
 user_id integer

Идентификатор пользователя, вошедшего в Shopify POS, который обработал заказ, если это применимо.
location_id
 location_id integer

Идентификатор физического расположения, в котором был обработан заказ. Если вам нужно ссылаться на расположение по заказу, используйте ресурс FulfillmentOrder.
source_identifier
 source_identifier string

Идентификатор источника.
source_url
 source_url string

Url-адрес источника.
processed_at
 processed_at string

Дата и время (формат ISO 8601) при обработке заказа.
device_id
 device_id string

Идентификатор устройства.
phone
 phone string

Номер телефона клиента для получения SMS-уведомлений.
customer_locale
 customer_locale string

Код языка с двумя или тремя буквами, за которым при необходимости следует модификатор региона.
app_id
 app_id integer

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

IP-адрес браузера, используемый клиентом при размещении заказа.
landing_site_ref
 landing_site_ref string

Ссылка на целевой сайт.
order_number
 order_number integer

Позиция заказа в количестве заказов, начиная с 1001 года.
discount_applications
 discount_applications discount_applications

Описание приложения скидок, определенного продавцом или скриптом Shopify.
discount_codes
 discount_codes discount_codes

Список скидок, примененных к заказу.
note_attributes
 note_attributes note_attributes

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

Список шлюзов платежей, используемых для заказа.
processing_method
 processing_method string

Как был обработан платеж.
checkout_id
 checkout_id integer

Идентификатор выхода.
source_name
 source_name string

Где возникло заказ.
fulfillment_status
 fulfillment_status string

Состояние заказа с точки зрения выполненных элементов строки.
tax_lines
 tax_lines tax_lines

Список объектов налоговой линии, каждый из которых содержит сведения о налоге, примененном к элементу.
tags
 tags string

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

Обратитесь по электронной почте.
order_status_url
 order_status_url string

URL-адрес, указывающий на веб-страницу состояния заказа, если применимо.
presentment_currency
 presentment_currency string

Валюта представления, которая использовалась для отображения цен для клиента.
total_line_items_price_set
 total_line_items_price_set subtotal_tax_discount_price_set
total_discounts_set
 total_discounts_set subtotal_tax_discount_price_set
total_shipping_price_set
 total_shipping_price_set subtotal_tax_discount_price_set
subtotal_price_set
 subtotal_price_set subtotal_tax_discount_price_set
total_price_set
 total_price_set subtotal_tax_discount_price_set
total_tax_set
 total_tax_set subtotal_tax_discount_price_set
admin_graphql_api_id
 admin_graphql_api_id string

Идентификатор API Graphql администратора.
shipping_lines
 shipping_lines shipping_lines

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

Адрес рассылки, связанный с методом оплаты. Этот адрес является необязательным полем, которое не будет доступно в заказах, которые не требуют метода оплаты.
shipping_address
 shipping_address shipping_address

Почтовый адрес, в который будет отправлен заказ. Этот адрес является необязательным и не будет доступен в заказах, которые не требуют доставки.
client_details
 client_details client_detail

Сведения о браузере, который клиент использовал при размещении заказа.
payment_details
 payment_details payment_detail

Объект, содержащий сведения об оплате.
клиент
 customer customer

Информация о пользователе.
line_items
 line_items line_items
Свершений
 fulfillments fulfillments

Массив выполнения, связанный с заказом.
Возврат
 refunds refunds

Возврат

клиент

Информация о пользователе.

Имя Путь Тип Описание
id
 id integer

Уникальный идентификатор клиента.
электронная почта
 email string

Уникальный адрес электронной почты клиента. Попытка назначить один адрес электронной почты нескольким клиентам возвращает ошибку.
accepts_marketing
 accepts_marketing boolean

Имеет ли клиент согласие на получение маркетинговых материалов по электронной почте.
создано_в
 created_at string

Дата и время (формат ISO 8601) при создании клиента.
updated_at
 updated_at string

Дата и время (формат ISO 8601) при последнем обновлении сведений о клиенте.
first_name
 first_name string

Имя клиента.
last_name
 last_name string

Фамилия клиента.
orders_count
 orders_count integer

Количество заказов, связанных с этим клиентом.
государство
 state string

Состояние учетной записи клиента с магазином. Значение по умолчанию: отключено.
total_spent
 total_spent string

Общая сумма денег, которую клиент потратил в истории заказов.
last_order_id
 last_order_id integer

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

Примечание о клиенте.
verified_email
 verified_email boolean

Проверяет ли клиент свой адрес электронной почты.
multipass_identifier
 multipass_identifier string

Уникальный идентификатор клиента, который используется для входа в Multipass.
tax_exempt
 tax_exempt boolean

Является ли клиент освобожден от уплаты налогов по их заказу. Если верно, то налоги не будут применяться к заказу при извлечении. Если значение false, то налоги будут применяться при извлечении.
phone
 phone string

Уникальный номер телефона (формат E.164) для этого клиента. Попытка назначить один и тот же номер телефона нескольким клиентам возвращает ошибку.
tags
 tags string

Теги, которые владелец магазина прикрепил к клиенту, отформатированный как строка разделенных запятыми значений. Клиент может иметь до 250 тегов. Каждый тег может содержать до 255 символов.
last_order_name
 last_order_name string

Имя последнего заказа клиента. Это напрямую связано с полем имени ресурса Order.
currency
 currency string

Трехбуквенный код (формат ISO 4217) для валюты, используемой клиентом при оплате последнего заказа.
addresses
 addresses addresses

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

Дата и время (формат ISO 8601), когда клиент согласился или возражал на получение маркетинговых материалов по электронной почте.
marketing_opt_in_level
 marketing_opt_in_level string

Маркетинговая подписка на подписку, которую клиент дал, когда он дал согласие на получение маркетинговых материалов по электронной почте.
tax_exemptions
 tax_exemptions array of

Является ли клиент освобожден от уплаты конкретных налогов по их заказу.
admin_graphql_api_id
 admin_graphql_api_id string

Идентификатор API Graphql администратора.
default_address
 default_address default_address

default_address

Имя Путь Тип Описание
id
 id integer

Уникальный идентификатор адреса.
customer_id
 customer_id integer

Уникальный идентификатор клиента.
first_name
 first_name string

Имя клиента.
last_name
 last_name string

Фамилия клиента.
компания
 company string

Компания клиента.
адрес1
 address1 string

Первая строка почтового адреса клиента.
Адрес2
 address2 string

Дополнительное поле для почтового адреса клиента.
city
 city string

Город, город или деревня клиента.
провинция
 province string

Имя региона клиента. Обычно провинция, штат или префектура.
country
 country string

Страна клиента.
ZIP-архив
 zip string

Почтовый индекс клиента, также известный как zip,postcode, Eircode и т. д.
phone
 phone string

Номер телефона клиента по этому адресу.
имя
 name string

Имена и фамилии клиента.
province_code
 province_code string

Двухбуквенный код для региона клиента.
country_code
 country_code string

Двухбуквенный код страны, соответствующий стране клиента.
country_name
 country_name string

Нормализованное имя страны клиента.
default
 default boolean

Возвращает значение true для каждого адреса по умолчанию.

shipping_address

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

Имя Путь Тип Описание
first_name
 first_name string

Имя лица, связанного с адресом доставки.
адрес1
 address1 string

Адрес улицы адреса доставки.
phone
 phone string

Номер телефона по адресу доставки.
city
 city string

Город, город или деревня адреса доставки.
ZIP-архив
 zip string

Почтовый индекс (например, почтовый индекс, почтовый индекс или Eircode) адреса доставки.
провинция
 province string

Имя региона (например, провинции, штата или префектуры) адреса доставки.
country
 country string

Имя страны доставки.
last_name
 last_name string

Фамилия лица, связанного с адресом доставки.
Адрес2
 address2 string

Дополнительное поле для адреса улицы адреса доставки.
компания
 company string

Компания лица, связанного с адресом доставки.
широта
 latitude float

Широта адреса доставки.
долгота
 longitude float

Долгота адреса доставки.
имя
 name string

Полное имя пользователя, связанного с методом оплаты.
country_code
 country_code string

Двухбуквенный код (формат ISO 3166-1) для страны доставки.
province_code
 province_code string

Двухбуквенное сокращение региона адреса доставки.

billing_address

Адрес рассылки, связанный с методом оплаты. Этот адрес является необязательным полем, которое не будет доступно в заказах, которые не требуют метода оплаты.

Имя Путь Тип Описание
first_name
 first_name string

Первое имя пользователя, связанного с методом оплаты.
адрес1
 address1 string

Адрес улицы адреса выставления счетов.
phone
 phone string

Номер телефона по адресу выставления счетов.
city
 city string

Город, город или деревня адреса выставления счетов.
ZIP-архив
 zip string

Почтовый индекс (например, почтовый индекс, почтовый индекс или Eircode) адреса выставления счетов.
провинция
 province string

Имя региона (например, провинции, штата или префектуры) адреса выставления счетов.
country
 country string

Имя страны адреса выставления счетов.
last_name
 last_name string

Фамилия лица, связанного с методом оплаты.
Адрес2
 address2 string

Дополнительное поле для адреса улицы адреса выставления счетов.
компания
 company string

Компания лица, связанного с адресом выставления счетов.
широта
 latitude float

Широта адреса выставления счетов.
долгота
 longitude float

Долгота адреса выставления счетов.
имя
 name string

Полное имя пользователя, связанного с методом оплаты.
country_code
 country_code string

Двухбуквенный код (формат ISO 3166-1) для страны адреса выставления счетов.
province_code
 province_code string

Двухбуквенное сокращение региона адреса выставления счетов.

addresses

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

Имя Путь Тип Описание
Товары
 default_address

shipping_line

Имя Путь Тип Описание
id
 id integer

Глобальный уникальный идентификатор.
title
 title string

Заголовок метода доставки.
цена
 price string

Цена этого метода доставки в валюте магазина.
код
 code string

Ссылка на метод доставки.
source
 source string

Источник метода доставки.
phone
 phone string

Номер телефона по адресу доставки.
requested_fulfillment_service_id
 requested_fulfillment_service_id string

Ссылка на службу выполнения, запрашиваемую для метода доставки. Указывает, требуется ли метод доставки сторонней службой выполнения; Значение NULL в противном случае.
delivery_category
 delivery_category string

Категория доставки.
carrier_identifier
 carrier_identifier string

Ссылка на службу перевозчика, которая предоставила ставку. Присутствует, когда скорость вычисляется сторонней службой перевозчика.
discounted_price
 discounted_price string

Цена метода доставки после применения скидок на уровне линии. Не отражает скидки на уровне корзины или заказа.
price_set
 price_set subtotal_tax_discount_price_set
discounted_price_set
 discounted_price_set subtotal_tax_discount_price_set
discount_allocations
 discount_allocations array of

Упорядоченный список сумм, выделенных приложениями скидок.
tax_lines
 tax_lines tax_lines

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

client_detail

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

Имя Путь Тип Описание
browser_ip
 browser_ip string

IP-адрес браузера.
accept_language
 accept_language string

Языки и языковые стандарта, которые понимает браузер.
user_agent
 user_agent string

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

Хэш сеанса.
browser_width
 browser_width integer

Ширина экрана браузера в пикселях, если она доступна.
browser_height
 browser_height integer

Высота экрана браузера в пикселях, если она доступна.

payment_detail

Объект, содержащий сведения об оплате.

Имя Путь Тип Описание
credit_card_bin
 credit_card_bin string

Идентификационный номер издателя (IIN), ранее известный как идентификационный номер банка (BIN) кредитной карты клиента.
avs_result_code
 avs_result_code string

Код ответа из системы проверки адресов (AVS). Код является одной буквой.
cvv_result_code
 cvv_result_code string

Код ответа от компании кредитной карты, указывающий, ввел ли клиент код безопасности карты (значение проверки карты) правильно. Код представляет собой одну букву или пустую строку.
credit_card_number
 credit_card_number string

Номер кредитной карты клиента, при этом большинство ведущих цифр были отредактированы.
credit_card_company
 credit_card_company string

Имя компании, выдавшей кредитную карту клиента.

subtotal_tax_discount_price_set

Имя Путь Тип Описание
количество
 shop_money.amount string

Фактическая сумма.
currency_code
 shop_money.currency_code string

В формате ISO 4217.
количество
 presentment_money.amount string

Фактическая сумма.
currency_code
 presentment_money.currency_code string

В формате ISO 4217.

line_item_property

Имя Путь Тип Описание
имя
 name string

Имя продукта.
value
 value string

Значение продукта.

line_item_properties

Свойства.

Имя Путь Тип Описание
Товары
 line_item_property

выполнение

Имя Путь Тип Описание
id
 id integer

Идентификатор выполнения.
order_id
 order_id integer

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

Состояние выполнения.
создано_в
 created_at string

Дата и время создания выполнения.
услуга
 service string

Тип используемой службы.
updated_at
 updated_at string

Дата и время (формат ISO 8601) при последнем изменении выполнения.
tracking_company
 tracking_company string

Имя компании отслеживания.
shipment_status
 shipment_status string

Текущее состояние отгрузки выполнения.
location_id
 location_id integer

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

Номер отслеживания, предоставленный компанией-перевозчиком.
tracking_numbers
 tracking_numbers array of string

Список номеров отслеживания, предоставляемых компанией-перевозчиком.
tracking_url
 tracking_url string

URL-адрес страницы отслеживания выполнения.
tracking_urls
 tracking_urls array of string

URL-адреса страниц отслеживания для выполнения.
квитанция
 receipt receipt

Текстовое поле, предоставляющее сведения о квитанции.
имя
 name string

Уникальное имя выполнения.
admin_graphql_api_id
 admin_graphql_api_id string

Идентификатор API Graphql администратора.
line_items
 line_items line_items

Свершений

Массив выполнения, связанный с заказом.

Имя Путь Тип Описание
Товары
 fulfillment

транзакция

Имя Путь Тип Описание
id
 id integer

Идентификатор транзакции.
order_id
 order_id integer

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

Тип транзакции.
шлюз
 gateway string

Имя шлюза, через который была выдана транзакция.
статус
 status string

Статус проводки.
сообщение
 message string

Строка, созданная поставщиком платежей с дополнительными сведениями о том, почему транзакция завершилась успешно или завершилась ошибкой.
создано_в
 created_at string

Дата и время (формат ISO 8601) при создании транзакции.
test
 test boolean

Указывает, является ли транзакция тестовой.
авторизация
 authorization string

Код авторизации, связанный с транзакцией.
location_id
 location_id string

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

Идентификатор пользователя, вошедшего в устройство Shopify POS при обработке заказа, если применимо.
parent_id
 parent_id integer

Идентификатор связанной транзакции.
processed_at
 processed_at string

Дата и время (формат ISO 8601) при обработке транзакции.
device_id
 device_id string

Идентификатор устройства.
error_code
 error_code string

Стандартизированный код ошибки, не зависящий от поставщика платежей.
source_name
 source_name string

Источник транзакции. Это задано Shopify и не может быть переопределено.
количество
 amount string

Сумма денег, включенных в транзакцию.
currency
 currency string

Трехбуквенный код (формат ISO 4217) для валюты, используемой для оплаты.
admin_graphql_api_id
 admin_graphql_api_id string

Идентификатор API Graphql администратора.

транзакции;

Список транзакций, участвующих в возврате средств.

Имя Путь Тип Описание
Товары
 transaction

tax_line

Имя Путь Тип Описание
цена
 price string

Сумма налога, которую необходимо взимать в валюте магазина.
скорость
 rate float

Ставка налога, применяемая.
title
 title string

Имя налога.
price_set
 price_set subtotal_tax_discount_price_set

tax_lines

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

Имя Путь Тип Описание
Товары
 tax_line

Возврат

Возврат

Имя Путь Тип Описание
Товары
 refund

возмещение

Имя Путь Тип Описание
id
 id integer

Уникальный идентификатор для возврата средств.
order_id
 order_id integer

Идентификатор заказа, используемый для целей API.
создано_в
 created_at string

Дата и время (формат ISO 8601) при создании возврата.
заметка
 note string

Необязательная заметка, присоединенная к возврату средств.
user_id
 user_id integer

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

Дата и время (формат ISO 8601) при импорте возврата.
пополнять запасы
 restock boolean

Следует ли добавлять элементы строки обратно в инвентаризацию магазина.
admin_graphql_api_id
 admin_graphql_api_id string

Идентификатор API Graphql администратора.
транзакции;
 transactions transactions

Список транзакций, участвующих в возврате средств.
order_adjustments
 order_adjustments array of

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

line_item

Список объектов элементов строки, каждый из которых содержит сведения о элементе в порядке.

Имя Путь Тип Описание
id
 id integer

Идентификатор элемента строки.
variant_id
 variant_id integer

Идентификатор варианта продукта.
title
 title string

Название продукта.
количество
 quantity integer

Количество приобретенных элементов.
sku
 sku string

Номер SKU элемента (единица хранения запасов).
variant_title
 variant_title string

Название варианта продукта.
продавец
 vendor string

Имя поставщика элемента.
fulfillment_service
 fulfillment_service string

Поставщик услуг, выполняющий элемент.
product_id
 product_id integer

Идентификатор продукта, к которому принадлежит элемент строки.
requires_shipping
 requires_shipping boolean

Требуется ли доставка товара.
облагаемый налогом
 taxable boolean

Является ли элемент налогооблагаемым.
gift_card
 gift_card boolean

Указывает, является ли элемент строки подарочной картой.
имя
 name string

Имя варианта продукта.
variant_inventory_management
 variant_inventory_management string

Имя службы управления инвентаризацией.
properties
 properties line_item_properties

Свойства.
product_exists
 product_exists boolean

Существует ли продукт.
fulfillable_quantity
 fulfillable_quantity integer

Объем, доступный для выполнения.
Граммы
 grams integer

Вес элемента в граммах.
цена
 price string

Цена товара до того, как скидки были применены в валюте магазина.
total_discount
 total_discount string

Общая сумма скидки, выделенной для элемента линии в валюте магазина.
fulfillment_status
 fulfillment_status string

Состояние заказа с точки зрения выполняемых элементов строки.
price_set
 price_set subtotal_tax_discount_price_set
total_discount_set
 total_discount_set subtotal_tax_discount_price_set
discount_allocations
 discount_allocations array of

Упорядоченный список сумм, выделенных приложениями скидок.
admin_graphql_api_id
 admin_graphql_api_id string

Идентификатор API Graphql администратора.
tax_lines
 tax_lines tax_lines

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

line_items

Имя Путь Тип Описание
Товары
 line_item

Список объектов элементов строки, каждый из которых содержит сведения о элементе в порядке.

shipping_lines

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

Имя Путь Тип Описание
Товары
 shipping_line

payment_gateway_names

Список шлюзов платежей, используемых для заказа.

Имя Путь Тип Описание
Товары
 string

note_attribute

Имя Путь Тип Описание
имя
 name string

Запишите имя атрибута.
value
 value string

Запишите значение атрибута.

note_attributes

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

Имя Путь Тип Описание
Товары
 note_attribute

discount_code

Имя Путь Тип Описание
код
 code string

Если связанное приложение скидки имеет тип кода, это свойство возвращает код скидки, введенный при извлечении.
количество
 amount string

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

Тип скидки.

discount_codes

Список скидок, примененных к заказу.

Имя Путь Тип Описание
Товары
 discount_code

discount_application

Имя Путь Тип Описание
type
 type string

Тип приложения скидки.
value
 value string

Значение приложения скидки в виде десятичного разряда. Это представляет намерение приложения скидок.
value_type
 value_type string

Тип значения.
allocation_method
 allocation_method string

Метод, с помощью которого значение приложения скидки было выделено для строк с правом.
target_selection
 target_selection string

Строки в заказе типа, определенного target_type, выделены скидки.
target_type
 target_type string

Тип строки в заказе, на который применяется скидка.
код
 code string

Код скидки, используемый для применения скидки. Доступно только для приложений скидок.

discount_applications

Описание приложения скидок, определенного продавцом или скриптом Shopify.

Имя Путь Тип Описание
Товары
 discount_application

квитанция

Текстовое поле, предоставляющее сведения о квитанции.

Имя Путь Тип Описание
testcase
 testcase boolean

Является ли выполнение тестовый регистр.
авторизация
 authorization string

Код авторизации.