Link Outlet by Merchant ID

By using this method, you can specify which outlet that you want to link so you can use call GoBiz endpoints on behalf of merchants and to enable webhook notifications. To perform this operation, you need to make sure the user has an access to the specified outlet ID. Please refer Token Info API

PUT /integrations/partner/outlets/{outlet_id}/v1/link/{product}

Sample Request

Sample Request

curl -X PUT https://api.partner-sandbox.gobiz.co.id/integrations/partner/outlets/{outlet_id}/v1/link/{product} \
  -H 'Authorization: Bearer {access-token}'
  -H 'Content-Type: application/json'
  -d $'
    {
      "external_outlet_id" : "external_outlet_id"
    }
  '

Path Parameters

Name	Description	Type	Required
outlet_id	ID of the outlet for which you want to link.	String	Required
product	The product name. Currently available are gofood, payment	String	Required

Request Parameters

JSON Attribute	Description	Type	Required
external_outlet_id	Outlet ID in Partner's POS system	String	Required

Sample Response - 200 Success

Sample Response

{
  "success": true,
  "data": {
    "outlet": {
      "id": "string",
      "external_outlet_id": "sample-abc-12345",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "linked_at": "2019-08-24T14:15:22Z"
    }
  }
}

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 linked outlet.	Object
» outlet	Linked object data.	Object

note

• To perform this operation, you must have one of [owner, admin, manager] role and authenticated using go_auth_authorization_code(partner:outlet:read).
• To perform this operation, you need to make sure the user has an access to the specified outlet ID. Please refer Token Info API
• Possible error responses are 401, 400, 403. Please refer Error Glossary.