Create multiple deliveries
POST/standard/deliveries
This endpoint is meant to be used for creating multiple deliveries at once in our Platform to then be processed and dispatched by a fleet.
Request
Header Parameters
Default value: Bearer <token>
Default value: application/json
- application/json
Body
arrayrequired
- Array [
- ]
City for the dropoff - destination city
Receiver's email who is addressed the package/s to. This field can be used by SiG or the Fleet to provide certain notifications to the receiver
Receiver's firstname who is addressed the package/s to
Receiver's lastname who is addressed the package/s to
Receiver's postalcode where the package/s will be dropped off
Receiver's streetname where the package/s will be dropped off
This field represents the Delivery ID from the Sender's side which usually represents the Order Id of the purchase. This ID will be used for the driver to recognize the package and the destination
If a good is considered hazardous and needs special treatment then we advise to set this as true
The depth in cm of the parcel. Maximum integer length of 4 and maximum of 2 decimal places
Comments while dropping off the package/s - i.e. please enter the red gateway and turn left
Company name in case is a B2B delivery or parcel needs to be dropped at the customer's workplace
If the agreement allows this service, this field will indicate what's the neighbour's name designated by the customer
Receiver's phone who is addressed the package/s to. Be aware that this field can be used by SiG or the Fleet to provide certain notifications via SMS or WhatsApp
If the agreement allows this service, this field will indicate what's the safeplace designated by the customer
Receiver's streetnumber where the package/s will be dropped off
Receiver's what3words encoded location where the package/s will be dropped off
The height in cm of the parcel. Maximum integer length of 4 and maximum of 2 decimal places
The length in cm of the parcel. Maximum integer length of 4 and maximum of 2 decimal places
Possible values: <= 255 characters
Arbitrary metadata that is either an object or a string
Quantity of parcels within this delivery. By default is 1
Type of delivery service. Keep in mind every service has a different price and different terms
Field to use in order to group a sequence of deliveries that shall be combined
Flag for testing while implementing, this will prevent to be sent to the real fleet and remain in the Sandbox. It's only meant to be used for integration purposes
If the volume of the parcel is known from the Sender's side, it is recommended to be provided. It is expected to be in cm³
Field to host the weight of the delivery when is known. The standard units are kg
Responses
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
- example-200
Schema
- Array [
- ]
- Array [
- ]
Possible values: non-empty
valid object[]required
City for the dropoff - destination city
Receiver's email who is addressed the package/s to. This field can be used by SiG or the Fleet to provide certain notifications to the receiver
Receiver's firstname who is addressed the package/s to
Receiver's lastname who is addressed the package/s to
Receiver's postalcode where the package/s will be dropped off
Receiver's streetname where the package/s will be dropped off
Receiver's streetnumber where the package/s will be dropped off
Name of the drop-off city of delivery.
deliveries object[]required
This is the ID reference from the sender. It is used normally as mapping between both platforms.
SiG Internal ID
This is the unique link identifier for a customer to access our Customer Portal. This portal allows the customer to modify the delivery.
{
"status": "string",
"valid": [
{
"dropoff_city": "string",
"dropoff_email": "string",
"dropoff_firstname": "string",
"dropoff_lastname": "string",
"dropoff_postalcode": "string",
"dropoff_streetname": "string",
"dropoff_streetnumber": "string",
"sender_external_id": "string"
}
],
"deliveries": [
{
"sender_external_id": "string",
"id": "string",
"public_link": "string"
}
],
"invalid": [
{}
],
"failures": [
{}
]
}
{
"status": "ok",
"deliveries": [
{
"sender_external_id": "111test",
"id": "DEYDRHWNZGT97KF8",
"public_link": "https://dashboard.sendit.green/tracking?public_id=DEYDRHWNZGT97KF8&postalcode=48155"
},
{
"sender_external_id": "222test",
"id": "DE97QA8ABBKEHG99",
"public_link": "https://dashboard.sendit.green/tracking?public_id=DE97QA8ABBKEHG99&postalcode=48155"
}
],
"valid": [
{
"dropoff_city": "Münster",
"dropoff_email": "test@example.com",
"dropoff_firstname": "Test",
"dropoff_lastname": "Smith",
"dropoff_postalcode": "48155",
"dropoff_streetname": "Hafenweg",
"dropoff_streetnumber": "16",
"sender_external_id": "111test"
},
{
"dropoff_city": "Münster",
"dropoff_email": "test@example.com",
"dropoff_firstname": "Test",
"dropoff_lastname": "Smith",
"dropoff_postalcode": "48155",
"dropoff_streetname": "Hafenweg",
"dropoff_streetnumber": "16",
"sender_external_id": "222test"
}
],
"invalid": [],
"failures": []
}
Bad Request
- application/json
- Schema
- Example (from schema)
- example-400
Schema
Possible values: non-empty
{
"error": true,
"message": "string"
}
{
"error": true,
"message": "missing the following fields: dropoff_firstname, dropoff_lastname"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- example-500
Schema
Possible values: non-empty
{
"error": true,
"message": "string"
}
{
"error": true,
"message": "Internal error, please contact support@sendit.green"
}