Znikające Pole DESCRIPTION

Opis problemu

Występuje problem z polem "description" w zapytaniu do REST API. Pole to nie jest procesowane dalej, co skutkuje błędem przy wysyłce za pomocą Pocztexu.

Komenda

Komenda, która powoduje ten problem to:

{{baseUrl}}/shipment-management/shipments/create-commands

Request

Zapytanie do REST API ma następujący format:

{
  "input": {
    "deliveryMethodId": "c3066682-97a3-42fe-9eb5-3beeccab840c",
    "sender": {
      "street": "Główna 310",
      "streetNumber": "30",
      "city": "Warszawa",
      "countryCode": "PL",
      "postalCode": "10-200",
      "email": "email@mail.com",
      "phone": "500600700",
      "name": "Jan Kowalski",
      "company": "Allegro.pl sp. z o.o.",
      "state": "AL",
      "point": "A1234567"
    },
    "receiver": {
      "street": "Główna 30",
      "streetNumber": "30",
      "city": "Warszawa",
      "countryCode": "PL",
      "postalCode": "10-200",
      "email": "email@mail.com",
      "phone": "500600700",
      "name": "Jan Kowalski",
      "company": "Allegro.pl sp. z o.o.",
      "state": "AL",
      "point": "A1234567"
    },
    "packages": [
      {
        "height": {
          "value": 12,
          "unit": "CENTIMETER"
        },
        "length": {
          "value": 12,
          "unit": "CENTIMETER"
        },
        "type": "PALLET",
        "weight": {
          "value": 12.45,
          "unit": "KILOGRAMS"
        },
        "width": {
          "value": 12,
          "unit": "CENTIMETER"
        }
      },
      {
        "height": {
          "value": 12,
          "unit": "CENTIMETER"
        },
        "length": {
          "value": 12,
          "unit": "CENTIMETER"
        },
        "type": "PACKAGE",
        "weight": {
          "value": 12.45,
          "unit": "KILOGRAMS"
        },
        "width": {
          "value": 12,
          "unit": "CENTIMETER"
        }
      }
    ],
    "credentialsId": "c9e6f40a-3d25-48fc-838c-055ceb1c5bc2",
    "pickup": {
      "street": "Główna 30",
      "streetNumber": "30",
      "city": "Warszawa",
      "countryCode": "PL",
      "postalCode": "10-200",
      "email": "email@mail.com",
      "phone": "500600700",
      "name": "Jan Kowalski",
      "company":Allegro.pl sp. z o.o.",
      "state": "AL",
      "point": "A1234567"
    },
    "referenceNumber": "abcd1234",
    "description": "",  // pole to nie jest procesowane dalej
    "insurance": {
      "amount": "23.47",
      "currency": "PLN"
    },
    "cashOnDelivery": {
      "amount": "2.50",
      "currency": "PLN",
      "ownerName": "Jan Kowalski",
      "iban": "PL48109024022441789739167589"
    },
    "labelFormat": "ZPL",
    "additionalServices": [
      "ADDITIONAL_HANDLING",
      "ADDITIONAL_HANDLING"
    ],
    "additionalProperties": {
      "adipisicing0": "sed ut Lorem"
    }
  },
  "commandId": "14e142cf-e8e0-48cc-bcf6-399b5fd90b33"
}

Błąd

Błąd, który występuje przy wysyłce za pomocą Pocztexu to:

"errors":[{"code":"VALIDATION_ERROR","message":"Parcel description is empty","details":"","path":"description","userMessage":"Shipment description cannot be empty"}]

Rozwiązanie

Aby rozwiązać ten problem, należy dodać wartość do pola "description" w zapytaniu do REST API.

Przykładowy kod:

{
  "input": {
    "deliveryMethodId": "c3066682-97a3-42fe-9eb5-3beeccab840c",
    "sender": {
      "street": "Główna 310",
      "streetNumber": "30",
      "city": "Warszawa",
      "countryCode": "PL",
      "postalCode": "10-200",
      "email": "email@mail.com",
      "phone": "500600700",
      "name": "Jan Kowalski",
      "company": "Allegro.pl sp. z o.o.",
      "state": "AL",
      "point": "A1234567"
    },
    "receiver": {
      "street": "Główna 30",
      "streetNumber": "30",
      "city": "Warszawa",
      "countryCode": "PL",
      "postalCode": "10-200",
      "email": "email@mail.com",
      "phone": "500600700",
      "name": "Jan Kowalski",
      "company": "Allegro.pl sp. z o.o.",
      "state": "AL",
      "point": "A1234567"
    },
    "packages": [
      {
        "height": {
          "value": 12,
          "unit": "CENTIMETER"
        },
        "length": {
          "value": 12,
          "unit": "CENTIMETER"
        },
        "type": "PALLET",
        "weight": {
          "value": 12.45,
          "unit": "KILOGRAMS"
        },
        "width": {
          "value": 12,
          "unit": "CENTIMETER"
        }
      },
      {
        "height": {
          "value": ,
          "unit": "CENTIMETER"
        },
        "length": {
          "value": 12,
          "unit": "CENTIMETER"
        },
        "type": "PACKAGE",
        "weight": {
          "value": 12.45,
          "unit": "KILOGRAMS"
        },
        "width": {
          "value": 12,
          "unit": "CENTIMETER"
        }
      }
    ],
    "credentialsId": "c9e6f40a-3d25-48fc-838c-055ceb1c5bc2",
    "pickup": {
      "street": "Główna 30",
      "streetNumber": "30",
      "city": "Warszawa",
      "countryCode": "PL",
      "postalCode": "10-200",
      "email": "email@mail.com",
      "phone": "500600700",
      "name": "Jan Kowalski",
      "company": "Allegro.pl sp. z o.o.",
      "state": "AL",
      "point": "A1234567"
    },
    "referenceNumber": "abcd1234",
    "description": "Opis przesyłki",  // dodano wartość do pola "description"
    "insurance": {
      "amount": "23.47",
      "currency": "PLN"
    },
    "cashOnDelivery": {
      "amount": "2.50",
      "currency": "PLN",
      "ownerName": "Jan Kowalski",
      "iban": "PL48109024022441789739167589"
    },
    "labelFormat": "ZPL",
    "additionalServices": [
      "ADDITIONAL_HANDLING",
      "ADDITIONAL_HANDLING"
    ],
    "additionalProperties": {
      "adipisicing0": "sed ut Lorem"
    }
  },
  "commandId": "14e142cf-e8e0-48cc-bcf6-399b5fd90b33"
}

Podsumowanie

Pole "description" w zapytaniu do REST API nie jest procesowane dalej, co skutkuje błędem przy wysyłce za pomocą Pocztexu. Aby rozwiązać ten problem, należy dodać wartość do pola "description" w zapytaniu do REST API.

Czym jest znikające pole DESCRIPTION?

Znikające pole DESCRIPTION to problem, który występuje w zapytaniach do REST API, gdzie pole "description" nie jest procesowane dalej. Skutkiem tego jest błąd przy wysyłce za pomocą Pocztexu.

Dlaczego pole "description" nie jest procesowane dalej?

Pole "description" nie jest procesowane dalej, ponieważ nie ma wartości w nim. Wartość musi być dodana do pola "description" w zapytaniu do REST API.

Jak dodać wartość do pola "description"?

Wartość do pola "description" można dodać w następujący sposób:

{
  "input": {
    ...
    "description": "Opis przesyłki",
    ...
  }
}

Czy pole "description" jest wymagane?

Tak, pole "description" jest wymagane. Jeśli nie ma wartości w nim, to skutkuje błędem przy wysyłce za pomocą Pocztexu.

Jak uniknąć błędu przy wysyłce za pomocą Pocztexu?

Aby uniknąć błędu przy wysyłce za pomocą Pocztexu, należy dodać wartość do pola "description" w zapytaniu do REST API.

Czy pole "description" jest dostępne w innych środowiskach?

Tak, pole "description" jest dostępne w innych środowiskach, takich jak środowisko testowe i środowisko produkcyjne.

Jak dodać wartość do pola "description" w innych środowiskach?

Wartość do pola "description" można dodać w następujący sposób w innych środowiskach:

{
  "input": {
    ...
    "description": "Opis przesyłki",
    ...
  }
}

Czy pole "description" jest zalecane?

Tak, pole "description" jest zalecane. Wartość w nim powinna być dodana, aby uniknąć błędu przy wysyłce za pomocą Pocztexu.

Jak dodać wartość do pola "description" w przypadku błędu?

W przypadku błędu, wartość do pola "description" można dodać w następujący sposób:

{
  "input": {
    ...
    "description": "Opis przesyłki",
    ...
  }
}

Czy pole "description" jest dostępne w innych językach?

Tak, pole "description" jest dostępne w innych językach, takich jak język polski i język angielski.

Jak dodać wartość do pola "description" w innych językach?

Wartość do pola "description" można dodać w następujący sposób w innych językach:

{
  "input": {
    ...
    "description":Opis przesyłki",
    ...
  }
}

Czy pole "description" jest zalecane w innych językach?

Tak, pole "description" jest zalecane w innych językach. Wartość w nim powinna być dodana, aby uniknąć błędu przy wysyłce za pomocą Pocztexu.