Branches
Authorizations
Header parameters
organization-idstringRequired
Organization ID
Responses
200Success
application/json
get
GET /v1/core/branches HTTP/1.1
Host:
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"
]
}
]
}
}
Authorizations
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired
Organization ID
Responses
200Success
application/json
400
Functional Error
application/json
get
GET /v1/core/branches/{uid} HTTP/1.1
Host:
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": {}
}
}
Authorizations
Query parameters
updatedSincestringOptional
offsetstringOptional
Header parameters
organization-idstringRequired
Organization ID
Responses
200Success
application/json
get
GET /v1/core/branches/export HTTP/1.1
Host:
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"
}
}
Was this helpful?