API – Dodawanie produktów

API Dla Dystrybutora
by Michał Jaworski API, Dla Dystrybutora

Endpoint /product służy do tworzenia nowych kartotek produktów.

Specyfikacja POST

Request

HTTP POST https://drinks2cash.com/api/product

Authorization: <api_key_dystrybutora>

Content-Type: multipart/form-data;

W form-data należy przekazać:

  • name – wymagane – string(1024) – nazwa produktu w tym zawartość procentowa oraz pojemność w ml np. Jack Daniels 40% 700ml
  • brand- wymagane – integer lub string(40) – marka, typ wyliczeniowy, numer marki z listy dotepnej pod endpointem /api/enum/brand, jeśli nie ma tej marki na liście możesz wpisać markę słownie zamiast id
  • ean- wymagane – string (same liczby)- ean
  • sku – string – identyfikator produktu w twoim systemie
  • packages[] – wymagane – integer lub tablica integerów – rodzaj opakowania, np. 4 szt., 12 szt, typ wyliczeniowy – numer dostępny pod endpointem /api/enum/package, proszę podać wszystkie dostępne opakowania
  • weight – float, waga w kg
  • concession_type – wartości A,B lub C lub pustą wartość, jeśli produkt nie wymaga koncesji – rodzaj koncesji na alkohol
  • description – text – opis produktu (max .10240 znaków)
  • short_description – string(1024) – jeśli masz w systemie krótki opis, prześlij go w tym polu
  • pictures[] – binary (file) – zdjęcia produktu, max 5 MB jedno, JPEG PNG, multifile
  • categories[] – wymagane – tablica z integer lub string – typ wyliczeniowy, dostępny pod endpointem /api/enum/category jeśli uważasz, że nie ma tam twojej kategorii to wpisz słownie, proszę podać wszystkie id które dotyczą produktu
  • attachments[] – binary (file) – załączniki do produktu, PDF max 10 MB jeden
  • capacity – integer – pojemność, typ wyliczeniowy dostępny pod endpoitem /api/enum/category, prześlij numer z listy lub puste pole
  • percent_of_alcohol – integer – procent alkoholu, typ wyliczeniowy dostępny pod endpoitem /api/enum/percent_of_alcohol, prześlij numer z listy lub puste pole
  • vat – stawka vat spośród: 23, 8, 7, 5, 4, 0

Swój api_key znajdziesz na stronie: https://drinks2cash.com/order/admin-importer

Responses

HTTP 200 – OK

Body:

{
    "code": 201,
    "reasonPhrase": "Created",
    "data": "Created"
}

Operacja zakończona sukcesem. Poczekaj teraz, aż moderator Drinks2cash sprawdzi wprowadzone dane i zatwierdzi produkt.

HTTP 403 – Forbidden

Body:

{
    "code": 403,
    "reasonPhrase": "Forbidden",
    "data": "Unauthorised"
}

Nie zidentyfikowano użytkownika. Sprawdź, czy podałeś poprawne api_key, znajdziesz je w swoim panelu administracyjnym w zakładce https://drinks2cash.com/order/admin-importer

HTTP 400 – Bad request

Błędne parametry żądania. Jeśli wprowadzone przez Ciebie dane są niepoprawne otrzymasz komunikat ze szczegółową informacją.

Przykład:

{
    "code": 400,
    "reasonPhrase": "Bad Request",
    "message": {
        "ean": {
            "notDigits": "Podana wartość może zawierać tylko cyfry"
        },
        "sku": {
            "recordFound": "SKU already exists"
        },
        "weight": {
            "callbackValue": "Weight must be numeric"
        },
        "concession_type": {
            "notInArray": "Only A,B,C are allowed"
        },
        "pictures": {
            "callbackValue": "Only JPEG and PNG files, max 10 MB are allowed"
        },
        "categories": {
            "callbackValue": "Category must be a number or a string up to 20 chars"
        },
        "vat": {
            "notInArray": "Invalid VAT value. Allowed values: 23, 8, 7, 5, 4, 0"
        }
    }
}