Sincronização manual de produtos no marketplace

POST /marketplaces/{marketplaceStoreCredentialId}/products/sync

Descrição

Endpoint responsável por fazer a sincronização manual de produtos através de uma credencial de marketplace e uma action. As ações disponíveis são as mesmas de fila de produtos.

Da mesma que forma que nas filas, as ações update-stock e update-price só podem ser executadas em produtos já mapeados.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Content-Type`	application/json	Tipo de conteúdo
`Authorization`	Bearer {token}	Token de autenticação

Parâmetros de rota

Parâmetro	Tipo	Descrição
`marketplaceStoreCredentialId`	integer	ID do grupo de credencial de marketplace.

Parâmetros de corpo

Campo	Tipo	Obrigatório	Descrição
entitiyIds	array de integers	Sim	Array contendo os IDs dos produtos (máximo de 100 IDs).
action	string	Sim	Ação que será executada.

Exemplo de Requisição

1curl --request POST \
2  --url https://sua-loja-uappi.com.br/api/v3/marketplaces/2/products/sync \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
4  --header 'Content-Type: application/json' \
5  --data '{
6	"entityIds": [
7		1,
8		2,
9		3
10	],
11	"action": "export"
12}'
curl --request POST \
  --url https://sua-loja-uappi.com.br/api/v3/marketplaces/2/products/sync \
  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
  --header 'Content-Type: application/json' \
  --data '{
	"entityIds": [
		1,
		2,
		3
	],
	"action": "export"
}'

✅ Resposta de Sucesso

1{
2	"status": true,
3	"data": true
4}
{
	"status": true,
	"data": true
}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Código Interno	Código Http	Descrição
UAPPI_INTEGRATION_MARKETPLACE_CREDENTIAL_NOT_FOUND	404	A credencial de marketplace solicitada não foi encontrada.
UAPPI_STORE_PRODUCT_NOT_FOUND	404	Os produtos solicitados não foram encontrados.
UAPPI_INTEGRATION_MARKETPLACE_PRODUCT_NOT_MAPPED	400	Os produtos solicitados não estão mapeados na credencial desejada.

Listagem de todos os IDs dos produtos mapeados na credencial

GET /marketplaces/maps/products/all/{marketplaceStoreCredentialId}

Listagem de todos os IDs dos produtos mapeados na credencial

Descrição

Endpoint responsável por retornar apenas os IDs de todos os produtos que estão mapeados em uma credencial de marketplace.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Content-Type`	application/json	Tipo de conteúdo
`Authorization`	Bearer {token}	Token de autenticação

Parâmetros de rota

Parâmetro	Tipo	Descrição
`marketplaceStoreCredentialId`	integer	ID do grupo de credencial de marketplace.

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/marketplaces/maps/products/all/2 \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
4  --header 'Content-Type: application/json'
curl --request POST \
  --url {{MAIN_URL}}/marketplaces/maps/products/all/2 \
  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
  --header 'Content-Type: application/json'

✅ Resposta de Sucesso

1{
2	"status": true,
3	"data": [
4		1,
5		2,
6		3,
7		4,
8		5,
9		6,
10		7,
11		8,
12		9,
13		10
14	]
15}
{
	"status": true,
	"data": [
		1,
		2,
		3,
		4,
		5,
		6,
		7,
		8,
		9,
		10
	]
}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Código Interno	Código Http	Descrição
UAPPI_INTEGRATION_MARKETPLACE_CREDENTIAL_NOT_FOUND	404	A credencial de marketplace solicitada não foi encontrada.

Listagem dos produtos simples não mapeados na credencial de marketplace

GET /marketplaces/{marketplaceStoreCredentialId}/products/not-mapped

Listagem dos produtos simples não mapeados na credencial de marketplace

Descrição

Endpoint responsável por retornar uma listagem dos produtos simples que não estão mapeados na crendencial de marketplace desejada.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Content-Type`	application/json	Tipo de conteúdo
`Authorization`	Bearer {token}	Token de autenticação

Parâmetros de rota

Parâmetro	Tipo	Descrição
`marketplaceStoreCredentialId`	integer	ID do grupo de credencial de marketplace.

Campos de Solicitação

Campo	Descrição
`media`	Retorna as mídias do produto (imagens, documentos, etc).
`variation`	Retorna os dados de variação e atributos utilizados naquele produto.
`mainCategory`	Retorna o nome e ID da categoria principal do produto.
`brand`	Retorna o nome da marca do produto.
`price`	Retorna o preço de comparação do produto.
`mainUrl`	Retorna a URL principal do produto.

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/marketplaces/2/products/not-mapped \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
4  --header 'Content-Type: application/json' \
5  --data '{
6	"fields": [
7		"media",
8		"variation",
9		"mainCategory",
10		"brand",
11		"price",
12		"mainUrl",
13    "stock"
14	],
15	"order": [],
16	"condition": {
17		"type": "AND",
18		"conditions": []
19	}
20}'
curl --request GET \
  --url {{MAIN_URL}}/marketplaces/2/products/not-mapped \
  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
  --header 'Content-Type: application/json' \
  --data '{
	"fields": [
		"media",
		"variation",
		"mainCategory",
		"brand",
		"price",
		"mainUrl",
    "stock"
	],
	"order": [],
	"condition": {
		"type": "AND",
		"conditions": []
	}
}'

✅ Resposta de Sucesso

1{
2	"status": true,
3	"data": {
4		"registers": [
5			{
6				"productId": 90,
7				"brandId": 1,
8				"brandName": "Uappi",
9				"mainCategoryId": 0,
10				"mainCategoryName": "",
11				"type": "product",
12				"sku": "91",
13				"name": "Maltodextrina (1kg) - Growth Supplements",
14				"active": true,
15				"url": "maltodextrina-1kg---growth-supplements",
16				"comparisonPrice": 0,
17				"stock": 0,
18				"medias": [],
19				"combination": [],
20				"currentAttributes": []
21			},
22			{
23				"productId": 185,
24				"brandId": 1,
25				"brandName": "Uappi",
26				"mainCategoryId": 0,
27				"mainCategoryName": "",
28				"type": "product",
29				"sku": "33",
30				"name": "(TOP) Whey Protein Concentrado (1KG) - Growth Supplements",
31				"active": true,
32				"url": "top-whey-protein-concentrado-1kg---growth-supplements-1",
33				"comparisonPrice": 133,
34				"stock": 0,
35				"medias": [],
36				"combination": [],
37				"currentAttributes": []
38			},
39			{
40				"productId": 1015,
41				"brandId": 1,
42				"brandName": "Uappi",
43				"mainCategoryId": 0,
44				"mainCategoryName": "",
45				"type": "product",
46				"sku": "ART 7",
47				"name": "CAMISETA GROWTH CASUAL PRETA  - GROWTH SUPPLEMENTS",
48				"active": true,
49				"url": "camiseta-growth-casual-preta----growth-supplements",
50				"comparisonPrice": 0,
51				"stock": 0,
52				"medias": [],
53				"combination": [],
54				"currentAttributes": []
55			},
56			{
57				"productId": 1232,
58				"brandId": 1,
59				"brandName": "Uappi",
60				"mainCategoryId": 0,
61				"mainCategoryName": "",
62				"type": "product",
63				"sku": "MZF 212",
64				"name": "BERMUDA MOLETOM CINZA MESCLA GROWTH SUPPLEMENTS",
65				"active": true,
66				"url": "bermuda-moletom-cinza-mescla-growth-supplements",
67				"comparisonPrice": 60,
68				"stock": 0,
69				"medias": [],
70				"combination": [],
71				"currentAttributes": []
72			},
73			{
74				"productId": 1307,
75				"brandId": 1,
76				"brandName": "Uappi",
77				"mainCategoryId": 0,
78				"mainCategoryName": "",
79				"type": "product",
80				"sku": "50288",
81				"name": "BONÉ CINZA LOGO MANUSCRITO LARANJA - GROWTH SUPPLEMENTS",
82				"active": true,
83				"url": "bone-cinza-logo-manuscrito-laranja---growth-supplements",
84				"comparisonPrice": 0,
85				"stock": 0,
86				"medias": [],
87				"combination": [],
88				"currentAttributes": []
89			},
90			{
91				"productId": 2536,
92				"brandId": 1,
93				"brandName": "Uappi",
94				"mainCategoryId": 0,
95				"mainCategoryName": "",
96				"type": "product",
97				"sku": "ROSA 73",
98				"name": "JAQUETA CROPPED GROWTH MANUSCRITO PRETO - GROWTH SUPPLEMENTS",
99				"active": true,
100				"url": "jaqueta-cropped-growth-manuscrito-preto---growth-supplements",
101				"comparisonPrice": 150,
102				"stock": 0,
103				"medias": [],
104				"combination": [],
105				"currentAttributes": []
106			},
107			{
108				"productId": 2540,
109				"brandId": 1,
110				"brandName": "Uappi",
111				"mainCategoryId": 0,
112				"mainCategoryName": "",
113				"type": "product",
114				"sku": "MZF 293",
115				"name": "CROPPED GROWTH SHE AZUL CLARO - GROWTH SUPPLEMENTS",
116				"active": true,
117				"url": "cropped-growth-she-azul-claro---growth-supplements",
118				"comparisonPrice": 54,
119				"stock": 0,
120				"medias": [],
121				"combination": [],
122				"currentAttributes": []
123			},
124			{
125				"productId": 2708,
126				"brandId": 1,
127				"brandName": "Uappi",
128				"mainCategoryId": 0,
129				"mainCategoryName": "",
130				"type": "product",
131				"sku": "FAIXA DE CABELO GROWTH BEAUT - TESTE",
132				"name": "FAIXA DE CABELO GROWTH BEAUT - TESTE",
133				"active": true,
134				"url": "faixa-de-cabelo-growth-beaut---teste",
135				"comparisonPrice": 999.99,
136				"stock": 0,
137				"medias": [],
138				"combination": [],
139				"currentAttributes": []
140			},
141			{
142				"productId": 2751,
143				"brandId": 1,
144				"brandName": "Uappi",
145				"mainCategoryId": 0,
146				"mainCategoryName": "",
147				"type": "product",
148				"sku": "AGRUPADOR PROTEIN BAR GROWTH 30GR",
149				"name": "PROTEIN BAR GROWTH 30GR - DISPLAY C/ 12 UN.",
150				"active": true,
151				"url": "protein-bar-growth-30gr---display-c/-12-un.",
152				"comparisonPrice": 40,
153				"stock": 0,
154				"medias": [],
155				"combination": [],
156				"currentAttributes": []
157			},
158			{
159				"productId": 3664,
160				"brandId": 32,
161				"brandName": "Saraiva",
162				"mainCategoryId": 0,
163				"mainCategoryName": "",
164				"type": "product",
165				"sku": "THEWITCHERBATISMODEFOGO",
166				"name": "A saga do bruxo Geral de Rivia - Batismo de fogo",
167				"active": true,
168				"url": "",
169				"comparisonPrice": 0,
170				"stock": 1310,
171				"medias": [
172					{
173						"id": 90,
174						"type": "image",
175						"title": "173",
176						"alternativeText": null,
177						"file": "/upload/media/a47b621edacfe52c72d6fe24025afeee.webp",
178						"originalFile": "/upload/media/a47b621edacfe52c72d6fe24025afeee.jpeg",
179						"size": 9070,
180						"originalSize": 18348,
181						"width": 500,
182						"height": 500,
183						"url": null
184					},
185					{
186						"id": 97,
187						"type": "image",
188						"title": "301",
189						"alternativeText": null,
190						"file": "/upload/media/1a33ed21f3f7a83ccc62b85125b79ab4.webp",
191						"originalFile": "/upload/media/2274172ae5d97155ad16b95e44fb2c29.jpeg",
192						"size": 9070,
193						"originalSize": 18348,
194						"width": 500,
195						"height": 500,
196						"url": null
197					}
198				],
199				"combination": [],
200				"currentAttributes": []
201			}
202		],
203		"pagination": {
204			"limit": 10,
205			"offset": 0,
206			"pages": 2,
207			"registers": 13
208		}
209	}
210}
{
	"status": true,
	"data": {
		"registers": [
			{
				"productId": 90,
				"brandId": 1,
				"brandName": "Uappi",
				"mainCategoryId": 0,
				"mainCategoryName": "",
				"type": "product",
				"sku": "91",
				"name": "Maltodextrina (1kg) - Growth Supplements",
				"active": true,
				"url": "maltodextrina-1kg---growth-supplements",
				"comparisonPrice": 0,
				"stock": 0,
				"medias": [],
				"combination": [],
				"currentAttributes": []
			},
			{
				"productId": 185,
				"brandId": 1,
				"brandName": "Uappi",
				"mainCategoryId": 0,
				"mainCategoryName": "",
				"type": "product",
				"sku": "33",
				"name": "(TOP) Whey Protein Concentrado (1KG) - Growth Supplements",
				"active": true,
				"url": "top-whey-protein-concentrado-1kg---growth-supplements-1",
				"comparisonPrice": 133,
				"stock": 0,
				"medias": [],
				"combination": [],
				"currentAttributes": []
			},
			{
				"productId": 1015,
				"brandId": 1,
				"brandName": "Uappi",
				"mainCategoryId": 0,
				"mainCategoryName": "",
				"type": "product",
				"sku": "ART 7",
				"name": "CAMISETA GROWTH CASUAL PRETA  - GROWTH SUPPLEMENTS",
				"active": true,
				"url": "camiseta-growth-casual-preta----growth-supplements",
				"comparisonPrice": 0,
				"stock": 0,
				"medias": [],
				"combination": [],
				"currentAttributes": []
			},
			{
				"productId": 1232,
				"brandId": 1,
				"brandName": "Uappi",
				"mainCategoryId": 0,
				"mainCategoryName": "",
				"type": "product",
				"sku": "MZF 212",
				"name": "BERMUDA MOLETOM CINZA MESCLA GROWTH SUPPLEMENTS",
				"active": true,
				"url": "bermuda-moletom-cinza-mescla-growth-supplements",
				"comparisonPrice": 60,
				"stock": 0,
				"medias": [],
				"combination": [],
				"currentAttributes": []
			},
			{
				"productId": 1307,
				"brandId": 1,
				"brandName": "Uappi",
				"mainCategoryId": 0,
				"mainCategoryName": "",
				"type": "product",
				"sku": "50288",
				"name": "BONÉ CINZA LOGO MANUSCRITO LARANJA - GROWTH SUPPLEMENTS",
				"active": true,
				"url": "bone-cinza-logo-manuscrito-laranja---growth-supplements",
				"comparisonPrice": 0,
				"stock": 0,
				"medias": [],
				"combination": [],
				"currentAttributes": []
			},
			{
				"productId": 2536,
				"brandId": 1,
				"brandName": "Uappi",
				"mainCategoryId": 0,
				"mainCategoryName": "",
				"type": "product",
				"sku": "ROSA 73",
				"name": "JAQUETA CROPPED GROWTH MANUSCRITO PRETO - GROWTH SUPPLEMENTS",
				"active": true,
				"url": "jaqueta-cropped-growth-manuscrito-preto---growth-supplements",
				"comparisonPrice": 150,
				"stock": 0,
				"medias": [],
				"combination": [],
				"currentAttributes": []
			},
			{
				"productId": 2540,
				"brandId": 1,
				"brandName": "Uappi",
				"mainCategoryId": 0,
				"mainCategoryName": "",
				"type": "product",
				"sku": "MZF 293",
				"name": "CROPPED GROWTH SHE AZUL CLARO - GROWTH SUPPLEMENTS",
				"active": true,
				"url": "cropped-growth-she-azul-claro---growth-supplements",
				"comparisonPrice": 54,
				"stock": 0,
				"medias": [],
				"combination": [],
				"currentAttributes": []
			},
			{
				"productId": 2708,
				"brandId": 1,
				"brandName": "Uappi",
				"mainCategoryId": 0,
				"mainCategoryName": "",
				"type": "product",
				"sku": "FAIXA DE CABELO GROWTH BEAUT - TESTE",
				"name": "FAIXA DE CABELO GROWTH BEAUT - TESTE",
				"active": true,
				"url": "faixa-de-cabelo-growth-beaut---teste",
				"comparisonPrice": 999.99,
				"stock": 0,
				"medias": [],
				"combination": [],
				"currentAttributes": []
			},
			{
				"productId": 2751,
				"brandId": 1,
				"brandName": "Uappi",
				"mainCategoryId": 0,
				"mainCategoryName": "",
				"type": "product",
				"sku": "AGRUPADOR PROTEIN BAR GROWTH 30GR",
				"name": "PROTEIN BAR GROWTH 30GR - DISPLAY C/ 12 UN.",
				"active": true,
				"url": "protein-bar-growth-30gr---display-c/-12-un.",
				"comparisonPrice": 40,
				"stock": 0,
				"medias": [],
				"combination": [],
				"currentAttributes": []
			},
			{
				"productId": 3664,
				"brandId": 32,
				"brandName": "Saraiva",
				"mainCategoryId": 0,
				"mainCategoryName": "",
				"type": "product",
				"sku": "THEWITCHERBATISMODEFOGO",
				"name": "A saga do bruxo Geral de Rivia - Batismo de fogo",
				"active": true,
				"url": "",
				"comparisonPrice": 0,
				"stock": 1310,
				"medias": [
					{
						"id": 90,
						"type": "image",
						"title": "173",
						"alternativeText": null,
						"file": "/upload/media/a47b621edacfe52c72d6fe24025afeee.webp",
						"originalFile": "/upload/media/a47b621edacfe52c72d6fe24025afeee.jpeg",
						"size": 9070,
						"originalSize": 18348,
						"width": 500,
						"height": 500,
						"url": null
					},
					{
						"id": 97,
						"type": "image",
						"title": "301",
						"alternativeText": null,
						"file": "/upload/media/1a33ed21f3f7a83ccc62b85125b79ab4.webp",
						"originalFile": "/upload/media/2274172ae5d97155ad16b95e44fb2c29.jpeg",
						"size": 9070,
						"originalSize": 18348,
						"width": 500,
						"height": 500,
						"url": null
					}
				],
				"combination": [],
				"currentAttributes": []
			}
		],
		"pagination": {
			"limit": 10,
			"offset": 0,
			"pages": 2,
			"registers": 13
		}
	}
}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Código Interno	Código Http	Descrição
UAPPI_INTEGRATION_MARKETPLACE_CREDENTIAL_NOT_FOUND	404	A credencial de marketplace solicitada não foi encontrada.

Começando

Store Theme

Customização de Interface

Consumo de Dados

Tracking e SEO

Checkout

Consumo de Dados

Tracking e SEO

Ambiente de Pagamento

Área Restrita (Minha Conta)

Consumo de Dados

Tracking e SEO

SDK Público (public-sdk)

Modules

Api

Tracking

API Pública

Área Restrita (Minha Conta)

Carrinho de Compras

API Privada

Apps

Configurações Gerais

Clientes

Template

Avaliações

Notificações

ERPs

Filas

Grupo de Pedidos

Pedidos

Carrinhos

Pagamentos

Anti-Fraude

Produtos

Inteligência Artificial

Marcas

Categorias

Filtros

Atributos

Url

Relatórios

Render

Fretes

Usuários

Promocionais

Marketplace

Third Party

Datalogic

Busca

MCP

Sincronização manual de produtos no marketplace

Descrição

Parâmetros

Headers Obrigatórios

Parâmetros de rota

Parâmetros de corpo

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros:

Listagem de todos os IDs dos produtos mapeados na credencial

Descrição

Parâmetros

Headers Obrigatórios

Parâmetros de rota

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros:

Listagem dos produtos simples não mapeados na credencial de marketplace

Descrição

Parâmetros

Headers Obrigatórios

Parâmetros de rota

Campos de Solicitação

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros:

Nesta página

Institucional