List active and unavailable Merchant branches

List active and unavailable Merchant branches. Results are scoped to the Merchant company bound by the OAuth client.

GET /v2/external/branches

List active and unavailable Merchant branches

cURL

curl --request GET \
  --url https://api-test.drop-hub.com/v2/external/branches \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "code": "<string>",
      "name": "<string>",
      "status": "<string>",
      "version": 1
    }
  ],
  "page": {
    "limit": 25,
    "nextCursor": null,
    "hasMore": false
  },
  "links": {
    "self": "<string>"
  }
}

Authorizations

Authorization · string · header · required

OAuth 2.0 client-credentials flow for external machine-to-machine integrations.

Headers

Accept-Language · string

Preferred response language when a localized representation is available.

Maximum string length: 64

Example:

"en"

Query Parameters

limit · integer · default: 25

Maximum items to return. Default 25, maximum 100. Values outside 1..100 are rejected with 400; they are never clamped.

Required range: 1 <= x <= 100

cursor · string

Opaque continuation token from a previous page's page.nextCursor. Bound to the tenant, parent resource, filter and sort of the originating query; a cursor presented to a different query is rejected with 400 INVALID_CURSOR.

Maximum string length: 256

Pattern: ^[A-Za-z0-9_-]{1,256}$

Response

200

application/json

Successful response

data · object[] · required

Show child attributes

page · object · required

Show child attributes

Example:

{
  "limit": 25,
  "nextCursor": null,
  "hasMore": false
}

links · object · required

Show child attributes