Products & Customers API overview

Products & Customers keeps a seller's product catalogue and customer list. It is a separate PayMe service, with its own hosts and its own access token.

What the API covers

Section What it covers
Authentication Get an access token for a seller, and refresh it.
Products Create, get, list, update and delete the seller's products.
Customers Create, get, list, update and delete the seller's customers.

Read these first

# Page What you learn
1 Authentication and environments The sandbox and production hosts, and how to get and refresh the access token that every product and customer call needs.
2 Errors The fields of an error response, its codes, and what each HTTP status means.

Amounts

Prices in this API are decimal amounts in major units, sent as money objects such as {"amount": 99.99, "currency": "ILS"}. This differs from the Payments API, which uses minor units.

Machine-readable docs

Every page is available as Markdown by appending .md to its URL. Each API Reference section publishes one OpenAPI file at /products-and-customers/<section>/openapi.json, for example /products-and-customers/products/openapi.json.