View as Markdown
API Spec (JSON)
API Spec (YAML)
Compact modeHides field descriptions and other prose for a more compact, scannable view of the API reference.PayPalJWT PayPal-supplied JWT token for authenticating merchant API requests.
Important: These JWT tokens are issued and managed by PayPal, not generated by merchants. PayPal provides these tokens to authenticate calls to your merchant API endpoints.
Usage:
Example:
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...In: header
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/merchant-cart/CART-123" \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."{ "id": "CART-READY-001", "status": "READY", "validation_status": "VALID", "validation_issues": [], "items": [ { "variant_id": "SHIRT-BASIC-001", "quantity": 1, "name": "Basic T-Shirt", "price": { "currency_code": "USD", "value": "19.99" } } ], "customer": { "email_address": "[email protected]" }, "shipping_address": { "address_line_1": "123 Main Street", "admin_area_2": "San Jose", "admin_area_1": "CA", "postal_code": "95131", "country_code": "US" }, "available_shipping_options": [ { "id": "STANDARD", "name": "Standard Shipping (3-5 days)", "price": { "currency_code": "USD", "value": "9.99" }, "estimated_delivery": "2024-07-01", "is_selected": true }, { "id": "EXPRESS", "name": "Express Shipping (1-2 days)", "price": { "currency_code": "USD", "value": "19.99" }, "estimated_delivery": "2024-06-27", "is_selected": false } ], "totals": { "subtotal": { "currency_code": "USD", "value": "19.99" }, "shipping": { "currency_code": "USD", "value": "4.99" }, "tax": { "currency_code": "USD", "value": "1.82" }, "handling": { "currency_code": "USD", "value": "1.50" }, "custom_charges": { "currency_code": "USD", "value": "2.00" }, "total": { "currency_code": "USD", "value": "30.30" } }}