Get by Product Guid

Sandbox: GET https://sandbox.payme.io/api/products/{guid}
Production: GET https://live.payme.io/api/products/{guid}

Credentials

No credentials are documented for this endpoint.

The GET /products/guid endpoint provides access to product data, enabling clients to filter and sort through available products. Clients can specify parameters such as product status, creation date range, currency, description, order columns, and directions. Additionally, the endpoint allows for pagination and setting price ranges.

The response will include a list of products that match the specified query parameters, along with metadata such as the total number of products available and pagination details. This endpoint is essential for applications that require dynamic and flexible product searches.

Parameters

Name	In	Type	Required	Description
`guid`	path	string	yes

Code samples

curl

curl -X GET 'https://sandbox.payme.io/api/products/<guid>'

Node.js

const response = await fetch("https://sandbox.payme.io/api/products/<guid>", {
  method: "GET",
});

console.log(await response.text());

Python

import requests

response = requests.get(
    "https://sandbox.payme.io/api/products/<guid>",
)

print(response.text)

PHP

<?php

$ch = curl_init('https://sandbox.payme.io/api/products/<guid>');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Responses

200 — OK (success)

Field	Type	Description
`guid`	string	The Product unique identifier.
`product_remote_id`	string
`name`	string	The product name.
`status`	integer	The status of the product. Options: 1 = `Available`, 0 = `Not Available`
`description`	string	The product description.
`store_configuration`	object
`store_configuration.currency`	string	The product store currency. 3 Letter ISO Format
`store_configuration.vat_free`	boolean	The VAT Indicator of the product.
`store_configuration.price_without_vat`	number	The price of the product, excluding VAT.
`store_configuration.price_include_vat`	number	The price of the product, including VAT.
`costs_details`	object
`costs_details.currency`	string	The product store currency. 3 Letter ISO Format
`costs_details.vat_free`	boolean	The VAT Indicator of the product.
`costs_details.price_without_vat`	number	The price of the product, excluding VAT.
`costs_details.price_include_vat`	number	The price of the product, including VAT.

{
  "guid": "string",
  "product_code": "string",
  "name": "string",
  "status": 0,
  "category": 0,
  "description": "string",
  "store_configuration": {
    "currency": "string",
    "vat_free": true,
    "Price_without_vat": 0,
    "Price_include_vat": 0
  },
  "costs_details": {
    "currency": "string",
    "vat_free": true,
    "Price_without_vat": 0,
    "Price_include_vat": 0
  }
}