Zastosowanie

Endpoint /order-document służy do dodawania dokumentu do zamówienia.

Specyfikacja POST - dodawanie dokumentu

Request

HTTP POST https://drinks2cash.com/api/order-document Authorization: <api_key_dystrybutora> Content-Type: multipart/form-data; W form-data należy przekazać:

• file - binary - wymagane
• order_id - bigint - numer zamówienia - wymagane
• document_type - string - typ dokumentu - wymagane
• inform_client - boolean - jeśli true klient zostanie poinformowany o nowym dokumencie standardowym e-mailem systemowym oraz notyfikacją w panelu klienta "Moje konto"

Możliwe wartości dla document_type to:

PRO_FORM_INVOICE - faktura pro forma
INVOICE - faktura
CORRECTING_INVOICE - faktura korygująca
SHIPPING_LIST - list przewozowy
MISC - inne

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

Responses

HTTP 201 - Created Body:

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

HTTP 403 - Forbidden Kod 403 to błąd autoryzacji. 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. Przykład:

{
    "code": 400,
    "reasonPhrase": "Bad Request",
    "message": {
        "order_id": {
            "noRecordFound": "Order not found"
        },
        "document_type": {
            "notInArray": "Invalid document type, acceptable values are: PRO_FORMA_INVOICE, INVOICE, CORRECTING_INVOICE, SHIPPING_LIST, MISC"
        },
        "inform_client": {
            "notInArray": "Value must be a boolean"
        }
    }
}