Branches

List all branches.

get

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

get/v1/core/branches

HTTPcURLJavaScriptPython

GET /v1/core/branches HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "uid": "text",
        "id": "text",
        "legalEntityUid": "text",
        "defaultSubinventoryUid": "text",
        "address": {},
        "scheduleUid": "text",
        "siteProductListUids": [
          "text"
        ],
        "posProductListUids": [
          "text"
        ],
        "tableProductListUids": [
          "text"
        ]
      }
    ]
  }
}

Get a branch by id.

get

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

get/v1/core/branches/{uid}

HTTPcURLJavaScriptPython

GET /v1/core/branches/{uid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "locales": {
        "ar": {
          "name": "text",
          "description": "text"
        },
        "en": {
          "name": "text",
          "description": "text"
        }
      },
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "id": "text",
      "legalEntityUid": "text",
      "defaultSubinventoryUid": "text",
      "address": {},
      "scheduleUid": "text",
      "siteProductListUids": [
        "text"
      ],
      "posProductListUids": [
        "text"
      ],
      "tableProductListUids": [
        "text"
      ]
    },
    "schedule": {}
  }
}

Exports all branches with support for incremental fetching.

get

Authorizations

api-key

api-keystringRequired

API Key

Query parameters

updatedSincestringOptional

offsetstringOptional

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

get/v1/core/branches/export

HTTPcURLJavaScriptPython

GET /v1/core/branches/export HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "uid": "text",
        "id": "text",
        "legalEntityUid": "text",
        "defaultSubinventoryUid": "text",
        "address": {},
        "scheduleUid": "text",
        "siteProductListUids": [
          "text"
        ],
        "posProductListUids": [
          "text"
        ],
        "tableProductListUids": [
          "text"
        ]
      }
    ],
    "next": "text"
  }
}