Documentație API pentru lucrul cu carduri de reducere
Tabel cu descrierile câmpurilor:
| Câmp | Tip | Necesar? | Descriere |
|---|---|---|---|
| id | int | Nu | Identificator unic al cardului (necesar la actualizare). |
| user_id | int/null | Nu | ID-ul utilizatorului la care este legat cardul (null dacă utilizatorul nu este specificat). https://admin.ecom.md/ru/admin/users/usergroup/ |
| cod | sfoară | Da | Cod card. |
| numeentitatelegală | sfoară | Nu | Denumirea legală. |
| prenume | sfoară | Nu | Numele titularului cardului. |
| nume | sfoară | Nu | Numele de familie al titularului cardului. |
| cod de bare | sfoară | Da | Cod de bare unic pentru card. |
| suma_acumulată | zecimal | Nu | Valoarea debitărilor de pe card. |
| sex | sfoară | Nu | Sexul titularului cardului (m- bărbat, f- femeie). |
| data_nașterii | data | Nu | Data nașterii titularului cardului. |
adrese
*| sfoară| Nu| Adresa proprietarului cardului.
activ
*| bool| Nu| Activitate
1. Primirea tuturor cardurilor
Metodă: GET
URL: {domeniu}/external/discount-card/
Descriere:
Returnează o listă cu toate cardurile de reducere de pe site.
Exemplu de interogare:
GET {domain}/external/discount-card/
Exemplu de răspuns:
[
{
„id”: 1,
„user_id”: nul,
"cod": "1234567890123",
"legal_entity_name": "Companie de testare",
"first_name": "Ioan",
"last_name": "Doe",
„cod de bare”: „123456789012378476234768”,
"accumulated_amount": "5166.00",
"sex": "m",
"data_of_birth": "2006-07-08",
"address": "Adresa de testare"
}
]
2. Primiți un card
Metodă: GET
URL: {domain}/external/discount-card/{id}/
Descriere:
Returnează datele unui card de reducere după identificatorul acestuia.
Exemplu de interogare:
GET {domain}/external/discount-card/1/
Exemplu de răspuns:
{
„id”: 1,
„user_id”: nul,
"cod": "1234567890123",
"legal_entity_name": "Companie de testare",
"first_name": "Ioan",
"last_name": "Doe",
„cod de bare”: „123456789012378476234768”,
"accumulated_amount": "5166.00",
"sex": "m",
"data_of_birth": "2006-07-08",
"address": "Adresa de testare"
}
3. Se actualizează un card
Metodă: PUT
URL: {domain}/external/discount-card/{id}/
Descriere:
Actualizează datele unui card de reducere după identificatorul acestuia.
Exemplu de interogare:
PUT {domain}/external/discount-card/1/
Tip de conținut: application/json
Corpul cererii:
{
„cod”: „9876543210987”,
„cod de bare”: „987654321012345678901234”,
"accumulated_amount": "6000.00",
"first_name": "Jane",
"last_name": "Smith",
"sex": "f",
"data_of_birth": "1990-05-15",
"address": "Noua adresă de test"
}
Exemplu de răspuns:
{
„id”: 1,
„user_id”: nul,
„cod”: „9876543210987”,
"legal_entity_name": "Companie de testare",
"first_name": "Jane",
"last_name": "Smith",
„cod de bare”: „987654321012345678901234”,
"accumulated_amount": "6000.00",
"sex": "f",
"data_of_birth": "1990-05-15",
"address": "Noua adresă de test"
}
4. Crearea mai multor hărți
Metodă: POST
URL: {domain}/external/discount-card/bulk-create/
Descriere:
Creează mai multe carduri de reducere în același timp.
Exemplu de interogare:
POST {domain}/external/discount-card/bulk-create/
Tip de conținut: application/json
Corpul cererii:
[
{
"cod": "5432109876543",
„cod de bare”: „543210987654321098765432”,
"accumulated_amount": "5000.00",
"first_name": "Alice",
"last_name": "Johnson",
"sex": "f",
"data_of_birth": "1992-08-12",
"address": "Eșantion de adresă 1"
},
{
„cod”: „6789012345678”,
„cod de bare”: „678901234567890123456789”,
"accumulated_amount": "3000,00",
"first_name": "Bob",
"last_name": "Maro",
"sex": "m",
"data_of_birth": "1985-03-20",
"address": "Eșantion de adresă 2"
}
]
Exemplu de răspuns:
[
{
„id”: 2,
„user_id”: nul,
"cod": "5432109876543", „legalentityname”: nul, "firstname": "Alice", "lastname": "Johnson", „cod de bare”: „543210987654321098765432”, "accumulatedamount": "5000.00", "sex": "f", "dataofbirth": "1992-08-12", "address": "Eșantion de adresă 1" }, { „id”: 3, „userid”: nul, „cod”: „6789012345678”, „legalentityname”: nul, "firstname": "Bob", "lastname": "Maro", „cod de bare”: „678901234567890123456789”, "accumulatedamount": "3000,00", "sex": "m", "dataof_birth": "1985-03-20", "address": "Eșantion de adresă 2" } ]
5. Actualizați mai multe hărți
Metodă: PUT
URL: {domain}/external/discount-card/bulk-update/
Descriere:
Actualizează datele pentru mai multe carduri de reducere simultan.
Exemplu de interogare:
PUT {domain}/external/discount-card/bulk-update/
Tip de conținut: application/json
Corpul cererii:
[
{
„id”: 1,
„cod de bare”: „987654321012345678901235”,
"accumulated_amount": "7000.00",
"first_name": "Ioan",
"last_name": "Doe Actualizat"
},
{
„id”: 2,
„cod de bare”: „5432109876543210987654321”,
"accumulated_amount": "5500.00",
"first_name": "Alice actualizată"
}
]
Exemplu de răspuns:
[
{
„id”: 1,
„user_id”: nul,
„cod”: „9876543210987”,
"legal_entity_name": "Companie de testare",
"first_name": "Ioan",
"last_name": "Doe Actualizat",
„cod de bare”: „987654321012345678901235”,
"accumulated_amount": "7000.00",
"sex": "m",
"data_of_birth": "2006-07-08",
"address": "Noua adresă de test"
},
{
„id”: 2,
„user_id”: nul,
"cod": "5432109876543",
„legal_entity_name”: nul,
"first_name": "Alice actualizată",
"last_name": "Johnson",
„cod de bare”: „5432109876543210987654321”,
"accumulated_amount": "5500.00",
"sex": "f",
"data_of_birth": "1992-08-12",
"address": "Eșantion de adresă 1"
}
]
A fost util articolul?
Da, multumesc! Din pacate nu