DOCS > RECURSOS PARA DISTRIBUIDORES > RECURSOS BÁSICOS

D.0. SINCRONIZAR CLIENTES

Un solo recurso para crear y modificar toda la información de clientes del distribuidor en la plataforma Gosbi.

Objetivo:

Sincronizar los clientes a los que vendemos producto (customers) para posteriormente informar de las ventas (recurso D.1. Informar ventas).
Sincronizar los nombres fiscales para entrar en el programa "Gosbi Next".
Sincronizar los agentes para dar acceso al equipo comercial a la herramienta de CRM de Gosbi.

Información a enviar en el documento de sincronización:
Direcciones de entrega: (customers) Direccion de entrega de un cliente del distribuidor.
Empresas: (business) Datos fiscales de empresa/autónomo. Cada dirección de entrega pertenece a una empresa.
Agentes comerciales: (agents) Agrupación de direcciones de entrega de clientes. A cada dirección de entrega se le asigna a un código de agente comercial.

Ver especificación técnica...

Información del recurso:

Url: /3rdp/distributors/customers
Method: POST
Document: JSON
Recurrencia: Ejecutar una vez al día o bajo petición usuario.

Estructura del documento:

Ruta	Campo	Tipo	Descripción
/	agents	array	Array de objetos agentes
agents/	src_id	str	ID único de Agente
agents/	name	str	Nombre de agente
/	business/	array	Array de objetos business
business/	vat_number	str	Identificación fiscal única
business/	name	str	Nombre fiscal de empresa
business/	address	str	Dirección fiscal -> calle y número
business/	address_admin2_src_id	str	Dirección fiscal -> ID único de província
business/	address_postal_code	str	Dirección fiscal -> Código postal
business/	address_admin3	str	Dirección fiscal -> Pueblo o Ciudad
business/	address_lat	float	Dirección fiscal -> latitud
business/	address_lng	float	Dirección fiscal -> longitud
/	customers	str	Array de objetos customer
customers/	src_id	str	ID único de cliente
customers/	name	str	Nombre comercial (o en su defecto nombre fiscal)
customers/	vat_number	str	Identificador fiscal (referencia objeto business)
customers/	address	str	Dirección de entrega -> calle y número
customers/	address_admin2_src_id	str	Dirección de entrega -> ID único de província
customers/	address_postal_code	str	Dirección de entrega -> Código postal
customers/	address_admin3	str	Dirección de entrega -> Pueblo o Ciudad
customers/	address_lat	float	Dirección de entrega -> Latitud
customers/	address_lng	float	Dirección de entrega -> Longitud
customers/	agent_src_id	str	Agente asignado (referencia objeto agents)
customers/	discount_1	str	Descuento 1 en pie de documento
customers/	discount_2	str	Descuento 2 en pie de documento
customers/	tribute_src_id	str	ID de tipo de impuesto del distribuidor
customers/	leaving_date	str	Fecha de baja del cliente

* Todos los campos son obligatorios (Not Null) excepto leaving_date, address_lat i address_lng
* Los porcentajes se informan de la siguiente forma: 1.5% se debe de enviar 1.5
* Siempre se envía el total de la información

Ejemplo: petición distribuidor > Gosbi:

Respuesta:

D.1. INFORMAR VENTAS

Existen dos recursos disponibles (crear y borrar) para mantener actualizada la información de ventas de producto a clientes en la plataforma Gosbi.

Objetivo:

Permitir a Gosbi supervisar que todas las ventas de producto se realizen dentro del marco estipulado por contrato.

D.1.1. CREAR una venta en la plataforma Gosbi

Ver especificación técnica...

Información del recurso:

Url: /3rdp/distributors/documents
Method: POST
Document: JSON
Recurrencia: En el momento de la venta o al final del día.

Estructura del documento:

Ruta	Campo	Tipo	Descripción
/	src_id	str	Id único de documento del distribuidor
/	document_date	timestamp(str)	Fecha de documento
/	customer_src_id	str	Id único cliente en servidor del distribuidor
/	discount_1	float	% Descuento 1 en total documento
/	discount_2	float	% Descuento 2 en total documento
/	currency_code	str	Código de moneda del documento (código ISO 4217)
/	lines	array	Array de lineas de pedido
lines/	product_src_id	str	Id único de producto del distribuidor
lines/	quantity	int	Unidades de producto servidas
lines/	price	float	Precio unitario del producto
lines/	discount_1	float	% Descuento 1 en línea
lines/	discount_2	float	% Descuento 2 en línea

* Los porcentajes se informan de la siguiente forma: 1.5% se debe de enviar 1.5
* Todos los campos son obligatorios (NotNull)
* Importante: Se debe guardar la id de respuesta para futuras peticiones y/o auditorias de control.

Ejemplo: petición distribuidor > Gosbi:

Respuesta:

D.1.2. BORRAR una venta en la plataforma Gosbi

Ver especificación técnica...

Información del recurso:

Url: /3rdp/distributors/documents/<id>
Method: DELETE
Document: None

* La id de la url representa la id de la plataforma Gosbi, recibida al crear la venta

Ejemplo: petición distribuidor > Gosbi:

Respuesta:

D.2: INFORMAR STOCKS

Recurso disponible para informa del stock actual del distribuidor de cada producto Gosbi.

Objetivo:

Auditar que la información enviada por los distribuidores sobre ventas sea correcta
Mantener un nivel de eficiencia máximo en toda la cadena de suministro

Ver especificación técnica...

Información del recurso:

Url: /3rdp/distributors/stocks
Method: POST
Document: JSON
Recurrencia: Una vez al día.

Estructura del documento:

Campo	Tipo	Descripción
product_src_id	str	ID producto del distribuidor
quantity	int	Cantidad disponible en stock

* Si un producto no se recibe en el documento enviado, se marca cómo stock = 0

DOCS > RECURSOS PARA DISTRIBUIDORES > RECURSOS DISPONIBLES SEGÚN NECESIDAD

D.3: INFORMACIÓN DE PRODUCTOS

Obtener la información actualizada de productos Gosbi y la disponibilidad de stock para la compra.

Ver especificación técnica...

Información del recurso:

Url: /3rdp/distributors/products
Method: GET
Document: None

Estructura del documento a recibir:

Ruta	Campo	Tipo	Descripción
/	id	int	Id Gosbi única de producto
/	src_id	str	ID distribuidor único de producto
/	name	str	Nombre de producto
/	image_front	str	Url de imágen principal
/	in_stock	bool	Disponibiliad de stock del distribuidor
/	formats	array	Lista de formatos de compra del producto
formats/	ean	str	Código EAN del formato
formats/	quantity	int	Unidades de venta de dicho formato
formats/	buyable	bool	Disponibilidad de compra (al distribuidor) del formato

Ejemplo petición:

Respuesta:

D.4: RECIBIR PEDIDOS GOSBI B2B

Servicio de envio de pedidos recibidos a la plataforma Gosbi B2B al servidor del distribuidor.

Ver especificación técnica...

Información del recurso:

Url: Pactada con el departamento IT de Gosbi
Method: POST
Document: JSON
Recurrencia: Cada vez que se reciba un pedido en la Gosbi B2B.

Estructura del documento a recibir:

Ruta	Campo	Tipo	Descripción
/	id	str	Id Gosbi única de webhook
/	type	str	Tipo de webhook
/	data	str	Información del webhook
/data	id	int	Id Gosbi única de pedido
/data	document_date	str	Fecha de documento
/data	customer_src_id	str	Id única de cliente del distribuidor
/data	currency_code	str	Código de moneda del documento (código ISO 4217)
/data	lines	array	Array de líneas de producto
lines/	product_src_id	str	Id única de producto del distribuidor
lines/	product_name	str	Nombre de producto
lines/	quantity	int	Unidades de producto
lines/	price	float	Precio de venta unitario
lines/	discount_1	float	Descuento 1 en línia de producto
lines/	discount_2	float	Descuento 2 en línia de producto
/data	discount_1	float	Descuento 1 en pie de documento
/data	discount_2	float	Descuento 2 en pie de documento
/data	payed	bool	Indica si el documento está o no pagado
/data	text	str	Texto introducido por el cliente

Ejemplo petición:

Respuesta:

D.4.1: VER PEDIDOS PENDIENTES GOSBI B2B/STORE

Servicio para recibir los pedidos pendientes tramitados por la plataforma Gosbi B2B.

Ver especificación técnica...

Información del recurso:

Url: /3rdp/distributors/documents
Method: GET
Parametros: date_start, date_end

Ejemplo: /3rdp/distributors/documents?date_start=2023-01-20&date_end=2023-01-21

Document: None
Recurrencia: Cada vez que el distribuidor quiera.

Estructura del documento a recibir:

Ruta	Campo	Tipo	Descripción
/	id	str	Id Gosbi única de webhook
/	type	str	Tipo de documento
/	version	str	Version
/	data	str	Información pedido
/data	id	int	Id Gosbi única de pedido
/data	document_date	str	Fecha de documento
/data	customer_src_id	str	Id única de cliente del distribuidor
/data	lines	array	Array de líneas de producto
lines/	product_src_id	str	Id única de producto del distribuidor
lines/	product_name	str	Nombre de producto
lines/	quantity	int	Unidades de producto
lines/	price	float	Precio de venta unitario
lines/	discount_1	float	Descuento 1 en línia de producto
lines/	discount_2	float	Descuento 2 en línia de producto
/data	discount_1	float	Descuento 1 en pie de documento
/data	discount_2	float	Descuento 2 en pie de documento
/data	payed	bool	Indica si el documento está o no pagado
/data	text	str	Texto introducido por el cliente

Ejemplo petición:

Respuesta:

D.4.2: SINCRONIZAR PEDIDOS GOSBI

Servicio de sincronización de pedidos de Gosbi con el distribuidor.

Ver especificación técnica...

Información del recurso:

Url:/3rdp/distributors/documents/sync
Method: POST
Document: JSON
Recurrencia: Cada vez que el distribuidor quiera, almenos una vez al dia.

Estructura del documento a recibir:

Ruta	Campo	Tipo	Descripción
/	/	array	Array de documentos para sincronizar
/	document_id	int	Id del documento de Gosbi
/	src_id	str	ID del pedido del distribuidor

Ejemplo petición:

Respuesta:

D.5: RECIBIR PEDIDOS GOSBI STORE

Servicio de envio de pedidos recibidos a la plataforma Gosbi STORE al servidor del distribuidor.

Ver especificación técnica...

Información del recurso:

Url: Pactada con el departamento IT de Gosbi
Method: POST
Document: JSON
Recurrencia: Cada vez que se reciba un pedido en la Gosbi STORE.

Estructura del documento a recibir:

Ruta	Campo	Tipo	Descripción
/	id	str	Id Gosbi única de webhook
/	type	str	Tipo de webhook
/	data	str	Información del webhook
/data	id	int	Id Gosbi única de pedido
/data	document_date	str	Fecha de documento
/data	customer	objeto cliente	Información sobre el cliente que compra
customer/	contact_name	str	Nombre a entregar la venta
customer/	contact_method	str	Teléfono para contactar por la venta
customer/	contact_mail	str	Mail para contactar por la venta
customer/	address	str	Dirección de entrega -> calle y número
customer/	address_admin2_src_id	str	Dirección de entrega -> ID único de província
customes/	address_postal_code	str	Dirección de entrega -> Código postal
customes/	address_admin3	str	Dirección de entrega -> Pueblo o Ciudad
/data	currency_code	str	Código de moneda del documento (código ISO 4217)
/data	lines	array	Array de líneas de producto
lines/	product_src_id	str	Id única de producto del distribuidor
lines/	product_name	str	Nombre de producto
lines/	quantity	int	Unidades de producto
lines/	price	float	Precio de venta unitario
lines/	discount_1	float	Descuento 1 en línia de producto
lines/	discount_2	float	Descuento 2 en línia de producto
/data	discount_1	float	Descuento 1 en pie de documento
/data	discount_2	float	Descuento 2 en pie de documento
/data	payed	bool	Indica si el documento está o no pagado
/data	payment	object	Objeto con información del pago
payment/	platform_src_id	str	Id único de la forma de pago del distribuidor
payment/	payed_amount	str	Importe pagado por el cliente
/data	carrier_src_id	str	Id único de transportista del distribuidor

Ejemplo petición:

Respuesta:

D.6: LISTAR ALBARANES EN LA B2B

Servicio para listar los albaranes del cliente dentro del servidor del distribuidor.

Ver especificación técnica...

Información del recurso:

Url: Pactada con el departamento IT de Gosbi (URL/entity_src_id)
Method: GET
Document: JSON
Recurrencia: Cada vez que el cliente lo solicite

Estructura de los argumentos:

Argumento	Valor	Descripción	Formato
date_from	timestamp	Fecha de inicio para mostrar el albarán	YYYY-MM-DDTHH:MI:SS.MS
date_to	timestamp	Fecha final para mostrar el albarán	YYYY-MM-DDTHH:MI:SS.MS

Ejemplo petición:

Respuesta:

D.7: MOSTRAR UN ALBARAN EN LA B2B

Servicio para mostrar un albaran del cliente dentro del servidor del distribuidor.

Ver especificación técnica...

Información del recurso:

Url: Pactada con el departamento IT de Gosbi (URL/entity_src_id)
Method: GET
Document: PDF
Recurrencia: Cada vez que el cliente lo solicite

Estructura de los argumentos:

Argumento	Valor	Descripción	Formato
show_ean	any	Si el albarán debe mostrar el codigo EAN de producto
show_price	any	Si el albarán debe mostrar precios

Ejemplo petición:

Respuesta:

D.8: LISTAR FACTURAS EN LA B2B

Servicio para listar las facturas del cliente dentro del servidor del distribuidor.

Ver especificación técnica...

Información del recurso:

Url: Pactada con el departamento IT de Gosbi (URL/entity_src_id)
Method: GET
Document: JSON
Recurrencia: Cada vez que el cliente lo solicite

Estructura de los argumentos:

Argumento	Valor	Descripción	Formato
date_from	timestamp	Fecha de inicio para mostrar la factura	YYYY-MM-DDTHH:MI:SS.MS
date_to	timestamp	Fecha final para mostrar la factura	YYYY-MM-DDTHH:MI:SS.MS

Ejemplo petición:

Respuesta:

D.9: MOSTRAR UNA FACTURA EN LA B2B

Servicio para mostrar una factura del cliente dentro del servidor del distribuidor.

Ver especificación técnica...

Información del recurso:

Url: Pactada con el departamento IT de Gosbi (URL/entity_src_id)
Method: GET
Document: PDF
Recurrencia: Cada vez que el cliente lo solicite

Ejemplo petición:

Respuesta:

GOSBI CONNECT

INTRODUCCIÓN

D.0. SINCRONIZAR CLIENTES

D.1. INFORMAR VENTAS

D.2: INFORMAR STOCKS

D.3: INFORMACIÓN DE PRODUCTOS

D.4: RECIBIR PEDIDOS GOSBI B2B

D.4.1: VER PEDIDOS PENDIENTES GOSBI B2B/STORE

D.4.2: SINCRONIZAR PEDIDOS GOSBI

D.5: RECIBIR PEDIDOS GOSBI STORE

D.6: LISTAR ALBARANES EN LA B2B

D.7: MOSTRAR UN ALBARAN EN LA B2B

D.8: LISTAR FACTURAS EN LA B2B

D.9: MOSTRAR UNA FACTURA EN LA B2B