Agregadores y PSPaaS
Sucursales
3 min
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 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 en caso de no utilizar referencia, es posible utilizar el siguiente método para editar una sucursal 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 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 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 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