Довідка
Увійти

Доступ до докладних даних у панелі адміністрування Shopify за допомогою JSON

JSON (скорочення від JavaScript Object Notation) — це формат для зберігання та передачі даних, який часто використовується під час надсилання даних із серверів на вебсторінки. На більшості сторінок ресурсів у панелі адміністрування Shopify, як-от сторінки Замовлення, Товари або Клієнти, можна отримати доступ до докладніших даних за допомогою JSON.

Хоча вам не обов'язково виконувати розширені завдання з розробки за допомогою JSON, можливість доступу до файлу JSON певного ресурсу в панелі адміністрування Shopify може допомогти зібрати докладнішу інформацію, а також самостійно проаналізувати проблеми або виконати усунення несправностей. Наприклад, ви можете переглянути файл JSON для товару, щоб знайти його ідентифікатор варіанта, який може знадобитися для певних завдань із міграції даних або кастомізації коду теми. Інший приклад: ви можете звернутися до файлу JSON замовлення, щоб підтвердити змінну даних, яку ви хочете використати під час створення автоматизованого робочого процесу в Shopify Flow.

JSON найчастіше використовується розробниками, але навіть користувачі з обмеженими знаннями в програмуванні можуть отримати користь від уміння знаходити й інтерпретувати поширену інформацію JSON у своїй панелі адміністрування Shopify.

На цій сторінці

Переформатування файлу JSON

Необроблені дані JSON відображаються як довга послідовність вкладених змінних і дужок, яку важко читати людині.

Щоб зробити формат JSON більш читабельним, розгляньте один із наведених нижче варіантів.

  • Установіть розширення для перегляду JSON у вашому браузері.
  • Використовуйте можливість форматованого виводу (pretty-print), яка за замовчуванням доступна в більшості сучасних веббраузерів:

Скриншот файлу JSON товару з відображенням прикладу інформації про товар. Прапорець налаштування «pretty-print» активний і виділений у верхньому лівому куті сторінки.

Доступ до файлів JSON у панелі адміністрування Shopify

Панель адміністрування Shopify — це центральний хаб для керування всіма аспектами вашого бізнесу. За замовчуванням вона відображає лише найкориснішу та найактуальнішу інформацію. Додаткова інформація, яка збирається під час виконання дій у вашій панелі адміністрування, зберігається у файлах .json різних сторінок ресурсів. Ці додаткові відомості не відображаються для вас за замовчуванням, оскільки така кількість інформації була б надмірною й некорисною, а також ускладнила б використання панелі адміністрування.

Для більшості бізнес-завдань ви можете використовувати наявні інструменти Shopify, щоб отримувати доступ до інформації вашого магазину та інтерпретувати її. Однак іноді під час усунення несправностей (щоб зрозуміти, чому чи коли щось сталося) буває корисно переглянути конкретну інформацію про певні ресурси, як-от товари чи замовлення.

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

У цьому прикладі ви отримаєте доступ до файлу JSON замовлення у своїй панелі адміністрування Shopify.

Кроки:

  1. У панелі адміністрування Shopify перейдіть у розділ Замовлення.

  2. Натисніть будь-яке замовлення в списку Замовлення.

  3. В адресному рядку браузера додайте .json у кінець URL-адреси. Це виглядатиме приблизно так, як у цьому прикладі:

https://admin.shopify.com/store/{example-shop-name}/orders/12345678901234.json
  1. Натисніть Enter, щоб перезавантажити сторінку у форматі JSON.
  2. Необов'язково: якщо у вашому браузері не встановлено розширення для перегляду JSON, активуйте налаштування Pretty-print (форматований вивід) у браузері, щоб зробити файл JSON зручнішим для читання. Дізнайтеся більше про переформатування файлу JSON.

Ви помітите, що відображається багато очікуваної інформації про замовлення, наприклад "currency" та "line_items", але також включено багато іншої докладної інформації, як-от "client_details" із сеансу браузера клієнта під час розміщення замовлення. Така інформація корисна для загального відстеження сеансів і аналітики маркетингової платформи, але вона не є обов'язковою для опрацювання та виконання замовлення.

Відображення певних полів у файлі JSON

Ви можете налаштувати файли JSON на відображення лише певних полів. Це спрощує інтерпретацію інформації, якщо ви знаєте конкретні властивості, які потрібно включити. У кінці URL-адреси будь-якого файлу JSON в адресному рядку браузера додайте ?fields=, а потім вкажіть назви властивостей, які потрібно відобразити, у будь-якому порядку через кому.

Наприклад, щоб відобразити ідентифікатор замовлення, інформацію про клієнта, загальну ціну та теги, додайте ?fields=id,customer,total_price,tags у кінець URL-адреси файлу JSON, як у наведеному нижче прикладі:

https://admin.shopify.com/store/{example-shop-name}/orders/12345678901234.json?fields=id,customer,total_price,tags

Використання інших ресурсів JSON

Ви можете використовувати наведені нижче ресурси JSON для відображення певної інформації у вашій панелі адміністрування Shopify:

  • Кількість товарів: додайте /count.json у кінець URL-адреси списку Товари, щоб відобразити загальну кількість товарів. Повна URL-адреса має бути такою:
https://admin.shopify.com/store/{example-shop-name}/products/count.json
  • Транзакції: додайте /transactions.json у кінець URL-адреси сторінки замовлення, щоб відобразити лише інформацію про транзакції замовлення. Дізнайтеся більше про ресурс транзакцій.
  • Виконання замовлень: додайте /fulfillments.json у кінець URL-адреси сторінки замовлення, щоб відобразити лише інформацію про виконання замовлення. Дізнайтеся більше про ресурс виконання.
  • Покинуті оформлення замовлень: додайте .json у кінець URL-адреси покинутого оформлення замовлення, щоб відобразити докладну інформацію про покинуте оформлення замовлення. Дізнайтеся більше про ресурс покинутих оформлень замовлень.

Загальні властивості JSON для усунення несправностей

У наведеній нижче таблиці перелічено властивості JSON, до яких можна звертатися для допомоги в усуненні несправностей із ресурсами різних типів. Наприклад, якщо ви хочете підтвердити, коли було опубліковано певний товар, ви можете переглянути у файлі JSON цього товару властивість published_at, яка відображає дату й час у форматі ISO 8601.

У цій таблиці не наведено всі можливі ресурси чи властивості JSON, що зберігаються в панелі адміністрування Shopify, тому звертайтеся до документації для розробників Shopify щодо визначень будь-якого ресурсу чи властивості, яких тут немає.

У цьому списку наведено деякі приклади ресурсів панелі адміністрування та пов’язаних із ними загальних властивостей, зокрема їхнє призначення під час усунення несправностей.
РесурсВластивість JSONВизначення
Товар
"product": {
  "created_at"
Час і дата початкового створення товару.
"product": {
  "published_at"
Час і дата, коли статус товару було змінено на Активний.
"product": {
  "updated_at"
Останні час і дата оновлення товару. Це можуть бути зміни в описі товару, назві чи інформації для SEO, а також автоматичні оновлення, як-от зміна запасів під час купівлі товару.
Варіант
"product": {
  "variants": [
    {
    "created_at"
Час і дата початкового створення варіанта. Вони можуть відрізнятися від дати й часу створення самого товару.
"product": {
  "variants": [
    {
    "updated_at"
Останні час і дата оновлення варіанта. Вони можуть відрізнятися від дати й часу останнього оновлення самого товару.
"product": {
  "variants": [
    {
    "inventory_quantity"
Поточне значення в базі даних і те, що є доступним для клієнтів для купівлі. Воно може бути від’ємним, якщо запаси варіанта не відстежуються або якщо налаштовано змогу продавати більше наявного.
"product": {
  "variants": [
    {
    "old_inventory_quantity"
Значення в базі даних до останньої дати updated_at варіанта.
Замовлення
"order": {
   "line_items": [
    {
    "requires_shipping"
Відображається як true або false. Це вказує на налаштування доставки товару чи варіанта на момент оформлення замовлення.
"order": {
   "line_items": [
    {
    "taxable"
Відображається як true або false. Це вказує на налаштування стягнення податку для товару чи варіанта на момент оформлення замовлення.
"order": {
   "line_items": [
    {
    "variant_inventory_management"
Відображається як shopify, amazon_marketplace_web, null або інше стороннє значення залежно від того, яка служба виконання замовлень налаштована для відстеження запасів товару. Значення null означає, що відстеження товару на момент замовлення не здійснювалося.
"order": {
   "line_items": [
    {
    "fulfillable_quantity"
Показує, скільки запасів ще зарезервовано системою для виконання замовлення. Це значення не дорівнює поточним запасам варіанта.
"order": {
   "line_items": [
    {
    "quantity"
Кількість придбаних товарів або варіантів.
"order": {
   "line_items": [
    {
    "tax_lines"
У США тут відображаються значення штату, округу та муніципалітету. Якщо рядки податків не відображаються, але податок за замовлення було стягнено, це означає, що податок було нараховано на вартість доставки.
Клієнт
"customer": {
  "created_at"
Час і дата початкового створення клієнта.
"customer": {
  "updated_at"
Останні час і дата оновлення профілю клієнта.

Метаполя у форматі JSON

Метаполя — це гнучкий спосіб додавання додаткової користувацької інформації до ресурсів Shopify, як-от товарів або колекцій. Дані, які зберігаються за допомогою метаполів, можуть містити технічні характеристики товарів, таблиці розмірів, документи для завантаження, дати випуску, зображення або номери деталей. Дізнайтеся більше про використання метаполів.

Щоб відобразити метаполя, пов’язані з підтримуваним ресурсом, ви можете додати /metafields.json у кінець URL-адреси його сторінки. У таблиці нижче наведено кілька прикладів ресурсів і форматів URL-адрес для відображення інформації метаполів за допомогою JSON.

Тут наведено кілька прикладів ресурсів панелі адміністрування разом із прикладом URL-адреси файлу метаполів JSON.
Приклад типу ресурсуПриклад URL-адреси
Колекціяhttps://admin.shopify.com/store/{your-store-name}/collections/{collection-id}/metafields.json
Клієнтhttps://admin.shopify.com/store/{your-store-name}/customers/{customer-id}/metafields.json
Замовленняhttps://admin.shopify.com/store/{your-store-name}/orders/{order-id}/metafields.json
Сторінкаhttps://admin.shopify.com/store/{your-store-name}/pages/{page-id}/metafields.json
Товарhttps://admin.shopify.com/store/{your-store-name}/products/{product-id}/metafields.json
Варіантhttps://admin.shopify.com/store/{your-store-name}/products/{product-id}/variants/{variant-id}/metafields.json
Зображення товаруhttps://admin.shopify.com/store/{your-store-name}/metafields.json?metafield[owner_id]={id}&metafield[owner_resource]=product_image

Примітка. Метаполя зображення товару можна додати лише через API. Замініть {id} та інші заповнювачі в URL-адресі на фактичні значення з ваших запитів API.

Магазинhttps://admin.shopify.com/store/{your-store-name}/metafields.json

Повний список ресурсів, які можуть мати метаполя, і конкретних типів властивостей, що зберігаються для кожного типу ресурсу, дивіться в розділі ресурсу Metafield JSON у документації для розробників Shopify.

Події у форматі JSON

Деякі ресурси Shopify генерують події, коли виконуються певні дії, як-от створення публікації в блозі, виконання замовлення чи додавання товару.

Щоб відобразити події, пов’язані з підтримуваним ресурсом, ви можете додати /events.json у кінець URL-адреси його сторінки. У таблиці нижче наведено кілька прикладів ресурсів і форматів URL-адрес для відображення інформації про події за допомогою JSON.

Тут наведено кілька прикладів ресурсів панелі адміністрування разом із прикладом URL-адреси файлу подій JSON.
Приклад типу ресурсуПриклад URL-адреси
Замовленняhttps://admin.shopify.com/store/{your-store-name}/orders/{order-id}/events.json

У цьому файлі вказано параметр author для подій, що інформує вас про те, які користувачі виконали певні дії, наприклад хто або що опублікувало товар.

Товарhttps://admin.shopify.com/store/{your-store-name}/products/{product-id}/events.json

У цьому файлі вказано параметр author для подій, що інформує вас про те, які користувачі виконали певні дії, наприклад хто або що позначило платіж як оплачений.

Магазинhttps://admin.shopify.com/store/{your-store-name}/events.json?limit=250

Цей формат URL-адреси відображає 250 найостанніших подій, які відбулися у вашому магазині. До подій можуть належати, зокрема, створення або оновлення товару, видалення сторінок і оновлення варіантів.

Повний список ресурсів, які можуть створювати події, і конкретних подій, що створюються для кожного типу ресурсу, дивіться в розділі ресурсу Event JSON у документації для розробників Shopify.