Creating a shipment in the simplified mode

receiver

Receiver

Receiver details

The attribute is required.

• In case of a courier service offer (inpost_courier_c2c included), at least receiver.phone_number, receiver.company_name and/or receiver.first_name and receiver.last_name and address  object should be provided

• In case of parcel locker service offer receiver.phone_number and receiver.email  should be provided

• Providing all the data will allow both types of offers to be presented

• In case of is_return = true, Attribute receiver is not required

sender

Sender

Sender details.

The attribute is optional.

• If no data is provided, the organization data for which the shipment is created will be used by default

parcels

Array[ParcelsSimple]

Details of parcels in the shipment.

The attribute is required.

• Minimum length - 1, maximum length - 1000

custom_attributes

CustomAttributes

Additional shipment attributes, e.g.

"custom_attributes": {
"target_point": "KRA010"
}

The attribute is optional.

• The list of available custom attributes has been described in Shipment.

• Specifying a target point is required in case of a parcel locker service.

cod

Cod

Cash collection amount.

The attribute is optional.

• Attribute validation and requirement is defined at the time of providing a service.

insurance

Insurance

Shipment insurance amount.

The attribute is required for the following services:
inpost_courier_standard, inpost_courier_express_1000, inpost_courier_express_1200, inpost_courier_express_1700, inpost_courier_palette, inpost_letter_allegro, inpost_courier_allegro, inpost_courier_c2c when passing the COD attribute.

• Attribute validation and requirement is defined at the time of providing a service.

reference

String

Additional shipment description, e.g. order number.

The attribute is optional.

• Minimum length - 3, maximum length - 100, can be empty.

is_return

Bool

Determines whether the shipment is a return shipment.

The attribute is optional.

• Available values (true, false)

• Can be empty.

• If true, marks the shipment as a return shipment. In this case the recipient and sender details will be swapped automatically.

service

String

Selected service.

Available services: Shipment sizes and services

The attribute is required.

additional_services

Array[String]

Additional services.

Available additional services: sms, email, saturday. Shipment sizes and services

The attribute is optional.

• Attribute validated once value is provided.

• When the additional_services  attribute is provided, the system checks the service  attribute provision, if the service  attribute is not provided or the additional_services  attribute does not fit in the scope of the service  provided, the user will get an error.

external_customer_id 

String

ID of the broker generating shipments within a different organization.

The attribute is optional.

only_choice_of_offer

Bool

Setting the parameter to true results in the offer being selected for the given service but not being paid for. The shipment has to be paid for before the offer expiry. Paying for shipment

The attribute is optional.

• Default false 

mpk

String

Name of cost center.

The attribute is optional.

• Maximum length - 255

• If the attribute is specified, we verify whether it belongs to the organization which the request is made from

• Can be empty

The cost center must first be added to the organization in order to assign it to the shipment.

comments

String

Any comment

The attribute is optional.

• Maximum length - 100

• Minimum lenght - 3

• Can be empty