Link Outlet

By using this method, you can link merchant's primary outlet so you can use call GoBiz endpoints on behalf of merchants and to enable webhook notifications.

caution

• This API is designed to link the user's primary outlet only. It may pose potential issues for multi-outlet merchants.
• To know the user's primary outlet, please refer Token Info API.
• We suggest you to use link outlet by Merchant ID. Please refer Link Outlet by Merchant ID.

PUT /integrations/partner/v1/outlet-link

Sample Request

Sample Request

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

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).
• Possible error responses are 401, 400. Please refer Error Glossary.