https://www.ifirma.pl/hub/user/platform/CUSTOM/V1/orders/order.json
Dostępne metody:
Przesłane żądanie powinno być zestawem danych o zamówieniu w formacie JSON, zgodnym ze strukturą przedstawioną w poniższej tabeli:
| Nazwa w JSON | Typ danych | Wartości | Wymagane | Opis |
|---|---|---|---|---|
| id | string | <= 40 znaków | T | identyfikator zamówienia |
| customId | string | <= 100 znaków | N | zewnętrzne id niestandardowe |
| status | string | <= 500 znaków | T | status zamówienia |
| created | string | Format: YYYY-MM-DDThh:mm:ss.sssZ. | T | data utworzenia zamówienia |
| currency | string | PLN; EUR; GBP; USD; CHF; NOK; JPY; CZK; LTL; UAH; RUB; AUD; DKK; CAD; LVL; RON; SEK; HUF; THB; HKD; NZD; SGD; ISK; HRK; BGN; TRY; ILS; CLP; PHP; MXN; ZAR; BRL; MYR; IDR; INR; KRW; CNY | N | waluta zamówienia zgodna ze standardem ISO 4217 |
| modified | string | Format: YYYY-MM-DDThh:mm:ss.sssZ. | N | data aktualizacji zamówienia |
| discountTotal | number | > 0.00 | N | rabat dla całego zamówienia |
| discountTax | number | > 0.00 | N | podatek od rabatu |
| shippingTotal | number | >= 0.00 | T | koszt dostawy |
| shippingTax | number | > 0.00 | N | podatek od dostawy |
| productsTotalNet | number | > 0.00 | T | kwota do zapłaty bez kosztów dostawy |
| productsTotalTax | number | >= 0.00 | N | podatek od kwoty do zapłaty bez kosztów dostawy |
| customerId | string | <= 20 znaków | N | zewnętrzny identyfikator klienta |
| paymentMethod | string | <= 500 znaków | N | sposób płatności |
| transactionId | string | <= 500 znaków | N | identyfikator transakcji z zewnętrznej integracji |
| paid | boolean | true; false | N | czy zamówienie zostało opłacone |
| completed | string | Format: YYYY-MM-DDThh:mm:ss.sssZ. | N | data zakończenia zamówienia |
| clientLogin | string | <= 400 znaków | N | login użytkownika składającego zamówienie |
| message | string | <= 2000 znaków | N | wiadomość od klienta |
| deliveryType | string | <= 300 znaków | N | sposób dostawy |
| invoiceRequired | boolean | true; false | N | czy faktura jest wymagana |
| voucherTotal | number | >= 0.00 | N | wartość vouchera |
| trackingList (lista trackingu, obiekt opcjonalny) | ||||
| name | string | ? | N | nazwa przesyłki |
| number | string | ? | N | numer przesyłki |
| items (pozycje zamówienia) | ||||
| id | string | <= 200 bajtów | N | zewnętrzne id pozycji zamówienia |
| name | string | <= 1000 znaków | N | nazwa pozycji zamówienia |
| quantity | number | >= 0.00 | T | ilość |
| totalPrice | number | >= 0.00 | T | suma wartości pozycji (ilość * cena za sztukę) |
| totalTax | number | >= 0.00 | N | wartość podatku obliczona od sumy wartości pozycji |
| price | number | >= 0.00 | T | cena jednostkowa |
| priceAfterDiscount | number | >= 0.00 | N | cena jednostkowa po uwzględnieniu rabatu na pozycję |
| unit | string | <= 100 znaków | N | jednostka pozycji zamówienia |
| sku | string | ? | N | kod sku |
| type | string | ITEM; HANDLING_FEE | N | typ pozycji zamówienia |
| offerId | string | <= 800 znaków | N | identyfikator oferty |
| digital | boolean | true; false | N | czy produkt cyfrowy |
| billing (adres do rozliczeń, obiekt opcjonalny) | ||||
| firstName | string | <= 500 znaków | N | imię kupującego |
| lastName | string | <= 500 znaków | N | nazwisko kupującego |
| company | string | <= 500 znaków | N | nazwa firmy |
| address1 | string | <= 500 znaków | N | adres – linia 1 |
| address2 | string | <= 500 znaków | N | adres – linia 2 |
| city | string | <= 500 znaków | N | miasto |
| state | string | <= 500 znaków | N | województwo |
| postcode | string | <= 500 znaków | N | kod pocztowy |
| country | string | <= 500 znaków | N | kraj |
| string | <= 500 znaków | N | adres e-mail | |
| phone | string | <= 500 znaków | N | numer telefonu |
| regon | string | <= 500 znaków | N | REGON |
| nip | string | <= 500 znaków | N | NIP |
| shipping (adres do dostawy, obiekt opcjonalny) | ||||
| firstName | string | <= 500 znaków | N | imię kupującego |
| lastName | string | <= 500 znaków | N | nazwisko kupującego |
| company | string | <= 500 znaków | N | nazwa firmy |
| address1 | string | <= 500 znaków | N | adres – linia 1 |
| address2 | string | <= 500 znaków | N | adres – linia 2 |
| city | string | <= 500 znaków | N | miasto |
| state | string | <= 500 znaków | N | województwo |
| postcode | string | <= 500 znaków | N | kod pocztowy |
| country | string | <= 500 znaków | N | kraj |
| string | <= 500 znaków | N | adres e-mail | |
| phone | string | <= 500 znaków | N | numer telefonu |
| regon | string | <= 500 znaków | N | REGON |
| nip | string | <= 500 znaków | N | NIP |
| pickupPoint (punkt odbioru, obiekt opcjonalny) | ||||
| method | string | <= 200 znaków | N | metoda dostawy do punktu odbioru |
| externalId | string | <= 500 znaków | N | identyfikator zewnętrzny |
| name | string | <= 200 znaków | N | nazwa punktu odbioru |
| description | string | <= 200 znaków | N | opis punktu odbioru |
| street | string | <= 200 znaków | N | ulica punktu odbioru |
| zipCode | string | <= 200 znaków | N | kod pocztowy punktu odbioru |
| city | string | <= 200 znaków | N | miasto punktu odbioru |
| countryCode | string | <= 50 znaków | N | kod kraju punktu odbioru |
Przykładowa zawartość żądania (JSON):
{
"id": "ORD-2025-0001",
"customId": "ZAM-INT-98765",
"status": "processing",
"created": "2025-10-22T10:15:30.123Z",
"currency": "PLN",
"modified": "2025-10-22T11:00:00.000Z",
"discountTotal": 20.00,
"discountTax": 4.60,
"shippingTotal": 15.00,
"shippingTax": 3.45,
"productsTotalNet": 550.00,
"productsTotalTax": 126.50,
"customerId": "CUST-00045",
"paymentMethod": "credit_card",
"transactionId": "TXN-ABC123456",
"paid": true,
"completed": "2025-10-22T12:30:00.000Z",
"clientLogin": "jan.kowalski",
"message": "Proszę o dostawę po godzinie 17:00.",
"deliveryType": "kurier",
"invoiceRequired": true,
"voucherTotal": 0.00,
"trackingList": [
{
"name": "Paczka nr 1",
"number": "PL1234567890"
}
],
"items": [
{
"id": "ITM-001",
"name": "Klawiatura mechaniczna RGB",
"quantity": 1,
"price": 349.99,
"priceAfterDiscount": 329.99,
"totalPrice": 329.99,
"totalTax": 75.90,
"unit": "szt.",
"sku": "KB-RGB-001",
"type": "ITEM",
"offerId": "OFFER-9988",
"digital": false
},
{
"id": "ITM-002",
"name": "Mysz bezprzewodowa",
"quantity": 2,
"price": 129.50,
"priceAfterDiscount": 120.00,
"totalPrice": 240.00,
"totalTax": 55.20,
"unit": "szt.",
"sku": "MYSZ-WL-002",
"type": "ITEM",
"offerId": "OFFER-8877",
"digital": false
},
{
"id": "ITM-003",
"name": "Opłata manipulacyjna",
"quantity": 1,
"price": 10.00,
"totalPrice": 10.00,
"totalTax": 2.30,
"unit": "usługa",
"type": "HANDLING_FEE",
"digital": false
}
],
"billing": {
"firstName": "Jan",
"lastName": "Kowalski",
"company": "Firma Kowalski Sp. z o.o.",
"address1": "ul. Lipowa 10",
"address2": "lok. 3",
"city": "Warszawa",
"state": "Mazowieckie",
"postcode": "00-123",
"country": "PL",
"email": "jan.kowalski@example.com",
"phone": "+48123456789",
"regon": "012345678",
"nip": "4166555715"
},
"shipping": {
"firstName": "Jan",
"lastName": "Kowalski",
"company": "",
"address1": "ul. Długa 25",
"address2": "",
"city": "Warszawa",
"state": "Mazowieckie",
"postcode": "00-456",
"country": "PL",
"email": "jan.kowalski@example.com",
"phone": "+48123456789"
},
"pickupPoint": {
"method": "InPost",
"externalId": "PL1234PNT001",
"name": "Paczkomat WAW123A",
"description": "Punkt odbioru przy Biedronce",
"street": "ul. Długa 25",
"zipCode": "00-456",
"city": "Warszawa",
"countryCode": "PL"
}
}
Copyright 2001-2025 ifirma.pl