Pickup Locations

Modified on Wed, 1 Oct at 8:39 PM

Create Pickup Location

Endpoint URL

POST https://api.tryoto.com/rest/v2/createPickupLocation

Example Request Body

Here is an example of a request body:

{
  "type": "warehouse",
  "code": "code-02",
  "name": "Location-02 Name",
  "mobile": "555888777",
  "address": "Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225",
  "contactName": "Test Contact",
  "contactEmail": "Test Email",
  "lat": "26.001",
  "lon": "50.001",
  "city": "Dammam",
  "country": "SA",
  "postcode": "12345",
  "servingRadius": "10",
  "brandName": "Example Seller"
}

Request Parameters

Name	Required	Type	Description
name	yes	string	Name of the pickup location
type	no	string	You can enter these values: `branch`, `warehouse`. Branch can only be used by enterprise and marketplace packages
code	yes	string	Code of the pickup location
mobile	yes	string	Mobile number of the pickup location
lat	no	number	Latitude, \*if not exist orders may not assigned to pickupLocations automatically
lon	no	number	Longitude, \* if not exist orders may not assigned to pickupLocations automatically
city	yes	string	City name of the pickup location
country	yes	string	Country ISO2 code "SA","AE" etc.
postcode	no	string	Postal code of the pickup location
address	yes	string	Address of the pickup location
district	no	string	The district or area where the location is situated
state	no	string	The state or province where the pickup location is located
street	no	string	The street address of the pickup location
contactName	yes	string	If not exists you may not create shipments with some delivery companies
contactEmail	yes	string	In format of [test@example.com](https://)
servingRadius	no	number	Serving radius of branch in KM
brandName	no	string	Store brand name which this location belongs to.
status	no	string	Status of the pickup location(active, inactive)

Available Packages: All Packages

This API endpoint allows you to define and register a new pickup location within the system. By specifying the location details, you can expand your network of pickup points, improving logistics and delivery workflows.

Request Parameters: |

Update Pickup Location

Endpoint URL

POST https://api.tryoto.com/rest/v2/updatePickupLocation

Example Request Body

Here is an example of a request body:

{
  "type": "warehouse",
  "code": "code-02",
  "name": "Location-02 Name",
  "mobile": "555888777",
  "address": "Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225",
  "contactName": "Test Contact",
  "contactEmail": "Test Email",
  "lat": "26.001",
  "lon": "50.001",
  "city": "Dammam",
  "district": "Latifah Manaf",
  "street": "Long Street",
  "state": "Eastern Province",
  "country": "SA",
  "postcode": "77777",
  "servingRadius": "10",
  "brandName": "Example Seller 2",
  "status": "active"
}

Request Parameters

Name	Required	Type	Description
name	yes	string	Name of the pickup location
type	no	string	You can enter these values: `branch`, `warehouse`. Branch can only be used by enterprise and marketplace packages
code	yes	string	Code of the pickup location
mobile	yes	string	Mobile number of the pickup location
lat	no	number	Latitude, \*if not exist orders may not assigned to pickupLocations automatically
lon	no	number	Longitude, \* if not exist orders may not assigned to pickupLocations automatically
city	yes	string	City name of the pickup location
country	yes	string	Country ISO2 code "SA","AE" etc.
postcode	no	string	Postal code of the pickup location
address	yes	string	Address of the pickup location
district	no	string	The district or area where the location is situated
state	no	string	The state or province where the pickup location is located
street	no	string	The street address of the pickup location
contactName	yes	string	If not exists you may not create shipments with some delivery companies
contactEmail	yes	string	In format of [test@example.com](https://)
servingRadius	no	number	Serving radius of branch in KM
brandName	no	string	Store brand name which this location belongs to.
status	no	string	Status of the pickup location(active, inactive)

Available Packages: All Packages

This API endpoint allows you to modify the details of your existing pickup locations efficiently. This endpoint provides a streamlined way to ensure that your pickup location information remains accurate and up to date, enabling smooth and reliable operations.

Request Parameters: |

Get Pickup Location List

Endpoint URL

GET https://api.tryoto.com/rest/v2/getPickupLocationList?minDate=2024-08-01&maxDate=2024-08-05&status=active

Request Parameters

Name	Required	Type	Description
minDate	no	date	Starting Pickup location create date in "yyyy-mm-dd" format. (e.g. "2024-08-01")
maxDate	no	date	Ending Pickup location create date in "yyyy-mm-dd" format. (e.g. "2024-08-05")
status	no	string	Status of the pickup location(active, inactive)

Available Packages: All Packages

This API endpoint enables you to retrieve a comprehensive list of pickup locations by specifying a date range and status. This endpoint provides an efficient way to filter and access relevant pickup location data, ensuring streamlined tracking and management.

Request Parameters: |

Response Body The response includes a boolean flag "success" indicating the success of the request, along with arrays of "warehouses" and "branches" containing details of pickup locations including their codes, addresses, contact information, geographical coordinates, and other relevant attributes.

``` json

{

"success": true,

"warehouses": [

{

"code": "code 999",

"address": "Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225",

"contactEmail": "Test Email",

"city": "Dammam",

"name": "Location Name",

"contactPerson": "Test Contact",

"lon": 50.001,

"id": 17051,

"contactPhone": "555888777",

"lat": 26.001

{

"code": "code 95",

"address": "Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225",

"contactEmail": "Test Email",

"city": "Dammam",

"name": "Location Name",

"contactPerson": "Test Contact",

"lon": 50.001,

"id": 17052,

"contactPhone": "555888777",

"lat": 26.001

}

"branches": [

{

"code": "code 96",

"address": "Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225",

"contactEmail": "Test Email",

"city": "Dammam",

"name": "Location 02 Name",

"contactPerson": "Test Contact",

"lon": 50.001,

"id": 18203,

"contactPhone": "555888777",

"lat": 26.002

}

]

}

```