این راهنما، مرجع فنی API و طرحوارههای بار مفید برای ارسال بهروزرسانیهای کامل وضعیت سفارش، رویدادهای تکمیل سفارش و تنظیمات در گوگل با استفاده از وبهوکها برای نسخه 2026-01-23 پروتکل تجارت جهانی (UCP) را ارائه میدهد.
قبل از ساخت نقاط پایانی خود، مطمئن شوید که نمای کلی چرخه حیات سفارش را برای مفاهیم سطح بالا، رویدادهای اجباری و جزئیات نقطه پایانی وبهوک مرور کردهاید.
تأیید و امضای درخواست
شما میتوانید با استفاده از کلید HMAC که توسط گوگل با شما به اشتراک گذاشته شده است، امضای کلید متقارن را انجام دهید.
یا میتوانید برای امضای نامتقارن به دستورالعملهای زیر مراجعه کنید:
- یک کلید از آرایه
signing_keysدر پروفایل UCP انتخاب کنید. - با استفاده از کلید انتخاب شده، یک JWT جدا ( RFC 7797 ) روی بدنه درخواست ایجاد کنید.
- JWT را در هدر
Request-Signatureقرار دهید. - شناسه کلید را در
kidبه هدر JWT قرار دهید تا گیرنده بتواند تشخیص دهد از کدام کلید برای تأیید استفاده کند.
اعتبارسنجی مهر زمانی
هنگام ارزیابی اینکه آیا بهروزرسانی سفارش قدیمیتر از آخرین بهروزرسانی ثبتشده است یا خیر (که باعث رد بهروزرسانی سفارش میشود)، گوگل با استفاده از ویژگی created_time در payload، مهر زمانی را ارزیابی میکند.
رویداد ایجاد شده را سفارش دهید
- فعالسازی: بلافاصله پس از تأیید سفارش (
status: processing).
مثال: این مثال سفارشی را نشان میدهد که پس از تکمیل فرآیند پرداخت توسط خریدار ایجاد شده است.
{
"ucp": {
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.order": [{"version": "2026-01-23"}]
}
},
"id": "order_01",
"checkout_id": "checkout_01",
"created_time": "2026-03-23T19:00:00Z",
// Full line items must be included
"line_items": [
{
"id": "line_1",
"item":
{
"id": "product_123",
"title": "Running Shoes",
"price": 10000
},
"quantity": { "total": 1, "fulfilled": 0 },
"totals": [
{"type": "subtotal", "amount": 10000},
{"type": "total", "amount": 10000}
],
// The status of a line item must match total and fulfilled quantities (e.g., total 1, fulfilled 0 -> status: processing).
"status": "processing"
}
],
"totals": [
{"type": "subtotal", "amount": 10000},
{"type": "total", "amount": 10000}
],
"fulfillment": {
"expectations": [
{
"id": "exp_1",
"line_items": [{ "id": "line_1", "quantity": 1 }],
"method_type": "shipping",
"destination": {
"first_name": "Alice",
"last_name": "Example",
"street_address": "123 Main St",
"address_locality": "Austin",
"address_region": "TX",
"address_country": "US",
"postal_code": "78701"
},
"description": "Arrives in 2-3 business days",
"fulfillable_on": "now"
}
]
},
"permalink_url": "https://merchant.example.com/orders/789"
}
رویدادهای تکمیل سفارش
این رویدادها به عنوان بخشی از آرایه fulfillment.events ارسال میشوند.
سفارش ارسال شد
وقتی اقلام سفارش ارسال شدهاند، فیلدهای tracking_number و tracking_url برای رویدادهای ارسالشده الزامی هستند، زیرا برای گروهبندی دقیق اقلام در صفحه «سفارشهای من» مورد نیاز هستند.
سفارش تحویل داده شد
وقتی اقلام موجود در سفارش تحویل داده شدند.
مثال ( shipped و delivered ): این مثال، بهروزرسانی سفارش را پس از ارسال و تحویل کالا نشان میدهد.
{
"ucp": {
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.order": [{"version": "2026-01-23"}]
}
},
"id": "order_01",
"checkout_id": "checkout_01",
"created_time": "2026-03-23T19:00:00Z",
"line_items": [
{
"id": "line_1",
"item":
{
"id": "product_123",
"title": "Running Shoes",
"price": 10000
},
"quantity": { "total": 1, "fulfilled": 1 },
"totals": [
{"type": "subtotal", "amount": 10000},
{"type": "total", "amount": 10000}
],
"status": "fulfilled"
}
],
"totals": [
{"type": "subtotal", "amount": 10000},
{"type": "total", "amount": 10000}
],
// Updated fulfillment details.
"fulfillment": {
"events": [
{
"id": "fulfill_evt_1",
"occurred_at": "2026-02-08T10:30:00Z",
"type": "shipped",
"line_items": [{ "id": "line_1", "quantity": 1 }],
"tracking_number": "123456789",
"tracking_url": "https://fedex.com/track/123456789",
"carrier": "FedEx",
"description": "Shipping departed from warehouse"
},
{
"id": "fulfill_evt_2",
"occurred_at": "2026-02-10T14:00:00Z",
"type": "delivered",
"line_items": [{ "id": "line_1", "quantity": 1 }],
"tracking_number": "123456789",
"tracking_url": "https://fedex.com/track/123456789",
"carrier": "FedEx",
"description": "Package delivered"
}
],
"expectations": [{ "...": "..." }]
},
"permalink_url": "https://merchant.example.com/orders/123"
}
نمونههای سفارش چند قلم کالا
مثالهای زیر نحوهی ساختاردهی بهروزرسانیها برای سفارشهای چند قلمی و محمولههای تقسیمشده را نشان میدهند. برای قوانین مربوط به نحوهی استخراج وضعیت بستهها، به «نحوهی تعیین وضعیت بسته» مراجعه کنید.
سفارش چند قلم کالا، تحویل در یک بسته
این مثال بهروزرسانی سفارش را برای یک بسته حاوی چندین کالا نشان میدهد. همه اقلام در یک رویداد shipped واحد با شماره پیگیری یکسان گروهبندی شدهاند.
{
"ucp": {
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.order": [{"version": "2026-01-23"}]
}
},
"id": "order_multi_01",
"checkout_id": "checkout_multi_01",
"created_time": "2026-02-07T09:00:00Z",
"line_items": [
{
"id": "line_1",
"item": { "id": "product_1", "title": "Item 1", "price": 5000 },
"quantity": { "total": 1, "fulfilled": 1 },
"totals": [
{"type": "subtotal", "amount": 5000},
{"type": "total", "amount": 5000}
],
"status": "fulfilled"
},
{
"id": "line_2",
"item": { "id": "product_2", "title": "Item 2", "price": 5000 },
"quantity": { "total": 1, "fulfilled": 1 },
"totals": [
{"type": "subtotal", "amount": 5000},
{"type": "total", "amount": 5000}
],
"status": "fulfilled"
}
],
"totals": [
{"type": "subtotal", "amount": 10000},
{"type": "fee", "amount": 500},
{"type": "total", "amount": 10500}
],
"fulfillment": {
"expectations": [
{
"id": "exp_1",
"line_items": [
{ "id": "line_1", "quantity": 1 },
{ "id": "line_2", "quantity": 1 }
],
"method_type": "shipping",
"destination": {
"first_name": "Alice",
"last_name": "Example",
"street_address": "123 Main St",
"address_locality": "Austin",
"address_region": "TX",
"address_country": "US",
"postal_code": "78701"
},
"description": "Standard Shipping",
"fulfillable_on": "now"
}
],
"events": [
{
"id": "fulfill_evt_1",
"occurred_at": "2026-02-08T10:30:00Z",
"type": "shipped",
"line_items": [
{ "id": "line_1", "quantity": 1 },
{ "id": "line_2", "quantity": 1 }
],
"tracking_number": "123456789",
"tracking_url": "https://fedex.com/track/123456789",
"carrier": "FedEx",
"description": "Both items shipped together"
}
]
},
"permalink_url": "https://merchant.example.com/orders/456"
}
سفارش چند قلم کالا، ارسال جداگانه
این مثال بهروزرسانی سفارش برای محمولههای تقسیمشده را نشان میدهد. چندین رویداد shipped وجود دارد که هر کدام به line_items خاص درون آن بسته مربوطه اشاره میکنند و شمارههای پیگیری متمایزی دارند. از آنجایی که هر بسته نشاندهنده یک تعهد تحقق متمایز است (مثلاً سرعتها و هزینههای متفاوت از یک پرداخت چندگروهی)، expectations نیز تقسیم میشوند.
{
"ucp": {
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.order": [{"version": "2026-01-23"}]
}
},
"id": "order_multi_02",
"checkout_id": "checkout_multi_02",
"created_time": "2026-02-07T09:00:00Z",
"line_items": [
{
"id": "line_1",
"item": { "id": "product_1", "title": "Item 1", "price": 5000 },
"quantity": { "total": 1, "fulfilled": 1 },
"totals": [
{"type": "subtotal", "amount": 5000},
{"type": "total", "amount": 5000}
],
"status": "fulfilled"
},
{
"id": "line_2",
"item": { "id": "product_2", "title": "Item 2", "price": 5000 },
"quantity": { "total": 1, "fulfilled": 1 },
"totals": [
{"type": "subtotal", "amount": 5000},
{"type": "total", "amount": 5000}
],
"status": "fulfilled"
}
],
"totals": [
{"type": "subtotal", "amount": 10000},
{"type": "fee", "amount": 1500},
{"type": "total", "amount": 11500}
],
"fulfillment": {
"expectations": [
{
"id": "exp_1",
"line_items": [{ "id": "line_1", "quantity": 1 }],
"method_type": "shipping",
"destination": {
"first_name": "Alice",
"last_name": "Example",
"street_address": "123 Main St",
"address_locality": "Austin",
"address_region": "TX",
"address_country": "US",
"postal_code": "78701"
},
"description": "Standard Shipping",
"fulfillable_on": "now"
},
{
"id": "exp_2",
"line_items": [{ "id": "line_2", "quantity": 1 }],
"method_type": "shipping",
"destination": {
"first_name": "Alice",
"last_name": "Example",
"street_address": "123 Main St",
"address_locality": "Austin",
"address_region": "TX",
"address_country": "US",
"postal_code": "78701"
},
"description": "Express Shipping",
"fulfillable_on": "now"
}
],
"events": [
{
"id": "fulfill_evt_1",
"occurred_at": "2026-02-08T10:30:00Z",
"type": "shipped",
"line_items": [{ "id": "line_1", "quantity": 1 }],
"tracking_number": "PKG1_TRACKING",
"tracking_url": "https://fedex.com/track/PKG1_TRACKING",
"carrier": "FedEx",
"description": "First item shipped in package 1"
},
{
"id": "fulfill_evt_2",
"occurred_at": "2026-02-09T14:00:00Z",
"type": "shipped",
"line_items": [{ "id": "line_2", "quantity": 1 }],
"tracking_number": "PKG2_TRACKING",
"tracking_url": "https://fedex.com/track/PKG2_TRACKING",
"carrier": "FedEx",
"description": "Second item shipped in package 2"
}
]
},
"permalink_url": "https://merchant.example.com/orders/457"
}
نمونههایی از رویدادهای تعدیل
مثالهای زیر نحوهی ساختاردهی بهروزرسانیها برای بازپرداختها، مرجوعیها و لغوها را نشان میدهند. برای مشاهدهی فهرستی از رویدادهای پشتیبانیشده و تعاریف آنها، به رویدادهای اصلاحی در نمای کلی چرخهی عمر سفارش مراجعه کنید.
لغو سفارش و بازگشت وجه
این مثال سفارشی را نشان میدهد که در آن کالا لغو و اندکی پس از ثبت سفارش، وجه آن مسترد شده است.
{
"ucp": {
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.order": [{"version": "2026-01-23"}]
}
},
"id": "order_02",
"checkout_id": "checkout_02",
"created_time": "2026-03-23T19:00:00Z",
"line_items": [
{
"id": "line_2",
"item": {
"id": "product_456",
"title": "Smart Watch",
"price": 29900
},
"quantity": { "total": 1, "fulfilled": 0 },
"totals": [
{"type": "subtotal", "amount": 29900},
{"type": "tax", "amount": 2400},
{"type": "total", "amount": 32300}
],
"status": "processing"
}
],
"totals": [
{"type": "subtotal", "amount": 29900},
{"type": "tax", "amount": 2400},
{"type": "total", "amount": 32300}
],
"adjustments": [
{
"id": "adj_cancel_1",
"type": "cancellation",
"description": "Customer changed mind",
"line_items": [{ "id": "line_2", "quantity": 1 }],
"occurred_at": "2026-02-09T11:00:00Z",
"status": "completed"
},
{
"id": "adj_refund_1",
"type": "refund",
"description": "Refund for cancelled item",
"line_items": [{ "id": "line_2", "quantity": 1 }],
"amount": 32300,
"occurred_at": "2026-02-09T11:05:00Z",
"status": "completed"
}
],
"permalink_url": "https://merchant.example.com/orders/12345"
}
بازگشت سفارش و بازپرداخت وجه
این مثال سفارشی را نشان میدهد که در آن کالا ارسال، تحویل و سپس برگشت داده شده و وجه آن مسترد شده است.
{
"ucp": {
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.order": [{"version": "2026-01-23"}]
}
},
"id": "order_03",
"checkout_id": "checkout_03",
"created_time": "2026-03-23T19:00:00Z",
"line_items": [
{
"id": "line_3",
"item": {
"id": "product_789",
"title": "Wireless Earbuds",
"price": 14900
},
"quantity": { "total": 1, "fulfilled": 1 },
"totals": [
{"type": "subtotal", "amount": 14900},
{"type": "tax", "amount": 1200},
{"type": "total", "amount": 16100}
],
"status": "fulfilled"
}
],
"totals": [
{"type": "subtotal", "amount": 14900},
{"type": "tax", "amount": 1200},
{"type": "total", "amount": 16100}
],
"fulfillment": {
"events": [
{
"id": "fulfill_evt_1",
"occurred_at": "2026-02-05T09:00:00Z",
"type": "shipped",
"line_items": [{ "id": "line_3", "quantity": 1 }],
"tracking_number": "987654321",
"tracking_url": "https://fedex.com/track/987654321",
"carrier": "FedEx",
"description": "Item shipped"
},
{
"id": "fulfill_evt_2",
"occurred_at": "2026-02-07T16:00:00Z",
"type": "delivered",
"line_items": [{ "id": "line_3", "quantity": 1 }],
"tracking_number": "987654321",
"tracking_url": "https://fedex.com/track/987654321",
"carrier": "FedEx",
"description": "Item delivered"
},
{
"id": "fulfill_evt_3",
"occurred_at": "2026-02-09T09:00:00Z",
"type": "returned",
"line_items": [{ "id": "line_3", "quantity": 1 }],
"tracking_number": "987654321",
"tracking_url": "https://fedex.com/track/987654321",
"carrier": "FedEx",
"description": "Item returned"
}
],
"expectations": [{ "...": "..." }]
},
"adjustments": [
{
"id": "adj_return_1",
"type": "return",
"description": "Item not compatible",
"line_items": [{ "id": "line_3", "quantity": 1 }],
"occurred_at": "2026-02-09T09:00:00Z",
"status": "completed"
},
{
"id": "adj_refund_2",
"type": "refund",
"description": "Refund for returned item",
"line_items": [{ "id": "line_3", "quantity": 1 }],
"amount": 16100,
"occurred_at": "2026-02-10T10:00:00Z",
"status": "completed"
}
],
"permalink_url": "https://merchant.example.com/orders/67890"
}
این راهنما، مرجع فنی API و طرحوارههای بار مفید برای ارسال بهروزرسانیهای کامل وضعیت سفارش، رویدادهای تکمیل سفارش و تنظیمات در گوگل با استفاده از وبهوکها برای نسخه 2026-01-23 پروتکل تجارت جهانی (UCP) را ارائه میدهد.
قبل از ساخت نقاط پایانی خود، مطمئن شوید که نمای کلی چرخه حیات سفارش را برای مفاهیم سطح بالا، رویدادهای اجباری و جزئیات نقطه پایانی وبهوک مرور کردهاید.
تأیید و امضای درخواست
شما میتوانید با استفاده از کلید HMAC که توسط گوگل با شما به اشتراک گذاشته شده است، امضای کلید متقارن را انجام دهید.
یا میتوانید برای امضای نامتقارن به دستورالعملهای زیر مراجعه کنید:
- یک کلید از آرایه
signing_keysدر پروفایل UCP انتخاب کنید. - با استفاده از کلید انتخاب شده، یک JWT جدا ( RFC 7797 ) روی بدنه درخواست ایجاد کنید.
- JWT را در هدر
Request-Signatureقرار دهید. - شناسه کلید را در
kidبه هدر JWT قرار دهید تا گیرنده بتواند تشخیص دهد از کدام کلید برای تأیید استفاده کند.
اعتبارسنجی مهر زمانی
هنگام ارزیابی اینکه آیا بهروزرسانی سفارش قدیمیتر از آخرین بهروزرسانی ثبتشده است یا خیر (که باعث رد بهروزرسانی سفارش میشود)، گوگل با استفاده از ویژگی created_time در payload، مهر زمانی را ارزیابی میکند.
رویداد ایجاد شده را سفارش دهید
- فعالسازی: بلافاصله پس از تأیید سفارش (
status: processing).
مثال: این مثال سفارشی را نشان میدهد که پس از تکمیل فرآیند پرداخت توسط خریدار ایجاد شده است.
{
"ucp": {
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.order": [{"version": "2026-01-23"}]
}
},
"id": "order_01",
"checkout_id": "checkout_01",
"created_time": "2026-03-23T19:00:00Z",
// Full line items must be included
"line_items": [
{
"id": "line_1",
"item":
{
"id": "product_123",
"title": "Running Shoes",
"price": 10000
},
"quantity": { "total": 1, "fulfilled": 0 },
"totals": [
{"type": "subtotal", "amount": 10000},
{"type": "total", "amount": 10000}
],
// The status of a line item must match total and fulfilled quantities (e.g., total 1, fulfilled 0 -> status: processing).
"status": "processing"
}
],
"totals": [
{"type": "subtotal", "amount": 10000},
{"type": "total", "amount": 10000}
],
"fulfillment": {
"expectations": [
{
"id": "exp_1",
"line_items": [{ "id": "line_1", "quantity": 1 }],
"method_type": "shipping",
"destination": {
"first_name": "Alice",
"last_name": "Example",
"street_address": "123 Main St",
"address_locality": "Austin",
"address_region": "TX",
"address_country": "US",
"postal_code": "78701"
},
"description": "Arrives in 2-3 business days",
"fulfillable_on": "now"
}
]
},
"permalink_url": "https://merchant.example.com/orders/789"
}
رویدادهای تکمیل سفارش
این رویدادها به عنوان بخشی از آرایه fulfillment.events ارسال میشوند.
سفارش ارسال شد
وقتی اقلام سفارش ارسال شدهاند، فیلدهای tracking_number و tracking_url برای رویدادهای ارسالشده الزامی هستند، زیرا برای گروهبندی دقیق اقلام در صفحه «سفارشهای من» مورد نیاز هستند.
سفارش تحویل داده شد
وقتی اقلام موجود در سفارش تحویل داده شدند.
مثال ( shipped و delivered ): این مثال، بهروزرسانی سفارش را پس از ارسال و تحویل کالا نشان میدهد.
{
"ucp": {
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.order": [{"version": "2026-01-23"}]
}
},
"id": "order_01",
"checkout_id": "checkout_01",
"created_time": "2026-03-23T19:00:00Z",
"line_items": [
{
"id": "line_1",
"item":
{
"id": "product_123",
"title": "Running Shoes",
"price": 10000
},
"quantity": { "total": 1, "fulfilled": 1 },
"totals": [
{"type": "subtotal", "amount": 10000},
{"type": "total", "amount": 10000}
],
"status": "fulfilled"
}
],
"totals": [
{"type": "subtotal", "amount": 10000},
{"type": "total", "amount": 10000}
],
// Updated fulfillment details.
"fulfillment": {
"events": [
{
"id": "fulfill_evt_1",
"occurred_at": "2026-02-08T10:30:00Z",
"type": "shipped",
"line_items": [{ "id": "line_1", "quantity": 1 }],
"tracking_number": "123456789",
"tracking_url": "https://fedex.com/track/123456789",
"carrier": "FedEx",
"description": "Shipping departed from warehouse"
},
{
"id": "fulfill_evt_2",
"occurred_at": "2026-02-10T14:00:00Z",
"type": "delivered",
"line_items": [{ "id": "line_1", "quantity": 1 }],
"tracking_number": "123456789",
"tracking_url": "https://fedex.com/track/123456789",
"carrier": "FedEx",
"description": "Package delivered"
}
],
"expectations": [{ "...": "..." }]
},
"permalink_url": "https://merchant.example.com/orders/123"
}
نمونههای سفارش چند قلم کالا
مثالهای زیر نحوهی ساختاردهی بهروزرسانیها برای سفارشهای چند قلمی و محمولههای تقسیمشده را نشان میدهند. برای قوانین مربوط به نحوهی استخراج وضعیت بستهها، به «نحوهی تعیین وضعیت بسته» مراجعه کنید.
سفارش چند قلم کالا، تحویل در یک بسته
این مثال بهروزرسانی سفارش را برای یک بسته حاوی چندین کالا نشان میدهد. همه اقلام در یک رویداد shipped واحد با شماره پیگیری یکسان گروهبندی شدهاند.
{
"ucp": {
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.order": [{"version": "2026-01-23"}]
}
},
"id": "order_multi_01",
"checkout_id": "checkout_multi_01",
"created_time": "2026-02-07T09:00:00Z",
"line_items": [
{
"id": "line_1",
"item": { "id": "product_1", "title": "Item 1", "price": 5000 },
"quantity": { "total": 1, "fulfilled": 1 },
"totals": [
{"type": "subtotal", "amount": 5000},
{"type": "total", "amount": 5000}
],
"status": "fulfilled"
},
{
"id": "line_2",
"item": { "id": "product_2", "title": "Item 2", "price": 5000 },
"quantity": { "total": 1, "fulfilled": 1 },
"totals": [
{"type": "subtotal", "amount": 5000},
{"type": "total", "amount": 5000}
],
"status": "fulfilled"
}
],
"totals": [
{"type": "subtotal", "amount": 10000},
{"type": "fee", "amount": 500},
{"type": "total", "amount": 10500}
],
"fulfillment": {
"expectations": [
{
"id": "exp_1",
"line_items": [
{ "id": "line_1", "quantity": 1 },
{ "id": "line_2", "quantity": 1 }
],
"method_type": "shipping",
"destination": {
"first_name": "Alice",
"last_name": "Example",
"street_address": "123 Main St",
"address_locality": "Austin",
"address_region": "TX",
"address_country": "US",
"postal_code": "78701"
},
"description": "Standard Shipping",
"fulfillable_on": "now"
}
],
"events": [
{
"id": "fulfill_evt_1",
"occurred_at": "2026-02-08T10:30:00Z",
"type": "shipped",
"line_items": [
{ "id": "line_1", "quantity": 1 },
{ "id": "line_2", "quantity": 1 }
],
"tracking_number": "123456789",
"tracking_url": "https://fedex.com/track/123456789",
"carrier": "FedEx",
"description": "Both items shipped together"
}
]
},
"permalink_url": "https://merchant.example.com/orders/456"
}
سفارش چند قلم کالا، ارسال جداگانه
این مثال بهروزرسانی سفارش برای محمولههای تقسیمشده را نشان میدهد. چندین رویداد shipped وجود دارد که هر کدام به line_items خاص درون آن بسته مربوطه اشاره میکنند و شمارههای پیگیری متمایزی دارند. از آنجایی که هر بسته نشاندهنده یک تعهد تحقق متمایز است (مثلاً سرعتها و هزینههای متفاوت از یک پرداخت چندگروهی)، expectations نیز تقسیم میشوند.
{
"ucp": {
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.order": [{"version": "2026-01-23"}]
}
},
"id": "order_multi_02",
"checkout_id": "checkout_multi_02",
"created_time": "2026-02-07T09:00:00Z",
"line_items": [
{
"id": "line_1",
"item": { "id": "product_1", "title": "Item 1", "price": 5000 },
"quantity": { "total": 1, "fulfilled": 1 },
"totals": [
{"type": "subtotal", "amount": 5000},
{"type": "total", "amount": 5000}
],
"status": "fulfilled"
},
{
"id": "line_2",
"item": { "id": "product_2", "title": "Item 2", "price": 5000 },
"quantity": { "total": 1, "fulfilled": 1 },
"totals": [
{"type": "subtotal", "amount": 5000},
{"type": "total", "amount": 5000}
],
"status": "fulfilled"
}
],
"totals": [
{"type": "subtotal", "amount": 10000},
{"type": "fee", "amount": 1500},
{"type": "total", "amount": 11500}
],
"fulfillment": {
"expectations": [
{
"id": "exp_1",
"line_items": [{ "id": "line_1", "quantity": 1 }],
"method_type": "shipping",
"destination": {
"first_name": "Alice",
"last_name": "Example",
"street_address": "123 Main St",
"address_locality": "Austin",
"address_region": "TX",
"address_country": "US",
"postal_code": "78701"
},
"description": "Standard Shipping",
"fulfillable_on": "now"
},
{
"id": "exp_2",
"line_items": [{ "id": "line_2", "quantity": 1 }],
"method_type": "shipping",
"destination": {
"first_name": "Alice",
"last_name": "Example",
"street_address": "123 Main St",
"address_locality": "Austin",
"address_region": "TX",
"address_country": "US",
"postal_code": "78701"
},
"description": "Express Shipping",
"fulfillable_on": "now"
}
],
"events": [
{
"id": "fulfill_evt_1",
"occurred_at": "2026-02-08T10:30:00Z",
"type": "shipped",
"line_items": [{ "id": "line_1", "quantity": 1 }],
"tracking_number": "PKG1_TRACKING",
"tracking_url": "https://fedex.com/track/PKG1_TRACKING",
"carrier": "FedEx",
"description": "First item shipped in package 1"
},
{
"id": "fulfill_evt_2",
"occurred_at": "2026-02-09T14:00:00Z",
"type": "shipped",
"line_items": [{ "id": "line_2", "quantity": 1 }],
"tracking_number": "PKG2_TRACKING",
"tracking_url": "https://fedex.com/track/PKG2_TRACKING",
"carrier": "FedEx",
"description": "Second item shipped in package 2"
}
]
},
"permalink_url": "https://merchant.example.com/orders/457"
}
نمونههایی از رویدادهای تعدیل
مثالهای زیر نحوهی ساختاردهی بهروزرسانیها برای بازپرداختها، مرجوعیها و لغوها را نشان میدهند. برای مشاهدهی فهرستی از رویدادهای پشتیبانیشده و تعاریف آنها، به رویدادهای اصلاحی در نمای کلی چرخهی عمر سفارش مراجعه کنید.
لغو سفارش و بازگشت وجه
این مثال سفارشی را نشان میدهد که در آن کالا لغو و اندکی پس از ثبت سفارش، وجه آن مسترد شده است.
{
"ucp": {
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.order": [{"version": "2026-01-23"}]
}
},
"id": "order_02",
"checkout_id": "checkout_02",
"created_time": "2026-03-23T19:00:00Z",
"line_items": [
{
"id": "line_2",
"item": {
"id": "product_456",
"title": "Smart Watch",
"price": 29900
},
"quantity": { "total": 1, "fulfilled": 0 },
"totals": [
{"type": "subtotal", "amount": 29900},
{"type": "tax", "amount": 2400},
{"type": "total", "amount": 32300}
],
"status": "processing"
}
],
"totals": [
{"type": "subtotal", "amount": 29900},
{"type": "tax", "amount": 2400},
{"type": "total", "amount": 32300}
],
"adjustments": [
{
"id": "adj_cancel_1",
"type": "cancellation",
"description": "Customer changed mind",
"line_items": [{ "id": "line_2", "quantity": 1 }],
"occurred_at": "2026-02-09T11:00:00Z",
"status": "completed"
},
{
"id": "adj_refund_1",
"type": "refund",
"description": "Refund for cancelled item",
"line_items": [{ "id": "line_2", "quantity": 1 }],
"amount": 32300,
"occurred_at": "2026-02-09T11:05:00Z",
"status": "completed"
}
],
"permalink_url": "https://merchant.example.com/orders/12345"
}
بازگشت سفارش و بازپرداخت وجه
این مثال سفارشی را نشان میدهد که در آن کالا ارسال، تحویل و سپس برگشت داده شده و وجه آن مسترد شده است.
{
"ucp": {
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.order": [{"version": "2026-01-23"}]
}
},
"id": "order_03",
"checkout_id": "checkout_03",
"created_time": "2026-03-23T19:00:00Z",
"line_items": [
{
"id": "line_3",
"item": {
"id": "product_789",
"title": "Wireless Earbuds",
"price": 14900
},
"quantity": { "total": 1, "fulfilled": 1 },
"totals": [
{"type": "subtotal", "amount": 14900},
{"type": "tax", "amount": 1200},
{"type": "total", "amount": 16100}
],
"status": "fulfilled"
}
],
"totals": [
{"type": "subtotal", "amount": 14900},
{"type": "tax", "amount": 1200},
{"type": "total", "amount": 16100}
],
"fulfillment": {
"events": [
{
"id": "fulfill_evt_1",
"occurred_at": "2026-02-05T09:00:00Z",
"type": "shipped",
"line_items": [{ "id": "line_3", "quantity": 1 }],
"tracking_number": "987654321",
"tracking_url": "https://fedex.com/track/987654321",
"carrier": "FedEx",
"description": "Item shipped"
},
{
"id": "fulfill_evt_2",
"occurred_at": "2026-02-07T16:00:00Z",
"type": "delivered",
"line_items": [{ "id": "line_3", "quantity": 1 }],
"tracking_number": "987654321",
"tracking_url": "https://fedex.com/track/987654321",
"carrier": "FedEx",
"description": "Item delivered"
},
{
"id": "fulfill_evt_3",
"occurred_at": "2026-02-09T09:00:00Z",
"type": "returned",
"line_items": [{ "id": "line_3", "quantity": 1 }],
"tracking_number": "987654321",
"tracking_url": "https://fedex.com/track/987654321",
"carrier": "FedEx",
"description": "Item returned"
}
],
"expectations": [{ "...": "..." }]
},
"adjustments": [
{
"id": "adj_return_1",
"type": "return",
"description": "Item not compatible",
"line_items": [{ "id": "line_3", "quantity": 1 }],
"occurred_at": "2026-02-09T09:00:00Z",
"status": "completed"
},
{
"id": "adj_refund_2",
"type": "refund",
"description": "Refund for returned item",
"line_items": [{ "id": "line_3", "quantity": 1 }],
"amount": 16100,
"occurred_at": "2026-02-10T10:00:00Z",
"status": "completed"
}
],
"permalink_url": "https://merchant.example.com/orders/67890"
}