Tuoterekisteriin voi tallentaa usein käytettyjä tuotteita tai palveluita, jolloin niiden tietoja ei tarvitse syöttää uudestaan tilauksia tehdessä.
| Endpoint | Toiminto |
|---|---|
| GET api/v1/products | Listaa tuotteet |
| POST api/v1/products | Lisää tuote |
| GET api/v1/products/{productId} | Hae tuotteen tiedot |
| PUT api/v1/products/{productId} | Muokkaa tuotetta |
| DELETE api/v1/products/{productId} | Poista tuote |
Listaa tuotteet
Listaa kaikki tuotteet. Tuotteet ovat aakkosjärjestyksessä.
Parametrit
page
Vapaaehtoinen
Sivu miltä tuotteet haetaan. Rajapinta palauttaa 50 tuotetta yhdellä sivulla.
GET api/v1/products
cURL
curl -i -X GET -H "Authorization:Token API-AVAIN" 'https://test.app.paylink.fi/api/v1/products?page=1'Vastaus
{
"has_more": false,
"data": [
{
"id": 1,
"title": "Testituote",
"tax_rate_id": "fi_standard",
"price_cents": 10000,
"created_at": "2020-08-10T18:04:37.000+03:00",
"updated_at": "2020-08-10T18:04:37.000+03:00"
},
...
]
}Lisää tuote
Luo uusi tuote.
Parametrit
title
Pakollinen
Tuotteen nimi
tax_rate_id
Pakollinen
Veroprosentin tunniste, joko
fi_standard (24 %), fi_intermediate (14 %), fi_reduced (10 %) tai fi_zero (0 %)
price_cents
Pakollinen
Tuotteen yksikköhinta, joko verollinen tai veroton asetuksista riippuen (Asetukset > Tilaukset > Hinnat sisältävät ALV).
POST api/v1/products
cURL
curl -i -X POST \
-H "Authorization:Token API-AVAIN" \
-H "Content-Type:application/json" \
-d \
'{
"title": "Testituote",
"tax_rate_id": "fi_standard",
"price_cents": 12400
}' \
'https://test.app.paylink.fi/api/v1/products.json'Vastaus
{
"id": 1,
"title": "Testituote",
"tax_rate_id": "fi_standard",
"price_cents": 12400,
"created_at": "2020-08-18T12:13:40.000+03:00",
"updated_at": "2020-08-18T12:13:40.000+03:00"
}
Hae tuotteen tiedot
Hakee yhden tuotteen tiedot tuote-ID:n perusteella.
Parametrit
productId
Pakollinen
Tuotteen ID
GET api/v1/products/{productId}
cURL
curl -i -X GET \
-H "Authorization:Token API-AVAIN" \
'https://test.app.paylink.fi/api/v1/products/1'Vastaus
{
"id": 1,
"title": "Testituote",
"tax_rate_id": "fi_standard",
"price_cents": 12400,
"created_at": "2020-08-18T12:13:40.000+03:00",
"updated_at": "2020-08-18T12:13:40.000+03:00"
}Muokkaa tuotetta
Muokkaa tuotteen tietoja.
Parametrit
productId
Pakollinen
Tuotteen ID
Kts. muut parametrit kohdasta Lisää tuote »
PUT api/v1/products/{productId}
cURL
curl -i -X PUT \
-H "Authorization:Token API-AVAIN" \
-H "Content-Type:application/json" \
-d \
'{
"title": "Uusi tuotteen nimi"
}' \
'https://test.app.paylink.fi/api/v1/products/1'Vastaus
{
"id": 1,
"title": "Uusi tuotteen nimi",
"tax_rate_id": "fi_standard",
"price_cents": 12400,
"created_at": "2020-08-18T12:13:40.000+03:00",
"updated_at": "2020-08-18T12:13:40.000+03:00"
}Poista tuote
Poistaa tuotteen.
Parametrit
productId
Pakollinen
Tuotteen ID
DELETE api/v1/products/{productId}
cURL
curl -i -X DELETE \
-H "Authorization:Token API-AVAIN" \
'https://test.app.paylink.fi/api/v1/products/1'
