Puntos de Venta

2 min

A partir de esta especificación se podrán crear Puntos de Venta de un comercio o de una sucursal.

Crear Punto de Venta

POST

https://{suga-id}.sugaway.io/p/pos

Header Parameters

x-api-keystringrequired
Description
API Key del operador
x-access-tokenstringrequired
Description
Access Token del Operador
x-suga-entitystringrequired
Description
ID del comercio o sucursal sobre el cual se desea crear el punto de venta

Body Parameters

namestringrequired
Description
Nombre de fantasía del punto de venta
referencestring
Description
Referencia única que permita identificar al punto de venta dentro del comercio o sucursal. Si no se envía se generara una automáticamente.
countryCategoryCodestring
Description
Indica el código de actividad a aplicarse en este POS. Si no se envía aplica el principal del comercio.
mccstring
Description
Contiene el código de categoría del Punto de Venta, si aplica uno diferente al del comercio. Si no se envía, se aplica por defecto el que indica según la actividad del POS o Comercio
emailstring
Description
Email del punto de venta. Si no se envía se considera el email del comercio.
phonestring
Description
Teléfono del punto de venta. Si no se envía se considera el teléfono del comercio.
accountTypestring
Description
Permite definir una cuenta bancaria o virtual para el destino de los fondos del punto de venta, en el caso que sea diferente al comercio o sucursal. Aplicar sólo en los casos requeridos y previa autorización de SUGA
accountNumberstring
Description
En el caso de especificar una cuenta, indica el número de cuenta de destino de los fondos.

curl

curl --location --globoff 'https://{suga-id}.sugaway.com/p/branch' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"name":"string","reference":"string","address":"Object","state":"string","city":"string","zipCode":"string","email":"string","phone":"string"}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://{suga-id}.sugaway.com/p/branch',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "name": "string",
      "reference": "string",
      "address": "Object",
      "state": "string",
      "city": "string",
      "zipCode": "string",
      "email": "string",
      "phone": "string"
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
   "name": "string",
   "reference": "string",
   "address": "Object",
   "state": "string",
   "city": "string",
   "zipCode": "string",
   "email": "string",
   "phone": "string"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://{suga-id}.sugaway.com/p/branch", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://{suga-id}.sugaway.com/p/branch"

payload = json.dumps({
   "name": "string",
   "reference": "string",
   "address": "Object",
   "state": "string",
   "city": "string",
   "zipCode": "string",
   "email": "string",
   "phone": "string"
})
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://{suga-id}.sugaway.com/p/branch")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
   "name": "string",
   "reference": "string",
   "address": "Object",
   "state": "string",
   "city": "string",
   "zipCode": "string",
   "email": "string",
   "phone": "string"
})

response = https.request(request)
puts response.read_body

curl

curl --location --globoff 'https://{suga-id}.sugaway.io/p/pos' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"name":"string","reference":"string","countryCategoryCode":"string","mcc":"string","email":"string","phone":"string"}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://{suga-id}.sugaway.io/p/pos',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "name": "string",
      "reference": "string",
      "countryCategoryCode": "string",
      "mcc": "string",
      "email": "string",
      "phone": "string"
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
   "name": "string",
   "reference": "string",
   "countryCategoryCode": "string",
   "mcc": "string",
   "email": "string",
   "phone": "string"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://{suga-id}.sugaway.io/p/pos", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://{suga-id}.sugaway.io/p/pos"

payload = json.dumps({
   "name": "string",
   "reference": "string",
   "countryCategoryCode": "string",
   "mcc": "string",
   "email": "string",
   "phone": "string"
})
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://{suga-id}.sugaway.io/p/pos")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
   "name": "string",
   "reference": "string",
   "countryCategoryCode": "string",
   "mcc": "string",
   "email": "string",
   "phone": "string"
})

response = https.request(request)
puts response.read_body

200

{
      "result": true,
      "data": {
        "id": "posID"
      }
}

404

{
      "message": "Ain't no cake like that."
    }

Editar Punto de Venta

PUT

https://{suga-id}.sugaway.io/p/pos/{uid}

Path Parameters

uidstringrequired
Description
ID del punto de venta que se quiere modificar

Header Parameters

x-api-keystringrequired
Description
API Key del operador
x-access-tokenstringrequired
Description
Access Token del Operador
x-suga-entitystringrequired
Description
ID del comercio o sucursal sobre el cual se desea editar el punto de venta

Body Parameters

namestring
Description
Nombre de fantasía del punto de venta
countryCategoryCodestring
Description
Indica el código de actividad a aplicarse en este POS.
mccstring
Description
Contiene el código de categoría del Punto de Venta, si aplica uno diferente al del comercio.
emailstring
Description
Email del punto de venta.
phonestring
Description
Teléfono del punto de venta.

curl

curl --location --globoff 'https://{suga-id}.sugaway.com/p/branch' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"name":"string","reference":"string","address":"Object","state":"string","city":"string","zipCode":"string","email":"string","phone":"string"}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://{suga-id}.sugaway.com/p/branch',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "name": "string",
      "reference": "string",
      "address": "Object",
      "state": "string",
      "city": "string",
      "zipCode": "string",
      "email": "string",
      "phone": "string"
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
   "name": "string",
   "reference": "string",
   "address": "Object",
   "state": "string",
   "city": "string",
   "zipCode": "string",
   "email": "string",
   "phone": "string"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://{suga-id}.sugaway.com/p/branch", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://{suga-id}.sugaway.com/p/branch"

payload = json.dumps({
   "name": "string",
   "reference": "string",
   "address": "Object",
   "state": "string",
   "city": "string",
   "zipCode": "string",
   "email": "string",
   "phone": "string"
})
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://{suga-id}.sugaway.com/p/branch")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
   "name": "string",
   "reference": "string",
   "address": "Object",
   "state": "string",
   "city": "string",
   "zipCode": "string",
   "email": "string",
   "phone": "string"
})

response = https.request(request)
puts response.read_body

curl

curl --location --globoff 'https://{suga-id}.sugaway.io/p/pos/:id/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"name":"string","countryCategoryCode":"string","mcc":"string","email":"string","phone":"string"}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://{suga-id}.sugaway.io/p/pos/:id/{id}',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "name": "string",
      "countryCategoryCode": "string",
      "mcc": "string",
      "email": "string",
      "phone": "string"
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
   "name": "string",
   "countryCategoryCode": "string",
   "mcc": "string",
   "email": "string",
   "phone": "string"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://{suga-id}.sugaway.io/p/pos/:id/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://{suga-id}.sugaway.io/p/pos/:id/{id}"

payload = json.dumps({
   "name": "string",
   "countryCategoryCode": "string",
   "mcc": "string",
   "email": "string",
   "phone": "string"
})
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://{suga-id}.sugaway.io/p/pos/:id/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
   "name": "string",
   "countryCategoryCode": "string",
   "mcc": "string",
   "email": "string",
   "phone": "string"
})

response = https.request(request)
puts response.read_body

200

{
      "result": true,
      "data": {}
}

404

{
      "message": "Ain't no cake like that."
    }

Los posible códigos de error al crear o modificar un Punto de Venta son:

POS:INVALID_REFERENCE

POS:INVALID_MCC

POS:INVALID_ACCOUNT

POS:POS_NOT_FOUND -> El {uid} no corresponde a un punto de venta válido

Inactivar Punto de Venta

PUT

https://{suga-id}.sugaway.io/p/pos/{uid}/inactive

Path Parameters

uidstringrequired
Description
ID del POS que se quiere inactivar

Header Parameters

x-api-keystringrequired
Description
API Key del operador
x-access-tokenstringrequired
Description
Access Token del operador
x-suga-entitystringrequired
Description
ID del comercio sobre el cual se desean gestionar los POS

curl

curl --location --globoff --request PUT 'https://{suga-id}.sugaway.io/p/branch/:id/inactive/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

nodejs

var request = require('request');
var options = {
   'method': 'PUT',
   'url': 'https://{suga-id}.sugaway.io/p/branch/:id/inactive/{id}',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var requestOptions = {
   method: 'PUT',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://{suga-id}.sugaway.io/p/branch/:id/inactive/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://{suga-id}.sugaway.io/p/branch/:id/inactive/{id}"

payload = {}
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://{suga-id}.sugaway.io/p/branch/:id/inactive/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"

response = https.request(request)
puts response.read_body

curl

curl --location --globoff --request PUT 'https://{suga-id}.sugaway.io/p/pos/:id/inactive/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

nodejs

var request = require('request');
var options = {
   'method': 'PUT',
   'url': 'https://{suga-id}.sugaway.io/p/pos/:id/inactive/{id}',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var requestOptions = {
   method: 'PUT',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://{suga-id}.sugaway.io/p/pos/:id/inactive/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://{suga-id}.sugaway.io/p/pos/:id/inactive/{id}"

payload = {}
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://{suga-id}.sugaway.io/p/pos/:id/inactive/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"

response = https.request(request)
puts response.read_body

200

{
      "result": true,
      "data": {}
    }

404

{
      "message": "Ain't no cake like that."
    }

Reactivar Punto de Venta

PUT

https://{suga-id}.sugaway.io/p/pos/{uid}/active

Path Parameters

uidstringrequired
Description
ID del POS que se quiere reactivar

Header Parameters

x-api-keystringrequired
Description
API Key del Operador
x-access-tokenstringrequired
Description
Access Token del Operador
x-suga-entitystringrequired
Description
ID del comercio sobre el cual se desean gestionar los puntos de venta

curl

curl --location --globoff --request PUT 'https://{suga-id}.sugaway.io/p/pos/:id/active/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

nodejs

var request = require('request');
var options = {
   'method': 'PUT',
   'url': 'https://{suga-id}.sugaway.io/p/pos/:id/active/{id}',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var requestOptions = {
   method: 'PUT',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://{suga-id}.sugaway.io/p/pos/:id/active/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://{suga-id}.sugaway.io/p/pos/:id/active/{id}"

payload = {}
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://{suga-id}.sugaway.io/p/pos/:id/active/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"

response = https.request(request)
puts response.read_body

curl

curl --location --globoff --request PUT 'https://{suga-id}.sugaway.io/p/pos/{id}/active/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

nodejs

var request = require('request');
var options = {
   'method': 'PUT',
   'url': 'https://{suga-id}.sugaway.io/p/pos/{id}/active/{id}',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var requestOptions = {
   method: 'PUT',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://{suga-id}.sugaway.io/p/pos/{id}/active/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://{suga-id}.sugaway.io/p/pos/{id}/active/{id}"

payload = {}
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://{suga-id}.sugaway.io/p/pos/{id}/active/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"

response = https.request(request)
puts response.read_body

200

{
      "result": true,
      "data": {}
    }

404

{
      "message": "Ain't no cake like that."
    }