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":"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":18721,"total_pages":1873,"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=1873","rel":"last","method":"GET"}]}