API Docs v1 api.hubiss.com.br

Lojas

A loja é a raiz da sua operação — é nela que ficam as categorias e os produtos.

Em resumo
Cada loja é uma filial independente: nome próprio, árvore de categorias própria e produtos próprios.

Uma loja funciona como uma filial: você pode ter uma loja só de informática, outra de calçados, cada uma com nome próprio. Cada loja tem sua própria árvore de categorias, porque nem sempre os produtos são os mesmos.

É na loja que você cadastra a árvore de categorias e os produtos que deseja vender ou disponibilizar para revenda em dropshipping ou crossdocking.

Campos principais da loja

Campo Descrição
name Nome da loja exibido na plataforma
status active ou inactive
country Código do país (ex.: BR)
languages Lista de idiomas (ex.: ["pt_BR"])
allow_store_pick_up Permite retirada na loja
dropshipping_crossdocking Configurações de revenda, aprovação e etiquetas
GET /stores
Listar Lojas

Listar todas as listas de produtos cadastradas

StatusQuando aconteceCorpo
401 401 —
Nome Local Tipo Descrição
name query string

Filtra as listas contendo o texto informado no nome

status query string
padrão: active

Filtra as listas de produtos por status. Opções: active, inactive

allow_others_integrate query integer
padrão: 0

Filtra por listas de produtos que permitem os outros usuários integrarem

Resposta
json
{
	"data": [
		{
			"id": "1",
			"name": "teste loja",
			"status": "active",
			"logo_url": "",
			"allow_store_pick_up": false,
			"site_url": "",
			"country": "BR",
			"languages": [
				"pt_BR"
			],
			"dropshipping_crossdocking": {
				"institutional": {
					"street_name": "",
					"zip_code": "",
					"street_number": "",
					"district": "",
					"city": "",
					"state": "",
					"document_number": "",
					"fantasy_name": "",
					"complement": "",
					"social_reason": "",
					"state_registration": "",
					"contact_phone": "",
					"contact_email": "",
					"description": ""
				},
				"allow_others_integrate": false,
				"allow_users_sell_as_dropshipping": false,
				"allow_users_sell_as_crossdocking": false,
				"approval_status": "awaiting_approval",
				"reason_for_refusal": "",
				"allow_receive_marketplace_labels": true,
        "information_proceed_seller_not_have_marketplace_label": "",
        "seller_purchase_procedure": "",
			},
			"created_at": "2021-04-05T22:30:53",
			"updated_at": "2021-04-21T00:17:32"
		}
	],
	"links": {
		"first": "https:\/\/hubiss.dev\/api\/v1\/product-lists?page=1",
		"last": "https:\/\/hubiss.dev\/api\/v1\/product-lists?page=1",
		"prev": null,
		"next": null
	},
	"meta": {
		"current_page": 1,
		"from": 1,
		"last_page": 1,
		"links": [
			{
				"url": null,
				"label": "« Previous",
				"active": false
			},
			{
				"url": "https:\/\/hubiss.dev\/api\/v1\/product-lists?page=1",
				"label": "1",
				"active": true
			},
			{
				"url": null,
				"label": "Next »",
				"active": false
			}
		],
		"path": "https:\/\/hubiss.dev\/api\/v1\/product-lists",
		"per_page": 20,
		"to": 1,
		"total": 1
	}
}
{
    "error": "Unauthorized"
}
Exemplo
curl --request GET \
     --url 'https://api.hubiss.com.br/v1/stores' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer SEU_TOKEN'
use Illuminate\Support\Facades\Http;

$response = Http::withToken('SEU_TOKEN')
    ->acceptJson()
    ->get('https://api.hubiss.com.br/v1/stores');

$response->json();
const response = await fetch('https://api.hubiss.com.br/v1/stores', {
    method: 'GET',
    headers: {
        'Accept': 'application/json',
        'Authorization': 'Bearer SEU_TOKEN'
    }
});

const data = await response.json();
import requests

response = requests.GET(
    'https://api.hubiss.com.br/v1/stores',
    headers={'Authorization': 'Bearer SEU_TOKEN', 'Accept': 'application/json'},
)

print(response.json())
O token é usado apenas nesta requisição e não é armazenado.
POST /stores
Cadastrar Loja
StatusQuando aconteceCorpo
401 401 —
422 422 —
CampoTipoDescrição
name * string

Nome da lista de produtos

status * string
allow_store_pick_up * boolean

Permite compradores buscar produtos na loja

site_url string

URL do site

country * string

Sigla do pais onde a lista de produtos se encontra

Busque o código aqui: https://api.hubiss.com.br/reference/paises

languages * array

Linguagens usadas para vendas dos produtos

Busque as possíveis opções aqui: https://api.hubiss.com.br/reference/linguagens#endpoint-listar-linguagens

dropshipping_crossdocking object
Corpo enviado (JSON) json
{
    "name": "teste loja",
    "status": "active",
    "allow_store_pick_up": false,
    "site_url": "",
    "country": "BR",
    "languages": [
        "pt_BR"
    ],
    "dropshipping_crossdocking": {
        "allow_others_integrate": false,
        "allow_users_sell_as_dropshipping": false,
        "allow_users_sell_as_crossdocking": false,
        "allow_receive_marketplace_labels": false,
        "information_proceed_seller_not_have_marketplace_label": "",
        "seller_purchase_procedure": "",
        "institutional": {
            "street_name": "",
            "zip_code": "",
            "street_number": "",
            "district": "",
            "city": "",
            "state": "",
            "document_number": "",
            "fantasy_name": "",
            "complement": "",
            "social_reason": "",
            "state_registration": "",
            "contact_phone": "",
            "contact_email": "",
            "description": ""
        }
    }
}
Resposta
json
{
    "data": {
        "id": "1",
        "name": "teste loja",
        "status": "active",
        "logo_url": "",
        "allow_store_pick_up": false,
        "site_url": "",
        "country": "BR",
        "languages": [
            "pt_BR"
        ],
        "dropshipping_crossdocking": {
            "allow_others_integrate": false,
            "allow_users_sell_as_dropshipping": false,
            "allow_users_sell_as_crossdocking": false,
            "approval_status": "",
            "reason_for_refusal": "",
            "allow_receive_marketplace_labels": false,
            "information_proceed_seller_not_have_marketplace_label": "",
            "seller_purchase_procedure": "",
            "institutional": {
                "street_name": "",
                "zip_code": "",
                "street_number": "",
                "district": "",
                "city": "",
                "state": "",
                "document_number": "",
                "fantasy_name": "",
                "complement": "",
                "social_reason": "",
                "state_registration": "",
                "contact_phone": "",
                "contact_email": "",
                "description": ""
            }
        },
        "created_at": "2022-04-14T22:15:44",
        "updated_at": "2022-04-14T22:15:44"
    },
    "success": true,
    "message": "Register Successfull Inserted"
}
{
    "error": "Unauthorized"
}
{
    "success": false,
    "message": "Validation errors",
    "data": {
        "name": [
            "The name field is required."
        ]
    }
}
Exemplo
curl --request POST \
     --url 'https://api.hubiss.com.br/v1/stores' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer SEU_TOKEN' \
     --header 'Content-Type: application/json' \
     --data '{    "name": "teste loja",    "status": "active",    "allow_store_pick_up": false,    "site_url": "",    "country": "BR",    "languages": [        "pt_BR"    ],    "dropshipping_crossdocking": {        "allow_others_integrate": false,        "allow_users_sell_as_dropshipping": false,        "allow_users_sell_as_crossdocking": false,        "allow_receive_marketplace_labels": false,        "information_proceed_seller_not_have_marketplace_label": "",        "seller_purchase_procedure": "",        "institutional": {            "street_name": "",            "zip_code": "",            "street_number": "",            "district": "",            "city": "",            "state": "",            "document_number": "",            "fantasy_name": "",            "complement": "",            "social_reason": "",            "state_registration": "",            "contact_phone": "",            "contact_email": "",            "description": ""        }    }}'
use Illuminate\Support\Facades\Http;

$response = Http::withToken('SEU_TOKEN')
    ->acceptJson()
    ->withBody("{\n    \"name\": \"teste loja\",\n    \"status\": \"active\",\n    \"allow_store_pick_up\": false,\n    \"site_url\": \"\",\n    \"country\": \"BR\",\n    \"languages\": [\n        \"pt_BR\"\n    ],\n    \"dropshipping_crossdocking\": {\n        \"allow_others_integrate\": false,\n        \"allow_users_sell_as_dropshipping\": false,\n        \"allow_users_sell_as_crossdocking\": false,\n        \"allow_receive_marketplace_labels\": false,\n        \"information_proceed_seller_not_have_marketplace_label\": \"\",\n        \"seller_purchase_procedure\": \"\",\n        \"institutional\": {\n            \"street_name\": \"\",\n            \"zip_code\": \"\",\n            \"street_number\": \"\",\n            \"district\": \"\",\n            \"city\": \"\",\n            \"state\": \"\",\n            \"document_number\": \"\",\n            \"fantasy_name\": \"\",\n            \"complement\": \"\",\n            \"social_reason\": \"\",\n            \"state_registration\": \"\",\n            \"contact_phone\": \"\",\n            \"contact_email\": \"\",\n            \"description\": \"\"\n        }\n    }\n}", 'application/json')
    ->post('https://api.hubiss.com.br/v1/stores');

$response->json();
const response = await fetch('https://api.hubiss.com.br/v1/stores', {
    method: 'POST',
    headers: {
        'Accept': 'application/json',
        'Authorization': 'Bearer SEU_TOKEN',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "teste loja",
    "status": "active",
    "allow_store_pick_up": false,
    "site_url": "",
    "country": "BR",
    "languages": [
        "pt_BR"
    ],
    "dropshipping_crossdocking": {
        "allow_others_integrate": false,
        "allow_users_sell_as_dropshipping": false,
        "allow_users_sell_as_crossdocking": false,
        "allow_receive_marketplace_labels": false,
        "information_proceed_seller_not_have_marketplace_label": "",
        "seller_purchase_procedure": "",
        "institutional": {
            "street_name": "",
            "zip_code": "",
            "street_number": "",
            "district": "",
            "city": "",
            "state": "",
            "document_number": "",
            "fantasy_name": "",
            "complement": "",
            "social_reason": "",
            "state_registration": "",
            "contact_phone": "",
            "contact_email": "",
            "description": ""
        }
    }
})
});

const data = await response.json();
import requests

response = requests.POST(
    'https://api.hubiss.com.br/v1/stores',
    headers={'Authorization': 'Bearer SEU_TOKEN', 'Accept': 'application/json'},
    json={
    "name": "teste loja",
    "status": "active",
    "allow_store_pick_up": false,
    "site_url": "",
    "country": "BR",
    "languages": [
        "pt_BR"
    ],
    "dropshipping_crossdocking": {
        "allow_others_integrate": false,
        "allow_users_sell_as_dropshipping": false,
        "allow_users_sell_as_crossdocking": false,
        "allow_receive_marketplace_labels": false,
        "information_proceed_seller_not_have_marketplace_label": "",
        "seller_purchase_procedure": "",
        "institutional": {
            "street_name": "",
            "zip_code": "",
            "street_number": "",
            "district": "",
            "city": "",
            "state": "",
            "document_number": "",
            "fantasy_name": "",
            "complement": "",
            "social_reason": "",
            "state_registration": "",
            "contact_phone": "",
            "contact_email": "",
            "description": ""
        }
    }
},
)

print(response.json())
O token é usado apenas nesta requisição e não é armazenado.
GET /stores/{storeId}
Recuperar Loja

Retorna a loja com essa ID

StatusQuando aconteceCorpo
401 401 —
404 404 —
Nome Local Tipo Descrição
storeId * path integer
padrão: 1

Um código novo é sempre gerado quando você cadastra uma loja.

Portanto o mesmo não pode ser alterado.

Resposta
json
{
    "data": {
        "id": "1",
        "name": "teste loja",
        "status": "active",
        "logo_url": "",
        "allow_store_pick_up": false,
        "site_url": "",
        "country": "BR",
        "languages": [
            "pt_BR"
        ],
        "dropshipping_crossdocking": {
            "allow_others_integrate": false,
            "allow_users_sell_as_dropshipping": false,
            "allow_users_sell_as_crossdocking": false,
            "approval_status": "",
            "reason_for_refusal": "",
            "allow_receive_marketplace_labels": true,
            "information_proceed_seller_not_have_marketplace_label": "",
            "seller_purchase_procedure": "",
            "institutional": {
                "street_name": "",
                "zip_code": "",
                "street_number": "",
                "district": "",
                "city": "",
                "state": "",
                "document_number": "",
                "fantasy_name": "",
                "complement": "",
                "social_reason": "",
                "state_registration": "",
                "contact_phone": "",
                "contact_email": "",
                "description": ""
            }
        },
        "created_at": "2021-04-05T22:30:53",
        "updated_at": "2021-04-21T00:17:32"
    }
}
{
    "error": "Unauthorized"
}
{
    "error": "Resource 9999 not found"
}
Exemplo
curl --request GET \
     --url 'https://api.hubiss.com.br/v1/stores/STOREID' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer SEU_TOKEN'
use Illuminate\Support\Facades\Http;

$response = Http::withToken('SEU_TOKEN')
    ->acceptJson()
    ->get('https://api.hubiss.com.br/v1/stores/STOREID');

$response->json();
const response = await fetch('https://api.hubiss.com.br/v1/stores/STOREID', {
    method: 'GET',
    headers: {
        'Accept': 'application/json',
        'Authorization': 'Bearer SEU_TOKEN'
    }
});

const data = await response.json();
import requests

response = requests.GET(
    'https://api.hubiss.com.br/v1/stores/STOREID',
    headers={'Authorization': 'Bearer SEU_TOKEN', 'Accept': 'application/json'},
)

print(response.json())
O token é usado apenas nesta requisição e não é armazenado.
PUT /stores/{storeId}
Atualizar Loja
StatusQuando aconteceCorpo
401 401 —
404 404 —
422 422 —
Nome Local Tipo Descrição
storeId * path integer
padrão: 1
CampoTipoDescrição
name * string

Nome da lista de produtos

status * string
allow_store_pick_up * boolean

Permite compradores buscar produtos na loja

site_url string

URL do site

country * string

Sigla do pais onde a lista de produtos se encontra

Busque o código aqui: https://api.hubiss.com.br/reference/paises

languages * array

Linguagens usadas para vendas dos produtos

dropshipping_crossdocking object
Corpo enviado (JSON) json
{
    "name": "teste lista própria novo",
    "status": "active",
    "allow_store_pick_up": false,
    "site_url": "",
    "country": "BR",
    "languages": [
        "pt_BR"
    ],
    "dropshipping_crossdocking": {
        "allow_others_integrate": false,
        "allow_users_sell_as_dropshipping": false,
        "allow_users_sell_as_crossdocking": false,
        "allow_receive_marketplace_labels": false,
        "information_proceed_seller_not_have_marketplace_label": "",
        "seller_purchase_procedure": "",
        "institutional": {
            "street_name": "",
            "zip_code": "",
            "street_number": "",
            "district": "",
            "city": "",
            "state": "",
            "document_number": "",
            "fantasy_name": "",
            "complement": "",
            "social_reason": "",
            "state_registration": "",
            "contact_phone": "",
            "contact_email": "",
            "description": ""
        }
    }
}
Resposta
json
{
    "data": {
        "id": "1",
        "name": "teste lista própria novo",
        "status": "active",
        "logo_url": "",
        "allow_store_pick_up": false,
        "site_url": "",
        "country": "BR",
        "languages": [
            "pt_BR"
        ],
        "dropshipping_crossdocking": {
            "allow_others_integrate": false,
            "allow_users_sell_as_dropshipping": false,
            "allow_users_sell_as_crossdocking": false,
            "approval_status": "",
            "reason_for_refusal": "",
            "allow_receive_marketplace_labels": false,
            "information_proceed_seller_not_have_marketplace_label": "",
            "seller_purchase_procedure": "",
            "institutional": {
                "street_name": "",
                "zip_code": "",
                "street_number": "",
                "district": "",
                "city": "",
                "state": "",
                "document_number": "",
                "fantasy_name": "",
                "complement": "",
                "social_reason": "",
                "state_registration": "",
                "contact_phone": "",
                "contact_email": "",
                "description": ""
            }
        },
        "created_at": "2022-04-14T22:15:44",
        "updated_at": "2022-04-14T22:15:44"
    },
    "success": true,
    "message": "Register Successfull Updated"
}
{
    "error": "Unauthorized"
}
{
    "error": "Resource 9999 not found"
}
{
    "success": false,
    "message": "Validation errors",
    "data": {
        "name": [
            "The name field is required."
        ]
    }
}
Exemplo
curl --request PUT \
     --url 'https://api.hubiss.com.br/v1/stores/STOREID' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer SEU_TOKEN' \
     --header 'Content-Type: application/json' \
     --data '{    "name": "teste lista própria novo",    "status": "active",    "allow_store_pick_up": false,    "site_url": "",    "country": "BR",    "languages": [        "pt_BR"    ],    "dropshipping_crossdocking": {        "allow_others_integrate": false,        "allow_users_sell_as_dropshipping": false,        "allow_users_sell_as_crossdocking": false,        "allow_receive_marketplace_labels": false,        "information_proceed_seller_not_have_marketplace_label": "",        "seller_purchase_procedure": "",        "institutional": {            "street_name": "",            "zip_code": "",            "street_number": "",            "district": "",            "city": "",            "state": "",            "document_number": "",            "fantasy_name": "",            "complement": "",            "social_reason": "",            "state_registration": "",            "contact_phone": "",            "contact_email": "",            "description": ""        }    }}'
use Illuminate\Support\Facades\Http;

$response = Http::withToken('SEU_TOKEN')
    ->acceptJson()
    ->withBody("{\n    \"name\": \"teste lista pr\u00f3pria novo\",\n    \"status\": \"active\",\n    \"allow_store_pick_up\": false,\n    \"site_url\": \"\",\n    \"country\": \"BR\",\n    \"languages\": [\n        \"pt_BR\"\n    ],\n    \"dropshipping_crossdocking\": {\n        \"allow_others_integrate\": false,\n        \"allow_users_sell_as_dropshipping\": false,\n        \"allow_users_sell_as_crossdocking\": false,\n        \"allow_receive_marketplace_labels\": false,\n        \"information_proceed_seller_not_have_marketplace_label\": \"\",\n        \"seller_purchase_procedure\": \"\",\n        \"institutional\": {\n            \"street_name\": \"\",\n            \"zip_code\": \"\",\n            \"street_number\": \"\",\n            \"district\": \"\",\n            \"city\": \"\",\n            \"state\": \"\",\n            \"document_number\": \"\",\n            \"fantasy_name\": \"\",\n            \"complement\": \"\",\n            \"social_reason\": \"\",\n            \"state_registration\": \"\",\n            \"contact_phone\": \"\",\n            \"contact_email\": \"\",\n            \"description\": \"\"\n        }\n    }\n}", 'application/json')
    ->put('https://api.hubiss.com.br/v1/stores/STOREID');

$response->json();
const response = await fetch('https://api.hubiss.com.br/v1/stores/STOREID', {
    method: 'PUT',
    headers: {
        'Accept': 'application/json',
        'Authorization': 'Bearer SEU_TOKEN',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "teste lista própria novo",
    "status": "active",
    "allow_store_pick_up": false,
    "site_url": "",
    "country": "BR",
    "languages": [
        "pt_BR"
    ],
    "dropshipping_crossdocking": {
        "allow_others_integrate": false,
        "allow_users_sell_as_dropshipping": false,
        "allow_users_sell_as_crossdocking": false,
        "allow_receive_marketplace_labels": false,
        "information_proceed_seller_not_have_marketplace_label": "",
        "seller_purchase_procedure": "",
        "institutional": {
            "street_name": "",
            "zip_code": "",
            "street_number": "",
            "district": "",
            "city": "",
            "state": "",
            "document_number": "",
            "fantasy_name": "",
            "complement": "",
            "social_reason": "",
            "state_registration": "",
            "contact_phone": "",
            "contact_email": "",
            "description": ""
        }
    }
})
});

const data = await response.json();
import requests

response = requests.PUT(
    'https://api.hubiss.com.br/v1/stores/STOREID',
    headers={'Authorization': 'Bearer SEU_TOKEN', 'Accept': 'application/json'},
    json={
    "name": "teste lista própria novo",
    "status": "active",
    "allow_store_pick_up": false,
    "site_url": "",
    "country": "BR",
    "languages": [
        "pt_BR"
    ],
    "dropshipping_crossdocking": {
        "allow_others_integrate": false,
        "allow_users_sell_as_dropshipping": false,
        "allow_users_sell_as_crossdocking": false,
        "allow_receive_marketplace_labels": false,
        "information_proceed_seller_not_have_marketplace_label": "",
        "seller_purchase_procedure": "",
        "institutional": {
            "street_name": "",
            "zip_code": "",
            "street_number": "",
            "district": "",
            "city": "",
            "state": "",
            "document_number": "",
            "fantasy_name": "",
            "complement": "",
            "social_reason": "",
            "state_registration": "",
            "contact_phone": "",
            "contact_email": "",
            "description": ""
        }
    }
},
)

print(response.json())
O token é usado apenas nesta requisição e não é armazenado.
DELETE /stores/{storeId}
Excluir Loja

Exclui a loja com essa id

StatusQuando aconteceCorpo
401 401 —
404 404 —
Nome Local Tipo Descrição
storeId * path integer
padrão: 1
Resposta
json
204
{
    "error": "Unauthorized"
}
{
    "error": "Resource 9999 not found"
}
Exemplo
curl --request DELETE \
     --url 'https://api.hubiss.com.br/v1/stores/STOREID' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer SEU_TOKEN'
use Illuminate\Support\Facades\Http;

$response = Http::withToken('SEU_TOKEN')
    ->acceptJson()
    ->delete('https://api.hubiss.com.br/v1/stores/STOREID');

$response->json();
const response = await fetch('https://api.hubiss.com.br/v1/stores/STOREID', {
    method: 'DELETE',
    headers: {
        'Accept': 'application/json',
        'Authorization': 'Bearer SEU_TOKEN'
    }
});

const data = await response.json();
import requests

response = requests.DELETE(
    'https://api.hubiss.com.br/v1/stores/STOREID',
    headers={'Authorization': 'Bearer SEU_TOKEN', 'Accept': 'application/json'},
)

print(response.json())
O token é usado apenas nesta requisição e não é armazenado.

Erros comuns

Sintoma Causa provável O que fazer
422 em country Código de país inválido Usar BR ou consultar Países
422 em languages Idioma não suportado Usar pt_BR ou consultar Linguagens
404 nas rotas filhas storeId de outra conta Usar o id retornado no cadastro
Próximo passo
Siga para Categorias.