---
title: Sucursales
slug: sucursales
docTags: 
createdAt: 2024-01-04T04:54:06.201Z
---

A partir de esta especificación se podrán crear sucursales de un subcomercio o entidad dentro de la plataforma, siempre y cuando esté habilitado dicho módulo.

:::ApiMethodV2
```json
{
  "name": "Crear o Editar Sucursal",
  "method": "POST",
  "url": "https://{suga-id}.sugaway.io/p/branch",
  "description": "",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "Mwt0BUcmNS0Zj08vMWglf",
        "language": "curl",
        "code": "curl --location --globoff 'https://{suga-id}.sugaway.com/p/branch' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data '{\"name\":\"string\",\"reference\":\"string\",\"address\":\"Object\",\"state\":\"string\",\"city\":\"string\",\"zipCode\":\"string\",\"email\":\"string\",\"phone\":\"string\"}'",
        "customLabel": ""
      },
      {
        "id": "lB8roVEBWmRsaEVbIibvc",
        "language": "nodejs",
        "code": "var request = require('request');\nvar options = {\n   'method': 'POST',\n   'url': 'https://{suga-id}.sugaway.com/p/branch',\n   'headers': {\n      'Accept': 'application/json',\n      'Content-Type': 'application/json'\n   },\n   body: JSON.stringify({\n      \"name\": \"string\",\n      \"reference\": \"string\",\n      \"address\": \"Object\",\n      \"state\": \"string\",\n      \"city\": \"string\",\n      \"zipCode\": \"string\",\n      \"email\": \"string\",\n      \"phone\": \"string\"\n   })\n\n};\nrequest(options, function (error, response) {\n   if (error) throw new Error(error);\n   console.log(response.body);\n});\n",
        "customLabel": ""
      },
      {
        "id": "vQNUTltQDiXj6h32EoaGM",
        "language": "javascript",
        "code": "var myHeaders = new Headers();\nmyHeaders.append(\"Accept\", \"application/json\");\nmyHeaders.append(\"Content-Type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"name\": \"string\",\n   \"reference\": \"string\",\n   \"address\": \"Object\",\n   \"state\": \"string\",\n   \"city\": \"string\",\n   \"zipCode\": \"string\",\n   \"email\": \"string\",\n   \"phone\": \"string\"\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"https://{suga-id}.sugaway.com/p/branch\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));",
        "customLabel": ""
      },
      {
        "id": "WED_CogpTVQkR7SK6MO20",
        "language": "python",
        "code": "import requests\nimport json\n\nurl = \"https://{suga-id}.sugaway.com/p/branch\"\n\npayload = json.dumps({\n   \"name\": \"string\",\n   \"reference\": \"string\",\n   \"address\": \"Object\",\n   \"state\": \"string\",\n   \"city\": \"string\",\n   \"zipCode\": \"string\",\n   \"email\": \"string\",\n   \"phone\": \"string\"\n})\nheaders = {\n   'Accept': 'application/json',\n   'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n",
        "customLabel": ""
      },
      {
        "id": "-_tFjC9t7JDH7jJMBifBL",
        "language": "ruby",
        "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://{suga-id}.sugaway.com/p/branch\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Accept\"] = \"application/json\"\nrequest[\"Content-Type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"name\": \"string\",\n   \"reference\": \"string\",\n   \"address\": \"Object\",\n   \"state\": \"string\",\n   \"city\": \"string\",\n   \"zipCode\": \"string\",\n   \"email\": \"string\",\n   \"phone\": \"string\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "lB8roVEBWmRsaEVbIibvc"
  },
  "results": {
    "languages": [
      {
        "id": "gnXmOysEtD2ZtSEKWChGr",
        "language": "200",
        "customLabel": "",
        "code": "{\n      \"id\": \"BranchID\",\n}"
      },
      {
        "id": "YTNhoo1Io7TCRnTMus24X",
        "language": "404",
        "customLabel": "",
        "code": "{\n      \"message\": \"Ain't no cake like that.\"\n    }"
      }
    ],
    "selectedLanguageId": "gnXmOysEtD2ZtSEKWChGr"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [
      {
        "name": "x-api-key",
        "kind": "required",
        "type": "string",
        "description": "API Key del operador",
        "children": []
      },
      {
        "name": "x-access-token",
        "kind": "required",
        "type": "string",
        "description": "Access Token del Operador",
        "children": []
      },
      {
        "name": "x-suga-entity",
        "kind": "required",
        "type": "string",
        "description": "ID del comercio sobre el cual se desean crear las sucursales",
        "children": []
      }
    ],
    "bodyDataParameters": [
      {
        "name": "name",
        "kind": "required",
        "type": "string",
        "description": "Nombre de fantasía de la sucursal"
      },
      {
        "name": "reference",
        "kind": "optional",
        "type": "string",
        "description": "Referencia única que permita identificar a la sucursal dentro del comercio. Si no se envía se generara una automáticamente. Este parámetro no puede ser editado posteriormente.",
        "children": []
      },
      {
        "name": "address",
        "kind": "required",
        "type": "Object",
        "description": "Dirección de la Sucursal.",
        "children": [
          {
            "name": "street",
            "kind": "required",
            "type": "string",
            "description": "Calle"
          },
          {
            "name": "number",
            "kind": "required",
            "type": "string",
            "description": "Altura"
          },
          {
            "name": "floor",
            "kind": "optional",
            "type": "string",
            "description": "Piso"
          },
          {
            "name": "flat",
            "kind": "optional",
            "type": "string",
            "description": "Departamento"
          },
          {
            "name": "notes",
            "kind": "optional",
            "type": "string",
            "description": "Notas sobre la dirección"
          }
        ]
      },
      {
        "name": "state",
        "kind": "required",
        "type": "string",
        "description": "Provincia o Estado de la sucursal. Para Argentina se debe utilizar la clasificacion propuesta.",
        "children": []
      },
      {
        "name": "city",
        "kind": "required",
        "type": "string",
        "description": "Ciudad de la Sucursal.",
        "children": []
      },
      {
        "name": "zipCode",
        "kind": "required",
        "type": "string",
        "description": "Código Postal. En Argentina se debe utilizar el Código Postal Argentino ( CPA ) cuyo formato es LNNNNLLL.",
        "children": []
      },
      {
        "name": "email",
        "kind": "optional",
        "type": "string",
        "description": "Email de la sucursal. Si no se envía se considera el email del comercio.",
        "children": []
      },
      {
        "name": "phone",
        "kind": "optional",
        "type": "string",
        "description": "Teléfono de la sucursal. Si no se envía se considera el teléfono del comercio.",
        "children": []
      },
      {
        "name": "accountType",
        "kind": "optional",
        "type": "string",
        "description": "Permite definir una cuenta bancaria o virtual para el destino de los fondos de la sucursal, en el caso que sea diferente al comercio. Aplicar sólo en los casos requeridos y previa autorización de SUGA",
        "children": []
      },
      {
        "name": "accountNumber",
        "kind": "optional",
        "type": "string",
        "description": "En el caso de especificar una cuenta, indica el número de cuenta de destino de los fondos.",
        "children": []
      }
    ],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "hasTryItOut": false,
  "autoGeneratedAnchorSlug": "crear-o-editar-sucursal",
  "legacyHash": "9IQncrVjq9L77CDM8pB5G"
}
```
:::

En caso de no utilizar referencia, es posible utilizar el siguiente método para editar una sucursal:

:::ApiMethodV2
```json
{
  "name": "Editar Sucursal",
  "method": "PUT",
  "url": "https://{suga-id}.sugaway.io/p/branch/{branch-id}",
  "description": "",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "Mwt0BUcmNS0Zj08vMWglf",
        "language": "curl",
        "code": "curl --location --globoff 'https://{suga-id}.sugaway.com/p/branch' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data '{\"name\":\"string\",\"reference\":\"string\",\"address\":\"Object\",\"state\":\"string\",\"city\":\"string\",\"zipCode\":\"string\",\"email\":\"string\",\"phone\":\"string\"}'",
        "customLabel": ""
      },
      {
        "id": "lB8roVEBWmRsaEVbIibvc",
        "language": "nodejs",
        "code": "var request = require('request');\nvar options = {\n   'method': 'POST',\n   'url': 'https://{suga-id}.sugaway.com/p/branch',\n   'headers': {\n      'Accept': 'application/json',\n      'Content-Type': 'application/json'\n   },\n   body: JSON.stringify({\n      \"name\": \"string\",\n      \"reference\": \"string\",\n      \"address\": \"Object\",\n      \"state\": \"string\",\n      \"city\": \"string\",\n      \"zipCode\": \"string\",\n      \"email\": \"string\",\n      \"phone\": \"string\"\n   })\n\n};\nrequest(options, function (error, response) {\n   if (error) throw new Error(error);\n   console.log(response.body);\n});\n",
        "customLabel": ""
      },
      {
        "id": "vQNUTltQDiXj6h32EoaGM",
        "language": "javascript",
        "code": "var myHeaders = new Headers();\nmyHeaders.append(\"Accept\", \"application/json\");\nmyHeaders.append(\"Content-Type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"name\": \"string\",\n   \"reference\": \"string\",\n   \"address\": \"Object\",\n   \"state\": \"string\",\n   \"city\": \"string\",\n   \"zipCode\": \"string\",\n   \"email\": \"string\",\n   \"phone\": \"string\"\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"https://{suga-id}.sugaway.com/p/branch\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));",
        "customLabel": ""
      },
      {
        "id": "WED_CogpTVQkR7SK6MO20",
        "language": "python",
        "code": "import requests\nimport json\n\nurl = \"https://{suga-id}.sugaway.com/p/branch\"\n\npayload = json.dumps({\n   \"name\": \"string\",\n   \"reference\": \"string\",\n   \"address\": \"Object\",\n   \"state\": \"string\",\n   \"city\": \"string\",\n   \"zipCode\": \"string\",\n   \"email\": \"string\",\n   \"phone\": \"string\"\n})\nheaders = {\n   'Accept': 'application/json',\n   'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n",
        "customLabel": ""
      },
      {
        "id": "-_tFjC9t7JDH7jJMBifBL",
        "language": "ruby",
        "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://{suga-id}.sugaway.com/p/branch\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Accept\"] = \"application/json\"\nrequest[\"Content-Type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"name\": \"string\",\n   \"reference\": \"string\",\n   \"address\": \"Object\",\n   \"state\": \"string\",\n   \"city\": \"string\",\n   \"zipCode\": \"string\",\n   \"email\": \"string\",\n   \"phone\": \"string\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "lB8roVEBWmRsaEVbIibvc"
  },
  "results": {
    "languages": [
      {
        "id": "gnXmOysEtD2ZtSEKWChGr",
        "language": "200",
        "customLabel": "",
        "code": "{\n      \"id\": \"BranchID\",\n}"
      },
      {
        "id": "YTNhoo1Io7TCRnTMus24X",
        "language": "404",
        "customLabel": "",
        "code": "{\n      \"message\": \"Ain't no cake like that.\"\n    }"
      }
    ],
    "selectedLanguageId": "gnXmOysEtD2ZtSEKWChGr"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [
      {
        "name": "x-api-key",
        "kind": "required",
        "type": "string",
        "description": "API Key del operador",
        "children": []
      },
      {
        "name": "x-access-token",
        "kind": "required",
        "type": "string",
        "description": "Access Token del Operador",
        "children": []
      },
      {
        "name": "x-suga-entity",
        "kind": "required",
        "type": "string",
        "description": "ID del comercio sobre el cual se desea editar la sucursal",
        "children": []
      }
    ],
    "bodyDataParameters": [
      {
        "name": "name",
        "kind": "optional",
        "type": "string",
        "description": "Nombre de fantasía de la sucursal"
      },
      {
        "name": "address",
        "kind": "optional",
        "type": "Object",
        "description": "Dirección de la Sucursal.",
        "children": [
          {
            "name": "street",
            "kind": "required",
            "type": "string",
            "description": "Calle"
          },
          {
            "name": "number",
            "kind": "required",
            "type": "string",
            "description": "Altura"
          },
          {
            "name": "floor",
            "kind": "optional",
            "type": "string",
            "description": "Piso"
          },
          {
            "name": "flat",
            "kind": "optional",
            "type": "string",
            "description": "Departamento"
          },
          {
            "name": "notes",
            "kind": "optional",
            "type": "string",
            "description": "Notas sobre la dirección"
          }
        ]
      },
      {
        "name": "state",
        "kind": "optional",
        "type": "string",
        "description": "Provincia o Estado de la sucursal. Para Argentina se debe utilizar la clasificacion propuesta.",
        "children": []
      },
      {
        "name": "city",
        "kind": "optional",
        "type": "string",
        "description": "Ciudad de la Sucursal.",
        "children": []
      },
      {
        "name": "zipCode",
        "kind": "optional",
        "type": "string",
        "description": "Código Postal. En Argentina se debe utilizar el Código Postal Argentino ( CPA ) cuyo formato es LNNNNLLL.",
        "children": []
      },
      {
        "name": "email",
        "kind": "optional",
        "type": "string",
        "description": "Email de la sucursal. Si no se envía se considera el email del comercio.",
        "children": []
      },
      {
        "name": "phone",
        "kind": "optional",
        "type": "string",
        "description": "Teléfono de la sucursal. Si no se envía se considera el teléfono del comercio.",
        "children": []
      },
      {
        "name": "accountType",
        "kind": "optional",
        "type": "string",
        "description": "Permite definir una cuenta bancaria o virtual para el destino de los fondos de la sucursal, en el caso que sea diferente al comercio. Aplicar sólo en los casos requeridos y previa autorización de SUGA",
        "children": []
      },
      {
        "name": "accountNumber",
        "kind": "optional",
        "type": "string",
        "description": "En el caso de especificar una cuenta, indica el número de cuenta de destino de los fondos.",
        "children": []
      }
    ],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "hasTryItOut": false,
  "autoGeneratedAnchorSlug": "editar-sucursal",
  "legacyHash": "14crfuJCFJj6WWgsbDy9z"
}
```
:::

Los posibles códigos de error al crear o modificar una sucursal son:

- BRANCH\:INVALID\_REFERENCE
- ENTITY\:COUNTRY\_INVALID\_STATE
- ENTITY\:INVALID\_MCC
- ENTITY\:INVALID\_ZIP\_CODE
- ENTITY\:INVALID\_ADDRESS
- ENTITY\:INVALID\_ACCOUNT
- NDFE -> El {branch-id} enviado no corresponde a una sucursal válida

:::ApiMethodV2
```json
{
  "name": "Inactivar Sucursal",
  "method": "PUT",
  "url": "https://{suga-id}.sugaway.io/p/branch/:id/inactive",
  "description": "",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "ffOYDr1j4i2Gf94ayKOwF",
        "language": "curl",
        "code": "curl --location --globoff --request PUT 'https://{suga-id}.sugaway.io/p/branch/:id/inactive/{id}' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json'",
        "customLabel": ""
      },
      {
        "id": "6DRO5kmgBMHyPdM8k9d43",
        "language": "nodejs",
        "code": "var request = require('request');\nvar options = {\n   'method': 'PUT',\n   'url': 'https://{suga-id}.sugaway.io/p/branch/:id/inactive/{id}',\n   'headers': {\n      'Accept': 'application/json',\n      'Content-Type': 'application/json'\n   }\n};\nrequest(options, function (error, response) {\n   if (error) throw new Error(error);\n   console.log(response.body);\n});\n",
        "customLabel": ""
      },
      {
        "id": "GkyZw3NnfRzc7uKPRrXwd",
        "language": "javascript",
        "code": "var myHeaders = new Headers();\nmyHeaders.append(\"Accept\", \"application/json\");\nmyHeaders.append(\"Content-Type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'PUT',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://{suga-id}.sugaway.io/p/branch/:id/inactive/{id}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));",
        "customLabel": ""
      },
      {
        "id": "ad7-ljCanFqka-apU1HF4",
        "language": "python",
        "code": "import requests\nimport json\n\nurl = \"https://{suga-id}.sugaway.io/p/branch/:id/inactive/{id}\"\n\npayload = {}\nheaders = {\n   'Accept': 'application/json',\n   'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n",
        "customLabel": ""
      },
      {
        "id": "FKey3rr8haicO2g_gG-Gv",
        "language": "ruby",
        "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://{suga-id}.sugaway.io/p/branch/:id/inactive/{id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"Accept\"] = \"application/json\"\nrequest[\"Content-Type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "ffOYDr1j4i2Gf94ayKOwF"
  },
  "results": {
    "selectedLanguageId": "CmegnowtGkUCFFeAP7tBp",
    "languages": [
      {
        "id": "CmegnowtGkUCFFeAP7tBp",
        "language": "200",
        "customLabel": "",
        "code": "{\n      \"name\": \"Cake's name\",\n    }"
      },
      {
        "id": "lzxKcvOTfYehRtO3InxCx",
        "language": "404",
        "customLabel": "",
        "code": "{\n      \"message\": \"Ain't no cake like that.\"\n    }"
      }
    ]
  },
  "request": {
    "pathParameters": [
      {
        "name": "id",
        "kind": "required",
        "type": "string",
        "description": "ID de la sucursal que se quiere inactivar",
        "children": []
      }
    ],
    "queryParameters": [],
    "headerParameters": [
      {
        "name": "x-api-key",
        "kind": "required",
        "type": "string",
        "description": "API Key del operador",
        "children": []
      },
      {
        "name": "x-access-token",
        "kind": "required",
        "type": "string",
        "description": "Access Token del operador",
        "children": []
      },
      {
        "name": "x-suga-entity",
        "kind": "required",
        "type": "string",
        "description": "ID del comercio sobre el cual se desean gestionar las sucursales",
        "children": []
      }
    ],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Header Parameter",
    "value": "headerParameters"
  },
  "hasTryItOut": false,
  "autoGeneratedAnchorSlug": "inactivar-sucursal",
  "legacyHash": "CkrvvGCjssCA9NW5tq0yi"
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Reactivar Sucursal",
  "method": "PUT",
  "url": "https://{suga-id}.sugaway.io/p/branch/:id/active",
  "description": "",
  "tab": "examples",
  "examples": {
    "selectedLanguageId": "0W9mfTjLA-gotFyLybM3R",
    "languages": [
      {
        "id": "0W9mfTjLA-gotFyLybM3R",
        "language": "javascript",
        "code": "var myHeaders = new Headers();\nmyHeaders.append(\"Accept\", \"application/json\");\nmyHeaders.append(\"Content-Type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"id\": \"string\"\n});\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.cakes.com\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));",
        "customLabel": ""
      }
    ]
  },
  "results": {
    "selectedLanguageId": "cRrVFJ7HVphHKiRJ8C3J-",
    "languages": [
      {
        "id": "cRrVFJ7HVphHKiRJ8C3J-",
        "language": "200",
        "customLabel": "",
        "code": "{\n      \"name\": \"Cake's name\",\n    }"
      },
      {
        "id": "6t8wrJVEiV-6JrjkeYabZ",
        "language": "404",
        "customLabel": "",
        "code": "{\n      \"message\": \"Ain't no cake like that.\"\n    }"
      }
    ]
  },
  "request": {
    "pathParameters": [
      {
        "name": "id",
        "kind": "required",
        "type": "string",
        "description": "ID de la sucursal que se quiere reactivar",
        "children": []
      }
    ],
    "queryParameters": [],
    "headerParameters": [
      {
        "name": "x-api-key",
        "kind": "required",
        "type": "string",
        "description": "API Key del Operador",
        "children": []
      },
      {
        "name": "x-access-token",
        "kind": "required",
        "type": "string",
        "description": "Access Token del Operador",
        "children": []
      },
      {
        "name": "x-suga-entity",
        "kind": "required",
        "type": "string",
        "description": "ID del comercio sobre el cual se desean gestionar las sucursales",
        "children": []
      }
    ],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Header Parameter",
    "value": "headerParameters"
  },
  "hasTryItOut": false,
  "autoGeneratedAnchorSlug": "reactivar-sucursal",
  "legacyHash": "rw82UhzwR52sbE1LwlpWx"
}
```
:::