Shipment

Creates a new shipment from the submitted data.

post/rest/api/shipping/shipment/

Request body

carrierAccountIdinteger nullable

Carrier account ID

orderIdstring nullable

Order ID

postDatestring date-time nullable

Post date

methodstring nullable

Shipment methods can be downloaded from <a href='#tag/Shipment/operation/get_rest_shipment_carrier_sending_methods'>Get Carrier sending methods</a>.

Example request

{
  "addressReceiver": {
    "type": "house",
    "name": "Jan Kowalski",
    "streetName": "Kwiatowa",
    "streetNumber": "1",
    "zipCode": "01-001",
    "city": "Warszawa",
    "country": "PL",
    "phone": "48500600700",
    "email": "jan.kowalski@poczta.op.pl"
  },
  "orderId": "MA123456789",
  "postDate": "2024-07-14T13:41:18+00:00",
  "method": "inpost_courier_standard",
  "options": [
    {
      "id": "cod",
      "type": "money",
      "value": {
        "amount": "10000",
        "currency": "PLN"
      }
    }
  ],
  "parcels": [
    {
      "options": [
        {
          "id": "cod",
          "type": "money",
          "value": {
            "amount": "10000",
            "currency": "PLN"
          }
        }
      ]
    }
  ]
}

Response

Returns list of identifiers for created shipments.

Changes

No recorded changes to this endpoint across all 1 revision of this API.