1
0
Files
PayPal-PHP-Server-SDK/doc/models/order-update-callback-response.md
Patrick Powers 6da8b9b5b8 1.1.0 Release (#44)
* Automated commit message

* add changelog

---------

Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
Co-authored-by: Patrick Powers <patickpowers@hey.com>
2025-05-27 13:31:17 -05:00

2.1 KiB

Order Update Callback Response

Returns the updated shipping options for an order.

Structure

OrderUpdateCallbackResponse

Fields

Name Type Tags Description Getter Setter
id ?string Optional The ID of the order.

Constraints: Minimum Length: 1, Maximum Length: 36, Pattern: ^[A-Z0-9-]+$
getId(): ?string setId(?string id): void
purchaseUnits ?ShippingOptionsPurchaseUnit Optional This would contain shipping option and amount data at purchase unit level. getPurchaseUnits(): ?ShippingOptionsPurchaseUnit setPurchaseUnits(?ShippingOptionsPurchaseUnit purchaseUnits): void

Example (as JSON)

{
  "id": "id2",
  "purchase_units": {
    "reference_id": "reference_id4",
    "amount": {
      "currency_code": "currency_code6",
      "value": "value0",
      "breakdown": {
        "item_total": {
          "currency_code": "currency_code0",
          "value": "value6"
        },
        "shipping": {
          "currency_code": "currency_code0",
          "value": "value6"
        },
        "handling": {
          "currency_code": "currency_code2",
          "value": "value8"
        },
        "tax_total": {
          "currency_code": "currency_code4",
          "value": "value0"
        },
        "insurance": {
          "currency_code": "currency_code2",
          "value": "value8"
        }
      }
    },
    "items": [
      {
        "name": "name8",
        "unit_amount": {
          "currency_code": "currency_code2",
          "value": "value8"
        },
        "tax": {
          "currency_code": "currency_code0",
          "value": "value6"
        },
        "quantity": "quantity4",
        "description": "description2",
        "sku": "sku6",
        "url": "url2",
        "category": "DONATION"
      }
    ],
    "shipping_options": [
      {
        "id": "id8",
        "label": "label8",
        "type": "PICKUP_IN_STORE",
        "amount": {
          "currency_code": "currency_code6",
          "value": "value0"
        },
        "selected": false
      }
    ]
  }
}