API етикеток повернення для зворотної логістики в електронній комерції
Генеруйте PDF етикеток повернення та інструкцій із даних електронної комерції або підтримки зі сторінками розміру етикетки, штрихкодами й шаблонними передруками.
/api/v1/pdf/render Рендерити PDF етикеток повернення або аркуші інструкцій із даних RMA, клієнта, товару, пункту призначення й штрихкоду, щоб портал повернень міг надати клієнту детермінований документ.
Коли використовувати цю API
- Ваша система вже створила RMA і авторизацію повернення.
- Перевізник або система повернень уже надала дані етикетки чи дані трекінгу.
- Потрібна PDF-етикетка або аркуш інструкцій, який можна завантажити, надіслати email або передрукувати.
- Потрібно повторно використовувати той самий макет етикетки повернення через Template Render.
Що вона не замінює
- Потрібно, щоб gPdf схвалив повернення, купив поштові послуги або створив відправлення перевізника.
- Потрібна пряма оркестрація API перевізника.
- Потрібен вивід команд принтера, наприклад ZPL.
Який шлях API викликати
/api/v1/pdf/render
JSON Render — типовий шлях для цього сценарію.
/api/v1/template-render
Використовуйте, коли сценарію потрібен пов’язаний API-шлях, контракт шаблону або перевірка можливостей.
Мінімальний запит
POST /api/v1/pdf/render - етикетка повернення зі штрихкодом RMA.
{
"pages": [
{
"size": "label_4_6_in",
"elements": [
{
"type": "text",
"x": 5,
"y": 8,
"content": "RETURN TO",
"style": { "font_size": 9, "font_family": "NotoSans-Regular" }
},
{
"type": "text",
"x": 5,
"y": 18,
"content": "Acme Returns\n500 Dock Door 4\nColumbus OH 43215",
"style": { "font_size": 11, "font_family": "NotoSans-Regular" }
},
{
"type": "barcode",
"format": "code128",
"content": "RMA-2026-77881",
"x": 5,
"y": 70,
"width": 88,
"height": 20,
"barcode_text": { "enabled": true, "position": "bottom" }
}
]
}
]
}
Що виконує gPdf
- PDF-рендеринг для етикеток повернення розміру етикетки й сторінок інструкцій.
- Штрихкод, текст, адресу, RMA і службові блоки.
- Прив’язку шаблону для затверджених макетів етикеток повернення або інструкцій.
- Детермінований вивід для повторних завантажень клієнтом і передруків службою підтримки.
Що контролює ваша система
- Право на повернення, стан RMA, акаунт перевізника, поштові послуги, номер трекінгу і повідомлення клієнту.
- Коректні дані штрихкодів, адресу призначення, посилання на товари й правила вікна повернення.
- Email-доставку, завантаження з порталу й аудиторський слід служби підтримки.
Чеклист для робочого запуску
- Валідуйте дані повернення у перевізника або платформи повернень перед рендерингом.
- Друкуйте й скануйте етикетки на тому самому матеріалі, який використовуватимуть клієнти або магазини.
- Додавайте X-Request-Id і зберігайте зв’язок RMA-to-PDF у журналах підтримки.
- Зробіть повторні завантаження ідемпотентними з погляду клієнта.
- Відокремлюйте рендеринг етикетки від логіки схвалення повернення коштів.
Межі заявлених можливостей
- gPdf рендерить PDF етикеток повернення; він не авторизує повернення й не купує поштові послуги.
- Прийняття перевізником і коректність даних штрихкоду залишаються вашою відповідальністю.
- Публічний API повертає PDF, а не ZPL або прямі команди принтера.
Зворотна логістика потребує чіткої відповідальності
Етикетки повернення поєднують клієнтський досвід і правила перевізника. gPdf відповідає за PDF-рендеринг. Ваша система повернень відповідає за право на повернення, стан RMA, трекінг, дані перевізника й комунікацію з клієнтом.
Тримайте цю межу видимою в інтеграції. Спочатку сформуйте рішення про повернення, а потім рендерте документ із фіналізованих даних.
FAQ
- Чи створює gPdf відправлення для повернення?
- Ні. Ваш перевізник або платформа повернень створює відправлення й дані для етикетки. gPdf рендерить ці дані в PDF.
- Чи можна генерувати етикетки повернення з шаблонів?
- Так. Використовуйте Template Render після затвердження макета етикетки повернення або інструкцій.
- Чи може PDF містити інструкції повернення?
- Так. Той самий запит рендерингу може створити сторінку етикетки, сторінку інструкцій або обидві, залежно від макета.
- Чи замінює gPdf сертифікацію перевізника?
- Ні. Прийняття перевізником, тести сканування й правила даних залишаються вашою відповідальністю.