To zapytanie tworzy zadanie utworzenia zamówienia i po wstępnej walidacji parametrów zwraca odpowiedź. Numer zamówienia oraz jego identyfikator (ID) nie są jeszcze znane na tym etapie, dlatego nie są zwracane.


POST https://{Adres_serwera_IIS:Port}/api/ExtensionsController/CreateOrder


Parametry:

RequestId

Wymagany

Identyfikator zapytania, po nim będzie można odpytywać bramkę o status realizacji zadania utworzenia zamówienia.

Int

ContractorId

Wymagany

Id Kontrahenta z bazy Wapro Mag, na którego ma zostać wystawione zamówienie.

Int

UserId

Wymagany

Id użytkownika z bazy Wapro Mag, który wystawia dokument zamówienia.

Int

ClientOrderNumber

Opcjonalny

Numer zamówienia w systemie klienta.

Tekst(30)

Comments

Opcjonalny

Uwagi do zamówienia, które zostaną skopiowane na stworzone zamówienie.

Tekst(100)


Lista obiektów „Positions”

Obiekt Position posiada następujące parametry:

ArticleId

Wymagane

Id artykułu wzorcowego z bazy Wapro Mag, na podstawie którego chcemy sparametryzować nasz produkt.

Int

ArticleVariantId

Opcjonalne

Id wariantu artykułu wzorcowego z bazy Wapro Mag jeżeli artykuł ma wiele wariantów można wskazać konkretny. W przypadku niewskazania - produkt tworzony jest na bazie wariantu domyślnego.

Int

Description

Opcjonalne

Tekst który zostanie skopiowany w pole opis pozycji, na danej pozycji wygenerowanego zamówienia.

Tekst(500)

Quantity

Wymagane

Ilość danego produktu na pozycji zamówienia.

Decimal


Lista obiektów „ArticleParameters”

Obiekt ArticleParameter ma następujące parametry:

Name

Wymagany

Nazwa parametru produktu.

Tekst

QuantityValue

Wymagany jeżeli parametr jest typu ilościowego

Ilość danego parametru.

Decimal

DictionaryValue

Wymagany jeżeli parametr jest typu słownikowego

Wartość słownika (tekstowa).

Tekst

ArticleId

Wymagany jeżeli parametr jest typu „wyróżnik”

Id artykułu wyróżnika.

Int


Przykładowe zapytanie:

curl --location 'https://localhost:44010/ProGate/api/ExtensionsController/CreateOrderAsync' \

--header 'Content-Type: application/json' \

--header 'Authorization: Bearer b3fy9qvg1DOBJCeOcny-KoczOliK369gevHjy_ekhjhVHtLYKnC1Lq8dzHTpaEv9w5VSBrC5M0fR08VJawl-rxIuNsDripI24l4SBSxmB1D5ZPWXGYW5nAZLkx8Mo3cOQ_R26fTABng7E8RMq6Hbev6CWungqFmK9W4VuPsh2qbvve1hozwHhPC1fGs39QWmuBF4yx2WRcwWPJtOAJ7hB7K3KFsowzdTb50Jjkc7Z2_PpNp03pQ4fWTYqQlwkBdiuWWEhgGOtwNsvnPnG3EHkl9C85FPGLAR7bmKkZR8ADw' \

--data '{

    "ContractorId": 5378,

    "UserId": 3000126,

    "ClientOrderNumber": "test",

    "Comments": "test",

    "RequestId":1,

    "Positions": [

        {

            "ArticleId": 4007927,

            "Quantity": 1,

            "ArticleParameters":  [

        {"Name":"SZEROKO\u015a\u0106","QuantityValue":160},

        {"Name":"WYSOKO\u015a\u0106","QuantityValue":70.700000000000003},

        {"Name":"TKANINA","ArticleId":4071446,"QuantityValue":1},

        {"Name":"KOLOR_CZARNY","QuantityValue":1},

        {"Name":"UCHWYT_OBS\u0141UGI_INNY_KOLOR","ArticleId":3917837,"QuantityValue":1},

        {"Name":"NR_TKANINY","QuantityValue":"101"}

        ]

        }

    ]

}'


Przykładowa odpowiedź:

{

    "IsFailure": false,

    "IsSuccess": true,

    "Message": "Sukces",

    "Error": null,

    "Value": {

        "Status": "W trakcie",

        "StatusCode": "InProgress",

        "OrderNumber": null,

        "OrderId": null,

        "ClientOrderNumber": "test",

        "Error": ""

    }

}


Parametry odpowiedzi:

Status

Słowny opis statusu utworzenia zamówienia („W trakcie”, „Utworzone”, „Błąd”).

Tekst(30)

StatusCode

Kod statusu utworzenia zamówienia („InProgress”, „Created”, „Error”).

Tekst(30)

OrderNumber

Numer zamówienia wygenerowanego w bazie Wapro Mag.

Tekst(30)

OrderId

Id zamówienia wygenerowanego w bazie Wapro Mag.

Int

ClientOrderNumber

Numer zamówienia w systemie klienta.

Tekst(30)

Error

Treść błędu.

Tekst(max)


Przykładowy błąd:

{

    "IsFailure": true,

    "IsSuccess": false,

    "Message": null,

    "Error": "Nie przekazano parametru 'RequestId'.",

    "Value": null

}