List products
GET {{base_url}}/v1/catalogs/products?page_size=10&page=1&total_required=true
Lists products.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page_size | number | The number of items to return in the response. | |
page | number | 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. | |
total_required | boolean | Indicates whether to show the total items and total pages in the response. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
PayPal-Partner-Attribution-Id | string | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. | |
PayPal-Auth-Assertion | string | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant. | |
Prefer | string | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> | |
Prefer | string | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> | |
Content-Type | string | The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json. | |
PayPal-Request-Id | string | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. | |
PayPal-Client-Metadata-Id | string | Optional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection. | |
PayPal-Partner-Attribution-Id | string | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. | |
PayPal-Auth-Assertion | string | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant. | |
Prefer | string | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> | |
Prefer | string | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
RESPONSES
status: OK
{"products":[{"id":"BusinessStarter","name":"Business Starter","description":"Custom and secure business email\ndone\n100 participant video meetings\ndone\n30 GB cloud storage per user\ndone\nSecurity and management controls\ndone\nStandard Support","create_time":"2021-08-24T22:11:47Z","links":[{"href":"https://api.sandbox.paypal.com/v1/catalogs/products/BusinessStarter","rel":"self","method":"GET"}]},{"id":"GoogleWorkspace","name":"Google Workspace","description":"Google Workspace plans start as low as $6 per user per month for Business Starter, $12 per user per month for Business Standard, and $18 per user per month for Business Plus.","create_time":"2021-08-24T22:15:28Z","links":[{"href":"https://api.sandbox.paypal.com/v1/catalogs/products/GoogleWorkspace","rel":"self","method":"GET"}]},{"id":"PROD-6NK24187PL5505908","name":"Video Streaming Service","description":"Video streaming service","create_time":"2022-02-01T00:30:31Z","links":[{"href":"https://api.sandbox.paypal.com/v1/catalogs/products/PROD-6NK24187PL5505908","rel":"self","method":"GET"}]},{"id":"PROD-01Y15581KH952442A","name":"T-Shirt","create_time":"2022-02-01T00:32:03Z","links":[{"href":"https://api.sandbox.paypal.com/v1/catalogs/products/PROD-01Y15581KH952442A","rel":"self","method":"GET"}]},{"id":"sku001","name":"T-Shirt","description":"Green XL","create_time":"2022-02-01T00:36:54Z","links":[{"href":"https://api.sandbox.paypal.com/v1/catalogs/products/sku001","rel":"self","method":"GET"}]},{"id":"1643675876","name":"T-Shirt","description":"Green XL","create_time":"2022-02-01T00:37:56Z","links":[{"href":"https://api.sandbox.paypal.com/v1/catalogs/products/1643675876","rel":"self","method":"GET"}]},{"id":"cbae131b-add2-47fc-90a6-1a56ed8d59bb","name":"T-Shirt","description":"Green XL","create_time":"2022-02-01T00:38:53Z","links":[{"href":"https://api.sandbox.paypal.com/v1/catalogs/products/cbae131b-add2-47fc-90a6-1a56ed8d59bb","rel":"self","method":"GET"}]},{"id":"1643675979","name":"T-Shirt","description":"Green XL","create_time":"2022-02-01T00:39:39Z","links":[{"href":"https://api.sandbox.paypal.com/v1/catalogs/products/1643675979","rel":"self","method":"GET"}]},{"id":"1643676111","name":"T-Shirt","description":"Green XL","create_time":"2022-02-01T00:41:50Z","links":[{"href":"https://api.sandbox.paypal.com/v1/catalogs/products/1643676111","rel":"self","method":"GET"}]},{"id":"1643676117","name":"T-Shirt","description":"Green XL","create_time":"2022-02-01T00:41:57Z","links":[{"href":"https://api.sandbox.paypal.com/v1/catalogs/products/1643676117","rel":"self","method":"GET"}]}],"total_items":17,"total_pages":2,"links":[{"href":"https://api.sandbox.paypal.com/v1/catalogs/products?page_size=10\u0026page=1","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v1/catalogs/products?page_size=10\u0026page=2","rel":"next","method":"GET"},{"href":"https://api.sandbox.paypal.com/v1/catalogs/products?page_size=10\u0026page=2","rel":"last","method":"GET"}]}