Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterTypeDescriptionValidation
receiverReceiverForm

Parcel recipient's data.

The attribute is required.

• if a courier service offer is to be presented, specify at least receiver.company_name and/or receiver.first_name and receiver.last_name and the address object,
if a parcel station offer is to be presented, provide receiver.phone number and receiver.email,
• providing all data will allow both types of offers to be presented.
• if "sms", or "email" are given in additional_services, then it is likewise required to specify phone, or email
• if the is return == true attribute is provided, the receiver attribute will not be required

senderSenderFormParcel sender's data.

The attribute is not required.

• If no data are provided, the data of the organization under which the shipment is being created will be used by default.

parcelsArray[ParcelsSimpleForm]

Data of the parcels included in the shipment.

  • The attribute is required.
    • Collection minimum 1, maximum 1000

custom_attributesCustomAttributesForm

Additional shipment attributes.

The attribute is not required.

• The list of additional attributes has been described in the introduction.
• It is required to specify the parcel station in the case of a parcel station shipment.

codCodFormCollection amount.

The attribute is not required.

• Attribute validation and required provision are defined at the time of providing the service.

insuranceInsuranceFormShipment insurance amount.

The attribute is not required.

• Attribute validation and required provision are defined at the time of providing the service.

referenceStringAdditional shipment description, e.g. order number.

The attribute is not required.
• Minimum 3 characters, maximum 100 characters, possibility to provide an empty attribute.

is_returnBoolDetermines the shipment as a return shipment.

The attribute is not required.

• Acceptable values (true, false)
• Possibility to provide an empty attribute.
• If set to true, specifies the shipment as a return shipment. In such situation, the places of the sender's and the recipient's data will be automatically switched.

additional_servicesArray[String]

Additional services.
Available additional services: sms, e mail, saturday.

API X Rozmiary i usługi dla przesyłekSizes and services for shipments 

The attribute is not required.

• Attribute validated at the time of providing the value.
• 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
StringID of the broker generating shipments within a different organizationThe attribute is not required.
only_choice_of_offerBoolean

Setting the parameter to true makes the offer in all shipments being selected for the stated service, but it will not be automatically paid. Such shipment has to be paid for before the end of the offer's validity term by completing the operations(Paying for shipment). 

This parameter can also be set separately for each shipment (in such
case the parameter set in the shipment has a higher priority).

The attribute is not required.

• Default value false

mpkStringName of cost center.

The attribute is not required.

• maximum 255 characters
• if the attribute is specified, we verify whether it belongs to the organization which the request is made from
• possibility to provide an empty attribute
The cost center must first be added to the organization in order to assign it to the shipment.


commentsStringAny comment

The attribute is not required.

• maximum 100 characters
• possibility to provide an empty attribute

...