¶ Insert WB ShipmentEX
- Description: This function will create a Domestic Standard Shipment
- Method: Post
- Test Url: https://newbetaapi.ship.co.il/api/v1/shipments/insert-shipment-ex
- Production Url: https://api.ship.co.il/api/v1/shipments/insert-shipment-ex
- Request Header:
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer zW19Z19Lg93DkIHYbz9U7Z2zjwjTKeUaplJ1Ae1OUUM9COT2UgpHHvAAET_PZ8yC3U5qcG8mMtjWNjay2yEnHBvjBzPapXsyMroQLe1Er6HSeCWgwuQik8gq04LmtgfJbrVKWApPRRsJ1GGqeyZfHIrJ8VnVqKUjITFYy93zk1Q9eCQyN x0Dpby16p1k0eDA5Zo8T169ZTxrj4zS6azrp8haSaqK0KYLXYdwETEPNZgW4YZ677nqMHTz0u5K8ijGD3eOQZhvNjljqYpjgh86zyxd6eqCKD79r4T4rrqc |
Request Information
URI Parameters
None
Body Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Weight | Weight of package | double | |
| ShipmentType | See details below | ShipmentType | |
| Reference2 | Reference to private useage | string | |
| Reference1 | Reference to private useage | string | |
| NumberOfPackages | int | Required | Required |
| NumberOfPackagesToReturn | int | ||
| ConsigneeAddress | See details below | PickupAddressModel | Required |
| ShipperAddress | See details below | PickupAddressModel | If UseDefaultShipperAddress is false or not supplied , this property is required. |
| DDO | Direct Delivery Only ensures that a package is delivered to the residential or commercial address you provide. | bool | |
| IsReturn | bool | ||
| UDRValue | Stamping and returning paperwork | long | |
| CODValue | Collection of payment at the time of distribution | double | How much money to collect , in ILS. |
| Instruction | string | ||
| UseDefaultShipperAddress | If true, takes shipper address details from customer card and not from ShipperAddress property. | bool |
ShipmentType stracture
| value | Name |
|---|---|
| 0 | Empty |
| 1 | Letter |
| 2 | Document |
| 3 | NoneDocument |
PickupAddressModel stracture
| Name | Description | Type | Length | Additional information |
|---|---|---|---|---|
| CustomerName | Consignee name. May include a full name of consignee for private person or a company name. | string | 50 | Required |
| CityName | City name in Hebrew | string | 30 | At leaste one of them is required. |
| CityCode | City code of "MAPA" | Long | ||
| ContactPerson | A name of a person for contact | string | 100 | Required |
| StreetCode | Street code from "MAPA" | Long | None | |
| StreetName | Street name in Hebrew | string | 30 | Required |
| Phone | Phone number without separators and Prefix | string | 7 | Required |
| PhonePrefix | Phone Prefix | string | 2-3 |
|
| Mobile | Mobile number without separators and Prefix | string | 7 | Required |
| MobilePrefix | Mobile Prefix | string |
|
|
| LocationDescription | Free text for additional information about target location. Will be used in case of house number alpha numeric | string | 50 | None |
| HouseNumber | House Number | string | 5 | Required |
| Floor | Floor Number | string | 5 | None |
| RoomNumber | Room Number | string | 5 | None |
| ContactEmail | Consignee Email | string | For Example:test@gmail.com | |
| ZipCode | Zip Code | string | 7 | None |
| Tel | String | |||
| Tel2 | string |
Example Request:
{
"ShipmentType": 0,
"IsCDO": true,
"Reference2": "string",
"Reference1": "string",
"NumberOfPackages":1,
"NumberOfPackagesToReturn": 0,
"ConsigneeAddress": {
"CustomerName": "string",
"CityName": "תל אביב",
"ContactPerson": "string",
"StreetCode": "string",
"StreetName": "string",
"Phone": "0504570842",
"PhonePrefix": "+972"
},
"ShipperAddress": {
"CustomerName": "string",
"CityName": "תל אביב",
"ContactPerson": "string",
"StreetCode": "string",
"StreetName": "string",
"Phone": "0504570842",
"PhonePrefix": "+972",
"HouseNumber": "55"
},
"DDO": true,
"PickupPointID": "string",
"IsReturn": true,
"IsDefault": true
}
Response Information
| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | InsertWbShipmentResultModel | None | |
| WbResult | WbShipmentReducedResultModel | None |
InsertWbShipmentResultModel stracture
| Name | Description | Type | Additional information |
|---|---|---|---|
| PackageTrackingNumbers | Tracking numbers of delivered packages. | Array of String | None. |
| ReturnPackageTrackingNumbers | Tracking numbers of collected packages | Array of String | None. |
| ReturnTrackingNumber | Main tracking number of collected package | Array of String | |
| TrackingNumber | Main tracking number of delivered package | String | |
| ErrorCode | Error code if return with error | Number | |
| ErrorMessage | Error details | string |
WbShipmentReducedResultModel stracture
| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | WbShipmentInfoReducedModel | None |
WbShipmentInfoReducedModel stracture
| Name | Description | Type | Additional information |
|---|---|---|---|
| ConsigneeCityName | Consignee city name in Hebrew | string | None. |
| ConsigneeStreetName | Consignee Street name in Hebrew | string | None |
| ConsigneeCityNameEng | Consignee city name in English | string | None |
| ConsigneeStreetNameEng | Consignee Street name in English | string | None |
| ConsigneeHouseNumber | Consignee House number | string | None |
| ConsigneeRoomNumber | Consignee room number | string | None |
| ConsigneeFloorNumber | Consignee floor number | string | None |
| RouteCode | UPS route code | string | None |
Response Formats:
- application/json
- text/json
Sample:
{
"Result": {
"ReturnPackageTrackingNumbers": [],
"ReturnTrackingNumber": [
"W5097074915"
],
"PackageTrackingNumbers": [],
"TrackingNumber": "W5097074906",
"ErrorCode": 0,
"ErrorMessage": ""
},
"WbResult": {
"Result": [
{
"ConsigneeCityName": "תל אביב יפו",
"ConsigneeStreetName": "מקווה ישראל",
"ConsigneeCityNameEng": "Tel Aviv-Yafo",
"ConsigneeStreetNameEng": "Mikve Yisrael",
"ConsigneeHouseNumber": "0",
"ConsigneeRoomNumber": "0",
"ConsigneeFloorNumber": "0",
"RouteCode": "T54 / q"
}
]
}
}
CreateShipmentInfoModel stracture
| Name | Description | Type | Additional Information |
|---|---|---|---|
| UserOwnerAccount | string | Required | |
| UserOwnerName | string | None | |
| IsMother | boolean | ||
| ChildrenTrackingNumbers | List of strings | ||
| POD | boolean | ||
| RowNum | int | ||
| COD | boolean | ||
| Weight | double | ||
| CustomerName | string | ||
| ShipmentType | ShipmentType | Type enum | |
| Reference1 | string | ||
| Reference2 | string | ||
| NumberOfPackages | int | ||
| NumberOfPackagesToReturn | int | ||
| DateShipped | DateTime | ||
| FormattedDateShipped | string | ||
| IsScheduledDelivery | boolean | ||
| RouteCode | string | ||
| TrackingNumber | string | ||
| ConsigneeAddress | PickupAddressModel | ||
| ShipperAddress | PickupAddressModel | ||
| DDO | boolean | ||
| Status | int | ||
| IsReturn | boolean |
ShipmentType stracture
| Name | Value |
|---|---|
| Empty | 0 |
| Letter | 1 |
| Document | 2 |
| NoneDocument | 3 |
PickupAddressModel stracture
| Name | Description | Type | Additional Information |
|---|---|---|---|
| CustomerID | number | None. | |
| CustomerName | Consignee name. May include a full name of consignee for private person or a company name. | string | Required |
| CityName | City name in Hebrew | string | At leaste one of them is required. |
| CityCode | City code of "MAPA" | Long | |
| ContactPerson | A name of a person for contact | string | Required |
| StreetCode | Street code from "MAPA" | Long | |
| StreetCodeMapa | string | ||
| StreetName | Street name in Hebrew | string | Required |
| Phone | Phone number without separators and Prefix | string | Required |
| PhonePrefix | Phone Prefix | ||
| For example:03 or 08 etc. | string | ||
| Mobile | Mobile number without separators and Prefix | string | Required |
| MobilePrefix | Mobile Prefix | ||
| For example:050 or 054 etc. | string | ||
| LocationDescription | Free text for additional information about target location. Will be used in case of house number alpha numeric | string | None |
| Story | string | ||
| HouseNumber | House Number | string | Required |
| Floor | Floor Number | string | None |
| RoomNumber | Room Number | string | None |
| ContactEmail | Consignee Email | ||
| For Example:test@gmail.com | string | ||
| Area | string | ||
| AreaCode | srting | ||
| IsAccessPoint | bool | ||
| IsResidential | bool | ||
| Index | number | ||
| ZipCode | Zip Code | string | None |
| Tel | String | ||
| Tel2 | string |
Response Information
| Name | Description | Type | Additional information |
|---|---|---|---|
| TrackingNumber | Shipment tracking Number | String | None |
| ErrorMessage | Error text returned if any | string | None. |
| ErrorCode | int | None |
Response Formats:
- application/json
- text/json
¶ InsertPickupShipmentEX
- Description: This function will create a Domestic Pickup Shipment
- Method: POST
- Test Url: https://newbetaapi.ship.co.il/api/v1/shipments/insert-pickup-shipment-ex
- Production Url: https://api.ship.co.il/api/v1/shipments/insert-pickup-shipment-ex
- Request Header:
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer zW19Z19Lg93DkIHYbz9U7Z2zjwjTKeUaplJ1Ae1OUUM9COT2UgpHHvAAET_PZ8yC3U5qcG8mMtjWNjay2yEnHBvjBzPapXsyMroQLe1Er6HSeCWgwuQik8gq04LmtgfJbrVKWApPRRsJ1GGqeyZfHIrJ8VnVqKUjITFYy93zk1Q9eCQyN x0Dpby16p1k0eDA5Zo8T169ZTxrj4zS6azrp8haSaqK0KYLXYdwETEPNZgW4YZ677nqMHTz0u5K8ijGD3eOQZhvNjljqYpjgh86zyxd6eqCKD79r4T4rrqc |
Request Information
URI Parameters
None
Body Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ConsigneeAddress | ShipAddressInputModel | Required | |
| ShipperAddress | ShipAddressInputModel | Required if UseDefaultShipperAddress is false or not supplied | |
| Reference1 | string | ||
| Reference2 | string | ||
| ShipmentInstructions | string | ||
| UseDefaultShipperAddress | bool | If true , ignore ShipperAddress property and get shipper address from ups system. | |
| NumberOfPackages | number | Required | |
| PickupPointType | Store= 1, Locker=2, PickUPDrop = 4 |
string | |
| PickupPointID | Must start with PKP | string |
ShipAddressInputModel stracture
| Name | Description | Type | Length | Additional Information |
|---|---|---|---|---|
| CityName | City name in Hebrew | string | 30 | Required |
| CityCode | City code of "MAPA" | Long | None | |
| StreetName | Street name in Hebrew | string | 30 | Required |
| StreetCode | Street code from "MAPA" | Long | None | |
| HouseNumber | House Number | string | 5 | Required |
| ContactPerson | A name of a person for contact | string | 100 | Required |
| CustomerName | Consignee name. May include a full name of consignee for private person or a company name. | string | 50 | Required |
| LocationDescription | Free text for additional information about target location. Will be used in case of house number alpha numeric | string | 50 | None |
| Phone1 | Mobile number with prefix | Required | ||
| Phone2 | Mobile number with prefix | None | ||
| RoomNumber | Room Number | string | 5 | None |
| Floor | Floor Number | string | 5 | None |
| ZipCode | Zip Code | string | 7 | None |
Example Request:
{
"ConsigneeAddress": {
"CityName": "בני ברק",
"StreetName": "רבי עקיבא",
"HouseNumber": "2",
"ContactPerson": "string",
"CustomerName": "string",
"LocationDescription": "string",
"Phone1": "0545682562",
"RoomNumber": "3",
"Floor": "2"
},
"Reference1": "string",
"Reference2": "string",
"ShipmentInstructions": "string",
"UseDefaultShipperAddress": true,
"UseDefaultShipperAddressSpecified": true,
"NumberOfPackagesSpecified": true,
"NumberOfPackages": 2,
"OriginalData": "string",
"PickupPointType": "1",
"PickupPointID": "PKP19063"
}
Response Information
| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | InsertWbShipmentResultModel | None | |
| WbResult | WbShipmentReducedResultModel | None |
InsertWbShipmentResultModel stracture
| Name | Description | Type | Additional information |
|---|---|---|---|
| PackageTrackingNumbers | Tracking numbers of delivered packages. | Array of String | None. |
| ReturnPackageTrackingNumbers | Tracking numbers of collected packages | Array of String | None. |
| ReturnTrackingNumber | Main tracking number of collected package | Array of String | |
| TrackingNumber | Main tracking number of delivered package | String | |
| ErrorCode | Error code if return with error | Number | |
| ErrorMessage | Error details | string |
WbShipmentReducedResultModel stracture
| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | WbShipmentInfoReducedModel | None |
WbShipmentInfoReducedModel stracture
| Name | Description | Type | Additional information |
|---|---|---|---|
| ConsigneeCityName | Consignee city name in Hebrew | string | None. |
| ConsigneeStreetName | Consignee Street name in Hebrew | string | None |
| ConsigneeCityNameEng | Consignee city name in English | string | None |
| ConsigneeStreetNameEng | Consignee Street name in English | string | None |
| ConsigneeHouseNumber | Consignee House number | string | None |
| ConsigneeRoomNumber | Consignee room number | string | None |
| ConsigneeFloorNumber | Consignee floor number | string | None |
| RouteCode | UPS route code | string | None |
Response Formats:
- application/json
- text/json
Sample:
{
"Result": {
"ReturnPackageTrackingNumbers": [],
"ReturnTrackingNumber": null,
"PackageTrackingNumbers": [
"W5097074942"
],
"TrackingNumber": "W5097074933",
"ErrorCode": 0,
"ErrorMessage": ""
},
"WbResult": {
"Result": [
{
"ConsigneeCityName": "",
"ConsigneeStreetName": "",
"ConsigneeCityNameEng": "",
"ConsigneeStreetNameEng": "",
"ConsigneeHouseNumber": "",
"ConsigneeRoomNumber": "",
"ConsigneeFloorNumber": "",
"RouteCode": "T212 / q"
},
{
"ConsigneeCityName": "",
"ConsigneeStreetName": "",
"ConsigneeCityNameEng": "",
"ConsigneeStreetNameEng": "",
"ConsigneeHouseNumber": "",
"ConsigneeRoomNumber": "",
"ConsigneeFloorNumber": "",
"RouteCode": "T212 / q"
}
]
}
}
¶ InsertPickupDropShipmentEX
- Description: This function will create a Domestic Pickup Drop Shipment
- Method: POST
- Test Url: https://newbetaapi.ship.co.il/api/v1/shipments/drop-pickup-ex
- Production Url: https://api.ship.co.il/api/v1/shipments/drop-pickup-ex
- Request Header:
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer zW19Z19Lg93DkIHYbz9U7Z2zjwjTKeUaplJ1Ae1OUUM9COT2UgpHHvAAET_PZ8yC3U5qcG8mMtjWNjay2yEnHBvjBzPapXsyMroQLe1Er6HSeCWgwuQik8gq04LmtgfJbrVKWApPRRsJ1GGqeyZfHIrJ8VnVqKUjITFYy93zk1Q9eCQyN x0Dpby16p1k0eDA5Zo8T169ZTxrj4zS6azrp8haSaqK0KYLXYdwETEPNZgW4YZ677nqMHTz0u5K8ijGD3eOQZhvNjljqYpjgh86zyxd6eqCKD79r4T4rrqc |
Request Information
URI Parameters
None
Body Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ConsigneeAddress | ShipAddressInputModel | Required | |
| ShipperAddress | ShipAddressInputModel | Required if UseDefaultShipperAddress is false or not supplied | |
| Reference1 | string | ||
| Reference2 | string | ||
| ShipmentInstructions | string | ||
| UseDefaultShipperAddress | bool | If true , ignore ShipperAddress property and get shipper address from ups system. | |
| NumberOfPackages | number | Required | |
| PickupPointType | Store= 1, Locker=2, PickUPDrop = 4 |
string | |
| PickupPointID | string | Must start with PKP |
ShipAddressInputModel stracture
| Name | Description | Type | Length | Additional Information |
|---|---|---|---|---|
| CityName | City name in Hebrew | string | 30 | Required |
| CityCode | City code of "MAPA" | Long | None | |
| StreetName | Street name in Hebrew | string | 30 | Required |
| StreetCode | Street code from "MAPA" | Long | None | |
| HouseNumber | House Number | string | 5 | Required |
| ContactPerson | A name of a person for contact | string | 100 | Required |
| CustomerName | Consignee name. May include a full name of consignee for private person or a company name. | string | 50 | Required |
| LocationDescription | Free text for additional information about target location. Will be used in case of house number alpha numeric | string | 50 | None |
| Phone1 | Mobile number with prefix | Required | ||
| Phone2 | Mobile number with prefix | None | ||
| RoomNumber | Room Number | string | 5 | None |
| Floor | Floor Number | string | 5 | None |
| ZipCode | Zip Code | string | 7 | None |
Example Request:
{
"UseDefaultDestinationAddress": true,
"ConsigneeAddress": {
"CityName": "אשדוד",
"StreetName": "הרצל",
"HouseNumber": "7",
"ContactPerson": "string",
"CustomerName": "string",
"LocationDescription": "string",
"Phone1": "0523656325",
"RoomNumber": "4",
"Floor": "1"
},
"ShipperAddress": {
"CityName": "אילת",
"StreetName": "string",
"HouseNumber": "8",
"ContactPerson": "string",
"CustomerName": "string",
"LocationDescription": "string",
"Phone1": "0545234252",
"RoomNumber": "5",
"Floor": "6"
},
"Reference1": "string",
"Reference2": "string",
"ShipmentInstructions": "string",
"NumberOfPackages": 1,
"ContextCustomerID": 0,
"ContextUserEmail": "string",
"UserDisplayName": "string",
"OriginalData": "string",
"PickupPointType": "2",
"PickupPointID": "PKP640500"
}
Response Information
| Name | Description | Type | Additional information |
|---|---|---|---|
| TrackingNumber | Shipment tracking Number | String | None. |
| Error | string | None. | |
| ErrorMessage | Error text returned if any | string | None. |
| RouteCode | UPS route code | string | None |
Response Formats:
- application/json
- text/json
Sample:
{
"Result": {
"PackageTrackingNumbers": [],
"ReturnPackageTrackingNumbers": [],
"ReturnTrackingNumber": null,
"TrackingNumber": "W5097074960",
"ErrorCode": 0,
"ErrorMessage": ""
},
"WbResult": {
"Result": [
{
"ConsigneeCityName": "",
"ConsigneeStreetName": "",
"ConsigneeCityNameEng": "",
"ConsigneeStreetNameEng": "",
"ConsigneeHouseNumber": "",
"ConsigneeRoomNumber": "",
"ConsigneeFloorNumber": "",
"RouteCode": "T53 / c"
}
]
}
}
¶ InsertPickingList
- Description: This function will create a picking list with the items provided
- Method: POST
- Test Url: https://newbetaapi.ship.co.il/api/v1/shipments/InsertPickingList
- Production Url: https://api.ship.co.il/api/v1/shipments/InsertPickingList
- Request Header:
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer zW19Z19Lg93DkIHYbz9U7Z2zjwjTKeUaplJ1Ae1OUUM9COT2UgpHHvAAET_PZ8yC3U5qcG8mMtjWNjay2yEnHBvjBzPapXsyMroQLe1Er6HSeCWgwuQik8gq04LmtgfJbrVKWApPRRsJ1GGqeyZfHIrJ8VnVqKUjITFYy93zk1Q9eCQyN x0Dpby16p1k0eDA5Zo8T169ZTxrj4zS6azrp8haSaqK0KYLXYdwETEPNZgW4YZ677nqMHTz0u5K8ijGD3eOQZhvNjljqYpjgh86zyxd6eqCKD79r4T4rrqc |
Request Information
URI Parameters
None
Body Parameters
| Name | Description | Type | Length | Additional information |
|---|---|---|---|---|
| CustomerNumber | number | optional | ||
| Items | See details below | Array of PickingListOrderItemModel | Required | |
| Ref1 | string | 36 | ||
| TrackNO | string | 18 |
PickingListOrderItemModel stracture
| Name | Description | Type | Length | Additional information |
|---|---|---|---|---|
| Location | Location of package | String | 20 | optional |
| SKU1 | Item number | String | 30 | Required |
| SKU2 | Barcode/short item number | String | 30 | Not Required |
| Description | Item description | String | 150 | Required |
| Quantity | Item quantity for picking | Numeric(7,2) | 7 | Required |
| WH | Item warehouse | String | 30 | Not Required |
| Remarks | Item remarks | String | 100 | Not Required |
Request sample:
{
"TrackNO":"W5363710535",
"Items":[
{
"SKU1":"231111",
"SKU2":"1111",
"Description":"Computer",
"Quantity":15,
"Location":"B35-12",
"WH":"",
"Remarks":"small item"
},
{
"SKU1":"23123",
"SKU2":"123312",
"Description":"Disk",
"Quantity":15,
"Location":"A32-25",
"WH":"",
"Remarks":"big item"
},
{
"SKU1":"233",
"SKU2":"123",
"Description":"memory",
"Quantity":15,
"Location":"",
"WH":"",
"Remarks":""
},
{
"SKU1":"23123",
"SKU2":"123312",
"Description":"plate",
"Quantity":15,
"Location":"",
"WH":"",
"Remarks":""
},
{
"SKU1":"2312354",
"SKU2":"12331244",
"Description":"bag",
"Quantity":15,
"Location":"",
"WH":"",
"Remarks":""
},
{
"SKU1":"2312773",
"SKU2":"12335512",
"Description":"",
"Quantity":3,
"Location":"",
"WH":"",
"Remarks":""
}
],
"Ref1":"Order132"
}
Response Information
| Name | Description | Type | Additional information |
|---|---|---|---|
| ReturnValue | Picking list number | String | None. |
| ErrorDescription | The error description if the is one | string | None. |
| ErrorCode | The error code | Number | None. |
Response Formats:
- application/json
- text/json
Response smaple:
{
"ReturnValue": 1191,
"ErrorDescription": "",
"ErrorCode": 0
}
¶ Get WB Thermal or A4 for print
- Description: This function will create a pdf with WB and all its childs WB and merge it to one pdf
- Method: GET
- Test Url: https://newbetaapi.ship.co.il/api/v2/shipments/print/batch
- Production Url: https://api.ship.co.il/api/v2/shipments/print/batch
- Request Header:
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| trackingNumber | WB track number | string | Required |
| labelFormat | The format of WB print | string | Available values:
|
| copies | Number of copies for each WB label/A4 | int | Default is 3 |
Response Information
| Name | Description | Type | Additional information |
|---|---|---|---|
| MediaType | Indicate media type – pdf | string | |
| FileByteArray | Base 64 string | string | |
| FileName | string |
Response Formats:
- application/json
- text/json
Sample:
{
"MediaType": "pdf",
"FileByteArray": "",
"FileName": ""
}
¶ PrintWBOrderDetailsDescription
- Description: This function will create a pdf with WB and Picking list it to one pdf – can be printed multiple wb's and picking lists
- Method: GET
- Test Url: https://newbetaapi.ship.co.il/api/v1/shipments/PrintWBOrderDetails?trackingNumbers={Trackingnumbers}&isA4Format={True/false}
- Production Url: https://api.ship.co.il/api/v1/shipments/PrintWBOrderDetails?trackingNumbers={Trackingnumbers}&isA4Format={True/false}
- Request Header:
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer zW19Z19Lg93DkIHYbz9U7Z2zjwjTKeUaplJ1Ae1OUUM9COT2UgpHHvAAET_PZ8yC3U5qcG8mMtjWNjay2yEnHBvjBzPapXsyMroQLe1Er6HSeCWgwuQik8gq04LmtgfJbrVKWApPRRsJ1GGqeyZfHIrJ8VnVqKUjITFYy93zk1Q9eCQyN x0Dpby16p1k0eDA5Zo8T169ZTxrj4zS6azrp8haSaqK0KYLXYdwETEPNZgW4YZ677nqMHTz0u5K8ijGD3eOQZhvNjljqYpjgh86zyxd6eqCKD79r4T4rrqc |
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| trackingNumbers | Multipe WB's track numbers comma delimited | string | Required |
| printPickingList | bool | Optional , default true | |
| isA4Format | Is it label format or A4 | bool | Optional , default false |
| isExternalShipment | bool | Optional , default false | |
| groupId | number | Optional , default 0 |
Body Parameters
None
Response Information
| Name | Description | Type | Additional information |
|---|---|---|---|
| MediaType | Indicate media type – pdf | String | None. |
| FileByteArray | Base 64 string | string | None. |
Response Formats:
- application/json
- text/json
¶ Get tracking status
Get shipments status for all shipment services (Standard, PickUP, and PickUPDROP)
- Status code field available only for Pickup Shipments and will show the last status for the shipment
| Status Code | Status | סטטוס |
|---|---|---|
| 1 | On Way to the Store | בדרך לחנות |
| 2 | Waiting in Store | ממתין בחנות |
| 3 | Picked up by customer | נאסף ע"י הלקוח |
| 4 | Returned to Shipper | הוחזר לשולח |
| 5 | Waiting for Pickup by Driver | מחכה לאיסוף ע"י השליח |
Interval for request- Every hour for batch
If the there will be abuse to the service or if the requests to service will be above the set INTERVAL, the IP
address will be blocked automatically
* Do not send status requests for shipments collected over a month ago
*Do not send status requests for shipments delivered with status code:
Pickup Shipments: Status Code: 3
Standard Shipments: Status Codes: KB, FS, RTS
- Method: GET
- Url: api/v1/shipments/wb-status?trackingNumber={trackingNumber}
- Headers:
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer zW19Z19Lg93DkIHYbz9U7Z2zjwjTKeUaplJ1Ae1OUUM9COT2UgpHHvAAET_PZ8yC3U5qcG8mMtjWNjay2yEnHBvjBzPapXsyMroQLe1Er6HSeCWgwuQik8gq04LmtgfJbrVKWApPRRsJ1GGqeyZfHIrJ8VnVqKUjITFYy93zk1Q9eCQyN x0Dpby16p1k0eDA5Zo8T169ZTxrj4zS6azrp8haSaqK0KYLXYdwETEPNZgW4YZ677nqMHTz0u5K8ijGD3eOQZhvNjljqYpjgh86zyxd6eqCKD79r4T4rrqc |
Summary
Request Information
URI Parameters:
| Name | Description | Type | Additional information |
|---|---|---|---|
| trackingNumber | string | Required |
Body Parameters:None.
Response Information:
| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | string | None | |
| DeliveredOn | string | None | |
| LeftAt | string | None | |
| RecivedBy | string | None | |
| Receipent | string | None | |
| Weight | string | ||
| Dispatch | string | ||
| LastSite | string | ||
| Service | string | ||
| ShipmentProgress | Array of Activity |
Response Formats:
- application/json, text/json
Sample:
{
"Status": "נמסר",
"DeliveredOn": "19/02/2019 16:55",
"LeftAt": "UPS BEN GURION AIRPORT",
"RecivedBy": "AMIT",
"Receipent": null,
"Weight": null,
"Dispatch": null,
"LastSite": "UPS BEN GURION AIRPORT",
"Service": "Worldwide Services",
"ShipmentProgress": [
{
"Activity": "נמסר",
"LocalTime": "16:55",
"LocalDate": "19/02/2019",
"Location": "UPS BEN GURION AIRPORT, IL"
},
{
"Activity": "הושגה חתימה",
"LocalTime": "16:49",
"LocalDate": "19/02/2019",
"Location": "UPS Ben Gurion Airport, IL"
},
{
"Activity": "סריקת יעד",
"LocalTime": "20:04",
"LocalDate": "17/02/2019",
"Location": "Lod, IL"
},
{
"Activity": "סריקת איסוף",
"LocalTime": "10:59",
"LocalDate": "17/02/2019",
"Location": "Lod, IL"
}
]
}
¶ GetClosestPoints
- Description: Return a list of points according to the input
- Method: GET
- Url: api/v1/pickups/getclosestpoints?city={city}&street={street}&houseNumber={houseNumber}&pointTypes={pointTypes}&points={points}
Summary
Request Information
URI Parameters:
| Name | Description | Type | Additional information |
|---|---|---|---|
| city | string | Required | |
| street | string | Required | |
| houseNumber | string | Required | |
| pointTypes | PointType | Required | |
| points | integer | Default value is 10 |
PointType:
Possible enumeration values:
| Name | Value | Description |
|---|---|---|
| Store | 1 | |
| Locker | 2 | |
| PickUPDrop | 4 |
Body Parameters:None.
Response Information:
| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean | None | |
| ResponseCode | string | None | |
| HomeDelivery | integer | None | |
| ErrorMSG | string | None | |
| Points | Collection of PickUpPointModel | None |
Response Formats:
- application/json, text/json:
Sample:
{
"IsSuccessful": true,
"ResponseCode": "sample string 2",
"HomeDelivery": 3,
"ErrorMSG": "sample string 4",
"Points": [
{
"CityName": "sample string 1",
"Description": "sample string 2",
"Latitude": 3.1,
"Longitude": 4.1,
"PointID": "sample string 5",
"PointType": "sample string 6",
"PointNumber": "sample string 7",
"Distance": 8.1,
"Phone": "sample string 9",
"PointName": "sample string 10",
"StreetName": "sample string 11",
"HouseNumber": "sample string 12"
},
{
"CityName": "sample string 1",
"Description": "sample string 2",
"Latitude": 3.1,
"Longitude": 4.1,
"PointID": "sample string 5",
"PointType": "sample string 6",
"PointNumber": "sample string 7",
"Distance": 8.1,
"Phone": "sample string 9",
"PointName": "sample string 10",
"StreetName": "sample string 11",
"HouseNumber": "sample string 12"
}
]
}
- application/xml, text/xml
Sample:
sample string 4
3
true
sample string 1
sample string 2
8.1
sample string 12
3.1
4.1
sample string 9
sample string 5
sample string 10
sample string 7
sample string 6
sample string 11
sample string 1
sample string 2
8.1
sample string 12
3.1
4.1
sample string 9
sample string 5
sample string 10
sample string 7
sample string 6
sample string 11
sample string 2
¶ GetClosestPoint
- Description: Return a single point according to the input
- Url: api/v1/pickups/getclosestpoint?city={city}&street={street}&number={number}
- Method: GET
- Input Params: String City, String Street, String Number
- Response: PickUpPointsResultModel:
Class Diagram:
GET api/v1/pickups/getclosestpoint?city={city}&street={street}&number={number}
Request Information.
URI Parameters:
| Name | Description | Type | Additional information |
|---|---|---|---|
| city | string | Required | |
| street | string | Required | |
| number | string | Required |
Body Parameters: None.
Response Information:
| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean | None | |
| ResponseCode | string | None | |
| HomeDelivery | integer | None | |
| ErrorMSG | string | None | |
| Points | Collection of PickUpPointModel | None |
Response Formats:
- application/json, text/json:
Sample:
{
"IsSuccessful": true,
"ResponseCode": "sample string 2",
"HomeDelivery": 3,
"ErrorMSG": "sample string 4",
"Points": [
{
"CityName": "sample string 1",
"Description": "sample string 2",
"Latitude": 3.1,
"Longitude": 4.1,
"PointID": "sample string 5",
"PointType": "sample string 6",
"PointNumber": "sample string 7",
"Distance": 8.1,
"Phone": "sample string 9",
"PointName": "sample string 10",
"StreetName": "sample string 11",
"HouseNumber": "sample string 12"
}
]
}
- application/xml, text/xml:
Sample:
sample string 4
3
true
sample string 1
sample string 2
8.1
sample string 12
3.1
4.1
sample string 9
sample string 5
sample string 10
sample string 7
sample string 6
sample string 11
sample string 2
¶ Get packages pricing by services
- Description: This function will return pricing by criteria for each available service
- Method: POST
- Test Url: https://newbetaapi.ship.co.il/api/v1/priceList/get-pricing
- Production Url: https://api.ship.co.il/api/v1/priceList/get-pricing
- Request Header:
| Key | Value |
|---|---|
| Authori zation | Bearer zW19Z19Lg93DkIHYbz9U7Z2zjwjTKeUaplJ1Ae1OUUM9COT2UgpHHvAAET_PZ8yC3U5qcG8mMtjWNjay2yEnHBvjBzPapXsyMroQLe1Er6HSeCWgwuQik8gq04LmtgfJbrVKWApPRRsJ1GGqeyZfHIrJ8VnVqKUjITFYy93zk1Q9eCQyN x0Dpby16p1k0eDA5Zo8T169ZTxrj4zS6azrp8haSaqK0KYLXYdwETEPNZgW4YZ677nqMHTz0u5K8ijGD3eOQZhvNjljqYpjgh86zyxd6eqCKD79r4T4rrqc |
Request Information:
PackagePriceCriteriaModel
| Name | Description | Type | Additional information |
|---|---|---|---|
| ToCountryCode | 2 Char country code | string | Required |
| IsExport | If export pricing true else for import false | bool | Required |
| PackageType | Letter = 1, Document = 2, NoneDocument = 3, | int | Required |
| ShipmentValue | Value in USD | decimal | Required |
| FromPostcode | zipcode of shipper location | Optional | |
| ToZipCode | Required for export – zipcode of consignee location | Required | |
| ToCity | Required for export – city of consignee location(English) | Required only for estimated date | |
| PickupDate | The date package will be picked up | date format dd/MM/yyyy | Optional |
| Packages | Rows of package weight and size | List | Required |
| Name | Description | Type | Additional information |
|---|---|---|---|
| Height | Max value 274CM | int | |
| Length | Max value 274CM | int | |
| Width | Max value 274CM | int | |
| Weight | The weight of the package/letter/documents | decimal | Required |
Example body for getting export pricing for US:
{
"PackageType": 2,
"IsExport": true ,
"ShipmentValue": 10,
"ToZipCode": "10015",
"ToCountryCode": "US",
"ToCity": "New york",
"Packages": [
{
"Length": 0,
"Width": 0,
"Height": 0,
"Weight": 10,
}
]
}
Response Formats
application/json, text/json
Sample:
{
"ServicesPricing": [
{
"Items": [
{
"Fee": "עלות הובלה",
"FeeCode": null,
"Price": 392.2,
"RowType": 1
},
{
"Fee": "היטל דלק",
"FeeCode": null,
"Price": 133.35,
"RowType": 2
},
{
"Fee": "סה\"כ",
"FeeCode": null,
"Price": 525.55,
"RowType": 4
},
{
"Fee": "סה\"כ",
"FeeCode": null,
"Price": 2233.58,
"RowType": 7
},
{
"Fee": "סהכ כולל מעמ",
"FeeCode": null,
"Price": 2233.58,
"RowType": 8
},
{
"Fee": "סהכ כולל מעמ",
"FeeCode": null,
"Price": 525.55,
"RowType": 9
},
{
"Fee": "עלות הובלה",
"FeeCode": null,
"Price": 1666.85,
"RowType": 10
},
{
"Fee": "היטל דלק",
"FeeCode": null,
"Price": 566.73,
"RowType": 11
}
],
"ServiceCode": 21,
"SeviceName": "ExpressPlus",
"Days": null,
"EstimatedDate": null
},
{
"Items": [
{
"Fee": "עלות הובלה",
"FeeCode": null,
"Price": 248.48,
"RowType": 1
},
{
"Fee": "היטל דלק",
"FeeCode": null,
"Price": 84.48,
"RowType": 2
},
{
"Fee": "סה\"כ",
"FeeCode": null,
"Price": 332.96,
"RowType": 4
},
{
"Fee": "סה\"כ",
"FeeCode": null,
"Price": 1415.09,
"RowType": 7
},
{
"Fee": "סהכ כולל מעמ",
"FeeCode": null,
"Price": 1415.09,
"RowType": 8
},
{
"Fee": "סהכ כולל מעמ",
"FeeCode": null,
"Price": 332.96,
"RowType": 9
},
{
"Fee": "עלות הובלה",
"FeeCode": null,
"Price": 1056.04,
"RowType": 10
},
{
"Fee": "היטל דלק",
"FeeCode": null,
"Price": 359.05,
"RowType": 11
}
],
"ServiceCode": 1,
"SeviceName": "Express",
"Days": null,
"EstimatedDate": null
},
{
"Items": [
{
"Fee": "עלות הובלה",
"FeeCode": null,
"Price": 228.48,
"RowType": 1
},
{
"Fee": "היטל דלק",
"FeeCode": null,
"Price": 77.68,
"RowType": 2
},
{
"Fee": "סה\"כ",
"FeeCode": null,
"Price": 306.16,
"RowType": 4
},
{
"Fee": "סה\"כ",
"FeeCode": null,
"Price": 1301.18,
"RowType": 7
},
{
"Fee": "סהכ כולל מעמ",
"FeeCode": null,
"Price": 1301.18,
"RowType": 8
},
{
"Fee": "סהכ כולל מעמ",
"FeeCode": null,
"Price": 306.16,
"RowType": 9
},
{
"Fee": "עלות הובלה",
"FeeCode": null,
"Price": 971.03,
"RowType": 10
},
{
"Fee": "היטל דלק",
"FeeCode": null,
"Price": 330.15,
"RowType": 11
}
],
"ServiceCode": 28,
"SeviceName": "Saver",
"Days": null,
"EstimatedDate": null
},
{
"Items": [
{
"Fee": "עלות הובלה",
"FeeCode": null,
"Price": 212.87,
"RowType": 1
},
{
"Fee": "היטל דלק",
"FeeCode": null,
"Price": 72.37,
"RowType": 2
},
{
"Fee": "סה\"כ",
"FeeCode": null,
"Price": 285.24,
"RowType": 4
},
{
"Fee": "סה\"כ",
"FeeCode": null,
"Price": 1212.28,
"RowType": 7
},
{
"Fee": "סהכ כולל מעמ",
"FeeCode": null,
"Price": 1212.28,
"RowType": 8
},
{
"Fee": "סהכ כולל מעמ",
"FeeCode": null,
"Price": 285.24,
"RowType": 9
},
{
"Fee": "עלות הובלה",
"FeeCode": null,
"Price": 904.68,
"RowType": 10
},
{
"Fee": "היטל דלק",
"FeeCode": null,
"Price": 307.59,
"RowType": 11
}
],
"ServiceCode": 5,
"SeviceName": "Expedited",
"Days": null,
"EstimatedDate": null
},
{
"Items": [
{
"Fee": "עלות הובלה",
"FeeCode": null,
"Price": 1519.4,
"RowType": 1
},
{
"Fee": "היטל דלק",
"FeeCode": null,
"Price": 516.6,
"RowType": 2
},
{
"Fee": "סה\"כ",
"FeeCode": null,
"Price": 2036.0,
"RowType": 4
},
{
"Fee": "סה\"כ",
"FeeCode": null,
"Price": 8652.98,
"RowType": 7
},
{
"Fee": "סהכ כולל מעמ",
"FeeCode": null,
"Price": 8652.98,
"RowType": 8
},
{
"Fee": "סהכ כולל מעמ",
"FeeCode": null,
"Price": 2036.0,
"RowType": 9
},
{
"Fee": "עלות הובלה",
"FeeCode": null,
"Price": 6457.45,
"RowType": 10
},
{
"Fee": "היטל דלק",
"FeeCode": null,
"Price": 2195.53,
"RowType": 11
}
],
"ServiceCode": 29,
"SeviceName": "Freight",
"Days": null,
"EstimatedDate": null
}
],
"ErrorDescription": null
}