| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer zW19Z19Lg93DkIHYbz9U7Z2zjwjTKeUaplJ1Ae1OUUM9COT2UgpHHvAAET_PZ8yC3U5qcG8mMtjWNjay2yEnHBvjBzPapXsyMroQLe1Er6HSeCWgwuQik8gq04LmtgfJbrVKWApPRRsJ1GGqeyZfHIrJ8VnVqKUjITFYy93zk1Q9eCQyN x0Dpby16p1k0eDA5Zo8T169ZTxrj4zS6azrp8haSaqK0KYLXYdwETEPNZgW4YZ677nqMHTz0u5K8ijGD3eOQZhvNjljqYpjgh86zyxd6eqCKD79r4T4rrqc |
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerNumber | customer number for getting data of pickup dates | string | Required |
| PickupDate | As of this date the service will offer dates | date | |
| CityCode | City code of package location | int | Required |
| StreetCode | Street code of package location | string | Required |
| ServiceType | Type of collection service | string | |
| DifferentCustomerAddress | Is collection address different from customer address | boolean | |
| PackageReady | Indicates if the package is ready | boolean | |
| OverrideFutureTime | Do not collect the package before this time | int | optional |
| CityName | City name of package location | string | Required |
| StreetName | Street name of package location | String | Required |
| Domestic | Is domestic. True when ServiceType = 31 | Bool | Required |
| HolidayServiceType | The requested service.Pickup = 1, Delivery = 2 |
number | Required |
Body Parameters
None
Response Information
| Name | Description | Type | Additional information |
|---|---|---|---|
| Dates | Date to pass GetDateTimes | Array of date , in type IdTitleModel. See details below | None. |
| ErrorMessage | Message returning from service if was an error | string | None. |
IdTitleModel:
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | Date to pass GetDateTimes | string | None. |
| Title | Full date | string | None. |
Response Formats:
Sample:
{
"Dates": [
{
"Id": "06/11/2019",
"Title": "יום רביעי - 06/11/2019"
},
{
"Id": "07/11/2019",
"Title": "יום חמישי - 07/11/2019"
},
{
"Id": "08/11/2019",
"Title": "יום שישי - 08/11/2019"
},
{
"Id": "10/11/2019",
"Title": "יום ראשון - 10/11/2019"
},
{
"Id": "11/11/2019",
"Title": "יום שני - 11/11/2019"
}
],
"ErrorMessage": "string"
}
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer zW19Z19Lg93DkIHYbz9U7Z2zjwjTKeUaplJ1Ae1OUUM9COT2UgpHHvAAET_PZ8yC3U5qcG8mMtjWNjay2yEnHBvjBzPapXsyMroQLe1Er6HSeCWgwuQik8gq04LmtgfJbrVKWApPRRsJ1GGqeyZfHIrJ8VnVqKUjITFYy93zk1Q9eCQyN x0Dpby16p1k0eDA5Zo8T169ZTxrj4zS6azrp8haSaqK0KYLXYdwETEPNZgW4YZ677nqMHTz0u5K8ijGD3eOQZhvNjljqYpjgh86zyxd6eqCKD79r4T4rrqc |
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CityName | City name of package location | string | Required |
| StreetName | Street name of package location | string | Required |
| ServiceType | 31 – domestic, 1- early express (export), 5 – late express (export) | String | Required |
| Domestic | Is domestic. True when ServiceType = 31 | Bool | Required |
| SelectedDay | One of the dates returned from GetPickupDates | string | Required |
Body Parameters
None
Response Information
| Name | Description | Type | Additional information |
|---|---|---|---|
| FromTime | Range start time | string | None. |
| ToTime | Range end time | string | None. |
| ServiceType | 31 – domestic, 1- early express (export), 5 – late express (export) | number | |
| Free | Indicated if this range is free or can have additional chrages | bool | |
| SelectedDay | One of the dates returned from GetPickupDates | string |
Response Formats:
Sample:
[
{
"FromTime": "08:00",
"ToTime": "16:50",
"ServiceType": 1,
"Free": false
},
{
"FromTime": "08:00",
"ToTime": "18:00",
"ServiceType": 5,
"Free": false
}
]
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer zW19Z19Lg93DkIHYbz9U7Z2zjwjTKeUaplJ1Ae1OUUM9COT2UgpHHvAAET_PZ8yC3U5qcG8mMtjWNjay2yEnHBvjBzPapXsyMroQLe1Er6HSeCWgwuQik8gq04LmtgfJbrVKWApPRRsJ1GGqeyZfHIrJ8VnVqKUjITFYy93zk1Q9eCQyN x0Dpby16p1k0eDA5Zo8T169ZTxrj4zS6azrp8haSaqK0KYLXYdwETEPNZgW4YZ677nqMHTz0u5K8ijGD3eOQZhvNjljqYpjgh86zyxd6eqCKD79r4T4rrqc |
Request Information:
URI Parameters
None
Body Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Valid email for booking confirmation | string | ||
| ContactPerson | string | Required | |
| OpenBy | User that opened the booking | string | Required |
| Weight | Weight of all pickup packages | decimal | Required |
| ServiceNumber | 31 For Domestic Booking | Required | |
| PackagesNumber | Indicates how many packages will be picked up | decimal | Required |
| IsFlatPlace | Indicate if the cargo is pallete | bool | |
| ConfirmByMail | Email confirmation about booking. True to booking confirmation |
bool | |
| PickupToTime | Valid to time returned from service when calling times | string | Required |
| PickupFromTime | Valid from time returned from service when calling times | string | Required |
| PickupDate | Valid Pickup date returned from service when calling dates | string | Required |
| CustomerInfo | CustomerInfo | Required | |
| PackageType | Package – 2 Pallete - 3 |
number | Required |
CustomerInfo structure
| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerName | The customer name | string | Required |
| CityName | City package/pallete should be picked up | string | Required |
Address stracture
| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerName | The customer name | string | Required |
| CityName | City package/pallete should be picked up | string | Required |
| ContactPerson | The name of contact person ups should contact | string | Required |
| StreetName | Street package/pallete should be picked up | string | Required |
| Phone | 7 digit number | string | Required |
| PhonePrefix | 2-3 digit number | string | Required |
| Mobile | 7 digit number | string | Required |
| MobilePrefix | 3 digit number | string | Required |
| string | Required | ||
| LocationDescription | Additional text for driver | string | |
| HouseNumber | The customer house number | decimal | Required |
| Floor | House floor | decimal | Required |
| RoomNumber | House room | string | Required |
Example Request:
{
"UserOwnerAccount": "string",
"Email": "string",
"ContactPerson": "string",
"OpenBy": "string",
"Weight": 0,
"ServiceNumber": 0,
"PackagesNumber": 0,
"IsFlatPlace": true,
"ConfirmByMail": true,
"PickupToTime": "string",
"PickupFromTime": "string",
"PickupDate": "string",
"CustomerInfo": {
"Address": {
"CustomerID": 0,
"CustomerName": "string",
"CityName": "string",
"CityCode": 0,
"CityCodeMapa": "string",
"ContactPerson": "string",
"StreetCode": "string",
"StreetCodeMapa": "string",
"StreetName": "string",
"Phone": "string",
"PhonePrefix": "string",
"Mobile": "string",
"MobilePrefix": "string",
"LocationDescription": "string",
"Story": "string",
"HouseNumber": "string",
"Floor": "string",
"RoomNumber": "string",
"ContactEmail": "string",
"Area": "string",
"AreaCode": "string",
"IsAccessPoint": true,
"IsResidential": true,
"Index": 0,
"ZipCode": "string",
"Tel": "string",
"Tel2": "string"
},
"CustomerID": 0,
"CreditExportExpress": 0,
"CreditDomestic": 0
},
"PackageType": 0
}
Response Formats:
Sample:
"13312-7356469"
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer zW19Z19Lg93DkIHYbz9U7Z2zjwjTKeUaplJ1Ae1OUUM9COT2UgpHHvAAET_PZ8yC3U5qcG8mMtjWNjay2yEnHBvjBzPapXsyMroQLe1Er6HSeCWgwuQik8gq04LmtgfJbrVKWApPRRsJ1GGqeyZfHIrJ8VnVqKUjITFYy93zk1Q9eCQyN x0Dpby16p1k0eDA5Zo8T169ZTxrj4zS6azrp8haSaqK0KYLXYdwETEPNZgW4YZ677nqMHTz0u5K8ijGD3eOQZhvNjljqYpjgh86zyxd6eqCKD79r4T4rrqc |
Request Information
Request same as Insert booking for Domestic shipment request.
Response Information
| Name | Description | Type | Additional information |
|---|---|---|---|
| BookingNumber | Created booking number | string | |
| Error | When booking not created | string |
Response Formats:
Sample:
{
"BookingNumber": "312312",
"Error": ""
}
Request Information
| Name | Description | Type | Additional information |
|---|---|---|---|
| BookingNumber | Cancelation booking number | long | Required |
| Reason | Cancelation reason text | string | Required |
URI Parameters
None
Example request:
{
"BookingNumber": 0,
"Reason": "string"
}
Response Information
| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccess | Indicate if cancelation completed successfuly | bool | |
| ErrorMessage | Error text returned if any | string |
Response Formats:
Sample:
{
"IsSuccess": "true",
"Error": ""
}