https://github.com/grab/grabfood-api-sdk-java
Java API client for GrabFood
https://github.com/grab/grabfood-api-sdk-java
grab grabfood java-client openapi
Last synced: 6 months ago
JSON representation
Java API client for GrabFood
- Host: GitHub
- URL: https://github.com/grab/grabfood-api-sdk-java
- Owner: grab
- License: mit
- Created: 2024-09-11T05:47:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-14T08:27:18.000Z (12 months ago)
- Last Synced: 2025-01-14T09:34:12.454Z (12 months ago)
- Topics: grab, grabfood, java-client, openapi
- Language: Java
- Homepage: https://developer.grab.com
- Size: 451 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Java API client for GrabFood
- API version: 1.1.3
- Generator version: 7.8.0
For more information, please visit [https://developer.grab.com](https://developer.grab.com)
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
## Requirements
Building the API client library requires:
1. Java 1.8+
2. Maven/Gradle
## Installation
To install the API client library to your local Maven repository, simply execute:
```shell
mvn clean install
```
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
```shell
mvn clean deploy
```
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
### Maven users
Add this dependency to your project's POM:
```xml
com.grab
grabfood-api-sdk-java
1.0.2
compile
```
### Gradle users
Add this dependency to your project's build file:
```groovy
repositories {
mavenCentral() // Needed if the 'grabfood-api-sdk-java' jar has been published to maven central.
mavenLocal() // Needed if the 'grabfood-api-sdk-java' jar has been published to the local maven repo.
}
dependencies {
implementation "com.grab:grabfood-api-sdk-java:1.0.2"
}
```
### Others
At first generate the JAR by executing:
```shell
mvn clean package
```
Then manually install the following JARs:
- `target/grabfood-api-sdk-java-1.0.2.jar`
- `target/lib/*.jar`
## Getting Started
Please follow the [installation](#installation) instruction and execute the following Java code:
In the example below, we start by acquiring an OAuth2 access token. In your applications, it's important to handle OAuth2 tokens efficiently. This means:
- Store the received access token once it's obtained.
- Use this stored access token for as long as it's valid.
- Only request a new access token when the current one has expired.
By following these practices, you minimize the number of requests to the server, making your application more efficient and responsive.
You can usually determine the validity of a token by the `expires_in` attribute in the OAuth2 token response.
```java
import com.grab.grabfood.client.ApiClient;
import com.grab.grabfood.client.ApiException;
import com.grab.grabfood.client.Configuration;
import com.grab.grabfood.client.model.*;
import com.grab.grabfood.client.api.*;
public class Example {
public static void main(String[] args) {
ApiClient client = Configuration.getDefaultApiClient();
client.setServerIndex(Configuration.StgEnv);
GetOauthGrabApi authInstance = new GetOauthGrabApi(client);
authInstance.setHostIndex(client.getServerIndex());
String contentType = "application/json";
GrabOauthRequest req = new GrabOauthRequest();
req.setClientId("client_id");
req.setClientSecret("client_secret");
req.setGrantType("client_credentials");
req.setScope("food.partner_api");
try {
GrabOauthResponse authResp = authInstance.getOauthGrab(contentType, req);
// Request a new token only when the previous one has expired.
// Can utilize the `expires_in` from authResp.getExpiresIn() to determine the validity of the token.
ACCESS_TOKEN = authResp.getAccessToken();
} catch (ApiException e) {
System.err.println("Exception when calling GetOauthGrabApi#getOauthGrab");
e.printStackTrace();
}
GetStoreHourApi apiInstance = new GetStoreHourApi(client);
String authorization = "Bearer " + ACCESS_TOKEN;
String merchantID = "1-CYNGRUNGSBCCC";
try {
StoreHourResponse result = apiInstance.getStoreHour(authorization, merchantID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling GetStoreHourApi#getStoreHour");
e.printStackTrace();
}
}
}
```
For handling webhook requests, we provide dedicated models for both requests and responses. Please refer to the list of available models provided below for more details.
## Documentation for API Endpoints
The base URL for OAuth2 URIs is https://api.grab.com
For other GrabFood partner API endpoints, URIs are relative to https://partner-api.grab.com/grabfood
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AcceptRejectOrderApi* | [**acceptRejectOrder**](docs/AcceptRejectOrderApi.md#acceptRejectOrder) | **POST** /partner/v1/order/prepare | Manually accept/reject orders
*CancelOrderApi* | [**cancelOrder**](docs/CancelOrderApi.md#cancelOrder) | **PUT** /partner/v1/order/cancel | Cancel an order
*CheckOrderCancelableApi* | [**checkOrderCancelable**](docs/CheckOrderCancelableApi.md#checkOrderCancelable) | **GET** /partner/v1/order/cancelable | Check order cancelable
*CreateCampaignApi* | [**createCampaign**](docs/CreateCampaignApi.md#createCampaign) | **POST** /partner/v1/campaigns | Create campaign
*CreateSelfServeJourneyApi* | [**createSelfServeJourney**](docs/CreateSelfServeJourneyApi.md#createSelfServeJourney) | **POST** /partner/v1/self-serve/activation | Create self serve journey
*DeleteCampaignApi* | [**deleteCampaign**](docs/DeleteCampaignApi.md#deleteCampaign) | **DELETE** /partner/v1/campaigns/{campaign_id} | Delete campaigns
*EditOrderApi* | [**editOrder**](docs/EditOrderApi.md#editOrder) | **PUT** /partner/v1/orders/{orderID} | Edit Order
*GetDineinVoucherApi* | [**getDineinVoucher**](docs/GetDineinVoucherApi.md#getDineinVoucher) | **GET** /partner/v1/dinein/voucher | Get Dine In Voucher
*GetOauthGrabApi* | [**getOauthGrab**](docs/GetOauthGrabApi.md#getOauthGrab) | **POST** /grabid/v1/oauth2/token | Get Oauth access token
*GetStoreHourApi* | [**getStoreHour**](docs/GetStoreHourApi.md#getStoreHour) | **GET** /partner/v2/merchants/{merchantID}/store/hours | Get Store Hours
*GetStoreStatusApi* | [**getStoreStatus**](docs/GetStoreStatusApi.md#getStoreStatus) | **GET** /partner/v1/merchants/{merchantID}/store/status | Get Store Status
*ListCampaignApi* | [**listCampaign**](docs/ListCampaignApi.md#listCampaign) | **GET** /partner/v1/campaigns | List campaigns
*ListOrdersApi* | [**listOrders**](docs/ListOrdersApi.md#listOrders) | **GET** /partner/v1/orders | List orders
*MarkOrderReadyApi* | [**markOrderReady**](docs/MarkOrderReadyApi.md#markOrderReady) | **POST** /partner/v1/orders/mark | Mark order as ready
*NotifyMembershipWebviewApi* | [**notifyMembershipWebview**](docs/NotifyMembershipWebviewApi.md#notifyMembershipWebview) | **POST** /partner/v1/membership/notify | Notify Membership
*PauseStoreApi* | [**pauseStore**](docs/PauseStoreApi.md#pauseStore) | **PUT** /partner/v1/merchant/pause | Pause store
*RedeemDineinVoucherApi* | [**redeemDineinVoucher**](docs/RedeemDineinVoucherApi.md#redeemDineinVoucher) | **POST** /partner/v1/dinein/voucher/redeem | Redeem Dine In Voucher
*TraceMenuSyncApi* | [**traceMenuSync**](docs/TraceMenuSyncApi.md#traceMenuSync) | **GET** /partner/v1/merchant/menu/trace | Trace menu sync
*UpdateCampaignApi* | [**updateCampaign**](docs/UpdateCampaignApi.md#updateCampaign) | **PUT** /partner/v1/campaigns/{campaign_id} | Update campaign
*UpdateDeliveryStateApi* | [**updateDeliveryState**](docs/UpdateDeliveryStateApi.md#updateDeliveryState) | **POST** /partner/v1/order/delivery | Update delivery state
*UpdateMenuNotificationApi* | [**updateMenuNotification**](docs/UpdateMenuNotificationApi.md#updateMenuNotification) | **POST** /partner/v1/merchant/menu/notification | Notify Grab of updated menu
*UpdateMenuRecordApi* | [**batchUpdateMenu**](docs/UpdateMenuRecordApi.md#batchUpdateMenu) | **PUT** /partner/v1/batch/menu | Batch Update Menu
*UpdateMenuRecordApi* | [**updateMenu**](docs/UpdateMenuRecordApi.md#updateMenu) | **PUT** /partner/v1/menu | Update menu record
*UpdateOrderReadyTimeApi* | [**updateOrderReadyTime**](docs/UpdateOrderReadyTimeApi.md#updateOrderReadyTime) | **PUT** /partner/v1/order/readytime | Update new order ready time
*UpdateStoreDeliveryHourApi* | [**updateStoreDeliveryHour**](docs/UpdateStoreDeliveryHourApi.md#updateStoreDeliveryHour) | **PUT** /partner/v1/merchants/{merchantID}/store/opening-hours | Update Store Delivery Hours
*UpdateStoreDineInHourApi* | [**updateStoreDineInHour**](docs/UpdateStoreDineInHourApi.md#updateStoreDineInHour) | **PUT** /partner/v1/merchants/{merchantID}/store/dine-in-hours | Update Store Dine-in Hours
*UpdateStoreSpecialHourApi* | [**updateStoreSpecialHour**](docs/UpdateStoreSpecialHourApi.md#updateStoreSpecialHour) | **PUT** /partner/v2/merchants/{merchantID}/store/special-opening-hour | Update Store Special Hours
## Documentation for Models
- [AcceptOrderRequest](docs/AcceptOrderRequest.md)
- [Address](docs/Address.md)
- [AdvancedPricing](docs/AdvancedPricing.md)
- [BatchUpdateMenuItem](docs/BatchUpdateMenuItem.md)
- [BatchUpdateMenuResponse](docs/BatchUpdateMenuResponse.md)
- [BindMembershipNativeRequest](docs/BindMembershipNativeRequest.md)
- [BindMembershipNativeResponse](docs/BindMembershipNativeResponse.md)
- [Campaign](docs/Campaign.md)
- [CampaignConditions](docs/CampaignConditions.md)
- [CampaignDiscount](docs/CampaignDiscount.md)
- [CampaignQuotas](docs/CampaignQuotas.md)
- [CampaignScope](docs/CampaignScope.md)
- [CancelCode](docs/CancelCode.md)
- [CancelOrderLimitType](docs/CancelOrderLimitType.md)
- [CancelOrderRequest](docs/CancelOrderRequest.md)
- [CancelOrderResponse](docs/CancelOrderResponse.md)
- [CancelReason](docs/CancelReason.md)
- [CheckOrderCancelableResponse](docs/CheckOrderCancelableResponse.md)
- [Coordinates](docs/Coordinates.md)
- [CreateCampaignRequest](docs/CreateCampaignRequest.md)
- [CreateCampaignResponse](docs/CreateCampaignResponse.md)
- [CreateSelfServeJourneyRequest](docs/CreateSelfServeJourneyRequest.md)
- [CreateSelfServeJourneyRequestPartner](docs/CreateSelfServeJourneyRequestPartner.md)
- [CreateSelfServeJourneyResponse](docs/CreateSelfServeJourneyResponse.md)
- [Currency](docs/Currency.md)
- [DineIn](docs/DineIn.md)
- [EditOrderItem](docs/EditOrderItem.md)
- [EditOrderRequest](docs/EditOrderRequest.md)
- [Error](docs/Error.md)
- [GetDineInVoucherResponse](docs/GetDineInVoucherResponse.md)
- [GetMembershipNativeResponse](docs/GetMembershipNativeResponse.md)
- [GetMembershipNativeResponsePointInfo](docs/GetMembershipNativeResponsePointInfo.md)
- [GetMembershipRequest](docs/GetMembershipRequest.md)
- [GetMembershipWebviewResponse](docs/GetMembershipWebviewResponse.md)
- [GetMenuNewResponse](docs/GetMenuNewResponse.md)
- [GetMenuOldResponse](docs/GetMenuOldResponse.md)
- [GetRewardNativeRequest](docs/GetRewardNativeRequest.md)
- [GetRewardNativeResponse](docs/GetRewardNativeResponse.md)
- [GrabOauthRequest](docs/GrabOauthRequest.md)
- [GrabOauthResponse](docs/GrabOauthResponse.md)
- [ListCampaignResponse](docs/ListCampaignResponse.md)
- [ListOrdersResponse](docs/ListOrdersResponse.md)
- [MarkOrderRequest](docs/MarkOrderRequest.md)
- [MenuCategory](docs/MenuCategory.md)
- [MenuEntity](docs/MenuEntity.md)
- [MenuEntityError](docs/MenuEntityError.md)
- [MenuItem](docs/MenuItem.md)
- [MenuModifier](docs/MenuModifier.md)
- [MenuSection](docs/MenuSection.md)
- [MenuSectionCategory](docs/MenuSectionCategory.md)
- [MenuSectionCategoryItem](docs/MenuSectionCategoryItem.md)
- [MenuSyncFail](docs/MenuSyncFail.md)
- [MenuSyncFailCategory](docs/MenuSyncFailCategory.md)
- [MenuSyncFailItem](docs/MenuSyncFailItem.md)
- [MenuSyncFailModifier](docs/MenuSyncFailModifier.md)
- [MenuSyncFailModifierGroup](docs/MenuSyncFailModifierGroup.md)
- [MenuSyncFailServiceHours](docs/MenuSyncFailServiceHours.md)
- [MenuSyncResponse](docs/MenuSyncResponse.md)
- [MenuSyncWebhookRequest](docs/MenuSyncWebhookRequest.md)
- [ModifierGroup](docs/ModifierGroup.md)
- [NewOrderTimeRequest](docs/NewOrderTimeRequest.md)
- [NotifyMembershipWebviewRequest](docs/NotifyMembershipWebviewRequest.md)
- [OpenPeriod](docs/OpenPeriod.md)
- [Order](docs/Order.md)
- [OrderCampaign](docs/OrderCampaign.md)
- [OrderDeliveryRequest](docs/OrderDeliveryRequest.md)
- [OrderFeatureFlags](docs/OrderFeatureFlags.md)
- [OrderFreeItem](docs/OrderFreeItem.md)
- [OrderItem](docs/OrderItem.md)
- [OrderItemModifier](docs/OrderItemModifier.md)
- [OrderPrice](docs/OrderPrice.md)
- [OrderPromo](docs/OrderPromo.md)
- [OrderReadyEstimation](docs/OrderReadyEstimation.md)
- [OrderStateRequest](docs/OrderStateRequest.md)
- [OutOfStockInstruction](docs/OutOfStockInstruction.md)
- [PartnerOauthRequest](docs/PartnerOauthRequest.md)
- [PartnerOauthResponse](docs/PartnerOauthResponse.md)
- [PauseStoreRequest](docs/PauseStoreRequest.md)
- [Purchasability](docs/Purchasability.md)
- [PushIntegrationStatusWebhookRequest](docs/PushIntegrationStatusWebhookRequest.md)
- [Receiver](docs/Receiver.md)
- [RedeemDineInVoucherRequest](docs/RedeemDineInVoucherRequest.md)
- [RedeemDineInVoucherResponse](docs/RedeemDineInVoucherResponse.md)
- [RedeemResult](docs/RedeemResult.md)
- [RegisterMembershipNativeRequest](docs/RegisterMembershipNativeRequest.md)
- [RegisterMembershipNativeResponse](docs/RegisterMembershipNativeResponse.md)
- [RewardItem](docs/RewardItem.md)
- [SellingTime](docs/SellingTime.md)
- [ServiceHour](docs/ServiceHour.md)
- [ServiceHours](docs/ServiceHours.md)
- [SpecialOpeningHour](docs/SpecialOpeningHour.md)
- [SpecialOpeningHourMetadata](docs/SpecialOpeningHourMetadata.md)
- [SpecialOpeningHourOpeningHours](docs/SpecialOpeningHourOpeningHours.md)
- [StoreHour](docs/StoreHour.md)
- [StoreHourResponse](docs/StoreHourResponse.md)
- [StoreStatusResponse](docs/StoreStatusResponse.md)
- [SubmitOrderRequest](docs/SubmitOrderRequest.md)
- [UnbindMembershipNativeRequest](docs/UnbindMembershipNativeRequest.md)
- [UnlinkMembershipWebviewRequest](docs/UnlinkMembershipWebviewRequest.md)
- [UpdateAdvancedPricing](docs/UpdateAdvancedPricing.md)
- [UpdateCampaignRequest](docs/UpdateCampaignRequest.md)
- [UpdateDeliveryHourRequest](docs/UpdateDeliveryHourRequest.md)
- [UpdateDeliveryHourResponse](docs/UpdateDeliveryHourResponse.md)
- [UpdateDineInHourRequest](docs/UpdateDineInHourRequest.md)
- [UpdateDineInHourResponse](docs/UpdateDineInHourResponse.md)
- [UpdateMenuItem](docs/UpdateMenuItem.md)
- [UpdateMenuModifier](docs/UpdateMenuModifier.md)
- [UpdateMenuNotifRequest](docs/UpdateMenuNotifRequest.md)
- [UpdateMenuRequest](docs/UpdateMenuRequest.md)
- [UpdatePurchasability](docs/UpdatePurchasability.md)
- [UpdateSpecialHourRequest](docs/UpdateSpecialHourRequest.md)
- [UpdateSpecialHourResponse](docs/UpdateSpecialHourResponse.md)
- [Voucher](docs/Voucher.md)
- [VoucherDescriptionInfo](docs/VoucherDescriptionInfo.md)
- [WorkingHour](docs/WorkingHour.md)
- [WorkingHourDay](docs/WorkingHourDay.md)
## Recommendation
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.