Catalog Products API

Catalog Products API

Merchants can use the Catalog Products API to create products, which are goods and services.

class python_paypal_api.api.Products(*args, **kwargs)

Use /products resource to create and manage products.

list_products(self, **kwargs) → ApiResponse

GET /v1/catalogs/products

Lists products.

**kwargs:

page integer

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.

Minimum value: 1.

Maximum value: 100000.

page_size integer

The number of items to return in the response.

Minimum value: 1.

Maximum value: 20.

total_required boolean

Indicates whether to show the total items and total pages in the response.

get_product(self, productId: str, **kwargs) → ApiResponse: GET /v1/catalogs/products/{product_id}

update_product(self, productId: str, **kwargs) → ApiResponse: PATCH /v1/catalogs/products/{product_id}

update_product_helper(self, productId: str, **kwargs) → ApiResponse: PATCH /v1/catalogs/products/{product_id}

post_product(self, **kwargs) → ApiResponse: POST /v1/catalogs/products

post_product_helper(self, body: str, **kwargs) → ApiResponse: POST /v1/catalogs/products