Outlet Properties
This section specifies how a partner can update the GoFood outlet information.
Update Outlet Properties
By using this method, you can update your restaurant outlet information such as outlet is open or close within its operational hours.
PATCH /integrations/gofood/outlets/{outlet_id}/v1/properties
Sample Request
Sample Request
curl -X PATCH https://api.partner-sandbox.gobiz.co.id/integrations/gofood/outlets/{outlet_id}/v1/properties \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-d $'
{
"force_close": false
}
'
Path Parameters
Name | Description | Type | Required |
---|---|---|---|
outlet_id | ID of the restaurant for which you want to update the status. | String | Required |
Request Parameters
JSON Attribute | Description | Type | Required |
---|---|---|---|
force_close | Restaurant outlet status. | Boolean | Required |
Sample Response - 200 Success
{
"success": true,
"data":
{
"force_close": false
}
}
Response Parameter - 200 Success
JSON Attribute | Description | Type |
---|---|---|
success | Status of the request. Value true indicates successful submission of the request. | Boolean |
data | Details of the updated restaurant. | Object |
» force_close | restaurant outlet status. | Boolean |
note
- To perform this operation, you must be authenticated using
go_auth_authorization_code(gofood:outlet:write)
using Owner or Manager roles. - Possible error responses are
401
,404
,406
, and415
. Please refer Error Glossary.