Penerapan siklus proses pesanan

Panduan ini memberikan referensi API teknis dan skema payload untuk mengirimkan update status pesanan lengkap, peristiwa pemenuhan, dan penyesuaian ke Google menggunakan webhook untuk versi 2026-04-08 Universal Commerce Protocol (UCP).

Sebelum membuat endpoint, pastikan Anda telah meninjau Ringkasan siklus proses pesanan untuk memahami konsep tingkat tinggi, peristiwa wajib, dan detail endpoint webhook.

Penandatanganan permintaan dan autentikasi

Perubahan utama dalam versi 2026-04-08 mencakup pengenalan header webhook wajib baru dan prosedur penandatanganan permintaan tertentu.

Header webhook yang diperlukan

Header HTTP berikut bersifat wajib untuk semua permintaan webhook:

• Webhook-Id: ID unik untuk peristiwa webhook tertentu ini. ID ini harus cocok dengan id dari peristiwa utama yang dikirim (misalnya, ID peristiwa pemenuhan atau ID peristiwa penyesuaian).
• Webhook-Timestamp: Stempel waktu yang menunjukkan kapan peristiwa terjadi.

Header ini menggantikan kolom id dan created_time yang sebelumnya diharapkan dalam payload pesanan.

Catatan: Google menggunakan header ini untuk mengevaluasi keaktualan pesanan. Pembaruan pesanan akan ditolak jika stempel waktu ini lebih lama daripada pembaruan terakhir yang tercatat.

Permintaan penandatanganan

1. Hitung ringkasan SHA-256 dari isi permintaan mentah dan tetapkan header Content-Digest.
2. Pilih kunci penandatanganan dari signing_keys di profil UCP Anda.
3. Buat basis tanda tangan per RFC 9421.
   • Lihat spesifikasi untuk komponen yang ditandatangani
4. Tetapkan header UCP-Agent, Signature-Input, dan Signature.
   • UCP-Agent adalah link ke profil UCP Anda dalam format profile="https://merchant.example.com/.well-known/ucp".
   • Signature-Input adalah kolom terstruktur kamus yang menjelaskan komponen yang ada dalam tanda tangan, serta keyid yang digunakan untuk menandatangani, yang harus cocok dengan kid dari kunci penandatanganan yang Anda pilih dari signing_keys di profil UCP Anda.
   • Header Signature berisi dasar tanda tangan Anda yang ditandatangani menggunakan kunci pribadi Anda, lalu dienkode base64.

Lihat petunjuk penandatanganan di ucp.dev untuk mengetahui informasi selengkapnya.

Peristiwa pesanan dibuat

• Pemicu: Segera setelah pesanan dikonfirmasi (status: processing).

Perubahan penting dalam versi ini:

• Kolom currency kini diperlukan di tingkat teratas objek Pesanan.
• Kolom type dalam setiap objek di array totals kini berupa string terbuka (misalnya, "subtotal", "pajak", "biaya", "total").
• Header Webhook-Id wajib berisi ID unik untuk peristiwa webhook. Perhatikan bahwa kolom id dalam payload yang berisi ID konfirmasi pesanan masih diperlukan.
• Header Webhook-Timestamp wajib memberikan waktu pembuatan, menggantikan kolom created_time sebelumnya dalam payload.

Contoh: Contoh ini menunjukkan pesanan yang dibuat setelah pembeli menyelesaikan checkout.

Header yang Wajib Ada:

• Webhook-Id: order_01
• Webhook-Timestamp: 2026-03-23T19:00:00Z

{
  "ucp": {
    "version": "2026-04-08",
    "capabilities": {
      "dev.ucp.shopping.order": [{"version": "2026-04-08"}]
    }
  },
  "id": "order_01",
  "checkout_id": "checkout_01",
  "currency": "USD",
   // Always include all line items, even for single-item checkouts. This ensures any add-ons, gifts, or separate charges are accounted for.
  "line_items": [
    {
      "id": "line_1",
      "item":
        {
          "id": "product_123",
          "title": "Running Shoes",
          "price": 10000
        },
      "quantity": { "total": 1, "fulfilled": 0 },
      "totals": [
        {"type": "subtotal", "display_text": null, "amount": 10000},
        {"type": "total", "display_text": null, "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", "display_text": "Subtotal", "amount": 10000}, // Tax-inclusive markets: Set display_text to "Subtotal (including taxes)". Amount must include tax.
    {"type": "fee", "display_text": "Service Fee", "amount": 100},
    {"type": "tax", "display_text": "Tax", "amount": 800}, // Tax-inclusive markets: Omit this entry.
    {"type": "total", "display_text": "Total", "amount": 10900}
  ],
  "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",  // Maximum length: 200 characters.
        "fulfillable_on": "now"
      }
    ]
  },
  "permalink_url": "https://merchant.example.com/orders/789"
}

Peristiwa pemenuhan

Peristiwa ini dikirim sebagai bagian dari array fulfillment.events.

Catatan: Saat peristiwa fulfillment terjadi, objek expectations harus tetap konsisten dengan setiap pembaruan. Misalnya, jika peristiwa menunjukkan bahwa pesanan terdiri dari dua paket, expectations juga harus mencerminkan hal ini. Ekspektasi tidak perlu diperbarui untuk penyesuaian (misalnya, pembatalan).

Pesanan dikirim

Saat item dalam pesanan telah dikirim. Kolom tracking_number dan tracking_url wajib diisi untuk peristiwa pengiriman, karena diperlukan untuk mengelompokkan item di halaman "Pesanan saya" secara akurat.

Pesanan diantarkan

Saat item dalam pesanan telah dikirim.

Contoh (shipped dan delivered): Contoh ini menunjukkan pembaruan pesanan setelah item dikirim dan kemudian diantarkan.

Header yang Wajib Ada:

• Webhook-Id: fulfill_evt_2
• Webhook-Timestamp: 2026-02-10T14:00:00Z

{
  "ucp": {
    "version": "2026-04-08",
    "capabilities": {
      "dev.ucp.shopping.order": [{"version": "2026-04-08"}]
    }
  },
  "id": "order_01",
  "checkout_id": "checkout_01",
  "currency": "USD",
  "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"
}

Contoh pesanan multi-item

Contoh berikut menunjukkan cara menyusun pembaruan untuk pesanan multi-item dan pengiriman terpisah. Untuk mengetahui aturan tentang cara status paket diperoleh, lihat Cara status paket ditentukan.

Pesanan multi-item, pengiriman paket yang sama

Contoh ini menunjukkan pembaruan pesanan untuk satu paket yang berisi beberapa item. Semua item baris dikelompokkan dalam satu peristiwa shipped yang memiliki nomor pelacakan yang sama.

Header yang Wajib Ada:

• Webhook-Id: fulfill_evt_1
• Webhook-Timestamp: 2026-02-08T10:30:00Z

{
  "ucp": {
    "version": "2026-04-08",
    "capabilities": {
      "dev.ucp.shopping.order": [{"version": "2026-04-08"}]
    }
  },
  "id": "order_multi_01",
  "checkout_id": "checkout_multi_01",
  "currency": "USD",
  "line_items": [
    {
      "id": "line_1",
      "item": { "id": "product_1", "title": "Item 1", "price": 5000 },
      "quantity": { "total": 1, "fulfilled": 1 },
      "totals": [
        {"type": "subtotal", "display_text": null, "amount": 5000},
        {"type": "total", "display_text": null, "amount": 5000}
      ],
      "status": "fulfilled"
    },
    {
      "id": "line_2",
      "item": { "id": "product_2", "title": "Item 2", "price": 5000 },
      "quantity": { "total": 1, "fulfilled": 1 },
      "totals": [
        {"type": "subtotal", "display_text": null, "amount": 5000},
        {"type": "total", "display_text": null, "amount": 5000}
      ],
      "status": "fulfilled"
    }
  ],
  "totals": [
    {"type": "subtotal", "display_text": "Subtotal", "amount": 10000},
    {"type": "fee", "display_text": "Shipping", "amount": 500},
    {"type": "total", "display_text": "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"
}

Pesanan multi-item, pengiriman terpisah

Contoh ini menunjukkan pembaruan pesanan untuk pengiriman terpisah. Ada beberapa peristiwa shipped, yang masing-masing mereferensikan line_items tertentu dalam paket masing-masing, dengan nomor pelacakan yang berbeda. Karena setiap paket mewakili komitmen pemenuhan yang berbeda (misalnya, kecepatan dan biaya yang berbeda dari checkout multi-grup), expectations juga dibagi.

Header yang Wajib Ada:

• Webhook-Id: fulfill_evt_2
• Webhook-Timestamp: 2026-02-09T14:00:00Z

{
  "ucp": {
    "version": "2026-04-08",
    "capabilities": {
      "dev.ucp.shopping.order": [{"version": "2026-04-08"}]
    }
  },
  "id": "order_multi_02",
  "checkout_id": "checkout_multi_02",
  "currency": "USD",
  "line_items": [
    {
      "id": "line_1",
      "item": { "id": "product_1", "title": "Item 1", "price": 5000 },
      "quantity": { "total": 1, "fulfilled": 1 },
      "totals": [
        {"type": "subtotal", "display_text": null, "amount": 5000},
        {"type": "total", "display_text": null, "amount": 5000}
      ],
      "status": "fulfilled"
    },
    {
      "id": "line_2",
      "item": { "id": "product_2", "title": "Item 2", "price": 5000 },
      "quantity": { "total": 1, "fulfilled": 1 },
      "totals": [
        {"type": "subtotal", "display_text": null, "amount": 5000},
        {"type": "total", "display_text": null, "amount": 5000}
      ],
      "status": "fulfilled"
    }
  ],
  "totals": [
    {"type": "subtotal", "display_text": "Subtotal", "amount": 10000},
    {"type": "fee", "display_text": "Shipping", "amount": 1500},
    {"type": "total", "display_text": "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"
}

Contoh peristiwa penyesuaian

Contoh berikut menunjukkan cara menyusun pembaruan untuk pengembalian dana, pengembalian barang, dan pembatalan. Untuk mengetahui daftar peristiwa yang didukung dan definisinya, lihat Peristiwa penyesuaian dalam Ringkasan siklus proses pesanan.

Pembatalan pesanan dan pengembalian dana

Contoh ini menunjukkan pesanan yang dibatalkan dan dananya dikembalikan segera setelah pesanan dilakukan.

Perubahan utama dalam versi ini dalam contoh ini:

• Item baris yang terpengaruh oleh cancellation kini menggunakan "status": "removed" dalam array line_items utama.
• Jika line_items.status adalah removed:
  • line_items.quantity.total disetel ke 0.
  • Jumlah asli disimpan di kolom line_items.quantity.original baru.

Header yang Wajib Ada:

• Webhook-Id: adj_refund_1
• Webhook-Timestamp: 2026-02-09T11:05:00Z

{
  "ucp": {
    "version": "2026-04-08",
    "capabilities": {
      "dev.ucp.shopping.order": [{"version": "2026-04-08"}]
    }
  },
  "id": "order_02",
  "checkout_id": "checkout_02",
  "currency": "USD",
  "line_items": [
    {
      "id": "line_2",
      "item": {
        "id": "product_456",
        "title": "Smart Watch",
        "price": 29900
      },
      "quantity": {
        "total": 0,  // Item removed from order total.
        "original": 1,  // Original quantity before removal.
        "fulfilled": 0 //  Item was not fulfilled before cancellation.
      },
      "totals": [
        {"type": "subtotal", "amount": 29900},
        {"type": "tax", "amount": 2400},
        {"type": "total", "amount": 32300}
      ],
      "status": "removed" // Item is cancelled, returned, or refunded.
    }
  ],
  "totals": [
    {"type": "subtotal", "amount": 29900},
    {"type": "tax", "amount": 2400},
    {"type": "total", "amount": 32300}
  ],
    // Fulfillment expectations should still be present even if cancelled early.
  "fulfillment": {
    "expectations": [
      {
        "id": "exp_1",
        "line_items": [{ "id": "line_2", "quantity": 1 }],
        "method_type": "shipping",
        "destination": {
          "first_name": "Bob",
          "last_name": "Consumer",
          "street_address": "456 Oak Ave",
          "address_locality": "Anytown",
          "address_region": "CA",
          "address_country": "US",
          "postal_code": "90210"
        },
        "description": "Standard Shipping",
        "fulfillable_on": "now"
      }
    ]
    // "events": [] // No fulfillment events occurred before cancellation.
    },
  "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 }],
      "totals": [
        {"type": "subtotal", "display_text": "Subtotal", "amount": -29900}, // Negative amounts indicate money returned to the buyer. Tax-inclusive markets: Set display_text to "Subtotal (including taxes)". Amount must include tax.
        {"type": "tax", "amount": -2400}, // Tax-inclusive markets: Omit this entry.
        {"type": "total", "display_text": "Total", "amount": -32300}
      ],
      "occurred_at": "2026-02-09T11:05:00Z",
      "status": "completed"
    }
  ],
  "permalink_url": "https://merchant.example.com/orders/12345"
}

Pengembalian barang dan pengembalian dana pesanan

Contoh ini menunjukkan pesanan saat item dikirim, diantarkan, lalu dikembalikan dan dananya dikembalikan.

Perubahan utama dalam versi ini dalam contoh ini:

• Item baris yang terpengaruh oleh return kini menggunakan "status": "removed" dalam array line_items utama.
• Jika line_items.status adalah removed:
  • line_items.quantity.total disetel ke 0.
  • Jumlah asli disimpan di kolom line_items.quantity.original baru.
• Dalam adjustments jenis return, kolom line_items.quantity dalam penyesuaian menggunakan nilai negatif (misalnya, -1) untuk menunjukkan item yang diambil kembali.

Header yang Wajib Ada:

• Webhook-Id: adj_refund_2
• Webhook-Timestamp: 2026-02-10T10:00:00Z

{
  "ucp": {
    "version": "2026-04-08",
    "capabilities": {
      "dev.ucp.shopping.order": [{"version": "2026-04-08"}]
    }
  },
  "id": "order_03",
  "checkout_id": "checkout_03",
  "currency": "USD",
  "line_items": [
    {
      "id": "line_3",
      "item": {
        "id": "product_789",
        "title": "Wireless Earbuds",
        "price": 14900
      },
      "quantity": {
        "total": 0,  // Item removed from order total.
        "original": 1,  // Original quantity before removal.
        "fulfilled": 1 // Was fulfilled before return.
      },
      "totals": [
        {"type": "subtotal", "amount": 14900},
        {"type": "tax", "amount": 1200},
        {"type": "total", "amount": 16100}
      ],
      "status": "removed" // Item is cancelled, returned, or refunded.
    }
  ],
  "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", // a matching fulfillment event is also added to represent return shipping.
      "description": "Item not compatible",
      "line_items": [{ "id": "line_3", "quantity": -1 }],  // Uses a negative value (such as -1) to indicate a return.
      "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 }],
      "totals": [
        {"type": "subtotal", "amount": -14900}, // Negative amounts indicate money returned to the buyer.
        {"type": "tax", "amount": -1200},
        {"type": "total", "amount": -16100}
      ],
      "occurred_at": "2026-02-10T10:00:00Z",
      "status": "completed"
    }
  ],
  "permalink_url": "https://merchant.example.com/orders/67890"
}