{"openapi":"3.1.0","info":{"title":"Products and Customers","version":"1.0.0","description":"API reference for storing a seller's product catalogue and customer records: create, list, update and delete products and customers, authenticated with a JWT from `POST /auth/token`."},"servers":[{"url":"https://payme-store-staging.payme.io/api","description":"Sandbox"},{"url":"https://payme-store.payme.io/api","description":"Production"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"},"partnerKey":{"type":"apiKey","in":"header","name":"PayMe-Partner-Key"},"merchantKey":{"type":"apiKey","in":"header","name":"PayMe-Merchant-Key"}}},"tags":[{"name":"Products"}],"paths":{"/products":{"get":{"security":[{"bearerAuth":[]}],"parameters":[{"name":"page","in":"query","required":true,"description":"Page number, from `1`.","schema":{"type":"integer"}},{"name":"items_per_page","in":"query","required":true,"description":"Products per page, from `1` to `100`.","schema":{"type":"integer"}},{"name":"status","in":"query","required":false,"description":"`1` – available, `0` – unavailable, `-1` – draft.","schema":{"type":"integer"}},{"name":"search","in":"query","required":false,"description":"Case-insensitive text to find in the name or the description.","schema":{"type":"string"}},{"name":"name","in":"query","required":false,"description":"Case-insensitive text to find in the name, 2–100 characters.","schema":{"type":"string"}},{"name":"description","in":"query","required":false,"description":"Case-insensitive text to find in the description, 2–100 characters.","schema":{"type":"string"}},{"name":"product_remote_id","in":"query","required":false,"description":"Your own product id, exact match.","schema":{"type":"string"}},{"name":"currency","in":"query","required":false,"description":"ISO 4217 code (e.g. `ILS`) of the store price including VAT.","schema":{"type":"string"}},{"name":"price[min]","in":"query","required":false,"description":"Lowest store price including VAT, in major units.","schema":{"type":"number"}},{"name":"price[max]","in":"query","required":false,"description":"Highest store price including VAT, in major units.","schema":{"type":"number"}},{"name":"created_at[from]","in":"query","required":false,"description":"Created at or after this time: `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`.","schema":{"type":"string"}},{"name":"created_at[to]","in":"query","required":false,"description":"Created at or before this time, in the same formats.","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"description":"`name`, `status` or `created_at`.","schema":{"type":"string"}},{"name":"sort_direction","in":"query","required":false,"description":"`asc` or `desc`. Default `desc`. Applies only together with `sort_by`.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of products.","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","description":"The products on this page.","items":{"type":"object","properties":{"guid":{"type":"string","description":"Product id (a UUID) assigned by PayMe. Use it in `/products/{guid}`."},"product_remote_id":{"type":"string","description":"Your own product id. Left out when not set."},"name":{"type":"string","description":"Product name."},"status":{"type":"integer","description":"`1` – available, `0` – unavailable, `-1` – draft."},"description":{"type":"string","description":"Product description."},"store_configuration":{"type":"object","description":"Selling price. You send it as `store_prices` when you create or update the product. The `currency` and `price[min]`/`price[max]` filters of `GET /products` match its `price_include_vat`.","properties":{"is_vat_free":{"type":"boolean","description":"`true` if the product is exempt from VAT."},"price_without_vat":{"type":"object","description":"Price before VAT. `null` when not set.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}}},"price_include_vat":{"type":"object","description":"Price including VAT. `null` when not set.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}}}}},"costs_details":{"type":"object","description":"Your cost for the product, same shape as `store_configuration`. You send it as `costs`. Left out when not set.","properties":{"is_vat_free":{"type":"boolean","description":"`true` if the product is exempt from VAT."},"price_without_vat":{"type":"object","description":"Price before VAT. `null` when not set.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}}},"price_include_vat":{"type":"object","description":"Price including VAT. `null` when not set.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}}}}}}}},"total":{"type":"integer","description":"How many products match the filters, across all pages."},"page":{"type":"integer","description":"The page returned."},"items_per_page":{"type":"integer","description":"The page size you asked for."}}},"example":{"items":[{"guid":"3f2b8f0e-5d7c-4a1e-9b8a-2c4d6e8f0a1b","product_remote_id":"PROD001","name":"Example product","status":1,"description":"Example description","store_configuration":{"is_vat_free":false,"price_without_vat":{"amount":99.99,"currency":"ILS"},"price_include_vat":{"amount":117.99,"currency":"ILS"}},"costs_details":{"is_vat_free":false,"price_without_vat":{"amount":50,"currency":"ILS"},"price_include_vat":{"amount":59,"currency":"ILS"}}}],"total":1,"page":1,"items_per_page":20}}}},"400":{"description":"A required parameter is missing or a parameter is invalid, e.g. `items_per_page` above `100`.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong. Validation messages are in Hebrew unless you send `Accept-Language: en`."},"status_error_code":{"type":"integer","description":"`501` for a validation error or a body that isn't valid JSON, `999` for any other error."},"validation_errors":{"type":"object","description":"The fields that failed validation. Each key is a field name; its value maps each failed rule to a message."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Field validation failed.","validation_errors":{"items_per_page":{"max":"The value must be less than max amount."}},"status_error_code":501,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"401":{"description":"The `Authorization` header is missing, or the access token is invalid or expired. Get a new token with `POST /refresh-exchanges` or `POST /auth-tokens`.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Unauthorized","status_error_code":999,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"500":{"description":"Server error. Contact PayMe support and quote the `session`.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}}}}}},"operationId":"get-products","summary":"List products","tags":["Products"],"description":"Lists the seller's products, one page at a time. `page` and `items_per_page` are required. Filter by status, text, your own product id, store currency, store price or creation date, and sort by name, status or creation date. Without `sort_by` the order isn't defined.\n\nPass the range filters in deep-object form, e.g. `?price[min]=10&price[max]=200&created_at[from]=2026-01-01`.\n\nSend `Authorization: Bearer <auth_token>`, the token from [`POST /auth-tokens`](/products-and-customers/authentication/post-auth-token). Hosts, tokens and the error format: [Hosts, authentication and errors](/products-and-customers/authentication). Prices are decimal amounts in major units (`99.99`), not minor units."},"post":{"security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_remote_id":{"type":"string","description":"Your own product id, 2–100 characters, unique among the seller's products (`409` otherwise)."},"name":{"type":"string","description":"Product name, 2–100 characters."},"status":{"type":"integer","description":"`1` – available, `0` – unavailable, `-1` – draft."},"description":{"type":"string","description":"Product description, at least 2 characters."},"store_prices":{"type":"object","description":"Selling price. Returned as `store_configuration`. The `currency` and `price[min]`/`price[max]` filters of `GET /products` match its `price_include_vat`.","properties":{"is_vat_free":{"type":"boolean","description":"`true` if the product is exempt from VAT."},"price_without_vat":{"type":"object","description":"Price before VAT.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}},"required":["amount","currency"]},"price_include_vat":{"type":"object","description":"Price including VAT.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}},"required":["amount","currency"]}}},"costs":{"type":"object","description":"Your cost for the product, same shape as `store_prices`. Returned as `costs_details`.","properties":{"is_vat_free":{"type":"boolean","description":"`true` if the product is exempt from VAT."},"price_without_vat":{"type":"object","description":"Price before VAT.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}},"required":["amount","currency"]},"price_include_vat":{"type":"object","description":"Price including VAT.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}},"required":["amount","currency"]}}}},"required":["name","status","store_prices"]},"example":{"product_remote_id":"PROD003","name":"Detailed costs product","status":1,"description":"This product includes detailed cost information.","store_prices":{"is_vat_free":false,"price_without_vat":{"amount":150,"currency":"ILS"},"price_include_vat":{"amount":177,"currency":"ILS"}},"costs":{"is_vat_free":false,"price_without_vat":{"amount":70,"currency":"ILS"},"price_include_vat":{"amount":82.6,"currency":"ILS"}}}}},"description":"The product to create."},"responses":{"201":{"description":"Product created.","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"guid":{"type":"string","description":"The new product's id (a UUID). Use it in `/products/{guid}`."},"created_at":{"type":"string","description":"Creation time, ISO 8601 (UTC)."}}},"example":{"guid":"3f2b8f0e-5d7c-4a1e-9b8a-2c4d6e8f0a1b","created_at":"2026-11-09T10:00:00.000Z"}}}},"400":{"description":"A required field is missing, a field is invalid, or the body isn't valid JSON.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong. Validation messages are in Hebrew unless you send `Accept-Language: en`."},"status_error_code":{"type":"integer","description":"`501` for a validation error or a body that isn't valid JSON, `999` for any other error."},"validation_errors":{"type":"object","description":"The fields that failed validation. Each key is a field name; its value maps each failed rule to a message."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Please verify that the JSON provided is valid","status_error_code":501,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"401":{"description":"The `Authorization` header is missing, or the access token is invalid or expired. Get a new token with `POST /refresh-exchanges` or `POST /auth-tokens`.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Unauthorized","status_error_code":999,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"409":{"description":"`product_remote_id` is already used by another of the seller's products.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Product remote id already exist","status_error_code":999,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"500":{"description":"Server error. Contact PayMe support and quote the `session`.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}}}}}},"operationId":"post-user","summary":"Create a product","tags":["Products"],"description":"Adds a product to the seller's catalogue. `name`, `status` and `store_prices` are required. The response returns the new product's `guid`; use it with `/products/{guid}`.\n\nThe request names the price objects `store_prices` and `costs`; responses name them `store_configuration` and `costs_details`. Fields the API doesn't know are ignored.\n\nSend `Authorization: Bearer <auth_token>`, the token from [`POST /auth-tokens`](/products-and-customers/authentication/post-auth-token). Hosts, tokens and the error format: [Hosts, authentication and errors](/products-and-customers/authentication). Prices are decimal amounts in major units (`99.99`), not minor units."}},"/products/{guid}":{"get":{"security":[{"bearerAuth":[]}],"parameters":[{"name":"guid","in":"path","required":true,"description":"The product `guid` (a UUID) that `POST /products` returned. Any other format returns `400`.","schema":{"type":"string"}}],"responses":{"200":{"description":"The product.","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"guid":{"type":"string","description":"Product id (a UUID) assigned by PayMe. Use it in `/products/{guid}`."},"product_remote_id":{"type":"string","description":"Your own product id. Left out when not set."},"name":{"type":"string","description":"Product name."},"status":{"type":"integer","description":"`1` – available, `0` – unavailable, `-1` – draft."},"description":{"type":"string","description":"Product description."},"store_configuration":{"type":"object","description":"Selling price. You send it as `store_prices` when you create or update the product. The `currency` and `price[min]`/`price[max]` filters of `GET /products` match its `price_include_vat`.","properties":{"is_vat_free":{"type":"boolean","description":"`true` if the product is exempt from VAT."},"price_without_vat":{"type":"object","description":"Price before VAT. `null` when not set.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}}},"price_include_vat":{"type":"object","description":"Price including VAT. `null` when not set.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}}}}},"costs_details":{"type":"object","description":"Your cost for the product, same shape as `store_configuration`. You send it as `costs`. Left out when not set.","properties":{"is_vat_free":{"type":"boolean","description":"`true` if the product is exempt from VAT."},"price_without_vat":{"type":"object","description":"Price before VAT. `null` when not set.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}}},"price_include_vat":{"type":"object","description":"Price including VAT. `null` when not set.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}}}}}}},"example":{"guid":"3f2b8f0e-5d7c-4a1e-9b8a-2c4d6e8f0a1b","product_remote_id":"PROD001","name":"Example product","status":1,"description":"Example description","store_configuration":{"is_vat_free":false,"price_without_vat":{"amount":99.99,"currency":"ILS"},"price_include_vat":{"amount":117.99,"currency":"ILS"}},"costs_details":{"is_vat_free":false,"price_without_vat":{"amount":50,"currency":"ILS"},"price_include_vat":{"amount":59,"currency":"ILS"}}}}}},"400":{"description":"`guid` isn't a UUID.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Validation failed (uuid is expected)","status_error_code":999,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"401":{"description":"The `Authorization` header is missing, or the access token is invalid or expired. Get a new token with `POST /refresh-exchanges` or `POST /auth-tokens`.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Unauthorized","status_error_code":999,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"404":{"description":"The product doesn't exist, was deleted, or belongs to another seller.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Product not found","status_error_code":999,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"500":{"description":"Server error. Contact PayMe support and quote the `session`.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}}}}}},"operationId":"get-products-guid","summary":"Get a product","tags":["Products"],"description":"Returns one of the seller's products by its `guid`. A product that doesn't exist, was deleted or belongs to another seller returns `404`.\n\nSend `Authorization: Bearer <auth_token>`, the token from [`POST /auth-tokens`](/products-and-customers/authentication/post-auth-token). Hosts, tokens and the error format: [Hosts, authentication and errors](/products-and-customers/authentication). Prices are decimal amounts in major units (`99.99`), not minor units."},"patch":{"security":[{"bearerAuth":[]}],"parameters":[{"name":"guid","in":"path","required":true,"description":"The product `guid` (a UUID) that `POST /products` returned. Any other format returns `400`.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_remote_id":{"type":"string","description":"Your own product id, 2–100 characters, unique among the seller's products (`409` otherwise). Send it only to change it: resending the product's current value also returns `409`."},"name":{"type":"string","description":"Product name, 2–100 characters."},"status":{"type":"integer","description":"`1` – available, `0` – unavailable, `-1` – draft."},"description":{"type":"string","description":"Product description, at least 2 characters."},"store_prices":{"type":"object","description":"Selling price. Replaces the stored selling price entirely: send `is_vat_free` and both prices together. Returned as `store_configuration`. The `currency` and `price[min]`/`price[max]` filters of `GET /products` match its `price_include_vat`.","properties":{"is_vat_free":{"type":"boolean","description":"`true` if the product is exempt from VAT."},"price_without_vat":{"type":"object","description":"Price before VAT.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}},"required":["amount","currency"]},"price_include_vat":{"type":"object","description":"Price including VAT.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}},"required":["amount","currency"]}}},"costs":{"type":"object","description":"Your cost for the product, same shape as `store_prices`. Replaces the stored cost entirely. Returned as `costs_details`.","properties":{"is_vat_free":{"type":"boolean","description":"`true` if the product is exempt from VAT."},"price_without_vat":{"type":"object","description":"Price before VAT.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}},"required":["amount","currency"]},"price_include_vat":{"type":"object","description":"Price including VAT.","properties":{"amount":{"type":"number","description":"Decimal amount in major units, e.g. `99.99`."},"currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."}},"required":["amount","currency"]}}}}},"example":{"name":"Example product","status":1,"store_prices":{"is_vat_free":false,"price_without_vat":{"amount":99.99,"currency":"ILS"},"price_include_vat":{"amount":117.99,"currency":"ILS"}}}}},"description":"The fields to change."},"responses":{"200":{"description":"Product updated.","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"guid":{"type":"string","description":"The product id (a UUID)."},"created_at":{"type":"string","description":"Creation time, ISO 8601 (UTC)."},"updated_at":{"type":"string","description":"Time of this update, ISO 8601 (UTC)."}}},"example":{"guid":"3f2b8f0e-5d7c-4a1e-9b8a-2c4d6e8f0a1b","created_at":"2026-11-01T09:30:00.000Z","updated_at":"2026-11-09T10:00:00.000Z"}}}},"400":{"description":"A field is invalid, the body isn't valid JSON, or `guid` isn't a UUID.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong. Validation messages are in Hebrew unless you send `Accept-Language: en`."},"status_error_code":{"type":"integer","description":"`501` for a validation error or a body that isn't valid JSON, `999` for any other error."},"validation_errors":{"type":"object","description":"The fields that failed validation. Each key is a field name; its value maps each failed rule to a message."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Please verify that the JSON provided is valid","status_error_code":501,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"401":{"description":"The `Authorization` header is missing, or the access token is invalid or expired. Get a new token with `POST /refresh-exchanges` or `POST /auth-tokens`.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Unauthorized","status_error_code":999,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"404":{"description":"The product doesn't exist, was deleted, or belongs to another seller.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Product not found","status_error_code":999,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"409":{"description":"`product_remote_id` is already used by another of the seller's products.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Product remote id already exist","status_error_code":999,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"500":{"description":"Server error. Contact PayMe support and quote the `session`.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}}}}}},"operationId":"patch-products-product-id","summary":"Update a product","tags":["Products"],"description":"Changes some fields of one of the seller's products. Fields you don't send keep their values. A price object you send (`store_prices` or `costs`) replaces the stored one entirely.\n\nThe request names the price objects `store_prices` and `costs`; responses name them `store_configuration` and `costs_details`. Fields the API doesn't know are ignored.\n\nTo replace the whole product in one call, `PUT /products/{guid}` takes the same body as [`POST /products`](/products-and-customers/products/post-user), with the same required fields.\n\nSend `Authorization: Bearer <auth_token>`, the token from [`POST /auth-tokens`](/products-and-customers/authentication/post-auth-token). Hosts, tokens and the error format: [Hosts, authentication and errors](/products-and-customers/authentication). Prices are decimal amounts in major units (`99.99`), not minor units."},"delete":{"security":[{"bearerAuth":[]}],"parameters":[{"name":"guid","in":"path","required":true,"description":"The product `guid` (a UUID) that `POST /products` returned. Any other format returns `400`.","schema":{"type":"string"}}],"responses":{"204":{"description":"Product deleted. The response has no body.","x-response-kind":"success"},"400":{"description":"`guid` isn't a UUID.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Validation failed (uuid is expected)","status_error_code":999,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"401":{"description":"The `Authorization` header is missing, or the access token is invalid or expired. Get a new token with `POST /refresh-exchanges` or `POST /auth-tokens`.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Unauthorized","status_error_code":999,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"404":{"description":"The product doesn't exist, was deleted, or belongs to another seller.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}},"example":{"status_error_details":"Product not found","status_error_code":999,"session":"f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"}}}},"500":{"description":"Server error. Contact PayMe support and quote the `session`.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_error_details":{"type":"string","description":"What went wrong."},"status_error_code":{"type":"integer","description":"`999`."},"session":{"type":"string","description":"Trace id of the request. Quote it when you contact PayMe support."}}}}}}},"operationId":"delete-products-guid","summary":"Delete a product","tags":["Products"],"description":"Deletes one of the seller's products. Deleted products no longer appear in lists or reads, and their `guid` returns `404`. The call has no request body and returns `204 No Content`.\n\nSend `Authorization: Bearer <auth_token>`, the token from [`POST /auth-tokens`](/products-and-customers/authentication/post-auth-token). Hosts, tokens and the error format: [Hosts, authentication and errors](/products-and-customers/authentication)."}}}}