Create a product

• Sandbox: POST https://payme-store-staging.payme.io/api/products
• Production: POST https://payme-store.payme.io/api/products

Credentials

• Header Authorization: Bearer <token>

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}.

The 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.

Send Authorization: Bearer <auth_token>, the token from POST /auth-tokens. Hosts, tokens and the error format: Hosts, authentication and errors. Prices are decimal amounts in major units (99.99), not minor units.

Parameters

This endpoint takes no path, query or header parameters.

Request body

Content type: application/json

The product to create.

Request 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"
    }
  }
}

Code samples

curl

curl -X POST 'https://payme-store-staging.payme.io/api/products' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  --data-raw '{
  "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"
    }
  }
}'

Node.js

const response = await fetch("https://payme-store-staging.payme.io/api/products", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <YOUR_TOKEN>",
  },
  body: JSON.stringify({
    "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"
      }
    }
  }),
});

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

Python

import requests

response = requests.post(
    "https://payme-store-staging.payme.io/api/products",
    headers={
        "Authorization": "Bearer <YOUR_TOKEN>",
    },
    json={
        "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",
            },
        },
    },
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{
  "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"
    }
  }
}
BODY;

$ch = curl_init('https://payme-store-staging.payme.io/api/products');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'Authorization: Bearer <YOUR_TOKEN>',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

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

echo $response;

Responses

201 — Product created. (success)

{
  "guid": "3f2b8f0e-5d7c-4a1e-9b8a-2c4d6e8f0a1b",
  "created_at": "2026-11-09T10:00:00.000Z"
}

400 — A required field is missing, a field is invalid, or the body isn't valid JSON. (error)

{
  "status_error_details": "Please verify that the JSON provided is valid",
  "status_error_code": 501,
  "session": "f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"
}

401 — 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. (error)

{
  "status_error_details": "Unauthorized",
  "status_error_code": 999,
  "session": "f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"
}

409 — product_remote_id is already used by another of the seller's products. (error)

{
  "status_error_details": "Product remote id already exist",
  "status_error_code": 999,
  "session": "f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"
}

500 — Server error. Contact PayMe support and quote the session. (error)