Introduction
This documentation aims to provide all the information you need to work with our API.
Authenticating requests
To authenticate requests, include an Authorization
header with the value "Bearer {YOUR_AUTH_KEY}"
.
All authenticated endpoints are marked with a requires authentication
badge in the documentation below.
You can retrieve your token by using Generate Token under Customer Management>Authentication tab.
Signature and Parameter Integrity
Introduction
HMR uses HMAC-SHA256 to sign all data in API communication with the merchant. Before sending a Signature request, make sure the following conditions are met:
- All parameters in the request/response are all strings.
- Sort key-value pairs in the payload in alphabetic order by keys.
- Concatenate all key-value pairs to not have any space.
- Make a hash with the payload string and client secret.
- The message outputs should be a lowercase hexadecimal digit.
Cleanup Example
In the example below we will clean up the request and make sure it follows the conditions required in order to get a successful response.
-
Make sure the necessary key / value pairs are met.
{ "some_other_value": "Test", "some_other_value2": "Test 2", "some_other_value3": 1000, }
-
Sort the keys alphabetically.
"some_other_value": "Test", "some_other_value2": "Test 2", "some_other_value3": 1000,
-
Trim all unnecessary quotations and spaces, and format it like the example below.
some_other_value=Test,some_other_value2=Test 2,some_other_value3=1000
-
Make a hash with SHA256 with the client_secret and encode it into Base64 format. The response should output a Base64 format like below.
x9Y8j1XYrDtkqn0WK+LxW0xL8dHCqDNOkveJOQb2xi0=
PHP Example
Node Example
Dart Example
Go Example
Customer Management
List of all Customer related endpoints
Authentication
Endpoints for managing customer's session
Generate Token
This endpoint allows you to generate a session token.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/auth/token" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"account_reference\": \"johndoe\",
\"password\": \"i8WnzwH58PY4Xzr\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/auth/token"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"account_reference": "johndoe",
"password": "i8WnzwH58PY4Xzr",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/token';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'account_reference' => 'johndoe',
'password' => 'i8WnzwH58PY4Xzr',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/token'
payload = {
"account_reference": "johndoe",
"password": "i8WnzwH58PY4Xzr",
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"account_reference": "johndoe",
"password": "i8WnzwH58PY4Xzr",
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/auth/token',
body ,
headers
)
p response.body
Example response (200):
{
"token_type": "Bearer",
"access_token": "28|EIiQyqqRqDdrlCfV6POQr3YfzM2176OsX5vs4Kkk250b61d7",
"refresh_token": "28|EIiQyqqRqDdrlCfV6POQr3YfzM2176OsX5vs4Kkk250b61d7",
"expires_at": "2023-10-23T05:42:29.000000Z"
}
Example response (422):
{
"message": "These credentials do not match our records.",
"errors": {
"account_reference": [
"These credentials do not match our records."
]
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Generate Token using Refresh Tokens
requires authentication
This endpoint allows you to generate new session token using the refresh token.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/auth/refresh-token" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/auth/refresh-token"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/refresh-token';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/refresh-token'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/auth/refresh-token',
body ,
headers
)
p response.body
Example response (200):
{
"token_type": "Bearer",
"access_token": "28|EIiQyqqRqDdrlCfV6POQr3YfzM2176OsX5vs4Kkk250b61d7",
"expires_at": "2023-10-23T05:42:29.000000Z"
}
Example response (401):
{
"message": "Unauthenticated.",
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Logout
This endpoint allows you to destroy the current active session token.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/auth/logout" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--header "Authorization: Bearer {accessToken}" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/auth/logout"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {accessToken}",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/logout';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
'Authorization' => 'Bearer {accessToken}',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/logout'
payload = {
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example',
'Authorization': 'Bearer {accessToken}'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {accessToken}",
}
response = RestClient.post(
'https://staging-api.hmr.ph/auth/logout',
body ,
headers
)
p response.body
Example response (200):
{
"success": 1,
}
Example response (401):
{
"message": "Unauthenticated.",
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Customer Credentials
Endpoints for managing customer credentials
Forgot Password
This endpoint allows you to request a "Forgot Password" token that will be sent to the specified email.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/auth/forgot-password" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"email\": \"leatha81@example.net\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/auth/forgot-password"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"email": "leatha81@example.net",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/forgot-password';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'email' => 'leatha81@example.net',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/forgot-password'
payload = {
"email": "leatha81@example.net",
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"email": "leatha81@example.net",
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/auth/forgot-password',
body ,
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 0
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Deactivate Authenticated Customer
requires authentication
This endpoint allows you to deactivate customer's account.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/auth/deactivate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"password\": \"incidunt\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/auth/deactivate"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"password": "incidunt",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/deactivate';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'password' => 'incidunt',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/deactivate'
payload = {
"password": "incidunt",
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"password": "incidunt",
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/auth/deactivate',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Validate "Forgot Password" Token
This endpoint allows you to check if the "Forgot Password" token is valid.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/auth/forgot-password/9Ur2URVyTdwSW62QoVhGdHIUenrtZYlTYwYPrzLfaoqYv6bQYGoiaTVcS5LF/validate" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/auth/forgot-password/9Ur2URVyTdwSW62QoVhGdHIUenrtZYlTYwYPrzLfaoqYv6bQYGoiaTVcS5LF/validate"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/forgot-password/9Ur2URVyTdwSW62QoVhGdHIUenrtZYlTYwYPrzLfaoqYv6bQYGoiaTVcS5LF/validate';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/forgot-password/9Ur2URVyTdwSW62QoVhGdHIUenrtZYlTYwYPrzLfaoqYv6bQYGoiaTVcS5LF/validate'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/auth/forgot-password/9Ur2URVyTdwSW62QoVhGdHIUenrtZYlTYwYPrzLfaoqYv6bQYGoiaTVcS5LF/validate',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 1
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
"Forgot Password" Token Based Update Password
This endpoint allows you to update password based on "Forgot Password" request.
Example request:
curl --request PATCH \
"https://staging-api.hmr.ph/auth/update-password" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"password\": \"i8WnzwH58PY4Xzr\",
\"token\": \"9Ur2URVyTdwSW62QoVhGdHIUenrtZYlTYwYPrzLfaoqYv6bQYGoiaTVcS5LF\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/auth/update-password"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"password": "i8WnzwH58PY4Xzr",
"token": "9Ur2URVyTdwSW62QoVhGdHIUenrtZYlTYwYPrzLfaoqYv6bQYGoiaTVcS5LF",
"signature": "No-Example"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/update-password';
$response = $client->patch(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'password' => 'i8WnzwH58PY4Xzr',
'token' => '9Ur2URVyTdwSW62QoVhGdHIUenrtZYlTYwYPrzLfaoqYv6bQYGoiaTVcS5LF',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/update-password'
payload = {
"password": "i8WnzwH58PY4Xzr",
"token": "9Ur2URVyTdwSW62QoVhGdHIUenrtZYlTYwYPrzLfaoqYv6bQYGoiaTVcS5LF",
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"password": "i8WnzwH58PY4Xzr",
"token": "9Ur2URVyTdwSW62QoVhGdHIUenrtZYlTYwYPrzLfaoqYv6bQYGoiaTVcS5LF",
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.patch(
'https://staging-api.hmr.ph/auth/update-password',
body ,
headers
)
p response.body
Example response (429):
Show headers
x-ratelimit-limit: 60
x-ratelimit-remaining: 0
retry-after: 59
x-ratelimit-reset: 1723780647
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Too Many Attempts.",
"exception": "Illuminate\\Http\\Exceptions\\ThrottleRequestsException",
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
"line": 232,
"trace": [
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
"line": 153,
"function": "buildException",
"class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
"line": 135,
"function": "handleRequest",
"class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
"line": 87,
"function": "handleRequestUsingNamedLimiter",
"class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/sanctum/src/Http/Middleware/EnsureFrontendRequestsAreStateful.php",
"line": 25,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 144,
"function": "Laravel\\Sanctum\\Http\\Middleware\\{closure}",
"class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 119,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/sanctum/src/Http/Middleware/EnsureFrontendRequestsAreStateful.php",
"line": 26,
"function": "then",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 119,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 807,
"function": "then",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 784,
"function": "runRouteWithinStack",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 748,
"function": "runRoute",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 737,
"function": "dispatchToRoute",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 200,
"function": "dispatch",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 144,
"function": "Illuminate\\Foundation\\Http\\{closure}",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
"line": 21,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
"line": 31,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
"line": 21,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
"line": 40,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
"line": 27,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
"line": 99,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Http/Middleware/HandleCors.php",
"line": 62,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Http\\Middleware\\HandleCors",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
"line": 39,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Http\\Middleware\\TrustProxies",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 119,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 175,
"function": "then",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 144,
"function": "sendRequestThroughRouter",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 310,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 298,
"function": "callLaravelOrLumenRoute",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 91,
"function": "makeApiCall",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 44,
"function": "makeResponseCall",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 35,
"function": "makeResponseCallIfConditionsPass",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 236,
"function": "__invoke",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 166,
"function": "iterateThroughStrategies",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 95,
"function": "fetchResponses",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 125,
"function": "processRoute",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 72,
"function": "extractEndpointsInfoFromLaravelApp",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 50,
"function": "extractEndpointsInfoAndWriteToDisk",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
"line": 53,
"function": "get",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 36,
"function": "handle",
"class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Container/Util.php",
"line": 41,
"function": "Illuminate\\Container\\{closure}",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 93,
"function": "unwrapIfClosure",
"class": "Illuminate\\Container\\Util",
"type": "::"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 37,
"function": "callBoundMethod",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Container/Container.php",
"line": 662,
"function": "call",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Console/Command.php",
"line": 211,
"function": "call",
"class": "Illuminate\\Container\\Container",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/symfony/console/Command/Command.php",
"line": 326,
"function": "execute",
"class": "Illuminate\\Console\\Command",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Console/Command.php",
"line": 181,
"function": "run",
"class": "Symfony\\Component\\Console\\Command\\Command",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/symfony/console/Application.php",
"line": 1096,
"function": "run",
"class": "Illuminate\\Console\\Command",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/symfony/console/Application.php",
"line": 324,
"function": "doRunCommand",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/symfony/console/Application.php",
"line": 175,
"function": "doRun",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
"line": 201,
"function": "run",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/artisan",
"line": 37,
"function": "handle",
"class": "Illuminate\\Foundation\\Console\\Kernel",
"type": "->"
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Change Active Session Customer Password
requires authentication
This endpoint allows you to update the active session customer password.
Example request:
curl --request PATCH \
"https://staging-api.hmr.ph/auth/customer/change-password" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"current_password\": \"i8WnzwH58PY4Xzr\",
\"new_password\": \"i8WnzwH58PY4Xzr\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/auth/customer/change-password"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"current_password": "i8WnzwH58PY4Xzr",
"new_password": "i8WnzwH58PY4Xzr",
"signature": "No-Example"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/customer/change-password';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'current_password' => 'i8WnzwH58PY4Xzr',
'new_password' => 'i8WnzwH58PY4Xzr',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/customer/change-password'
payload = {
"current_password": "i8WnzwH58PY4Xzr",
"new_password": "i8WnzwH58PY4Xzr",
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"current_password": "i8WnzwH58PY4Xzr",
"new_password": "i8WnzwH58PY4Xzr",
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.patch(
'https://staging-api.hmr.ph/auth/customer/change-password',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update Mobile Number
This endpoint allows you to update customer's existing mobile number.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/auth/customer/update-mobile-number" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--header "Authorization: Bearer {accessToken}" \
--data "{
\"mobile_number\": \"639291731365\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/auth/customer/update-mobile-number"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {accessToken}",
};
let body = {
"mobile_number": "639291731365",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/customer/update-mobile-number';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
'Authorization' => 'Bearer {accessToken}',
],
'json' => [
'mobile_number' => '639291731365',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/customer/update-mobile-number'
payload = {
"mobile_number": "639291731365",
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example',
'Authorization': 'Bearer {accessToken}'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"mobile_number": "639291731365",
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {accessToken}",
}
response = RestClient.post(
'https://staging-api.hmr.ph/auth/customer/update-mobile-number',
body ,
headers
)
p response.body
Example response (200):
{
"success": 1,
"mobile_number": "6399******70",
}
Example response (401):
{
"message": "Unauthenticated.",
}
Example response (422):
{
"message": "The Mobile No. field is required.",
"errors": {
"mobile_number": [
"The Mobile No. field is required."
]
}
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Retrieve Active Session Customer Details
requires authentication
This endpoint allows you to retrieve customer's details.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/auth/customer" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/auth/customer"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/customer';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/customer'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/auth/customer',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Registration
Endpoints for managing registration.
Create Customer Account
This endpoint allows you to create a customer account.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/auth/register" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"customer_firstname\": \"fvomnq\",
\"customer_lastname\": \"pyfaczyrhixqaejir\",
\"customer_middlename\": \"knqodn\",
\"customer_suffixname\": \"eiltnywenxg\",
\"mobile_no\": \"639384650392\",
\"username\": \"neqasnpzbgdcrtxsvsdopgg\",
\"email\": \"ffarrell@example.org\",
\"password\": \"u}1SZ*om\\/WEp35ka#c4V\",
\"consent\": true,
\"verification_type\": \"Email\",
\"verification_code\": \"accusantium\",
\"auction_newsletter\": true,
\"retail_newsletter\": false,
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/auth/register"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"customer_firstname": "fvomnq",
"customer_lastname": "pyfaczyrhixqaejir",
"customer_middlename": "knqodn",
"customer_suffixname": "eiltnywenxg",
"mobile_no": "639384650392",
"username": "neqasnpzbgdcrtxsvsdopgg",
"email": "ffarrell@example.org",
"password": "u}1SZ*om\/WEp35ka#c4V",
"consent": true,
"verification_type": "Email",
"verification_code": "accusantium",
"auction_newsletter": true,
"retail_newsletter": false,
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/register';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'customer_firstname' => 'fvomnq',
'customer_lastname' => 'pyfaczyrhixqaejir',
'customer_middlename' => 'knqodn',
'customer_suffixname' => 'eiltnywenxg',
'mobile_no' => '639384650392',
'username' => 'neqasnpzbgdcrtxsvsdopgg',
'email' => 'ffarrell@example.org',
'password' => 'u}1SZ*om/WEp35ka#c4V',
'consent' => true,
'verification_type' => 'Email',
'verification_code' => 'accusantium',
'auction_newsletter' => true,
'retail_newsletter' => false,
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/register'
payload = {
"customer_firstname": "fvomnq",
"customer_lastname": "pyfaczyrhixqaejir",
"customer_middlename": "knqodn",
"customer_suffixname": "eiltnywenxg",
"mobile_no": "639384650392",
"username": "neqasnpzbgdcrtxsvsdopgg",
"email": "ffarrell@example.org",
"password": "u}1SZ*om\/WEp35ka#c4V",
"consent": true,
"verification_type": "Email",
"verification_code": "accusantium",
"auction_newsletter": true,
"retail_newsletter": false,
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"customer_firstname": "fvomnq",
"customer_lastname": "pyfaczyrhixqaejir",
"customer_middlename": "knqodn",
"customer_suffixname": "eiltnywenxg",
"mobile_no": "639384650392",
"username": "neqasnpzbgdcrtxsvsdopgg",
"email": "ffarrell@example.org",
"password": "u}1SZ*om\/WEp35ka#c4V",
"consent": true,
"verification_type": "Email",
"verification_code": "accusantium",
"auction_newsletter": true,
"retail_newsletter": false,
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/auth/register',
body ,
headers
)
p response.body
Example response (200):
{
"success": 1,
"message": ... (Message varies on the type of verification used.)
}
Example response (422):
{
"message": ...,
"errors": {
...
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Generate Registration Verification Code
This endpoint allows you to generate a verification code that will be sent to a specified mobile number/email.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/auth/register/verification-code" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"verification_type\": \"Email\",
\"account_reference\": \"dicta\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/auth/register/verification-code"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"verification_type": "Email",
"account_reference": "dicta",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/register/verification-code';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'verification_type' => 'Email',
'account_reference' => 'dicta',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/register/verification-code'
payload = {
"verification_type": "Email",
"account_reference": "dicta",
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"verification_type": "Email",
"account_reference": "dicta",
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/auth/register/verification-code',
body ,
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 2
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Resend Email Confirmation
This endpoint allows you to resend new email confirmation.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/auth/email-confirmation/resend" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"email\": \"qkirlin@example.net\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/auth/email-confirmation/resend"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"email": "qkirlin@example.net",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/email-confirmation/resend';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'email' => 'qkirlin@example.net',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/email-confirmation/resend'
payload = {
"email": "qkirlin@example.net",
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"email": "qkirlin@example.net",
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/auth/email-confirmation/resend',
body ,
headers
)
p response.body
Example response (200):
{
"success": 1,
"status": "Confirmation email has been sent. Please check your email."
}
Example response (422):
{
"message": ...,
"errors": {
...
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Generate Mobile Verification Code
This endpoint allows you to generate a verification code that will be sent to a specified mobile number.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/auth/mobile-verification/generate" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--header "Authorization: Bearer {accessToken}" \
--data "{
\"mobile_no\": \"639123456789\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/auth/mobile-verification/generate"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {accessToken}",
};
let body = {
"mobile_no": "639123456789",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/auth/mobile-verification/generate';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
'Authorization' => 'Bearer {accessToken}',
],
'json' => [
'mobile_no' => '639123456789',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/auth/mobile-verification/generate'
payload = {
"mobile_no": "639123456789",
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example',
'Authorization': 'Bearer {accessToken}'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"mobile_no": "639123456789",
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {accessToken}",
}
response = RestClient.post(
'https://staging-api.hmr.ph/auth/mobile-verification/generate',
body ,
headers
)
p response.body
Example response (429):
Show headers
x-ratelimit-limit: 60
x-ratelimit-remaining: 0
retry-after: 58
x-ratelimit-reset: 1723780647
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Too Many Attempts.",
"exception": "Illuminate\\Http\\Exceptions\\ThrottleRequestsException",
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
"line": 232,
"trace": [
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
"line": 153,
"function": "buildException",
"class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
"line": 135,
"function": "handleRequest",
"class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
"line": 87,
"function": "handleRequestUsingNamedLimiter",
"class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/sanctum/src/Http/Middleware/EnsureFrontendRequestsAreStateful.php",
"line": 25,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 144,
"function": "Laravel\\Sanctum\\Http\\Middleware\\{closure}",
"class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 119,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/sanctum/src/Http/Middleware/EnsureFrontendRequestsAreStateful.php",
"line": 26,
"function": "then",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 119,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 807,
"function": "then",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 784,
"function": "runRouteWithinStack",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 748,
"function": "runRoute",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 737,
"function": "dispatchToRoute",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 200,
"function": "dispatch",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 144,
"function": "Illuminate\\Foundation\\Http\\{closure}",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
"line": 21,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
"line": 31,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
"line": 21,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
"line": 40,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
"line": 27,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
"line": 99,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Http/Middleware/HandleCors.php",
"line": 62,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Http\\Middleware\\HandleCors",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
"line": 39,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Http\\Middleware\\TrustProxies",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 119,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 175,
"function": "then",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 144,
"function": "sendRequestThroughRouter",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 310,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 298,
"function": "callLaravelOrLumenRoute",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 91,
"function": "makeApiCall",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 44,
"function": "makeResponseCall",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 35,
"function": "makeResponseCallIfConditionsPass",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 236,
"function": "__invoke",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 166,
"function": "iterateThroughStrategies",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 95,
"function": "fetchResponses",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 125,
"function": "processRoute",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 72,
"function": "extractEndpointsInfoFromLaravelApp",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 50,
"function": "extractEndpointsInfoAndWriteToDisk",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
"line": 53,
"function": "get",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 36,
"function": "handle",
"class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Container/Util.php",
"line": 41,
"function": "Illuminate\\Container\\{closure}",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 93,
"function": "unwrapIfClosure",
"class": "Illuminate\\Container\\Util",
"type": "::"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 37,
"function": "callBoundMethod",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Container/Container.php",
"line": 662,
"function": "call",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Console/Command.php",
"line": 211,
"function": "call",
"class": "Illuminate\\Container\\Container",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/symfony/console/Command/Command.php",
"line": 326,
"function": "execute",
"class": "Illuminate\\Console\\Command",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Console/Command.php",
"line": 181,
"function": "run",
"class": "Symfony\\Component\\Console\\Command\\Command",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/symfony/console/Application.php",
"line": 1096,
"function": "run",
"class": "Illuminate\\Console\\Command",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/symfony/console/Application.php",
"line": 324,
"function": "doRunCommand",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/symfony/console/Application.php",
"line": 175,
"function": "doRun",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
"line": 201,
"function": "run",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/hmradmin/HMR/hmr-mobile-api/artisan",
"line": 37,
"function": "handle",
"class": "Illuminate\\Foundation\\Console\\Kernel",
"type": "->"
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Order Management
List of all Cart related endpoints
Cart
Endpoints for managing customer's cart
Retrieve Customer's Cart Information
requires authentication
This endpoint allows you to retrieve all the products/lots that are currently in the customer's cart.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/carts" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/carts"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/carts';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/carts'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/carts',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Retrieve Total Quantity and Count of Products/Lots in Cart
requires authentication
This endpoint allows you to retrieve the current total quantity and amount of products/lots in the customer's cart.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/carts/details" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/carts/details"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/carts/details';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/carts/details'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/carts/details',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Add Specific Product to Cart
requires authentication
This endpoint allows you to add a specific product to the customer's cart.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/products/1/cart" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"store_id\": 20,
\"posting_item_id\": 8,
\"quantity\": 6,
\"type\": \"dec\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/products/1/cart"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"store_id": 20,
"posting_item_id": 8,
"quantity": 6,
"type": "dec",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/products/1/cart';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'store_id' => 20,
'posting_item_id' => 8,
'quantity' => 6,
'type' => 'dec',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/products/1/cart'
payload = {
"store_id": 20,
"posting_item_id": 8,
"quantity": 6,
"type": "dec",
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"store_id": 20,
"posting_item_id": 8,
"quantity": 6,
"type": "dec",
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/products/1/cart',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Remove Specific Product from Cart
requires authentication
This endpoint allows you to remove a specific product from the customer's cart.
Example request:
curl --request DELETE \
"https://staging-api.hmr.ph/api/v1/carts/deserunt" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/carts/deserunt"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/carts/deserunt';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/carts/deserunt'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.delete(
'https://staging-api.hmr.ph/api/v1/carts/deserunt',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Remove Multiple Products from Cart
requires authentication
This endpoint allows you to remove a specific product from the customer's cart.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/carts/delete" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"carts\": [
4,
6
],
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/carts/delete"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"carts": [
4,
6
],
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/carts/delete';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'carts' => [
4,
6,
],
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/carts/delete'
payload = {
"carts": [
4,
6
],
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"carts": [
4,
6
],
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/carts/delete',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Checkout
Endpoints for managing customer's checkout
Retrieve Checkout Information
requires authentication
This endpoint allows you to retrieve all the stores and product/lot details that are for checkout.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/checkout/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/checkout/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/checkout/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/checkout/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/checkout/1',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Generate Checkout ID
requires authentication
This endpoint allows you to generate checkout id.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/checkout" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"checkout_method\": \"Delivery\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/checkout"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"checkout_method": "Delivery",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/checkout';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'checkout_method' => 'Delivery',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/checkout'
payload = {
"checkout_method": "Delivery",
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"checkout_method": "Delivery",
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/checkout',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Refresh Checkout ID
requires authentication
This endpoint allows you to refresh a checkout id and generate a new checkout id.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/checkout/1/refresh" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/checkout/1/refresh"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/checkout/1/refresh';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/checkout/1/refresh'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/checkout/1/refresh',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Destroy Checkout ID
requires authentication
This endpoint allows you to destroy checkout id.
Example request:
curl --request DELETE \
"https://staging-api.hmr.ph/api/v1/checkout/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/checkout/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/checkout/1';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/checkout/1'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.delete(
'https://staging-api.hmr.ph/api/v1/checkout/1',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Retrieve Applicable Couriers based on Checkout Information
requires authentication
This endpoint allows you to retrieve all the applicable couriers based on products or lots that are for checkout.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/checkout/couriers?checkout_reference_code=dolores&cash_on_delivery=13" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/checkout/couriers"
);
const params = {
"checkout_reference_code": "dolores",
"cash_on_delivery": "13",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/checkout/couriers';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'checkout_reference_code' => 'dolores',
'cash_on_delivery' => '13',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/checkout/couriers'
params = {
'checkout_reference_code': 'dolores',
'cash_on_delivery': '13',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/checkout/couriers',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Retrieve Available Payment Types
requires authentication
This endpoint allows you to retrieve all the available payment types for checkout.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/payment-types?checkout_reference_code=distinctio" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/payment-types"
);
const params = {
"checkout_reference_code": "distinctio",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/payment-types';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'checkout_reference_code' => 'distinctio',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/payment-types'
params = {
'checkout_reference_code': 'distinctio',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/payment-types',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Retrieve Available Vouchers
requires authentication
This endpoint allows you to retrieve all the available vouchers for checkout.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/vouchers" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"shipping_method\": [
{
\"store_id\": 67,
\"store_address_id\": 12,
\"courier_id\": 4,
\"shipping_fee\": 185
}
],
\"checkout_reference_code\": \"cum\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/vouchers"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"shipping_method": [
{
"store_id": 67,
"store_address_id": 12,
"courier_id": 4,
"shipping_fee": 185
}
],
"checkout_reference_code": "cum",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/vouchers';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => \Symfony\Component\VarExporter\Internal\Hydrator::hydrate(
$o = [
clone (\Symfony\Component\VarExporter\Internal\Registry::$prototypes['stdClass'] ?? \Symfony\Component\VarExporter\Internal\Registry::p('stdClass')),
],
null,
[
'stdClass' => [
'store_id' => [
67,
],
'store_address_id' => [
12,
],
'courier_id' => [
4,
],
'shipping_fee' => [
185,
],
],
],
[
'shipping_method' => [
$o[0],
],
'checkout_reference_code' => 'cum',
'signature' => 'No-Example',
],
[]
),
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/vouchers'
payload = {
"shipping_method": [
{
"store_id": 67,
"store_address_id": 12,
"courier_id": 4,
"shipping_fee": 185
}
],
"checkout_reference_code": "cum",
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"shipping_method": [
{
"store_id": 67,
"store_address_id": 12,
"courier_id": 4,
"shipping_fee": 185
}
],
"checkout_reference_code": "cum",
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/vouchers',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Validate Applicable Voucher
requires authentication
This endpoint allows you to validate if a voucher is applicable for the checkout.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/vouchers/validate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"code\": \"expedita\",
\"checkout_reference_code\": \"nihil\",
\"shipping_method\": [
{
\"store_id\": 67,
\"store_address_id\": 12,
\"courier_id\": 4,
\"shipping_fee\": 185
}
],
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/vouchers/validate"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"code": "expedita",
"checkout_reference_code": "nihil",
"shipping_method": [
{
"store_id": 67,
"store_address_id": 12,
"courier_id": 4,
"shipping_fee": 185
}
],
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/vouchers/validate';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => \Symfony\Component\VarExporter\Internal\Hydrator::hydrate(
$o = [
clone (\Symfony\Component\VarExporter\Internal\Registry::$prototypes['stdClass'] ?? \Symfony\Component\VarExporter\Internal\Registry::p('stdClass')),
],
null,
[
'stdClass' => [
'store_id' => [
67,
],
'store_address_id' => [
12,
],
'courier_id' => [
4,
],
'shipping_fee' => [
185,
],
],
],
[
'code' => 'expedita',
'checkout_reference_code' => 'nihil',
'shipping_method' => [
$o[0],
],
'signature' => 'No-Example',
],
[]
),
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/vouchers/validate'
payload = {
"code": "expedita",
"checkout_reference_code": "nihil",
"shipping_method": [
{
"store_id": 67,
"store_address_id": 12,
"courier_id": 4,
"shipping_fee": 185
}
],
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"code": "expedita",
"checkout_reference_code": "nihil",
"shipping_method": [
{
"store_id": 67,
"store_address_id": 12,
"courier_id": 4,
"shipping_fee": 185
}
],
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/vouchers/validate',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Orders
Endpoints for managing customer's order
Retrieve All Customer's Orders
requires authentication
This endpoint allows you to retrieve all the customer's orders.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/orders?action=pagination&order_status=Pending&limit=10" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/orders"
);
const params = {
"action": "pagination",
"order_status": "Pending",
"limit": "10",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/orders';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'action' => 'pagination',
'order_status' => 'Pending',
'limit' => '10',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/orders'
params = {
'action': 'pagination',
'order_status': 'Pending',
'limit': '10',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/orders',
headers
)
p response.body
Example response (200):
[
...
]
Example response (200, Paginated):
{
"current_page": 1,
"data": [
...
],
"first_page_url": "https://staging-api/api/postings/search?page=1",
"from": 1,
"last_page": 3,
"last_page_url": "https://staging-api/api/v1/orders?page=3",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://staging-api/api/v1/orders?page=1",
"label": "1",
"active": true
},
{
"url": "https://staging-api/api/v1/orders?page=2",
"label": "2",
"active": false
},
{
"url": "https://staging-api/api/v1/orders?page=3",
"label": "3",
"active": false
},
{
"url": "https://staging-api/api/v1/orders?page=2",
"label": "Next »",
"active": false
}
],
"next_page_url": "https://staging-api/api/v1/orders?page=2",
"path": "https://staging-api/api/v1/orders",
"per_page": 10,
"prev_page_url": null,
"to": 10,
"total": 25
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Retrieve Specific Order
requires authentication
This endpoint allows you to retrieve the details of a specific order.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/orders/repellat" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/orders/repellat"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/orders/repellat';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/orders/repellat'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/orders/repellat',
headers
)
p response.body
Example response (200):
{
"postings": ...,
"store": ...,
"order": ...,
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Retrieve Order's Payment Status
requires authentication
This endpoint allows you to retrive order's payment status.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/orders/dicta/payments/status" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/orders/dicta/payments/status"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/orders/dicta/payments/status';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/orders/dicta/payments/status'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/orders/dicta/payments/status',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Refresh Non Bank OTC Payments Barcode
requires authentication
This endpoint allows you to refresh expired Non Bank OTC Payments Barcode.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/orders/dicta/payments/refresh-barcode" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/orders/dicta/payments/refresh-barcode"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/orders/dicta/payments/refresh-barcode';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/orders/dicta/payments/refresh-barcode'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/orders/dicta/payments/refresh-barcode',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Create New Order
requires authentication
This endpoint allows you to create a new order.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/orders" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"checkout_reference_code\": \"doloribus\",
\"payment_type_id\": \"est\",
\"address\": 472,
\"shipping_method\": [
{
\"shipping_fee\": 1
}
],
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/orders"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"checkout_reference_code": "doloribus",
"payment_type_id": "est",
"address": 472,
"shipping_method": [
{
"shipping_fee": 1
}
],
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/orders';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'checkout_reference_code' => 'doloribus',
'payment_type_id' => 'est',
'address' => 472,
'shipping_method' => [
[
'shipping_fee' => 1,
],
],
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/orders'
payload = {
"checkout_reference_code": "doloribus",
"payment_type_id": "est",
"address": 472,
"shipping_method": [
{
"shipping_fee": 1
}
],
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"checkout_reference_code": "doloribus",
"payment_type_id": "est",
"address": 472,
"shipping_method": [
{
"shipping_fee": 1
}
],
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/orders',
body ,
headers
)
p response.body
Example response (200):
{
"success": 1,
"data": {
"reference_code": "CLSTLJWX784EXBL2",
"payment_transaction": {
"payment_gateway_reference_code": ...,
"payment_url": ...,
"image_url": ...,
"expiry": ...,
"status": ...
}
},
}
Example response (422):
{
"message": ...,
"errors": {
...
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Cancel Specific Pending Order
requires authentication
This endpoint allows you to cancel a specific pending order.
Example request:
curl --request PATCH \
"https://staging-api.hmr.ph/api/v1/orders/debitis/cancellation" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/orders/debitis/cancellation"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/orders/debitis/cancellation';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/orders/debitis/cancellation'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.patch(
'https://staging-api.hmr.ph/api/v1/orders/debitis/cancellation',
body ,
headers
)
p response.body
Example response (200):
{
"success": 1
}
Example response (403):
{
"message": "Order already paid."
}
Example response (404):
{
"message: "No records found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Account Settings
List of all watchlist and wishlists related endpoints
Wishlist
Endpoints for managing wishlist.
Add product to wishlist.
requires authentication
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/postings/2/wishlists" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/postings/2/wishlists"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/postings/2/wishlists';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/postings/2/wishlists'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/postings/2/wishlists',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Check and retrieve if product is on wishlist.
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/postings/2/wishlists" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/postings/2/wishlists"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/postings/2/wishlists';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/postings/2/wishlists'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/postings/2/wishlists',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of products on wishlist.
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/wishlists?event_id=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/wishlists"
);
const params = {
"event_id": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/wishlists';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'event_id' => '1',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/wishlists'
params = {
'event_id': '1',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/wishlists',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Remove product on wishlist.
requires authentication
Example request:
curl --request DELETE \
"https://staging-api.hmr.ph/api/v1/wishlists/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/wishlists/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/wishlists/1';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/wishlists/1'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.delete(
'https://staging-api.hmr.ph/api/v1/wishlists/1',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Watchlist
Endpoints for managing watchlist.
Count watchers in Posting.
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/postings/2/watchers" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/postings/2/watchers"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/postings/2/watchers';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/postings/2/watchers'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/postings/2/watchers',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Add Lot to watchlist.
requires authentication
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/postings/2/watchlists" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/postings/2/watchlists"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/postings/2/watchlists';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/postings/2/watchlists'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/postings/2/watchlists',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Check and retrieve if product is on watchlist.
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/postings/2/watchlists" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/postings/2/watchlists"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/postings/2/watchlists';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/postings/2/watchlists'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/postings/2/watchlists',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of lots on watchlist.
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/watchlists" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/watchlists"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/watchlists';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/watchlists'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/watchlists',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Remove lots on watchlist
requires authentication
Example request:
curl --request DELETE \
"https://staging-api.hmr.ph/api/v1/watchlists/1377686" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/watchlists/1377686"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/watchlists/1377686';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/watchlists/1377686'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.delete(
'https://staging-api.hmr.ph/api/v1/watchlists/1377686',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
My Bid History
Endpoints for Managing My Bid History.
List of Auctions Where the Customer Has Placed Bids.
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/bid-histories/auctions" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/bid-histories/auctions"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/bid-histories/auctions';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/bid-histories/auctions'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/bid-histories/auctions',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Postings Where the Customer Has Placed Bids.
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/auctions/1/bid-histories?page=1&row_per_page=20&action=pagination&order_by=DESC" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/auctions/1/bid-histories"
);
const params = {
"page": "1",
"row_per_page": "20",
"action": "pagination",
"order_by": "DESC",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/auctions/1/bid-histories';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'page' => '1',
'row_per_page' => '20',
'action' => 'pagination',
'order_by' => 'DESC',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/auctions/1/bid-histories'
params = {
'page': '1',
'row_per_page': '20',
'action': 'pagination',
'order_by': 'DESC',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/auctions/1/bid-histories',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Bid History on Specific Auction Lot Posting (See on Auction Lot Details).
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/postings/1/bid-histories" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/postings/1/bid-histories"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/postings/1/bid-histories';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/postings/1/bid-histories'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/postings/1/bid-histories',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
My Winning Bid
Endpoints for Managing My Winning Bid.
List of Auctions Where the Bidder Has Successful Bids
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/winning-bids/auctions" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/winning-bids/auctions"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/winning-bids/auctions';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/winning-bids/auctions'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/winning-bids/auctions',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Postings Where the Bidder Has Successful Bids
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/auctions/1/winning-bids" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/auctions/1/winning-bids"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/auctions/1/winning-bids';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/auctions/1/winning-bids'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/auctions/1/winning-bids',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Bidder Deposit History
Endpoint for Managing Bidder Deposit History.
Bidder Deposit History.
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/bidder-deposits" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/bidder-deposits"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/bidder-deposits';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/bidder-deposits'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/bidder-deposits',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
QR Code
Endpoint for Managing QR Code.
QR Code
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/qr-code" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/qr-code"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/qr-code';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/qr-code'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/qr-code',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Validate Verification Code
Endpoint for Managing Validation of Verfioation Code.
Validate Verification Code
requires authentication
This endpoint allows you to validate the verification code that will be sent to a specified mobile number/email.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/validate/verification-code" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"verification_type\": \"Email\",
\"verification_code\": \"HMRG360\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/validate/verification-code"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"verification_type": "Email",
"verification_code": "HMRG360",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/validate/verification-code';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'verification_type' => 'Email',
'verification_code' => 'HMRG360',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/validate/verification-code'
payload = {
"verification_type": "Email",
"verification_code": "HMRG360",
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"verification_type": "Email",
"verification_code": "HMRG360",
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/validate/verification-code',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Recently Viewed Products/Lots
Endpoints for managing recently viewed products/lots.
List of Recently Viewed Products/Lots.
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/customer/recently-viewed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/customer/recently-viewed"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/customer/recently-viewed';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/customer/recently-viewed'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/customer/recently-viewed',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Customer Settings
Endpoints for managing Customer Settings.
Getting Customer Settings Data.
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/customer/settings" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/customer/settings"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/customer/settings';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/customer/settings'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/customer/settings',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update Customer Settings.
requires authentication
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/customer/settings?notification=1&outbidded=1&win=1&lot_started=1&lot_ending=1&auction_newsletter=1&retail_newsletter=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/customer/settings"
);
const params = {
"notification": "1",
"outbidded": "1",
"win": "1",
"lot_started": "1",
"lot_ending": "1",
"auction_newsletter": "1",
"retail_newsletter": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/customer/settings';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'notification' => '1',
'outbidded' => '1',
'win' => '1',
'lot_started' => '1',
'lot_ending' => '1',
'auction_newsletter' => '1',
'retail_newsletter' => '1',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/customer/settings'
payload = {
"signature": "No-Example"
}
params = {
'notification': '1',
'outbidded': '1',
'win': '1',
'lot_started': '1',
'lot_ending': '1',
'auction_newsletter': '1',
'retail_newsletter': '1',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload, params=params)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/customer/settings',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Profile Uploader
Endpoint that allows users to upload an image file.
Image Uploader.
requires authentication
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/profile-upload" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--form "signature=No-Example"\
--form "image=@/tmp/phpuRzawH"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/profile-upload"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
const body = new FormData();
body.append('signature', 'No-Example');
body.append('image', document.querySelector('input[name="image"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/profile-upload';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'multipart' => [
[
'name' => 'signature',
'contents' => 'No-Example'
],
[
'name' => 'image',
'contents' => fopen('/tmp/phpuRzawH', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/profile-upload'
files = {
'signature': (None, 'No-Example'),
'image': open('/tmp/phpuRzawH', 'rb')}
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, files=files)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/profile-upload',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Notifications
Endpoints for managing Notifications.
List of Total Notifications on Cart, Watchlist, Wishlist, Unviewed Notifications
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/notifications/count" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/notifications/count"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/notifications/count';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/notifications/count'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/notifications/count',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Notifications.
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/notifications" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/notifications"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/notifications';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/notifications'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/notifications',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Mark As Read a Notification.
requires authentication
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/notifications/viewed?ids[]=1&ids[]=2&ids[]=3&ids[]=4" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/notifications/viewed"
);
const params = {
"ids[0]": "1",
"ids[1]": "2",
"ids[2]": "3",
"ids[3]": "4",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/notifications/viewed';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'ids[0]' => '1',
'ids[1]' => '2',
'ids[2]' => '3',
'ids[3]' => '4',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/notifications/viewed'
payload = {
"signature": "No-Example"
}
params = {
'ids[0]': '1',
'ids[1]': '2',
'ids[2]': '3',
'ids[3]': '4',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload, params=params)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/notifications/viewed',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Address
List of all Adress related endpoints
Customer Address
Endpoints for Customer Address
Get Customer Address.
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/api/customer/addresses" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/api/customer/addresses"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/api/customer/addresses';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/api/customer/addresses'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/api/customer/addresses',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Create New Customer Address.
requires authentication
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/api/customer/addresses" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"contact_person\": \"John Doe\",
\"contact_number\": 9615920331,
\"additional_information\": \"Lot 1\",
\"province\": \"Cavite\",
\"city\": \"Bacoor\",
\"barangay\": \"Queenst Row East\",
\"zipcode\": 4102,
\"label\": \"Home\",
\"delivery_instructions\": \"Please Handle With Care\",
\"google_places_id\": 4102,
\"latitude\": 4102,
\"longitude\": 4102,
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/api/customer/addresses"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"contact_person": "John Doe",
"contact_number": 9615920331,
"additional_information": "Lot 1",
"province": "Cavite",
"city": "Bacoor",
"barangay": "Queenst Row East",
"zipcode": 4102,
"label": "Home",
"delivery_instructions": "Please Handle With Care",
"google_places_id": 4102,
"latitude": 4102,
"longitude": 4102,
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/api/customer/addresses';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'contact_person' => 'John Doe',
'contact_number' => 9615920331,
'additional_information' => 'Lot 1',
'province' => 'Cavite',
'city' => 'Bacoor',
'barangay' => 'Queenst Row East',
'zipcode' => 4102,
'label' => 'Home',
'delivery_instructions' => 'Please Handle With Care',
'google_places_id' => 4102,
'latitude' => 4102,
'longitude' => 4102,
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/api/customer/addresses'
payload = {
"contact_person": "John Doe",
"contact_number": 9615920331,
"additional_information": "Lot 1",
"province": "Cavite",
"city": "Bacoor",
"barangay": "Queenst Row East",
"zipcode": 4102,
"label": "Home",
"delivery_instructions": "Please Handle With Care",
"google_places_id": 4102,
"latitude": 4102,
"longitude": 4102,
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"contact_person": "John Doe",
"contact_number": 9615920331,
"additional_information": "Lot 1",
"province": "Cavite",
"city": "Bacoor",
"barangay": "Queenst Row East",
"zipcode": 4102,
"label": "Home",
"delivery_instructions": "Please Handle With Care",
"google_places_id": 4102,
"latitude": 4102,
"longitude": 4102,
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/api/customer/addresses',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update Customer Address
requires authentication
Example request:
curl --request PATCH \
"https://staging-api.hmr.ph/api/v1/api/customer/expedita/addresses?contact_person=John+Doe&contact_number=9615920331&additional_information=Lot+1&province=Cavite&city=Bacoor&barangay=Queenst+Row+East&zipcode=4102&google_places_id=4102&latitude=4102&longitude=4102" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"contact_person\": \"incidunt\",
\"contact_number\": \"(639\",
\"additional_information\": \"ducimus\",
\"province\": \"quia\",
\"city\": \"consectetur\",
\"barangay\": \"non\",
\"zipcode\": \"praesentium\",
\"delivery_instructions\": \"Please Handle With Care\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/api/customer/expedita/addresses"
);
const params = {
"contact_person": "John Doe",
"contact_number": "9615920331",
"additional_information": "Lot 1",
"province": "Cavite",
"city": "Bacoor",
"barangay": "Queenst Row East",
"zipcode": "4102",
"google_places_id": "4102",
"latitude": "4102",
"longitude": "4102",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"contact_person": "incidunt",
"contact_number": "(639",
"additional_information": "ducimus",
"province": "quia",
"city": "consectetur",
"barangay": "non",
"zipcode": "praesentium",
"delivery_instructions": "Please Handle With Care",
"signature": "No-Example"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/api/customer/expedita/addresses';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'contact_person' => 'John Doe',
'contact_number' => '9615920331',
'additional_information' => 'Lot 1',
'province' => 'Cavite',
'city' => 'Bacoor',
'barangay' => 'Queenst Row East',
'zipcode' => '4102',
'google_places_id' => '4102',
'latitude' => '4102',
'longitude' => '4102',
],
'json' => [
'contact_person' => 'incidunt',
'contact_number' => '(639',
'additional_information' => 'ducimus',
'province' => 'quia',
'city' => 'consectetur',
'barangay' => 'non',
'zipcode' => 'praesentium',
'delivery_instructions' => 'Please Handle With Care',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/api/customer/expedita/addresses'
payload = {
"contact_person": "incidunt",
"contact_number": "(639",
"additional_information": "ducimus",
"province": "quia",
"city": "consectetur",
"barangay": "non",
"zipcode": "praesentium",
"delivery_instructions": "Please Handle With Care",
"signature": "No-Example"
}
params = {
'contact_person': 'John Doe',
'contact_number': '9615920331',
'additional_information': 'Lot 1',
'province': 'Cavite',
'city': 'Bacoor',
'barangay': 'Queenst Row East',
'zipcode': '4102',
'google_places_id': '4102',
'latitude': '4102',
'longitude': '4102',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('PATCH', url, headers=headers, json=payload, params=params)
response.json()
require 'rest-client'
body = {
"contact_person": "incidunt",
"contact_number": "(639",
"additional_information": "ducimus",
"province": "quia",
"city": "consectetur",
"barangay": "non",
"zipcode": "praesentium",
"delivery_instructions": "Please Handle With Care",
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.patch(
'https://staging-api.hmr.ph/api/v1/api/customer/expedita/addresses',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Delete Customer Address
Example request:
curl --request DELETE \
"https://staging-api.hmr.ph/api/v1/api/customer/aut/addresses" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/api/customer/aut/addresses"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/api/customer/aut/addresses';
$response = $client->delete(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/api/customer/aut/addresses'
payload = {
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.delete(
'https://staging-api.hmr.ph/api/v1/api/customer/aut/addresses',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Set To Default Address.
Example request:
curl --request PATCH \
"https://staging-api.hmr.ph/api/v1/api/address/omnis/default" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/api/address/omnis/default"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/api/address/omnis/default';
$response = $client->patch(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/api/address/omnis/default'
payload = {
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.patch(
'https://staging-api.hmr.ph/api/v1/api/address/omnis/default',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Address
Endpoints for getting Address
1. Get Provinces.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/provinces" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/provinces"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/provinces';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/provinces'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/provinces',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 8
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
2. Get Municipalites on specific Province
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/provinces/non/municipalities" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/provinces/non/municipalities"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/provinces/non/municipalities';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/provinces/non/municipalities'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/provinces/non/municipalities',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 7
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
3. Get Baranggays on specific Municipality
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/municipalities/iusto/barangays" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/municipalities/iusto/barangays"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/municipalities/iusto/barangays';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/municipalities/iusto/barangays'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/municipalities/iusto/barangays',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 6
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
4. Get Zip Codes.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/zipcodes?province=Cavite" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/zipcodes"
);
const params = {
"province": "Cavite",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/zipcodes';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'province' => 'Cavite',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/zipcodes'
params = {
'province': 'Cavite',
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/zipcodes',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 5
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Ads
This endpoint retrieves ads based on specific criteria.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/ads?type=landing_page" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/ads"
);
const params = {
"type": "landing_page",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/ads';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'type' => 'landing_page',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/ads'
params = {
'type': 'landing_page',
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/ads',
headers
)
p response.body
Example response (200):
{
"id": 21,
"sequence": 1,
"featured": 1,
"banner": "/images/ads/new_stock_lot.jpg",
"mobile_banner": "/images/ads/new_stock_lot.jpg",
"ads_name": "International Stock Lots",
"ads_link": "search#/stock-lots",
"active": 1,
"created_by": 94,
"modified_by": 94,
"created_at": "2022-06-30T14:22:29.000000Z",
"updated_at": "2023-03-11T11:48:11.000000Z",
"orientation": "Landscape"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Response
Response Fields
id
integer
The ID of the ad.
title
string
The title or name of the ad.
description
string
A brief description of the ad.
image_url
string
The URL of the ad's image.
Auctions
List of all auction related endpoints.
Lot Details
This endpoint allows you to retrieve the Lot Details.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/lot/1-mc-laren-750-s-sntj9" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/lot/1-mc-laren-750-s-sntj9"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {YOUR_AUTH_KEY}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/lot/1-mc-laren-750-s-sntj9';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/lot/1-mc-laren-750-s-sntj9'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example',
'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {YOUR_AUTH_KEY}",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/lot/1-mc-laren-750-s-sntj9',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 49
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Lots under specific Auction
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/lots?category=Simulcast&page=1&row_per_page=20&action=pagination&order_by=DESC" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/lots"
);
const params = {
"category": "Simulcast",
"page": "1",
"row_per_page": "20",
"action": "pagination",
"order_by": "DESC",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/lots';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'category' => 'Simulcast',
'page' => '1',
'row_per_page' => '20',
'action' => 'pagination',
'order_by' => 'DESC',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/lots'
params = {
'category': 'Simulcast',
'page': '1',
'row_per_page': '20',
'action': 'pagination',
'order_by': 'DESC',
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/lots',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 48
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Active Auction Locations
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/auctions/locations" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/auctions/locations"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/auctions/locations';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/auctions/locations'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/auctions/locations',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 47
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Retrieve Specific Auction Details
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/auctions/occaecati" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/auctions/occaecati"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/auctions/occaecati';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/auctions/occaecati'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/auctions/occaecati',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 46
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Auctions
This endpoint allows you to retrieve the list of auctions.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/auctions?type=ongoing&auction_locations=&page=1&row_per_page=20&action=pagination&order_by=DESC" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/auctions"
);
const params = {
"type": "ongoing",
"auction_locations": "",
"page": "1",
"row_per_page": "20",
"action": "pagination",
"order_by": "DESC",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {YOUR_AUTH_KEY}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/auctions';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
],
'query' => [
'type' => 'ongoing',
'auction_locations' => '',
'page' => '1',
'row_per_page' => '20',
'action' => 'pagination',
'order_by' => 'DESC',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/auctions'
params = {
'type': 'ongoing',
'auction_locations': '',
'page': '1',
'row_per_page': '20',
'action': 'pagination',
'order_by': 'DESC',
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example',
'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {YOUR_AUTH_KEY}",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/auctions',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 45
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Auction Postings
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/postings/auctions" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/postings/auctions"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/postings/auctions';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/postings/auctions'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/postings/auctions',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 44
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Simulcast Auction
This endpoint allows you retrieve specific Simulcast auction details.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/simulcast" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/simulcast"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {YOUR_AUTH_KEY}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/simulcast';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/simulcast'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example',
'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {YOUR_AUTH_KEY}",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/simulcast',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 43
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Simulcast Auction Winning Lots
requires authentication
This endpoint allows you to retrieve the winning lots of Simulcast Auction.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/winning-lots" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/winning-lots"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/winning-lots';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/winning-lots'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/winning-lots',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Simulcast Bidder Agreement
requires authentication
This endpoint allows you to Agree on Auction Terms And Conditions.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/agreement" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/agreement"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/agreement';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/agreement'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/auctions/0002-dev-monthly-public-auction-automotives/agreement',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Simulcast Set Pin Location
requires authentication
This endpoint allows you to set your current City Location.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/customer-location" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"city\": \"doloribus\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/customer-location"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"city": "doloribus",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/customer-location';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'city' => 'doloribus',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/customer-location'
payload = {
"city": "doloribus",
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"city": "doloribus",
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/customer-location',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Auction Related Lots
Generate Stream Token for Simulcast Auction
requires authentication
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/auction/stream/et/generate-token" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/auction/stream/et/generate-token"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/auction/stream/et/generate-token';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/auction/stream/et/generate-token'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/auction/stream/et/generate-token',
body ,
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 3
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Bidder Deposits
Endpoint for managing auction bidder deposits.
Generate Bid Deposit for a Specific Auction
requires authentication
This endpoint allows you to generate bid deposit for a specific auction.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/auctions/1/bidder-deposits" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/auctions/1/bidder-deposits"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/auctions/1/bidder-deposits';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/auctions/1/bidder-deposits'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/auctions/1/bidder-deposits',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Retrieve Bidder Deposit's Payment Status
requires authentication
This endpoint allows you to retrive bidder deposit's payment status.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/bidder-deposits/earum/payments/status" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/bidder-deposits/earum/payments/status"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/bidder-deposits/earum/payments/status';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/bidder-deposits/earum/payments/status'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/bidder-deposits/earum/payments/status',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Process Payment for a Specified Bidder Deposit
requires authentication
This endpoint allows you to process the payment for a specified bidder deposit.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/bidder-deposits/BD-4XGU77X/payments" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"payment_type_id\": \"1\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/bidder-deposits/BD-4XGU77X/payments"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"payment_type_id": "1",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/bidder-deposits/BD-4XGU77X/payments';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'payment_type_id' => '1',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/bidder-deposits/BD-4XGU77X/payments'
payload = {
"payment_type_id": "1",
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"payment_type_id": "1",
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/bidder-deposits/BD-4XGU77X/payments',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Retrieve Available Payment Types for Bid Deposit
requires authentication
This endpoint allows you to retrieve all the available payment types for bidder deposit.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/bidder-deposits/BD-4XGU77X/payment-types" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/bidder-deposits/BD-4XGU77X/payment-types"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/bidder-deposits/BD-4XGU77X/payment-types';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/bidder-deposits/BD-4XGU77X/payment-types'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/bidder-deposits/BD-4XGU77X/payment-types',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Private Auction
Endpoint for managing private auction.
Request an access to have an access on a Private Auction
requires authentication
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/api/auctions/1/access-request" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/api/auctions/1/access-request"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/api/auctions/1/access-request';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/api/auctions/1/access-request'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/api/auctions/1/access-request',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Check if Bidder is already given an access on specific Private Auction
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/api/auctions/1/access-request" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/api/auctions/1/access-request"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/api/auctions/1/access-request';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/api/auctions/1/access-request'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/api/auctions/1/access-request',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Brands
List of Featured Brands
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/featured-brands" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/featured-brands"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/featured-brands';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/featured-brands'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/featured-brands',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 26
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Categories
List of Categories
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/categories" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/categories"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/categories';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/categories'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/categories',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 36
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Featured Categories
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/featured-categories" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/featured-categories"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/featured-categories';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/featured-categories'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/featured-categories',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 35
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Endpoints
Retrieve Specific Product.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/product/laudantium" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/product/laudantium"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/product/laudantium';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/product/laudantium'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/product/laudantium',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 15
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Remove the specified resource from storage.
Example request:
curl --request DELETE \
"https://staging-api.hmr.ph/api/v1/addresses/nostrum" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/addresses/nostrum"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/addresses/nostrum';
$response = $client->delete(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/addresses/nostrum'
payload = {
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.delete(
'https://staging-api.hmr.ph/api/v1/addresses/nostrum',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update the specified resource in storage.
Example request:
curl --request PATCH \
"https://staging-api.hmr.ph/api/v1/addresses/impedit" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/addresses/impedit"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/addresses/impedit';
$response = $client->patch(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/addresses/impedit'
payload = {
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.patch(
'https://staging-api.hmr.ph/api/v1/addresses/impedit',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Display the specified resource.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/addresses/et" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/addresses/et"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/addresses/et';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/addresses/et'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/addresses/et',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Display a listing of the resource.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/addresses" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/addresses"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/addresses';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/addresses'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/addresses',
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Store a newly created resource in storage.
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/addresses" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"contact_person\": \"omnis\",
\"contact_number\": \"(639\",
\"additional_information\": \"laudantium\",
\"province\": \"adipisci\",
\"city\": \"expedita\",
\"barangay\": \"consectetur\",
\"zipcode\": \"culpa\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/addresses"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"contact_person": "omnis",
"contact_number": "(639",
"additional_information": "laudantium",
"province": "adipisci",
"city": "expedita",
"barangay": "consectetur",
"zipcode": "culpa",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/addresses';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'contact_person' => 'omnis',
'contact_number' => '(639',
'additional_information' => 'laudantium',
'province' => 'adipisci',
'city' => 'expedita',
'barangay' => 'consectetur',
'zipcode' => 'culpa',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/addresses'
payload = {
"contact_person": "omnis",
"contact_number": "(639",
"additional_information": "laudantium",
"province": "adipisci",
"city": "expedita",
"barangay": "consectetur",
"zipcode": "culpa",
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"contact_person": "omnis",
"contact_number": "(639",
"additional_information": "laudantium",
"province": "adipisci",
"city": "expedita",
"barangay": "consectetur",
"zipcode": "culpa",
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/addresses',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Flash Sale
List of Flash Sales
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/flash-sale" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/flash-sale"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/flash-sale';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/flash-sale'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/flash-sale',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 19
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Inquiries
List of all Inquiries related endpoints.
List of Stores for Sell With Us
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/contact-us/stores" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/contact-us/stores"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/contact-us/stores';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/contact-us/stores'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/contact-us/stores',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 13
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Contact Us
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/inquiries" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"full_name\": \"Jerome Edward\",
\"company\": \"HMR\",
\"mobile_no\": \"09817492245\",
\"email\": \"edward@gmail.com\",
\"address\": \"CAVITE\",
\"subject\": \"FOr INQUIRY\",
\"message\": \"TEST MEASSAGE\",
\"concern\": \"Auction or Retail\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/inquiries"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"full_name": "Jerome Edward",
"company": "HMR",
"mobile_no": "09817492245",
"email": "edward@gmail.com",
"address": "CAVITE",
"subject": "FOr INQUIRY",
"message": "TEST MEASSAGE",
"concern": "Auction or Retail",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/inquiries';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'full_name' => 'Jerome Edward',
'company' => 'HMR',
'mobile_no' => '09817492245',
'email' => 'edward@gmail.com',
'address' => 'CAVITE',
'subject' => 'FOr INQUIRY',
'message' => 'TEST MEASSAGE',
'concern' => 'Auction or Retail',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/inquiries'
payload = {
"full_name": "Jerome Edward",
"company": "HMR",
"mobile_no": "09817492245",
"email": "edward@gmail.com",
"address": "CAVITE",
"subject": "FOr INQUIRY",
"message": "TEST MEASSAGE",
"concern": "Auction or Retail",
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"full_name": "Jerome Edward",
"company": "HMR",
"mobile_no": "09817492245",
"email": "edward@gmail.com",
"address": "CAVITE",
"subject": "FOr INQUIRY",
"message": "TEST MEASSAGE",
"concern": "Auction or Retail",
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/inquiries',
body ,
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 12
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Posting Inquiry
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/posting/2024/contact-us" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"full_name\": \"Edward\",
\"mobile_no\": \"12345678910\",
\"email\": \"Edward@gmail.com\",
\"message\": \"Test Message\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/posting/2024/contact-us"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"full_name": "Edward",
"mobile_no": "12345678910",
"email": "Edward@gmail.com",
"message": "Test Message",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/posting/2024/contact-us';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'full_name' => 'Edward',
'mobile_no' => '12345678910',
'email' => 'Edward@gmail.com',
'message' => 'Test Message',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/posting/2024/contact-us'
payload = {
"full_name": "Edward",
"mobile_no": "12345678910",
"email": "Edward@gmail.com",
"message": "Test Message",
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"full_name": "Edward",
"mobile_no": "12345678910",
"email": "Edward@gmail.com",
"message": "Test Message",
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/posting/2024/contact-us',
body ,
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 11
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Store Inquiries
requires authentication
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/posting/2024/store-inquiry" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"message\": \"Test Message\",
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/posting/2024/store-inquiry"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"message": "Test Message",
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/posting/2024/store-inquiry';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'message' => 'Test Message',
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/posting/2024/store-inquiry'
payload = {
"message": "Test Message",
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"message": "Test Message",
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/posting/2024/store-inquiry',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Just For you
List of all Just For You related endpoints
List of "Just For You" Related Categories
This endpoint allows you to retrieve categories based on the customer's search histories.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/just-for-you/categories?search[]=tv&search[]=watch&search[]=electronics&search[]=appliances&action=%22pagination%22" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/just-for-you/categories"
);
const params = {
"search[0]": "tv",
"search[1]": "watch",
"search[2]": "electronics",
"search[3]": "appliances",
"action": ""pagination"",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/just-for-you/categories';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'search[0]' => 'tv',
'search[1]' => 'watch',
'search[2]' => 'electronics',
'search[3]' => 'appliances',
'action' => '"pagination"',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/just-for-you/categories'
params = {
'search[0]': 'tv',
'search[1]': 'watch',
'search[2]': 'electronics',
'search[3]': 'appliances',
'action': '"pagination"',
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/just-for-you/categories',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 25
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of "Just For You" Related Products
This endpoint allows you to retrieve products based on the customer's search histories.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/just-for-you?search[]=tv&search[]=watch&search[]=electronics&search[]=appliances&random=1&action=%22pagination%22" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/just-for-you"
);
const params = {
"search[0]": "tv",
"search[1]": "watch",
"search[2]": "electronics",
"search[3]": "appliances",
"random": "1",
"action": ""pagination"",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/just-for-you';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'search[0]' => 'tv',
'search[1]' => 'watch',
'search[2]' => 'electronics',
'search[3]' => 'appliances',
'random' => '1',
'action' => '"pagination"',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/just-for-you'
params = {
'search[0]': 'tv',
'search[1]': 'watch',
'search[2]': 'electronics',
'search[3]': 'appliances',
'random': '1',
'action': '"pagination"',
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/just-for-you',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 24
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Key Visuals
List of Key Visuals
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/key-visuals" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/key-visuals"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/key-visuals';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/key-visuals'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/key-visuals',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Onsite Auctions
API for managing Onsite Auctions
Searching Function
Display All available Filters for specific Item Category Type. Please visit this link for reference (See the sidebar) : https://hmr.ph/heavy-equipment#/
GET api/v1/item-category-types/filters
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/item-category-types/filters?item_category_type=Automotives" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/item-category-types/filters"
);
const params = {
"item_category_type": "Automotives",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/item-category-types/filters';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'item_category_type' => 'Automotives',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/item-category-types/filters'
params = {
'item_category_type': 'Automotives',
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/item-category-types/filters',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 34
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Automotives
API for managing "Automotives" Postings. This endpoint allows you to get all automotive postings and search for items based on specific category type filters (All Array parameters is based on specific item category type filter.). Use the provided parameters to filter your search according to your needs.
GET api/v1/item-category-types/automotives
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/item-category-types/automotives?page=1&row_per_page=20&action=pagination&sort_by=Newest&model%5B%5D[]=fuga&year%5B%5D[]=neque&color%5B%5D[]=voluptates&transmission%5B%5D[]=consequatur&fuel_type%5B%5D[]=autem&body_type%5B%5D[]=ipsum" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/item-category-types/automotives"
);
const params = {
"page": "1",
"row_per_page": "20",
"action": "pagination",
"sort_by": "Newest",
"model[][0]": "fuga",
"year[][0]": "neque",
"color[][0]": "voluptates",
"transmission[][0]": "consequatur",
"fuel_type[][0]": "autem",
"body_type[][0]": "ipsum",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/item-category-types/automotives';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'page' => '1',
'row_per_page' => '20',
'action' => 'pagination',
'sort_by' => 'Newest',
'model[][0]' => 'fuga',
'year[][0]' => 'neque',
'color[][0]' => 'voluptates',
'transmission[][0]' => 'consequatur',
'fuel_type[][0]' => 'autem',
'body_type[][0]' => 'ipsum',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/item-category-types/automotives'
params = {
'page': '1',
'row_per_page': '20',
'action': 'pagination',
'sort_by': 'Newest',
'model[][0]': 'fuga',
'year[][0]': 'neque',
'color[][0]': 'voluptates',
'transmission[][0]': 'consequatur',
'fuel_type[][0]': 'autem',
'body_type[][0]': 'ipsum',
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/item-category-types/automotives',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 33
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Heavy Equipments
API for managing "Heavy Equipment" Postings. This endpoint allows you to get all automotive postings and search for items based on specific category type filters (All Array parameters is based on specific item category type filter.). Use the provided parameters to filter your search according to your needs.
GET api/v1/item-category-types/heavy-equipments
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/item-category-types/heavy-equipments?page=1&row_per_page=20&action=pagination&sort_by=Newest&model%5B%5D[]=quia&year%5B%5D[]=suscipit&condition%5B%5D[]=voluptates&location%5B%5D[]=illum" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/item-category-types/heavy-equipments"
);
const params = {
"page": "1",
"row_per_page": "20",
"action": "pagination",
"sort_by": "Newest",
"model[][0]": "quia",
"year[][0]": "suscipit",
"condition[][0]": "voluptates",
"location[][0]": "illum",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/item-category-types/heavy-equipments';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'page' => '1',
'row_per_page' => '20',
'action' => 'pagination',
'sort_by' => 'Newest',
'model[][0]' => 'quia',
'year[][0]' => 'suscipit',
'condition[][0]' => 'voluptates',
'location[][0]' => 'illum',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/item-category-types/heavy-equipments'
params = {
'page': '1',
'row_per_page': '20',
'action': 'pagination',
'sort_by': 'Newest',
'model[][0]': 'quia',
'year[][0]': 'suscipit',
'condition[][0]': 'voluptates',
'location[][0]': 'illum',
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/item-category-types/heavy-equipments',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 32
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Real Estates
API for managing "Real Estates" Postings. This endpoint allows you to get all automotive postings and search for items based on specific category type filters (All Array parameters is based on specific item category type filter.). Use the provided parameters to filter your search according to your needs.
GET api/v1/item-category-types/real-estates
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/item-category-types/real-estates?page=1&row_per_page=20&action=pagination&sort_by=Newest&type_of_property%5B%5D[]=minima&bedroom%5B%5D[]=voluptatem&bathroom%5B%5D[]=quaerat" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/item-category-types/real-estates"
);
const params = {
"page": "1",
"row_per_page": "20",
"action": "pagination",
"sort_by": "Newest",
"type_of_property[][0]": "minima",
"bedroom[][0]": "voluptatem",
"bathroom[][0]": "quaerat",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/item-category-types/real-estates';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'page' => '1',
'row_per_page' => '20',
'action' => 'pagination',
'sort_by' => 'Newest',
'type_of_property[][0]' => 'minima',
'bedroom[][0]' => 'voluptatem',
'bathroom[][0]' => 'quaerat',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/item-category-types/real-estates'
params = {
'page': '1',
'row_per_page': '20',
'action': 'pagination',
'sort_by': 'Newest',
'type_of_property[][0]': 'minima',
'bedroom[][0]': 'voluptatem',
'bathroom[][0]': 'quaerat',
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/item-category-types/real-estates',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 31
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Automotive Posting Details
API for showing one specific Automotive posting.
GET api/v1/automotive/{slug}/details
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/automotive/1-2022-mitsubishi-mirage-g-4-glx-3biyg/details" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/automotive/1-2022-mitsubishi-mirage-g-4-glx-3biyg/details"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/automotive/1-2022-mitsubishi-mirage-g-4-glx-3biyg/details';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/automotive/1-2022-mitsubishi-mirage-g-4-glx-3biyg/details'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/automotive/1-2022-mitsubishi-mirage-g-4-glx-3biyg/details',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 30
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Heavy Equipment Posting Details
API for showing one specific Heavy Equipment posting.
GET api/v1/heavy-equipment/{slug}/details
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/heavy-equipment/12-truck-and-machinery-auction-lot-12-pod23/details" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/heavy-equipment/12-truck-and-machinery-auction-lot-12-pod23/details"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/heavy-equipment/12-truck-and-machinery-auction-lot-12-pod23/details';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/heavy-equipment/12-truck-and-machinery-auction-lot-12-pod23/details'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/heavy-equipment/12-truck-and-machinery-auction-lot-12-pod23/details',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 29
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Real Estate Posting Details
API for showing one specific Real Estate posting.
GET api/v1/real-estate/{slug}/details
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/real-estate/hotel-building-in-poblacion-makati-city-ah7kp/details" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/real-estate/hotel-building-in-poblacion-makati-city-ah7kp/details"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/real-estate/hotel-building-in-poblacion-makati-city-ah7kp/details';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/real-estate/hotel-building-in-poblacion-makati-city-ah7kp/details'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/real-estate/hotel-building-in-poblacion-makati-city-ah7kp/details',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 28
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Postings
Posting Terms and Condition Endpoint
List of all Available Posting Categories
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/postings/categories" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/postings/categories"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/postings/categories';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/postings/categories'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/postings/categories',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of all Available Posting Sub Categories
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/postings/sub-categories" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/postings/sub-categories"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/postings/sub-categories';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/postings/sub-categories'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/postings/sub-categories',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 58
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of all Available Posting Stores
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/postings/stores" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/postings/stores"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/postings/stores';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/postings/stores'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/postings/stores',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 57
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of all Available Posting Brands
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/postings/brands" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/postings/brands"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/postings/brands';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/postings/brands'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/postings/brands',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 56
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of all Available Posting Tags
Search Function
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/postings/search?q=aircon&category=Retail&offers=1&stores=53&categories=1&sub_categories=3&brands=2&page=1&row_per_page=20&action=pagination&sort_by=Newest" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/postings/search"
);
const params = {
"q": "aircon",
"category": "Retail",
"offers": "1",
"stores": "53",
"categories": "1",
"sub_categories": "3",
"brands": "2",
"page": "1",
"row_per_page": "20",
"action": "pagination",
"sort_by": "Newest",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/postings/search';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'q' => 'aircon',
'category' => 'Retail',
'offers' => '1',
'stores' => '53',
'categories' => '1',
'sub_categories' => '3',
'brands' => '2',
'page' => '1',
'row_per_page' => '20',
'action' => 'pagination',
'sort_by' => 'Newest',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/postings/search'
params = {
'q': 'aircon',
'category': 'Retail',
'offers': '1',
'stores': '53',
'categories': '1',
'sub_categories': '3',
'brands': '2',
'page': '1',
'row_per_page': '20',
'action': 'pagination',
'sort_by': 'Newest',
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/postings/search',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 54
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Get Terms and Condition of postings.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/postings/2/terms" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/postings/2/terms"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/postings/2/terms';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/postings/2/terms'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/postings/2/terms',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 9
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Quicklinks
List of Quicklinks
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/quick-links" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/quick-links"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/quick-links';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/quick-links'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/quick-links',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 52
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Mobile Quicklinks
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/mobile-quick-links" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/mobile-quick-links"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/mobile-quick-links';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/mobile-quick-links'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/mobile-quick-links',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 51
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Related Items
List of Related Items on active/showed Item
Retail Events (Live Selling)
Live Selling Details
List of Retail Events
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/retail-events?type=ongoing" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/retail-events"
);
const params = {
"type": "ongoing",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/retail-events';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'query' => [
'type' => 'ongoing',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/retail-events'
params = {
'type': 'ongoing',
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/retail-events',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 42
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Live Selling Details
This endpoint allows you to retrieve the list of auctions.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/live-selling/pioneer-live-selling-oct20" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/live-selling/pioneer-live-selling-oct20"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {YOUR_AUTH_KEY}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/live-selling/pioneer-live-selling-oct20';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/live-selling/pioneer-live-selling-oct20'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example',
'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {YOUR_AUTH_KEY}",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/live-selling/pioneer-live-selling-oct20',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 17
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Carts under Live Selling
requires authentication
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/events/2/carts" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/events/2/carts"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/events/2/carts';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/events/2/carts'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/events/2/carts',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 16
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Retail Event Postings This endpoint allows you to retrieve the list of auctions. <aside class="notice">The "<b>Authorization</b>" header is <b>optional</b>. This endpoint will get if session token is supplied.</aside>
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/live-selling/pioneer-first-event-testing/products?category=Live+Selling&page=1&row_per_page=20&action=pagination&sort_by=Newest" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/live-selling/pioneer-first-event-testing/products"
);
const params = {
"category": "Live Selling",
"page": "1",
"row_per_page": "20",
"action": "pagination",
"sort_by": "Newest",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {YOUR_AUTH_KEY}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/live-selling/pioneer-first-event-testing/products';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
],
'query' => [
'category' => 'Live Selling',
'page' => '1',
'row_per_page' => '20',
'action' => 'pagination',
'sort_by' => 'Newest',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/live-selling/pioneer-first-event-testing/products'
params = {
'category': 'Live Selling',
'page': '1',
'row_per_page': '20',
'action': 'pagination',
'sort_by': 'Newest',
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example',
'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
"Authorization": "Bearer {YOUR_AUTH_KEY}",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/live-selling/pioneer-first-event-testing/products',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 14
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Event Customers Agreement (Live Selling)
requires authentication
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/events/pioneer-test-event1/agreement" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/events/pioneer-test-event1/agreement"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/events/pioneer-test-event1/agreement';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/events/pioneer-test-event1/agreement'
payload = {
"signature": "No-Example"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/events/pioneer-test-event1/agreement',
body ,
headers
)
p response.body
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Retail Events
Example request:
curl --request POST \
"https://staging-api.hmr.ph/api/v1/retail/stream/eius/generate-token" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example" \
--data "{
\"signature\": \"No-Example\"
}"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/retail/stream/eius/generate-token"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
let body = {
"signature": "No-Example"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/retail/stream/eius/generate-token';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
'json' => [
'signature' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/retail/stream/eius/generate-token'
payload = {
"signature": "No-Example"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
require 'rest-client'
body = {
"signature": "No-Example"
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.post(
'https://staging-api.hmr.ph/api/v1/retail/stream/eius/generate-token',
body ,
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 4
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Section Tags
List of Section Tag
List of Section Tag Categories
Getting Tags on Parameter Column
Sections
Show Section Detail
Display a listing of the resource.
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/sections/Just For You" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/sections/Just For You"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/sections/Just For You';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/sections/Just For You'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/sections/Just For You',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 50
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List of Section Banners
Stores
List of all Stores related endpoints.
List of Stores
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/stores" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/stores"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/stores';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/stores'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/stores',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 41
access-control-allow-origin: *
{
"message": "Forbidden"
}
Example response (404):
{
"message": "Page Not Found."
}
Example response (429):
{
"message": "Too Many Requests."
}
Example response (500):
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Show Store Details
Example request:
curl --request GET \
--get "https://staging-api.hmr.ph/api/v1/stores/18/detail" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: No-Example" \
--header "X-Client-ID: No-Example"
const url = new URL(
"https://staging-api.hmr.ph/api/v1/stores/18/detail"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://staging-api.hmr.ph/api/v1/stores/18/detail';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Key' => 'No-Example',
'X-Client-ID' => 'No-Example',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://staging-api.hmr.ph/api/v1/stores/18/detail'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Key': 'No-Example',
'X-Client-ID': 'No-Example'
}
response = requests.request('GET', url, headers=headers)
response.json()
require 'rest-client'
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"X-Api-Key": "No-Example",
"X-Client-ID": "No-Example",
}
response = RestClient.get(
'https://staging-api.hmr.ph/api/v1/stores/18/detail',
headers
)
p response.body
Example response (403):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 40
access-control-allow-origin: *
{
"message": "Forbidden"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Tags
List of Tag Categories
List of Posting under specific Tags
List of Featured Tags
Show Detail of Tag