Skip to main content
POST
/
v2
/
checkout
/
orders
/
order-update-callback
curl --request POST \
  --url https://api-m.paypal.com/v2/checkout/orders/order-update-callback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "5O190127TN364715T",
  "shipping_address": {
    "country_code": "US",
    "admin_area_1": "TX",
    "admin_area_2": "Dallas",
    "postal_code": "75001"
  },
  "purchase_units": [
    {
      "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
      "amount": {
        "currency_code": "USD",
        "value": "100.00",
        "breakdown": {
          "item_total": {
            "currency_code": "USD",
            "value": "90.00"
          },
          "tax_total": {
            "currency_code": "USD",
            "value": "10.00"
          },
          "shipping": {
            "currency_code": "USD",
            "value": "0.00"
          }
        }
      },
      "items": [
        {
          "name": "T-Shirt",
          "description": "Green XL",
          "sku": "sku01",
          "unit_amount": {
            "currency_code": "USD",
            "value": "90.00"
          },
          "tax": {
            "currency_code": "USD",
            "value": "10.00"
          },
          "quantity": "1",
          "category": "PHYSICAL_GOODS"
        }
      ]
    }
  ]
}
'
{
  "id": "5O190127TN364715T",
  "purchase_units": {
    "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
    "amount": {
      "currency_code": "USD",
      "value": "90.00",
      "breakdown": {
        "item_total": {
          "currency_code": "USD",
          "value": "90.00"
        },
        "tax_total": {
          "currency_code": "USD",
          "value": "10.00"
        },
        "shipping": {
          "currency_code": "USD",
          "value": "0.00"
        },
        "discount": {
          "currency_code": "USD",
          "value": "10.00",
          "breakdown": [
            {
              "value": "10.00",
              "currency_code": "USD",
              "discount_code": "SUMMER_SALE",
              "description": "$10 off for summer sale"
            }
          ]
        }
      }
    },
    "items": [
      {
        "name": "T-Shirt",
        "description": "Green XL",
        "sku": "sku01",
        "unit_amount": {
          "currency_code": "USD",
          "value": "90.00"
        },
        "tax": {
          "currency_code": "USD",
          "value": "10.00"
        },
        "quantity": "1",
        "category": "PHYSICAL_GOODS"
      }
    ],
    "shipping": {
      "options": [
        {
          "id": "FEDEX",
          "amount": {
            "currency_code": "USD",
            "value": "0.00"
          },
          "type": "SHIPPING",
          "label": "Free Shipping",
          "selected": true
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Oauth 2.0 authentication

Headers

​
Authorization
string

Holds authorization information for external API calls. Standard headers are generally less restrictive in structure due to historical precedent across browsers, etc. This is a common schema for use in defining most standard headers.

Required string length: 1 - 16000

Body

application/json

Shipping Options Callback request. This will be implemented by the merchants.

​
purchase_units
purchase_unit · object[]
required

An array of purchase units. At present only 1 purchase_unit is supported. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.

Required array length: 1 element
​
shipping_address
Portable Postal Address (Medium-Grained) · object

Redacted shipping address to be used for shipping options and tax calculations.

​
shipping_option
shipping_option · object

Buyer selected shipping option.

Response

The callback to merchant was successful.

Returns the updated shipping options for an order.

​
id
string

The ID of the order.

Required string length: 1 - 36