https://github.com/grab/grabfood-api-sdk-python
grab/grabfood-api-sdk-python
https://github.com/grab/grabfood-api-sdk-python
Last synced: 6 months ago
JSON representation
grab/grabfood-api-sdk-python
- Host: GitHub
- URL: https://github.com/grab/grabfood-api-sdk-python
- Owner: grab
- License: mit
- Created: 2025-01-23T02:45:35.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-03-12T06:48:57.000Z (10 months ago)
- Last Synced: 2025-06-25T15:12:09.794Z (7 months ago)
- Language: Python
- Size: 210 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# grabfood
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.1.3
- Package version: 1.0.2
- Generator version: 7.8.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://developer.grab.com](https://developer.grab.com)
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/grab/grabfood-api-sdk-python.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/grab/grabfood-api-sdk-python.git`)
Then import the package:
```python
import grabfood
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import grabfood
```
### Tests
Execute `pytest` to run the tests.
## Environment Configuration
Defining the host is optional and defaults to STG_ENV. The SDK supports both staging and production environments. This also applies to the authentication server.
You can switch between environments by modifying the host settings parameter:
```python
import grabfood
from grabfood.configs.config import STG_ENV
from grabfood.configs.config import PRD_ENV
from grabfood.configs.config import STG_AUTH_ENV
from grabfood.configs.config import PRD_AUTH_ENV
# Staging Environment (default)
configuration = grabfood.Configuration(
host=STG_ENV
)
# Production Environment
configuration = grabfood.Configuration(
host=PRD_ENV
)
# Staging Auth Environment (default)
configuration = grabfood.Configuration(
host=STG_AUTH_ENV
)
# Production Auth Environment
configuration = grabfood.Configuration(
host=PRD_AUTH_ENV
)
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import grabfood
from grabfood.rest import ApiException
from pprint import pprint
# Enter a context with an instance of the API client
with grabfood.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = grabfood.AcceptRejectOrderApi(api_client)
authorization = 'Bearer ' # str | Specify the generated authorization token of the bearer type.
content_type = 'application/json' # str | The content type of the request body. You must use `application/json` for this header as GrabFood API currently does not support other formats.
accept_order_request = grabfood.AcceptOrderRequest() # AcceptOrderRequest |
try:
# Manually accept/reject orders
api_instance.accept_reject_order(authorization, content_type, accept_order_request)
except ApiException as e:
print("Exception when calling AcceptRejectOrderApi->accept_reject_order: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://partner-api.grab.com/grabfood-sandbox*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AcceptRejectOrderApi* | [**accept_reject_order**](docs/AcceptRejectOrderApi.md#accept_reject_order) | **POST** /partner/v1/order/prepare | Manually accept/reject orders
*CancelOrderApi* | [**cancel_order**](docs/CancelOrderApi.md#cancel_order) | **PUT** /partner/v1/order/cancel | Cancel an order
*CheckOrderCancelableApi* | [**check_order_cancelable**](docs/CheckOrderCancelableApi.md#check_order_cancelable) | **GET** /partner/v1/order/cancelable | Check order cancelable
*CreateCampaignApi* | [**create_campaign**](docs/CreateCampaignApi.md#create_campaign) | **POST** /partner/v1/campaigns | Create campaign
*CreateSelfServeJourneyApi* | [**create_self_serve_journey**](docs/CreateSelfServeJourneyApi.md#create_self_serve_journey) | **POST** /partner/v1/self-serve/activation | Create self serve journey
*DeleteCampaignApi* | [**delete_campaign**](docs/DeleteCampaignApi.md#delete_campaign) | **DELETE** /partner/v1/campaigns/{campaign_id} | Delete campaigns
*EditOrderApi* | [**edit_order**](docs/EditOrderApi.md#edit_order) | **PUT** /partner/v1/orders/{orderID} | Edit Order
*GetDineinVoucherApi* | [**get_dinein_voucher**](docs/GetDineinVoucherApi.md#get_dinein_voucher) | **GET** /partner/v1/dinein/voucher | Get Dine In Voucher
*GetOauthGrabApi* | [**get_oauth_grab**](docs/GetOauthGrabApi.md#get_oauth_grab) | **POST** /grabid/v1/oauth2/token | Get Oauth access token
*GetStoreHourApi* | [**get_store_hour**](docs/GetStoreHourApi.md#get_store_hour) | **GET** /partner/v2/merchants/{merchantID}/store/hours | Get Store Hours
*GetStoreStatusApi* | [**get_store_status**](docs/GetStoreStatusApi.md#get_store_status) | **GET** /partner/v1/merchants/{merchantID}/store/status | Get Store Status
*ListCampaignApi* | [**list_campaign**](docs/ListCampaignApi.md#list_campaign) | **GET** /partner/v1/campaigns | List campaigns
*ListOrdersApi* | [**list_orders**](docs/ListOrdersApi.md#list_orders) | **GET** /partner/v1/orders | List orders
*MarkOrderReadyApi* | [**mark_order_ready**](docs/MarkOrderReadyApi.md#mark_order_ready) | **POST** /partner/v1/orders/mark | Mark order as ready
*NotifyMembershipWebviewApi* | [**notify_membership_webview**](docs/NotifyMembershipWebviewApi.md#notify_membership_webview) | **POST** /partner/v1/membership/notify | Notify Membership
*PauseStoreApi* | [**pause_store**](docs/PauseStoreApi.md#pause_store) | **PUT** /partner/v1/merchant/pause | Pause store
*RedeemDineinVoucherApi* | [**redeem_dinein_voucher**](docs/RedeemDineinVoucherApi.md#redeem_dinein_voucher) | **POST** /partner/v1/dinein/voucher/redeem | Redeem Dine In Voucher
*TraceMenuSyncApi* | [**trace_menu_sync**](docs/TraceMenuSyncApi.md#trace_menu_sync) | **GET** /partner/v1/merchant/menu/trace | Trace menu sync
*UpdateCampaignApi* | [**update_campaign**](docs/UpdateCampaignApi.md#update_campaign) | **PUT** /partner/v1/campaigns/{campaign_id} | Update campaign
*UpdateDeliveryStateApi* | [**update_delivery_state**](docs/UpdateDeliveryStateApi.md#update_delivery_state) | **POST** /partner/v1/order/delivery | Update delivery state
*UpdateMenuNotificationApi* | [**update_menu_notification**](docs/UpdateMenuNotificationApi.md#update_menu_notification) | **POST** /partner/v1/merchant/menu/notification | Notify Grab of updated menu
*UpdateMenuRecordApi* | [**batch_update_menu**](docs/UpdateMenuRecordApi.md#batch_update_menu) | **PUT** /partner/v1/batch/menu | Batch Update Menu
*UpdateMenuRecordApi* | [**update_menu**](docs/UpdateMenuRecordApi.md#update_menu) | **PUT** /partner/v1/menu | Update menu record
*UpdateOrderReadyTimeApi* | [**update_order_ready_time**](docs/UpdateOrderReadyTimeApi.md#update_order_ready_time) | **PUT** /partner/v1/order/readytime | Update new order ready time
*UpdateStoreDeliveryHourApi* | [**update_store_delivery_hour**](docs/UpdateStoreDeliveryHourApi.md#update_store_delivery_hour) | **PUT** /partner/v1/merchants/{merchantID}/store/opening-hours | Update Store Delivery Hours
*UpdateStoreDineInHourApi* | [**update_store_dine_in_hour**](docs/UpdateStoreDineInHourApi.md#update_store_dine_in_hour) | **PUT** /partner/v1/merchants/{merchantID}/store/dine-in-hours | Update Store Dine-in Hours
*UpdateStoreSpecialHourApi* | [**update_store_special_hour**](docs/UpdateStoreSpecialHourApi.md#update_store_special_hour) | **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)
## Documentation For Authorization
Endpoints do not require authorization.
## Author