DOCS > RESOURCES FOR DISTRIBUTORS > BASIC RESOURCES

D.0. SYNCHRONISE CUSTOMERS

A single resource to create and modify all the distributor's customer information on the Gosbi platform.

Objective:

Synchronise the customers to whom we sell product (customers) to subsequently report sales (resource D.1. Report sales).
Synchronise the fiscal names to enter the "Gosbi Next" programme.
Synchronise agents to give the sales team access to the Gosbi CRM tool.

Information to be sent in the synchronisation document:
Delivery addresses: (customers) Delivery address of a customer of the distributor.
Companies: (business) Fiscal data of company/self-employed. Each delivery address belongs to a company.
Commercial agents: (agents) Grouping of customer delivery addresses. Each delivery address is assigned a commercial agent code.

See technical specification...

Resource information:

Url: /3rdp/distributors/customers
Method: POST
Document: JSON
Recurrence: Run once a day or under user request.

Document structure:

Route	Field	Type	Description
/	agents	array	Array of agent objects
agents/	src_id	str	Unique Agent ID
agents/	name	str	Agent name
/	business/	array	Array of business objects
business/	vat_number	str	Unique tax identification
business/	name	str	Company tax name
business/	address	str	Tax address -> Street and number
business/	address_admin2_src_id	str	Tax address -> Distributor's province ID
business/	address_postal_code	str	Tax address -> Postal code
business/	address_admin3	str	Tax address -> Town or City
business/	address_lat	float	Tax address -> Latitude
business/	address_lng	float	Tax address -> Longitude
/	customers	str	Array of customer objects
customers/	src_id	str	Distribuor's customer ID
customers/	name	str	Commercial name (or failing this, company tax name)
customers/	vat_number	str	Tax identifier (Business object reference)
customers/	address	str	Delivery address -> Street and number
customers/	address_admin2_src_id	str	Delivery address -> Distributor's province ID
customers/	address_postal_code	str	Delivery address -> Pstal code
customers/	address_admin3	str	Delivery address -> Town or City
customers/	address_lat	float	Delivery address -> Latitude
customers/	address_lng	float	Delivery address -> Longitude
customers/	agent_src_id	str	Assigned agent (object reference agents)
customers/	discount_1	str	Discount 1 in footnote
customers/	discount_2	str	Discount 2 in footnote
customers/	tribute_src_id	str	Distributor's customer tax ID
customers/	leaving_date	str	Date of customer's deregistration

* All fields are mandatory (Not Null) except leaving_date, address_lat i address_lng
* Percentages are reported as follows: 1.5% to be sent 1.5
* The total amount of information is always sent

Example: request distributor > Gosbi:

Response:

D.1. REPORT SALES

Two resources are available (create and delete) to keep up to date product sales to customers information in the Gosbi platform.

Objective

Enable Gosbi to monitor that all product sales are made within the contractually stipulated framework.

D.1.1. CREATE a sale on the Gosbi platform

See technical specification...

Resource information:

Url: /3rdp/distributors/documents
Method: POST
Document: JSON
Recurrence: At the time of sale or at the end of the day.

Document structure:

Route	Field	Type	Description
/	src_id	str	Distributor's document ID
/	document_date	timestamp(str)	Document date
/	customer_src_id	str	Distributor's customer ID
/	discount_1	float	Discount 1 in footnote
/	discount_2	float	Discount 2 in footnote
/	currency_code	str	Document currency code (Code ISO 4217)
/	lines	array	Array of line objects
lines/	product_src_id	str	Distributor's prodcut ID
lines/	quantity	int	Units of product sold
lines/	price	float	Uni price of the product
lines/	discount_1	float	Line discount 1
lines/	discount_2	float	Line discount 2

* Percentages are reported as follows: 1.5% to be sent 1.5
* All fields are mandatory (NotNull)
* Important: The response id should be kept for future control requests and/or audits.

Example: request distributor > Gosbi:

Response:

D.1.2. DELETE a sale on the Gosbi platform

See technical specification...

Resource information:

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

* The id of the url represents the id of the Gosbi platform, received when creating the sale.

Example: request distributor > Gosbi:

Response:

D.2: REPORT STOCKS

Reports the distributor's current stock of each Gosbi product.

Objective:

To audit that the information sent by distributors on sales is correct.
Maintain a maximum level of efficiency throughout the supply chain.

See technical specification...

Información del recurso:

Url: /3rdp/distributors/stocks
Method: POST
Document: JSON
Recurrencia: Once a day.

Document structure:

Field	Type	Description
product_src_id	str	Distributor's product ID
quantity	int	Units in stock

If a product is not received in the sent document, it is set as stock = 0.

DOCS > RESOURCES FOR DISTRIBUTORS > AVAILABLE RESOURCES DEPENDING ON NEED

D.3: PRODUCT INFORMATION

Get up to date information on Gosbi products and stock availability for purchase.

See technical specification...

Resource information:

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

Structure of the document to be recived:

Route	Field	Type	Description
/	id	int	Gosbi's product ID
/	src_id	str	Distributor's product ID
/	name	str	Product name
/	image_front	str	Main image URL
/	in_stock	bool	Distributor stock availability
/	formats	array	List of product purchase formats
formats/	ean	str	Format EAN code
formats/	quantity	int	Format sales units
formats/	buyable	bool	Format purchase availability

Request example:

Response:

D.4: RECEIVING GOSBI B2B ORDERS

Service for sending orders received on the Gosbi B2B platform to the distributor's server.

See technical specification...

Resource information:

Url: Agreement with the IT department of Gosbi
Method: POST
Document: JSON
Recurrence: Each time an order is received at Gosbi B2B.

Structure of the document to be recived:

Ruta	Campo	Tipo	Description
/	id	str	Webhook gosbi unique id
/	type	str	Webhook type
/	data	str	Webhook information
/data	id	int	Gosbi Unique Order ID
/data	document_date	str	Order date
/data	customer_src_id	str	Id única de cliente del distribuidor
/data	currency_code	str	currency code (código ISO 4217)
/data	lines	array	Array of product lines
lines/	product_src_id	str	Distributor Unique Product ID
lines/	product_name	str	Name of product
lines/	quantity	int	Product units
lines/	price	float	unit sale price
lines/	discount_1	float	Discount 1 on product line
lines/	discount_2	float	Discount 2 on product line
/data	discount_1	float	Discount 1 on foot of the document
/data	discount_2	float	Discount 2 on foot of the document
/data	payed	bool	Indicates whether or not the document is paid
/data	text	str	Text entered by the client

Request example:

Response:

D.4.1: VER PEDIDOS PENDIENTES GOSBI B2B/STORE

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

See technical specification...

Resource information:

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

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

Document: None
Recurrencia: Every time the distributor wants.

Structure of the document to be recived:

Ruta	Campo	Tipo	Description
/	id	str	webhook unique Gosbi id
/	type	str	Document type
/	version	str	Version
/	data	str	Order information
/data	id	int	Id Gosbi única de pedido
/data	document_date	str	Order date
/data	customer_src_id	str	Unique reseller customer id
/data	lines	array	Array of product lines
lines/	product_src_id	str	Distributor Unique Product ID
lines/	product_name	str	Name of product
lines/	quantity	int	Product units
lines/	price	float	unit sale price
lines/	discount_1	float	Discount 1 on product line
lines/	discount_2	float	Discount 2 on product line
/data	discount_1	float	Discount 1 on foot of the document
/data	discount_2	float	Discount 2 on foot of the document
/data	payed	bool	Indicates whether or not the document is paid
/data	text	str	Text entered by the client

Request example:

Response:

D.4.2: SINCRONIZAR PEDIDOS GOSBI

Gosbi order synchronization service with the distributor.

See technical specification...

Resource information:

Url:/3rdp/distributors/documents/sync
Method: POST
Document: JSON
Recurrencia: Whenever the dealer wants, at least once a day.

Structure of the document to be recived:

Ruta	Campo	Tipo	Descripción
/	/	array	Array of documents to sync
/	document_id	int	Gosbi document id
/	src_id	str	Distributor order id

Request example:

Response:

D.5: RECEIVING GOSBI STORE ORDERS

Service for sending orders received on the Gosbi STORE platform to the distributor's server.

See technical specification...

Resource information:

Url: Agreed with Gosbi's IT Department
Method: POST
Document: JSON
Recurrence: Every time an order is received in the Gosbi STORE.

Structure of the document to be recived:

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	Gosbi Unique Order ID
/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 of product lines
lines/	product_src_id	str	Distributor Unique Product ID
lines/	product_name	str	Name of product
lines/	quantity	int	Product units
lines/	price	float	unit sale price
lines/	discount_1	float	Discount 1 on product line
lines/	discount_2	float	Discount 2 on product line
/data	discount_1	float	Discount 1 on foot of the document
/data	discount_2	float	Discount 2 on foot of the document
/data	payed	bool	Indicates whether or not the document is paid
/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

Request example:

Response:

D.6: LISTING DELIVERY NOTES IN THE B2B

Service to list the customer's delivery notes within the distributor's server.

See technical specification...

Resource information:

Url: Agreed with Gosbi's IT department (URL/entity_src_id)
Method: GET
Document: JSON
Recurrencia: Every time the customer requests it

Structure of arguments:

Argument	Value	Description	Format
date_from	timestamp	Start date to display delivery note	YYYY-MM-DDTHH:MI:SS.MS
date_to	timestamp	Final date to display delivery note	YYYY-MM-DDTHH:MI:SS.MS

Request example:

Response:

D.7: DISPLAYING A DELIVERY NOTE IN THE B2B

Service to display a customer delivery note within the distributor's server.

See technical specification...

Resource information:

Url: Agreed with Gosbi's IT department (URL/entity_src_id)
Method: GET
Document: PDF
Recurrencia:Every time the customer requests it

Structure of arguments:

Argument	Value	Description	Format
show_ean	any	If the delivery note must show the product EAN code
show_price	any	If the delivery note should show prices

Request example:

Response:

D.8: LISTING INVOICES IN THE B2B

Service to list the customer’s invoices within the distributor's server

See technical specification...

Resource information:

Url:Agreed with Gosbi's IT department (URL/entity_src_id)
Method: GET
Document: JSON
Recurrencia:Every time the customer requests it

Structure of arguments:

Argument	Value	Description	Format
date_from	timestamp	Start date to display invoice	YYYY-MM-DDTHH:MI:SS.MS
date_to	timestamp	End date to display invoice	YYYY-MM-DDTHH:MI:SS.MS

Request example:

Response:

D.9: DISPLAYING AN INVOICE IN THE B2B

Service to display a customer's invoice within the distributor's server.

See technical specification...

Resource information:

Url: Agreed with Gosbi's IT department (URL/entity_src_id)
Method: GET
Document: PDF
Recurrencia:Every time the customer requests it

Request example:

Response:

GOSBI CONNECT

INTRODUCTION

D.0. SYNCHRONISE CUSTOMERS

D.1. REPORT SALES

D.2: REPORT STOCKS

D.3: PRODUCT INFORMATION

D.4: RECEIVING GOSBI B2B ORDERS

D.4.1: VER PEDIDOS PENDIENTES GOSBI B2B/STORE

D.4.2: SINCRONIZAR PEDIDOS GOSBI

D.5: RECEIVING GOSBI STORE ORDERS

D.6: LISTING DELIVERY NOTES IN THE B2B

D.7: DISPLAYING A DELIVERY NOTE IN THE B2B

D.8: LISTING INVOICES IN THE B2B

D.9: DISPLAYING AN INVOICE IN THE B2B