diff --git a/reference/api-json/pos copy.json b/reference/api-json/pos copy.json deleted file mode 100644 index 4f13533c90..0000000000 --- a/reference/api-json/pos copy.json +++ /dev/null @@ -1,1788 +0,0 @@ -{ - "url": "https://api.mercadopago.com", - "paths": { - "/pos": { - "post": { - "tags": [ - "qr-code", - "mp-point" - ], - "description": { - "en": "Generate a point of sale in a store. Each POS will have a unique QR Code linked to it", - "pt": "Gerar um ponto de venda em uma loja. Cada caixa registradora terá um código QR exclusivo vinculado a ela", - "es": "Genera un punto de venta en una sucursal. Cada caja tendrá vinculado un código QR unívoco" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": { - "en": "Name of the point of sale.", - "pt": "Nome do ponto de venda.", - "es": "Nombre del punto de venta." - }, - "example": "First POS" - }, - "fixed_amount": { - "type": "boolean", - "description": { - "en": "Define if the customer can insert the amount to be paid.", - "pt": "Determine se o cliente pode inserir o valor a ser pago.", - "es": "Determina si el cliente puede insertar el monto a pagar." - }, - "example": false - }, - "store_id": { - "type": "string", - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o ponto de venda pertence.", - "es": "Identificador de la sucursal a la que pertenece el punto de venta." - }, - "example": 1234567 - }, - "external_store_id": { - "type": "string", - "description": { - "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", - "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", - "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." - }, - "example": "SUC001" - }, - "external_id": { - "type": "string", - "description": { - "en": "Unique identifier of the pos defined by integrator system.", - "pt": "Identificador único da caixa definido pelo sistema integrador.", - "es": "Identificador único de la caja definido por el integrador." - }, - "example": "SUC001POS001" - }, - "category": { - "$ref": "#/components/schemas/category" - }, - "url": { - "type": "string", - "description": { - "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", - "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", - "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": { - "en": "Success", - "pt": "Sucesso", - "es": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 2711382, - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." - } - }, - "qr": { - "type": "object", - "properties": { - "image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", - "description": { - "es": "image", - "pt": "image", - "en": "image" - } - }, - "template_document": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.pdf", - "description": { - "es": "template_document", - "pt": "template_document", - "en": "template_document" - } - }, - "template_image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", - "description": { - "es": "template_image", - "pt": "template_image", - "en": "template_image" - } - } - }, - "description": { - "es": "qr", - "pt": "qr", - "en": "qr" - } - }, - "status": { - "type": "string", - "example": "active", - "description": { - "es": "status", - "pt": "status", - "en": "status" - } - }, - "date_created": { - "type": "string", - "example": "2019-08-22T14:11:12.000Z", - "description": { - "es": "date_created", - "pt": "date_created", - "en": "date_created" - } - }, - "date_last_updated": { - "type": "string", - "example": "2019-08-22T14:11:12.000Z", - "description": { - "es": "date_last_updated", - "pt": "date_last_updated", - "en": "date_last_updated" - } - }, - "uuid": { - "type": "string", - "example": "0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1", - "description": { - "es": "uuid", - "pt": "uuid", - "en": "uuid" - } - }, - "user_id": { - "type": "number", - "example": 446566691, - "description": { - "es": "user_id", - "pt": "user_id", - "en": "user_id" - } - }, - "name": { - "type": "string", - "example": "First POS", - "description": { - "es": "name", - "pt": "name", - "en": "name" - } - }, - "fixed_amount": { - "type": "boolean", - "example": false, - "description": { - "es": "fixed_amount", - "pt": "fixed_amount", - "en": "fixed_amount" - } - }, - "category": { - "$ref": "#/components/schemas/category" - }, - "store_id": { - "type": "string", - "example": 1234567, - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o ponto de venda pertence.", - "es": "Identificador de la sucursal a la que pertenece el punto de venta." - } - }, - "external_store_id": { - "type": "string", - "example": "SUC001", - "description": { - "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", - "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", - "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." - } - }, - "url": { - "type": "string", - "description": { - "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", - "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", - "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." - } - }, - "external_id": { - "type": "string", - "example": "SUC001POS001", - "description": { - "en": "Unique identifier of the pos defined by integrator system.", - "pt": "Identificador único da caixa definido pelo sistema integrador.", - "es": "Identificador único de la caja definido por el integrador." - } - } - } - } - } - } - }, - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "MISSING_BODY", - "description": { - "en": "HTTP body is required to modify pos.", - "es": "El cuerpo del HTTP es requerido para modificar el punto de venta.", - "pt": "O corpo do HTTP é necessário para modificar o ponto de venda." - } - }, - { - "title": "UNKNOWN_FIELD_EXCEPTION", - "description": { - "en": "The indicated field is not allowed for this operation or is unknown.", - "es": "El campo indicado no está permitido para esta operación o es desconocido.", - "pt": "O campo indicado não é permitido para esta operação ou é desconhecido." - } - }, - { - "title": "INVALID_POS_ID", - "description": { - "en": "The ID of the pos is invalid, it must be numeric.", - "es": "El ID del punto de venta es inválida, debe ser numérica.", - "pt": "O ID do ponto de venda é inválida, deve ser numérica." - } - }, - { - "title": "INVALID_NAME", - "description": { - "en": "NAME must be string.", - "es": "NOMBRE debe ser string.", - "pt": "NAME deve ser string." - } - }, - { - "title": "NAME_TOO_LONG", - "description": { - "en": "The NAME must be less than 45 characters.", - "es": "NAME debe ser menor de 45 caracteres.", - "pt": "NAME deve ter menos de 45 caracteres." - } - }, - { - "title": "INVALID_FIXED_AMOUNT", - "description": { - "en": "FIXED_AMOUNT must be boolean.", - "es": "FIXED_AMOUNT debe ser boolean.", - "pt": "FIXED_AMOUNT deve ser boolean." - } - }, - { - "title": "INVALID_CATEGORY", - "description": { - "en": "CATEGORY must be numeric.", - "es": "CATEGORY debe ser numérico.", - "pt": "CATEGORY deve ser numérico." - } - }, - { - "title": "POS_UNKNOWN_MCC", - "description": { - "en": "CATEGORY must be valid for the user's site.", - "es": "CATEGORY debe ser válida para el sitio del usuario.", - "pt": "CATEGORY deve ser válida para o site do usuário." - } - }, - { - "title": "POS_INVALID_STORE_ID", - "description": { - "en": "STORE_ID must be numeric.", - "es": "STORE_ID debe ser numérico.", - "pt": "STORE_ID deve ser numérico." - } - }, - { - "title": "INVALID_EXTERNAL_STORE_ID", - "description": { - "en": "EXTERNAL_STORE_ID must be string.", - "es": "EXTERNAL_STORE_ID debe ser string.", - "pt": "EXTERNAL_STORE_ID deve ser string." - } - }, - { - "title": "EXTERNAL_STORE_ID_NOT_MATCH", - "description": { - "en": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.", - "es": "El EXTERNAL_STORE_ID no hace referencia al STORE_ID indicado.", - "pt": "O EXTERNAL_STORE_ID não se refere ao STORE_ID indicado." - } - }, - { - "title": "INEXISTENT_EXTERNAL_STORE_ID", - "description": { - "en": "The EXTERNAL STORE_ID does not refer to an existing Store.", - "es": "El EXTERNAL_STORE_ID no hace referencia a una tienda existente.", - "pt": "O EXTERNAL_STORE_ID não se refere a uma loja existente." - } - }, - { - "title": "INVALID_EXTERNAL_ID", - "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces, hyphens or special characters.", - "es": "El campo EXTERNAL_ID debe ser alfanumérico, solo letras y números. Sin espacios, guiones o caracteres especiales.", - "pt": "O campo EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços, hífens ou caracteres especiais." - } - }, - { - "title": "EXTERNAL_ID_TOO_LONG", - "description": { - "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "El EXTERNAL_ID debe ser menor de 40 caracteres.", - "pt": "O EXTERNAL_ID deve ter menos de 40 caracteres." - } - }, - { - "title": "INVALID_URL", - "description": { - "en": "The URL must be string and muste have the format of a valid url", - "es": "La URL debe ser una cadena y debe tener el formato de una URL válida.", - "pt": "A URL deve ser uma string e deve ter o formato de uma URL válida." - } - }, - { - "title": "URL_TOO_LONG", - "description": { - "en": "The URL must be less than 300 characters.", - "es": "La URL debe ser menor de 300 caracteres.", - "pt": "A URL deve ter menos de 300 caracteres." - } - }, - { - "title": "FIXED_AMOUNT_FALSE", - "description": { - "en": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.", - "es": "Si se indica el campo URL, el campo FIXED_AMOUNT debe ser verdadero. No soportamos la modalidad de monto abierto en este caso.", - "pt": "Se o campo URL estiver indicado, o campo FIXED_AMOUNT deve ser verdadeiro. Não suportamos a modalidade de valor aberto nesse caso." - } - } - ] - } - } - } - } - } - }, - "403": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor.", - "es": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor.", - "pt": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor." - } - } - ] - } - } - } - } - } - }, - "404": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "pt": "Se o ponto de venda não existir para o ID ou EXTERNAL_ID indicado e para o usuário.", - "es": "Si el punto de venta no existe para el ID o EXTERNAL_ID indicado y para el usuario." - } - } - ] - } - } - } - } - } - }, - "409": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "A pos with the same EXTERNAL_ID already exists.", - "es": "A pos with the same EXTERNAL_ID already exists.", - "pt": "A pos with the same EXTERNAL_ID already exists." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Create point of sale", - "pt": "Criar caixa", - "es": "Crear caja" - } - }, - "get": { - "tags": [ - "qr-code", - "mp-point" - ], - "description": { - "en": "Get the information about all of your stores", - "pt": "Encontre todas as informações dos pontos de venda através de filtros específicos", - "es": "Encuentra toda la información de los puntos de venta a través de filtros específicos" - }, - "parameters": [ - { - "name": "external_id", - "in": "query", - "description": { - "en": "Unique identifier of the pos defined by integrator system.", - "pt": "Identificador único da caixa definido pelo sistema integrador.", - "es": "Identificador único de la caja definido por el integrador." - }, - "required": false, - "schema": { - "type": "string", - "example": "SUC001POS001" - } - }, - { - "name": "external_store_id", - "in": "query", - "description": { - "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", - "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", - "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." - }, - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "store_id", - "in": "query", - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o ponto de venda pertence.", - "es": "Identificador de la sucursal a la que pertenece el punto de venta." - }, - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "category", - "in": "query", - "description": { - "es": "Category", - "pt": "Category", - "en": "Category" - }, - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": { - "en": "Success", - "pt": "Sucesso", - "es": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "paging": { - "type": "object", - "properties": { - "total": { - "type": "number", - "example": 1, - "description": { - "es": "total", - "pt": "total", - "en": "total" - } - }, - "offset": { - "type": "number", - "example": 0, - "description": { - "es": "offset", - "pt": "offset", - "en": "offset" - } - }, - "limit": { - "type": "number", - "example": 0, - "description": { - "es": "limit", - "pt": "limit", - "en": "limit" - } - } - }, - "description": { - "es": "paging", - "pt": "paging", - "en": "paging" - } - }, - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user_id": { - "type": "number", - "example": 446566691, - "description": { - "es": "user_id", - "pt": "user_id", - "en": "user_id" - } - }, - "name": { - "type": "string", - "example": "Caja Principal", - "description": { - "es": "name", - "pt": "name", - "en": "name" - } - }, - "fixed_amount": { - "type": "boolean", - "description": { - "es": "fixed_amount", - "pt": "fixed_amount", - "en": "fixed_amount" - } - }, - "category": { - "$ref": "#/components/schemas/category" - }, - "store_id": { - "type": "string", - "example": 1234567, - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o ponto de venda pertence.", - "es": "Identificador de la sucursal a la que pertenece el punto de venta." - } - }, - "external_id": { - "type": "string", - "example": "SUC001POS001", - "description": { - "en": "Unique identifier of the pos defined by integrator system.", - "pt": "Identificador único da caixa definido pelo sistema integrador.", - "es": "Identificador único de la caja definido por el integrador." - } - }, - "id": { - "type": "number", - "example": 1988157, - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." - } - }, - "qr": { - "type": "object", - "properties": { - "image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/1988157/1f1da6401a4645e99fa21d3f4ffe0e702c4eab2209784fce9d45c83fa93bd5a7.png", - "description": { - "es": "image", - "pt": "image", - "en": "image" - } - }, - "template_document": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/1988157/template_1f1da6401a4645e99fa21d3f4ffe0e702c4eab2209784fce9d45c83fa93bd5a7.pdf", - "description": { - "es": "template_document", - "pt": "template_document", - "en": "template_document" - } - }, - "template_image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/1988157/template_1f1da6401a4645e99fa21d3f4ffe0e702c4eab2209784fce9d45c83fa93bd5a7.png", - "description": { - "es": "template_image", - "pt": "template_image", - "en": "template_image" - } - } - }, - "description": { - "es": "qr", - "pt": "qr", - "en": "qr" - } - }, - "date_created": { - "type": "string", - "example": "2019-06-24T13:31:56.000Z", - "description": { - "es": "date_created", - "pt": "date_created", - "en": "date_created" - } - }, - "date_last_updated": { - "type": "string", - "example": "2019-08-07T21:07:26.000Z", - "description": { - "es": "date_last_updated", - "pt": "date_last_updated", - "en": "date_last_updated" - } - }, - "external_store_id": { - "type": "string", - "example": "SUC001", - "description": { - "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", - "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", - "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." - } - } - } - }, - "description": { - "es": "results", - "pt": "results", - "en": "results" - } - } - } - } - } - } - }, - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "INVALID_CATEGORY", - "description": { - "en": "The CATEGORY must be numeric.", - "es": "The CATEGORY must be numeric.", - "pt": "The CATEGORY must be numeric." - } - }, - { - "title": "INVALID_STORE_ID", - "description": { - "en": "The STORE_ID must be numeric.", - "es": "The STORE_ID must be numeric.", - "pt": "The STORE_ID must be numeric." - } - }, - { - "title": "INVALID_EXTERNAL_STORE_ID", - "description": { - "en": "The EXTERNAL_STORE_ID must be string.", - "es": "The EXTERNAL_STORE_ID must be string.", - "pt": "The EXTERNAL_STORE_ID must be string." - } - }, - { - "title": "INEXISTENT_EXTERNAL_STORE_ID", - "description": { - "en": "The EXTERNAL STORE_ID does not refer to an existing Store.", - "es": "The EXTERNAL STORE_ID does not refer to an existing Store.", - "pt": "The EXTERNAL STORE_ID does not refer to an existing Store." - } - }, - { - "title": "INVALID_EXTERNAL_ID", - "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "es": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "pt": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters." - } - }, - { - "title": "EXTERNAL_ID_TOO_LONG", - "description": { - "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "The EXTERNAL_ID must be less than 40 characters.", - "pt": "The EXTERNAL_ID must be less than 40 characters." - } - }, - { - "title": "INVALID_LIMIT", - "description": { - "en": "The LIMIT must be numeric.", - "es": "The LIMIT must be numeric.", - "pt": "The LIMIT must be numeric." - } - }, - { - "title": "INVALID_OFFSET", - "description": { - "en": "The OFFSET must be numeric.", - "es": "The OFFSET must be numeric.", - "pt": "The OFFSET must be numeric." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Search POS", - "pt": "Buscar em caixas", - "es": "Buscar en cajas" - } - } - }, - "/pos/{id}": { - "get": { - "tags": [ - "qr-code", - "mp-point" - ], - "description": { - "en": "This endpoint allows you to find all the information about the points of sale created using specific filters.", - "pt": "Este endpoint permite encontrar todas as informações das caixas (ponto de venda) criadas utilizando filtros específicos.", - "es": "Este endpoint permite encontrar toda la información de las cajas (puntos de venta) creadas utilizando filtros específicos." - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." - }, - "required": true, - "schema": { - "type": "string", - "example": 1988157 - } - } - ], - "responses": { - "200": { - "description": { - "en": "Success", - "pt": "Sucesso", - "es": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": 1988157, - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." - } - }, - "qr": { - "type": "object", - "properties": { - "image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.png" - }, - "template_document": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/template_c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.pdf" - }, - "template_image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/template_c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.png" - } - } - }, - "status": { - "type": "string", - "example": "active" - }, - "date_created": { - "type": "string", - "example": "2019-09-03T13:13:54.000-04:00" - }, - "date_last_updated": { - "type": "string", - "example": "2020-09-30T08:38:58.000-04:00" - }, - "uuid": { - "type": "string", - "example": "c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68" - }, - "compatible_id": { - "type": "string", - "example": "4be87a269a7b863fd043658d2a0d7b3fa2f32334138ff651e2408d3f8191d6c9f67a4dc297e9efc70d1adfbb31f7c21c29c9059ac905a359e39114c9871afef9" - }, - "user_id": { - "type": "number", - "example": 329653108 - }, - "name": { - "type": "string", - "example": "POS001" - }, - "fixed_amount": { - "type": "boolean", - "example": false - }, - "store_id": { - "type": "string", - "example": 56807753 - }, - "external_store_id": { - "type": "string", - "example": "SUC01" - }, - "external_id": { - "type": "string", - "example": "SUC001POS002" - }, - "site": { - "type": "string", - "example": "MLB" - }, - "qr_code": { - "type": "string", - "example": "00020101021226940014BR.GOV.BCB.PIX2572pix-qr-h.mercadopago.com/instore/h/p/v2/c955a5618d874e998c8399e3515fed3a43520016com.mercadolibre0128https://mpago.la/pos/28521285204000053039865802BR5924VICTOR CORREA DE ALMEIDA6008CAMPINAS62070503***6304367C" - } - } - } - } - } - }, - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "INVALID_POS_ID", - "description": { - "en": "The ID of the pos is invalid, it must be numeric.", - "es": "El ID del punto de venta es inválida, debe ser numérica.", - "pt": "O ID do ponto de venda é inválida, deve ser numérica." - } - }, - { - "title": "INVALID_EXTERNAL_ID", - "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces, hyphens or special characters.", - "es": "El campo EXTERNAL_ID debe ser alfanumérico, solo letras y números. Sin espacios, guiones o caracteres especiales.", - "pt": "O campo EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços, hífens ou caracteres especiais." - } - }, - { - "title": "EXTERNAL_ID_TOO_LONG", - "description": { - "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "El EXTERNAL_ID debe ser menor de 40 caracteres.", - "pt": "O EXTERNAL_ID deve ter menos de 40 caracteres." - } - } - ] - } - } - } - } - } - }, - "404": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "pt": "Se o ponto de venda não existir para o ID ou EXTERNAL_ID indicado e para o usuário.", - "es": "Si el punto de venta no existe para el ID o EXTERNAL_ID indicado y para el usuario." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Get POS", - "pt": "Obter caixa", - "es": "Obtener caja" - } - }, - "put": { - "tags": [ - "qr-code", - "mp-point" - ], - "description": { - "en": "This endpoint allows you to update the data of a point of sale. To use it, you need to provide the identification of the point of sale and send the parameters with the information to be updated.", - "pt": "Este endpoint permite atualizar os dados de uma caixa (ponto de venda). Para utilizá-lo, é necessário fornecer a identificação do ponto de venda e enviar os parâmetros com as informações a serem atualizadas.", - "es": "Este endpoint permite actualizar los datos de una caja (punto de venta). Para utilizarlo, es necesario proporcionar la identificación del punto de venta y enviar los parámetros con la información que se debe actualizar." - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including updating the point of sale data.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo a atualização de dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la actualización de los datos del punto de venta." - }, - "required": true, - "schema": { - "type": "string", - "example": 1988157 - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": { - "en": "Name of the point of sale.", - "pt": "Nome da caixa (ponto de venda).", - "es": "Nombre de la caja (punto de venta)." - }, - "example": "First POS" - }, - "fixed_amount": { - "type": "boolean", - "description": { - "en": "Define if the customer can insert the amount to be paid.", - "pt": "Determine se o cliente pode inserir o valor a ser pago.", - "es": "Determina si el cliente puede insertar el monto a pagar." - }, - "example": false - }, - "category": { - "$ref": "#/components/schemas/category" - }, - "store_id": { - "type": "string", - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o ponto de venda pertence.", - "es": "Identificador de la sucursal a la que pertenece el punto de venta." - }, - "example": 1234567 - }, - "external_store_id": { - "type": "string", - "description": { - "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", - "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", - "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." - } - }, - "url": { - "type": "string", - "description": { - "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", - "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", - "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": { - "en": "Success", - "pt": "Sucesso", - "es": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 2711382, - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." - } - }, - "qr": { - "type": "object", - "properties": { - "image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", - "description": { - "es": "image", - "pt": "image", - "en": "image" - } - }, - "template_document": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.pdf", - "description": { - "es": "template_document", - "pt": "template_document", - "en": "template_document" - } - }, - "template_image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", - "description": { - "es": "template_image", - "pt": "template_image", - "en": "template_image" - } - } - }, - "description": { - "es": "qr", - "pt": "qr", - "en": "qr" - } - }, - "status": { - "type": "string", - "example": "active", - "description": { - "es": "status", - "pt": "status", - "en": "status" - } - }, - "date_created": { - "type": "string", - "example": "2019-08-22T14:11:12.000Z", - "description": { - "es": "date_created", - "pt": "date_created", - "en": "date_created" - } - }, - "date_last_updated": { - "type": "string", - "example": "2019-08-22T14:11:12.000Z", - "description": { - "es": "date_last_updated", - "pt": "date_last_updated", - "en": "date_last_updated" - } - }, - "uuid": { - "type": "string", - "example": "0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1", - "description": { - "es": "uuid", - "pt": "uuid", - "en": "uuid" - } - }, - "user_id": { - "type": "number", - "example": 446566691, - "description": { - "es": "user_id", - "pt": "user_id", - "en": "user_id" - } - }, - "name": { - "type": "string", - "example": "First POS", - "description": { - "es": "name", - "pt": "name", - "en": "name" - } - }, - "fixed_amount": { - "type": "boolean", - "example": false, - "description": { - "es": "fixed_amount", - "pt": "fixed_amount", - "en": "fixed_amount" - } - }, - "category": { - "$ref": "#/components/schemas/category" - }, - "store_id": { - "type": "string", - "example": 1234567, - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o ponto de venda pertence.", - "es": "Identificador de la sucursal a la que pertenece el punto de venta." - } - }, - "external_store_id": { - "type": "string", - "example": "SUC001", - "description": { - "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", - "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", - "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." - } - }, - "url": { - "type": "string", - "description": { - "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", - "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", - "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." - } - }, - "external_id": { - "type": "string", - "example": "SUC001POS002", - "description": { - "en": "Unique identifier of the pos defined by integrator system.", - "pt": "Identificador único da caixa definido pelo sistema integrador.", - "es": "Identificador único de la caja definido por el integrador." - } - }, - "site": { - "type": "string", - "example": "MLB" - }, - "qr_code": { - "type": "string", - "example": "00020101021226940014BR.GOV.BCB.PIX2572pix-qr-h.mercadopago.com/instore/h/p/v2/db12b6e2ec4844839825c6dce7cd2f2243530016com.mercadolibre0129https://mpago.la/pos/212798995204000053039865802BR5924VICTOR CORREA DE ALMEIDA6008CAMPINAS62070503***63040B44" - } - } - } - } - } - }, - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "MISSING_BODY", - "description": { - "en": "HTTP body is required to modify pos.", - "es": "El cuerpo del HTTP es requerido para modificar el punto de venta.", - "pt": "O corpo do HTTP é necessário para modificar o ponto de venda." - } - }, - { - "title": "UNKNOWN_FIELD_EXCEPTION", - "description": { - "en": "The indicated field is not allowed for this operation or is unknown.", - "es": "El campo indicado no está permitido para esta operación o es desconocido.", - "pt": "O campo indicado não é permitido para esta operação ou é desconhecido." - } - }, - { - "title": "INVALID_POS_ID", - "description": { - "en": "The ID of the pos is invalid, it must be numeric.", - "es": "El ID del punto de venta es inválida, debe ser numérica.", - "pt": "O ID do ponto de venda é inválida, deve ser numérica." - } - }, - { - "title": "INVALID_NAME", - "description": { - "en": "NAME must be string.", - "es": "NOMBRE debe ser string.", - "pt": "NAME deve ser string." - } - }, - { - "title": "NAME_TOO_LONG", - "description": { - "en": "The NAME must be less than 45 characters.", - "es": "NAME debe ser menor de 45 caracteres.", - "pt": "NAME deve ter menos de 45 caracteres." - } - }, - { - "title": "INVALID_FIXED_AMOUNT", - "description": { - "en": "FIXED_AMOUNT must be boolean.", - "es": "FIXED_AMOUNT debe ser boolean.", - "pt": "FIXED_AMOUNT deve ser boolean." - } - }, - { - "title": "INVALID_CATEGORY", - "description": { - "en": "CATEGORY must be numeric.", - "es": "CATEGORY debe ser numérico.", - "pt": "CATEGORY deve ser numérico." - } - }, - { - "title": "POS_UNKNOWN_MCC", - "description": { - "en": "CATEGORY must be valid for the user's site.", - "es": "CATEGORY debe ser válida para el sitio del usuario.", - "pt": "CATEGORY deve ser válida para o site do usuário." - } - }, - { - "title": "POS_INVALID_STORE_ID", - "description": { - "en": "STORE_ID must be numeric.", - "es": "STORE_ID debe ser numérico.", - "pt": "STORE_ID deve ser numérico." - } - }, - { - "title": "INVALID_EXTERNAL_STORE_ID", - "description": { - "en": "EXTERNAL_STORE_ID must be string.", - "es": "EXTERNAL_STORE_ID debe ser string.", - "pt": "EXTERNAL_STORE_ID deve ser string." - } - }, - { - "title": "EXTERNAL_STORE_ID_NOT_MATCH", - "description": { - "en": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.", - "es": "El EXTERNAL_STORE_ID no hace referencia al STORE_ID indicado.", - "pt": "O EXTERNAL_STORE_ID não se refere ao STORE_ID indicado." - } - }, - { - "title": "INEXISTENT_EXTERNAL_STORE_ID", - "description": { - "en": "The EXTERNAL STORE_ID does not refer to an existing Store.", - "es": "El EXTERNAL_STORE_ID no hace referencia a una tienda existente.", - "pt": "O EXTERNAL_STORE_ID não se refere a uma loja existente." - } - }, - { - "title": "INVALID_EXTERNAL_ID", - "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces, hyphens or special characters.", - "es": "El campo EXTERNAL_ID debe ser alfanumérico, solo letras y números. Sin espacios, guiones o caracteres especiales.", - "pt": "O campo EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços, hífens ou caracteres especiais." - } - }, - { - "title": "EXTERNAL_ID_TOO_LONG", - "description": { - "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "El EXTERNAL_ID debe ser menor de 40 caracteres.", - "pt": "O EXTERNAL_ID deve ter menos de 40 caracteres." - } - }, - { - "title": "INVALID_URL", - "description": { - "en": "The URL must be string and muste have the format of a valid url", - "es": "La URL debe ser una cadena y debe tener el formato de una URL válida.", - "pt": "A URL deve ser uma string e deve ter o formato de uma URL válida." - } - }, - { - "title": "URL_TOO_LONG", - "description": { - "en": "The URL must be less than 300 characters.", - "es": "La URL debe ser menor de 300 caracteres.", - "pt": "A URL deve ter menos de 300 caracteres." - } - }, - { - "title": "FIXED_AMOUNT_FALSE", - "description": { - "en": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.", - "es": "Si se indica el campo URL, el campo FIXED_AMOUNT debe ser verdadero. No soportamos la modalidad de monto abierto en este caso.", - "pt": "Se o campo URL estiver indicado, o campo FIXED_AMOUNT deve ser verdadeiro. Não suportamos a modalidade de valor aberto nesse caso." - } - } - ] - } - } - } - } - } - }, - "403": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor.", - "es": "Si está utilizando el campo URL, el host debe estar habilitado por Mercado Pago. Si no lo está, recibirá este error. Por favor, comuníquese con su asesor técnico asignado.", - "pt": "Se você estiver usando o campo URL, o host deve ser habilitado pelo Mercado Pago. Se não for, você receberá este erro. Por favor, entre em contato com seu assessor técnico designado." - } - } - ] - } - } - } - } - } - }, - "404": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "If the point of sale does not exist for an indicated ID or EXTERNAL_ID and to the user.", - "es": "Si el punto de venta no existe para un ID o EXTERNAL_ID indicado y para el usuario.", - "pt": "Se o ponto de venda não existir para um ID ou EXTERNAL_ID indicado e para o usuário." - } - } - ] - } - } - } - } - } - }, - "409": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "A pont of sale with the same EXTERNAL_ID already exists.", - "es": "Ya existe un punto de venta con el mismo EXTERNAL_ID.", - "pt": "Já existe um ponto de venda com o mesmo EXTERNAL_ID." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Update point of sale", - "pt": "Atualizar caixa", - "es": "Actualizar caja" - } - }, - "delete": { - "tags": [ - "qr-code", - "mp-point" - ], - "description": { - "en": "This endpoint allows the deletion of a specific point of sale, identified by its ID.", - "pt": "Este endpoint permite a exclusão de uma caixa (ponto de venda) específica, identificada pelo seu ID.", - "es": "Este endpoint permite la eliminación de una caja (punto de venta) específica, identificada por su ID." - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including deleting a point of sale.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la eliminación de un punto de venta." - }, - "required": true, - "schema": { - "type": "string", - "example": "12123adfasdf123u4u" - } - } - ], - "responses": { - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "INVALID_POS_ID", - "description": { - "en": "The ID of the pos is invalid, it must be numeric.", - "es": "El ID del punto de venta es inválida, debe ser numérica.", - "pt": "O ID do ponto de venda é inválido, deve ser numérica." - } - } - ] - } - } - } - } - } - }, - "404": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "If there is no pos for the indicated ID and user.", - "es": "Si no hay punto de venta para el ID y el usuario indicados.", - "pt": "Se não houver ponto de venda para o ID e o usuário indicados." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Delete point of sale", - "pt": "Excluir caixa", - "es": "Eliminar caja" - } - } - } - }, - "components": { - "schemas": { - "category": { - "type": "number", - "example": 621102, - "description": { - "en": "MCC code that indicates the category of the point of sale. If not specified, it remains as a generic category.", - "pt": "Código MCC que indica a categoria do ponto de venda. Se não especificado, ele permanece como uma categoria genérica.", - "es": "Código MCC que indica el rubro del punto de venta. Si no se especifica, queda como categoría genérica." - }, - "enum": [ - { - "title": "Gastronomy", - "description": { - "en": "Gastronomy", - "es": "Gastronomía", - "pt": "Gastronomia" - } - }, - { - "title": "621102", - "description": { - "en": "Argentina", - "es": "Argentina", - "pt": "Argentina" - } - }, - { - "title": "5611203", - "description": { - "en": "Brazil", - "es": "Brasil", - "pt": "Brasil" - } - }, - { - "title": "5812", - "description": { - "en": "Mexico", - "es": "México", - "pt": "México" - } - }, - { - "title": "5611", - "description": { - "en": "Colombia", - "es": "Colombia", - "pt": "Colômbia" - } - }, - { - "title": "5520", - "description": { - "en": "Peru", - "es": "Perú", - "pt": "Peru" - } - }, - { - "title": "56101", - "description": { - "en": "Uruguay", - "es": "Uruguay", - "pt": "Uruguai" - } - }, - { - "title": "561000", - "description": { - "en": "Chile", - "es": "Chile", - "pt": "Chile" - } - }, - { - "title": "Gas station", - "description": { - "en": "Gas station", - "es": "Estación de servicio", - "pt": "posto de gasolina" - } - }, - { - "title": "473000", - "description": { - "en": "Argentina", - "es": "Argentina", - "pt": "Argentina" - } - }, - { - "title": "4731300", - "description": { - "en": "Brazil", - "es": "Brasil", - "pt": "Brasil" - } - }, - { - "title": "468419", - "description": { - "en": "Mexico", - "es": "México", - "pt": "México" - } - }, - { - "title": "4731", - "description": { - "en": "Colombia", - "es": "Colombia", - "pt": "Colômbia" - } - }, - { - "title": "5050", - "description": { - "en": "Peru", - "es": "Perú", - "pt": "Peru" - } - }, - { - "title": "47300", - "description": { - "en": "Uruguay", - "es": "Uruguay", - "pt": "Uruguai" - } - }, - { - "title": "473001", - "description": { - "en": "Chile", - "es": "Chile", - "pt": "Chile" - } - } - ] - } - } - } -} \ No newline at end of file