Paypal API
  1. Catalog Products
Paypal API
  • Authorization
    • Generate access_token
      POST
    • Terminate access_token
      POST
    • User Info
      GET
    • Generate client_token
      POST
  • Orders
    • Create order
      POST
    • Show order details
      GET
    • Update order
      PATCH
    • Authorize payment for order
      POST
    • Capture payment for order
      POST
  • Payments
    • Show details for authorized payment
      GET
    • Reauthorize authorized payment
      POST
    • Void authorized payment
      POST
    • Capture authorized payment
      POST
    • Show captured payment details
      GET
    • Refund captured payment
      POST
    • Show refund details
      GET
  • Invoices
    • Invoices
      • Generate invoice number
      • Create draft invoice
      • Show invoice details
      • List invoices
      • Generate QR code
      • Fully update invoice
      • Send invoice
      • Send invoice reminder
      • Cancel sent invoice
      • Delete invoice
      • Search for invoices
      • Record payment for invoice
      • Delete external payment
      • Record refund for invoice
      • Delete external refund
    • Templates
      • List templates
      • Create template
      • Show template details
      • Fully update template
      • Delete template
  • Subscriptions
    • Catalog Products
      • Create product
        POST
      • List products
        GET
      • Show product details
        GET
      • Update product
        PATCH
    • Plans
      • Create plan
      • List plans
      • Show plan details
      • Update plan
      • Deactivate plan
      • Activate plan
      • Update pricing
    • Subscriptions
      • Create subscription
      • Show subscription details
      • Update subscription
      • Revise plan or quantity of subscription
      • Suspend subscription
      • Activate subscription
      • Cancel subscription
      • Capture authorized payment on subscription
      • List transactions for subscription
  • Payouts
    • Create batch payout
    • Show payout batch details
    • Show payout item details
    • Cancel unclaimed payout item
  • Webhooks
    • List available events
    • Create webhook
    • List webhooks
    • Show webhook details
    • List event notifications
    • List event subscriptions for webhook
    • Show event notification details
    • Trigger a sample event
    • Verify webhook signature
    • Resend event notification
    • Simulate webhook event
    • Update webhook
    • Delete webhook
  • Shipment Tracking
    • Add tracking information for multiple PayPal transactions
    • Show tracking information
    • Update or cancel tracking information for PayPal transaction
  • Transaction Search
    • List transactions
    • List all balances
  • Disputes
    • List disputes
    • Show dispute details
    • Accept claim
    • Appeal dispute
    • Settle dispute
    • Update dispute status
    • Make offer to resolve dispute
    • Provide evidence
    • Acknowledge returned item
    • Provide supporting information for dispute
    • Escalate dispute to claim
    • Accept offer to resolve dispute
    • Send message about dispute to other party
    • Deny offer to resolve dispute
    • Partially update dispute
  • Onboarding (Limited Release)
    • Manage Accounts
      • Create managed account
      • Search managed account through external id
      • Search managed account by Seller Id
      • Partially updates information for a managed account
      • Shows collection of registered wallet domains
  1. Catalog Products

List products

GET
/v1/catalogs/products
Lists products.

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Basic 之后拼接空格,以及经过 Base64 编码的 username:password
示例:
Authorization: Basic *****************
Query 参数
page_size
string 
必需
The number of items to return in the response.
示例值:
10
page
string 
必需
A non-zero integer which is the start index of the entire list of items that are returned in the response. So, the combination of page=1 and page_size=20 returns the first 20 items. The combination of page=2 and page_size=20 returns the next 20 items.
示例值:
1
total_required
string 
必需
Indicates whether to show the total items and total pages in the response.
示例值:
true

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-m.sandbox.paypal.com/v1/catalogs/products?page_size=10&page=1&total_required=true' \
--header 'Authorization: Basic Og=='

返回响应

🟢200200 - List Products
application/json
Body
products
array [object {5}] 
必需
id
string 
必需
name
string 
必需
create_time
string 
必需
links
array [object {3}] 
必需
description
string 
必需
total_items
integer 
必需
total_pages
integer 
必需
links
array [object {3}] 
必需
href
string 
必需
rel
string 
必需
method
string 
必需
示例
{
    "products": [
        {
            "id": "1647236710",
            "name": "Blue M",
            "create_time": "2022-03-14T05:45:06Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/catalogs/products/1647236710",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        },
        {
            "id": "1647236727",
            "name": "Licenza Oro",
            "create_time": "2022-03-14T05:45:23Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/catalogs/products/1647236727",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        },
        {
            "id": "1647285840",
            "name": "Licenza Premium",
            "description": "Blue M",
            "create_time": "2022-03-14T19:24:00Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/catalogs/products/1647285840",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        },
        {
            "id": "1647285859",
            "name": "T-Shirt",
            "create_time": "2022-03-14T19:24:18Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/catalogs/products/1647285859",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        },
        {
            "id": "1647288288",
            "name": "T-Shirt",
            "description": "Blue M",
            "create_time": "2022-03-14T20:04:47Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/catalogs/products/1647288288",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        },
        {
            "id": "1647288308",
            "name": "T-Shirt",
            "create_time": "2022-03-14T20:05:08Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/catalogs/products/1647288308",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        },
        {
            "id": "1647289108",
            "name": "T-Shirt",
            "description": "Blue M",
            "create_time": "2022-03-14T20:18:28Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/catalogs/products/1647289108",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        },
        {
            "id": "1647289127",
            "name": "T-Shirt",
            "create_time": "2022-03-14T20:18:47Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/catalogs/products/1647289127",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        },
        {
            "id": "1647289319",
            "name": "T-Shirt",
            "description": "Blue M",
            "create_time": "2022-03-14T20:21:59Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/catalogs/products/1647289319",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        },
        {
            "id": "1647289338",
            "name": "T-Shirt",
            "create_time": "2022-03-14T20:22:18Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/catalogs/products/1647289338",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        }
    ],
    "total_items": 18719,
    "total_pages": 1872,
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/catalogs/products?page_size=10&page=1",
            "rel": "self",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/catalogs/products?page_size=10&page=2",
            "rel": "next",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/catalogs/products?page_size=10&page=1872",
            "rel": "last",
            "method": "GET"
        }
    ]
}
🟢200200 - List Products With Detailed Response
🟢200200 - List Products With Minimal Response
🟠401401 Unauthorized - Invalid Token
修改于 2023-08-16 07:18:59
上一页
Create product
下一页
Show product details
Built with