{ "openapi": "3.0.0", "info": { "title": "V3 API", "version": "3.0", "description": "Os mesmos endpoints da **v2** funcionam nesta versão; a única diferença é a autenticação. Obtenha um token em `POST /oauth2/token` (client credentials) e envie-o no header `Authorization: Bearer `. O token expira (`expires_in`, em segundos) — renove-o antes de expirar.", "contact": { "name": "ANYMARKET Developers", "url": "https://suporte.anymarket.com.br/" }, "x-logo": { "url": "https://anymarket.com.br/wp-content/uploads/2018/07/icon-anymarket-300x300.png" }, "x-preferred": true, "x-providerName": "V2 API" }, "servers": [ { "url": "https://sandbox-api.anymarket.com.br/v3", "description": "Sandbox" }, { "url": "https://api.anymarket.com.br/v3", "description": "Produção" } ], "security": [ { "authorization": [] } ], "tags": [ { "name": "Autenticação", "description": "Autenticação OAuth2 (client credentials) — obtenção do token de acesso. Disponível apenas na v3 da API." }, { "name": "Callback", "description": "Callbacks management" }, { "name": "Campanhas", "description": "Gerenciamento de Campanhas" }, { "name": "Categorias", "description": "Gerenciamento de categorias" }, { "name": "Cotar Frete", "description": "Gerenciamento de frete" }, { "name": "Emissão de Etiquetas", "description": "Gerenciamento de emissão de etiquetas" }, { "name": "Grupo de caracteristica", "description": "Gerenciamento de grupo de caracteristica" }, { "name": "Estoque", "description": "Gerenciamento de stock" }, { "name": "Local de Estoque", "description": "Gerenciamento de Locais de Estoque" }, { "name": "Feed pedido", "description": "Gerenciamento de feed de pedidos" }, { "name": "Feed produto", "description": "Gerenciamento de feed de produtos" }, { "name": "Feed transmissão", "description": "Gerenciamento de feed de transmissão" }, { "name": "Imagem", "description": "Gerenciamento de imagens" }, { "name": "Marcas", "description": "Gerenciamento de marcas" }, { "name": "Mensageria", "description": "Gerenciamento de mensagens nos pedidos" }, { "name": "Monitoramento de Erro", "description": "Monitoramento de erros" }, { "name": "Pedido", "description": "Gerenciamento de pedidos" }, { "name": "Fulfillment", "description": "Gerenciamento de pedidos fulfillment" }, { "name": "Devolução", "description": "Gerenciamento de devolução" }, { "name": "Perguntas", "description": "Gerenciamento de perguntas" }, { "name": "Produto", "description": "Gerenciamento de produtos" }, { "name": "Promoção", "description": "Gerenciamento de regras de preço (Promoções)" }, { "name": "SKU", "description": "SKUs Management" }, { "name": "SKU Marketplace", "description": "Gerenciamento de anúncios" }, { "name": "Template", "description": "Templates Management" }, { "name": "Transmissão", "description": "Gerenciamento de transmissões" }, { "name": "Tipos de variação", "description": "Gerenciamento de tipos de variação" }, { "name": "Valores de variação", "description": "Gerenciamento de valores de variação" }, { "name": "Documentos Fiscais", "description": "Gerenciamento de documentos fiscais" }, { "name": "Feed preço de transmissão", "description": "Gerenciamento de feed de preço de transmissão" }, { "name": "Feed reserva", "description": "Gerenciamento de feed de reservas" }, { "name": "Perfis de Acesso", "description": "Gerenciamento de perfis de acesso" }, { "name": "Preço", "description": "Gerenciamento de preços" }, { "name": "Usuários", "description": "Gerenciamento de usuários" } ], "paths": { "/oauth2/token": { "post": { "summary": "/oauth2/token", "operationId": "post-oauth2-token", "description": "# OAuth2 authentication\n\nGenerates the access token for the ANYMARKET APIs using the *client credentials* flow. Send `client_id` and `client_secret` (provided by ANYMARKET) and receive a *bearer* `access_token`.\n\nThe returned token must be sent in the `Authorization` header of every other request, in the `Bearer ` format, and expires after `expires_in` seconds — renew it before it expires.", "servers": [ { "url": "https://sandbox-api.anymarket.com.br/v3", "description": "Sandbox" }, { "url": "https://api.anymarket.com.br/v3", "description": "Produção" } ], "security": [], "requestBody": { "description": "Credenciais do fluxo client credentials.", "content": { "application/json": { "schema": { "type": "object", "properties": { "grant_type": { "type": "string", "description": "Tipo de concessão OAuth2. Use `client_credentials`." }, "scope": { "type": "string", "description": "Escopo de acesso. Use `anymarket-api`." }, "client_id": { "type": "string", "description": "Identificador do cliente, fornecido pela ANYMARKET." }, "client_secret": { "type": "string", "description": "Segredo do cliente, fornecido pela ANYMARKET." } }, "required": [ "grant_type", "client_id", "client_secret" ] }, "examples": { "example-1": { "value": { "grant_type": "client_credentials", "scope": "anymarket-api", "client_id": "", "client_secret": "" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "token_type": { "type": "string", "description": "Tipo do token. Sempre `bearer`." }, "access_token": { "type": "string", "description": "Token de acesso a ser enviado no header `Authorization`, no formato `Bearer `." }, "expires_in": { "type": "integer", "description": "Tempo de vida do token, em segundos." } } }, "examples": { "example-1": { "value": { "token_type": "bearer", "access_token": "", "expires_in": 7200 } } } } } } }, "tags": [ "Autenticação" ] }, "parameters": [] }, "/brands": { "get": { "summary": "/brands", "operationId": "get-brands", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "links": { "type": "array", "description": "Referências de paginação", "items": { "type": "object", "properties": { "rel": { "type": "string", "description": "Relacionamento do hyperlink", "example": "next" }, "href": { "type": "string", "description": "URL de definição do recurso", "example": "https://.../v2/component?limit=5&offset=5" } } } }, "content": { "type": "array", "description": "Lista de marcas", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da marca", "minimum": 0 }, "name": { "type": "string", "description": "Nome da marca", "minLength": 1, "maxLength": 120 }, "reducedName": { "type": "string", "description": "Nome reduzido da marca", "minLength": 0, "maxLength": 30 }, "partnerId": { "type": "string", "description": "ID da marca no parceiro", "minLength": 0, "maxLength": 255 } } } }, "page": { "type": "object", "properties": { "size": { "type": "integer", "maximum": 100 }, "totalElements": { "type": "integer", "minimum": 0 }, "totalPages": { "type": "integer", "minimum": 0 }, "number": { "type": "integer", "minimum": 0 } } } } }, "examples": { "example-2": { "value": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 0, "name": "string", "reducedName": "string", "partnerId": "string" } ], "page": { "size": 5, "totalElements": 0, "totalPages": 1, "number": 1 } } }, "example-1": { "value": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 123456, "name": "Brastemp", "reducedName": "brastemp", "partnerId": "marca-001-brastemp" } ], "page": { "size": 5, "totalElements": 0, "totalPages": 1, "number": 1 } } } } } }, "headers": {} } }, "description": "# Retrieve Brands\nRetrieves all Brands.", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/name" }, { "$ref": "#/components/parameters/partnerId" } ], "tags": [ "Marcas" ] }, "post": { "summary": "/brands", "operationId": "post-brands", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da marca", "minimum": 0 }, "name": { "type": "string", "description": "Nome da marca", "minLength": 1, "maxLength": 120 }, "reducedName": { "type": "string", "description": "Nome reduzido da marca", "minLength": 0, "maxLength": 30 }, "partnerId": { "type": "string", "description": "ID da marca no parceiro", "minLength": 0, "maxLength": 255 } } }, "examples": { "Example 1": { "value": { "id": 0, "name": "string", "reducedName": "string", "partnerId": "string" } }, "example-1": { "value": { "id": 1987032, "name": "teste co po", "reducedName": "testcop" } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Create Brand\nCreates a new Brand using the given data.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandAdd" } } }, "description": "" }, "tags": [ "Marcas" ] } }, "/brands/{id}": { "get": { "summary": "/brands/{id}", "operationId": "get-brands-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da marca", "minimum": 0 }, "name": { "type": "string", "description": "Nome da marca", "minLength": 1, "maxLength": 120 }, "reducedName": { "type": "string", "description": "Nome reduzido da marca", "minLength": 0, "maxLength": 30 } } }, "examples": { "example-1": { "value": { "id": 0, "name": "string", "reducedName": "string" } }, "stoplight-example-1": { "value": { "id": 1987032, "name": "teste co po", "reducedName": "testcop" } } } } }, "headers": {} }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Retrieve a brand\nRetrieves a specific Brand by its ID.", "parameters": [], "tags": [ "Marcas" ] }, "parameters": [ { "schema": { "type": "integer", "format": "int64", "minimum": 1 }, "name": "id", "in": "path", "description": "Brand ID generated by ANYMARKET.", "required": true } ], "delete": { "summary": "/brands/{id}", "operationId": "delete-brands-id", "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)" } }, "description": "# Delete Brand\nDeletes an existing brand.", "tags": [ "Marcas" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "description": "" } }, "put": { "summary": "/brands/{id}", "operationId": "put-brands-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da marca", "minimum": 0 }, "name": { "type": "string", "description": "Nome da marca", "minLength": 1, "maxLength": 255 }, "reducedName": { "type": "string", "description": "Nome reduzido da marca", "minLength": 0, "maxLength": 30 } } }, "examples": { "example-1": { "value": { "id": 0, "name": "string", "reducedName": "string" } }, "stoplight-example-1": { "value": { "id": 0, "name": "string", "reducedName": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Update Brand\nUpdates a existing Brand.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandAdd" } } } }, "tags": [ "Marcas" ] } }, "/callbacks": { "post": { "summary": "/callbacks", "operationId": "post-callbacks", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID interno", "minimum": 0, "maximum": 9999999999 }, "url": { "type": "string", "description": "URL do callback", "minLength": 1, "maxLength": 255 }, "token": { "type": "string", "description": "Token da Conta ANYMARKET" }, "orderActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de pedido" }, "productActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de produto" }, "transmissionActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de transmissão" }, "questionActive ": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de pergunta" } } }, "examples": { "example-1": { "value": { "id": 0, "url": "example.com", "token": "string", "orderActive": true, "productActive": true, "transmissionActive": true, "questionActive ": true } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Create Callback\nCreates a Callback using the given data.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "URL de Callback" }, "token": { "type": "string", "description": "Token da Conta ANYMARKET" }, "orderActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de pedido" }, "productActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de produto" }, "transmissionActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de transmissão" }, "questionActive ": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de pergunta" } } }, "examples": { "example-1": { "value": { "url": "example.com", "token": "string", "orderActive": true, "productActive": true, "transmissionActive": true, "questionActive ": true } }, "stoplight-example-1": { "value": { "id": 0, "url": "example.com", "token": "string", "orderActive": true, "productActive": true, "transmissionActive": true, "questionActive ": true } } } } }, "description": "" }, "tags": [ "Callback" ] }, "parameters": [], "get": { "summary": "/callbacks", "operationId": "get-callbacks", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_CallBack" }, "examples": { "example-1": { "value": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 0, "url": "example.com", "token": "string", "orderActive": true, "productActive": true, "transmissionActive": true, "questionActive ": true } ], "page": { "size": 5, "totalElements": 0, "totalPages": 1, "number": 1 } } } } } }, "headers": {} } }, "description": "# Retrieve Callbacks \nRetrieves all available Callbacks.", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/sort" } ], "tags": [ "Callback" ], "x-internal": true, "x-stoplight": { "id": "q85f0ckemeksm" } } }, "/callbacks/{id}": { "get": { "summary": "/callbacks/{id}", "operationId": "get-callbacks-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallBack" }, "examples": { "example-1": { "value": { "id": 0, "url": "example.com", "token": "string", "orderActive": true, "productActive": true, "transmissionActive": true, "questionActive ": true } } } } }, "headers": {} }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "description": "# Retrieve a Callback\nRetrieves the details of a Callback by its ID.", "parameters": [], "tags": [ "Callback" ] }, "parameters": [ { "schema": { "type": "integer", "format": "int64", "minimum": 1 }, "name": "id", "in": "path", "required": true, "description": "Callback ID generated by ANYMARKET." } ], "delete": { "summary": "/callbacks/{id}", "operationId": "delete-callback-id", "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "description": "# Delete Callback\nDeletes an existing Callback.", "tags": [ "Callback" ] }, "put": { "summary": "/callbacks/{id}", "operationId": "put-callbacks-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID interno" }, "url": { "type": "string", "description": "URL do callback", "minLength": 1, "maxLength": 255 }, "token": { "type": "string", "description": "Token da Conta ANYMARKET" }, "orderActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de pedido" }, "productActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de produto" }, "transmissionActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de transmissão" }, "questionActive ": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de pergunta" } } }, "examples": { "example-1": { "value": { "id": 0, "url": "string", "token": "string", "orderActive": true, "productActive": true, "transmissionActive": true, "questionActive ": true } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Update Callback\nUpdates the data of a Callback.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallBackPost" } } } }, "tags": [ "Callback" ] } }, "/campaigns": { "get": { "summary": "/campaigns", "operationId": "get-campaigns", "description": "# Consulta Campanha\nRetorna por paginação TODAS campanhas cadastradas", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "status", "description": "Os status podem ser SCHEDULED, ACTIVE e FINALIZED." }, { "schema": { "type": "string" }, "in": "query", "name": "limit", "description": "Quantidade de registro da paginação, valor máximo 100." }, { "schema": { "type": "string" }, "in": "query", "name": "offset", "description": "Quantidade de registros deslocados na paginação." } ], "tags": [ "Campanhas" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "pageSize": { "type": "integer" }, "count": { "type": "integer" }, "start": { "type": "integer" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "idAccount": { "type": "string" }, "accountName": { "type": "string" }, "description": { "type": "string" }, "initialDate": { "type": "string" }, "finalDate": { "type": "string" }, "marketplace": { "type": "string" }, "status": { "type": "string" }, "productsCount": { "type": "integer" } } } } } }, "examples": { "example-1": { "value": { "pageSize": 0, "count": 0, "start": 0, "values": [ { "id": 0, "title": "string", "idAccount": "string", "accountName": "string", "description": "string", "initialDate": "string", "finalDate": "string", "marketplace": "string", "status": "string", "productsCount": 0 } ] } }, "stoplight-example-1": { "value": { "pageSize": 5, "count": 64, "start": 0, "values": [ { "id": 203, "title": "Automação1662035570679", "idAccount": "1", "accountName": "ECOMMERCE", "description": "Campanha de testes automatizados", "initialDate": "2022-09-03T09:32:42.041Z", "finalDate": "2022-09-07T09:32:42.041Z", "marketplace": "ECOMMERCE", "status": "SCHEDULED", "productsCount": 0 }, { "id": 206, "title": "Automação1662036323424", "idAccount": "1", "accountName": "ECOMMERCE", "description": "Campanha de testes automatizados", "initialDate": "2022-09-03T09:45:14.789Z", "finalDate": "2022-09-07T09:45:14.789Z", "marketplace": "ECOMMERCE", "status": "FINALIZED", "productsCount": 0 }, { "id": 209, "title": "Automação1662038893910", "idAccount": "1", "accountName": "ECOMMERCE", "description": "Campanha de testes automatizados", "initialDate": "2022-09-03T10:28:05.454Z", "finalDate": "2022-09-07T10:28:05.454Z", "marketplace": "ECOMMERCE", "status": "FINALIZED", "productsCount": 0 }, { "id": 263, "title": "Automação1672060413770", "idAccount": "1", "accountName": "ECOMMERCE", "description": "Campanha de testes automatizados", "initialDate": "2022-12-28T13:12:42.733Z", "finalDate": "2023-01-01T13:12:42.733Z", "marketplace": "ECOMMERCE", "status": "FINALIZED", "productsCount": 0 }, { "id": 262, "title": "Automação1672060393631", "idAccount": "1", "accountName": "ECOMMERCE", "description": "Campanha de testes automatizados", "initialDate": "2022-12-28T13:12:42.651Z", "finalDate": "2023-01-01T13:12:42.651Z", "marketplace": "ECOMMERCE", "status": "ACTIVE", "productsCount": 0 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "example-1": { "value": { "code": "400", "message": "O campo 'status' na url está em formato incorreto. Verifique a documentação para maiores detalhes." } }, "stoplight-example-1": { "value": { "code": "400", "message": "O campo 'status' na url está em formato incorreto. Verifique a documentação para maiores detalhes." } } } } } } } }, "parameters": [], "post": { "summary": "/campaigns", "tags": [ "Campanhas" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "marketplace": { "type": "string" }, "idAccount": { "type": "integer" }, "description": { "type": "string" }, "initialDate": { "type": "string", "format": "date-time" }, "finalDate": { "type": "string", "format": "date-time" }, "overrideCampaignItens": { "type": "boolean" } } }, "examples": { "Example 1": { "value": { "id": 0, "title": "string", "marketplace": "string", "idAccount": 0, "description": "string", "initialDate": "2024-08-24T14:15:22Z", "finalDate": "2024-08-24T15:15:22Z", "overrideCampaignItens": true } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "422", "message": "[O campo title deve ter no máximo 35 caracteres]" } } } } } } }, "operationId": "post-campaigns", "description": "# Criar campanha\nCria uma campanha com os dados informados", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "title", "initialDate", "finalDate", "marketplace" ], "properties": { "title": { "type": "string", "description": "Nome da campanha", "maxLength": 35 }, "initialDate": { "type": "string", "format": "date-time", "description": "Data inicial" }, "finalDate": { "type": "string", "format": "date-time", "description": "Data Final" }, "marketplace": { "type": "string", "description": "Marketplace da campanha" }, "idAccount": { "type": "integer", "description": "ID da conta utilizada no MARKETPLACE" }, "description": { "type": "string", "description": "Descrição da campanha", "maxLength": 100 }, "overrideCampaignItens": { "type": "boolean", "description": "Sobrescrever itens em outras campanhas", "default": false } } } } }, "description": "" } } }, "/campaigns/{id}": { "get": { "summary": "/campaigns/{id}", "operationId": "get-campaigns-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" }, "examples": {} } }, "headers": {} }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "description": "# Retrieve Campaign\nRetrieves the details of a Campaign.", "parameters": [], "tags": [ "Campanhas" ] }, "put": { "summary": "/campaigns/{id}", "operationId": "put-campaigns", "tags": [ "Campanhas" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "marketplace": { "type": "string" }, "idAccount": { "type": "integer" }, "description": { "type": "string" }, "initialDate": { "type": "string", "format": "date-time" }, "finalDate": { "type": "string", "format": "date-time" }, "overrideCampaignItens": { "type": "boolean" } } }, "examples": { "Example 1": { "value": { "id": 0, "title": "string", "marketplace": "string", "idAccount": 0, "description": "string", "initialDate": "2019-08-24T14:15:22Z", "finalDate": "2019-08-24T14:15:22Z", "overrideCampaignItens": false } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "422", "message": "Uma campanha já finalizada não pode ser alterada!" } } } } } } }, "description": "# Atualizar campanha\n\nAtualiza uma campanha com os dados informados.\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.\n>\n> Campos omitidos podem ser redefinidos ou apagados.\n>\n> Use este método quando quiser sobrescrever todas as informações.", "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "title", "initialDate", "finalDate", "marketplace" ], "properties": { "title": { "type": "string", "description": "Nome da campanha\n`<= 35 characters`" }, "initialDate": { "type": "string", "format": "date-time", "description": "Data inicial" }, "finalDate": { "type": "string", "format": "date-time", "description": "Data Final" }, "marketplace": { "type": "string", "description": "Marketplace da campanha" }, "idAccount": { "type": "integer", "description": "ID da conta utilizada no MARKETPLACE" }, "description": { "type": "string", "description": "Descrição da campanha\n`<= 100 characters`" }, "overrideCampaignItens": { "type": "boolean", "description": "Sobrescrever itens em outras campanhas", "default": false } } }, "examples": {} } } } }, "parameters": [ { "schema": { "type": "integer", "format": "int64", "minimum": 1 }, "name": "id", "in": "path", "required": true, "description": "Campaign ID generated by ANYMARKET." } ] }, "/campaigns/{id}/products": { "parameters": [ { "schema": { "type": "integer", "format": "int64", "minimum": 1 }, "name": "id", "in": "path", "required": true, "description": "ID da campanha gerado pelo ANYMARKET" } ], "get": { "summary": "/campaigns/{id}/products", "tags": [ "Campanhas" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "pageSize": { "type": "integer" }, "count": { "type": "integer" }, "start": { "type": "integer" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "sku": { "type": "string" }, "codInMarketplace": { "type": "string" }, "regularPrice": { "type": "number" }, "discountPrice": { "type": "number" } } } } } }, "examples": { "Example 1": { "value": { "pageSize": 0, "count": 0, "start": 0, "values": [ { "id": 0, "sku": "string", "codInMarketplace": "string", "regularPrice": 0, "discountPrice": 0 } ] } }, "stoplight-Example 1": { "value": { "pageSize": 5, "count": 163, "start": 0, "values": [ { "id": 12879, "sku": "MKP002099002586", "codInMarketplace": "MLB4735784160", "regularPrice": 1944.8, "discountPrice": 1934.8 }, { "id": 12746, "sku": "MKP002099004566", "codInMarketplace": "MLB4735861148", "regularPrice": 899.9, "discountPrice": 889.9 }, { "id": 12818, "sku": "MKP002097005340", "codInMarketplace": "MLB4735784570", "regularPrice": 2794.8, "discountPrice": 2784.8 }, { "id": 12755, "sku": "MKP002098020510", "codInMarketplace": "MLB4735822152", "regularPrice": 1073.8, "discountPrice": 1063.8 }, { "id": 12881, "sku": "MKP002099005668", "codInMarketplace": "MLB4735796512", "regularPrice": 1916.8, "discountPrice": 1906.8 } ] } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "404", "message": "Recurso com o id 'xxx' não encontrado" } } } } } } }, "operationId": "get-campaigns-id-products", "description": "# Consulta Produtos da Campanha\nRetorna por paginação TODOS os produtos cadastrados na campanha", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "limit", "description": "Quantidade de registro da paginação, valor máximo 100." }, { "schema": { "type": "string" }, "in": "query", "name": "offset", "description": "Quantidade de registros deslocados na paginação." } ] }, "post": { "summary": "/campaigns/{id}/products", "tags": [ "Campanhas" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "400", "message": "O campo 'id' na url está em formato incorreto. Verifique a documentação para maiores detalhes." } }, "Example 2": { "value": { "code": "400", "message": "O parâmetro 'file' é obrigatório, consulte a documentação para maiores informações." } }, "stoplight-Example 1": { "value": { "code": "400", "message": "O campo 'id' na url está em formato incorreto. Verifique a documentação para maiores detalhes." } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "404", "message": "Recurso com o id 'xxx' não encontrado." } }, "stoplight-Example 1": { "value": { "code": "404", "message": "Recurso com o id 'xxx' não encontrado." } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "422", "message": "File not supported" } }, "stoplight-Example 1": { "value": { "code": "422", "message": "File not supported" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "500", "message": "Content type 'null' not supported" } }, "stoplight-Example 1": { "value": { "code": "500", "message": "Content type 'null' not supported" } } } } } } }, "operationId": "post-campaigns-id-products", "description": "# Gerencia produtos de uma campanha\nEndpoint para a importação de planilha dos produtos de uma campanha", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "description": "key: File
value: Arquivo XLS ou XLSX" } } }, "examples": { "Example 1": { "value": { "file": "string" } } } } } } } }, "/campaigns/{id}/inactivate": { "parameters": [ { "schema": { "type": "integer", "format": "int64", "minimum": 1 }, "name": "id", "in": "path", "description": "ID da campanha gerado pelo ANYMARKET", "required": true } ], "post": { "summary": "/campaigns/{id}/inactivate", "tags": [ "Campanhas" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "idAccount": { "type": "integer" }, "accountName": { "type": "string" }, "initialDate": { "type": "string", "format": "date-time" }, "finalDate": { "type": "string", "format": "date-time" }, "marketplace": { "type": "string" }, "status": { "type": "string" }, "productsCount": { "type": "integer" }, "override": { "type": "boolean", "default": false } } } } }, "examples": { "Example 1": { "value": { "message": "Campanha encerrada com sucesso!", "data": { "id": 0, "title": "teste", "idAccount": 0, "accountName": "ECOMMERCE", "initialDate": "2019-08-24T14:15:22Z", "finalDate": "2019-08-24T14:15:22Z", "marketplace": "ECOMMERCE", "status": "FINALIZED", "productsCount": 0, "override": false } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "400", "message": "O campo 'id' na url está em formato incorreto. Verifique a documentação para maiores detalhes." } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "404", "message": "Recurso com o id '0' não encontrado" } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "422", "message": "Método POST não suportado para path solicitado. Verifique a documentação para maiores detalhes." } } } } } } }, "operationId": "post-campaigns-id-inactivate", "description": "# Inativar Campanha\nEncerrar uma campanha previamente criada" } }, "/categories": { "get": { "summary": "/categories", "operationId": "get-categories", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_Category" }, "examples": { "Example 1": { "value": { "links": [ { "rel": "next", "href": "https://.../v2/{rota}?limit=5&offset=5" } ], "content": [ { "id": 0, "name": "string", "path": "string", "partnerId": "string", "priceFactor": 0, "definitionPriceScope": "SKU" } ], "page": { "size": 5, "totalElements": 0, "totalPages": 0, "number": 1 } } } } } }, "headers": {} } }, "description": "# Retrieve Categories \nRetrievs all categories on the first hierarchy level, example: \n\n\n- Electronics\n - Accessories & Supplies\n - Television & Video\n- Sports and Outdoors\n - Outdoor Recreation\n - Sports & Fitness\n- Home and Kitchen\n - Furniture\n - Lighting & Ceiling Fans\n\n\nOn this scenario the retrieved categories would be 'Electronics',\n'Sports and Outdoors' and 'Home and Kitchen'.", "tags": [ "Categorias" ] }, "post": { "summary": "/categories", "operationId": "post-categories", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryGET" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Create Category\nCreates a category using the given data.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryPOST" }, "examples": { "example-1": { "value": { "name": "string", "partnerId": "string", "priceFactor": 0, "definitionPriceScope": "SKU", "parent": { "id": 0 } } } } } }, "description": "" }, "tags": [ "Categorias" ] }, "parameters": [] }, "/categories/{id}": { "get": { "summary": "/categories/{id}", "operationId": "get-categories-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID interno" }, "name": { "type": "string", "description": "Nome da categoria" }, "path": { "type": "string", "description": "Diretório e subdiretórios da categoria" }, "parent": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da categoria \"PAI\"" }, "partnerId": { "type": "string", "description": "ID da categoria \"PAI\" no parceiro" } } }, "partnerId": { "type": "string", "description": "ID da categoria no parceiro" }, "priceFactor": { "type": "integer", "description": "Fator de preço" }, "children": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da categoria \"FILHA\"" }, "name": { "type": "string", "description": "Nome da categoria \"FILHA\"" }, "path": { "type": "string", "description": "Diretório e subdiretórios da categoria" }, "partnerId": { "type": "string", "description": "ID da categoria \"FILHA\" no parceiro" }, "priceFactor": { "type": "integer", "description": "Fator de preço" }, "definitionPriceScope": { "type": "string", "description": "SKU (Manual, eu controlo o preço pelo SKU), SKU_MARKETPLACE (Manual, eu controlo o preço pelo anúncio) ou COST (Automático, pela mudança do custo)" } } } }, "definitionPriceScope": { "type": "string", "description": "SKU (Manual, eu controlo o preço pelo SKU), SKU_MARKETPLACE (Manual, eu controlo o preço pelo anúncio) ou COST (Automático, pela mudança do custo)" } } }, "examples": { "example-1": { "value": { "id": 0, "name": "string", "path": "string", "parent": { "id": 0, "partnerId": "string" }, "partnerId": "string", "priceFactor": 0, "children": [ { "id": 0, "name": "string", "path": "string", "partnerId": "string", "priceFactor": 0, "definitionPriceScope": "SKU" } ], "definitionPriceScope": "SKU" } }, "stoplight-example-1": { "value": { "id": 1794222, "name": "Testetetetet1", "path": "Testetetetet/Testetetetet1", "parent": { "id": 1794218, "partnerId": "757878" }, "partnerId": "7547878", "priceFactor": 1, "children": [ { "id": 1794224, "name": "Testetetetet10", "path": "Testetetetet/Testetetetet1/Testetetetet10", "partnerId": "75478678", "priceFactor": 1, "definitionPriceScope": "SKU" } ], "definitionPriceScope": "SKU" } } } } }, "headers": {} }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "description": "# Retrieve Category\nRetrieves the data of the given Category on all levels.", "parameters": [], "tags": [ "Categorias" ] }, "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "Category ID generated by ANYMARKET." } ], "put": { "summary": "/categories/{id}", "operationId": "put-categories-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryFullPath" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Update Category\nUpdates the data of the given Category.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryPOST" } } } }, "tags": [ "Categorias" ] }, "delete": { "summary": "/categories/{id}", "operationId": "delete-categories-id", "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "description": "# Delete Category\nDeletes an existing Category.", "tags": [ "Categorias" ] } }, "/categories/fullPath": { "get": { "summary": "/categories/fullPath", "operationId": "get-categories-fullPath", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da categoria gerado pelo ANYMARKET" }, "name": { "type": "string", "description": "Nome da categoria" }, "path": { "type": "string", "description": "Caminho da categoria" }, "partnerId": { "type": "string", "description": "partnerId" }, "priceFactor": { "type": "integer", "description": "Fator de preço" }, "totalProducts": { "type": "integer", "description": "Total de produtos contidos na categoria" }, "children": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID interno" }, "name": { "type": "string", "description": "Nome da categoria \"FILHA\"" }, "path": { "type": "string", "description": "Caminho da categoria" }, "parent": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID interno" }, "partnerId": { "type": "string", "description": "ID da categoria no parceiro" } } }, "partnerId": { "type": "string", "description": "ID da categoria no parceiro" }, "priceFactor": { "type": "integer", "description": "priceFactor" }, "totalProducts": { "type": "integer", "description": "Total de produtos contidos na categoria" } } } } } } }, "examples": { "example-1": { "value": [ { "id": 0, "name": "string", "path": "string", "partnerId": "string", "priceFactor": 0, "totalProducts": 0, "children": { "id": 0, "name": "string", "path": "string", "partnerId": "string", "priceFactor": 0, "totalProducts": 1, "definitionPriceScope": "SKU", "parent": { "id": 0, "parnerId": "string" }, "children": {} } } ] }, "stoplight-example-1": { "value": [ { "id": 1771102, "name": "Brinquedos", "path": "Brinquedos", "partnerId": "87", "priceFactor": 1, "totalProducts": 0, "children": [ { "id": 1771137, "name": "Brinquedos para Bebês", "path": "Brinquedos/Brinquedos para Bebês", "parent": { "id": 1771102, "partnerId": "87" }, "partnerId": "371", "priceFactor": 1, "totalProducts": 2 } ] } ] } } } }, "headers": {} } }, "description": "# Retrieve Category Tree\nRetrievs all categories levels, example: \n\n\n- Electronics\n - Accessories & Supplies\n - Television & Video\n- Sports and Outdoors\n - Outdoor Recreation\n - Sports & Fitness\n- Home and Kitchen\n - Furniture\n - Lighting & Ceiling Fans\n\nAll categories levels would be listed respectively.\n", "parameters": [], "tags": [ "Categorias" ] }, "parameters": [] }, "/printtag/{type}": { "parameters": [ { "schema": { "type": "string", "enum": [ "PDF", "ZPL", "ZPL2" ] }, "name": "type", "in": "path", "required": true, "description": "File extension that will be generated (PDF, ZPL2)" } ], "post": { "tags": [ "Emissão de Etiquetas" ], "summary": "/printtag/{type}", "description": "# Print Shipping Label\nPrints the Shipping Labels of the given orders.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintTag" }, "examples": { "ZPL": { "value": { "content": "^XA^MCY^CI28^LH5,15^FX HEADER ^FS^FX Logo_Meli ^FS^FO20,10^GFA,800,800,10,,:::::::::::O0FF,M07JFE,L07FC003FE,K07EL07E,J01EN078,J07P0E,I01CP038,I07R0E,001CK01FK038,003L0IFK0C,0078J03803CJ0E,0187J06I07I01D8,0300F00F8J0FEFE0C,02003IFK01J06,04I01C6P02,08K0401FM01,1L08060CM083K0100C02M0C2M01001M046K0306I0CL064K0198I02L024Q01L02CR08K03CR04K03FR02K03FFQ01J07!C1FQ0C007E3C03EP0203F03C0078O010F003CI0EF1N0F8003CI070C4M06I03CI02003CL02I03CI02P02I036I03N0106I066I01J08J0C4I067J0EI08J078I0E38I03I0E00406I01C3CI01800100204I01C3CJ0FI080118I03C1EJ03800801FJ0780FK0C008018J0F,078J07C0823J01F,07EJ01C1C36J07E,03FK031C3K0FC,01FCJ01E18J01F8,00FER07F,007F8P01FE,003FFP0FFC,I0FFEN07FF,I03FFCL03FFC,J0IFCJ03IF,J07PFE,K0PF,K01NF8,L01LF8,N0JF,,:::::::::::^FS^FO120,20^A0N,24,24^FH^FDANYMARKET SA _2E_2D ANYMARKET SA _2E #123456789^FS^FO120,43^A0N,24,24^FH^FB550,2,0,L^FDAv_2E Carneiro Leao_2D2 Andar 563, Zona 1^FS^FO120,90^A0N,24,24^FH^FB550,1,0,L^FDMaringa, BR-PR - 87014010^FS^FO120,120^A0N,24,24^FDPack ID: 10000^FS^FO272,117^A0N,27,27^FD01234567890^FS^FX LAST CLUSTER ^FS^FO20,150^GB210,45,45^FS^FO20,156^A0N,45,45^FB210,1,0,C^FR^FDXSP1^FS^FX END LAST CLUSTER ^FS^FO480,150^GB330,40,40^FS^FO410,160^A0N,22,22^FB460,1,0,C^FR^FH^FDENTREGAR NA COLETA^FS^FX Shipment_Number_Bar_Code ^FS^FO230,210^BY3,,0^BCN,160,N,N,N^FD>:01234567890^FS^FO95,385^A0N,30,30^FB390,1,0,R^FD423127^FS^FO488,381^A0N,35,35^FB400,1,0,L^FD60443^FS^FX END_HEADER ^FS^FX CUSTOM_DATA ^FS^FO0,580^A0N,175,175^FB630,1,0,R^FDSRD1^FS^FO670,640^A0N,47,47^FB200,1,0,L^FD09:00^FS^FO0,790^A0N,28,28^FB600,1,0,R^FDXSP1 > XSP9 > SRD1 > ^FS^FO605,785^A0N,40,40^FD4^FS^FO0,830^A0N,38,38^FB820,1,0,C^FDTER 06/06/2023 CEP: 87014010 NF: 1234567^FS^FX END CUSTOM_DATA ^FS^FO0,950^GB850,0,2^FS^FX RECEIVER ZONE ^FS^FO30,970^A0N,26,26^FB600,2,0,L^FH^FDDB1 Global Software SA (DB1GLOBALSOFTWARE)^FS^FO30,1030^A0N,26,26^FB600,2,0,L^FH^FDEndere_C3_A7o: Av Carneiro Leao, 563 - 2º Andar_2c Zona 1^FS^FO30,1090^A0N,30,30^FDCEP: 87014010^FS^FO30,1089^A0N,30,30^FDCEP: 87014010^FS^FO30,1121^A0N,26,26^FB600,2,1000,L^FH^FDCidade de destino: Maringa_2c Parana^FS^FO30,1150^A0N,26,26^FB600,5,0,L^FH^FDComplemento: Sobreloja Centro Empresarial Le Monde_2E^FS^FX QR Code ^FS^FO650,985^BY2,2,0^BQN,2,5^FDLA,{\"id\":\"01234567890\",\"t\":\"lm\"}^FS^FO650,1130^GB105,40,40^FS^FO650,1135^A0N,35,35^FB105,1,0,C^FR^FDR^FS^FX END_FOOTER ^FS^XZ" } } } }, "application/pdf": { "schema": { "type": "object", "properties": {} }, "examples": { "file=PLP": { "value": "Arquivo.pdf" }, "type = PDF ou ZIP": { "value": "Arquivo.pdf ou Arquivo.zip" } } }, "application/zip": { "schema": { "type": "object", "properties": {} }, "examples": { "type = PDF": { "value": "Arquivo.zip" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "example-1": { "value": { "code": "409", "message": "As etiquetas dos seguintes pedidos [id dos pedidos] não estão prontas para download, tente novamente mais tarde" } }, "Example 1": { "value": { "code": "409", "message": "As etiquetas dos seguintes pedidos [id dos pedidos] não estão prontas para download, tente novamente mais tarde" } } } } }, "headers": {} }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintTagPost" } } } }, "parameters": [ { "schema": { "type": "string", "enum": [ "TXT", "PLP" ] }, "in": "query", "name": "file", "description": "\"TXT\" or \"PLP\" are allowed when the format is ZPL2. When given \"TXT\" a JSON is returned with the content of the TXT provided by the marketplace, when given \"PLP\" a PDF is returned with the PLP content." } ], "operationId": "post-printtag-type" } }, "/stocks": { "get": { "summary": "/stocks", "tags": [ "Estoque" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "links": { "type": "array", "description": "Referências de paginação", "items": { "type": "object", "properties": { "rel": { "type": "string", "description": "Relacionamento do hyperlink", "example": "next" }, "href": { "type": "string", "description": "URL de definição do recurso", "example": "https://.../v2/component?limit=5&offset=5" } } } }, "content": { "type": "array", "description": "Lista de estoques", "items": { "type": "object", "properties": { "stockKeepingUnit": { "type": "object", "description": "Objeto SKU", "properties": { "id": { "type": "integer", "description": "ID do SKU gerado pelo ANYMARKET" }, "title": { "type": "string", "description": "Título do SKY" }, "partnerId": { "type": "string", "description": "ID do parceiro" } } }, "stockLocal": { "type": "object", "description": "Local de Estoque", "properties": { "id": { "type": "integer", "description": "ID do estoque gerado pelo ANYMARKET" }, "oi": { "type": "object", "properties": { "value": { "type": "string", "description": "Identificador da Conta ANYMARKET" } } }, "name": { "type": "string", "description": "Nome do Estoque" }, "virtual": { "type": "boolean", "description": "Identifica se é estoque virtual" }, "defaultLocal": { "type": "boolean", "description": "Identifica se é o estoque principal" }, "priorityPoints": { "type": "integer", "description": "Pontos de prioridade para Múltiplos CDs" } } }, "amount": { "type": "integer", "description": "Quantidade em estoque" }, "reservationAmount": { "type": "integer", "description": "Quantidade em Reserva" }, "availableAmount": { "type": "integer", "description": "Quantidade de estoque disponível" }, "price": { "type": "integer", "description": "Preço de Custo" }, "active": { "type": "boolean", "description": "Identifica se o estoque está ativo" }, "additionalTime": { "type": "integer", "description": "Crossdocking" }, "lastStockUpdate": { "type": "string", "description": "Data da última atualização" }, "skuLocationDescription": { "type": "string", "description": "Local de Estoque" } } } }, "page": { "type": "object", "properties": { "size": { "type": "integer", "description": "Tamanho da página" }, "totalElements": { "type": "integer", "description": "Total de elementos existentes" }, "totalPages": { "type": "integer", "description": "Total de páginas disponíveis" }, "number": { "type": "integer", "description": "Número da página atual" } } } } }, "examples": { "example-1": { "value": { "links": [ { "rel": "string", "href": "string" } ], "content": [ { "stockKeepingUnit": { "id": 0, "title": "string", "partnerId": "string" }, "stockLocal": { "id": 0, "oi": { "value": "string" }, "name": "string", "virtual": true, "defaultLocal": true, "priorityPoints": 0 }, "amount": 0, "reservationAmount": 0, "availableAmount": 0, "price": 0, "active": true, "additionalTime": 0, "lastStockUpdate": "string" } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } }, "stoplight-example-1": { "value": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "stockKeepingUnit": { "id": 0, "title": "string", "partnerId": "string" }, "stockLocal": { "id": 0, "oi": { "value": "string" }, "name": "string", "virtual": true, "defaultLocal": true, "priorityPoints": 0 }, "amount": 0, "reservationAmount": 0, "availableAmount": 0, "price": 0, "active": true, "additionalTime": 0, "lastStockUpdate": "2019-08-24T14:15:22Z" } ], "page": { "size": 5, "totalElements": 0, "totalPages": 1, "number": 1 } } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "operationId": "get-stocks", "description": "# Retrieve Stocks\nRetrieves the details of a Stock.\n\n> The request can be made through filters used in the query. If no filter is specified, and the request return has more than 50 thousand records, the total return of records (totalElements) with an approximate value will be used, for performance reasons.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "idSku", "description": "Attribute to filter by SKU ID." }, { "schema": { "type": "string" }, "in": "query", "name": "idStockLocal", "description": "Attribute to filter by Warehouse ID." }, { "schema": { "type": "string" }, "in": "query", "name": "sku", "description": "Attribute to filter by SKU." }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/sortDirection" }, { "schema": { "type": "boolean" }, "in": "query", "name": "hasReservation", "description": "Atributo para filtras os estoques que possuem reserva" } ] }, "post": { "summary": "/stocks", "operationId": "post-stocks", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "tags": [ "Estoque" ], "description": "# Create Stock\nCreates the stock for the SKU and the Warehouse informed with the quantity, cost and additional time information.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "partnerId", "quantity", "cost", "stockLocalId" ], "properties": { "id": { "type": "string", "description": "ID do SKU gerado pelo ANYMARKET" }, "partnerId": { "type": "string", "description": "Código do SKU do parceiro" }, "quantity": { "type": "integer", "description": "Quantidade de estoque" }, "cost": { "type": "integer", "description": "Preço de Custo. A partir desse custo será calculado o preço final do produto caso o tipo do cálculo de preço esteja como automático" }, "additionalTime": { "type": "integer", "description": "Prazo Adicional para entrega do produto. Também chamado de 'crossdocking' este é o prazo de preparo de cada produto para envio, seja de fabricação, aquisição, embalagem ou redirecionamento de local. Utilizado em marketplaces como B2W e VIA. Caso não informado, manterá o valor atual." }, "stockLocalId": { "type": "integer", "description": "ID do Local de Estoque" }, "skuLocationDescription": { "type": "string", "description": "Local de Estoque" } } } }, "examples": { "example-1": { "value": [ { "id": 0, "partnerId": "string", "quantity": 0, "cost": 0, "additionalTime": 0, "stockLocalId": 0 } ] }, "stoplight-example-1": { "value": [ { "partnerId": "naomexerIntelipost", "quantity": 50, "cost": 1000, "additionalTime": 0, "stockLocalId": 18448 } ] } } } }, "description": "\n> #### Atenção!\n>\n> Tamanho máximo do lote é de **200 itens.**" } }, "put": { "summary": "/stocks", "operationId": "put-stocks", "responses": { "204": { "description": "No Content" }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Update Stock\nIt will be used to update stock, additional time or cost. The stock update is carried out in batch, so its possible to update one or multiple SKUs.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID do SKU gerado pelo ANYMARKET" }, "partnerId": { "type": "string", "description": "Código do SKU do parceiro" }, "quantity": { "type": "number", "description": "Quantidade em estoque", "minimum": 0 }, "cost": { "type": "number", "description": "Custo médio do SKU no estoque. A partir desse custo será calculado o preço final do produto caso o tipo do cálculo de preço esteja como automático.", "minimum": 0 }, "additionalTime": { "type": "integer", "description": "Prazo Adicional para entrega do produto. Também chamado de 'crossdocking' este é o prazo de preparo de cada produto para envio, seja de fabricação, aquisição, embalagem ou redirecionamento de local. Utilizado em marketplaces como B2W e CNOVA. Caso não informado, manterá o valor atual.\n" }, "stockLocalId": { "type": "integer", "description": "ID do Local de Estoque" }, "skuLocationDescription": { "type": "string", "description": "Local de Estoque" } }, "required": [ "partnerId", "quantity" ] } }, "examples": { "Example 1": { "value": [ { "id": 0, "partnerId": "string", "quantity": 0, "cost": 0, "additionalTime": 0, "stockLocalId": 0 } ] }, "stoplight-Example 1": { "value": [ { "id": 0, "partnerId": "string", "quantity": 0, "cost": 0, "additionalTime": 0, "stockLocalId": 0 } ] } } } }, "description": "\n> #### Atenção!\n>\n> Tamanho máximo do lote é de **200 itens**." }, "tags": [ "Estoque" ] } }, "/stocks/batch": { "put": { "summary": "/stocks/batch", "operationId": "put-stocks-batch", "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "array", "description": "SKUs atualizados com Sucesso", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID do SKU e Mensagem de erro dee Atualização" } } } }, "errors": { "type": "array", "description": "SKUs com erro de Atualização", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID do SKU e Mensagem de erro dee Atualização" } } } } } }, "examples": { "example-1": { "value": { "success": [ { "SKU1": "Atualizado com sucesso" }, { "SKU2": "Atualizado com sucesso" } ], "errors": [ { "SKU3": "Erro ao processar: Quantidade, Custo, Prazo Adicional ou Localização do produto devem ser informados" } ] } }, "stoplight-example-1": { "value": { "success": { "id": "string" }, "errors": { "id": "string" } } } } } } }, "400": { "description": "Bad Request" } }, "description": "# Altera Estoque\nSerá utilizada para realizar a atualização de estoque, prazo adicional ou do custo médio. A operação de estoque é realizada em batch, ou seja é possível enviar um ou mais SKUs para atualização.\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.\n>\n> Campos omitidos podem ser redefinidos ou apagados.\n>\n> Use este método quando quiser sobrescrever todas as informações.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "partnerId", "quantity" ], "properties": { "id": { "type": "integer", "description": "ID do SKU gerado pelo ANYMARKET" }, "partnerId": { "type": "string", "description": "Código do SKU do parceiro" }, "quantity": { "type": "integer", "description": "Quantidade em estoque" }, "cost": { "type": "integer", "description": "Custo médio do SKU no estoque. A partir desse custo será calculado o preço final do produto caso o tipo do cálculo de preço esteja como automático." }, "additionalTime": { "type": "integer", "description": "Prazo Adicional para entrega do produto. Também chamado de 'crossdocking' este é o prazo de preparo de cada produto para envio, seja de fabricação, aquisição, embalagem ou redirecionamento de local. Utilizado em marketplaces como Americanas e VIA. Caso não informado, manterá o valor atual." }, "stockLocalId": { "type": "integer", "description": "ID do Local de Estoque" } } } }, "examples": { "Example 1": { "value": [ { "id": 0, "partnerId": "string", "quantity": 0, "cost": 0, "additionalTime": 0, "stockLocalId": 0 } ] }, "example-1": { "value": [ { "id": 0, "partnerId": "string", "quantity": 0, "cost": 0, "additionalTime": 0, "stockLocalId": 0 } ] } } } }, "description": "\n> #### Atenção!\n>\n> Tamanho máximo do lote é de **200 itens**." }, "tags": [ "Estoque" ] }, "parameters": [] }, "/stocks/fulfillment/{marketplace}/{idSku}": { "parameters": [ { "schema": { "$ref": "#/components/schemas/EnumMarketplaces" }, "name": "marketplace", "in": "path", "required": true, "description": "Marketplace Identifier" }, { "schema": { "type": "string" }, "name": "idSku", "in": "path", "required": true, "description": "SKU Identifier in ANYMARKET" } ], "get": { "summary": "/stocks/fulfillment/{marketplace}/{idSku}", "tags": [ "Fulfillment" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StockFulfillmentGet" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "operationId": "get-stocks-fulfillment", "description": "# Retrieve fulfillment stock by Marketplace and idSku.\nUsed to list SKU fulfillment stock at each distribution center of the Marketplace. The\n\"marketplace\" parameter can be:\n- B2W_NEW_API\n- OTHERS\n\n> #### Warning!\n>\n> The **'marketplace'** parameter value must be capitalized because it is an ENUM. " } }, "/stocks/locals": { "get": { "summary": "/stocks/locals", "tags": [ "Local de Estoque" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StockLocalGet" } } } } } }, "operationId": "get-stocks-locals", "description": "# Retrieve Warehouses\nUsed to list Warehouses data." }, "post": { "summary": "/stocks/locals", "operationId": "post-stocks-locals", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "message": { "type": "string", "minLength": 1 }, "data": { "$ref": "#/components/schemas/StockLocalGet" } } }, "examples": { "example-1": { "value": { "message": "Estoque criado com sucesso!", "data": { "id": 1, "name": "string", "virtual": true, "distributor": "string", "defaultLocal": true, "zipCode": "string" } } }, "stoplight-example-1": { "value": { "message": "Estoque criado com sucesso!", "data": { "id": 3586, "name": "stringqwe", "virtual": false, "defaultLocal": false } } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Create Warehouse\nUsed to create Warehouses data.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockLocalPost" } } } }, "tags": [ "Local de Estoque" ] } }, "/stocks/locals/{id}": { "get": { "summary": "/stocks/locals/{id}", "tags": [ "Local de Estoque" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockLocalGet" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "operationId": "get-stocks-locals-id", "description": "# Retrieve Warehouse\nRetrieves Warehouse data by ID." }, "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "Warehouse ID generated by ANYMARKET." } ], "delete": { "summary": "/stocks/locals/{id}", "operationId": "delete-stocks-locals-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "message": { "type": "string", "minLength": 1 }, "data": { "type": "integer", "format": "int64", "minimum": 1 } }, "required": [ "message", "data" ] }, "examples": { "example-1": { "value": { "message": "Local de Estoque removido com sucesso!", "data": 1 } }, "stoplight-example-1": { "value": { "message": "Local de Estoque removido com sucesso!", "data": 3586 } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Delete Warehouse\nDeletes the Warehouse.", "tags": [ "Local de Estoque" ] }, "put": { "summary": "/stocks/locals/{id}", "operationId": "put-stocks-locals-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "message": { "type": "string", "minLength": 1 }, "data": { "$ref": "#/components/schemas/StockLocalGet" } } }, "examples": { "example-1": { "value": { "message": "Atualizado com sucesso!", "data": { "id": 1, "name": "string", "virtual": true, "defaultLocal": true, "zipCode": "string" } } }, "stoplight-example-1": { "value": { "message": "Estoque criado com sucesso!", "data": { "id": 3586, "name": "stringqwe", "virtual": false, "defaultLocal": false } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Update Warehouse\nUpdates the Warehouse data.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockLocalPost" } } } }, "tags": [ "Local de Estoque" ] } }, "/orders/feeds": { "get": { "summary": "/orders/feeds", "tags": [ "Feed pedido" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "maxItems": 10, "items": { "$ref": "#/components/schemas/OrderFeed" } } } } } }, "operationId": "get-orders-feeds", "description": "# Retrieve Orders Updates\nWhenever there is a New Order or an Order Update on ANYMARKET, it will be included as a new item in the Feed and this item will be available for 30 days. The request will return 10 random available items.", "parameters": [ { "$ref": "#/components/parameters/limit" } ] }, "parameters": [] }, "/orders/feeds/{id}": { "put": { "summary": "/orders/feeds/{id}", "operationId": "put-orders-feeds-id", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "tags": [ "Feed pedido" ], "description": "# Set Order Feed Item as Read\nThe Feed must be set as Read after retrieving the Order successfully. If not set as read it'll keep showing up on the request response.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "token": { "type": "string", "minLength": 1, "format": "uuid", "description": "Token recuperado na consulta do feed" } }, "required": [ "token" ] }, "examples": { "example-1": { "value": { "token": "string" } } } } }, "description": "Dados para atualização do feed" }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "description": "Status recuperado no momento da consulta do pedido, caso este parâmetro seja enviado apenas o status informado será marcado como lido. Por padrão são marcados como lidos todos os feeds do pedido em questão ", "name": "status" } ] }, "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "Order ID generated by ANYMARKET" } ] }, "/orders/feeds/batch": { "put": { "summary": "/orders/feeds/batch", "operationId": "put-orders-feeds-batch", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "tags": [ "Feed pedido" ], "description": "# Marca vários feeds como processados de uma vez\nApós consulta de diversos pedidos através do feed, é preciso marcá-los como lidos. Caso não sejam marcados, continuarão retornandos na consulta. Por este endpoint é possível fazer a confirmação de leitura em massa de vários pedidos.\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.\n>\n> Campos omitidos podem ser redefinidos ou apagados.\n>\n> Use este método quando quiser sobrescrever todas as informações.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "token", "type" ], "properties": { "id": { "type": "integer", "description": "Id da notificação do pedido", "example": 188443520 }, "status": { "type": "string", "description": "Status do pedido no momento do GET no pedido, caso queira fazer a confirmação por status", "example": "PENDING" }, "token": { "type": "string", "description": "Token recuperado na consulta do feed", "format": "uuid", "example": "c74952c9-f181-4ea5-81d2-adeee74215c4" }, "type": { "type": "string", "description": "Tipo da notificação", "example": "ORDER" } } } }, "examples": { "Example 1": { "value": [ { "id": 188443520, "status": "PENDING", "token": "c74952c9-f181-4ea5-81d2-adeee74215c4", "type": "ORDER" }, { "id": 188443520, "status": "PENDING", "token": "c74952c9-f181-4ea5-81d2-adeee74215c4", "type": "ORDER" } ] }, "stoplight-Example 1": { "value": [ { "id": 188443520, "status": "PAID_WAITING_SHIP", "token": "c74952c9-f181-4ea5-81d2-adeee74215c4", "type": "ORDER" }, { "id": 188443328, "status": "PAID_WAITING_SHIP", "token": "5238ba67-57b6-4097-9f75-14c3b2ae6a78", "type": "ORDER" } ] } } } }, "description": "Dados para atualização do feed" }, "parameters": [] }, "parameters": [] }, "/transmissions/feeds": { "get": { "summary": "/transmissions/feeds", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "maxItems": 10, "items": { "$ref": "#/components/schemas/TransmissionsFeed" } } } } } }, "operationId": "get-transmissions-feeds", "description": "# Retrieve E-commerce Transmissions Updates\nWhenever there is a new Transmission or an Transmission Update on E-commerce on ANYMARKET, it will be included as a new item in the Feed and this item will be available for 30 days. The request will return 10 random available items.", "tags": [ "Feed transmissão" ], "parameters": [ { "$ref": "#/components/parameters/limit" } ] }, "parameters": [] }, "/transmissions/feeds/{id}": { "put": { "summary": "/transmissions/feeds/{id}", "operationId": "put-transmissions-feeds-id", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "description": "# Set Transmission Feed Item as Read\nThe Feed must be set as Read after retrieving the Transmission Update successfully. If not set as read it'll keep showing up on the request response.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "token": { "type": "string", "minLength": 1, "format": "uuid", "description": "Token recuperado na consulta do feed" } }, "required": [ "token" ] }, "examples": { "example-1": { "value": { "token": "string" } } } } }, "description": "Dados para atualização do feed" }, "tags": [ "Feed transmissão" ] }, "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "Transmission ID generated by ANYMARKET" } ] }, "/transmissions/feeds/batch": { "put": { "summary": "/transmissions/feeds/batch", "operationId": "put-transmissions-feeds-batch", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "description": "# Marca vários feeds de transmissão como processados de uma vez\nApós consulta de diversas transmissões através do feed, é preciso marcá-los como lidos. Caso não sejam marcados, continuarão retornandos na consulta. Por este endpoint é possível fazer a confirmação de leitura em massa de vários pedidos.\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.\n>\n> Campos omitidos podem ser redefinidos ou apagados.\n>\n> Use este método quando quiser sobrescrever todas as informações.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "token", "type" ], "properties": { "id": { "type": "integer", "description": "Id da notificação de transmissão", "example": 188443520 }, "status": { "type": "string", "description": "Evento que originou a transmissão", "example": "CREATED" }, "token": { "type": "string", "description": "Token recuperado na consulta do feed", "format": "uuid", "example": "c74952c9-f181-4ea5-81d2-adeee74215c4" }, "type": { "type": "string", "description": "Tipo da notificação", "example": "TRANSMISSIONS" } } } }, "examples": { "Example 1": { "value": [ { "id": 188443520, "status": "CREATE", "token": "c74952c9-f181-4ea5-81d2-adeee74215c4", "type": "TRANSMISSION" }, { "id": 188443520, "status": "UPDATE", "token": "c74952c9-f181-4ea5-81d2-adeee74215c4", "type": "TRANSMISSION" } ] }, "stoplight-Example 1": { "value": [ { "id": 188443520, "status": "PAID_WAITING_SHIP", "token": "c74952c9-f181-4ea5-81d2-adeee74215c4", "type": "ORDER" }, { "id": 188443328, "status": "PAID_WAITING_SHIP", "token": "5238ba67-57b6-4097-9f75-14c3b2ae6a78", "type": "ORDER" } ] } } } }, "description": "Dados para atualização do feed de transmissão" }, "parameters": [], "tags": [ "Feed transmissão" ] }, "parameters": [] }, "/transmissions-price/feeds": { "get": { "summary": "/transmissions-price/feeds", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "maxItems": 10, "items": { "$ref": "#/components/schemas/TransmissionsPriceFeed" } } } } } }, "operationId": "get-transmissions-price-feeds", "description": "# Consulta as alterações de preço nas transmissões\nQuando uma alteração de preço de transmissão é realizada no ANYMARKET, o mesmo é disponibilizado para consulta través desse feed e fica disponível por 30 dias (se foi lido, 30 dias a partir da data de leitura, se não foi lido, 30 dias a partir da data de edição.). \n\n\nO caso não informado um limit o resultado da consulta de feed retorna 100 itens disponíveis aleatóriamente\n\n\n> #### Atenção!\n>\n> Só serão retornadas as operações configuradas pelo seller no painel do ANYMARKET.\n\nApós leitura dos itens dos FEED, é necessário realizar um PUT para confirmar a leitura.", "tags": [ "Feed preço de transmissão" ], "parameters": [ { "$ref": "#/components/parameters/limit" } ] }, "parameters": [] }, "/transmissions-price/feeds/{id}": { "put": { "summary": "/transmissions-price/feeds/{id}", "operationId": "put-transmissions-price-feeds-id", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "description": "# Marca o feed como processado\nApós consulta da atualização de preço nas transmissões através do feed, é preciso marcá-lo como lido. Caso não seja marcado, o mesmo continuará a ser trazido na consulta.\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "token": { "type": "string", "minLength": 1, "format": "uuid", "description": "Token recuperado na consulta do feed" } }, "required": [ "token" ] }, "examples": { "example-1": { "value": { "token": "string" } } } } }, "description": "Dados de identificação do feed que será marcado como lido" }, "tags": [ "Feed preço de transmissão" ] }, "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "ID da notificação gerado pelo ANYMARKET" } ] }, "/transmissions-price/feeds/batch": { "put": { "summary": "/transmissions-price/feeds/batch", "operationId": "put-transmissions-price-feeds-batch", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "description": "# Marca vários feeds de atualização de preço nas transmissões como processados em lote\nApós consulta de diversas atualização de preço nas transmissões através do feed, é preciso marcá-los como lidos. Caso não sejam marcados, continuarão retornandos na consulta. Por este endpoint é possível fazer a confirmação de leitura em massa de vários transmissões.\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "token" ], "properties": { "id": { "type": "integer", "description": "Id da notificação de transmissão", "example": 188443520 }, "token": { "type": "string", "description": "Token recuperado na consulta do feed", "format": "uuid", "example": "c74952c9-f181-4ea5-81d2-adeee74215c4" } } } }, "examples": { "Example 1": { "value": [ { "id": 188443520, "token": "c74952c9-f181-4ea5-81d2-adeee74215c4" }, { "id": 188443520, "token": "c74952c9-f181-4ea5-81d2-adeee74215c4" } ] }, "stoplight-Example 1": { "value": [ { "id": 188443520, "token": "c74952c9-f181-4ea5-81d2-adeee74215c4" }, { "id": 188443328, "token": "5238ba67-57b6-4097-9f75-14c3b2ae6a78" } ] } } } }, "description": "Dados de identificação do feed que será marcado como lido" }, "parameters": [], "tags": [ "Feed preço de transmissão" ] }, "parameters": [] }, "/reservations/feeds": { "get": { "summary": "/reservations/feeds", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 13 }, "token": { "type": "string", "example": "5238ba67-57b6-4097-9f75-14c3b2ae6a78" } } } } } } }, "operationId": "get-reservations-feeds", "description": "# Consulta todos as reservas de estoque alteradas\nQuando uma reserva de estoque é criada ou alterada no ANYMARKET, a mesmo é disponibilizada para consulta través desse feed e fica disponível por 30 dias (se foi lido, 30 dias a partir da data de leitura, se não foi lido, 30 dias a partir da data de criação/edição.). \n\n\nO caso não informado um limit o resultado da consulta de feed retorna 100 itens disponíveis aleatóriamente\n\n\n> #### Atenção!\n>\n> Só serão retornadas as operações configuradas pelo seller no painel do ANYMARKET.\n\nApós leitura dos itens dos FEED, é necessário realizar um PUT para confirmar a leitura.", "parameters": [ { "$ref": "#/components/parameters/limit" } ], "tags": [ "Feed reserva" ] }, "parameters": [] }, "/reservations/feeds/{id}": { "put": { "summary": "/reservations/feeds/{id}", "operationId": "put-reservations-feeds-id", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "description": "# Marca o feed como processado\nApós consulta da reserva através do feed, é preciso marcá-lo como lido. Caso não seja marcado, o mesmo continuará a ser trazido na consulta.\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.\n>\n> Campos omitidos podem ser redefinidos ou apagados.\n>\n> Use este método quando quiser sobrescrever todas as informações.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "token": { "type": "string", "minLength": 1, "format": "uuid", "description": "Token recuperado na consulta do feed" } }, "required": [ "token" ] }, "examples": { "example-1": { "value": { "token": "string" } } } } }, "description": "Dados para atualização do feed" }, "tags": [ "Feed reserva" ] }, "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "ID do SKU gerado pelo ANYMARKET" } ] }, "/reservations/feeds/batch": { "put": { "summary": "/reservations/feeds/batch", "operationId": "put-reservations-feeds-batch", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "description": "# Marca vários feeds de reserva de estoque como processados de uma vez\nApós consulta de diversas reservas de estoque através do feed, é preciso marcá-los como lidos. Caso não sejam marcados, continuarão retornandos na consulta. Por este endpoint é possível fazer a confirmação de leitura em massa de vários pedidos.\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.\n>\n> Campos omitidos podem ser redefinidos ou apagados.\n>\n> Use este método quando quiser sobrescrever todas as informações.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "token", "type" ], "properties": { "id": { "type": "integer", "description": "Id da notificação de reserva de estoque", "example": 188443520 }, "status": { "type": "string", "description": "Evento da reserva", "example": "CREATED" }, "token": { "type": "string", "description": "Token recuperado na consulta do feed", "format": "uuid", "example": "c74952c9-f181-4ea5-81d2-adeee74215c4" }, "type": { "type": "string", "description": "Tipo da notificação", "example": "STOCK_RESERVATION" } } } }, "examples": { "Example 1": { "value": [ { "id": 188443520, "status": "CREATE", "token": "c74952c9-f181-4ea5-81d2-adeee74215c4", "type": "STOCK_RESERVATION" }, { "id": 188443520, "status": "UPDATE", "token": "c74952c9-f181-4ea5-81d2-adeee74215c4", "type": "STOCK_RESERVATION" } ] }, "stoplight-Example 1": { "value": [ { "id": 188443520, "status": "PAID_WAITING_SHIP", "token": "c74952c9-f181-4ea5-81d2-adeee74215c4", "type": "ORDER" }, { "id": 188443328, "status": "PAID_WAITING_SHIP", "token": "5238ba67-57b6-4097-9f75-14c3b2ae6a78", "type": "ORDER" } ] } } } }, "description": "Dados para atualização do feed de transmissão" }, "parameters": [], "tags": [ "Feed reserva" ] }, "parameters": [] }, "/freight/quotes": { "post": { "summary": "/freight/quotes", "operationId": "post-freight-quotes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FreightResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Freight Prices Quotes\nFreight prices quotes for the informed object.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FreightRequest" } } } }, "tags": [ "Cotar Frete" ] } }, "/products/{productId}/images": { "parameters": [ { "schema": { "type": "integer" }, "name": "productId", "in": "path", "required": true, "description": "ID do produto gerado pelo ANYMARKET" } ], "get": { "summary": "/products/{productId}/images", "tags": [ "Imagem" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Image" } }, "examples": { "example-1": { "value": [ { "id": 0, "index": 0, "main": true, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "string", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": -2147483648, "standardHeight": -2147483648, "originalWidth": -2147483648, "originalHeight": -2147483648 } ] } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "operationId": "get-products-productId-images", "description": "# Retrieve All Product Images\nRetrieves all images of the informed Product." }, "post": { "summary": "/products/{productId}/images", "operationId": "post-products-productId-images", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da imagem gerado pelo ANYMARKET" }, "index": { "type": "integer", "description": "Índice da imagem, ou seja, posição da imagem no cadastro no produto; inicia-se em 1 e limita-se a quantidade de imagens no produto" }, "main": { "type": "boolean", "description": "Determina se a imagem é principal" }, "url": { "type": "string", "description": "URL original da imagem" }, "variation": { "type": "string", "description": "Valor de Variação da Imagem" }, "status": { "type": "string", "description": "Determina qual é o status da imagem", "enum": [ "UNPROCESSED", "PROCESSED", "ERROR" ] }, "standardWidth": { "type": "integer", "description": "Dimensão padrão de largura da imagem" }, "standardHeight": { "type": "integer", "description": "Dimensão padrão de altura da imagem" }, "originalWidth": { "type": "integer", "description": "Dimensão original de largura da imagem" }, "originalHeight": { "type": "integer", "description": "Dimensão original de altura da imagem" } } }, "examples": { "example-1": { "value": { "id": 0, "index": 0, "main": true, "url": "string", "variation": "string", "status": "UNPROCESSED", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } }, "stoplight-example-1": { "value": { "id": 2523770137, "index": 2, "main": true, "url": "https://static.netshoes.com.br/produtos/bola-de-futebol-campo-nike-mercurial-fade/58/HZM-1897-058/HZM-1897-058_zoom3.jpg?ts=1564483160&ims=544x", "variation": "Azul", "status": "UNPROCESSED", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } } } }, "application/xml": { "schema": { "type": "object", "properties": {} }, "examples": { "example-1": { "value": {} } } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Create Image\n Creates an Image using the informed data. If an index is informed, ANYMARKET will keep that index (always keeping the index within the image quantity informed for the product). Otherwise, a index sequence will be set starting at 1. If an image is informed as 'main', ANYMARKET will check if there's no other image set as main. If there's other image set as main, an error will be returned on the request.\n\n## `useCase` parameter\nDefines the image's use case/classification for the product. Possible values:\n\n| Code | Description |\n| --- | --- |\n| `PRODUCT_IMAGE` | Product |\n| `SIZE_CHART_IMAGE` | Size Chart |\n| `CERTIFICATION_IMAGE` | Product Label |\n\nOptional field; if omitted, the image does not receive a use case classification.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImagePost" }, "examples": { "example-1": { "value": { "index": 0, "main": true, "url": "string", "variation": "string", "useCase": "SIZE_CHART_IMAGE" } } } } } }, "tags": [ "Imagem" ] }, "put": { "summary": "/products/{productId}/images", "operationId": "put-products-productId-images", "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Update the Index or the main Image\nIf the given Index is greater than the image quantity, the operation will be ignored. If the given Index is the same as any other image of the product, the Indexes will be switched. If the image is updated to 'main' and there's already another image set as 'main', the updated image will be the new 'main' and the other one won't be the 'main' anymore.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImagePut" }, "examples": { "example-1": { "value": { "id": 0, "index": 0, "main": true } } } } } }, "tags": [ "Imagem" ] } }, "/products/{productId}/images/{imageId}": { "parameters": [ { "schema": { "type": "integer" }, "name": "productId", "in": "path", "required": true, "description": "ID do produto gerado pelo ANYMARKET" }, { "schema": { "type": "integer" }, "name": "imageId", "in": "path", "required": true, "description": "ID da imagem gerado pelo ANYMARKET" } ], "get": { "summary": "/products/{productId}/images/{imageId}", "tags": [ "Imagem" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Image" } }, "examples": { "example-1": { "value": [ { "id": 0, "index": 0, "main": true, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "string", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": -2147483648, "standardHeight": -2147483648, "originalWidth": -2147483648, "originalHeight": -2147483648 } ] } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "operationId": "get-products-productId-images-imageId", "description": "# Retrieve Image Details\nRetrieves the details of the informed image." }, "delete": { "summary": "/products/{productId}/images/{imageId}", "operationId": "delete-products-productId-images-imageId", "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "description": "# Delete Image\nDeletes the informed image.", "tags": [ "Imagem" ] } }, "/products/{productId}/images/reorder": { "parameters": [ { "schema": { "type": "integer" }, "name": "productId", "in": "path", "required": true, "description": "ID do produto no ANYMARKET" }, { "schema": { "type": "string" }, "name": "x-module-origin", "in": "header", "required": false, "description": "Origem do módulo que realizou a chamada" } ], "put": { "summary": "/products/{productId}/images/reorder", "tags": [ "Imagem" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "Lista de imagens do produto no estado pós-reorder", "items": { "$ref": "#/components/schemas/Image" } }, "examples": { "example-1": { "value": [ { "id": 470739, "index": 1 }, { "id": 470738, "index": 2 }, { "id": 470736, "index": 3 }, { "id": 470735, "index": 4 } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } } }, "operationId": "put-products-images-reorder", "description": "# Reordena imagens\nReordena todas as imagens de um produto de forma atômica, respeitando a mesma quantidade já cadastrada.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "Lista de grupos de imagens a reordenar, um grupo por variação", "items": { "type": "object", "properties": { "variation": { "type": "string", "description": "Descrição da variação à qual o grupo de imagens pertence. Quando omitido, o grupo se refere às imagens sem variação. Deve bater exatamente (case-sensitive) com a variação existente no produto" }, "images": { "type": "array", "description": "Imagens do grupo e sua nova posição", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da imagem", "minimum": 0 }, "index": { "type": "integer", "description": "Posição da imagem dentro do grupo (1..N, relativo ao grupo)", "minimum": 1 } }, "required": [ "id", "index" ] } } }, "required": [ "images" ] } }, "examples": { "example-1": { "value": [ { "variation": "branco", "images": [ { "id": 470739, "index": 1 }, { "id": 470738, "index": 2 } ] }, { "images": [ { "id": 470736, "index": 1 }, { "id": 470735, "index": 2 } ] } ] } } } }, "description": "" }, "security": [ { "gumgaToken": [] } ] } }, "/messages/order/{id}": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "ID do pedido fornecido pelo ANYMARKET" } ], "post": { "summary": "/messages/order/{id}", "tags": [ "Mensageria" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Texto da mensagem para o comprador do pedido" } } } } } }, "400": { "description": "Bad Request" } }, "operationId": "get-messages-order-id", "description": "# Send Message to Mercado Livre's Buyer of the Order\nSends a message to the buyer of the order on Mercado Livre.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "message": { "type": "string", "minLength": 1 } }, "required": [ "message" ] }, "examples": { "example-1": { "value": { "message": "string" } } } } }, "description": "Mensagem para o comprador" } } }, "/monitorings": { "post": { "summary": "/monitorings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "partnerId", "origin", "message", "createdAt", "type", "status" ], "properties": { "partnerId": { "type": "string", "description": "ID do monitoramento - controle no parceiro", "minLength": 1 }, "origin": { "type": "string", "description": "Nome do integrador", "minLength": 1 }, "message": { "type": "string", "description": "Resumo da mensagem de erro", "minLength": 1, "maxLength": 500 }, "details": { "type": "string", "description": "Detalhes da mensagem de erro", "minLength": 1, "maxLength": 4000 }, "createdAt": { "type": "string", "description": "Data de entrada do registro" }, "type": { "type": "string", "description": "Tipo de monitoramento", "enum": [ "ALERT", "INTERNAL_ERROR", "CRITICAL_ERROR" ] }, "retryCallbackURL": { "type": "string", "description": "URL da API do integrador" }, "status": { "type": "string", "description": "Tipo de satus do monitoramento", "enum": [ "PENDING", "RETRYING", "CANCELLED", "CONCLUED" ] } } }, "examples": { "example-1": { "value": { "partnerId": "order-1", "origin": "ERP", "message": "Erro ao importar pedido 1", "details": "Erro ao importar pedido 1 por falta do mapegamento de transportadora.", "createdAt": "2021-11-25T20:30:00-03:00", "type": "CRITICAL_ERROR", "retryCallbackURL": "https//callback.meusite.meu/orders/1", "status": "PENDING" } }, "stoplight-example-1": { "value": { "partnerId": "string", "origin": "string", "message": "string", "details": "string", "createdAt": "2019-08-24T14:15:22Z", "type": "ALERT", "retryCallbackURL": "http://example.com", "status": "PENDING" } } } } } } }, "operationId": "post-monitorings", "description": "# Create Monitoring Record\nCreates a record for monitoring.", "tags": [ "Monitoramento de Erro" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringPost" }, "examples": { "Example 1": { "value": { "partnerId": "order-1", "origin": "ERP", "message": "Erro ao importar pedido 1", "details": "Erro ao importar pedido 1 por falta do mapegamento de transportadora.", "createdAt": "2021-11-25T20:30:00-03:00", "type": "CRITICAL_ERROR", "retryCallbackURL": "https://callback.meusite.meu/orders/1", "status": "PENDING" } } } } } } } }, "/monitorings/{id}": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "ID do monitoramento gerado pelo ANYMARKET" } ], "put": { "summary": "/monitorings/{id}", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Monitoring" } } } } }, "operationId": "put-monitorings-id", "description": "# Update Monitored Record Data\nUpdates the data of a monitored record.", "tags": [ "Monitoramento de Erro" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringPut" } } } }, "x-internal": true, "x-stoplight": { "id": "2mdj8q4hlsa0s" } } }, "/orders": { "get": { "tags": [ "Pedido" ], "summary": "/orders", "description": "# Retrieve Order\nRetrieves Orders details.\n\n> The query can be performed using the filters provided in the request. If no filters are specified, the response will be limited to records created within the last 120 days.\n\n> When the createdAfter (creation start date) and createdBefore (creation end date) parameters are provided, the system will validate whether the requested interval is within the maximum limit of 120 days.\n\n> If only the createdAfter parameter is provided, the records returned will correspond to the period between the specified start date and the maximum limit of 120 days from that date.\n\n> If only the createdBefore parameter is provided, the records returned will correspond to the period between the specified end date and the maximum limit of 120 days backwards.\n\n> When the updatedAfter (updated after) and updatedBefore (updated before) parameters are provided, the system will validate whether the requested interval is within the maximum limit of 7 days.\n\n> If no filters are provided and the data volume exceeds 30,000 records, the totalElements field will be returned with an approximate value for performance reasons.\n", "parameters": [ { "name": "createdAfter", "in": "query", "description": "Created After", "required": false, "schema": { "type": "string", "format": "date-time", "example": "2021-11-25T14:00:00-03:00" } }, { "name": "createdBefore", "in": "query", "description": "Created Before", "required": false, "schema": { "type": "string", "format": "date-time", "example": "2021-11-25T20:30:00-03:00" } }, { "name": "status", "in": "query", "description": "Parameter used to filter for the orders status.", "schema": { "type": "string", "enum": [ "PENDING", "DELIVERY_ISSUE", "PAID_WAITING_SHIP", "INVOICED", "PAID_WAITING_DELIVERY", "CONCLUDED", "CANCELED" ] } }, { "$ref": "#/components/parameters/marketplaceQuery" }, { "name": "marketplaceId", "in": "query", "description": "Parameter used to filter for the marketplace Order ID.", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/sortDirection" }, { "schema": { "type": "string" }, "in": "query", "name": "partnerId", "description": "Atributo para filtrar pelo ID do Pedido no Integrador" }, { "schema": { "type": "string" }, "in": "query", "name": "shippingId", "description": "Id de envio do marketplace, utilizado para otimizar a consulta de pedidos Mercado Livre" }, { "schema": { "type": "string", "format": "date-time", "example": "2021-11-25T14:00:00-03:00" }, "in": "query", "name": "updatedAfter", "description": "Updated After" }, { "schema": { "type": "string", "format": "date-time", "example": "2021-11-25T20:30:00-03:00" }, "in": "query", "name": "updatedBefore", "description": "Updated Before" } ], "operationId": "get-orders", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_Order" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" }, "examples": { "Example 1": { "value": { "code": "422", "message": "O parâmetro '%s' com a data informada '%s', está em formato incorreto. Por favor verificar a documentação" } } } } } } }, "requestBody": { "content": {} } }, "post": { "summary": "/orders", "operationId": "post-orders", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" }, "examples": { "example-1": { "value": { "id": 0, "accountName": "string", "marketPlaceId": "string", "marketPlaceNumber": "string", "partnerId": "string", "marketPlace": "string", "subChannel": "string", "subChannelNormalized": "string", "createdAt": "2019-08-24T14:15:22Z", "paymentDate": "2019-08-24T14:15:22Z", "cancelDate": "2019-08-24T14:15:22Z", "shippingOptionId": "string", "transmissionStatus": "string", "status": "PENDING", "marketPlaceStatus": "string", "marketPlaceStatusComplement": "string", "documentIntermediator": "string", "intermediateRegistrationId": "string", "documentPaymentInstitution": "string", "fulfillment": true, "discount": 0, "freight": 0, "interestValue": 0, "gross": 0, "total": 0, "marketPlaceUrl": "string", "marketPlaceShipmentStatus": "string", "invoice": { "accessKey": "string", "series": "string", "number": "string", "date": "2019-08-24T14:15:22Z", "cfop": "string", "companyStateTaxId": "string", "linkNfe": "string", "invoiceLink": "string", "extraDescription": "string" }, "shipping": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "address": "string", "number": "string", "neighborhood": "string", "street": "string", "comment": "string", "reference": "string", "zipCode": "string", "receiverName": "string", "promisedShippingTime": "2019-08-24T14:15:22Z" }, "billingAddress": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "street": "string", "number": "string", "neighborhood": "string", "comment": "string", "reference": "string", "zipCode": "string" }, "anymarketAddress": { "state": "string", "city": "string", "zipCode": "string", "neighborhood": "string", "address": "string", "street": "string", "number": "string", "comment": "string", "reference": "string", "receiverName": "string", "promisedShippingTime": "string" }, "buyer": { "marketPlaceId": "string", "name": "string", "email": "string", "document": "string", "documentType": "string", "phone": "string", "cellPhone": "string", "documentNumberNormalized": "string" }, "payments": [ { "method": "string", "status": "string", "value": 0, "installments": 0, "marketplaceId": "string", "gatewayFee": 0, "marketplaceFee": 0, "paymentMethodNormalized": "string", "paymentDetailNormalized": "string" } ], "items": [ { "product": { "id": 0, "title": "string" }, "sku": { "id": 0, "title": "string", "partnerId": "string", "externalId": "string", "ean": "string" }, "amount": 0, "unit": 0, "gross": 0, "total": 0, "discount": 0, "discountItemMetadata": [ { "type": "COUPON", "discountProductSeller": 5 } ], "shippings": [ { "id": 0, "shippingtype": "string", "shippingCarrierNormalized": "string", "shippingCarrierTypeNormalized": "string" } ], "stocks": [ { "stockLocalId": 0, "stockName": "string", "amount": 0 } ], "marketPlaceId": "string", "orderItemId": "string", "idInMarketPlace": "string", "officialStoreId": "string", "officialStoreName": "string", "listingType": "string", "freeShipping": true }, { "product": { "id": 1, "title": "string" }, "sku": { "id": 1, "title": "string", "partnerId": "string", "externalId": "string", "ean": "string" }, "amount": 0, "unit": 0, "gross": 0, "total": 0, "discount": 0, "discountItemMetadata": [ { "type": "FREE_ITEM", "discountProductMarketplace": 8 } ], "marketPlaceId": "string", "orderItemId": "string", "idInMarketPlace": "string", "officialStoreId": "string", "officialStoreName": "string", "listingType": "string", "freeShipping": true } ], "tracking": { "url": "string", "number": "string", "carrier": "string", "carrierDocument": "string", "date": "2019-08-24T14:15:22Z", "deliveredDate": "2019-08-24T14:15:22Z", "estimateDate": "2019-08-24T14:15:22Z", "shippedDate": "2019-08-24T14:15:22Z" }, "deliverStatus": "UNKNOWN", "idAccount": 0, "pickup": { "id": 0, "description": "string", "partnerId": 0, "marketplaceId": "string", "receiverName": "string" }, "metadata": { "number-of-packages": "1", "cdZipCode": "string", "needInvoiceXML": "true" }, "discountMetadata": [ { "type": [ "COUPON" ], "discountDetails": [ { "type": "COUPON", "discountOrderSeller": 10, "discountOrderMarketplace": 5.9 } ] } ] } } } } } } }, "description": "# Create Order\nCreates a Order with the informed data. Usually used by E-commerce partners.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostOrder" }, "examples": { "example-1": { "value": { "id": 0, "accountName": "string", "marketPlaceId": "string", "marketPlaceNumber": "string", "partnerId": "string", "marketPlace": "string", "subChannel": "string", "subChannelNormalized": "string", "createdAt": "2022-02-24T14:15:22Z", "paymentDate": "2022-02-24T14:15:22Z", "cancelDate": "2022-02-24T14:15:22Z", "shippingOptionId": "string", "transmissionStatus": "string", "status": "PENDING", "marketPlaceStatus": "string", "marketPlaceStatusComplement": "string", "documentIntermediator": "string", "intermediateRegistrationId": "string", "documentPaymentInstitution": "string", "fulfillment": true, "discount": 0, "freight": 0, "interestValue": 0, "gross": 0, "total": 0, "marketPlaceUrl": "string", "marketPlaceShipmentStatus": "string", "invoice": { "accessKey": "string", "series": "string", "number": "string", "date": "2022-02-24T14:15:22Z", "cfop": "string", "companyStateTaxId": "string", "linkNfe": "string", "invoiceLink": "string", "extraDescription": "string" }, "shipping": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "address": "string", "number": "string", "neighborhood": "string", "street": "string", "comment": "string", "reference": "string", "zipCode": "string", "receiverName": "string", "promisedShippingTime": "2019-08-24T14:15:22Z" }, "billingAddress": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "street": "string", "number": "string", "neighborhood": "string", "comment": "string", "reference": "string", "zipCode": "string" }, "anymarketAddress": { "state": "string", "city": "string", "zipCode": "string", "neighborhood": "string", "address": "string", "street": "string", "number": "string", "comment": "string", "reference": "string", "receiverName": "string", "promisedShippingTime": "string" }, "buyer": { "marketPlaceId": "string", "name": "string", "email": "string", "document": "string", "documentType": "string", "phone": "string", "cellPhone": "string", "documentNumberNormalized": "string" }, "payments": [ { "method": "string", "status": "string", "value": 0, "installments": 0, "marketplaceId": "string", "gatewayFee": 0, "marketplaceFee": 0, "paymentMethodNormalized": "string", "paymentDetailNormalized": "string" } ], "items": [ { "product": { "id": 0, "title": "string" }, "sku": { "id": 0, "title": "string", "partnerId": "string", "externalId": "string", "ean": "string" }, "amount": 0, "unit": 0, "gross": 0, "total": 0, "discount": 0, "discountItemMetadata": [ { "type": "COUPON", "discountProductSeller": 5 } ], "shippings": [ { "id": 0, "shippingtype": "string", "shippingCarrierNormalized": "string", "shippingCarrierTypeNormalized": "string" } ], "stocks": [ { "stockLocalId": 0, "stockName": "string", "amount": 0 } ], "marketPlaceId": "string", "orderItemId": "string", "idInMarketPlace": "string", "officialStoreId": "string", "officialStoreName": "string", "listingType": "string", "freeShipping": true }, { "product": { "id": 1, "title": "string" }, "sku": { "id": 1, "title": "string", "partnerId": "string", "externalId": "string", "ean": "string" }, "amount": 0, "unit": 0, "gross": 0, "total": 0, "discount": 0, "discountItemMetadata": [ { "type": "FREE_ITEM", "discountProductMarketplace": 8 } ], "marketPlaceId": "string", "orderItemId": "string", "idInMarketPlace": "string", "officialStoreId": "string", "officialStoreName": "string", "listingType": "string", "freeShipping": true } ], "tracking": { "url": "string", "number": "string", "carrier": "string", "carrierDocument": "string", "date": "2019-08-24T14:15:22Z", "deliveredDate": "2019-08-24T14:15:22Z", "estimateDate": "2019-08-24T14:15:22Z", "shippedDate": "2019-08-24T14:15:22Z" }, "deliverStatus": "UNKNOWN", "idAccount": 0, "pickup": { "id": 0, "description": "string", "partnerId": 0, "marketplaceId": "string", "receiverName": "string" }, "metadata": { "number-of-packages": "1", "cdZipCode": "string", "needInvoiceXML": "true" }, "discountMetadata": [ { "type": [ "COUPON" ], "discountDetails": [ { "type": "COUPON", "discountOrderSeller": 10, "discountOrderMarketplace": 5.9 } ] } ] } } } } }, "description": "" }, "tags": [ "Pedido" ] } }, "/orders/reservations": { "get": { "tags": [ "Pedido" ], "summary": "/orders/reservations", "description": "# Consulta Pedidos\nConsulta o pedido em reserva\n", "parameters": [ { "$ref": "#/components/parameters/marketplaceQuery" }, { "name": "marketplaceId", "in": "query", "description": "Atributo para filtrar pelo ID do Pedido no Marketplace", "required": false, "schema": { "type": "string" } } ], "operationId": "get-orders-reservations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "links": { "type": "array", "description": "Referências de paginação", "minItems": 1, "maxItems": 1, "items": { "type": "object", "properties": { "rel": { "type": "string", "description": "Relacionamento do hyperlink", "example": "next" }, "href": { "type": "string", "description": "URL de definição do recurso", "example": "https://.../v2/component?limit=5&offset=5" } } } }, "content": { "type": "array", "description": "Lista de pedidos", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID do pedido gerado pelo ANYMARKET" }, "accountName": { "type": "string", "description": "Identificador da conta do Marketplace" }, "marketPlaceId": { "type": "string", "description": "ID interno do pedido no marketplace" }, "marketPlaceNumber": { "type": "string", "description": "ID público do pedido no marketplace" }, "partnerId": { "type": "string", "description": "Código do pedido no parceiro. Uma vez informado, não poderá ser alterado" }, "marketPlace": { "type": "string", "description": "Descritivo de qual marketplace o pedido pertence" }, "subChannel": { "type": "string", "description": "Site onde foi realizado o pedido (conforme recebido pelo marketplace. Pode ser nulo caso o marketplace não possua subcanal)" }, "subChannelNormalized": { "type": "string", "description": "Site onde foi realizado o pedido (normalizado pelo ANYMARKET. Pode ser nulo)" }, "createdAt": { "type": "string", "description": "Data de criação do pedido" }, "paymentDate": { "type": "string", "description": "Data de pagamento do pedido" }, "cancelDate": { "type": "string", "description": "Data de cancelamento do pedido" }, "shippingOptionId": { "type": "string", "description": "ID do Envio de cada Marketplace" }, "transmissionStatus": { "type": "string", "description": "Status da transmissão\n\nOK: Pedido sincronizado com sucesso com o Marketplace\nERROR: Ocorreu erro na sincronização com o Marketplace\nWAITING: Aguardando sincronização com o Marketplace", "enum": [ "OK", "ERROR", "WAITING" ] }, "status": { "type": "string", "description": "Status do pedido\n\nCONCLUDED: Pedido entregue (é a última situação do pedido). Mudando para essa situação é necessário informar: data de entrega\nCANCELED: Cancelado\nINVOICED: Faturado. Mudando para essa situação é necessário informar: número da nota, número de série, data de emissão e chave de acesso\nPAID_WAITING_DELIVERY: Enviado (aguardando entrega). Mudando para essa situação é necessário informar: URL de rastreamento, número de rastreio, nome da transportadora, data de envio\nPAID_WAITING_SHIP: Pago (está aguardando envio)\nPENDING: Pendente (Ainda não foi pago. Existe parâmetro para que o ANYMARKET importe do MarketPlace o pedido que ainda não foi pago)", "enum": [ "PENDING", "DELIVERY_ISSUE", "PAID_WAITING_SHIP", "INVOICED", "PAID_WAITING_DELIVERY", "CONCLUDED", "CANCELED" ] }, "marketPlaceStatus": { "type": "string", "description": "Situação do pedido no marketplace. Cada marketplace possui situações diferentes. Ex: no mercado livre não existe a situação faturado" }, "marketPlaceStatusComplement": { "type": "string", "description": "Informação complementar à situação do pedido no marketplace. Cada marketplace possui situações diferentes. Ex: na Dafiti o pedido pode ser marcado como falha de entrega e a causa pode ser armazenada nesse atributo" }, "documentIntermediator": { "type": "string", "description": "Identificador de intermediador da Transação CNPJ" }, "intermediateRegistrationId": { "type": "string", "description": "Identificador do cadastro (vendedor ou usuário) no intermediador" }, "documentPaymentInstitution": { "type": "string", "description": "Identificador de Instituição de pagamento CNPJ" }, "fulfillment": { "type": "boolean", "description": "Identifica se o pedido é fulfillment" }, "discount": { "type": "integer", "description": "Desconto do pedido" }, "freight": { "type": "integer", "description": "Valor de frete" }, "interestValue": { "type": "integer", "description": "Valor dos juros" }, "gross": { "type": "integer", "description": "Total bruto sem o valor de frete" }, "total": { "type": "integer", "description": "Total do pedido com o valor de frete" }, "marketPlaceUrl": { "type": "string", "description": "URL do pedido no Marketplace" }, "marketPlaceShipmentStatus": { "type": "string", "description": "Situação de envio do pedido no marketplace. Cada Marketplace possui situações diferentes" }, "invoice": { "type": "object", "properties": { "accessKey": { "type": "string", "description": "Chave de acesso da nota fiscal" }, "series": { "type": "string", "description": "Número de série da nota fiscal" }, "number": { "type": "string", "description": "Número da nota fiscal" }, "date": { "type": "string", "description": "Data de emissão da nota fiscal (Necessário informar o fuso horario)" }, "cfop": { "type": "string", "description": "Código Fiscal de Operações e Prestações, esse campo será obrigátorio caso seja utilizado 'Mercado Envio Coleta'" }, "companyStateTaxId": { "type": "string", "description": "Inscrição Estadual quando o comprador é uma Pessoa Jurídica (CNPJ), esse campo será obrigátorio caso seja utilizado 'Mercado Envios Coleta'; é possível utilizar 'ISENTO'" }, "linkNfe": { "type": "string", "description": "Campo para inserir a URL para consulta da nota fiscal" }, "invoiceLink": { "type": "string", "description": "Campo para inserir a URL onde está armazenada o PDF ou o XML da nota fiscal (utilizado para a integração da Garbarino)" }, "extraDescription": { "type": "string", "description": "Campo para observações" }, "fiscalMetadata": { "type": "object", "description": "Metadados fiscais complementares da nota fiscal", "properties": { "operationType": { "type": "string", "description": "Tipo de operação fiscal (ex.: entrada, saida)" }, "emissionType": { "type": "string", "description": "Tipo de emissão da nota fiscal (ex.: normal, contingencia)" }, "authorizationProtocol": { "type": "string", "description": "Protocolo de autorização da nota fiscal" } } } }, "required": [ "accessKey", "date" ] }, "shipping": { "type": "object", "required": [ "city", "state", "stateNameNormalized", "country", "countryAcronymNormalized", "countryNameNormalized", "address", "number", "neighborhood", "street", "zipCode", "receiverName", "promisedShippingTime" ], "properties": { "city": { "type": "string", "description": "Cidade" }, "state": { "type": "string", "description": "Sigla do Estado padronizado internamente pelo ANYMARKET. Pode ser nulo se o state for nulo ou o valor enviado pelo Marketplace, se ele for desconhecido." }, "stateNameNormalized": { "type": "string", "description": "Nome do Estado padronizado internamente pelo ANYMARKET. Pode ser nulo se o state for nulo ou UNKNOWN para desconhecido." }, "country": { "type": "string", "description": "País (Campo original, cadastrado pelo Marketplace ou Ecommerce)" }, "countryAcronymNormalized": { "type": "string", "description": "Sigla do País padronizado internamente pelo ANYMARKET. Pode ser nulo se o country for nulo ou desconhecido." }, "countryNameNormalized": { "type": "string", "description": "Nome do País padronizado internamente pelo ANYMARKET. Pode ser nulo se o country for nulo ou UNKNOWN para desconhecido." }, "address": { "type": "string", "description": "Endereço" }, "number": { "type": "string", "description": "Número" }, "neighborhood": { "type": "string", "description": "Bairro" }, "street": { "type": "string", "description": "Rua" }, "comment": { "type": "string", "description": "Complemento" }, "reference": { "type": "string", "description": "Referência" }, "zipCode": { "type": "string", "description": "CEP" }, "receiverName": { "type": "string", "description": "Nome do remetente para entrega" }, "promisedShippingTime": { "type": "string", "description": "Data acordada para entrega" } } }, "billingAddress": { "type": "object", "properties": { "city": { "type": "string", "description": "Cidade" }, "state": { "type": "string", "description": "Sigla do Estado padronizado internamente pelo ANYMARKET. Pode ser nulo se o state for nulo ou o valor enviado pelo Marketplace, se ele for desconhecido." }, "stateNameNormalized": { "type": "string", "description": "Nome do Estado padronizado internamente pelo ANYMARKET. Pode ser nulo se o state for nulo ou UNKNOWN para desconhecido." }, "country": { "type": "string", "description": "País (Campo original, cadastrado pelo Marketplace ou Ecommerce)" }, "countryAcronymNormalized": { "type": "string", "description": "Sigla do País padronizado internamente pelo ANYMARKET. Pode ser nulo se o country for nulo ou desconhecido." }, "countryNameNormalized": { "type": "string", "description": "Nome do País padronizado internamente pelo ANYMARKET. Pode ser nulo se o country for nulo ou UNKNOWN para desconhecido." }, "street": { "type": "string", "description": "Rua" }, "number": { "type": "string", "description": "Número" }, "neighborhood": { "type": "string", "description": "Bairro" }, "comment": { "type": "string", "description": "Complemento" }, "reference": { "type": "string", "description": "Referência" }, "zipCode": { "type": "string", "description": "CEP" } }, "required": [ "city", "state", "stateNameNormalized", "country", "countryAcronymNormalized", "countryNameNormalized", "street", "number", "neighborhood", "zipCode" ] }, "anymarketAddress": { "type": "object", "required": [ "state", "city", "zipCode", "neighborhood", "address", "street", "number", "receiverName", "promisedShippingTime" ], "properties": { "state": { "type": "string", "description": "Sigla do Estado padronizado internamente pelo ANYMARKET. Pode ser nulo se o state for nulo ou o valor enviado pelo Marketplace, se ele for desconhecido." }, "city": { "type": "string", "description": "Cidade" }, "zipCode": { "type": "string", "description": "CEP" }, "neighborhood": { "type": "string", "description": "Bairro" }, "address": { "type": "string", "description": "Endereço" }, "street": { "type": "string", "description": "Rua" }, "number": { "type": "string", "description": "Número" }, "comment": { "type": "string", "description": "Complemento" }, "reference": { "type": "string", "description": "Referência" }, "receiverName": { "type": "string", "description": "Nome do remetente para entrega" }, "promisedShippingTime": { "type": "string", "description": "Data estimada de entrega" } } }, "buyer": { "type": "object", "required": [ "name", "email", "document", "documentType", "phone" ], "properties": { "marketPlaceId": { "type": "string", "description": "ID no marketplace. Essa informação pode não existir para algum marketplace ou ecommerce." }, "name": { "type": "string", "description": "Nome do comprador" }, "email": { "type": "string", "description": "E-mail do comprador" }, "document": { "type": "string", "description": "Número do documento. Essa informação pode não ser preenchida para algum Marketplace ou e-commerce." }, "documentType": { "type": "string", "description": "Tipo do documento. Valores possíveis: CPF, CNPJ, OTHER" }, "phone": { "type": "string", "description": "Telefone do comprador" }, "cellPhone": { "type": "string", "description": "Celular do comprador" }, "documentNumberNormalized": { "type": "string", "description": "Número do documento normalizado pelo ANYMARKET. Somente números. Caso o document não seja um CPF ou CNPJ este campo irá retornar nulo." } } }, "payments": { "type": "array", "description": "Dados referente a pagamento (Será enviado pelo Marketplace)", "items": { "type": "object", "properties": { "method": { "type": "string", "description": "Método de pagamento. (Campo original, enviado pelo Marketplace ou Ecommerce)" }, "status": { "type": "string", "description": "Status do pagamento enviado pelo marketplace" }, "value": { "type": "integer", "description": "Valor do pagamento (Em caso de cobrança de juros, o valor é adicionado ao total da compra. Ex: Mercado livre)" }, "installments": { "type": "integer", "description": "Número de parcelas do meio do pagamento. Deve-se dividir o número de parcelas pelo valor para encontrar o valor de cada parcela." }, "marketplaceId": { "type": "string", "description": "ID do pagamento enviado pelo marketplace. Alguns marketplaces não disponibilizam o id, podendo o valor estar nulo ou com um valor fixo \"1\" dependendo da regra. (Exemplo- Cnova sempre tem apenas um pagamento para a compra, então o id do pagamento pode ser sempre \"1\")" }, "gatewayFee": { "type": "integer", "description": "Taxa referente ao gateway de pagamento (Ex: MercadoPago)." }, "marketplaceFee": { "type": "integer", "description": "Taxa referente ao Marketplace." }, "paymentMethodNormalized": { "type": "string", "description": "Método de pagamento padronizado internamente pelo ANYMARKET. Caso for um valor desconhecido internamente irá retornar UNKNOWN. Se o method for nulo, este campo também será nulo." }, "paymentDetailNormalized": { "type": "string", "description": "Detalhamento do método de pagamento padronizado internamente pelo ANYMARKET. Caso for um valor desconhecido internamente irá retornar UNKNOWN. Se o method for nulo, este campo também será nulo." } }, "required": [ "method", "value" ] } }, "items": { "type": "array", "description": "Dados referente aos produtos comprados", "items": { "type": "object", "properties": { "product": { "type": "object", "required": [ "id", "title" ], "properties": { "id": { "type": "integer", "description": "ID do produto gerado pelo ANYMARKET" }, "title": { "type": "string", "description": "Título do produto", "maxLength": 150 } } }, "sku": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "partnerId": { "type": "string" }, "externalId": { "type": "string" }, "ean": { "type": "string" } } }, "amount": { "type": "integer", "description": "Quantidade do item" }, "unit": { "type": "integer", "description": "Preço do item" }, "gross": { "type": "integer", "description": "Valor bruto do item (amount * unit)" }, "total": { "type": "integer", "description": "Total do item com desconto aplicado (gross - discount)" }, "discount": { "type": "integer", "description": "Desconto do item" }, "shippings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "shippingtype": { "type": "string" }, "shippingCarrierNormalized": { "type": "string" }, "shippingCarrierTypeNormalized": { "type": "string" } } } }, "stocks": { "type": "array", "items": { "type": "object", "properties": { "stockLocalId": { "type": "integer" }, "stockName": { "type": "string" }, "amount": { "type": "integer" } } } }, "marketPlaceId": { "type": "string" }, "orderItemId": { "type": "string" }, "idInMarketPlace": { "type": "string" }, "officialStoreId": { "type": "string" }, "officialStoreName": { "type": "string" }, "listingType": { "type": "string" }, "freeShipping": { "type": "boolean" } }, "required": [ "product", "sku", "amount", "unit", "gross", "total", "discount" ] } }, "tracking": { "type": "object", "properties": { "url": { "type": "string", "description": "URL para o rastreamento" }, "number": { "type": "string", "description": "Número de rastreio" }, "carrier": { "type": "string", "description": "Nome da transportadora" }, "carrierDocument": { "type": "string", "description": "CNPJ da transportadora" }, "date": { "type": "string", "description": "Data do rastreio (Necessário informar o fuso horario)" }, "deliveredDate": { "type": "string", "description": "Data de entrega ao Cliente (Necessário informar o fuso horario)" }, "estimateDate": { "type": "string", "description": "Data estimada (Necessário informar o fuso horario)" }, "shippedDate": { "type": "string", "description": "Data em que foi entregue a transportadora (Necessário informar o fuso horario)" } }, "required": [ "estimateDate", "shippedDate" ] }, "deliverStatus": { "type": "string", "description": "Status do pedido\n\nUNKNOWN: Envio pendente\nIN_TRANSIT: Pedido Enviado DELIVERED: Pedido entregue", "enum": [ "UNKNOWN", "IN_TRANSIT", "DELIVERED", "HOLD_FOR_PICKUP", "DELAYED", "DELIVERED_LATE" ] }, "idAccount": { "type": "integer", "description": "ID da conta gerado automático pelo ANYMARKET" }, "pickup": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da loja no ANYMARKET" }, "description": { "type": "string", "description": "Nome da loja" }, "partnerId": { "type": "integer", "description": "Código da loja no parceiro" }, "marketplaceId": { "type": "string", "description": "ID da loja no marketplace" }, "receiverName": { "type": "string", "description": "Nome de quem retira o pedido na loja" } } }, "metadata": { "type": "object", "description": "Campos adicionais do pedido.", "properties": { "number-of-packages": { "type": "string", "description": "Quantidade de volumes para a impressão de etiqueta (B2W Nova Api)", "default": "1" }, "cdZipCode": { "type": "string", "description": "CEP do Centro de Distribuição referente ao CNPJ de faturamento do pedido" }, "needInvoiceXML": { "type": "string", "description": "Caso o marketplace exija a integração do arquivo XML com os dados de faturamento" }, "paymentConnector": { "type": "string", "description": "Informações de pagamento dos pedidos (VTEX Marketplace)" } } }, "": { "type": "string" } }, "required": [ "id", "accountName", "marketPlaceId", "marketPlaceNumber", "marketPlace", "createdAt", "marketPlaceStatus", "discount", "freight", "interestValue", "gross", "total", "shipping", "anymarketAddress", "buyer", "payments", "items", "deliverStatus", "idAccount" ] } }, "page": { "type": "object", "properties": { "size": { "type": "integer", "description": "Tamanho da página" }, "totalElements": { "type": "integer", "description": "Total de elementos existentes" }, "totalPages": { "type": "integer", "description": "Total de páginas disponíveis" }, "number": { "type": "integer", "description": "Número da página atual" } } } } }, "examples": { "example-1": { "value": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 0, "accountName": "string", "marketPlaceId": "string", "marketPlaceNumber": "string", "partnerId": "string", "marketPlace": "string", "subChannel": "string", "subChannelNormalized": "string", "createdAt": "2019-08-24T14:15:22Z", "paymentDate": "2019-08-24T14:15:22Z", "cancelDate": "2019-08-24T14:15:22Z", "shippingOptionId": "string", "transmissionStatus": "OK", "status": "PENDING", "marketPlaceStatus": "string", "marketPlaceStatusComplement": "string", "documentIntermediator": "string", "intermediateRegistrationId": "string", "documentPaymentInstitution": "string", "fulfillment": true, "discount": 0, "freight": 0, "interestValue": 0, "gross": 0, "total": 0, "marketPlaceUrl": "string", "marketPlaceShipmentStatus": "string", "invoice": { "accessKey": "string", "series": "string", "number": "string", "date": "2019-08-24T14:15:22Z", "cfop": "string", "companyStateTaxId": "string", "linkNfe": "string", "invoiceLink": "string", "extraDescription": "string" }, "shipping": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "address": "string", "number": "string", "neighborhood": "string", "street": "string", "comment": "string", "reference": "string", "zipCode": "string", "receiverName": "string", "promisedShippingTime": "2019-08-24T14:15:22Z" }, "billingAddress": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "street": "string", "number": "string", "neighborhood": "string", "comment": "string", "reference": "string", "zipCode": "string" }, "anymarketAddress": { "state": "string", "city": "string", "zipCode": "string", "neighborhood": "string", "address": "string", "street": "string", "number": "string", "comment": "string", "reference": "string", "receiverName": "string", "promisedShippingTime": "string" }, "buyer": { "marketPlaceId": "string", "name": "string", "email": "string", "document": "string", "documentType": "string", "phone": "string", "cellPhone": "string", "documentNumberNormalized": "string" }, "payments": [ { "method": "string", "status": "string", "value": 0, "installments": 0, "marketplaceId": "string", "gatewayFee": 0, "marketplaceFee": 0, "paymentMethodNormalized": "string", "paymentDetailNormalized": "string" } ], "items": [ { "product": { "id": 0, "title": "string" }, "sku": { "id": 0, "title": "string", "partnerId": "string", "externalId": "string", "ean": "string" }, "amount": 0, "unit": 0, "gross": 0, "total": 0, "discount": 0, "shippings": [ { "id": 0, "shippingtype": "string", "shippingCarrierNormalized": "string", "shippingCarrierTypeNormalized": "string" } ], "stocks": [ { "stockLocalId": 0, "stockName": "string", "amount": 0 } ], "marketPlaceId": "string", "orderItemId": "string", "idInMarketPlace": "string", "officialStoreId": "string", "officialStoreName": "string", "listingType": "string", "freeShipping": true } ], "tracking": { "url": "string", "number": "string", "carrier": "string", "carrierDocument": "string", "date": "2019-08-24T14:15:22Z", "deliveredDate": "2019-08-24T14:15:22Z", "estimateDate": "2019-08-24T14:15:22Z", "shippedDate": "2019-08-24T14:15:22Z" }, "deliverStatus": "UNKNOWN", "idAccount": 0, "pickup": { "id": 0, "description": "string", "partnerId": 0, "marketplaceId": "string", "receiverName": "string" }, "metadata": { "number-of-packages": "1", "cdZipCode": "string", "needInvoiceXML": "true", "paymentConnector": "string" } } ], "page": { "size": 5, "totalElements": 0, "totalPages": 1, "number": 1 } } }, "stoplight-example-1": { "value": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 0, "accountName": "string", "marketPlaceId": "string", "marketPlaceNumber": "string", "partnerId": "string", "marketPlace": "string", "subChannel": "string", "subChannelNormalized": "string", "createdAt": "2019-08-24T14:15:22Z", "paymentDate": "2019-08-24T14:15:22Z", "cancelDate": "2019-08-24T14:15:22Z", "shippingOptionId": "string", "transmissionStatus": "string", "status": "PENDING", "marketPlaceStatus": "string", "marketPlaceStatusComplement": "string", "documentIntermediator": "string", "intermediateRegistrationId": "string", "documentPaymentInstitution": "string", "fulfillment": true, "discount": 0, "freight": 0, "interestValue": 0, "gross": 0, "total": 0, "marketPlaceUrl": "string", "marketPlaceShipmentStatus": "string", "invoice": { "accessKey": "string", "series": "string", "number": "string", "date": "2019-08-24T14:15:22Z", "cfop": "string", "companyStateTaxId": "string", "linkNfe": "string", "invoiceLink": "string", "extraDescription": "string" }, "shipping": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "address": "string", "number": "string", "neighborhood": "string", "street": "string", "comment": "string", "reference": "string", "zipCode": "string", "receiverName": "string", "promisedShippingTime": "2019-08-24T14:15:22Z" }, "billingAddress": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "street": "string", "number": "string", "neighborhood": "string", "comment": "string", "reference": "string", "zipCode": "string" }, "anymarketAddress": { "state": "string", "city": "string", "zipCode": "string", "neighborhood": "string", "address": "string", "street": "string", "number": "string", "comment": "string", "reference": "string", "receiverName": "string", "promisedShippingTime": "string" }, "buyer": { "marketPlaceId": "string", "name": "string", "email": "string", "document": "string", "documentType": "string", "phone": "string", "cellPhone": "string", "documentNumberNormalized": "string" }, "payments": [ { "method": "string", "status": "string", "value": 0, "installments": 0, "marketplaceId": "string", "gatewayFee": 0, "marketplaceFee": 0, "paymentMethodNormalized": "string", "paymentDetailNormalized": "string" } ], "items": [ { "product": { "id": 0, "title": "string" }, "sku": { "id": 0, "title": "string", "partnerId": "string", "externalId": "string", "ean": "string" }, "amount": 0, "unit": 0, "gross": 0, "total": 0, "discount": 0, "shippings": [ { "id": 0, "shippingtype": "string", "shippingCarrierNormalized": "string", "shippingCarrierTypeNormalized": "string" } ], "customizations": { "customizationType": "string", "customizationQuantity": 0, "customizationPrice": 0, "customizationValue": "string" }, "stocks": [ { "stockLocalId": 0, "stockName": "string", "amount": 0 } ], "marketPlaceId": "string", "orderItemId": "string", "idInMarketPlace": "string", "officialStoreId": "string", "officialStoreName": "string", "listingType": "string", "freeShipping": true } ], "tracking": { "url": "string", "number": "string", "carrier": "string", "carrierDocument": "string", "date": "2019-08-24T14:15:22Z", "deliveredDate": "2019-08-24T14:15:22Z", "estimateDate": "2019-08-24T14:15:22Z", "shippedDate": "2019-08-24T14:15:22Z" }, "deliverStatus": "UNKNOWN", "idAccount": 0, "pickup": { "id": 0, "description": "string", "partnerId": 0, "marketplaceId": "string", "receiverName": "string" }, "metadata": { "number-of-packages": "1", "cdZipCode": "string", "needInvoiceXML": "true", "paymentConnector": "string" } } ], "page": { "size": 5, "totalElements": 0, "totalPages": 1, "number": 1 } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" }, "examples": { "example-1": { "value": { "code": "404", "message": "Recurso com o id '%s' não encontrado." } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" }, "examples": { "example-1": { "value": { "code": "422", "message": "O parâmetro '%s' com a data informada '%s', está em formato incorreto. Por favor verificar a documentação" } } } } } } } }, "parameters": [], "post": { "summary": "/orders/reservations", "operationId": "post-orders-reservations", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "marketPlaceId": { "type": "string" }, "marketPlace": { "type": "string" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "integer" }, "sku": { "type": "object", "properties": { "partnerId": { "type": "string" } } } } } } }, "x-examples": { "Example 1": { "id": 7, "marketPlaceId": "1020301", "marketPlace": "MARKETPLACE_TESTE", "total": 150, "items": [ { "amount": 1, "sku": { "partnerId": "ProdutoAPIV21663352881193" } } ] } } }, "examples": { "example-1": { "value": { "id": 0, "accountName": "string", "marketPlaceId": "string", "marketPlaceNumber": "string", "partnerId": "string", "marketPlace": "string", "subChannel": "string", "subChannelNormalized": "string", "createdAt": "2019-08-24T14:15:22Z", "paymentDate": "2019-08-24T14:15:22Z", "cancelDate": "2019-08-24T14:15:22Z", "shippingOptionId": "string", "transmissionStatus": "string", "status": "PENDING", "marketPlaceStatus": "string", "marketPlaceStatusComplement": "string", "documentIntermediator": "string", "intermediateRegistrationId": "string", "documentPaymentInstitution": "string", "fulfillment": true, "discount": 0, "freight": 0, "interestValue": 0, "gross": 0, "total": 0, "marketPlaceUrl": "string", "marketPlaceShipmentStatus": "string", "invoice": { "accessKey": "string", "series": "string", "number": "string", "date": "2019-08-24T14:15:22Z", "cfop": "string", "companyStateTaxId": "string", "linkNfe": "string", "invoiceLink": "string", "extraDescription": "string" }, "shipping": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "address": "string", "number": "string", "neighborhood": "string", "street": "string", "comment": "string", "reference": "string", "zipCode": "string", "receiverName": "string", "promisedShippingTime": "2019-08-24T14:15:22Z" }, "billingAddress": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "street": "string", "number": "string", "neighborhood": "string", "comment": "string", "reference": "string", "zipCode": "string" }, "anymarketAddress": { "state": "string", "city": "string", "zipCode": "string", "neighborhood": "string", "address": "string", "street": "string", "number": "string", "comment": "string", "reference": "string", "receiverName": "string", "promisedShippingTime": "string" }, "buyer": { "marketPlaceId": "string", "name": "string", "email": "string", "document": "string", "documentType": "string", "phone": "string", "cellPhone": "string", "documentNumberNormalized": "string" }, "payments": [ { "method": "string", "status": "string", "value": 0, "installments": 0, "marketplaceId": "string", "gatewayFee": 0, "marketplaceFee": 0, "paymentMethodNormalized": "string", "paymentDetailNormalized": "string" } ], "items": [ { "product": { "id": 0, "title": "string" }, "sku": { "id": 0, "title": "string", "partnerId": "string", "externalId": "string", "ean": "string" }, "amount": 0, "unit": 0, "gross": 0, "total": 0, "discount": 0, "shippings": [ { "id": 0, "shippingtype": "string", "shippingCarrierNormalized": "string", "shippingCarrierTypeNormalized": "string" } ], "stocks": [ { "stockLocalId": 0, "stockName": "string", "amount": 0 } ], "marketPlaceId": "string", "orderItemId": "string", "idInMarketPlace": "string", "officialStoreId": "string", "officialStoreName": "string", "listingType": "string", "freeShipping": true } ], "tracking": { "url": "string", "number": "string", "carrier": "string", "carrierDocument": "string", "date": "2019-08-24T14:15:22Z", "deliveredDate": "2019-08-24T14:15:22Z", "estimateDate": "2019-08-24T14:15:22Z", "shippedDate": "2019-08-24T14:15:22Z" }, "deliverStatus": "UNKNOWN", "idAccount": 0, "pickup": { "id": 0, "description": "string", "partnerId": 0, "marketplaceId": "string", "receiverName": "string" }, "metadata": { "number-of-packages": "1", "cdZipCode": "string", "needInvoiceXML": "true" } } } } } } } }, "description": "# Cria uma reserva", "tags": [ "Pedido" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "id": 7, "marketPlaceId": "1020301", "marketPlace": "MARKETPLACE_TESTE", "total": 150, "items": [ { "amount": 1, "sku": { "partnerId": "ProdutoAPIV21663352881193" } } ] } }, "properties": { "marketPlaceId": { "type": "string" }, "marketPlace": { "type": "string" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "integer" }, "sku": { "type": "object", "properties": { "partnerId": { "type": "string" } } } } } } } } } } }, "x-internal": true, "x-stoplight": { "id": "7577rkj4qstu0" } } }, "/orders/{id}": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "Order ID generated by ANYMARKET" } ], "get": { "summary": "/orders/{id}", "tags": [ "Pedido" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "operationId": "get-orders-id", "description": "# Retrieve Order Details\nRetrieves the details of the informed Order.", "parameters": [] }, "put": { "summary": "/orders/{id}", "operationId": "put-orders-id", "tags": [ "Pedido" ], "requestBody": { "description": "Dados do pedido", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderUpdatePaid" }, { "$ref": "#/components/schemas/OrderUpdateInvoiced" }, { "$ref": "#/components/schemas/OrderUpdateDelivery" }, { "$ref": "#/components/schemas/OrderUpdateConcluded" }, { "$ref": "#/components/schemas/OrderUpdateCanceled" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "description": "# Update Order Data\nUpdates the informed order data according to the new `status`. The update data are not mandatory and if not informed, the order will remain with the current data.\n\nIn the request body, select the variant matching the desired status (Paid, Invoiced, Shipped, Concluded, or Canceled).\n\n> The `PUT` method completely replaces the resource.\n>\n> All required fields must be sent, even if they have not been modified.\n>\n> Omitted fields may be reset or cleared.\n>\n> Use this method when you want to overwrite all information." } }, "/orders/{id}/quote-id": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "ID do pedido gerado pelo ANYMARKET" } ], "get": { "summary": "/orders/{id}/quote-id", "tags": [ "Pedido" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderQuoteId" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "operationId": "get-orders-id-quote-id", "description": "# Consulta informações de auditoria da cotação de frete.\nConsulta informações de auditoria da cotação de frete.", "parameters": [] } }, "/orders/{id}/nfe/type/{type}": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "Order ID generated by ANYMARKET" }, { "schema": { "type": "string", "enum": [ "sale", "sale_return", "sale_devolution", "gift", "inbound", "devolution", "inbound_devolution", "inbound_return", "inbound_supplier_return", "symbolic_inbound", "symbolic_inbound_return", "purchase", "removal", "symbolic_removal" ] }, "name": "type", "in": "path", "required": true, "description": "XML type expected" } ], "get": { "summary": "/orders/{id}/nfe/type/{type}", "tags": [ "Pedido" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XmlFulfillment" } }, "examples": {} } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "operationId": "get-orders-id-nfe-type-type", "description": "# Retrieve Invoice XML\nRetrieves de Invoice XML to the seller. The expected Invoice type must be sent.\n\nAllowed 'type' values:\n- sale\n- sale_return\n- sale_devolution\n- gift\n- inbound\n- devolution\n- inbound_devolution\n- inbound_return\n- inbound_supplier_return\n- symbolic_inbound\n- symbolic_inbound_return\n- purchase\n- removal\n- symbolic_removal\n", "deprecated": true } }, "/orders/{id}/inbound/marketplace/{marketplace}": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "ID de banco enviado pela callback gerado pelo ANYMARKET" }, { "schema": { "$ref": "#/components/schemas/EnumMarketplaces" }, "name": "marketplace", "in": "path", "required": true, "description": "Identificador do marketplace." } ], "get": { "summary": "/orders/{id}/inbound/marketplace/{marketplace}", "tags": [ "Pedido" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XmlFulfillment" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "operationId": "get-orders-id-inbound-marketplace-marketplace", "description": "# Busca o XML da NF-e\nRetorna o Xml da NF-e do tipo Inbound para o Seller. Deve ser enviado o marketplace da NF-e desejada.\n\nAtributo 'marketplace' podendo ser:\n- MERCADO_LIVRE\n- VIA_VAREJO\n- E OUTROS\n\n\n> #### Atenção!\n>\n> Atributo **'marketplace'** deve ser caixa alta (maiúsculo) pois trata-se de um ENUM.", "deprecated": true } }, "/fulfillment/{marketplace}/documents": { "parameters": [ { "schema": { "$ref": "#/components/schemas/EnumMarketplaces" }, "name": "marketplace", "in": "path", "required": true, "description": "Identificador do marketplace." } ], "get": { "summary": "/fulfillment/{marketplace}/documents", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "links": { "type": "array", "description": "Referências de paginação", "items": { "type": "object", "properties": { "rel": { "type": "string", "description": "Relacionamento do hyperlink" }, "href": { "type": "string", "description": "URL de definição do recurso" } } } }, "content": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID do Documento Fiscal" }, "idOrder": { "type": "integer", "description": "ID do Pedido (quando a nota for ligada a um pedido)" }, "url": { "type": "string", "description": "URL do Documento" }, "marketplace": { "$ref": "#/components/schemas/EnumMarketplaces" }, "type": { "$ref": "#/components/schemas/EnumTypeFulfillment" } } } }, "page": { "type": "object", "properties": { "size": { "type": "integer", "description": "Tamanho da página" }, "totalElements": { "type": "integer", "description": "Total de elementos existentes" }, "totalPages": { "type": "integer", "description": "Total de páginas disponíveis" }, "number": { "type": "integer", "description": "Número da página atual" } } } } }, "examples": { "Example 1": { "value": { "links": [ { "rel": "next", "href": "http://api.anymarket.com.br/v2/fulfillment/MAGAZINE_LUIZA/documents?offset=5" } ], "content": [ { "id": 43109, "idOrder": 107032238, "url": "https://s3.us-east-1.amazonaws.com/xml.anymarket.com.br/anymarket-magazineluiza-nfe/transactionType-sale/transactionStatus-autorizadas/152273594.LU-1201170398354422-05012023-220027.xml", "marketplace": "MAGAZINE_LUIZA", "type": "SALE" } ], "page": { "size": 5, "totalElements": 8120, "totalPages": 1624, "number": 0 } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } }, "application/xml": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "404", "message": "Documento não encontrado." } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "operationId": "get-fulfillment-documents", "description": "# Busca documentos fiscais do Fulfillment\nBusca documentos fiscais do Fulfillment do seller, disponibilizados pelos Marketplaces\n\nAtributo 'marketplace' podendo ser:\n- MAGAZINE_LUIZA\n- MERCADO_LIVRE\n- B2W_NEW_API\n- AMAZON_GLOBAL_API\n\n\n> #### Atenção!\n>\n> Atributo **'marketplace'** deve ser caixa alta (maiúsculo) pois trata-se de um ENUM.\n\n> #### Para MERCADO_LIVRE:\n>\n> Caso o parâmetro *\"createdBefore\"* não seja informado, será considerado o valor de *\"createdAfter\"* acrescido de um mês. \n> Caso o parâmetro *\"createdAfter\"* não seja informado, será considerado o valor de *\"createdBefore\"* subtraído de um mês. \n> Se ambos os parâmetros não forem informados, *\"createdBefore\"* assumirá a data atual e *\"createdAfter\"* será definido como um mês antes dessa data.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "idOrder", "description": "ID do Pedido (quando a nota for ligada a um pedido)" }, { "schema": { "type": "string" }, "in": "query", "name": "idDocument", "description": "ID do Documento Fiscal" }, { "schema": { "$ref": "#/components/schemas/EnumTypeFulfillment" }, "in": "query", "name": "type", "description": "Tipo do documento (Ex: Sale, Inbound e etc.)" }, { "schema": { "type": "string", "example": "2022-11-25T14:00:00-03:00", "format": "date-time" }, "in": "query", "name": "createdAfter", "description": "Criado a partir de" }, { "schema": { "type": "string", "example": "2022-11-25T20:30:00-03:00", "format": "date-time" }, "in": "query", "name": "createdBefore", "description": "Criado antes de " }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" } ], "tags": [ "Fulfillment" ] } }, "/orders/{id}/nfe": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "description": "Order ID generated by ANYMARKET", "required": true } ], "put": { "summary": "/orders/{id}/nfe", "tags": [ "Pedido" ], "responses": { "200": { "description": "OK", "content": {} }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" }, "examples": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" }, "examples": { "orders/{id}/nfe 1": { "value": { "code": "500", "message": "Ocorreu um erro ao atualizar o documento fiscal para o marketplace. Erro: O Mercado Livre não permite o envio do XML da nota fiscal para a seguinte combinação de status e substatus do shipment do pedido no Mercado Livre. (Status: pending, Substatus: buffered, Id. no Marketplace: 20000012345678901)" } }, "orders/{id}/nfe 2": { "value": { "code": "500", "message": "Ocorreu um erro ao atualizar o documento fiscal para o marketplace. Erro: O Limite de Nota Fiscal salva na venda foi atingido no Mercado Livre." } }, "orders/{id}/nfe 3": { "value": { "code": "500", "message": "Ocorreu um erro ao atualizar o documento fiscal para o marketplace. Erro: Erro ao faturar pedido: Erro: ''??invalid_invoice_emission_date??''" } } } } } } }, "operationId": "get-orders-id-nfe", "description": "# Send Invoice XML file\nSends Invoice XML file to the Marketplace. Only the XML content must be sent.", "requestBody": { "content": { "application/xml": { "schema": { "type": "string" }, "examples": { "XML": { "value": "\n\n\n\n\n41\n04143308\nVenda de mercadorias\n55\n1\n562465425\n2019-09-11T15:57:56-03:00\n1\n1\n4115200\n1\n1\n7\n2\n1\n1\n9\n0\nBling 1.0\n\n\n08328657000194\nAnymarket DB1\n\nAv. Advogado Horacio Raccanello Filho\n5410\nNovo Centro\n4115200\nMaringa\nPR\n87020035\n1058\nBrasil\n4430336300\n\n9038912540\n1\n\n\n42159270130\nNF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL\n\nPraca Amabile Giroldo\n100\nmaca, area, avo, avo\nZona 04\n4115200\nMaringa\nPR\n87014280\n1058\nBrasil\n4432202020\n\n9\nttest.7y5snb2-oge3dcojrgmztcmbt@mail.com\n\n\n\nAKCI00990ZPTODAVIDA\nSEM GTIN\nNOTA FISCAL EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL\n01029000\n5102\n1\n1.0000\n160.00\n160.00\nSEM GTIN\n1\n1.0000\n160.00\n1\n1\n\n\n25.92\n\n\n0\n400\n\n\n\n301\n\n52\n\n\n\n\n07\n\n\n\n\n07\n\n\n\n\n\n\n0.00\n0.00\n0\n0.00\n0.00\n0.00\n0.00\n0.00\n160.00\n0.00\n0.00\n0.00\n0.00\n0.00\n0.00\n0.00\n0.00\n0.00\n160.00\n25.92\n\n\n\n0\n\nDESCONHECIDO\n\n\n0.000\n0.000\n\n\n\n\n562465425\n160.00\n0\n160.00\n\n\n001\n2019-09-11\n160.00\n\n\n\n\n01\n160.00\n\n\n\nTotal aproximado de tributos: R$ 25,92 (16,20%) Federais R$ 6,72 (4,20%) Estaduais R$ 19,20 (12,00%) . Fonte IBPT.
\n\n\n01056417000139\nJonatan Fracasso da Silva\nfiscal@bling.com.br\n05430550479\n\n\n\n\n\n\n\n\n\n\n\n\nJYjiWB7sFoiM7jQckhdvLsSBpQw=\n\n\nH6DfZXCiFcypfHAXdaotLTU2hSJxaCCDIEHkU84eioyd4VVSqYu/0FbBAYnmlb5xGbqio59fzlZ2P7OvR4UogYcW32jT95HfuB2wkUxIbCPzI14uEQzm7Sve8NG+0H0Oge1U/vTApeZHcGfVsQiGCRItvDUVuGJ50qPCGONz1BV6yBO9cr9WxtA2AhOklb4uShPrb+08W+LZ2ReYKLND5vJVofEmUE9jU1hgFGm/WM2zMgauKNqgJr2/nlPI13PxyxYZ6QTC7EenkEJdr+L9ziWzN5haFQ7mw2jtVQOwpnU5KQBbfmpyWZKQ9sUDPOrnr9y73iKGrPAf6cvTNEhZAA==\n\n\nMIIHwDCCBaigAwIBAgIIRD0ZAig/4BIwDQYJKoZIhvcNAQELBQAwgYkxCzAJBgNVBAYTAkJSMRMwEQYDVQQKEwpJQ1AtQnJhc2lsMTQwMgYDVQQLEytBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUmFpeiBCcmFzaWxlaXJhIHYyMRIwEAYDVQQLEwlBQyBTT0xVVEkxGzAZBgNVBAMTEkFDIFNPTFVUSSBNdWx0aXBsYTAeFw0xOTAyMjgxODA0MTBaFw0yMDAyMjgxNzM1MDBaMIHfMQswCQYDVQQGEwJCUjETMBEGA1UEChMKSUNQLUJyYXNpbDE0MDIGA1UECxMrQXV0b3JpZGFkZSBDZXJ0aWZpY2Fkb3JhIFJhaXogQnJhc2lsZWlyYSB2MjESMBAGA1UECxMJQUMgU09MVVRJMRswGQYDVQQLExJBQyBTT0xVVEkgTXVsdGlwbGExGjAYBgNVBAsTEUNlcnRpZmljYWRvIFBKIEExMTgwNgYDVQQDEy9EQjEgU0lTVEVNQVMgRSBDT05TVUxUT1JJQSBMVERBLjowODMyODY1NzAwMDE5NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJAMfqYQn+K1ZVA1mikdSoUdeP9JU1zcj9JW30yqcRgHqYeNvVZwSPGSpNBURTpdJq+a2QEUXrqe9xLDCWNbPV6M4Br3cq7JOSc4lC31gt6JxhBXrm9cRQvcu0Kyh7h8DF8aHcFEW2rr8xGXQdiguR3Gs1bgPUdpqRQNQ5nq5oaoGdbIjbRWkNLSV9LXZP/PW6KIRdCMBby4ly7TbEt1WwU2az625TOnlVLL0ISHKdNAcKwtDM53OEq+FXp4nmfO7LULo5IB57Zzj97Xz4wyNyir/9nh1lX3cc/i8AlcTYVPtK1u/h1Id/UZK53mb9yo0FMLRf+nHXI9q7g7AUjZHycCAwEAAaOCAtIwggLOMFQGCCsGAQUFBwEBBEgwRjBEBggrBgEFBQcwAoY4aHR0cDovL2NjZC5hY3NvbHV0aS5jb20uYnIvbGNyL2FjLXNvbHV0aS1tdWx0aXBsYS12MS5wN2IwHQYDVR0OBBYEFGbSSAwEwrPZAgM8DFShvCbMJ+50MAkGA1UdEwQCMAAwHwYDVR0jBBgwFoAUNa4xFPZe0npPWP40qBpnlwrEmwcwXgYDVR0gBFcwVTBTBgZgTAECASYwSTBHBggrBgEFBQcCARY7aHR0cHM6Ly9jY2QuYWNzb2x1dGkuY29tLmJyL2RvY3MvZHBjLWFjLXNvbHV0aS1tdWx0aXBsYS5wZGYwgd4GA1UdHwSB1jCB0zA+oDygOoY4aHR0cDovL2NjZC5hY3NvbHV0aS5jb20uYnIvbGNyL2FjLXNvbHV0aS1tdWx0aXBsYS12MS5jcmwwP6A9oDuGOWh0dHA6Ly9jY2QyLmFjc29sdXRpLmNvbS5ici9sY3IvYWMtc29sdXRpLW11bHRpcGxhLXYxLmNybDBQoE6gTIZKaHR0cDovL3JlcG9zaXRvcmlvLmljcGJyYXNpbC5nb3YuYnIvbGNyL0FDU09MVVRJL2FjLXNvbHV0aS1tdWx0aXBsYS12MS5jcmwwDgYDVR0PAQH/BAQDAgXgMB0GA1UdJQQWMBQGCCsGAQUFBwMCBggrBgEFBQcDBDCBugYDVR0RBIGyMIGvgRhjb250cm9sYWRvcmlhQGRiMS5jb20uYnKgJQYFYEwBAwKgHBMaQUxFWEFORFJFIERBIFNJTFZBIFJFWkVOREWgGQYFYEwBAwOgEBMOMDgzMjg2NTcwMDAxOTSgOAYFYEwBAwSgLxMtMDYxMDE5ODAwMzAwNzQ1Nzk2MzAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoBcGBWBMAQMHoA4TDDAwMDAwMDAwMDAwMDANBgkqhkiG9w0BAQsFAAOCAgEAYTnjjqwxA3Yg4YYBf+tArw2SshV2IXb5IqqmFtRWBiHlIgwwc8VgGsJEM8nJwFX5htPTtySX4RCETTbh/GKBYjp42T+v1udKuDYohoTdm1TrYvarXkFXKqQ6HBzDFtLPo4VfsKbAe/31S5OtYvb536Qtj6e+5S000RH5nCHsfcqgShZHkdLuMpQqjawaCVccfERlK/3iN4S9pYryy+zgeb158rNOKUZU4DVj2yhNO3JKvUmvPuyHpUnAqGA35qZkCSLCPl4AEi4RyjCE5DAwGp20gMF5xXZwZD+rszTzILpXUfyqAjL2uarkSJrhRmXGT7i2cQHzez2HrLzLBI8vgalzk98RcX1GNiQlUueEWH2xseh/nyi3YjOkFIyhzvQuACTs6Ou4xYPW/3xkclNivc44lomEzmT16yZrrxD7AdlH4om1+Hrcr216AiekIO72Ggl2bjKt10vFtb9NlEmrpBq9+KcKbL4v2QNOESHsDQXnxgi0XuECdw3Jkj4X0IYbN8h4RkKvYiCTi5bgLH685XkU2WgGYAtvTAlmIvTlMDhskKv6cmHp5C0b2GPvC8WMncq5bwNqjLDhwH/qSsqsJT7s2qypj+mzokuMpjJ8noVy5LU0on6p5QOnO31mMbYmvHFbhbigl9OHe94liqVnJdChVlQD3j74EelQwZjCrZw=\n\n\n\n\n\n\n2\nPR-v4_4_9\n41190908328657000194550015624654251041433087\n2019-09-11T15:57:57-03:00\n141190000835627\nJYjiWB7sFoiM7jQckhdvLsSBpQw=\n100\nAutorizado o uso da NF-e\n\n\n" } } } }, "description": "Conteúdo do XML" } } }, "/orders/{id}/fiscalDocument": { "parameters": [ { "schema": { "type": "integer", "format": "int64" }, "name": "id", "in": "path", "description": "ID do pedido no ANYMARKET.", "required": true } ], "post": { "summary": "/orders/{id}/fiscalDocument", "tags": [ "Pedido" ], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "name": "packageId", "in": "query", "description": "Identificador do pacote do pedido ao qual a nota fiscal pertence. Obrigatório quando o pedido possui pacotes; não deve ser informado quando o pedido não possui pacotes.", "required": false } ], "responses": { "200": { "description": "NF registrada com sucesso no pacote.", "content": {} }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" }, "examples": { "packageId obrigatório": { "value": { "code": "400", "message": "O parâmetro packageId é obrigatório quando o pedido possui pacotes." } }, "PACKAGE_ALREADY_INVOICED": { "value": { "code": "400", "message": "O pacote informado já possui nota fiscal associada (PACKAGE_ALREADY_INVOICED)." } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" }, "examples": { "orders/{id}/nfe 1": { "value": { "code": "500", "message": "Ocorreu um erro ao atualizar o documento fiscal para o marketplace. Erro: O Mercado Livre não permite o envio do XML da nota fiscal para a seguinte combinação de status e substatus do shipment do pedido no Mercado Livre. (Status: pending, Substatus: buffered, Id. no Marketplace: 20000012345678901)" } }, "orders/{id}/nfe 2": { "value": { "code": "500", "message": "Ocorreu um erro ao atualizar o documento fiscal para o marketplace. Erro: O Limite de Nota Fiscal salva na venda foi atingido no Mercado Livre." } }, "orders/{id}/nfe 3": { "value": { "code": "500", "message": "Ocorreu um erro ao atualizar o documento fiscal para o marketplace. Erro: Erro ao faturar pedido: Erro: ''??invalid_invoice_emission_date??''" } } } } } } }, "operationId": "get-orders-id-fiscaDocument", "description": "# Envia a Nota Fiscal (PDF ou XML)\n\nRegistra a nota fiscal em um pacote do pedido e envia o documento ao Marketplace. O endpoint não retorna body na resposta (void).\n\n## Parâmetros\n\n| Parâmetro | Tipo | Obrigatoriedade | Descrição |\n|-----------|------|-----------------|-----------|\n| id (path) | Long | Obrigatório | ID do pedido no ANYMARKET. |\n| packageId (query) | UUID | Obrigatório quando o pedido possui pacotes; não deve ser informado quando o pedido não possui pacotes | Identificador do pacote do pedido ao qual a nota fiscal pertence. |\n\n## Body (multipart/form-data)\n\n| Campo | Tipo | Obrigatoriedade | Descrição |\n|-------|------|-----------------|-----------|\n| file | File (PDF ou XML) | Obrigatório | Arquivo da nota fiscal. |\n| number | String | Obrigatório | Número da nota fiscal. |\n| date | String (ISO 8601) | Obrigatório | Data de emissão. Ex: 2026-05-05T10:00:00-03:00. |\n| accessKey | String | Opcional | Chave de acesso da NF-e. |\n| series | String | Opcional | Série da nota fiscal. |\n| cfop | String | Opcional | Código Fiscal de Operações e Prestações. |\n| companyStateTaxId | String | Opcional | Inscrição estadual da empresa emissora. |\n| linkNfe | String | Opcional | URL para consulta da NF-e. |\n| invoiceLink | String | Opcional | URL onde está armazenado o PDF ou XML da nota fiscal. |\n| extraDescription | String | Opcional | Campo para observações. |\n| operationType | String | Opcional | Tipo de operação fiscal. |\n| emissionType | String | Opcional | Tipo de emissão da nota fiscal. |\n| authorizationProtocol | String | Opcional | Protocolo de autorização da nota fiscal. |\n| origin | String | Opcional | Responsável pela persistência da nota fiscal no armazenador de arquivo fiscal document. Valores: ORIGIN_ERP, ORIGIN_MARKETPLACE, UNKNOW. Quando não informado, o valor padrão é UNKNOW. |\n\n> **Importante:** Pacotes faturados se tornam imutáveis — não podem ser editados, excluídos ou cancelados.\n\n## Códigos de retorno\n\n| Código | Descrição |\n|--------|-----------|\n| 200 | NF registrada com sucesso no pacote. |\n| 400 | `packageId obrigatório` — pedido possui pacotes e a requisição não informou packageId. |\n| 400 | `PACKAGE_ALREADY_INVOICED` — pacote informado já possui NF associada. |\n\n## Exemplo de curl\n\n```bash\ncurl --location 'https://sandbox-api.anymarket.com.br/v2/orders/6565/fiscalDocument' \\\n --header 'gumgaToken: ' \\\n --form 'file=@\"/caminho/para/nota-fiscal.pdf\"' \\\n --form 'packageId=\"476ae5cb-2cc2-4e4e-9f42-22def0f06378\"' \\\n --form 'date=\"2026-05-15T10:00:00-03:00\"' \\\n --form 'number=\"1234\"' \\\n --form 'accessKey=\"352505123456780001955500100000123412345\"' \\\n --form 'series=\"1\"' \\\n --form 'invoiceLink=\"https://example.com/danfe/1234.pdf\"' \\\n --form 'linkNfe=\"https://example.com/nfe/1234.xml\"' \\\n --form 'cfop=\"6102\"' \\\n --form 'companyStateTaxId=\"123456789\"' \\\n --form 'extraDescription=\"Venda de mercadoria\"' \\\n --form 'operationType=\"1\"' \\\n --form 'emissionType=\"1\"' \\\n --form 'authorizationProtocol=\"135260005473993\"' \\\n --form 'origin=\"ORIGIN_ERP\"'\n```\n\n> **Nota:** Caso o campo `origin` não seja informado na requisição, o valor padrão atribuído será `UNKNOW`.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file", "number", "date" ], "properties": { "file": { "type": "string", "format": "binary", "description": "Arquivo da nota fiscal (PDF ou XML)." }, "number": { "type": "string", "description": "Número da nota fiscal." }, "date": { "type": "string", "format": "date-time", "description": "Data de emissão da nota fiscal (ISO 8601). Ex: 2026-05-05T10:00:00-03:00." }, "accessKey": { "type": "string", "description": "Chave de acesso da NF-e." }, "series": { "type": "string", "description": "Série da nota fiscal." }, "cfop": { "type": "string", "description": "Código Fiscal de Operações e Prestações." }, "companyStateTaxId": { "type": "string", "description": "Inscrição estadual da empresa emissora." }, "linkNfe": { "type": "string", "description": "URL para consulta da NF-e." }, "invoiceLink": { "type": "string", "description": "URL onde está armazenado o PDF ou XML da nota fiscal." }, "extraDescription": { "type": "string", "description": "Campo para observações." }, "operationType": { "type": "string", "description": "Tipo de operação fiscal." }, "emissionType": { "type": "string", "description": "Tipo de emissão da nota fiscal." }, "authorizationProtocol": { "type": "string", "description": "Protocolo de autorização da nota fiscal." }, "origin": { "type": "string", "description": "Responsável pela persistência da nota fiscal no armazenador de arquivo fiscal document. Quando não informado, o valor padrão é UNKNOW.", "enum": [ "ORIGIN_ERP", "ORIGIN_MARKETPLACE", "UNKNOW" ], "default": "UNKNOW", "x-enum-descriptions": { "ORIGIN_ERP": "Nota fiscal enviada pelo ERP do seller", "ORIGIN_MARKETPLACE": "Nota fiscal originada do marketplace", "UNKNOW": "Origem não identificada (valor padrão quando não informado)" } } } } } } } } }, "/questions": { "get": { "summary": "/questions", "tags": [ "Perguntas" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_Questions" } } } } }, "operationId": "get-questions", "description": "# Retrieve Available Questions\nRetrieves the available questions. Currently available to Mercado Livre marketplace only.", "parameters": [ { "schema": { "type": "string", "example": "2022-02-25" }, "in": "query", "name": "date", "description": "Created After" }, { "schema": { "type": "string", "enum": [ "UNANSWERED", "ANSWERED", "TO_BE_DELETED", "CLOSED_UNANSWERED" ] }, "in": "query", "name": "status", "description": "Parameter used to filter questions by status" } ], "x-internal": true, "x-stoplight": { "id": "9aiqz9yqesuvy" } } }, "/questions/{id}": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "ID da pergunta" } ], "get": { "summary": "/questions/{id}", "tags": [ "Perguntas" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Questions" }, "examples": { "example-1": { "value": { "id": 0, "questionerName": "string", "context": "string", "question": "string", "answers": [ { "id": 0, "answer": "string" } ], "questionDate": "2019-08-24T14:15:22Z" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "operationId": "get-questions-id", "description": "# Retrieve Question Details\nRetrieves the details of the informed question. Currently available to Mercado Livre marketplace only." } }, "/questions/{id}/answers": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "Question ID" } ], "get": { "summary": "/questions/{id}/answers", "tags": [ "Perguntas" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_Answers" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "operationId": "get-questions-id-answers", "description": "# Retrieve Question Answers\nRetrieves the answers of the informed question. Currently available to Mercado Livre marketplace only." }, "post": { "summary": "Creates a new answer to a question.", "operationId": "post-questions-id-answers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answers" } } } } }, "description": "# Create New Answer\nCreates a new answer to the informed question. Currently available to Mercado Livre marketplace only.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answers" } } } }, "tags": [ "Perguntas" ] } }, "/questions/{id}/answers/{answerId}": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "ID da pergunta" }, { "schema": { "type": "integer" }, "name": "answerId", "in": "path", "required": true, "description": "ID da resposta" } ], "get": { "summary": "/questions/{id}/answers/{answerId}", "tags": [ "Perguntas" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answers" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "operationId": "get-questions-id-answers-answerId", "description": "# Retrieve Answer Details\nRetrieves the details of the informed answer. Currently available to Mercado Livre marketplace only." } }, "/products": { "get": { "summary": "/products", "tags": [ "Produto" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_Product" }, "examples": { "example-1": { "value": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 0, "title": "string", "description": "string", "externalIdProduct": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 123456, "name": "Brastemp", "reducedName": "brastemp", "partnerId": "marca-001-brastemp" }, "nbm": { "id": "string", "description": "string" }, "origin": { "id": 0, "description": "string" }, "model": "string", "videoUrl": "string", "gender": "MALE", "warrantyTime": 0, "warrantyText": "string", "height": 0, "width": 0, "weight": 0, "length": 0, "priceFactor": 0, "calculatedPrice": true, "definitionPriceScope": "string", "hasVariations": true, "isProductActive": true, "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "images": [ { "id": 0, "index": 0, "main": true, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "string", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } ], "skus": [ { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } ], "allowAutomaticSkuMarketplaceCreation": true } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } } } } } } }, "operationId": "get-products", "description": "# Retrieve Products Details\nRetrieves products details.", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "schema": { "type": "string" }, "in": "query", "name": "sku", "description": "Partner SKU code (If informed, filters for products that contains this SKU)" }, { "schema": { "type": "string" }, "in": "query", "description": "External ID, used by some marketplaces for internal control", "name": "externalId" }, { "schema": { "type": "string" }, "in": "query", "name": "categoryId", "description": "ID da categoria gerado pelo ANYMARKET (Quando informado, filtra apenas os produtos contidos nessa categoria)" } ] }, "post": { "summary": "/products", "operationId": "post-products", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" }, "examples": { "example-1": { "value": { "id": 0, "title": "string", "description": "string", "externalIdProduct": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 123456, "name": "Brastemp", "reducedName": "brastemp", "partnerId": "marca-001-brastemp" }, "nbm": { "id": "string", "description": "string" }, "origin": { "id": 0, "description": "string" }, "model": "string", "videoUrl": "string", "gender": "MALE", "warrantyTime": 0, "warrantyText": "string", "height": 0, "width": 0, "weight": 0, "length": 0, "priceFactor": 0, "calculatedPrice": true, "definitionPriceScope": "string", "hasVariations": true, "isProductActive": true, "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "images": [ { "id": 0, "index": 0, "main": true, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "string", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } ], "skus": [ { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } ], "allowAutomaticSkuMarketplaceCreation": true } } } } } }, "400": { "$ref": "#/components/responses/400" }, "422": { "$ref": "#/components/responses/422" } }, "description": "# Create Product\nCreates a product using the informed data.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostProduct" }, "examples": {} } } }, "tags": [ "Produto" ] } }, "/products/{id}": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "Product ID generated by ANYMARKET" } ], "get": { "summary": "/products/{id}", "tags": [ "Produto" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" }, "examples": { "example-1": { "value": { "id": 0, "title": "string", "description": "string", "externalIdProduct": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 123456, "name": "Brastemp", "reducedName": "brastemp", "partnerId": "marca-001-brastemp" }, "nbm": { "id": "string", "description": "string" }, "origin": { "id": 0, "description": "string" }, "model": "string", "videoUrl": "string", "gender": "MALE", "warrantyTime": 0, "warrantyText": "string", "height": 0, "width": 0, "weight": 0, "length": 0, "priceFactor": 0, "calculatedPrice": true, "definitionPriceScope": "string", "hasVariations": true, "isProductActive": true, "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "images": [ { "id": 0, "index": 0, "main": true, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "string", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } ], "skus": [ { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } ], "allowAutomaticSkuMarketplaceCreation": true } } } } } }, "404": { "$ref": "#/components/responses/404" } }, "operationId": "get-products-id", "description": "# Retrieve Product Details\nRetrieves the details of the informed product." }, "patch": { "summary": "/products/{id}", "operationId": "patch-products-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" }, "examples": { "example-1": { "value": { "id": 0, "title": "string", "description": "string", "externalIdProduct": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 123456, "name": "Brastemp", "reducedName": "brastemp", "partnerId": "marca-001-brastemp" }, "nbm": { "id": "string", "description": "string" }, "origin": { "id": 0, "description": "string" }, "model": "string", "videoUrl": "string", "gender": "MALE", "warrantyTime": 0, "warrantyText": "string", "height": 0, "width": 0, "weight": 0, "length": 0, "priceFactor": 0, "calculatedPrice": true, "definitionPriceScope": "string", "hasVariations": true, "isProductActive": true, "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "images": [ { "id": 0, "index": 0, "main": true, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "string", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } ], "skus": [ { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } ], "allowAutomaticSkuMarketplaceCreation": true } } } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "description": "# Update Product Partial Data\nUpdates partial data of a product. After the product is created, images and SKUs can only be updated through their specific APIs.", "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/ProductMergePatch" }, "examples": { "example-1": { "value": { "title": "replace", "description": "Título do produto", "maxLength": 150 } } } } }, "description": "Dados do produto" }, "tags": [ "Produto" ] }, "put": { "summary": "/products/{id}", "operationId": "put-products-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" }, "examples": { "example-1": { "value": { "id": 0, "title": "string", "description": "string", "externalIdProduct": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 123456, "name": "Brastemp", "reducedName": "brastemp", "partnerId": "marca-001-brastemp" }, "nbm": { "id": "string", "description": "string" }, "origin": { "id": 0, "description": "string" }, "model": "string", "videoUrl": "string", "gender": "MALE", "warrantyTime": 0, "warrantyText": "string", "height": 0, "width": 0, "weight": 0, "length": 0, "priceFactor": 0, "calculatedPrice": true, "definitionPriceScope": "string", "hasVariations": true, "isProductActive": true, "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "images": [ { "id": 0, "index": 0, "main": true, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "string", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } ], "skus": [ { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } ], "allowAutomaticSkuMarketplaceCreation": true } } } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "description": "# Update Product\nAfter the product is created, images and SKUs can only be updated through their specific APIs.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductUpdate" }, "examples": { "example-1": { "value": { "title": "string", "description": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 0, "name": "string", "partnerId": "string" }, "nbm": { "id": "string" }, "origin": { "id": 0 }, "model": "string", "videoUrl": "string", "gender": "string", "warrantyTime": 0, "warrantyText": "string", "height": 0, "width": 0, "weight": 0, "length": 0, "priceFactor": 0, "calculatedPrice": true, "definitionPriceScope": "string", "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "allowAutomaticSkuMarketplaceCreation": true } } } } } }, "tags": [ "Produto" ] } }, "/products/patch/{productId}": { "parameters": [ { "schema": { "type": "integer" }, "name": "productId", "in": "path", "required": true, "description": "Product ID generated by ANYMARKET" } ], "patch": { "summary": "/products/patch/{productId}", "tags": [ "Produto" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "operationId": "patch-products-patch-productId", "description": "# Update Product Partial Data (using RFC 6902)\nUpdates partial data of a product using RFC 6902. After the product is created, images and SKUs can only be updated through their specific APIs.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ProductPatch" }, "examples": { "example-1": { "value": [ { "op": "replace", "path": "/title", "value": "novo título" }, { "op": "replace", "path": "/warrantyTime", "value": 2 }, { "op": "replace", "path": "/brand/id", "value": 1323057 } ] } } } }, "description": "" } } }, "/promotions/{id}": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "Price Rule (promotion) ID generated by ANYMARKET" } ], "get": { "summary": "/promotions/{id}", "tags": [ "Promoção" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Promotion" } } } }, "404": { "$ref": "#/components/responses/404" } }, "operationId": "get-promotions-id", "description": "# Retrieve Price Rule (promotion) Details\nRetrieves the details of a Price Rule (promotion)." } }, "/products/{productId}/skus": { "parameters": [ { "schema": { "type": "integer" }, "name": "productId", "in": "path", "required": true, "description": "Product ID generated by ANYMARKET" } ], "get": { "summary": "/products/{productId}/skus", "tags": [ "SKU" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sku" } }, "examples": { "example-1": { "value": [ { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } ] } } } } } }, "operationId": "get-products-productId-skus", "description": "# Retrieve Product SKUs\nRetrieves all SKUs of a product. ANYMARKET products have at least 1 SKU, if the product has variations it might have more than 1 SKU. Example: If the product is a pen and has color variations (blue, red and black for example), each one of them will have an SKU. If a product doesn't have a variation (a Wrist Watch for example) it will also have an SKU.", "parameters": [] }, "post": { "summary": "/products/{productId}/skus", "operationId": "post-products-productId-skus", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sku" }, "examples": { "example-1": { "value": { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } } } } } }, "422": { "$ref": "#/components/responses/422" } }, "description": "# Create SKU\nCreates an SKU using the given data.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuPost" }, "examples": { "example-1": { "value": { "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "price": 0, "additionalTime": 0, "stockLocalId": 0, "variations": { "variationName": "VariationValue" }, "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } } } } } }, "tags": [ "SKU" ] } }, "/products/{productId}/skus/{skuId}": { "parameters": [ { "schema": { "type": "integer" }, "name": "productId", "in": "path", "required": true, "description": "Product ID generated by ANYMARKET" }, { "schema": { "type": "integer" }, "name": "skuId", "in": "path", "required": true, "description": "SKU ID generated by ANYMARKET" } ], "get": { "summary": "/products/{productId}/skus/{skuId}", "tags": [ "SKU" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sku" }, "examples": { "example-1": { "value": { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } } } } } }, "404": { "$ref": "#/components/responses/404" } }, "operationId": "get-products-productId-skus-skuId", "description": "# Retrieve SKU details\nRetrieves the details of a SKU." }, "put": { "summary": "/products/{productId}/skus/{skuId}", "operationId": "put-products-productId-skus-skuId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sku" }, "examples": { "example-1": { "value": { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "tags": [ "SKU" ], "description": "# Update SKU data\nUpdates the SKU data.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuPut" }, "examples": { "example-1": { "value": { "title": "string", "partnerId": "string", "ean": "string", "price": 0, "sellPrice": 0, "externalId": "string" } } } } } } }, "patch": { "summary": "/products/{productId}/skus/{skuId}", "operationId": "patch-products-productId-skus-skuId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sku" }, "examples": { "example-1": { "value": { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "description": "# Update SKU Partial Data\nUpdates partial data of a SKU.", "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/SkuMergePatch" }, "examples": { "example-1": { "value": { "title": "NewTitle", "ean": "1234567890" } } } } } }, "tags": [ "SKU" ] } }, "/products/{productId}/skus/patch/{skuId}": { "parameters": [ { "schema": { "type": "integer" }, "name": "productId", "in": "path", "required": true, "description": "ID do produto gerado pelo ANYMARKET" }, { "schema": { "type": "integer" }, "name": "skuId", "in": "path", "required": true, "description": "ID do SKU" } ], "patch": { "summary": "/products/{productId}/skus/patch/{skuId}", "operationId": "patch-products-productId-skus-patch-skuId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sku" }, "examples": { "example-1": { "value": { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "description": "# Update SKU Partial Data (using RFC 6902)\nUpdates partial data of a SKU using RFC 6902", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "replace", "add", "test", "remove", "move", "copy" ], "description": "Operação a ser executada.", "example": "replace" }, "path": { "type": "string", "description": "Propriedade a ser modificada.", "example": "\"/ean\"" }, "value": { "type": "string", "description": "Valor da propriedade.", "example": "\"0001124445\"" } }, "required": [ "op", "path", "value" ] } }, "examples": { "example-1": { "value": [ { "op": "replace", "path": "/title", "value": "novo título" }, { "op": "replace", "path": "/ean", "value": "123456789" } ] }, "stoplight-example-1": { "value": [ { "op": "replace", "patch": "/title", "value": "novo título" }, { "op": "replace", "patch": "/ean", "value": "123456789" } ] } } } }, "description": "" }, "tags": [ "SKU" ] } }, "/skus/exports": { "get": { "summary": "/skus/exports", "tags": [ "SKU" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuFileExport" } } } } } }, "operationId": "get-skus-exports", "description": "# Retrieve Exports List\nRetrieves the list of requested exports, based on the token user.", "parameters": [ { "$ref": "#/components/parameters/marketplaceQuery" } ] }, "post": { "summary": "/skus/exports", "operationId": "post-skus-exports", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuFileExport" } } } } }, "tags": [ "SKU" ], "parameters": [ { "$ref": "#/components/parameters/marketplaceQuery" } ], "description": "# Create Product Report File (SKU, price, stock and crossdocking)\nCreates a Report File of a Product. This report contains the SKU, price, stock and crossdocking." } }, "/skus/exports/{idDocument}": { "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "name": "idDocument", "in": "path", "required": true, "description": "File ID generated by ANYMARKET" } ], "get": { "summary": "/skus/exports/{idDocument}", "tags": [ "SKU" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuFileExport" } } } }, "404": { "$ref": "#/components/responses/404" } }, "operationId": "get-skus-exports-idDocument", "description": "# Retrieve File Export by Document ID (idDocument)\nRetrieves all requested exports based on the token user and idDocument." } }, "/skus/marketplaces": { "get": { "summary": "/skus/marketplaces", "tags": [ "SKU Marketplace" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuMarketplace" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "partnerID obrigatório": { "value": { "code": "400", "message": "O parâmetro 'partnerID' é obrigatório, consulte a documentação para maiores informações." } }, "Example 1": { "value": { "code": "400", "message": "O parâmetro 'partnerID' é obrigatório, consulte a documentação para maiores informações." } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "operationId": "get-skus-marketplaces", "description": "# Retrieve SKU Offers (transmissions)\nRetrieves all offers of a SKU. A SKU might have multiple offers created in marketplaces.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "description": "Partner SKU code", "name": "partnerID", "required": true } ] } }, "/skus/{marketplace}/{skuInMarketplace}/stock/reservation": { "parameters": [ { "schema": { "type": "string" }, "name": "marketplace", "in": "path", "required": true, "description": "Marketplace Identifier" }, { "schema": { "type": "string" }, "name": "skuInMarketplace", "in": "path", "required": true, "description": "Marketplace SKU Identifier" } ], "get": { "summary": "/skus/{marketplace}/{skuInMarketplace}/stock/reservation", "tags": [ "SKU Marketplace" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "": { "$ref": "#/components/schemas/StockReservationGet" } } } } } } }, "operationId": "get-skus-marketplace-skuinmarketplace-stock-reservation", "description": "# Consulta reserva de estoque do marketplace de um SKU\nConsulta a reserva de estoque de um SKU através do seu identificador no marketplace.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "idAccount", "description": "Identificador da conta" } ], "x-internal": true, "x-stoplight": { "id": "zwpy7z0ob4ssm" } } }, "/skus/{marketplace}/simple/all": { "parameters": [ { "schema": { "type": "string" }, "name": "marketplace", "in": "path", "required": true } ], "get": { "summary": "/skus/{marketplace}/simple/all", "tags": [ "SKU Marketplace" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "links": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "rel", "href" ], "properties": { "rel": { "type": "string", "minLength": 1 }, "href": { "type": "string", "minLength": 1 } } } }, "content": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "idInMarketplace", "marketPlace", "title", "publicationStatus", "transmissionStatus", "errorMsg", "price", "priceFactor", "discountPrice", "skuInMarketplace", "marketplaceItemCode", "lastUpdateStatusDate", "transmissionMessage" ], "properties": { "id": { "type": "number" }, "idInMarketplace": { "type": "string", "minLength": 1 }, "marketPlace": { "type": "string", "minLength": 1 }, "title": { "type": "string", "minLength": 1 }, "publicationStatus": { "type": "string", "minLength": 1 }, "transmissionStatus": { "type": "string", "minLength": 1 }, "errorMsg": { "type": "string", "minLength": 1 }, "price": { "type": "number" }, "priceFactor": { "type": "number" }, "discountPrice": { "type": "number" }, "skuInMarketplace": { "type": "string", "minLength": 1 }, "marketplaceItemCode": { "type": "string", "minLength": 1 }, "lastUpdateStatusDate": { "type": "string", "minLength": 1 }, "transmissionMessage": { "type": "string", "minLength": 1 } } } }, "page": { "type": "object", "properties": { "size": { "type": "number" }, "totalElements": { "type": "number" }, "totalPages": { "type": "number" }, "number": { "type": "number" } }, "required": [ "size", "totalElements", "totalPages", "number" ] } }, "required": [ "links", "content", "page" ], "x-examples": { "example-1": { "links": [ { "rel": "next", "href": "string" } ], "content": [ { "id": 0, "idInMarketplace": "string", "marketPlace": "B2W", "title": "string", "publicationStatus": "ACTIVE", "transmissionStatus": "string", "errorMsg": "string", "price": 0, "priceFactor": 0, "discountPrice": 0, "skuInMarketplace": "string", "marketplaceItemCode": "string", "lastUpdateStatusDate": "2022-03-03T14:06:02Z", "transmissionMessage": "string" } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } } }, "examples": { "example-1": { "value": { "links": [ { "rel": "next", "href": "string" } ], "content": [ { "id": 0, "idInMarketplace": "string", "marketPlace": "B2W", "title": "string", "publicationStatus": "ACTIVE", "transmissionStatus": "string", "errorMsg": "string", "price": 0, "priceFactor": 0, "discountPrice": 0, "skuInMarketplace": "string", "marketplaceItemCode": "string", "lastUpdateStatusDate": "2022-03-03T14:06:02Z", "transmissionMessage": "string" } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } } } } } } }, "operationId": "get-skus-marketplace-simple-all", "description": "# Consulta todos os anúncios de um SKU\nConsulta todos os anúncios de um SKU filtrando o Marketplace. Um SKU pode possuir varios anúncios criados nos Marketplaces\n\nLembrando que se o total de item ultrapassar 50 mil itens o totalizador apresentara um valor aproximado", "parameters": [ { "schema": { "type": "string" }, "in": "query", "description": "Publication status que será filtado", "name": "status" } ], "x-internal": true, "x-stoplight": { "id": "8cchpah6e5lwr" } } }, "/skus/{skuId}/marketplaces": { "parameters": [ { "schema": { "type": "integer" }, "name": "skuId", "in": "path", "required": true, "description": "SKU ID" } ], "get": { "summary": "/skus/{skuId}/marketplaces", "tags": [ "SKU Marketplace" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuMarketplace" } } } } }, "404": { "$ref": "#/components/responses/404" } }, "operationId": "get-skus-skuId-marketplaces", "description": "# Retrieve all SKU Offers\nRetrieves all the offers of a SKU. A SKU might have multiple offers created in the marketplaces." }, "post": { "summary": "/skus/{skuId}/marketplaces", "operationId": "post-skus-skuId-marketplaces", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuMarketplaceDetail" } } } }, "422": { "$ref": "#/components/responses/422" } }, "description": "# Create Offer\nCreates an offer for a SKU using the given data.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostSkuMarketplace" } } } }, "tags": [ "SKU Marketplace" ] } }, "/skus/{skuId}/stocks/reservation": { "parameters": [ { "schema": { "type": "integer" }, "name": "skuId", "in": "path", "required": true, "description": "ID do SKU" } ], "get": { "summary": "/skus/{skuId}/stocks/reservation", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "integer" }, "marketplaceId": { "type": "string" }, "amount": { "type": "integer" }, "marketplace": { "type": "string" }, "typeStockReservation": { "type": "string" } } } }, "examples": { "Example 1": { "value": [ { "orderId": 0, "marketplaceId": "string", "amount": 0, "marketplace": "string", "typeStockReservation": "string" } ] }, "stoplight-Example 1": { "value": [ { "orderId": 21001610, "marketplaceId": "702-2057085-4861050", "amount": 1, "marketplace": "AMAZON", "typeStockReservation": "SALE_RESERVATION" } ] } } } } }, "404": { "$ref": "#/components/responses/404" } }, "operationId": "get-skus-skuId-stocks-reservation", "description": "# Consulta todos os pedidos em reserva de um SKU\nConsulta todos os pedidos em reserva de um SKU, utilizando o skuId como parâmetro", "parameters": [], "tags": [ "Estoque" ] } }, "/skus/{skuId}/marketplaces/{id}": { "parameters": [ { "schema": { "type": "integer" }, "name": "skuId", "in": "path", "required": true, "description": "ID do SKU" }, { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "Offer ID" } ], "get": { "summary": "/skus/{skuId}/marketplaces/{id}", "tags": [ "SKU Marketplace" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuMarketplaceById" } } } }, "404": { "$ref": "#/components/responses/404" } }, "operationId": "get-skus-skuId-marketplaces-id", "description": "# Retrieve Offer Details\nRetrieves the details of an offer by SKU ID and Offer ID." }, "put": { "summary": "/skus/{skuId}/marketplaces/{id}", "operationId": "put-skus-skuId-marketplaces-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuMarketplace" } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "tags": [ "SKU Marketplace" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutSkuMarketplace" } } } }, "description": "# Update Offer Data\nUpdates the data of an offer." }, "patch": { "summary": "/skus/{skuId}/marketplaces/{id}", "operationId": "patch-merge-skus-skuId-marketplaces-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuMarketplace" } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "description": "Updates the data of an offer using the PATCH method", "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/SkuMarketplaceMergePatch" } } }, "description": "" }, "tags": [ "SKU Marketplace" ] } }, "/skus/{skuId}/marketplaces/patch/{id}": { "parameters": [ { "schema": { "type": "integer" }, "name": "skuId", "in": "path", "required": true, "description": "SKU ID" }, { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "Offer ID" } ], "patch": { "summary": "/skus/{skuId}/marketplaces/patch/{id}", "operationId": "patch-skus-skuId-marketplaces-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuMarketplace" } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "tags": [ "SKU Marketplace" ], "description": "Updates the data of an offer using the PATCH method", "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/SkuMarketplacePatch" }, "examples": { "example-1": { "value": [ { "op": "add", "path": "/permalink", "value": "Link da publicação no marketplace" }, { "op": "replace", "path": "/skuInMarketplace", "value": "skuNovo" }, { "op": "replace", "path": "/fields/title", "value": "novo titulo" } ] } } } }, "description": "" } } }, "/skus/{skuId}/marketplaces/{id}/send": { "parameters": [ { "schema": { "type": "integer" }, "name": "skuId", "in": "path", "required": true, "description": "SKU ID" }, { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "Offer ID" } ], "post": { "summary": "/skus/{skuId}/marketplaces/{id}/send", "tags": [ "SKU Marketplace" ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" } }, "operationId": "get-skus-skuId-marketplaces-id-send", "description": "# Send Marketplace Offer\nInitiates the publishing process for unpublished offers. If the offer is already published, it sends the offer update." } }, "/skus/marketplaces/prices": { "put": { "summary": "/skus/marketplaces/prices", "tags": [ "SKU Marketplace" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutSkuMarketplaceUpdatePricesResourceResponse" }, "examples": { "example-1": { "value": [ { "id": 0, "errorMsg": "string" } ] } } } } }, "422": { "$ref": "#/components/responses/422" } }, "operationId": "get-skus-marketplaces-prices", "description": "# Update Price and Discount Price of an Offer list\nUpdates the price and discountPrice of an offer list, calculating automatically the discount value and additional price factor of each offer.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutSkuMarketplaceUpdatePricesResource" }, "examples": { "example-1": { "value": [ { "id": 0, "price": 0, "discountPrice": 0 } ] } } } } } } }, "/skus/{skuId}/updatePrice/{marketPlace}": { "parameters": [ { "schema": { "type": "integer" }, "name": "skuId", "in": "path", "required": true, "description": "ID do SKU" }, { "$ref": "#/components/parameters/marketPlace" } ], "post": { "summary": "/skus/{skuId}/updatePrice/{marketPlace}", "tags": [ "SKU Marketplace" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuMarketplaceUpdatePricesErrorResource" } } } }, "422": { "$ref": "#/components/responses/422" } }, "operationId": "get-skus-skuId-updatePrice-marketPlace", "description": "# Update Price and Discount Price of a Marketplace Offer list\nUpdates the price and discountPrice of a marketplace offer list. Products offers using COST price scope can't be updated using this request.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuMarketplacePricePost" } } }, "description": "" } } }, "/template": { "post": { "summary": "/template", "operationId": "post-template", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" }, "examples": { "example-1": { "value": { "id": 0, "name": "string", "content": "string", "templateType": "HTML", "plainTextContent": "string", "includeDimensionAttributes": true, "manualImageSize": true, "manualImgAttributes": "string", "isActive": true, "removeDescriptionTableContent": true, "marketPlace": "B2W_NEW_API" } } } } } }, "422": { "$ref": "#/components/responses/422" } }, "description": "# Create Template\nCreates a new description template.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostTemplate" } } } }, "tags": [ "Template" ] } }, "/template/{marketPlace}/all": { "parameters": [ { "$ref": "#/components/parameters/marketPlace" } ], "get": { "summary": "/template/{marketPlace}/all", "tags": [ "Template" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_Template" }, "examples": { "example-1": { "value": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 0, "name": "string", "content": "string", "templateType": "HTML", "plainTextContent": "string", "includeDimensionAttributes": true, "manualImageSize": true, "manualImgAttributes": "string", "isActive": true, "removeDescriptionTableContent": true, "marketPlace": "B2W_NEW_API" } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } } } } } } }, "operationId": "get-template-marketPlace-all", "description": "# Retrieve templates by Marketplace\nRetieves all templates of a specifc marketplace.", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" } ] } }, "/template/{id}": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "ID do template gerado pelo ANYMARKET" } ], "get": { "summary": "/template/{id}", "tags": [ "Template" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" }, "examples": { "example-1": { "value": { "id": 0, "name": "string", "content": "string", "templateType": "HTML", "plainTextContent": "string", "includeDimensionAttributes": true, "manualImageSize": true, "manualImgAttributes": "string", "isActive": true, "removeDescriptionTableContent": true, "marketPlace": "B2W_NEW_API" } } } } } }, "404": { "$ref": "#/components/responses/404" } }, "operationId": "get-template-id", "description": "# Retrieve Template Details\nRetrieves the details of a template by Template ID." }, "put": { "summary": "/template/{id}", "operationId": "put-template-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" }, "examples": { "example-1": { "value": { "id": 0, "name": "string", "content": "string", "templateType": "HTML", "plainTextContent": "string", "includeDimensionAttributes": true, "manualImageSize": true, "manualImgAttributes": "string", "isActive": true, "removeDescriptionTableContent": true, "marketPlace": "B2W_NEW_API" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "tags": [ "Template" ], "description": "# Update Template\nUptades a template data.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutTemplate" }, "examples": { "example-1": { "value": { "name": "string", "content": "string", "templateType": "HTML", "plainTextContent": "string", "includeDimensionAttributes": true, "manualImageSize": true, "manualImgAttributes": "string", "isActive": true, "removeDescriptionTableContent": true } } } } } } }, "delete": { "summary": "/template/{id}", "operationId": "delete-template-id", "responses": { "204": { "description": "No Content" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "tags": [ "Template" ], "description": "# Delete Template\nDeletes a template." } }, "/template/{id}/active": { "parameters": [ { "schema": { "type": "number" }, "name": "id", "in": "path", "required": true, "description": "ID do template " } ], "get": { "summary": "/template/{id}/active", "tags": [ "Template" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "example-1": { "value": true } } } } } }, "operationId": "get-template-id-active", "description": "# Consulta se o template está ativo ou inativo\nRetorna true se o template estiver ativo e false se estiver inativo.", "parameters": [] } }, "/variations": { "get": { "summary": "/variations", "tags": [ "Tipos de variação" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_Variation" }, "examples": { "example-1": { "value": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 0, "name": "string", "partnerId": "string", "values": [ { "id": 0, "description": "string", "partnerId": "string" } ], "visualVariation": true } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } } } } } } }, "operationId": "get-variations", "description": "# Retrieve Variations Types\nRetrieves all variations types.", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/sort" }, { "schema": { "type": "string" }, "in": "query", "name": "partnerId", "description": "ID do tipo de variação no parceiro" } ] }, "post": { "summary": "/variations", "operationId": "post-variations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariationGet" }, "examples": { "example-1": { "value": { "id": 0, "name": "string", "partnerId": "string", "values": [ { "id": 0, "description": "string", "partnerId": "string" } ], "visualVariation": true } } } } } }, "422": { "$ref": "#/components/responses/422" } }, "description": "# Create Variation Type\nCreates a Variation Type using the given data.", "requestBody": { "content": { "application/json": { "examples": { "example-1": { "value": { "name": "string", "partnerId": "string", "values": [ { "description": "string", "partnerId": "string" } ], "visualVariation": true } }, "stoplight-example-1": { "value": { "name": "string", "partnerId": "string", "values": [ { "description": "string", "partnerId": "string" } ], "visualVariation": true } } }, "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Nome do Tipo de Variação" }, "partnerId": { "type": "string", "description": "ID do Tipo de Variação no parceiro" }, "values": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Nome do Valor de Variação (ex: Amarelo, Azul...)" }, "partnerId": { "type": "string", "description": "ID do Valor de Variação no parceiro" } } } }, "visualVariation": { "type": "boolean", "description": "Informa se o Tipo de Variação é visual (ex: cor)" } }, "required": [ "name" ] } } }, "description": "" }, "tags": [ "Tipos de variação" ] } }, "/variations/{id}": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "ID do tipo de variação gerado pelo ANYMARKET" } ], "get": { "summary": "/variations/{id}", "tags": [ "Tipos de variação" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariationGet" }, "examples": { "example-1": { "value": { "id": 0, "name": "string", "partnerId": "string", "values": [ { "id": 0, "description": "string", "partnerId": "string" } ], "visualVariation": true } } } } } }, "404": { "$ref": "#/components/responses/404" } }, "operationId": "get-variations-id", "description": "# Retrieve Variation Type details\nRetrieves the details of a Variation Type." }, "put": { "summary": "/variations/{id}", "operationId": "put-variations-id", "tags": [ "Tipos de variação" ], "description": "# Update Variation Type\nUpdate a Variation Type using the given data.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariationGet" }, "examples": { "example-1": { "value": { "id": 0, "name": "string", "partnerId": "string", "values": [ { "id": 0, "description": "string", "partnerId": "string" } ], "visualVariation": true } } } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariationTypePut" }, "examples": { "example-1": { "value": { "name": "string", "partnerId": "string", "visualVariation": true } } } } } } }, "delete": { "summary": "/variations/{id}", "operationId": "delete-variations-id", "responses": { "204": { "description": "No Content" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" } }, "tags": [ "Tipos de variação" ], "description": "# Delete Variation Type\nDeletes a Variation Type." } }, "/transmissions": { "get": { "summary": "/transmissions", "tags": [ "Transmissão" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_Transmission" }, "examples": { "example-1": { "value": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 0, "accountName": "string", "description": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 0, "name": "string" }, "product": { "id": 0, "title": "string" }, "nbm": { "id": "string", "description": "string" }, "origin": { "id": 0, "description": "string" }, "model": "string", "videoUrl": "string", "warrantyTime": 0, "warrantyText": "string", "height": 0, "width": 0, "weight": 0, "length": 0, "status": "string", "transmissionMessage": "string", "publicationStatus": "ACTIVE", "marketPlaceStatus": "string", "priceFactor": 0, "sku": { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "price": 0, "amount": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "discountPrice": 0 }, "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "images": [ { "id": 0, "index": 0, "main": true, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "string", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } ] } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } } } } } } }, "operationId": "get-transmissions", "description": "Retrieve Transmissions\nRetrieves all E-Commerce tranmissions.", "parameters": [ { "schema": { "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 90071992 }, "in": "query", "name": "offset", "description": "Número de itens a ignorar no início da lista de resultados, usado para paginação." }, { "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "in": "query", "name": "sortDirection", "description": "Define a direção da ordenação dos resultados, podendo ser \"asc\" (ascendente) ou \"desc\" (descendente)." }, { "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 100 }, "in": "query", "name": "limit", "description": "Número máximo de itens a serem retornados na resposta." }, { "schema": { "type": "array", "items": { "type": "string", "enum": [ "UNPUBLISHED", "CLOSED", "CORRUPTED", "PAUSED", "WITHOUT_STOCK", "ACTIVE" ] } }, "in": "query", "name": "statusFilter", "description": "Lista de status a serem filtrados separados por virgula." }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "description": "Atributo para ordenação." } ] } }, "/transmissions/{id}": { "parameters": [ { "schema": { "type": "integer" }, "name": "id", "in": "path", "required": true, "description": "ID do SKU gerado pelo ANYMARKET" } ], "get": { "summary": "/transmissions/{id}", "tags": [ "Transmissão" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transmission" }, "examples": { "example-1": { "value": { "id": 0, "accountName": "string", "description": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 0, "name": "string" }, "product": { "id": 0, "title": "string" }, "nbm": { "id": "string", "description": "string" }, "origin": { "id": 0, "description": "string" }, "model": "string", "videoUrl": "string", "warrantyTime": 0, "warrantyText": "string", "height": 0, "width": 0, "weight": 0, "length": 0, "status": "string", "transmissionMessage": "string", "publicationStatus": "ACTIVE", "marketPlaceStatus": "string", "priceFactor": 0, "sku": { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "price": 0, "amount": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "discountPrice": 0 }, "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "images": [ { "id": 0, "index": 0, "main": true, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "string", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } ] } } } } } }, "404": { "$ref": "#/components/responses/404" } }, "operationId": "get-transmissions-id", "description": "# Retrieve Transmission Details\nRetrieves the details of a E-Commerce transmission." }, "put": { "summary": "/transmissions/{id}", "operationId": "put-transmissions-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transmission" }, "examples": { "example-1": { "value": { "id": 0, "accountName": "string", "description": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 0, "name": "string" }, "product": { "id": 0, "title": "string" }, "nbm": { "id": "string", "description": "string" }, "origin": { "id": 0, "description": "string" }, "model": "string", "videoUrl": "string", "warrantyTime": 0, "warrantyText": "string", "height": 0, "width": 0, "weight": 0, "length": 0, "status": "string", "transmissionMessage": "string", "publicationStatus": "ACTIVE", "marketPlaceStatus": "string", "priceFactor": 0, "sku": { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "price": 0, "amount": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "discountPrice": 0 }, "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "images": [ { "id": 0, "index": 0, "main": true, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "string", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } ] } } } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "tags": [ "Transmissão" ], "description": "# Update Transmission Data\nUpdates the data of a E-Commerce transmission.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransmissionPut" }, "examples": { "example-1": { "value": { "publicationStatus": "ACTIVE", "marketPlaceStatus": "string" } } } } } } } }, "/transmissions/marketplace/{marketplace}": { "parameters": [ { "schema": { "type": "string", "enum": [ "ALIEXPRESS", "AMAZON_GLOBAL_API", "ANGELONI", "ARMAZEM_PARAIBA", "B2W_NEW_API", "BABYBIZ", "BANCO_INTER", "BANDSHOP", "BELEZA_NA_WEB_NEW_API", "BRAVIUM", "C_A", "CARREFOUR", "CASA_VIDEO", "CASSOL_CENTERLAR", "CENTAURO_NEW_API", "CLAROSHOP_MEXICO", "COMFORTFLEX_NOVA_API", "COMPRA_CERTA", "COPPEL", "CSM", "DB1_MARKETPLACE", "DECATHLON", "DIGIGROW", "EFACIL", "ELEKTRA", "EOS", "EPOCA", "ESTANTE_VIRTUAL", "FALABELLA", "FARMADELIVERY", "FASTSHOP_NEW_API", "FENICIO", "FOODIES_STORE", "GFG", "GRUPO_MATEUS", "HELP_SELLER", "HITES", "HOUSE_OF_GAMERS", "ICBC_MALL", "IGA", "ITAU", "JUMPSELLER", "KABUM", "KOERICH", "LE_BISCUIT", "LEROY_MERLIN", "LIVESHOP", "LL_LOYALTY", "LOJA_DO_COOPERADO", "LOJA_DO_MECANICO", "LOJAS_COLOMBO", "LOJAS_IMPERIO", "LOJAS_LEBES_NEW_API", "LOJAS_MM", "LOJAS_QUERO_QUERO", "MADEIRA_MADEIRA", "MAGAZINE_LUIZA", "MAGENTO", "MAIS_CORREIOS", "MARCA_SELETA", "MARTINS_ATACADO", "MEGATONE", "MOBLY", "MULTIVAREJO_GPA", "NETSHOES", "NEXTSHOP", "NUVEMSHOP", "OLIST_NEW_API", "PAGUE_MENOS", "PARIS", "PHILIPS_STORE", "PITSTOP", "PNEUBEST", "POLISHOP", "POSTHAUS_NEW_API", "PRESTASHOP", "PRIVALIA", "RAIA_DROGASIL", "RAMARIM_NOVA_API", "RENNER", "RI_HAPPY_NEW_API", "RIACHUELO", "RIPLEY", "SENFF_SHOPPING", "SHEIN", "SHOPEE", "SHOPHUB", "SHOPIFY", "SHOPPING_BB", "SHOPPING_LIVELO", "SICOOB", "SICREDI", "STECK", "SUBLIMITY", "TA_TASHOP", "TENDA_ATACADO", "THE_HOME_DEPOT", "TIENDA_CLIC", "TIKTOK_SHOP", "TRAY", "TROCAFONE", "VALE_BONUS", "VENTURESHOP", "VINKLO_BY_FESTALAB", "VTEX", "WALMART", "WEB_CONTINENTAL_V2", "WEHOUSE", "WOOCOMMERCE", "WOOCOMMERCE2", "YA_PLACE_STORE", "ZEMA", "ZOOM" ] }, "name": "marketplace", "in": "path", "required": true } ], "get": { "summary": "/transmissions/marketplace/{marketplace}", "tags": [ "Transmissão" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "example-1": { "value": { "links": [ { "rel": "string", "href": "string" } ], "content": [ { "id": 0, "accountName": "string", "description": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 0, "name": "string" }, "product": { "id": 0, "title": "string" }, "nbm": { "id": "string", "description": "string" }, "origin": { "id": 0, "description": "string" }, "model": "string", "videoUrl": "string", "warrantyTime": 0, "warrantyText": "string", "height": 0, "width": 0, "weight": 0, "length": 0, "status": "string", "transmissionMessage": "string", "publicationStatus": "ACTIVE", "marketPlaceStatus": "string", "priceFactor": 0, "sku": { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "price": 0, "amount": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "discountPrice": 0 }, "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "images": [ { "id": 0, "index": 0, "main": true, "url": "string", "thumbnailUrl": "string", "lowResolutionUrl": "string", "standardUrl": "string", "originalImage": "string", "variation": "string", "status": "string", "statusMessage": "string", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } ] } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } } } } } } }, "operationId": "get-transmissions-marketplace-marketplace", "description": "# Consulta todas as transmissões de um determinado marketplace\nConsulta todas as transmissões de um determinado marketplace", "parameters": [ { "schema": { "type": "string", "enum": [ "ACTIVE", "CLOSED", "PAUSED", "UNPUBLISHED", "WITHOUT_STOCK", "CORRUPTED" ] }, "in": "query", "name": "statusFilter", "description": "Lista de status a serem filtrados separados por virgula." }, { "schema": { "type": "string" }, "in": "query", "name": "limit", "description": "Número máximo de transmissões", "required": true }, { "schema": { "type": "string" }, "in": "query", "required": true, "name": "offset", "description": "Número de itens a ignorar no início da lista de resultados, usado para paginação." }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "description": "Atributo para ordenação" }, { "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "in": "query", "name": "sortDirection", "description": "Define a direção da ordenação dos resultados, podendo ser \"asc\" (ascendente) ou \"desc\" (descendente)." } ] } }, "/variations/{typeId}/values": { "parameters": [ { "schema": { "type": "integer" }, "name": "typeId", "in": "path", "required": true, "description": "ID do tipo de variação gerado pelo ANYMARKET" } ], "get": { "summary": "/variations/{typeId}/values", "tags": [ "Valores de variação" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_VariationValue" }, "examples": { "example-1": { "value": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 0, "description": "string", "partnerId": "string" } ], "page": { "size": 5, "totalElements": 0, "totalPages": 0, "number": 0 } } } } } } } }, "operationId": "get-variations-typeId-values", "description": "# Retrieve Variation Type Values\nRetrieves all the values of a variation type.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "description": "Partner Variation Type ID", "name": "partnerId" } ] }, "post": { "summary": "/variations/{typeId}/values", "operationId": "post-variations-typeId-values", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariationValueGet" }, "examples": { "example-1": { "value": { "id": 0, "description": "string", "partnerId": "string" } } } } } }, "422": { "$ref": "#/components/responses/422" } }, "tags": [ "Valores de variação" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariationValuePost" }, "examples": { "example-1": { "value": { "description": "string", "partnerId": "string" } } } } } }, "description": "# Create Variation Type Value\nCreates a variation type value using the given data." } }, "/variations/{typeId}/values/{valueId}": { "parameters": [ { "schema": { "type": "integer" }, "name": "typeId", "in": "path", "required": true, "description": "ID do tipo de variação gerado pelo ANYMARKET" }, { "schema": { "type": "integer" }, "name": "valueId", "in": "path", "required": true, "description": "ID do valor de variação gerado pelo ANYMARKET" } ], "get": { "summary": "/variations/{typeId}/values/{valueId}", "tags": [ "Valores de variação" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariationValueGet" } } } }, "404": { "$ref": "#/components/responses/404" } }, "operationId": "get-variations-typeId-values-valueId", "description": "# Retrieve Vartiation Type Value Details\nRetrieves the details of a Variation Type value." }, "put": { "summary": "/variations/{typeId}/values/{valueId}", "operationId": "put-variations-typeId-values-valueId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariationValueGet" }, "examples": { "example-1": { "value": { "id": 0, "description": "string", "partnerId": "string" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "tags": [ "Valores de variação" ], "description": "# Update Variation Type Value Data\nUpdates the data of a Variation Type Value.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariationValuePut" }, "examples": { "example-1": { "value": { "description": "string", "partnerId": "string" } } } } } } }, "delete": { "summary": "/variations/{typeId}/values/{valueId}", "operationId": "delete-variations-typeId-values-valueId", "responses": { "204": { "description": "No Content" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" } }, "tags": [ "Valores de variação" ], "description": "# Delete Vartiation Type Value\nDeletes the specified Variation Type Value." } }, "/categories/characteristics/groups/{id}": { "get": { "summary": "Consulta todos os valores de grupo de características pelo ID", "tags": [ "Grupo de caracteristica" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID do grupo de caracteristicas gerado pelo ANYMARKET" }, "name": { "type": "string", "description": "Nome do grupo de caracteristica", "minLength": 1, "maxLength": 255 }, "characteristics": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID do anúncio no ANYMARKET" }, "index": { "type": "integer", "description": "Índice do anúncio por Marketplace" }, "name": { "type": "string", "description": "Nome da caracteristica", "maxLength": 255 }, "characteristicItemMarketPlaces": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID do caracteristica no ANYMARKET" }, "marketPlace": { "type": "string", "description": "Identificador do MARKETPLACE" }, "idInMarketplace": { "type": "string", "description": "ID da Característica no Marketplace" }, "required": { "type": "boolean" } } } } } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da categoria", "minimum": 0 }, "name": { "type": "string", "description": "Nome da categoria", "minLength": 0, "maxLength": 80 }, "path": { "type": "string", "description": "Diretório e subdiretórios da categoria", "minLength": 0, "maxLength": 1000 } } } } } }, "examples": { "example-1": { "value": { "id": 0, "name": "string", "characteristics": [ { "id": 0, "index": 0, "name": "string", "characteristicItemMarketPlaces": [ { "id": 0, "marketPlace": "string", "idInMarketplace": "string", "required": true } ] } ], "categories": [ { "id": 0, "name": "string", "path": "string" } ] } }, "stoplight-example-1": { "value": { "id": 38, "name": "testeTESTE", "characteristics": [ { "id": 57, "index": 0, "name": "testeTESTE", "characteristicItemMarketPlaces": [ { "id": 79, "marketPlace": "ECOMMERCE", "idInMarketplace": "testeTESTE", "required": true } ] } ], "categories": [ { "id": 2695, "name": "To mexendo mesmo", "path": "To mexendo mesmo" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } } }, "operationId": "get-categories-characteristics-groups", "description": "Consulta todos os valores de grupo de caracteristicas", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "parameters": [], "security": [ { "gumgaToken": [] } ] }, "put": { "summary": "Altera os dados de um grupo de características", "tags": [ "Grupo de caracteristica" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID Grupo de caracteristica" }, "name": { "type": "string", "description": "Nome Grupo de caracteristica", "minLength": 1, "maxLength": 255 }, "characteristics": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID caracteristica" }, "name": { "type": "string", "description": "Nome de caracteristicas", "maxLength": 255 }, "characteristicItemMarketPlaces": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID Caracteristica do marketplace" }, "marketPlace": { "type": "string", "description": "Identificador do MARKETPLACE" }, "idInMarketplace": { "type": "string", "description": "ID do anúncio no Marketplace" }, "required": { "type": "boolean" } } } } } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID Categoria" }, "name": { "type": "string", "description": "Nome Categoria" }, "path": { "type": "string", "description": "Diretório e subdiretórios da categoria" } } } } } }, "examples": { "example-1": { "value": { "id": 38, "name": "teste", "characteristics": [ { "id": 68, "name": "testeTESTE", "characteristicItemMarketPlaces": [ { "id": 77, "marketPlace": "ECOMMERCE", "idInMarketplace": "testeTESTE", "required": true } ] } ], "categories": [ { "id": 2756, "name": "#62i9sto", "path": "#62i9sto" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/409" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "operationId": "put-categories-characteristics-groups", "description": "Atualiza os dados de um grupo de caracteriticas\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.\n>\n> Campos omitidos podem ser redefinidos ou apagados.\n>\n> Use este método quando quiser sobrescrever todas as informações.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "characteristics": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string", "maxLength": 255 }, "characteristicItemMarketPlaces": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "marketPlace": { "type": "string" }, "idInMarketplace": { "type": "string", "description": "ID da Característica no Marketplace" }, "required": { "type": "boolean" } }, "required": [ "id", "marketPlace" ] } } } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" } }, "required": [ "id" ] } } }, "required": [ "name", "characteristics", "categories" ] }, "examples": { "example-1": { "value": { "id": 0, "name": "string", "characteristics": [ { "id": 0, "name": "string", "characteristicItemMarketPlaces": [ { "id": 0, "marketPlace": "string", "idInMarketplace": "string", "required": true } ] } ], "categories": [ { "id": 0, "name": "string", "path": "string" } ] } }, "stoplight-example-1": { "value": { "id": 38, "name": "teste", "characteristics": [ { "id": 35, "name": "testeTESTE", "characteristicItemMarketPlaces": [ { "id": 77, "marketPlace": "ECOMMERCE", "idInMarketplace": "testeTESTE", "required": true } ] } ], "categories": [ { "id": 2756, "name": "#62i9sto", "path": "#62i9sto" } ] } } } }, "application/xml": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "characteristics": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "characteristicItemMarketPlaces": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "marketPlace": { "type": "string" }, "idInMarketplace": { "type": "string" }, "required": { "type": "boolean" } } } } } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" } } } } } }, "examples": { "example-1": { "value": { "id": 38, "name": "teste", "characteristics": [ { "id": 35, "name": "testeTESTE", "characteristicItemMarketPlaces": [ { "id": 77, "marketPlace": "ECOMMERCE", "idInMarketplace": "testeTESTE", "required": true } ] } ], "categories": [ { "id": 2756, "name": "#62i9sto", "path": "#62i9sto" } ] } } } } } }, "security": [ { "gumgaToken": [] } ] }, "delete": { "summary": "Excluir grupo de caracteristica", "tags": [ "Grupo de caracteristica" ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/409" } } } } }, "operationId": "delete-categories-characteristics-groups", "description": "Exclui grupo de caracteristica", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } }, "application/xml": { "schema": { "type": "object", "properties": {} } }, "multipart/form-data": { "schema": { "type": "object", "properties": {} } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "header", "name": "gumgaToken" } ], "security": [ { "gumgaToken": [] } ] }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true } ] }, "/categories/characteristics/groups": { "get": { "summary": "Consulta todos os dados de grupos de características", "operationId": "get-categories-characteristics-groups-list", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "links": { "type": "array", "description": "Referências de paginação", "items": { "type": "object", "properties": { "rel": { "type": "string", "description": "Relacionamento do hyperlink" }, "href": { "type": "string", "description": "URL de definição do recurso" } } } }, "content": { "type": "array", "description": "Lista de grupos de características", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID do grupo de características gerado pelo ANYMARKET" }, "name": { "type": "string", "description": "Nome do grupo de características", "minLength": 1, "maxLength": 255 }, "characteristics": { "type": "array", "description": "Lista de características do grupo", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da característica" }, "index": { "type": "integer", "description": "Ordem da característica no grupo" }, "name": { "type": "string", "description": "Nome da característica", "maxLength": 255 }, "characteristicItemMarketPlaces": { "type": "array", "description": "Lista de vínculos da característica com marketplaces", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID do vínculo da característica com marketplace" }, "marketPlace": { "type": "string", "description": "Nome do marketplace" }, "idInMarketplace": { "type": "string", "description": "ID da característica no marketplace" }, "required": { "type": "boolean", "description": "Indica se a característica é obrigatória" } } } } } } }, "categories": { "type": "array", "description": "Lista de categorias vinculadas ao grupo", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da categoria" }, "name": { "type": "string", "description": "Nome da categoria" }, "path": { "type": "string", "description": "Caminho completo da categoria" } } } } } } }, "page": { "type": "object", "properties": { "size": { "type": "integer", "description": "Tamanho da página" }, "totalElements": { "type": "integer", "description": "Total de elementos" }, "totalPages": { "type": "integer", "description": "Total de páginas" }, "number": { "type": "integer", "description": "Página atual" } } } } }, "examples": { "example-1": { "value": { "links": [ { "rel": "next", "href": "https://api.anymarket.com.br/v2/categories/characteristics/groups?offset=5" } ], "content": [ { "id": 1, "name": "Livros", "characteristics": [ { "id": 10, "index": 0, "name": "Autor", "characteristicItemMarketPlaces": [ { "id": 100, "marketPlace": "MARKETPLACE_EXEMPLO", "idInMarketplace": "author", "required": true } ] }, { "id": 11, "index": 1, "name": "ISBN", "characteristicItemMarketPlaces": [ { "id": 101, "marketPlace": "MARKETPLACE_EXEMPLO", "idInMarketplace": "isbn", "required": false } ] } ] }, { "id": 2, "name": "Moda", "characteristics": [ { "id": 20, "index": 0, "name": "Tamanho" }, { "id": 21, "index": 1, "name": "Cor" } ], "categories": [ { "id": 200, "name": "Roupas", "path": "Roupas" } ] } ], "page": { "size": 5, "totalElements": 2, "totalPages": 1, "number": 0 } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } } }, "description": "# Consulta grupos de características\nConsulta todos os grupos de características cadastrados.", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" } ], "tags": [ "Grupo de caracteristica" ] }, "post": { "summary": "Cria um grupo de caracteristicas com os dados informados", "tags": [ "Grupo de caracteristica" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID Grupo de caracteristica" }, "name": { "type": "string", "description": "Nome Grupo de caracteristica", "minLength": 1, "maxLength": 255 }, "characteristics": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID caracteristica" }, "index": { "type": "integer", "description": "Índice do anúncio por Marketplace" }, "name": { "type": "string", "description": "Nome de caracteristicas", "maxLength": 255 }, "characteristicItemMarketPlaces": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID Caracteristica do marketplace" }, "marketPlace": { "type": "string", "description": "Identificador do MARKETPLACE" }, "idInMarketplace": { "type": "string", "description": "ID da Característica no Marketplace" }, "required": { "type": "boolean" } } } } } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID Categoria" }, "name": { "type": "string", "description": "Nome Categoria" }, "path": { "type": "string", "description": "Diretório e subdiretórios da categoria" } } } } } }, "examples": { "example-1": { "value": { "id": 39, "name": "Pipoca_2", "characteristics": [ { "id": 66, "index": 0, "name": "Pipoca1", "characteristicItemMarketPlaces": [ { "id": 80, "marketPlace": "ECOMMERCE", "idInMarketplace": "Boby", "required": true }, { "id": 81, "marketPlace": "MAGAZINE_LUIZA", "idInMarketplace": "Boby", "required": false } ] }, { "id": 67, "index": 0, "name": "Pipoca2", "characteristicItemMarketPlaces": [ { "id": 82, "marketPlace": "ECOMMERCE", "idInMarketplace": "Boby", "required": true } ] } ], "categories": [ { "id": 2695, "name": "To mexendo mesmo", "path": "To mexendo mesmo" } ] } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/409" } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } }, "operationId": "post-categories-characteristics-groups", "description": "Cria um grupo de caracteristicas com os dados informados", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Nome do grupo de caracteristica", "minLength": 1, "maxLength": 255 }, "characteristics": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "description": "Índice do anúncio por Marketplace" }, "name": { "type": "string", "description": "Nome da caracteristica", "maxLength": 255 }, "characteristicItemMarketPlaces": { "type": "array", "items": { "type": "object", "properties": { "marketPlace": { "type": "string", "description": "Identificador do MARKETPLACE" }, "idInMarketplace": { "type": "string", "description": "ID do anúncio no Marketplace" }, "required": { "type": "boolean" } }, "required": [ "marketPlace", "required" ] } } } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da categoria" }, "name": { "type": "string", "description": "Nome da categoria" }, "path": { "type": "string", "description": "Diretório e subdiretórios da categoria" } }, "required": [ "id" ] } } }, "required": [ "name", "characteristics", "categories" ] }, "examples": { "example-1": { "value": { "name": "string", "characteristics": [ { "index": 0, "name": "string", "characteristicItemMarketPlaces": [ { "marketPlace": "string", "idInMarketplace": "string", "required": true } ] } ], "categories": [ { "id": 0, "name": "string", "path": "string" } ] } }, "stoplight-example-1": { "value": { "name": "Pipoca_2", "characteristics": [ { "index": 0, "name": "Pipoca1", "characteristicItemMarketPlaces": [ { "marketPlace": "ECOMMERCE", "idInMarketplace": "Boby", "required": true }, { "marketPlace": "MAGAZINE_LUIZA", "idInMarketplace": "Boby", "required": false } ] }, { "index": 0, "name": "Pipoca2", "characteristicItemMarketPlaces": [ { "marketPlace": "ECOMMERCE", "idInMarketplace": "Boby", "required": true } ] } ], "categories": [ { "id": 2695, "name": "To mexendo mesmo", "path": "To mexendo mesmo" }, { "id": 2756, "name": "#62i9sto", "path": "#62i9sto" } ] } } } } }, "description": "" }, "security": [ { "gumgaToken": [] } ] } }, "/brands/marketplace/{marketplace}": { "parameters": [ { "schema": { "type": "string" }, "name": "marketplace", "in": "path", "required": true, "description": "Marketplace" } ], "get": { "summary": "Consulta as Marcas para Vínculo", "operationId": "get-brands-bind-marketplace", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "codeInMarketplace": { "type": "string" }, "name": { "type": "string" } } }, "examples": { "Example 1": { "value": { "codeInMarketplace": "string", "name": "string" } }, "stoplight-Example 1": { "value": { "codeInMarketplace": "string", "name": "string" } } } } } } }, "tags": [ "Marcas" ], "description": "# Consulta as Marcas para Vínculo\n\nConsulta todos os vínculos de marcas por marketplace." } }, "/brands/{id}/bind/{marketplace}": { "parameters": [ { "schema": { "type": "string" }, "name": "marketplace", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true } ], "post": { "summary": "Vincula Marcas com os Marketplaces", "operationId": "post-brands-bind-marketplace", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "marketPlace": { "type": "string" }, "id": { "type": "integer" }, "codeInMarketplace": { "type": "string" } } }, "examples": { "Example 1": { "value": { "marketPlace": "string", "id": 0, "codeInMarketplace": "string" } }, "stoplight-Example 1": { "value": { "marketPlace": "GFG", "id": 21208, "codeInMarketplace": "MLB432912" } } } } } }, "400": { "description": "{\n \"code\": \"400\",\n \"message\": \"O campo 'marketplace' na url está em formato incorreto. Verifique a documentação para maiores detalhes.\"\n}" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "codeInMarketplace": { "type": "string" } } }, "examples": { "Example 1": { "value": { "codeInMarketplace": "string" } }, "stoplight-Example 1": { "value": { "codeInMarketplace": "MLB432912" } } } } }, "description": "" }, "description": "# Cria um vínculo de Marca\n\nA vinculação de marcas nada mais é que um DE/PARA que o seller ira realizar na camada ANYMARKET, informando ao marketplace que a marca \"X\" corresponde a marca \"Y\" do marketplace em questão.", "tags": [ "Marcas" ] }, "put": { "summary": "Alterar Vínculo de Marcas", "operationId": "put-brands-id-bind-marketplace", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "marketPlace": { "type": "string" }, "id": { "type": "integer" }, "codeInMarketplace": { "type": "string" } } }, "examples": { "Example 1": { "value": { "marketPlace": "string", "id": 0, "codeInMarketplace": "string" } }, "stoplight-Example 1": { "value": { "marketPlace": "GFG", "id": 21208, "codeInMarketplace": "MLB432912" } } } } } }, "400": { "description": "{\n \"code\": \"400\",\n \"message\": \"O campo 'marketplace' na url está em formato incorreto. Verifique a documentação para maiores detalhes.\"\n}" } }, "description": "# Altera um Vínculo de Marca\n\nA vinculação de marcas nada mais é que um DE/PARA que o seller ira realizar na camada ANYMARKET, informando ao marketplace que a marca \"X\" corresponde a marca \"Y\" do marketplace em questão.\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.\n>\n> Campos omitidos podem ser redefinidos ou apagados.\n>\n> Use este método quando quiser sobrescrever todas as informações.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "codeInMarketplace": { "type": "string" } } }, "examples": { "Example 1": { "value": { "codeInMarketplace": "string" } }, "stoplight-Example 1": { "value": { "codeInMarketplace": "string" } } } } }, "description": "" }, "tags": [ "Marcas" ] } }, "/orders/{orderId}/returns/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "orderId", "in": "path", "required": true, "description": "ID do Pedido no ANYMARKET" }, { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "ID da Devolução no ANYMARKET" } ], "get": { "summary": "/orders/{orderId}/returns/{id}", "tags": [ "Devolução" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "orderId", "marketplace", "marketplaceOrderId", "marketplaceReturnId", "marketplaceTypeId", "accountId", "status", "reason", "type", "createdAt", "items", "history" ], "properties": { "id": { "type": "integer", "description": "ID da Devolução" }, "orderId": { "type": "integer", "description": "ID do Pedido no ANYMARKET" }, "oi": { "type": "string" }, "marketplace": { "$ref": "#/components/schemas/EnumMarketplaces" }, "marketplaceOrderId": { "type": "string", "description": "ID público do pedido no marketplace" }, "marketplaceReturnId": { "type": "string", "description": "ID público da devolução no marketplace" }, "marketplaceTypeId": { "type": "string", "description": "Tipo de devolução no marketplace", "example": "automatic, calim, dispute" }, "accountId": { "type": "string", "description": "ID da conta no ANYMARKET" }, "accountName": { "type": "string", "description": "Nome da conta no ANYMARKET" }, "paymentStatus": { "type": "string", "description": "Status do pagamento da devolução" }, "status": { "description": "Status da devolução\n\n**NEW_RETURN**: Nova devolução
\n**WAITING_DELIVERY**: Retorno ao CD do seller
\n**WAITING_DELIVERY_MARKETPLACE**: Retorno ao CD do marketplace
\n**WAITING_CONFERENCE**: Aguardando conferência
\n**CHECKED**: Devolução conferida
\n**CANCELLED**: Devolução cancelada
\n**CONCLUDED**: Devolução concluída
\n**FAILED**: Devolução falhou
\n**EXPIRED**: Devolução expirou ", "enum": [ "NEW_RETURN", "WAITING_DELIVERY", "WAITING_DELIVERY_MARKETPLACE", "WAITING_CONFERENCE", "CHECKED", "CANCELLED", "CONCLUDED", "FAILED", "EXPIRED" ] }, "reason": { "type": "string", "description": "Razão da devolução" }, "type": { "description": "Tipo de devolução", "enum": [ "TOTAL", "PARTIAL" ] }, "createdAt": { "$ref": "#/components/schemas/dateTypeGMT" }, "closedAt": { "$ref": "#/components/schemas/dateTypeGMT" }, "checkedAt": { "$ref": "#/components/schemas/dateTypeGMT" }, "updatedAt": { "$ref": "#/components/schemas/dateTypeGMT" }, "items": { "type": "array", "description": "Items devolvidos", "items": { "type": "object", "required": [ "id", "orderItemId", "skuId", "marketplaceSkuId", "quantity" ], "properties": { "id": { "type": "integer", "description": "ID do item da devolução no ANYMARKET" }, "orderItemId": { "type": "integer", "description": "Id do item no pedido gerado pelo ANYMARKET" }, "title": { "type": "string", "description": "Título do produto" }, "skuId": { "type": "integer", "description": "ID do SKU gerado pelo ANYMARKET" }, "marketplaceSkuId": { "type": "string", "description": "Código do sku no marketplace", "example": "MLB123456789, SKU_123" }, "quantity": { "type": "integer", "description": "Quantidade do item" } } } }, "shipping": { "type": "array", "description": "Envio da devolução", "items": { "type": "object", "required": [ "id", "marketplaceShippingId", "status", "type", "city", "state", "country", "createdAt" ], "properties": { "id": { "type": "integer", "description": "ID do envio da devolução no ANYMARKET" }, "marketplaceShippingId": { "type": "string", "description": "Código do envio no marketplace" }, "status": { "description": "Status do envio no marketplace\n\n**WAITING_CARRIER**: Aguardando envio
\n**TRANSIT_GOODS**: Em trânsito
\n**DELIVERED**: Devolução no CD
\n**NOT_DELIVERED**: Devolução não entregue no CD ", "enum": [ "WAITING_CARRIER", "TRANSIT_GOODS", "DELIVERED", "NOT_DELIVERED" ] }, "subStatus": { "type": "string", "description": "Substatus do envio no marketplace" }, "trackingNumber": { "type": "string", "description": "Número de rastreio" }, "estimatedDelivery": { "$ref": "#/components/schemas/dateTypeGMT" }, "transportServiceName": { "type": "string", "description": "Nome da transportadora" }, "senderName": { "type": "string", "description": "Nome do responsável pelo envio" }, "type": { "type": "string", "description": "Define o tipo do endereço de envio", "example": "selling_address" }, "addressLine": { "type": "string", "description": "Endereço completo do envio" }, "streetName": { "type": "string", "description": "Rua" }, "streetNumber": { "type": "string", "description": "Número" }, "comment": { "type": "string", "description": "Complemento" }, "zipCode": { "type": "string", "description": "Código Postal" }, "city": { "type": "string", "description": "Cidade" }, "state": { "type": "string", "description": "Estado" }, "country": { "type": "string", "description": "País" }, "neighborhood": { "type": "string", "description": "Bairro" }, "destination": { "type": "string", "description": "Define o tipo de endereço do CD\n\n**SELLER_ADDRESS**: CD do seller
\n**WAREHOUSE**: CD do marketplace", "enum": [ "SELLER_ADDRESS", "WAREHOUSE" ] }, "municipality": { "type": "string", "description": "Município" }, "createdAt": { "$ref": "#/components/schemas/dateTypeGMT" } } } }, "history": { "type": "array", "description": "Histórico da devolução", "items": { "type": "object", "required": [ "id", "returnStatus", "createdAt" ], "properties": { "id": { "type": "integer", "description": "Data da criação do envio da devolução" }, "returnStatus": { "description": "Status da devolução\n\n**NEW_RETURN**: Nova devolução
\n**WAITING_DELIVERY**: Retorno ao CD do seller
\n**WAITING_DELIVERY_MARKETPLACE**: Retorno ao CD do marketplace
\n**WAITING_CONFERENCE**: Aguardando conferência
\n**CHECKED**: Devolução conferida
\n**CANCELLED**: Devolução cancelada
\n**CONCLUDED**: Devolução concluída
\n**FAILED**: Devolução falhou
\n**EXPIRED**: Devolução expirou", "enum": [ "NEW_RETURN", "WAITING_DELIVERY", "WAITING_CONFERENCE", "CHECKED", "CANCELLED", "CONCLUDED", "FAILED", "EXPIRED", "WAITING_DELIVERY_MARKETPLACE" ] }, "shippingStatus": { "description": "Status da entrega da devolução\n\n**WAITING_CARRIER**: Aguardando envio
\n**TRANSIT_GOODS**: Em trânsito
\n**DELIVERED**: Devolução no CD
\n**NOT_DELIVERED**: Devolução não entregue no CD", "enum": [ "WAITING_CARRIER", "TRANSIT_GOODS", "DELIVERED", "NOT_DELIVERED" ] }, "shippingSubStatus": { "type": "string", "description": "Substatus da devolução" }, "createdAt": { "$ref": "#/components/schemas/dateTypeGMT" } } } }, "conference": { "type": "object", "description": "Dados de conferência da devolução", "required": [ "status" ], "properties": { "reasonDetails": { "type": "string", "description": "Detalhes do motivo da devolução" }, "status": { "enum": [ "RETURN_CHECK_OK", "RETURN_CHECK_NOT_OK" ], "description": "Status da conferência da devolução" }, "observations": { "type": "string", "description": "Observações na conferência da devolução" }, "marketplaceReview": { "type": "object", "description": "Dados da revisão do marketplace", "properties": { "method": { "type": "string", "description": "Método da revisão" }, "reviewStatus": { "type": "string", "description": "Status da revisão no marketplace" }, "productCondition": { "type": "string", "description": "Condição do produto\n\n**saleable**: o produto está em boas condições para venda.
\n**discard**: o produto foi descartado.
\n**unsaleable**: o produto não está apto para venda.
\n**missing**: o produto não chegou para revisão." }, "productDestination": { "type": "string", "description": "Destino do produto" }, "benefited": { "type": "string", "description": "Beneficiário da revisão" }, "reasonId": { "type": "string", "description": "Identificador do motivo da revisão\n\n**accepted**: o produto foi aceito.
\n**different_product**: produto diferente.
\n**discard**: produto descartado.
\n**misused**: produto mal usado.
\n**not_working**: o produto não funciona.
\n**incomplete**: produto incompleto.
\n**blocked**: produto bloqueado.
\n**open_box**: produto de caixa aberta.
\n**missing**: produto não encontrado.
\n**default**: nos casos em que a revisão não pôde ser gerada.
\n**null**: quando não há uma revisão." }, "reviewedAt": { "$ref": "#/components/schemas/dateTypeGMT", "description": "Data da revisão" } } } } }, "invoice": { "type": "object", "description": "Dados da nota fiscal da devolução", "properties": { "accessKey": { "type": "string", "description": "Chave de acesso da nota fiscal" } } } } }, "examples": { "Example 1": { "value": { "id": 1234, "orderId": 123456789, "oi": "123456789.", "marketplace": "MERCADO_LIVRE", "marketplaceOrderId": "2000001234567", "marketplaceReturnId": "234567", "marketplaceTypeId": "automatic", "accountId": "123", "accountName": "TESTUSER", "paymentStatus": "APPROVED", "status": "NEW_RETURN", "reason": "Não é da cor, tamanho ou modelo que escolhi", "type": "TOTAL", "createdAt": "2024-08-30T11:26:00.000Z", "closedAt": "2024-08-30T11:26:00.000Z", "checkedAt": "2024-08-30T11:26:00.000Z", "updatedAt": "2024-08-30T11:26:00.000Z", "items": [ { "id": 123, "orderItemId": 234567890, "title": "Boné", "skuId": 34567890, "marketplaceSkuId": "MLB123456789", "quantity": 2 }, { "id": 1234, "orderItemId": 234567891, "title": "Jaqueta", "skuId": 34567891, "marketplaceSkuId": "MLB1234567890", "quantity": 2 } ], "shipping": [ { "id": 1234, "marketplaceShippingId": "123456789", "status": "WAITING_CARRIER", "subStatus": "READY_TO_PRINT", "trackingNumber": "OY123456789BR", "estimatedDelivery": "2024-08-31T11:26:00.000Z", "transportServiceName": "Mercado Livre", "senderName": "Test Test", "type": "selling_address", "addressLine": "XXXXXXX", "streetName": "XXXXXXX", "streetNumber": "XXXXXXX", "comment": "XXXXXXX", "zipCode": "06454000", "city": "Barueri", "state": "São Paulo", "country": "Brasil", "neighborhood": "Alphaville", "destination": "seller_address", "createdAt": "2024-08-30T11:26:00.000Z" }, { "id": 1235, "marketplaceShippingId": "1234567890", "status": "WAITING_CARRIER", "subStatus": "READY_TO_PRINT", "trackingNumber": "OY123456789BR", "estimatedDelivery": "2024-08-31T11:26:00.000Z", "transportServiceName": "Mercado Livre", "senderName": "Test Test", "type": "selling_address", "addressLine": "XXXXXXX", "streetName": "XXXXXXX", "streetNumber": "XXXXXXX", "comment": "XXXXXXX", "zipCode": "06454000", "city": "Barueri", "state": "São Paulo", "country": "Brasil", "neighborhood": "Alphaville", "destination": "warehouse", "createdAt": "2024-08-30T11:26:00.000Z" } ], "history": [ { "id": 12345, "returnStatus": "NEW_RETURN", "shippingStatus": "WAITING_CARRIER", "shippingSubStatus": "READY_TO_PRINT", "createdAt": "2024-08-30T11:26:00.000Z" } ], "conference": { "reasonDetails": "string", "status": "RETURN_CHECK_OK", "observations": "string", "marketplaceReview": { "method": "triage", "reviewStatus": "success", "productCondition": "unsaleable", "productDestination": "seller", "benefited": "buyer", "reasonId": "accepted", "reviewedAt": "2024-08-27T14:58:21.978Z" } }, "invoice": { "accessKey": "string" } } }, "stoplight-Example 1": { "value": { "id": 75055, "orderId": 179762155, "oi": "259061958.", "marketplace": "MERCADO_LIVRE", "marketplaceOrderId": "2000006227480873", "marketplaceReturnId": "27480873", "marketplaceTypeId": "automatic", "accountId": "47205", "accountName": "TESTUSER1143557621", "paymentStatus": "APPROVED", "status": "NEW_RETURN", "reason": "Não é da cor, tamanho ou modelo que escolhi", "type": "TOTAL", "createdAt": "2024-08-30T11:26:00.000Z", "closedAt": "2024-08-30T11:26:00.000Z", "checkedAt": "2024-08-30T11:26:00.000Z", "updatedAt": "2024-08-30T11:26:00.000Z", "items": [ { "id": 75036, "orderItemId": 209627092, "title": "BonΘ H90 Logo (UNISSEX)", "skuId": 95527728, "marketplaceSkuId": "MLB4776746304", "quantity": 2 }, { "id": 75037, "orderItemId": 209627093, "title": "Jaqueta Hino Colômbia", "skuId": 95527734, "marketplaceSkuId": "MLB4776746582", "quantity": 2 } ], "shipping": [ { "id": 74995, "marketplaceShippingId": "1", "status": "WAITING_CARRIER", "subStatus": "READY_TO_PRINT", "trackingNumber": "OY123456789BR", "estimatedDelivery": "2024-08-31T11:26:00.000Z", "transportServiceName": "Mercado Livre", "senderName": "Test Test", "type": "selling_address", "addressLine": "XXXXXXX", "streetName": "XXXXXXX", "streetNumber": "XXXXXXX", "comment": "XXXXXXX", "zipCode": "06454000", "city": "Barueri", "state": "São Paulo", "country": "Brasil", "neighborhood": "Alphaville Centro Industrial e Empresarial/Alphaville", "destination": "seller_address", "createdAt": "2024-08-30T11:26:00.000Z" } ], "history": [ { "id": 386651, "returnStatus": "NEW_RETURN", "shippingStatus": "WAITING_CARRIER", "shippingSubStatus": "READY_TO_PRINT", "createdAt": "2024-08-30T11:26:00.000Z" } ], "conference": { "reasonDetails": "string", "status": "RETURN_CHECK_OK", "observations": "string", "marketplaceReview": { "method": "triage", "reviewStatus": "success", "productCondition": "unsaleable", "productDestination": "seller", "benefited": "buyer", "reasonId": "accepted", "reviewedAt": "2024-08-27T14:58:21.978Z" } }, "invoice": { "accessKey": "43240830111222333444550010001234567891234567890" } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "Código da mensagem de erro " }, "message": { "type": "string", "description": "Mensagem de Erro" } } }, "examples": { "Example 1": { "value": { "code": "string", "message": "string" } }, "stoplight-Example 1": { "value": { "code": "string", "message": "string" } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "Código da mensagem de erro " }, "message": { "type": "string", "description": "Mensagem de Erro" } } }, "examples": { "Example 1": { "value": { "code": "string", "message": "string" } }, "stoplight-Example 1": { "value": { "code": "string", "message": "string" } } } } } } }, "operationId": "get-orders-returns-id", "description": "# Consulta os detalhes de uma Devolução\r\nConsulta os detalhes de uma devolução de pedido", "parameters": [] }, "patch": { "summary": "/orders/{orderId}/returns/{id}", "tags": [ "Devolução" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "orderId", "oi", "marketplace" ], "properties": { "id": { "type": "integer", "description": "ID da Devolução" }, "orderId": { "type": "integer", "description": "ID do Pedido no ANYMARKET" }, "oi": { "type": "string" }, "marketplace": { "$ref": "#/components/schemas/EnumMarketplaces" }, "type": { "description": "Tipo de devolução", "enum": [ "TOTAL", "PARTIAL" ] }, "marketplaceOrderId": { "type": "string", "description": "ID público do pedido no marketplace" }, "marketplaceReturnId": { "type": "string", "description": "ID público da devolução no marketplace" }, "marketplaceTypeId": { "type": "string", "description": "Tipo de devolução no marketplace" }, "accountId": { "type": "string", "description": "ID da conta gerado automático pelo ANYMARKET" }, "accountName": { "type": "string", "description": "Identificador da conta do Marketplace" }, "paymentStatus": { "type": "string", "description": "Status do pagamento da devolução" }, "status": { "description": "Status da devolução\n\n**NEW_RETURN**: Nova devolução
\n**WAITING_DELIVERY**: Retorno ao CD
\n**WAITING_CONFERENCE**: Aguardando conferência
\n**CHECKED**: Devolução conferida
\n**CANCELLED**: Devolução cancelada
\n**CONCLUDED**: Devolução concluída
\n**FAILED**: Devolução falhou
\n**EXPIRED**: Devolução expirou", "enum": [ "NEW_RETURN", "WAITING_DELIVERY", "WAITING_CONFERENCE", "CHECKED", "CANCELLED", "CONCLUDED", "FAILED", "EXPIRED" ] }, "reason": { "type": "string", "description": "Razão da devolução" }, "closedAt": { "type": "string", "description": "Data prevista para o encerramento da devolução" }, "checkedAt": { "type": "string", "description": "Data que a devolução foi conferida" }, "createdAt": { "type": "string", "description": "Data da criação da devolução" }, "updatedAt": { "type": "string", "description": "Data da última atualização" }, "items": { "type": "array", "items": { "type": "object", "required": [ "id", "orderItemId" ], "properties": { "id": { "type": "integer", "description": "ID do item da devolução" }, "orderItemId": { "type": "integer", "description": "ID do item da devolução" }, "title": { "type": "string", "description": "Título do produto" }, "skuId": { "type": "integer", "description": "ID do SKU gerado pelo ANYMARKET" }, "marketplaceSkuId": { "type": "string", "description": "Código do sku no marketplace" }, "quantity": { "type": "integer", "description": "Quantidade do item" } } } }, "shipping": { "type": "array", "items": { "type": "object", "required": [ "id", "marketplaceShippingId", "status", "trackingNumber", "estimatedDelivery", "type", "createdAt" ], "properties": { "id": { "type": "integer", "description": "ID do item da entrega da devolução" }, "marketplaceShippingId": { "type": "string", "description": "Código do envio no marketplace" }, "status": { "description": "Status do envio no marketplace\n\n**WAITING_CARRIER**: Aguardando envio
\n**TRANSIT_GOODS**: Em trânsito
\n**DELIVERED**: Devolução no CD
\n**NOT_DELIVERED**: Devolução não entregue no CD ", "enum": [ "WAITING_CARRIER", "TRANSIT_GOODS", "DELIVERED", "NOT_DELIVERED" ] }, "subStatus": { "type": "string", "description": "Substatus do envio no marketplace" }, "trackingNumber": { "type": "string", "description": "Número de rastreio" }, "estimatedDelivery": { "type": "string", "description": "Data estimada (Necessário informar o fuso horario)" }, "transportServiceName": { "type": "string", "description": "Nome da transportadora" }, "senderName": { "type": "string", "description": "Nome do responsável pelo envio" }, "type": { "type": "string", "description": "Define o tipo do endereço de envio" }, "addressLine": { "type": "string", "description": "Endereço completo do envio" }, "streetName": { "type": "string", "description": "Rua" }, "streetNumber": { "type": "string", "description": "Número" }, "comment": { "type": "string", "description": "Complemento" }, "zipCode": { "type": "string", "description": "Código Postal" }, "city": { "type": "string", "description": "Cidade" }, "state": { "type": "string", "description": "Estado" }, "country": { "type": "string", "description": "País" }, "neighborhood": { "type": "string", "description": "Bairro" }, "municipality": { "type": "string", "description": "Cidade ou Distrito" }, "destination": { "type": "string", "description": "Endereço do vendedor ou do depósito" }, "createdAt": { "type": "string", "description": "Data da criação do envio da devolução" } } } }, "history": { "type": "array", "items": { "type": "object", "required": [ "id", "returnStatus", "shippingSubStatus", "shippingStatus", "createdAt" ], "properties": { "id": { "type": "integer", "description": "ID do histórico da devolução gerado pelo ANYMARKET" }, "returnStatus": { "description": "Status da devolução\n\n**NEW_RETURN**: Nova devolução
\n**WAITING_DELIVERY**: Retorno ao CD
\n**WAITING_CONFERENCE**: Aguardando conferência
\n**CHECKED**: Devolução conferida
\n**CANCELLED**: Devolução cancelada
\n**CONCLUDED**: Devolução concluída
\n**FAILED**: Devolução falhou
\n**EXPIRED**: Devolução expirou", "enum": [ "NEW_RETURN", "WAITING_DELIVERY", "WAITING_CONFERENCE", "CHECKED", "CANCELLED", "CONCLUDED", "FAILED", "EXPIRED" ] }, "shippingSubStatus": { "type": "string", "description": "Substatus da devolução" }, "shippingStatus": { "description": "Status da entrega da devolução\n\n**WAITING_CARRIER**: Aguardando envio
\n**TRANSIT_GOODS**: Em trânsito
\n**DELIVERED**: Devolução no CD
\n**NOT_DELIVERED**: Devolução não entregue no CD", "enum": [ "WAITING_CARRIER", "TRANSIT_GOODS", "DELIVERED", "NOT_DELIVERED" ] }, "createdAt": { "type": "string", "description": "Data da criação do histórico da devolução" } } } }, "conference": { "type": "object", "required": [ "status" ], "properties": { "reasonDetails": { "type": "string", "description": "Detalhes do motivo da devolução" }, "status": { "enum": [ "RETURN_CHECK_OK", "RETURN_CHECK_NOT_OK" ], "description": "Status da conferência da devolução" }, "observations": { "type": "string", "description": "Observações" } } } } }, "examples": { "Example 1": { "value": { "id": 0, "orderId": 0, "oi": "string", "marketplace": "string", "type": "string", "marketplaceOrderId": "string", "marketplaceReturnId": "string", "marketplaceTypeId": "string", "accountId": "string", "accountName": "string", "paymentStatus": "string", "status": "CHECKED", "reason": "string", "closedAt": "string", "checkedAt": "string", "createdAt": "string", "updatedAt": "string", "items": [ { "id": 0, "orderItemId": 0, "title": "string", "skuId": 0, "marketplaceSkuId": "string", "quantity": 0 } ], "shipping": [ { "id": 0, "marketplaceShippingId": "string", "status": "string", "subStatus": "string", "trackingNumber": "string", "estimatedDelivery": "string", "transportServiceName": "string", "senderName": "string", "type": "string", "addressLine": "string", "streetName": "string", "streetNumber": "string", "comment": "string", "zipCode": "string", "city": "string", "state": "string", "country": "string", "neighborhood": "string", "municipality": "string", "destination": "string", "createdAt": "string" } ], "history": [ { "id": 0, "returnStatus": "string", "shippingSubStatus": "string", "shippingStatus": "string", "createdAt": "string" } ], "conference": { "reasonDetails": "string", "status": "RETURN_CHECK_OK", "observations": "string" } } }, "stoplight-Example 1": { "value": { "id": 0, "orderId": 0, "oi": "string", "marketplace": "string", "type": "string", "marketplaceOrderId": "string", "marketplaceReturnId": "string", "marketplaceTypeId": "string", "accountId": "string", "accountName": "string", "paymentStatus": "string", "status": "string", "reason": "string", "closedAt": "string", "checkedAt": "string", "createdAt": "string", "updatedAt": "string", "items": [ { "id": 0, "orderItemId": 0, "title": "string", "skuId": 0, "marketplaceSkuId": "string", "quantity": 0 } ], "shipping": [ { "id": 0, "marketplaceShippingId": "string", "status": "string", "subStatus": "string", "trackingNumber": "string", "estimatedDelivery": "string", "transportServiceName": "string", "senderName": "string", "type": "string", "addressLine": "string", "streetName": "string", "streetNumber": "string", "comment": "string", "zipCode": "string", "city": "string", "state": "string", "country": "string", "neighborhood": "string", "municipality": "string", "destination": "string", "createdAt": "string" } ], "history": [ { "id": 0, "returnStatus": "string", "shippingSubStatus": "string", "shippingStatus": "string", "createdAt": "string" } ], "conference": { "reasonDetails": "string", "status": "RETURN_CHECK_OK", "observations": "string" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "string", "message": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "string", "message": "string" } } } } } } }, "operationId": "patch-orders-returns-id", "description": "# Marcar a devolução como conferida\nMarcar a devolução como conferida\n\n> O método `PATCH` permite atualizar apenas os campos desejados de um recurso.\n>\n> Campos não enviados permanecem com os valores atuais.\n>\n> Recomendado quando há campos opcionais e você deseja atualizar apenas parte das informações.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string" }, "conference": { "type": "object", "required": [ "status" ], "properties": { "reasonDetails": { "type": "string" }, "status": { "enum": [ "RETURN_CHECK_OK", "RETURN_CHECK_NOT_OK" ] }, "observations": { "type": "string" } } } } }, "examples": { "Example 2": { "value": { "status": "CHECKED", "conference": { "reasonDetails": "string", "status": "RETURN_CHECK_OK", "observations": "string" } } }, "Example 1": { "value": { "status": "CHECKED", "conference": { "reasonDetails": "string", "status": "RETURN_CHECK_OK", "observations": "string" } } } } } } } } }, "/orders/{id}/returns": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "ID do Pedido no ANYMARKET" } ], "get": { "summary": "/orders/{id}/returns", "tags": [ "Devolução" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "content" ], "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "rel": { "type": "string" }, "href": { "type": "string" } } } }, "content": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "marketplace", "marketplaceOrderId", "marketplaceReturnId", "marketplaceTypeId", "paymentStatus", "status", "reason", "items", "history" ], "properties": { "id": { "type": "integer", "description": "ID da devolução" }, "orderId": { "type": "integer", "description": "ID do pedido gerado pelo ANYMARKET" }, "oi": { "type": "string" }, "marketplace": { "$ref": "#/components/schemas/EnumMarketplaces" }, "type": { "description": "Tipo de devolução", "enum": [ "TOTAL", "PARTIAL" ] }, "marketplaceOrderId": { "type": "string", "description": "ID público do pedido no marketplace" }, "marketplaceReturnId": { "type": "string", "description": "ID público da devolução no marketplace" }, "marketplaceTypeId": { "type": "string", "description": "Tipo de devolução no marketplace" }, "accountId": { "type": "string", "description": "ID da conta gerado automático pelo ANYMARKET" }, "accountName": { "type": "string", "description": "Identificador da conta do Marketplace" }, "paymentStatus": { "type": "string", "description": "Status do pagamento da devolução" }, "status": { "description": "Status da devolução\n\n**NEW_RETURN**: Nova devolução
\n**WAITING_DELIVERY**: Retorno ao CD do seller
\n**WAITING_DELIVERY_MARKETPLACE**: Retorno ao CD do marketplace
\n**WAITING_CONFERENCE**: Aguardando conferência
\n**CHECKED**: Devolução conferida
\n**CANCELLED**: Devolução cancelada
\n**CONCLUDED**: Devolução concluída
\n**FAILED**: Devolução falhou
\n**EXPIRED**: Devolução expirou", "enum": [ "NEW_RETURN", "WAITING_DELIVERY", "WAITING_DELIVERY_MARKETPLACE", "WAITING_CONFERENCE", "CHECKED", "CANCELLED", "CONCLUDED", "FAILED", "EXPIRED" ] }, "reason": { "type": "string", "description": "Razão da devolução" }, "createdAt": { "type": "string", "description": "Data da criação da devolução" }, "updatedAt": { "type": "string", "description": "Data da última atualização" }, "closedAt": { "type": "string", "description": "Data prevista para o encerramento da devolução" }, "checkedAt": { "type": "string", "description": "Data que a devolução foi conferida" }, "items": { "type": "array", "items": { "type": "object", "required": [ "id", "orderItemId" ], "properties": { "id": { "type": "integer", "description": "ID do item da devolução" }, "orderItemId": { "type": "integer", "description": "Id do item no pedido gerado pelo ANYMARKET" }, "title": { "type": "string", "description": "Título do produto" }, "skuId": { "type": "integer", "description": "ID do SKU gerado pelo ANYMARKET" }, "marketplaceSkuId": { "type": "string", "description": "Código do sku no marketplace" }, "quantity": { "type": "integer", "description": "Quantidade do item" } } } }, "shipping": { "type": "array", "items": { "type": "object", "required": [ "id", "marketplaceShippingId", "status", "trackingNumber", "estimatedDelivery", "type", "createdAt" ], "properties": { "id": { "type": "integer", "description": "ID do item da entrega da devolução" }, "marketplaceShippingId": { "type": "string", "description": "Código do envio no marketplace" }, "status": { "description": "Status do envio no marketplace\n\n**WAITING_CARRIER**: Aguardando envio
\n**TRANSIT_GOODS**: Em trânsito
\n**DELIVERED**: Devolução no CD
\n**NOT_DELIVERED**: Devolução não entregue no CD ", "enum": [ "WAITING_CARRIER", "TRANSIT_GOODS", "DELIVERED", "NOT_DELIVERED" ] }, "subStatus": { "type": "string", "description": "Substatus do envio no marketplace" }, "trackingNumber": { "type": "string", "description": "Número de rastreio" }, "estimatedDelivery": { "type": "string", "description": "Data estimada (Necessário informar o fuso horario)" }, "transportServiceName": { "type": "string", "description": "Nome da transportadora" }, "senderName": { "type": "string", "description": "Nome do responsável pelo envio" }, "type": { "type": "string", "description": "Define o tipo do endereço de envio" }, "addressLine": { "type": "string", "description": "Endereço completo do envio" }, "streetName": { "type": "string", "description": "Rua" }, "streetNumber": { "type": "string", "description": "Número" }, "comment": { "type": "string", "description": "Complemento" }, "zipCode": { "type": "string", "description": "Código Postal" }, "city": { "type": "string", "description": "Cidade" }, "state": { "type": "string", "description": "Estado" }, "country": { "type": "string", "description": "País " }, "neighborhood": { "type": "string", "description": "Bairro" }, "municipality": { "type": "string", "description": "Cidade ou Distrito" }, "destination": { "type": "string", "enum": [ "SELLER_ADDRESS", "WAREHOUSE" ], "description": "Define o tipo de endereço do CD\n\n**SELLER_ADDRESS**: CD do seller
\n**WAREHOUSE**: CD do marketplace" }, "createdAt": { "type": "string", "description": "Data da criação do envio da devolução" } } } }, "history": { "type": "array", "items": { "type": "object", "required": [ "id", "returnStatus", "shippingStatus", "createdAt" ], "properties": { "id": { "type": "integer", "description": "ID do histórico da devolução gerado pelo ANYMARKET" }, "returnStatus": { "description": "Status da devolução\n\n**NEW_RETURN**: Nova devolução
\n**WAITING_DELIVERY**: Retorno ao CD do seller
\n**WAITING_DELIVERY_MARKETPLACE**: Retorno ao CD do marketplace
\n**WAITING_CONFERENCE**: Aguardando conferência
\n**CHECKED**: Devolução conferida
\n**CANCELLED**: Devolução cancelada
\n**CONCLUDED**: Devolução concluída
\n**FAILED**: Devolução falhou
\n**EXPIRED**: Devolução expirou", "enum": [ "NEW_RETURN", "WAITING_DELIVERY", "WAITING_CONFERENCE", "CHECKED", "CANCELLED", "CONCLUDED", "FAILED", "EXPIRED", "WAITING_DELIVERY_MARKETPLACE" ] }, "shippingStatus": { "description": "Status da entrega da devolução\n\n**WAITING_CARRIER**: Aguardando envio
\n**TRANSIT_GOODS**: Em trânsito
\n**DELIVERED**: Devolução no CD
\n**NOT_DELIVERED**: Devolução não entregue no CD", "enum": [ "WAITING_CARRIER", "TRANSIT_GOODS", "DELIVERED", "NOT_DELIVERED" ] }, "shippingSubStatus": { "type": "string" }, "createdAt": { "type": "string", "description": "Data da criação do histórico da devolução" } } } }, "conference": { "type": "object", "description": "Dados de conferência da devolução", "required": [ "status" ], "properties": { "reasonDetails": { "type": "string", "description": "Detalhes do motivo da devolução" }, "status": { "enum": [ "RETURN_CHECK_OK", "RETURN_CHECK_NOT_OK" ], "description": "Status da conferência da devolução" }, "observations": { "type": "string", "description": "Observações na conferência da devolução" }, "marketplaceReview": { "type": "object", "description": "Revisão da devolução pelo marketplace", "properties": { "method": { "type": "string", "description": "Método de revisão" }, "reviewStatus": { "type": "string", "description": "Status da revisão do marketplace" }, "productCondition": { "type": "string", "description": "Condição do produto na revisão" }, "productDestination": { "type": "string", "description": "Destino do produto após revisão" }, "benefited": { "type": "string", "description": "Beneficiado na revisão" }, "reasonId": { "type": "string", "description": "ID do motivo da revisão" }, "reviewedAt": { "type": "string", "description": "Data da revisão" } } } } }, "invoice": { "type": "object", "description": "Dados da nota fiscal da devolução", "properties": { "accessKey": { "type": "string", "description": "Chave de acesso da nota fiscal" } } } } } }, "page": { "type": "object", "properties": { "size": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" }, "number": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "links": [ { "rel": "string", "href": "string" } ], "content": [ { "id": 0, "orderId": 0, "oi": "string", "marketplace": "string", "type": "string", "marketplaceOrderId": "string", "marketplaceReturnId": "string", "marketplaceTypeId": "string", "accountId": "string", "accountName": "string", "paymentStatus": "string", "status": "string", "reason": "string", "createdAt": "string", "updatedAt": "string", "closedAt": "string", "checkedAt": "string", "items": [ { "id": 0, "orderItemId": 0, "title": "string", "skuId": 0, "marketplaceSkuId": "string", "quantity": 0 } ], "shipping": [ { "id": 0, "marketplaceShippingId": "string", "status": "string", "subStatus": "string", "trackingNumber": "string", "estimatedDelivery": "string", "transportServiceName": "string", "senderName": "string", "type": "string", "addressLine": "string", "streetName": "string", "streetNumber": "string", "comment": "string", "zipCode": "string", "city": "string", "state": "string", "country": "string", "neighborhood": "string", "municipality": "string", "destination": "seller_address", "createdAt": "string" }, { "id": 0, "marketplaceShippingId": "string", "status": "string", "subStatus": "string", "trackingNumber": "string", "estimatedDelivery": "string", "transportServiceName": "string", "senderName": "string", "type": "string", "addressLine": "string", "streetName": "string", "streetNumber": "string", "comment": "string", "zipCode": "string", "city": "string", "state": "string", "country": "string", "neighborhood": "string", "municipality": "string", "destination": "warehouse", "createdAt": "string" } ], "history": [ { "id": 0, "returnStatus": "string", "shippingStatus": "string", "shippingSubStatus": "string", "createdAt": "string" } ], "conference": { "reasonDetails": "string", "status": "RETURN_CHECK_OK", "observations": "string", "marketplaceReview": { "method": "string", "reviewStatus": "string", "productCondition": "string", "productDestination": "string", "benefited": "string", "reasonId": "string", "reviewedAt": "string" } }, "invoice": { "accessKey": "string" } } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } }, "stoplight-Example 1": { "value": { "links": [ { "rel": "next", "href": "http://api.anymarket.com.br/v2/orders/164084149/return?offset=5" } ], "content": [ { "id": 74, "orderId": 164084149, "oi": "22449504.", "marketplace": "ECOMMERCE", "marketplaceOrderId": "1", "marketplaceReturnId": "1", "marketplaceTypeId": "claim", "accountId": "12641", "accountName": "ECOMMERCE", "paymentStatus": "retained", "status": "opened", "reason": "PDD9946", "createdAt": "2024-05-14T17:14:24.913Z", "updatedAt": "2024-05-14T17:14:24.913Z" }, { "id": 75, "orderId": 164084149, "oi": "22449504.", "marketplace": "ECOMMERCE", "marketplaceOrderId": "giovani-27", "marketplaceReturnId": "giovani-27-return", "marketplaceTypeId": "1", "accountId": "1", "accountName": "Loja do Giovani", "paymentStatus": "APPROVED", "status": "SHIPPED", "reason": "OTHER_MOTIVE", "closedAt": "2023-09-22T14:32:11.544Z", "createdAt": "2023-09-22T14:32:11.544Z", "updatedAt": "2023-09-22T14:32:11.544Z", "items": [ { "id": 56, "orderItemId": 191248906, "title": "Title Item", "skuId": 51786368, "marketplaceSkuId": "sku-do-giovani", "quantity": 1 } ], "shipping": [ { "id": 56, "marketplaceShippingId": "1", "status": "READY_TO_SHIP", "subStatus": "READY_TO_PRINT", "trackingNumber": "Tracking Number", "estimatedDelivery": "2023-09-22T14:32:11.544Z", "transportServiceName": "Transport Service Name", "senderName": "Sender Name", "type": "Type", "addressLine": "Address Line", "streetName": "Street Name", "streetNumber": "Street Number", "comment": "Comment", "zipCode": "Zip Code", "city": "City", "state": "State", "country": "Country", "neighborhood": "Neighborhood", "municipality": "Municipality", "destination": "Destination", "createdAt": "2023-09-22T14:32:11.544Z" } ], "history": [ { "id": 59, "returnStatus": "OPENED", "shippingStatus": "READY_TO_SHIP", "shippingSubStatus": "READY_TO_PRINT", "createdAt": "2023-09-22T14:32:11.544Z" } ], "conference": [ { "reasonDetails": "Reason", "status": "RETURN_CHECK_OK", "observations": null, "marketplaceReview": { "method": "string", "reviewStatus": "string", "productCondition": "string", "productDestination": "string", "benefited": "string", "reasonId": "string", "reviewedAt": "2024-08-30T11:26:00.000Z" } } ], "invoice": { "accessKey": "string" } } ], "page": { "size": 5, "totalElements": 2, "totalPages": 1, "number": 1 } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "Código da mensagem de erro " }, "message": { "type": "string", "description": "Mensagem de Erro" } } }, "examples": { "Example 1": { "value": { "code": "string", "message": "string" } }, "stoplight-Example 1": { "value": { "code": "string", "message": "string" } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "Código da mensagem de erro " }, "message": { "type": "string", "description": "Mensagem de Erro" } } }, "examples": { "Example 1": { "value": { "code": "string", "message": "string" } }, "stoplight-Example 1": { "value": { "code": "string", "message": "string" } } } } } } }, "operationId": "get-orders-id-returns", "description": "# Consulta as devoluções de um determinado pedido\r\nConsulta as devoluções de um determinado pedido", "requestBody": { "description": "", "content": {} } }, "post": { "summary": "/orders/{id}/returns", "tags": [ "Devolução" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "orderId", "marketplace", "marketplaceOrderId", "marketplaceReturnId", "marketplaceTypeId", "accountId", "status", "reason", "type", "createdAt", "items", "history" ], "properties": { "id": { "type": "integer", "description": "ID da devolução" }, "orderId": { "type": "integer", "description": "ID do pedido gerado pelo ANYMARKET" }, "oi": { "type": "string" }, "marketplace": { "$ref": "#/components/schemas/EnumMarketplaces" }, "marketplaceOrderId": { "type": "string", "description": "Id da venda no canal marketplace" }, "marketplaceReturnId": { "type": "string", "description": "Id devolução" }, "marketplaceTypeId": { "type": "string", "description": "Tipo de devolução no marketplace", "example": "automatic, calim, dispute" }, "accountId": { "type": "string", "description": "Identificador da conta marketplace da venda " }, "accountName": { "type": "string", "description": "Nome da conta marketplace da venda" }, "paymentStatus": { "type": "string", "description": "Status do pagamento da devolução" }, "status": { "description": "Status normalizados para o canal de venda:\n\n**NEW_RETURN**: Nova devolução
\n**WAITING_DELIVERY**: Retorno ao CD do seller
\n**WAITING_DELIVERY_MARKETPLACE**: Retorno ao CD do marketplace
\n**WAITING_CONFERENCE**: Aguardando conferência
\n**CHECKED**: Devolução conferida
\n**CANCELLED**: Devolução cancelada
\n**CONCLUDED**: Devolução concluída
\n**FAILED**: Devolução falhou
\n**EXPIRED**: Devolução expirou ", "enum": [ "NEW_RETURN", "WAITING_DELIVERY", "WAITING_DELIVERY_MARKETPLACE", "WAITING_CONFERENCE", "CHECKED", "CONCLUDED", "FAILED", "EXPIRED" ] }, "reason": { "type": "string", "description": "Razão da devolução" }, "type": { "enum": [ "TOTAL", "PARTIAL" ], "description": "Tipo de devolução" }, "createdAt": { "type": "string", "format": "date-time", "description": "Modelo de data e hora com GMT", "example": "2024-08-30T08:26:00-03:00", "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}-[0-9]{2}:[0-9]{2}" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-08-30T08:26:00-03:00", "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}-[0-9]{2}:[0-9]{2}", "description": "Modelo de data e hora com GMT" }, "closedAt": { "type": "string", "format": "date-time", "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}-[0-9]{2}:[0-9]{2}", "example": "2024-08-30T08:26:00-03:00", "description": "Modelo de data e hora com GMT" }, "items": { "type": "array", "description": "Itens devolvidos", "items": { "type": "object", "required": [ "id", "orderItemId" ], "properties": { "id": { "type": "integer", "description": "ID do item da devolução" }, "orderItemId": { "type": "integer", "description": "Id do item no pedido gerado pelo ANYMARKET" }, "title": { "type": "string", "description": "Título do produto" }, "skuId": { "type": "string", "description": "ID do SKU gerado pelo ANYMARKE" }, "marketplaceSkuId": { "type": "string", "description": "Código do sku no marketplace", "example": "MLB123456789, SKU_123" }, "quantity": { "type": "integer", "description": "Quantidade de itens devolvidos" } } } }, "shipping": { "type": "array", "description": "Envio da devolução", "items": { "type": "object", "required": [ "id", "marketplaceShippingId", "status", "type", "city", "state", "country", "createdAt" ], "properties": { "id": { "type": "integer", "description": "ID do envio da devolução no ANYMARKET" }, "marketplaceShippingId": { "type": "string", "description": "Código do envio no marketplace" }, "status": { "description": "Status da entrega da devolução normalizados:\n\n**WAITING_CARRIER**: Aguardando envio
\n**TRANSIT_GOODS**: Em trânsito
\n**DELIVERED**: Devolução no CD
\n**NOT_DELIVERED**: Devolução não entregue no CD", "enum": [ "WAITING_CARRIER", "TRANSIT_GOODS", "DELIVERED", "NOT_DELIVERED" ] }, "subStatus": { "type": "string", "description": "Substatus do envio no marketplace" }, "trackingNumber": { "type": "string", "description": "Número de rastreio" }, "estimatedDelivery": { "type": "string", "format": "date-time", "description": "Modelo de data e hora com GMT", "example": "2024-08-30T08:26:00-03:00", "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}-[0-9]{2}:[0-9]{2}" }, "transportServiceName": { "type": "string", "description": "Nome da transportadora" }, "senderName": { "type": "string", "description": "Nome do responsável pelo envio" }, "type": { "description": "Define o tipo do endereço de envio", "type": "string", "example": "selling_address" }, "addressLine": { "type": "string", "description": "Endereço completo do envio" }, "streetName": { "type": "string", "description": "Rua" }, "streetNumber": { "type": "string", "description": "Número" }, "comment": { "type": "string", "description": "Complemento" }, "zipCode": { "type": "string", "description": "Código Postal" }, "city": { "type": "string", "description": "Cidade" }, "state": { "type": "string", "description": "Estado" }, "country": { "type": "string", "description": "País" }, "neighborhood": { "type": "string", "description": "Bairro" }, "municipality": { "type": "string", "description": "Cidade ou Distrito" }, "destination": { "enum": [ "SELLER_ADDRESS", "WAREHOUSE" ], "description": "Define o tipo de endereço do CD\n\n**SELLER_ADDRESS**: CD do seller
\n**WAREHOUSE**: CD do marketplace" }, "createdAt": { "type": "string", "format": "date-time", "description": "Modelo de data e hora com GMT", "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}-[0-9]{2}:[0-9]{2}", "example": "2024-08-30T08:26:00-03:00" } } } }, "history": { "type": "array", "description": "Histórico da devolução", "items": { "type": "object", "required": [ "id", "returnStatus", "shippingStatus", "createdAt" ], "properties": { "id": { "type": "integer" }, "returnStatus": { "description": "Status da devolução\n\n**NEW_RETURN**: Nova devolução
\n**WAITING_DELIVERY**: Retorno ao CD do seller
\n**WAITING_DELIVERY_MARKETPLACE**: Retorno ao CD do marketplace
\n**WAITING_CONFERENCE**: Aguardando conferência
\n**CHECKED**: Devolução conferida
\n**CANCELLED**: Devolução cancelada
\n**CONCLUDED**: Devolução concluída
\n**FAILED**: Devolução falhou
\n**EXPIRED**: Devolução expirou", "enum": [ "NEW_RETURN", "WAITING_DELIVERY", "WAITING_DELIVERY_MARKETPLACE", "WAITING_CONFERENCE", "CHECKED", "CANCELLED", "CONCLUDED", "FAILED", "EXPIRED" ] }, "shippingStatus": { "description": "Status da entrega da devolução\n\n**WAITING_CARRIER**: Aguardando envio
\n**TRANSIT_GOODS**: Em trânsito
\n**DELIVERED**: Devolução no CD
\n**NOT_DELIVERED**: Devolução não entregue no CD", "enum": [ "WAITING_CARRIER", "TRANSIT_GOODS", "DELIVERED", "NOT_DELIVERED" ] }, "shippingSubStatus": { "type": "string", "description": "Substatus da devolução" }, "createdAt": { "type": "string", "format": "date-time", "description": "Data da criação do histórico da devolução
\nModelo de data e hora com GMT", "example": "2024-08-30T08:26:00-03:00", "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}-[0-9]{2}:[0-9]{2}" } } } }, "invoice": { "type": "object", "description": "Dados de faturamento da devolução", "properties": { "accessKey": { "type": "string", "description": "Chave de acesso à nota fiscal" } } } } }, "examples": { "Example 1": { "value": { "id": 1101, "orderId": 22286, "oi": "47.", "marketplace": "ECOMMERCE", "marketplaceOrderId": "101000021", "marketplaceReturnId": "placereturnID1100", "marketplaceTypeId": "type", "accountId": "2", "accountName": "ECOMMERCE", "paymentStatus": "approved", "status": "NEW_RETURN", "reason": "não deu certo", "type": "PARTIAL", "createdAt": "2025-06-12T18:29:14.166Z", "updatedAt": "2025-06-12T18:29:14.166Z", "closedAt": "2023-09-22T14:32:11.000Z", "items": [ { "id": 1212, "orderItemId": 70561, "title": "Gaiola de viagem para transporte de papagaio 2", "skuId": 20, "marketplaceSkuId": "SKUNOVOPET", "quantity": 1 } ], "shipping": [ { "id": 32167, "status": "NOT_DELIVERED", "subStatus": "READY_TO_PRINT", "trackingNumber": "8888", "estimatedDelivery": "2023-09-22T14:32:11.000Z", "transportServiceName": "Transport Service Name", "addressLine": "Address Line", "streetName": "Street Name", "streetNumber": "Street Number", "comment": "Comment", "zipCode": "Zip Code", "city": "City", "state": "State", "country": "Country", "neighborhood": "Neighborhood", "municipality": "Municipality", "destination": "warehouse", "createdAt": "2023-09-22T14:32:11.000Z" }, { "id": 32168, "status": "NOT_DELIVERED", "subStatus": "READY_TO_PRINT", "trackingNumber": "8888", "estimatedDelivery": "2023-09-22T14:32:11.000Z", "transportServiceName": "Transport Service Name", "addressLine": "Address Line", "streetName": "Street Name", "streetNumber": "Street Number", "comment": "Comment", "zipCode": "Zip Code", "city": "City", "state": "State", "country": "Country", "neighborhood": "Neighborhood", "municipality": "Municipality", "destination": "seller_address", "createdAt": "2023-09-22T14:32:11.000Z" } ], "history": [ { "id": 1606, "returnStatus": "NEW_RETURN", "shippingStatus": "NOT_DELIVERED", "shippingSubStatus": "sub", "createdAt": "2025-06-12T18:29:14.243Z" }, { "id": 1607, "returnStatus": "NEW_RETURN", "shippingStatus": "NOT_DELIVERED", "shippingSubStatus": "sub", "createdAt": "2025-06-12T18:29:14.243Z" } ], "invoice": { "accessKey": "32123123" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "string", "message": "string" } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Example 1": { "value": { "code": "string", "message": "string" } } } } } } }, "operationId": "post-orders-id-returns", "description": "# Cria uma devolução com os dados informados \nUtilizado para criar uma nova devolução no ANYMARKET. Deve ser utilizado por parceiros ou integrações ERP e plataformas internas.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "marketplace", "marketplaceOrderId", "marketplaceReturnId", "status", "reason", "items", "shipping" ], "properties": { "marketplace": { "$ref": "#/components/schemas/EnumMarketplaces" }, "marketplaceOrderId": { "type": "string", "description": "Id da venda no canal marketplace" }, "marketplaceReturnId": { "type": "string", "description": "Id devolução no canal" }, "marketplaceTypeId": { "type": "string", "description": "Tipo de devolução no marketplace" }, "accountId": { "type": "string", "description": "Identificador da conta marketplace da venda" }, "accountName": { "type": "string", "description": "Nome da conta marketplace da venda" }, "paymentStatus": { "type": "string", "description": "Status do pagamento da devolução" }, "status": { "enum": [], "description": "O status informado deve ser normalizados para o canal de venda:\n\n**NEW_RETURN**: Nova devolução
\n**WAITING_DELIVERY**: Retorno ao CD do seller
\n**WAITING_DELIVERY_MARKETPLACE**: Retorno ao CD do marketplace
\n**WAITING_CONFERENCE**: Aguardando conferência
\n**CHECKED**: Devolução conferida
\n**CANCELLED**: Devolução cancelada
\n**CONCLUDED**: Devolução concluída
\n**FAILED**: Devolução falhou
\n**EXPIRED**: Devolução expirou " }, "reason": { "type": "string", "description": "Razão da devolução" }, "type": { "enum": [ "TOTAL", "PARTIAL" ], "description": "Tipo de devolução" }, "createdAt": { "type": "string", "format": "date-time", "description": "Data da criação da devolução" }, "items": { "type": "array", "description": "Itens devolvidos", "items": { "type": "object", "required": [ "orderItemId", "skuId", "marketplaceSkuId", "quantity" ], "properties": { "orderItemId": { "type": "integer", "description": "Id do item no pedido gerado pelo ANYMARKET" }, "tile": { "type": "string", "description": "Título do produto" }, "skuId": { "type": "integer", "description": "ID do SKU gerado pelo ANYMARKET" }, "marketplaceSkuId": { "type": "string", "description": "Código do sku no marketplace" }, "quantity": { "type": "integer", "description": "Quantidade do itens devolvidos" } } } }, "shipping": { "type": "array", "description": "Envio da devolução", "items": { "type": "object", "required": [ "status" ], "properties": { "marketplaceShippingId": { "type": "string", "description": "Código do envio no marketplace" }, "status": { "description": "O status do envio no marketplace informado deve ser normalizado:\n\n**WAITING_CARRIER**: Aguardando envio
\n**TRANSIT_GOODS**: Em trânsito
\n**DELIVERED**: Devolução no CD
\n**NOT_DELIVERED**: Devolução não entregue no CD", "enum": [] }, "subStatus": { "type": "string", "description": "Substatus do envio no marketplace" }, "trackingNumber": { "type": "string", "description": "Número de rastreio" }, "estimatedDelivery": { "type": "string", "format": "date-time", "description": "Data estimada (Necessário informar o fuso horario)" }, "transportServiceName": { "type": "string", "description": "Nome da transportadora" }, "senderName": { "type": "string", "description": "Nome do responsável pelo envio" }, "type": { "type": "string", "description": "Define o tipo do endereço de envio" }, "addressLine": { "type": "string", "description": "Endereço completo do envio" }, "streetName": { "type": "string", "description": "Rua" }, "streetNumber": { "type": "string", "description": "Número" }, "comment": { "type": "string", "description": "Complemento" }, "zipCode": { "type": "string", "description": "Código Postal" }, "city": { "type": "string", "description": "Cidade" }, "state": { "type": "string", "description": "Estado" }, "country": { "type": "string", "description": "País" }, "neighborhood": { "type": "string", "description": "Bairro" }, "municipality": { "type": "string", "description": "Cidade ou Distrito" }, "destination": { "enum": [ "SELLER_ADDRESS", "WAREHOUSE" ], "description": "Informa para qual tipo de Cd está sendo enviado o pacote de devolução\n\n**SELLER_ADDRESS**: CD do seller
\n**WAREHOUSE**: CD do marketplace" }, "createdAt": { "type": "string", "format": "date-time", "description": "Data da criação do envio da devolução" } } } }, "invoice": { "type": "object", "description": "Dados de faturamento da devolução", "properties": { "accessKey": { "type": "string", "description": "Chave de acesso à nota fiscal" } } } } }, "examples": { "Example 1": { "value": { "marketplace": "ALIEXPRESS", "marketplaceOrderId": "string", "marketplaceReturnId": "string", "marketplaceTypeId": "string", "accountId": "2", "accountName": "ECOMMERCE", "paymentStatus": "string", "status": "string", "reason": "string", "type": "TOTAL", "createdAt": "2019-08-24T14:15:22Z", "items": [ { "orderItemId": 0, "tile": "string", "skuId": 0, "marketplaceSkuId": "string", "quantity": 0 } ], "shipping": [ { "marketplaceShippingId": "string", "status": "string", "subStatus": "string", "trackingNumber": "string", "estimatedDelivery": "2019-08-24T14:15:22Z", "transportServiceName": "string", "senderName": "string", "type": "string", "addressLine": "string", "streetName": "string", "streetNumber": "string", "comment": "string", "zipCode": "string", "city": "string", "state": "string", "country": "string", "neighborhood": "string", "municipality": "string", "destination": "seller_address", "createdAt": "2019-08-24T14:15:22Z" }, { "marketplaceShippingId": "string", "status": "string", "subStatus": "string", "trackingNumber": "string", "estimatedDelivery": "2019-08-24T14:15:22Z", "transportServiceName": "string", "senderName": "string", "type": "string", "addressLine": "string", "streetName": "string", "streetNumber": "string", "comment": "string", "zipCode": "string", "city": "string", "state": "string", "country": "string", "neighborhood": "string", "municipality": "string", "destination": "warehouse", "createdAt": "2019-08-24T14:15:22Z" } ], "invoice": { "accessKey": "32123123" } } } } } } } } }, "/orders/{id}/packages": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "Order ID generated by ANYMARKET" } ], "post": { "summary": "/orders/{id}/packages", "tags": [ "Pedido" ], "operationId": "post-orders-id-packages", "description": "# Create a package (multiple shipments) for an order\nSignals to the channel that the sale will have multiple shipments, allowing multiple packages — and, consequently, multiple invoices — to be associated with the same order.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderPackageCreate" }, "examples": { "Example 1": { "value": { "packageReason": { "id": "string", "description": "string" }, "packages": [ { "dimensions": { "length": 0, "width": 0, "height": 0, "weight": 0 }, "items": [ { "sku": "string", "quantity": 1 } ], "externalId": "string" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderPackage" }, "examples": { "Example 1": { "value": { "orderId": 0, "packageId": 0, "oi": "string", "orderIdInMarketplace": "string", "packageReason": { "id": "string", "description": "string" }, "packages": [ { "packageItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "externalId": "string", "createdAt": "2019-08-24T14:15:22Z", "trackingCode": "string", "trackingDate": "2019-08-24T14:15:22Z", "dimensions": { "length": 0, "width": 0, "height": 0, "weight": 0 }, "reasonId": "string", "reasonDescription": "string", "createdUnit": "2019-08-24T14:15:22Z", "issuedLabelAt": "2019-08-24T14:15:22Z", "statusMarketplace": "string", "status": "string", "items": [ { "packageItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sku": "string", "quantity": 1, "salesOrderItemId": 0, "skuInMarketplace": "string", "idInMarketplace": "string" } ] } ] } } } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } } } }, "/users": { "get": { "summary": "Listar todos os usuários", "tags": [ "Usuários" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "offset": { "type": "integer" }, "pageSize": { "type": "integer" } } }, "users": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } } } } } }, "examples": { "Example 1": { "value": { "pagination": { "offset": 0, "pageSize": 10 }, "users": [ { "email": "abc@db1.com.br", "id": 1, "name": "ABC", "roles": [ "Administrativo", "Comercial" ] } ] } } } } } } }, "operationId": "get-users", "parameters": [ { "schema": { "type": "array", "example": "[\"login\", \"ASC\"]" }, "in": "query", "name": "order", "description": "Campo utilizado para ordenação e Ordenação a Utilizar" }, { "schema": { "type": "integer" }, "in": "query", "name": "offset", "description": "Offset da paginação" }, { "schema": { "type": "integer" }, "in": "query", "name": "size", "description": "Tamanho das Páginas" }, { "schema": { "type": "string", "example": "abc@db1.com.br" }, "in": "query", "name": "filter", "description": "Campo para filtragem (Nome ou Login)" } ], "description": "\n> #### Importante\n>\n> Este endpoint não está disponível no ambiente de sandbox" }, "parameters": [], "post": { "summary": "Criar um novo usuário", "tags": [ "Usuários" ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "operationId": "post-users", "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "login": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "roles": { "type": "array", "items": { "type": "number" } } } }, "examples": { "Example 1": { "value": { "login": "hugo@user.com", "name": "Hugo", "password": "12345678", "roles": [ 1, 2, 3 ] } } } } } }, "description": "\n> #### Important\n> Este endpoint não está disponível no ambiente de sandbox.\n\n\n> #### Atenção!\n>\n> Este endpoint só deve ser chamado após a validação do Usuário ter sido realizada através do endpoint /validate." } }, "/users/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true } ], "put": { "summary": "Alterar as informações de um usuário", "tags": [ "Usuários" ], "description": "\n> #### Importante\n>\n> Este endpoint não está disponível no ambiente de sandbox\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.\n>\n> Campos omitidos podem ser redefinidos ou apagados.\n>\n> Use este método quando quiser sobrescrever todas as informações.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "number" } } } } } } } }, "operationId": "put-users-id", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } } } } }, "examples": { "Example 1": { "value": { "login": "hugo@user.com", "roles": [ { "id": 1 } ] } } } } } } }, "delete": { "summary": "Remover um usuário", "tags": [ "Usuários" ], "responses": { "200": { "description": "" } }, "operationId": "delete-users-id", "description": "\n> #### Importante\n>\n> Este endpoint não está disponível no ambiente de sandbox\n\n\n> #### Atenção!\n>\n> O usuário não será removido definitivamente do sistema, ele será apenas removido da organização. Caso o usuário esteja vinculado a mais de uma organização, ele será removido apenas da organização realizando a chamada." } }, "/users/validate": { "get": { "summary": "Validar se o usuário existe", "tags": [ "Usuários" ], "responses": { "202": { "description": "Usuário existe no sistema, mas não está vinculado a organização." }, "204": { "description": "Usuário não existe no sistema." }, "226": { "description": "Usuário existe no sistema e está vinculado a organização." } }, "operationId": "get-users-validate", "description": "\n> #### Importante\n>\n> Este endpoint não está disponível no ambiente de sandbox\n\n\n> #### Atenção!\n>\n> Este endpoint deve ser chamado antes de criar ou vincular um usuário a uma organização para validar a existência do mesmo.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "email", "description": "Email do Usuário" } ] } }, "/users/bind": { "get": { "summary": "Vincular o usuário a Organização ou Empresa", "tags": [ "Usuários" ], "responses": { "204": { "description": "" } }, "operationId": "get-users-bind", "description": "\n> #### Importante\n>\n> Este endpoint não está disponível no ambiente de sandbox\n\n\n> #### Atenção!\n>\n> Este endpoint só deve ser chamado após a validação do Usuário ter sido realizada através do endpoint /validate.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } } } } }, "examples": { "Example 1": { "value": { "email": "email@db1.com.br", "nameCountry": "Brasil", "roles": [ { "id": 1 } ] } } } } } } } }, "/roles": { "get": { "summary": "Listar os perfis de acesso", "tags": [ "Perfis de Acesso" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "totalUsers": { "type": "integer" }, "totalPermissions": { "type": "integer" } } } } } }, "examples": { "Example 1": { "value": { "roles": [ { "id": 82183, "name": "Não Deletar - Uso Interno", "totalUsers": 40, "quantity": 89 } ] } } } } } } }, "operationId": "get-roles", "description": "\n> #### Importante\n>\n> Este endpoint não está disponível no ambiente de sandbox" }, "post": { "summary": "Criar um perfil de acesso", "tags": [ "Perfis de Acesso" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "number" } } } } } } }, "operationId": "post-roles", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "resourcesId": { "type": "array", "items": { "type": "number" } } } }, "examples": { "Example 1": { "value": { "name": "Novo Perfil Teste", "resourcesId": [ 2, 1 ] } } } } }, "description": "\n> #### Atenção!\n>\n> Os ids dos recursos podem ser obtidos no endpoint /roles/permission" }, "description": "\n> #### Importante\n>\n> Este endpoint não está disponível no ambiente de sandbox" } }, "/roles/permissions": { "get": { "summary": "Retornar as permissões do vendedor", "tags": [ "Perfis de Acesso" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "journeys": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "description": { "type": "string" }, "type": { "type": "string" }, "resources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "description": { "type": "string" } } } } } } } } }, "examples": { "Example 1": { "value": { "journeys": [ { "id": 14, "keyInternationalization": "journey.administrative", "description": "Administrativo", "type": "DEFAULT", "icon": "pi pi-briefcase", "resources": [ { "id": 284, "key": "financialInformationSeller", "type": "FEATURE", "keyInternationalization": "resource.financialInformationSeller", "description": "Faturas", "isPresent": null }, { "id": 286, "key": "userManagement", "type": "FEATURE", "keyInternationalization": "resource.userManagement", "description": "Usuários", "isPresent": null }, { "id": 285, "key": "profileManagement", "type": "FEATURE", "keyInternationalization": "resource.profileManagement", "description": "Perfis de Acesso", "isPresent": null } ] }, { "id": 15, "keyInternationalization": "journey.help", "description": "Ajuda", "type": "DEFAULT", "icon": "pi pi-question-circle", "resources": [ { "id": 287, "key": "allowedChat", "type": "FEATURE", "keyInternationalization": "resource.allowedChat", "description": "Chat", "isPresent": null }, { "id": 288, "key": "support", "type": "FEATURE", "keyInternationalization": "resource.support", "description": "Ajuda", "isPresent": null }, { "id": 289, "key": "university", "type": "FEATURE", "keyInternationalization": "resource.university", "description": "Universidade ANYMARKET", "isPresent": null } ] } ] } } } } } } }, "operationId": "get-roles-permissions", "description": "\n> #### Importante\n>\n> Este endpoint não está disponível no ambiente de sandbox" } }, "/roles/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true } ], "get": { "summary": "Buscar informações do perfil de acesso", "tags": [ "Perfis de Acesso" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "journeys": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "description": { "type": "string" }, "type": { "type": "string" }, "resources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "description": { "type": "string" } } } } } } }, "name": { "type": "string" }, "id": { "type": "integer" } } }, "examples": { "Example 1": { "value": { "journeys": [ { "id": 14, "keyInternationalization": "journey.administrative", "description": "Administrativo", "type": "DEFAULT", "icon": "pi pi-briefcase", "resources": [ { "id": 284, "key": "financialInformationSeller", "type": "FEATURE", "keyInternationalization": "resource.financialInformationSeller", "description": "Faturas", "isPresent": false }, { "id": 286, "key": "userManagement", "type": "FEATURE", "keyInternationalization": "resource.userManagement", "description": "Usuários", "isPresent": false }, { "id": 285, "key": "profileManagement", "type": "FEATURE", "keyInternationalization": "resource.profileManagement", "description": "Perfis de Acesso", "isPresent": false } ] } ], "name": "Administrativo - HomologBrasil", "id": 6 } } } } } }, "404": { "description": "A role informada não existe no sistema", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errorCode": { "type": "string" } } }, "examples": { "Example 1": { "value": { "message": "Perfil invalido, por favor verifique o perfil informado.", "errorCode": "INVALID_ROLE" } } } } } } }, "operationId": "get-roles-id", "description": "\n> #### Importante\n>\n> Este endpoint não está disponível no ambiente de sandbox" }, "put": { "summary": "Alterar informações do perfil de acesso", "tags": [ "Perfis de Acesso" ], "description": "\n> #### Importante\n>\n> Este endpoint não está disponível no ambiente de sandbox\n\nAlterar informações do perfil de acesso\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.\n>\n> Campos omitidos podem ser redefinidos ou apagados.\n>\n> Use este método quando quiser sobrescrever todas as informações.", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "resourcesId": { "type": "array", "items": { "type": "number" } } } }, "examples": { "Example 1": { "value": { "name": "abc", "resourcesId": [ 1 ] } } } } } } }, "operationId": "put-roles-id", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "resourcesId": { "type": "array", "items": { "type": "number" } } } }, "examples": { "Example 1": { "value": { "name": "abc", "resourcesId": [ 1 ] } } } } } } }, "delete": { "summary": "Deletar um perfil de acesso", "tags": [ "Perfis de Acesso" ], "responses": { "200": { "description": "" } }, "operationId": "delete-roles-id", "description": "\n> #### Importante\n>\n> Este endpoint não está disponível no ambiente de sandbox" } }, "/monitorings/{id}/retry": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true } ], "put": { "summary": "/monitoring/{id}/retry", "tags": [ "Monitoramento de Erro" ], "responses": { "202": { "description": "Accepted" } }, "operationId": "put-monitorings-id-retry", "description": "# Envia um monitoring para retentativa\nEnvia um monitoring para retentativa\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.\n>\n> Campos omitidos podem ser redefinidos ou apagados.\n>\n> Use este método quando quiser sobrescrever todas as informações." } }, "/monitorings/{id}/cancel": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true } ], "put": { "summary": "/monitoring/{id}/cancel", "tags": [ "Monitoramento de Erro" ], "responses": { "200": { "description": "OK" } }, "operationId": "put-monitorings-id-cancel", "description": "# Cancela um monitoring\nCancela um monitoring\n\n> O método `PUT` substitui completamente o recurso. \n>\n> Todos os campos obrigatórios devem ser enviados, mesmo que não tenham sido modificados.\n>\n> Campos omitidos podem ser redefinidos ou apagados.\n>\n> Use este método quando quiser sobrescrever todas as informações." } }, "/fiscalDocuments": { "get": { "summary": "/fiscalDocuments", "tags": [ "Documentos Fiscais" ], "responses": { "200": { "description": "OK\r\n\r\n> Caso nenhum documento seja encontrado, o retorno será **200** com o array `content` vazio.\r\n", "content": { "application/json": { "schema": { "type": "object", "required": [ "content", "links", "page" ], "properties": { "content": { "type": "array", "items": { "type": "object", "required": [ "id", "createdAt", "lastUpdate", "marketplace" ], "properties": { "id": { "type": "integer", "description": "ID do registro do documento, enviado na notificação." }, "documentId": { "type": "string", "description": "Identificador da nota fiscal, é retornado o número da nota fiscal para documentos do tipo NFE" }, "documentKey": { "type": "string", "description": "Chave do documento, é retornado a chave da nota fiscal para documentos do tipo NFE" }, "orderId": { "type": "string", "description": "ID do pedido no ANYMARKET associado ao pedido" }, "createdAt": { "type": "string", "description": "Data de criação do registro do documento no ANYMARKET" }, "lastUpdate": { "type": "string", "description": "Data da última atualização do documento" }, "marketplace": { "type": "string", "description": "Descritivo de qual marketplace o pedido pertence" }, "origin": { "type": "string", "description": "Responsável pela persistência da nota fiscal no armazenador de arquivo fiscal document. Quando não informado no envio, o valor padrão é UNKNOW.", "enum": [ "ORIGIN_ERP", "ORIGIN_MARKETPLACE", "UNKNOW" ], "x-enum-descriptions": { "ORIGIN_ERP": "Nota fiscal enviada pelo ERP do seller", "ORIGIN_MARKETPLACE": "Nota fiscal originada do marketplace", "UNKNOW": "Origem não identificada (valor padrão quando não informado)" } }, "documentType": { "type": "object", "properties": { "type": { "type": "string", "description": "Modelo do documento" }, "subType": { "description": "Tipo de operação do documento", "enum": [] } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "status": { "enum": [], "description": "Estado do documento: Autorizado, Cancelado." }, "data": { "type": "string", "format": "date-time", "description": "Data de emissão do documento/evento" }, "url": { "type": "object", "properties": { "path": { "type": "string", "description": "Caminho da API de acesso ao documento" }, "expirationDate": { "type": "string", "description": "Data de remoção do documento " } } } } } }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "referenceKey": { "type": "string", "description": "Chave do documento relacionado" }, "documentType": { "type": "object", "properties": { "type": { "type": "string", "description": "Modelo do documento relacionado" }, "value": { "type": "string", "description": "Tipo de operação do documento relacionado" } } } } } }, "metadata": { "type": "array", "description": "Campos adicionais de informações do documento de chave e valor de informações específicas de cada canal.", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } } }, "links": { "type": "array", "description": "Referências de paginação\r\n", "items": { "type": "object", "required": [ "rel", "href" ], "properties": { "rel": { "type": "string", "description": "Relacionamento do hyperlink" }, "href": { "type": "string", "description": "URL de definição do recurso" } } } }, "page": { "type": "object", "required": [ "size", "totalElements", "totalPages", "number" ], "properties": { "size": { "type": "integer", "description": "Tamanho da página\r\n\r\n" }, "totalElements": { "type": "integer", "description": "Total de elementos existentes\r\n\r\n" }, "totalPages": { "type": "integer", "description": "Total de páginas disponíveis\r\n\r\n" }, "number": { "type": "integer", "description": "Número da página atual\r\n\r\n" } } } } }, "examples": { "Example 1": { "value": { "content": [ { "id": "string", "documentId": "string", "documentKey": "string", "orderId": "string", "createdAt": "string", "lastUpdate": "string", "marketplace": "string", "origin": "string", "documentType": { "type": "string", "value": "string" }, "documents": [ { "status": "string", "data": "string", "url": { "path": "string", "expirationDate": "string" } } ], "relationships": [ { "referenceKey": "string", "documentType": { "type": "string", "value": "string" } } ], "metadata": [ { "key": "string", "value": "string" } ] } ], "links": [ { "rel": "string", "href": "string" } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } }, "stoplight-Example 1": { "value": { "content": [ { "id": "47.", "documentId": "23208074", "documentKey": "35240612345678000123550010000012345678901234", "orderId": "20020251989", "createdAt": "2025-06-23T14:04:36.934718Z", "lastUpdate": "2025-06-23T14:10:36.934727Z", "marketplace": "MERCADO_LIVRE", "origin": "ORIGIN_ERP", "documentType": { "type": "NFE", "value": "sale" }, "documents": [ { "status": "AUTHORIZED", "data": "2025-06-04T15:30:50Z", "url": { "path": "/document/download/1", "expirationDate": "2030-06-04T15:30:50Z" } }, { "status": "CANCELLED", "data": "2025-06-05T15:30:50Z", "url": { "path": "/document/download/2", "expirationDate": "2030-06-05T15:30:50Z" } } ], "relationships": [ { "referenceKey": "35240612345678000123550010000012345678901235", "documentType": { "type": "NFE", "value": "symbolic_inbound_return" } } ], "metadata": [ { "key": "cfop", "value": "1949" } ] } ], "links": [ { "rel": "self", "href": "/api/fiscal-documents?page=0&size=10" }, { "rel": "next", "href": "/api/fiscal-documents?page=1&size=10" }, { "rel": "last", "href": "/api/fiscal-documents?page=50&size=10" } ], "page": { "size": 10, "totalElements": 504, "totalPages": 51, "number": 0 } } } } } } } }, "operationId": "get-fiscalDocuments", "description": "# Consulta Documentos Fiscais\r\n\r\nConsulta listagem de documentos fiscais\r\n\r\n", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "orderId", "description": "ID do pedido associado ao documento" }, { "schema": { "enum": [ "MERCADO_LIVRE", "MAGAZINE_LUIZA", "SHOPEE", "NETSHOES", "DAFITI", "AMAZON_GLOBAL_API" ], "type": "string" }, "in": "query", "name": "marketplace", "description": "ENUM do marketplace", "allowEmptyValue": false }, { "schema": { "type": "string", "format": "date-time", "example": "2022-11-25T14:00:00-03:00" }, "in": "query", "name": "createdAtFrom", "description": "Criado a partir de", "allowEmptyValue": false }, { "schema": { "type": "string", "format": "date", "example": "2022-11-25T20:30:00-03:00" }, "in": "query", "name": "createdAtTo", "description": "Criado antes de", "allowEmptyValue": false }, { "schema": { "type": "string", "example": "2022-11-25T14:00:00-03:00", "format": "time" }, "in": "query", "name": "lastUpdateFrom", "description": "Atualizado a partir de" }, { "schema": { "type": "string", "format": "time", "example": "2022-11-25T20:30:00-03:00" }, "in": "query", "name": "lastUpdateTo", "description": "Atualizado antes de" }, { "schema": { "enum": [ "sale", "sale_return", "devolution", "inbound", "inbound_return", "symbolic_inbound", "symbolic_inbound_return" ] }, "in": "query", "name": "documentTypeValue", "description": "Tipo de operação do documento" }, { "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int64", "default": 10, "minimum": 1, "maximum": 50 }, "description": "Número máximo de elementos" }, { "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int64", "maximum": 9999999, "minimum": 0 }, "description": "Posição de início da paginação" } ] }, "parameters": [] }, "/fiscalDocuments/{id}": { "get": { "summary": "/fiscalDocuments/{id}", "tags": [ "Documentos Fiscais" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "content" ], "properties": { "content": { "type": "array", "items": { "type": "object", "required": [ "id", "createdAt", "lastUpdate", "marketplace" ], "properties": { "id": { "type": "integer", "description": "ID do registro do documento, enviado na notificação." }, "documentId": { "type": "string", "description": "Identificador da nota fiscal, é retornado o número da nota fiscal para documentos do tipo NFE" }, "documentKey": { "type": "string", "description": "Chave do documento, é retornado a chave da nota fiscal para documentos do tipo NFE" }, "orderId": { "type": "string", "description": "ID do pedido no ANYMARKET associado ao pedido" }, "createdAt": { "type": "string", "description": "Data de criação do registro do documento no ANYMARKET" }, "lastUpdate": { "type": "string", "description": "Data da última atualização do documento" }, "marketplace": { "type": "string", "description": "Descritivo de qual marketplace o pedido pertence" }, "origin": { "type": "string", "description": "Responsável pela persistência da nota fiscal no armazenador de arquivo fiscal document. Quando não informado no envio, o valor padrão é UNKNOW.", "enum": [ "ORIGIN_ERP", "ORIGIN_MARKETPLACE", "UNKNOW" ], "x-enum-descriptions": { "ORIGIN_ERP": "Nota fiscal enviada pelo ERP do seller", "ORIGIN_MARKETPLACE": "Nota fiscal originada do marketplace", "UNKNOW": "Origem não identificada (valor padrão quando não informado)" } }, "documentType": { "type": "object", "properties": { "type": { "type": "string", "description": "Modelo do documento" }, "subType": { "description": "Tipo de operação do documento", "enum": [] } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "status": { "enum": [], "description": "Estado do documento: Autorizado, Cancelado." }, "data": { "type": "string", "format": "date-time", "description": "Data de emissão do documento/evento" }, "url": { "type": "object", "properties": { "path": { "type": "string", "description": "Caminho da API de acesso ao documento" }, "expirationDate": { "type": "string", "description": "Data de remoção do documento " } } } } } }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "referenceKey": { "type": "string", "description": "Chave do documento relacionado" }, "documentType": { "type": "object", "properties": { "type": { "type": "string", "description": "Modelo do documento relacionado" }, "value": { "type": "string", "description": "Tipo de operação do documento relacionado" } } } } } }, "metadata": { "type": "array", "description": "Campos adicionais de informações do documento de chave e valor de informações específicas de cada canal.", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } } } } }, "examples": { "Retorno padrão": { "value": { "content": [ { "id": "string", "documentId": "string", "documentKey": "string", "orderId": "string", "createdAt": "string", "lastUpdate": "string", "marketplace": "string", "origin": "string", "documentType": { "type": "string", "value": "string" }, "documents": [ { "status": "string", "data": "string", "url": { "path": "string", "expirationDate": "string" } } ], "relationships": [ { "referenceKey": "string", "documentType": { "type": "string", "value": "string" } } ], "metadata": [ { "key": "string", "value": "string" } ] } ], "links": [ { "rel": "string", "href": "string" } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } }, "Retorno sem conteúdo": { "value": { "content": [], "links": [ { "rel": "self", "href": "/api/fiscalDocuments?offset=800&limit=10" }, { "rel": "first", "href": "/api/fiscalDocuments?offset=0&limit=10" } ], "page": { "size": 10, "totalElements": 0, "totalPages": 0, "number": 80 } } }, "Example 1": { "value": { "content": [ { "id": "47.", "documentId": "23208074", "documentKey": "35240612345678000123550010000012345678901234", "orderId": "20020251989", "createdAt": "2025-06-23T14:04:36.934718Z", "lastUpdate": "2025-06-23T14:10:36.934727Z", "marketplace": "MERCADO_LIVRE", "origin": "ORIGIN_MARKETPLACE", "documentType": { "type": "NFE", "value": "sale" }, "documents": [ { "status": "AUTHORIZED", "data": "2025-06-04T15:30:50Z", "url": { "path": "/document/download/1", "expirationDate": "2030-06-04T15:30:50Z" } }, { "status": "CANCELLED", "data": "2025-06-05T15:30:50Z", "url": { "path": "/document/download/2", "expirationDate": "2030-06-05T15:30:50Z" } } ], "relationships": [ { "referenceKey": "35240612345678000123550010000012345678901235", "documentType": { "type": "NFE", "value": "symbolic_inbound_return" } } ], "metadata": [ { "key": "cfop", "value": "1949" } ] } ], "links": [ { "rel": "self", "href": "/api/fiscal-documents?page=0&size=10" }, { "rel": "next", "href": "/api/fiscal-documents?page=1&size=10" }, { "rel": "last", "href": "/api/fiscal-documents?page=50&size=10" } ], "page": { "size": 10, "totalElements": 504, "totalPages": 51, "number": 0 } } } } } } }, "404": { "description": "Not Found" } }, "operationId": "get-fiscalDocuments-id", "description": "# Consulta Documento Fiscal\r\n\r\nConsulta um documento fiscal.", "parameters": [ { "in": "query", "name": "id", "schema": { "type": "integer" }, "description": "Id do documento fiscal gerado pelo ANYMARKET" } ] }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true } ] }, "/fiscalDocuments/download/{document_item_id}": { "get": { "summary": "/fiscalDocuments/download/{document_item_id}", "tags": [ "Documentos Fiscais" ], "responses": { "200": { "description": "Retorna o xml do documento fiscal\r\n\r\n##### Exemplos de resposta\r\n\r\n- Documento do tipo `\"NFE\"` com o status `\"AUTHORIZED\"` (Nota fiscal autorizada):\r\n\r\n```xml\r\n\r\n\r\n\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\t99\r\n\t\t\t\t12345678\r\n\t\t\t\tVenda de produtos diversos\r\n\t\t\t\t55\r\n\t\t\t\t1\r\n\t\t\t\t123456\r\n\t\t\t\t2025-01-01T12:00:00-03:00\r\n\t\t\t\t2025-01-01T12:00:00-03:00\r\n\t\t\t\t1\r\n\t\t\t\t1\r\n\t\t\t\t9999999\r\n\t\t\t\t1\r\n\t\t\t\t1\r\n\t\t\t\t9\r\n\t\t\t\t2\r\n\t\t\t\t1\r\n\t\t\t\t1\r\n\t\t\t\t1\r\n\t\t\t\t0\r\n\t\t\t\t0\r\n\t\t\t\texemplo.documentacao\r\n\t\t\t\t\r\n\t\t\t\t\t99999999999999999999999999999999999999999999\r\n\t\t\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\t00000000000191\r\n\t\t\t\tEMPRESA DE EXEMPLO LTDA\r\n\t\t\t\t\r\n\t\t\t\t\tRua Fictícia\r\n\t\t\t\t\t123\r\n\t\t\t\t\tBloco A\r\n\t\t\t\t\tCentro\r\n\t\t\t\t\t9999999\r\n\t\t\t\t\tCidade Exemplo\r\n\t\t\t\t\tEX\r\n\t\t\t\t\t00000000\r\n\t\t\t\t\t1058\r\n\t\t\t\t\tBrasil\r\n\t\t\t\t\t11999999999\r\n\t\t\t\t\r\n\t\t\t\t000000000000\r\n\t\t\t\t3\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\t00000000000000\r\n\t\t\t\tCLIENTE DEMONSTRACAO S/A\r\n\t\t\t\t\r\n\t\t\t\t\tAvenida de Teste\r\n\t\t\t\t\t1000\r\n\t\t\t\t\tConjunto 1\r\n\t\t\t\t\tBairro Teste\r\n\t\t\t\t\t8888888\r\n\t\t\t\t\tOutro Município\r\n\t\t\t\t\tTS\r\n\t\t\t\t\t88888888\r\n\t\t\t\t\t1058\r\n\t\t\t\t\tBrasil\r\n\t\t\t\t\r\n\t\t\t\t1\r\n\t\t\t\t000000000000\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\tXYZ123\r\n\t\t\t\t\t0000000000000\r\n\t\t\t\t\tProduto Exemplo - Mochila Teste\r\n\t\t\t\t\t00000000\r\n\t\t\t\t\t5101\r\n\t\t\t\t\tUN\r\n\t\t\t\t\t2\r\n\t\t\t\t\t50.00000000\r\n\t\t\t\t\t100.00\r\n\t\t\t\t\t0000000000000\r\n\t\t\t\t\tUN\r\n\t\t\t\t\t2\r\n\t\t\t\t\t50.00000000\r\n\t\t\t\t\t1\r\n\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\t15.00\r\n\t\t\t\t\t\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\t\t0\r\n\t\t\t\t\t\t\t00\r\n\t\t\t\t\t\t\t3\r\n\t\t\t\t\t\t\t100.00\r\n\t\t\t\t\t\t\t18.0000\r\n\t\t\t\t\t\t\t18.00\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\t999\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\t\t03\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\t\t99\r\n\t\t\t\t\t\t\t100.00\r\n\t\t\t\t\t\t\t1.6500\r\n\t\t\t\t\t\t\t1.65\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\t\t99\r\n\t\t\t\t\t\t\t100.00\r\n\t\t\t\t\t\t\t7.6000\r\n\t\t\t\t\t\t\t7.60\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\txPed:00000000000000\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\t100.00\r\n\t\t\t\t\t18.00\r\n\t\t\t\t\t0.00\r\n\t\t\t\t\t0.00\r\n\t\t\t\t\t0.00\r\n\t\t\t\t\t0.00\r\n\t\t\t\t\t0.00\r\n\t\t\t\t\t0.00\r\n\t\t\t\t\t100.00\r\n\t\t\t\t\t0.00\r\n\t\t\t\t\t0.00\r\n\t\t\t\t\t0.00\r\n\t\t\t\t\t0.00\r\n\t\t\t\t\t0.00\r\n\t\t\t\t\t0.00\r\n\t\t\t\t\t1.65\r\n\t\t\t\t\t7.60\r\n\t\t\t\t\t0.00\r\n\t\t\t\t\t100.00\r\n\t\t\t\t\t15.00\r\n\t\t\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\t0\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\t0\r\n\t\t\t\t\t01\r\n\t\t\t\t\t100.00\r\n\t\t\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\t00000000000100\r\n\t\t\t\t000000000\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\tDocumento emitido para fins de demonstração. Nenhuma operação real ocorreu.\r\n\t\t\t\t\r\n\t\t\t\t\tEXEMPLO-documento-ficticio-123456789\r\n\t\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\tDADOASSINATURAFICTICIO\r\n\t\t\r\n\t\r\n\t\r\n\t\t\r\n\t\t\t2\r\n\t\t\tEXEMPLO_APP\r\n\t\t\t99999999999999999999999999999999999999999999\r\n\t\t\t2025-01-01T12:30:00-03:00\r\n\t\t\t000000000000000\r\n\t\t\tDIGESTOEXEMPLO==\r\n\t\t\t100\r\n\t\t\tAutorizado o uso da NF-e\r\n\t\t\r\n\t\r\n\r\n\r\n```\r\n\r\n- Documento do tipo `\"NFE\"` com o status `\"CANCELLED\"` (Evento de cancelamento de nota fiscal):\r\n```xml\r\n\r\n\r\n \r\n \r\n 91\r\n 2\r\n 99999999000199\r\n 99999999999999999999550050000123456789012345\r\n 2025-06-01T10:00:00-03:00\r\n 110111\r\n 1\r\n 1.00\r\n \r\n Cancelamento\r\n 123456789012345\r\n Cancelamento realizado por motivo genérico para fins de teste.\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n XXXXXXXXXXXXXXXXXXXXXXXXXXXXX=\r\n \r\n \r\n XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\r\n \r\n \r\n MIIDXTCCAkWgAwIBAgIEUyb+qDANBgkqhkiG9w0BAQsFADBbMQswCQYDVQQGEwJCUjEWMBQGA1UECgwNQ29tcGFuaWEgRmljdGljaWExEzARBgNVBAMMCkV4ZW1wbG8gQ0EwHhcNMjUwNjAxMDAwMDAwWhcNMjYwNjAxMDAwMDAwWjBcMQswCQYDVQQGEwJCUjEXMBUGA1UECgwORW1pdGVudGUgRGV4ZW1wbG8xEzARBgNVBAMMCkV4ZW1wbG8gU1NUMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnomizado+ParaUsoEm+Docx==\r\n \r\n \r\n \r\n \r\n \r\n \r\n 2\r\n EXEMPLO100200\r\n 91\r\n 135\r\n Evento registrado e vinculado a NF-e\r\n 99999999999999999999550050000123456789012345\r\n 110111\r\n 1\r\n 2025-06-01T10:00:00-03:00\r\n 123456789012346\r\n \r\n \r\n\r\n\r\n```\r\n\r\n- Documento do tipo `\"CTE\"` com o status `\"AUTHORIZED\"` (Conhecimento de transporte autorizado):\r\n```xml\r\n\r\n\r\n \r\n \r\n \r\n 99\r\n 00000000\r\n 6353\r\n PRESTAÇÕES DE SERVIÇOS DE TRANSPORTE\r\n 57\r\n 1\r\n 1234567\r\n 2025-06-01T08:00:00-03:00\r\n 1\r\n 1\r\n 0\r\n 2\r\n 0\r\n 0\r\n 1.0.0\r\n 9999999\r\n Cidade de Origem\r\n XX\r\n 01\r\n 0\r\n 9999998\r\n Município Inicial\r\n XX\r\n 9999997\r\n Município Final\r\n YY\r\n 1\r\n 1\r\n \r\n 0\r\n \r\n \r\n \r\n 99999999000199\r\n 000000000\r\n TRANSPORTADORA FICTICIA LTDA\r\n \r\n Rua Exemplo\r\n 100\r\n Centro\r\n 9999999\r\n Cidade de Origem\r\n 99999999\r\n XX\r\n \r\n 3\r\n \r\n \r\n 88888888000188\r\n 111111111\r\n REMETENTE FICTÍCIO LTDA\r\n \r\n Avenida Fictícia\r\n 9999\r\n Bairro Fictício\r\n 9999998\r\n Município Inicial\r\n 88888888\r\n XX\r\n \r\n \r\n \r\n 00000000000\r\n DESTINATÁRIO FICTÍCIO\r\n \r\n Rua Final\r\n 0\r\n Complemento Qualquer\r\n Bairro Final\r\n 9999997\r\n Município Final\r\n 77777777\r\n YY\r\n \r\n \r\n \r\n 100.00\r\n 100.00\r\n \r\n \r\n \r\n \r\n 00\r\n 100.00\r\n 12.00\r\n 12.00\r\n \r\n \r\n 12.00\r\n \r\n \r\n \r\n 500.00\r\n MERCADORIA\r\n \r\n 01\r\n PESO BRUTO\r\n 10.0000\r\n \r\n \r\n \r\n \r\n 99999999999999999999550010000000000000000000\r\n 2025-06-05\r\n \r\n \r\n \r\n \r\n 00000000\r\n \r\n \r\n \r\n \r\n \r\n https://www.seufornecedor.com.br/cte/qrCode?chCTe=99999999999999999999550010000000000000000000&tpAmb=2\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==\r\n \r\n \r\n XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\r\n \r\n \r\n MIID...FICTICIO...CERTIFICADO\r\n \r\n \r\n \r\n \r\n \r\n \r\n 2\r\n EXEMPLO20240601000000\r\n 99999999999999999999550010000000000000000000\r\n 2025-06-01T08:00:01-03:00\r\n 999999999999999\r\n XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==\r\n 100\r\n Autorizado o uso do CT-e\r\n \r\n \r\n\r\n\r\n\r\n```\r\n", "content": {} }, "404": { "description": "Not Found" } }, "operationId": "get-fiscalDocuments-download", "description": "# Consulta o Arquivo de um Documento Fiscal\r\n\r\nConsulta um documento fiscal.\r\n\r\n> #### Atenção\r\n>\r\n> O `document_item_id` é retornado junto com todo o caminho de acesso ao XML na Consulta de Documentos Fiscais, no objeto `path`, do array `documents`, exemplo abaixo:\r\n>\r\n> ```json\r\n> {\r\n> [...],\r\n> \"documents\": [\r\n> {\r\n> \"status\": \"AUTHORIZED\",\r\n> \"data\": \"2025-06-04T15:30:50Z\",\r\n> \"url\": {\r\n> \"path\": \"/document/download/101\",\r\n> \"expirationDate\": \"2030-06-04T15:30:50Z\"\r\n> }\r\n> }\r\n> ]\r\n>}\r\n>```", "parameters": [ { "in": "query", "name": "id", "schema": { "type": "integer" }, "description": "Id do documento fiscal gerado pelo ANYMARKET" } ] }, "parameters": [ { "schema": { "type": "string" }, "name": "document_item_id", "in": "path", "required": true } ] }, "/prices": { "parameters": [], "get": { "summary": "/prices/transmission/{id}", "tags": [ "Preço" ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransmissionPrice" }, "examples": { "Example 1": { "value": { "id": 9276, "title": "Kit 02 Poltrona 01 Namoradeira e 02 Puffs Dado Suede Amarelo", "accountName": "ECOMMERCE", "idAccount": 1, "idSku": 76579, "basePrice": 1039.9, "priceFactor": 1.8, "originalPrice": 1984.81, "finalPrice": 1875.81, "discount": { "discountType": "PERCENT", "discountValue": 12.43 }, "priceRule": { "priceRuleRegular": 1871.83, "priceRuleDeal": 1871.82 }, "campaign": { "campaignRegularPrice": 1871.83, "campaignDealPrice": 1871.82 } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" }, "examples": { "Example 1": { "value": { "code": "404", "message": "TransmissionPrice não encontrado para o oi=47., transmissionId=927600" } } } } } } }, "operationId": "get-prices-id", "description": "# Consultar dados de transmissão por ID\r\nEste endpoint retorna as informações detalhadas da transmissão (registro da tabela SKU_MARKETPLACE) identificada pelo seu ID. Os dados incluem título do SKU, conta associada, preços (base, original e final), fator de preço, regras aplicadas, descontos e campanhas." } } }, "components": { "securitySchemes": { "gumgaToken": { "name": "gumgaToken", "type": "apiKey", "in": "header", "description": "Token de segurança fornecido pela Anymarket" }, "authorization": { "type": "http", "scheme": "bearer", "description": "Token Bearer da autenticação OAuth2 (v3). Obtenha o `access_token` em `POST /oauth2/token` (client credentials: `client_id`/`client_secret` no corpo JSON) e envie-o em `Authorization: Bearer `. O token expira (`expires_in`, em segundos). Declarado aqui para uso do documento da v3 — este documento (v2) não o exige." } }, "parameters": { "limit": { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "minimum": 5, "default": 5, "example": 5, "maximum": 100 }, "description": "Número máximo de elementos" }, "sort": { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Atributo para ordenação" }, "name": { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Atributo para filtro por nome" }, "partnerId": { "name": "partnerId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Atributo para filtro por partnerId" }, "offset": { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "minimum": 0 }, "description": "Posição de início da paginação" }, "sortDirection": { "name": "sortDirection", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] }, "description": "Atributo para direcionar a ordenação (ASC ou DESC)" }, "marketplaceQuery": { "name": "marketplace", "in": "query", "schema": { "$ref": "#/components/schemas/EnumMarketplaces" }, "description": "Marketplace" }, "marketPlace": { "name": "marketPlace", "in": "path", "schema": { "$ref": "#/components/schemas/EnumMarketplaces" }, "description": "Marketplace", "required": true } }, "schemas": { "400": { "description": "", "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "title": "400 - Bad Request", "example": { "code": "400", "message": "Não foi possível finalizar a chamada." } }, "404": { "description": "", "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "title": "404 - Not Found", "example": { "code": "404", "message": "Recurso com o id 'xxx' não encontrado." } }, "409": { "description": "", "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "title": "409 - Conflict", "example": { "code": "409", "message": "Não foi possível concluir a operação por conflito de integridade." } }, "422": { "description": "", "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "title": "422 - Error", "example": { "code": "422", "message": "O campo informado esta fora das especificações." } }, "500": { "description": "", "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "title": "500 - Error", "example": { "code": "500", "message": "Erro no sistema. Detalhes: Ocorreu um erro inesperado. Por favor, tente novamente." } }, "BrandAdd": { "title": "BrandAdd", "allOf": [ { "properties": { "name": { "type": "string", "description": "Nome da marca", "minLength": 1, "maxLength": 120 }, "reducedName": { "type": "string", "description": "Nome reduzido da marca", "minLength": 0, "maxLength": 30 }, "partnerId": { "type": "string", "minLength": 0, "maxLength": 255, "description": "ID da marca no parceiro" } }, "required": [ "name" ] } ], "description": "Model brand add", "type": "object" }, "PageLinks": { "title": "PageLinks", "type": "object", "properties": { "rel": { "type": "string", "description": "Hyperlink Relation", "example": "next" }, "href": { "type": "string", "description": "Resource definition URL", "example": "https://.../v2/{rota}?limit=5&offset=5" } } }, "PageMetadata": { "title": "PageMetadata", "type": "object", "properties": { "size": { "type": "integer", "description": "Page size", "format": "int64", "readOnly": true }, "totalElements": { "type": "integer", "description": "Total existing elements", "format": "int64", "readOnly": true }, "totalPages": { "type": "integer", "description": "Total available pages", "format": "int64", "readOnly": true }, "number": { "type": "integer", "description": "Current page number", "format": "int64", "readOnly": true } } }, "Page_CallBack": { "title": "Page_CallBack", "allOf": [ { "properties": { "links": { "type": "array", "description": "Referências de paginação", "uniqueItems": false, "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/PageLinks" } }, "page": { "$ref": "#/components/schemas/PageMetadata" } } } ], "description": "", "type": "object" }, "CallBack": { "type": "object", "properties": { "url": { "type": "string", "description": "URL do callback", "minLength": 1, "maxLength": 255 }, "orderActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de pedido" }, "productActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de produto" }, "transmissionActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de transmissão" }, "questionActive ": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de pergunta" } }, "required": [ "url" ], "example": { "url": "http://example.com", "token": "string", "orderActive": true, "productActive": true, "transmissionActive": true, "questionActive ": true } }, "CallBackPost": { "title": "CallBackPost", "allOf": [ { "properties": { "url": { "type": "string", "description": "URL do callback", "minLength": 1, "maxLength": 255, "format": "hostname" }, "orderActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de pedido " }, "productActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de produto" }, "transmissionActive": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de transmissão " }, "questionActive ": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de pergunta" } }, "required": [ "url" ] } ], "description": "Model post callBack", "type": "object" }, "Campaign": { "title": "Campaign", "allOf": [ { "properties": { "id": { "type": "integer", "description": "ID gerado pelo ANYMARKET", "format": "int64", "minimum": 0 }, "title": { "type": "string", "description": "Título da campanha", "maxLength": 35 }, "idAccount": { "type": "string", "maxLength": 35, "description": "ID da conta utilizada no MARKETPLACE " }, "accountName": { "type": "string", "description": "Conta utilizada no MARKETPLACE", "maxLength": 100 }, "description": { "type": "string", "description": "Descrição da campanha" }, "initialDate": { "type": "string", "description": "Data inicial", "format": "date-time" }, "finalDate": { "type": "string", "description": "Data final", "format": "date-time" }, "marketplace": { "type": "string", "description": "Marketplace da campanha" }, "status": { "type": "string", "description": "Status relacionado a campanha", "enum": [ "SCHEDULED", "ACTIVE", "FINALIZED" ] }, "productsCount": { "type": "number", "description": "Quantidade de produtos afetados na campanha.", "format": "long" } } } ], "description": "Model return campaign", "type": "object" }, "CategoryGET": { "title": "Category", "description": "Model return category", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID interno", "minimum": 0 }, "name": { "type": "string", "description": "Nome da categoria", "maxLength": 80 }, "path": { "type": "string", "description": "Diretório e subdiretórios da categoria", "maxLength": 1000 }, "partnerId": { "type": "string", "description": "ID da categoria no parceiro", "maxLength": 80 }, "priceFactor": { "type": "number", "format": "double", "description": "Fator de preço", "minimum": 0 }, "definitionPriceScope": { "type": "string", "description": "SKU (Manual, eu controlo o preço pelo SKU), SKU_MARKETPLACE (Manual, eu controlo o preço pelo anúncio) ou COST (Automático, pela mudança do custo)", "enum": [ "SKU", "SKU_MARKETPLACE", "COST" ] } }, "example": { "id": 0, "name": "string", "path": "string", "partnerId": "string", "priceFactor": 0, "definitionPriceScope": "SKU" } }, "Page_Category": { "title": "Page_Category", "type": "object", "required": [ "links", "content", "page" ], "properties": { "links": { "type": "array", "description": "Referências de paginação", "items": { "$ref": "#/components/schemas/PageLinks" } }, "content": { "type": "array", "description": "Lista de categorias", "items": { "$ref": "#/components/schemas/CategoryGET" } }, "page": { "$ref": "#/components/schemas/PageMetadata" } }, "example": { "links": [ { "rel": "next", "href": "https://.../v2/{rota}?limit=5&offset=5" } ], "content": [ { "id": 0, "name": "string", "path": "string", "partnerId": "string", "priceFactor": 0, "definitionPriceScope": "SKU" } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } }, "CategoryPOST": { "title": "Category", "allOf": [ { "properties": { "id": { "type": "integer", "format": "int64", "minimum": 0, "description": "ID interno" }, "name": { "type": "string", "description": "Nome da categoria", "maxLength": 80 }, "partnerId": { "type": "string", "description": "ID da categoria no parceiro", "maxLength": 80 }, "priceFactor": { "type": "number", "format": "double", "description": "Fator de preço", "minimum": 0 }, "definitionPriceScope": { "type": "string", "description": "SKU (Manual, eu controlo o preço pelo SKU), SKU_MARKETPLACE (Manual, eu controlo o preço pelo anúncio) ou COST (Automático, pela mudança do custo)", "enum": [ "SKU", "SKU_MARKETPLACE", "COST" ] }, "parent": { "type": "object", "description": "Categoria Pai (Utilizado na criação de Subcategorias)", "properties": { "id": { "type": "integer", "format": "int64", "minimum": 0, "description": "ID da categoria gerado pelo ANYMARKET" } } } }, "required": [ "name" ] } ], "description": "Category create/update model", "type": "object" }, "CategoryChildren": { "title": "Category", "allOf": [ { "properties": { "id": { "type": "integer", "format": "int64", "minimum": 0, "description": "ID interno" }, "name": { "type": "string", "description": "Nome da categoria", "maxLength": 80 }, "path": { "type": "string", "description": "Nome da categoria", "maxLength": 1000 }, "partnerId": { "type": "string", "description": "ID da categoria no parceiro", "maxLength": 80 }, "priceFactor": { "type": "number", "format": "double", "description": "Fator de preço", "minimum": 0 }, "definitionPriceScope": { "type": "string", "description": "SKU (Manual, eu controlo o preço pelo SKU), SKU_MARKETPLACE (Manual, eu controlo o preço pelo anúncio) ou COST (Automático, pela mudança do custo)\nCaso não informado o ANYMARKET adotará o cálculo como 'COST'.", "enum": [ "SKU", "SKU_MARKETPLACE", "COST" ] }, "parent": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID da categoria gerado pelo ANYMARKET ", "minimum": 0 }, "parnerId": { "type": "string", "description": "Id da categoria no parceiro" } } }, "children": { "$ref": "#/components/schemas/CategoryChildren" } } } ], "description": "Model return brand", "type": "object" }, "CategoryFullPath": { "type": "object", "properties": { "id": { "type": "integer", "description": "Category ID generated by ANYMARKET", "format": "int64", "minimum": 0 }, "name": { "type": "string", "minLength": 1, "description": "Category name" }, "path": { "type": "string", "minLength": 1, "description": "Category Path" }, "partnerId": { "type": "string", "minLength": 1, "description": "Partner category ID " }, "priceFactor": { "type": "number", "format": "double", "description": "Price Factor " }, "children": { "$ref": "#/components/schemas/CategoryChildren" } } }, "PrintTagPost": { "type": "object", "properties": { "orders": { "type": "array", "description": "Orders IDs", "items": { "type": "integer", "description": "Id da venda" } } }, "required": [ "orders" ] }, "PrintTag": { "allOf": [ { "properties": { "content": { "type": "string", "description": "Conteúdo presente no TXT do ZPL2, disponível apenas no modo ZPL2 com o parâmetro TXT." } } } ], "type": "object" }, "EnumMarketplaces": { "type": "string", "title": "Marketplaces", "enum": [ "MERCADO_LIVRE", "ALIEXPRESS", "AMAZON_GLOBAL_API", "ANGELONI", "ARMAZEM_PARAIBA", "B2W_NEW_API", "BABYBIZ", "BANCO_INTER", "BANDSHOP", "BELEZA_NA_WEB_NEW_API", "BRAVIUM", "C_A", "CARREFOUR", "CASA_VIDEO", "CASSOL_CENTERLAR", "CENTAURO_NEW_API", "CLAROSHOP_MEXICO", "COMFORTFLEX_NOVA_API", "COMPRA_CERTA", "COPPEL", "CSM", "DB1_MARKETPLACE", "DECATHLON", "DIGIGROW", "EFACIL", "ELEKTRA", "EOS", "EPOCA", "ESTANTE_VIRTUAL", "FALABELLA", "FARMADELIVERY", "FASTSHOP_NEW_API", "FENICIO", "FOODIES_STORE", "GFG", "GRUPO_MATEUS", "HELP_SELLER", "HITES", "HOUSE_OF_GAMERS", "ICBC_MALL", "IGA", "ITAU", "JUMPSELLER", "KABUM", "KOERICH", "LE_BISCUIT", "LEROY_MERLIN", "LIVESHOP", "LL_LOYALTY", "LOJA_DO_COOPERADO", "LOJA_DO_MECANICO", "LOJAS_COLOMBO", "LOJAS_IMPERIO", "LOJAS_LEBES_NEW_API", "LOJAS_MM", "LOJAS_QUERO_QUERO", "MADEIRA_MADEIRA", "MAGAZINE_LUIZA", "MAGENTO", "MAIS_CORREIOS", "MARCA_SELETA", "MARTINS_ATACADO", "MEGATONE", "MOBLY", "MULTIVAREJO_GPA", "NETSHOES", "NEXTSHOP", "NUVEMSHOP", "OLIST_NEW_API", "PAGUE_MENOS", "PARIS", "PHILIPS_STORE", "PITSTOP", "PNEUBEST", "POLISHOP", "POSTHAUS_NEW_API", "PRESTASHOP", "PRIVALIA", "RAIA_DROGASIL", "RAMARIM_NOVA_API", "RENNER", "RI_HAPPY_NEW_API", "RIACHUELO", "RIPLEY", "SENFF_SHOPPING", "SHEIN", "SHOPEE", "SHOPHUB", "SHOPIFY", "SHOPPING_BB", "SHOPPING_LIVELO", "SICOOB", "SICREDI", "STECK", "SUBLIMITY", "TA_TASHOP", "TENDA_ATACADO", "THE_HOME_DEPOT", "TIENDA_CLIC", "TIKTOK_SHOP", "TRAY", "TROCAFONE", "VALE_BONUS", "VENTURESHOP", "VINKLO_BY_FESTALAB", "VTEX", "WALMART", "WEB_CONTINENTAL_V2", "WEHOUSE", "WOOCOMMERCE", "WOOCOMMERCE2", "YA_PLACE_STORE", "ZEMA", "ZOOM" ], "description": "Descritivo de qual marketplace o pedido pertence", "example": "ALIEXPRESS" }, "StockFulfillmentGet": { "description": "", "type": "object", "properties": { "sku": { "type": "string", "description": "Código do SKU no MarketPlace" }, "document": { "type": "string", "minLength": 14, "maxLength": 14, "description": "CNPJ do centro de distribuição (CD) fulfillment" }, "description": { "type": "string", "description": "Descrição do centro de distribuição (CD) fulfillment" }, "fulfillment_quantity_stock": { "type": "number", "description": "Quantidade de estoque fulfillment no centro de distribuição (CD)", "format": "double" }, "fulfillment_reserved_stock": { "type": "number", "description": "Quantidade de estoque fulfillment reservado no centro de distribuição (CD)", "format": "double" }, "fulfillment_available_stock": { "type": "number", "description": "Quantidade de estoque fulfillment disponível no centro de distribuição (CD). Obtido através do cálculo (fulfillment_quantity_stock - fulfillment_reserved_stock)", "format": "double" } }, "example": { "sku": "string", "document": "string", "description": "string", "fulfillment_quantity_stock": "number", "fulfillment_available_stock": "number", "fulfillment_reserved_stock": "number" } }, "StockLocalGet": { "description": "", "type": "object", "properties": { "id": { "type": "integer", "description": "ID do local de estoque", "format": "int64", "minimum": 1 }, "name": { "type": "string", "minLength": 1, "description": "Descrição do local de estoque " }, "virtual": { "type": "boolean", "description": "Identifica se o local de estoque é virtual" }, "defaultLocal": { "type": "boolean", "description": "Identifica se o local de estoque é o padrão " }, "zipCode": { "type": "string", "minLength": 1, "description": "CEP do local de estoque" } }, "example": { "id": 0, "name": "string", "virtual": true, "distributor": "string", "defaultLocal": true, "zipCode": "string" } }, "StockLocalPost": { "description": "", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Descrição do local de estoque", "maxLength": 200 }, "virtual": { "type": "boolean", "description": "Identifica se o local de estoque é virtual " }, "defaultLocal": { "type": "boolean", "description": "Identifica se o local de estoque é o padrão" }, "zipCode": { "type": "string", "minLength": 1, "description": "CEP do local de estoque" }, "distributor": { "type": "string", "minLength": 1, "description": "(Obrigatório quando estoque for virtual) Distribuidor para estoque virtual = ['UNDEFINED', 'ALDO', 'EVOLUSOM', 'HAYAMAX', 'PROSHOWS']" } }, "required": [ "name" ], "example": { "name": "string", "virtual": true, "defaultLocal": true, "zipCode": "string" } }, "OrderFeed": { "description": "", "type": "object", "title": "OrderFeed", "properties": { "id": { "type": "integer", "description": "ID do pedido gerado pelo ANYMARKET", "format": "int64", "minimum": 0 }, "token": { "type": "string", "minLength": 1, "description": "Token do feed", "format": "uuid" } }, "x-tags": [ "Feed" ] }, "TransmissionsFeed": { "description": "", "type": "object", "title": "TransmissionsFeed", "properties": { "id": { "type": "integer", "description": "SKU ID generated by ANYMARKET ", "format": "int64", "minimum": 0 }, "token": { "type": "string", "minLength": 1, "description": "Token do feed", "format": "uuid" } }, "x-tags": [ "Feed" ] }, "TransmissionsPriceFeed": { "description": "", "type": "object", "title": "TransmissionsPriceFeed", "properties": { "id": { "type": "integer", "description": "ID da notificação gerado pelo ANYMARKET ", "format": "int64", "minimum": 0 }, "token": { "type": "string", "minLength": 1, "description": "Token do feed", "format": "uuid" } }, "x-tags": [ "Feed" ] }, "FreightRequest": { "description": "", "type": "object", "properties": { "zipCode": { "type": "string", "minLength": 1, "description": "CEP do destinatário do frete sem hífen ", "maxLength": 8 }, "marketPlace": { "description": "Marketplace onde foi realizada a consulta", "type": "string" }, "additionalPercentual": { "type": "number", "description": "Percentual a adicionar ao valor de frete", "format": "double" }, "timeout": { "type": "integer", "description": "Timeout, em milissegundos, para a consulta", "format": "int32", "minimum": 0 }, "products": { "type": "array", "uniqueItems": true, "minItems": 1, "description": "Lista de produtos a consultar", "items": { "type": "object", "properties": { "skuId": { "type": "string", "minLength": 1, "description": "Código do item no marketplace " }, "amount": { "type": "integer", "description": "Quantidade do item ", "format": "int32", "maximum": 1000000, "minimum": 0 }, "dimensions": { "type": "object", "description": "Dimensões do item", "properties": { "height": { "type": "number", "description": "Altura do objeto" }, "width": { "type": "number", "description": "Largura do objeto" }, "weight": { "type": "number", "description": "Peso do objeto" }, "length": { "type": "number", "description": "Comprimento do objeto" } } } }, "required": [ "skuId", "amount" ] } } }, "required": [ "zipCode", "marketPlace" ], "example": { "zipCode": "string", "marketPlace": "string", "additionalPercentual": -1.7976931348623157e+308, "timeout": 0, "products": [ { "skuId": "string", "amount": 0, "dimensions": { "height": 0, "width": 0, "weight": 0, "length": 0 } } ] } }, "FreightResponse": { "description": "", "type": "object", "properties": { "marketPlace": { "description": "Marketplace onde foi realizada a consulta", "$ref": "#/components/schemas/EnumMarketplaces" }, "zipCode": { "type": "string", "minLength": 1, "description": "CEP do destinatário do frete sem hífen ", "maxLength": 8 }, "products": { "type": "array", "uniqueItems": true, "minItems": 1, "description": "Lista de produtos existentes ", "items": { "type": "object", "properties": { "skuId": { "type": "string", "minLength": 1, "description": "Código do item no marketplace " }, "amount": { "type": "number", "description": "Quantidade do item" }, "dimensions": { "type": "object", "description": "Dimensões do item", "properties": { "height": { "type": "number", "description": "Altura do objeto" }, "width": { "type": "number", "description": "Largura do objeto" }, "weight": { "type": "number", "description": "Peso do objeto" }, "length": { "type": "number", "description": "Comprimento do objeto" } } }, "stockAmount": { "type": "number", "description": "Quantidade em estoque" }, "additionalDeliveryTime": { "type": "number", "description": "Prazo adicional em dias para este produto " }, "price": { "type": "number", "description": "Preço normal do produto", "format": "double", "minimum": 0 }, "discountPrice": { "type": "number", "description": "Preço do produto com desconto ", "format": "double", "minimum": 0 } } } }, "quotes": { "type": "array", "uniqueItems": true, "minItems": 1, "description": "Cotações de frete", "items": { "type": "object", "properties": { "carrierName": { "type": "string", "minLength": 1, "description": "Nome da empresa de transporte " }, "serviceName": { "type": "string", "minLength": 1, "description": "Nome do serviço de transporte " }, "deliveryTime": { "type": "number", "description": "Prazo de entrega em dias " }, "freightType": { "type": "string", "minLength": 1, "description": "Tipo do frete (NORMAL/EXPRESS) ", "enum": [ "NORMAL", "EXPRESS" ] }, "price": { "type": "number", "description": "Valor do frete", "format": "double", "minimum": 0 } } } }, "defaultFreight": { "type": "object", "description": "Quando está configurado frete padrão e não encontrou algum SKU pesquisado, retorna o valor do frete padrão ", "properties": { "carrierName": { "type": "string", "minLength": 1, "description": "Nome da empresa de transporte " }, "serviceName": { "type": "string", "minLength": 1, "description": "Nome do serviço de transporte " }, "deliveryTime": { "type": "number", "description": "Prazo de entrega em dias " }, "freightType": { "type": "string", "minLength": 1, "description": "Tipo do frete (NORMAL/EXPRESS) ", "enum": [ "NORMAL", "EXPRESS" ] }, "price": { "type": "number", "description": "Valor do frete", "format": "double", "minimum": 0 } } }, "missingSkus": { "type": "object", "description": "Mapa com as SKUs não encontradas" } }, "example": { "marketPlace": "string", "zipCode": "string", "products": [ { "skuId": "string", "amount": 0, "dimensions": { "height": 0, "width": 0, "weight": 0, "length": 0 }, "stockAmount": 0, "additionalDeliveryTime": 0, "price": 0, "discountPrice": 0 } ], "quotes": [ { "carrierName": "string", "serviceName": "string", "deliveryTime": 0, "freightType": "string", "price": 0 } ], "defaultFreight": { "carrierName": "string", "serviceName": "string", "deliveryTime": 0, "freightType": "string", "price": 0 }, "missingSkus": {} } }, "Image": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da imagem gerado pelo ANYMARKET ", "format": "int64", "minimum": 0 }, "index": { "type": "integer", "description": "Índice da imagem, ou seja, posição da imagem no cadastro no produto; inicia-se em 1 e limita-se a quantidade de imagens no produto", "format": "int32", "minimum": 0 }, "main": { "type": "boolean", "description": "Determina se a imagem é principal", "default": false }, "url": { "type": "string", "minLength": 1, "description": "URL original da imagem ", "format": "uri" }, "thumbnailUrl": { "type": "string", "minLength": 1, "description": "URL da imagem miniatura", "format": "uri" }, "lowResolutionUrl": { "type": "string", "minLength": 1, "description": "URL da imagem de baixa resolução", "format": "uri" }, "standardUrl": { "type": "string", "minLength": 1, "description": "URL padrão da imagem", "format": "uri" }, "originalImage": { "type": "string", "minLength": 1, "description": "URL da imagem original com suas dimensões originais ", "format": "uri" }, "variation": { "type": "string", "minLength": 1, "description": "Indica a qual variaçao a imagem pertence ", "example": "Azul" }, "status": { "type": "string", "minLength": 1, "description": "Determina qual é o status da imagem", "enum": [ "UNPROCESSED", "PROCESSED", "ERROR" ] }, "statusMessage": { "type": "string", "minLength": 1, "description": "Preenchida quando ocorre algum erro no processamento da imagem " }, "standardWidth": { "type": "integer", "description": "Dimensão padrão de largura da imagem ", "format": "int32" }, "standardHeight": { "type": "integer", "description": "Dimensão padrão de altura da imagem", "format": "int32" }, "originalWidth": { "type": "integer", "description": "Dimensão original de largura da imagem", "format": "int32" }, "originalHeight": { "type": "integer", "description": "Dimensão original de altura da imagem", "format": "int32" } }, "required": [ "main", "url" ] }, "ImagePut": { "description": "", "type": "object", "properties": { "id": { "type": "integer", "description": "ID da imagem vínculada no produto no ANYMARKET" }, "index": { "type": "integer", "description": "Índice da imagem, ou seja, posição da imagem que será atualizada no cadastro do produto; inicia-se em 1 e limita-se a quantidade de imagens no produto" }, "main": { "type": "boolean", "description": "Determina se a imagem é principal " } }, "required": [ "id", "index" ], "example": { "id": 0, "index": 0, "main": true } }, "ImagePost": { "description": "", "type": "object", "properties": { "index": { "type": "integer", "description": "Índice da imagem, ou seja, posição da imagem no cadastro no produto; inicia-se em 1 e limita-se a quantidade de imagens no produto", "format": "int32", "minimum": 0 }, "main": { "type": "boolean", "description": "Determina se a imagem é principal" }, "url": { "type": "string", "minLength": 1, "description": "URL original da imagem" }, "variation": { "type": "string", "minLength": 1, "description": "Indica a qual variaçao a imagem pertence " }, "useCase": { "type": "string", "description": "Defines the image's use case/classification for the product. Possible values: `PRODUCT_IMAGE` (Product), `SIZE_CHART_IMAGE` (Size Chart), `CERTIFICATION_IMAGE` (Product Label). Optional field; if omitted, the image does not receive a use case classification.", "enum": [ "PRODUCT_IMAGE", "SIZE_CHART_IMAGE", "CERTIFICATION_IMAGE" ] } }, "required": [ "url" ], "example": { "index": 0, "main": true, "url": "string", "variation": "string", "useCase": "SIZE_CHART_IMAGE" } }, "MonitoringPost": { "description": "", "type": "object", "properties": { "partnerId": { "type": "string", "minLength": 1, "description": "ID do monitoramento - controle \nno parceiro" }, "origin": { "type": "string", "minLength": 1, "description": "Nome do integrador" }, "message": { "type": "string", "minLength": 1, "description": "Resumo da mensagem de erro", "maxLength": 500 }, "details": { "type": "string", "minLength": 1, "description": "Detalhes da mensagem de erro ", "maxLength": 4000 }, "createdAt": { "type": "string", "minLength": 1, "description": "Data de entrada do registro", "format": "date-time" }, "type": { "type": "string", "minLength": 1, "description": "Tipo de monitoramento (ERROR, WARN)", "enum": [ "ALERT", "INTERNAL_ERROR", "CRITICAL_ERROR" ] }, "retryCallbackURL": { "type": "string", "minLength": 1, "description": "URL da API do integrador ", "format": "uri" }, "status": { "type": "string", "minLength": 1, "description": "Tipo de satus do monitoramento (PENDING, RETRYING, CANCELLED, CONCLUDED)", "enum": [ "PENDING", "RETRYING", "CANCELLED", "CONCLUDED" ] } }, "required": [ "partnerId", "origin", "message", "createdAt" ] }, "MonitoringPut": { "description": "", "type": "object", "properties": { "id": { "type": "integer", "description": "ID do monitoramento", "format": "int64", "minimum": 1 }, "partnerId": { "type": "string", "minLength": 1, "description": "ID do monitoramento - controle \nno parceiro" }, "origin": { "type": "string", "minLength": 1, "description": "Nome do integrador" }, "message": { "type": "string", "minLength": 1, "description": "Resumo da mensagem de erro", "maxLength": 500 }, "details": { "type": "string", "minLength": 1, "description": "Detalhes da mensagem de erro ", "maxLength": 4000 }, "createdAt": { "type": "string", "minLength": 1, "description": "Data de entrada do registro", "format": "date-time" }, "type": { "type": "string", "minLength": 1, "description": "Tipo de monitoramento (ERROR, WARN)", "enum": [ "ALERT", "INTERNAL_ERROR", "CRITICAL_ERROR" ] }, "retryCallbackURL": { "type": "string", "minLength": 1, "description": "Url da API do integrador ", "format": "uri" }, "status": { "type": "string", "minLength": 1, "description": "Tipo de satus do monitoramento (PENDING, RETRYING, CANCELLED, CONCLUDED)", "enum": [ "PENDING", "RETRYING", "CANCELLED", "CONCLUDED" ] } }, "required": [ "partnerId", "origin", "message", "status" ] }, "Monitoring": { "description": "", "type": "object", "properties": { "id": { "type": "integer", "description": "ID do monitoramento", "format": "int64", "minimum": 1 }, "partnerId": { "type": "string", "minLength": 1, "description": "ID do monitoramento - controle \nno parceiro" }, "origin": { "type": "string", "minLength": 1, "description": "Nome do integrador" }, "message": { "type": "string", "minLength": 1, "description": "Resumo da mensagem de erro", "maxLength": 500 }, "details": { "type": "string", "minLength": 1, "description": "Detalhes da mensagem de erro ", "maxLength": 4000 }, "createdAt": { "type": "string", "minLength": 1, "description": "Data de entrada do registro", "format": "date-time" }, "type": { "type": "string", "minLength": 1, "description": "Tipo de monitoramento (ERROR, WARN)", "enum": [ "ALERT", "INTERNAL_ERROR", "CRITICAL_ERROR" ] }, "retryCallbackURL": { "type": "string", "minLength": 1, "description": "Url da API do integrador ", "format": "uri" }, "status": { "type": "string", "minLength": 1, "description": "Tipo de satus do monitoramento (PENDING, RETRYING, CANCELLED, CONCLUDED)", "enum": [ "PENDING", "RETRYING", "CANCELLED", "CONCLUDED" ] } } }, "FiscalDocumentMetadata": { "type": "object", "description": "Metadados fiscais complementares da nota fiscal", "properties": { "operationType": { "type": "string", "description": "Tipo de operação fiscal (ex.: entrada, saida)" }, "emissionType": { "type": "string", "description": "Tipo de emissão da nota fiscal (ex.: normal, contingencia)" }, "authorizationProtocol": { "type": "string", "description": "Protocolo de autorização da nota fiscal" } } }, "OrderInvoice": { "type": "object", "properties": { "accessKey": { "type": "string", "description": "Chave de acesso da nota fiscal", "maxLength": 255 }, "series": { "type": "string", "description": "Número de série da nota fiscal", "maxLength": 255 }, "number": { "type": "string", "description": "Número da nota fiscal", "maxLength": 255 }, "date": { "type": "string", "description": "Data de emissão da nota fiscal (Necessário informar o fuso horario)", "format": "date-time" }, "cfop": { "type": "string", "description": "Código Fiscal de Operações e Prestações, esse campo será obrigátorio caso seja utilizado 'Mercado Envio Coleta'", "maxLength": 50 }, "companyStateTaxId": { "type": "string", "description": "Inscrição Estadual quando o comprador é uma Pessoa Jurídica (CNPJ), esse campo será obrigátorio caso seja utilizado 'Mercado Envios Coleta'; é possível utilizar 'ISENTO'", "maxLength": 20 }, "linkNfe": { "type": "string", "description": "Campo para inserir a URL para consulta da nota fiscal", "maxLength": 300 }, "invoiceLink": { "type": "string", "description": "Campo para inserir a URL onde está armazenada o PDF ou o XML da nota fiscal (utilizado para a integração da Garbarino)", "maxLength": 4000 }, "extraDescription": { "type": "string", "description": "Campo para observações", "maxLength": 255 }, "fiscalMetadata": { "$ref": "#/components/schemas/FiscalDocumentMetadata" } } }, "OrderShippingAddressGet": { "type": "object", "properties": { "address": { "type": "string", "description": "Endereço", "maxLength": 500 }, "city": { "type": "string", "description": "Cidade", "maxLength": 255 }, "comment": { "type": "string", "description": "Complemento", "maxLength": 500 }, "country": { "type": "string", "description": "País (Campo original, cadastrado pelo Marketplace ou Ecommerce)", "maxLength": 255 }, "countryAcronymNormalized": { "type": "string", "description": "Sigla do País padronizado internamente pelo ANYMARKET. Pode ser nulo se o country for nulo ou desconhecido.", "maxLength": 2 }, "countryNameNormalized": { "type": "string", "description": "Nome do País padronizado internamente pelo ANYMARKET. Pode ser nulo se o country for nulo ou UNKNOWN para desconhecido.", "maxLength": 100 }, "neighborhood": { "type": "string", "description": "Bairro", "maxLength": 255 }, "number": { "type": "string", "description": "Número", "maxLength": 100 }, "promisedShippingTime": { "type": "string", "description": "Data acordada para entrega", "example": "2023-06-15T21:25:52Z" }, "promisedDispatchTime": { "type": "string", "description": "Data prevista de coleta", "example": "2024-09-17T03:00:00Z" }, "receiverName": { "type": "string", "description": "Nome do remetente para entrega", "maxLength": 255 }, "reference": { "type": "string", "description": "Referência", "maxLength": 255 }, "state": { "type": "string", "description": "Sigla do Estado padronizado internamente pelo ANYMARKET. Pode ser nulo se o state for nulo ou o valor enviado pelo Marketplace, se ele for desconhecido.", "maxLength": 255 }, "stateNameNormalized": { "type": "string", "description": "Nome do Estado padronizado internamente pelo ANYMARKET. Pode ser nulo se o state for nulo ou UNKNOWN para desconhecido.", "maxLength": 100 }, "street": { "type": "string", "description": "Rua", "maxLength": 255 }, "zipCode": { "type": "string", "description": "CEP", "maxLength": 255 } }, "required": [ "address", "city", "country", "countryAcronymNormalized", "countryNameNormalized", "number", "receiverName", "state", "stateNameNormalized", "street", "zipCode" ] }, "DocumentType": { "type": "string", "title": "Tipos de documentos", "enum": [ "CPF", "CNPJ", "OTHER", "DNI" ], "default": "OTHER", "readOnly": true, "description": "" }, "OrderBillingAddressGet": { "type": "object", "description": "Endereço de Cobrança", "properties": { "address": { "type": "string", "description": "Endereço", "maxLength": 500 }, "city": { "type": "string", "description": "Cidade", "maxLength": 255 }, "comment": { "type": "string", "description": "Complemento", "maxLength": 500 }, "country": { "type": "string", "description": "País (Campo original, cadastrado pelo Marketplace ou Ecommerce)", "maxLength": 255 }, "countryAcronymNormalized": { "type": "string", "description": "Sigla do País padronizado internamente pelo ANYMARKET. Pode ser nulo se o country for nulo ou desconhecido.", "maxLength": 2 }, "countryNameNormalized": { "type": "string", "description": "Nome do País padronizado internamente pelo ANYMARKET. Pode ser nulo se o country for nulo ou UNKNOWN para desconhecido.", "maxLength": 100 }, "neighborhood": { "type": "string", "description": "Bairro", "maxLength": 255 }, "number": { "type": "string", "description": "Número", "maxLength": 100 }, "reference": { "type": "string", "description": "Referência", "maxLength": 255 }, "shipmentUserDocument": { "type": "string", "maxLength": 80 }, "shipmentUserDocumentType": { "$ref": "#/components/schemas/DocumentType" }, "shipmentUserName": { "type": "string", "maxLength": 255 }, "state": { "type": "string", "description": "Sigla do Estado padronizado internamente pelo ANYMARKET. Pode ser nulo se o state for nulo ou o valor enviado pelo Marketplace, se ele for desconhecido.", "maxLength": 255 }, "stateNameNormalized": { "type": "string", "description": "Nome do Estado padronizado internamente pelo ANYMARKET. Pode ser nulo se o state for nulo ou UNKNOWN para desconhecido.", "maxLength": 100 }, "street": { "type": "string", "description": "Rua", "maxLength": 255 }, "zipCode": { "type": "string", "description": "CEP", "maxLength": 255 } }, "required": [ "address", "city", "country", "countryAcronymNormalized", "countryNameNormalized", "neighborhood", "number", "state", "stateNameNormalized", "street", "zipCode" ] }, "OrderAnymarketAddress": { "type": "object", "required": [ "address", "city", "country", "neighborhood", "number", "promisedShippingTime", "state", "stateAcronymNormalized", "street", "zipCode" ], "properties": { "address": { "type": "string", "description": "Endereço", "maxLength": 500 }, "city": { "type": "string", "description": "Cidade", "maxLength": 255 }, "comment": { "type": "string", "description": "Complemento", "maxLength": 500 }, "country": { "type": "string", "maxLength": 255, "description": "País" }, "neighborhood": { "type": "string", "description": "Bairro", "maxLength": 255 }, "number": { "type": "string", "description": "Número", "maxLength": 100 }, "promisedShippingTime": { "type": "string", "description": "Data estimada de entrega", "example": "2023-06-15T21:25:52Z", "format": "date-time" }, "receiverName": { "type": "string", "description": "Nome do remetente para entrega", "maxLength": 255 }, "reference": { "type": "string", "description": "Referência", "maxLength": 255 }, "state": { "type": "string", "description": "Sigla do Estado padronizado internamente pelo ANYMARKET. Pode ser nulo se o state for nulo ou o valor enviado pelo Marketplace, se ele for desconhecido.", "maxLength": 255 }, "stateAcronymNormalized": { "type": "string", "maxLength": 2, "description": "Sigla do Estado padronizado internamente pelo ANYMARKET. Pode ser nulo se o state for nulo ou o valor enviado pelo Marketplace, se ele for desconhecido." }, "street": { "type": "string", "description": "Rua", "maxLength": 255 }, "zipCode": { "type": "string", "description": "CEP", "maxLength": 255 } } }, "BuyerGet": { "type": "object", "required": [ "document", "documentNumberNormalized", "documentType", "email", "name", "phone" ], "properties": { "cellPhone": { "type": "string", "description": "Celular do comprador", "maxLength": 255 }, "document": { "type": "string", "description": "Número do documento. Essa informação pode não ser preenchida para algum marketplace ou ecommerce.", "maxLength": 255 }, "documentNumberNormalized": { "type": "string", "description": "Número do documento normalizado pelo ANYMARKET. Somente números. Caso o document não seja um CPF ou CNPJ este campo irá retornar nulo." }, "documentType": { "type": "string", "description": "Tipo do documento. Valores possíveis: CPF, CNPJ, OTHER\n", "enum": [ "CPF", "CNPJ", "DNI", "OTHER" ] }, "email": { "type": "string", "description": "E-mail do comprador", "maxLength": 255 }, "marketPlaceId": { "type": "string", "description": "ID no marketplace. Essa informação pode não existir para algum marketplace ou ecommerce.", "maxLength": 255 }, "name": { "type": "string", "description": "Nome do comprador", "maxLength": 255 }, "phone": { "type": "string", "description": "Telefone do comprador", "maxLength": 255 }, "dateOfBirth": { "type": "string", "description": "Data de nascimento do comprador", "format": "date-time" }, "companyStateTaxId": { "type": "string", "description": "Inscrição Estadual do comprador.", "maxLength": 25 } } }, "OrderPaymentGet": { "type": "object", "required": [ "marketplaceId", "method", "paymentDetailNormalized", "paymentMethodNormalized" ], "properties": { "installments": { "type": "number", "description": "Número de parcelas do meio do pagamento. Deve-se dividir o número de parcelas pelo valor para encontrar o valor de cada parcela.", "format": "int64" }, "marketplaceId": { "type": "string", "description": "ID do pagamento enviado pelo marketplace. Alguns marketplaces não disponibilizam o id, podendo o valor estar nulo ou com um valor fixo \"1\" dependendo da regra. (Exemplo- Cnova sempre tem apenas um pagamento para a compra, então o id do pagamento pode ser sempre \"1\")", "maxLength": 50 }, "method": { "type": "string", "description": "Método de pagamento. (Campo original, enviado pelo Marketplace ou Ecommerce)", "maxLength": 255 }, "paymentDetailNormalized": { "type": "string", "description": "Detalhamento do método de pagamento padronizado internamente pelo ANYMARKET. Caso for um valor desconhecido internamente irá retornar UNKNOWN. Se o method for nulo, este campo também será nulo.", "default": "UNKNOWN", "maxLength": 100 }, "paymentMethodNormalized": { "type": "string", "description": "Método de pagamento padronizado internamente pelo ANYMARKET. Caso for um valor desconhecido internamente irá retornar UNKNOWN. Se o method for nulo, este campo também será nulo.", "default": "UNKNOWN", "maxLength": 100 }, "status": { "type": "string", "description": "Status do pagamento enviado pelo marketplace", "maxLength": 255 }, "value": { "type": "number", "description": "Valor do pagamento (Em caso de cobrança de juros, o valor é adicionado ao total da compra. Ex: Mercado livre)\n", "format": "double" }, "gatewayFee": { "type": "number", "description": "Taxa referente ao gateway de pagamento (Ex: MercadoPago).\n", "format": "double" }, "marketplaceFee": { "type": "number", "description": "Taxa referente ao Marketplace.\n", "format": "double" }, "documentPaymentInstitution": { "type": "string", "description": "Identificação através do CNPJ do responsavel pela transação de pagamento com cartão. tag card/CNPJ." }, "cardOperator": { "type": "string", "description": "Código da bandeira da operadora de cartão de crédito e/ou débito. Conforme publicada no Portal Nacional da Nota Fiscal Eletrônica. tag card/tBand" }, "orderAuthorizationCardCode": { "type": "string", "description": "Número de autorização da operação cartão de crédito e/ou débito. tag card/cAuth" } } }, "SimpleProduct": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID do produto gerado pelo ANYMARKET", "format": "int64" }, "title": { "type": "string", "description": "Título do produto", "maxLength": 150 } }, "required": [ "id", "title" ] }, "SimpleSku": { "type": "object", "properties": { "ean": { "type": "string", "description": "Código de barras do SKU", "maxLength": 13 }, "id": { "type": "integer", "description": "SKU ID generated by ANYMARKET", "format": "int64" }, "title": { "type": "string", "description": "SKU title", "maxLength": 150 }, "partnerId": { "type": "string", "description": "Partner SKU code", "maxLength": 120 }, "externalId": { "type": "string", "description": "External ID, used by some marketplaces for internal control ", "maxLength": 100, "deprecated": true } }, "required": [ "id", "title", "partnerId" ] }, "OrderItemStockGet": { "type": "object", "properties": { "amount": { "type": "number", "description": "Quantidade em estoque do local", "format": "double" }, "stockLocalId": { "type": "integer", "description": "ID do estoque do local", "format": "int64" }, "stockName": { "type": "string", "description": "Descrição do local de estoque" } }, "required": [ "amount", "stockLocalId", "stockName" ] }, "OrderShippingItemGet": { "type": "object", "properties": { "product": { "$ref": "#/components/schemas/SimpleProduct" }, "sku": { "$ref": "#/components/schemas/SimpleSku" }, "amount": { "type": "number", "description": "Quantidade do item", "format": "double" }, "unit": { "type": "number", "description": "Preço do item", "format": "double" }, "gross": { "type": "number", "description": "Valor bruto do item (amount * unit)", "format": "double" }, "total": { "type": "number", "description": "Total do item com desconto aplicado (gross - discount)", "format": "double" }, "discount": { "type": "number", "description": "Desconto do item", "format": "double" }, "discountItemMetadata": { "type": "array", "description": "Indica a origem do desconto aplicado ao item (seller ou marketplace), quando informada pelo canal de venda. Cada campo de origem é omitido quando não informado.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "**COUPON**: indica que o item possui desconto do tipo Cupom no Mercado Livre.
\n**FREE_ITEM**: indica que o item possui 100% de desconto e é do tipo Amostra grátis.", "enum": [ "FREE_ITEM", "COUPON" ] }, "discountProductSeller": { "type": "number", "format": "double", "description": "Valor do desconto do item concedido pelo seller. Omitido quando não informado pelo canal." }, "discountProductMarketplace": { "type": "number", "format": "double", "description": "Valor do desconto do item concedido pelo marketplace. Omitido quando não informado pelo canal." } } } }, "shippings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID gerado pelo ANYMARKET" }, "shippingCarrierNormalized": { "type": "string", "default": "UNKNOWN", "description": "Transportadora normalizada", "maxLength": 100 }, "shippingCarrierTypeNormalized": { "type": "string", "default": "UNKNOWN", "description": "Tipo de transpote normalizado", "maxLength": 100 }, "shippingtype": { "type": "string", "description": "Nome da transportadora vinda do marketplace", "maxLength": 255 } }, "required": [ "id", "shippingCarrierNormalized", "shippingCarrierTypeNormalized", "shippingtype" ] } }, "customization": { "type": "object", "properties": { "customizationType": { "type": "string", "description": "Tipo da customização/personalização a ser realizada", "example": "Personalização de Nome", "maxLength": 255 }, "customizationQuantity": { "type": "number", "description": "Quantidade de itens a serem personalizados" }, "customizationPrice": { "type": "number", "description": "Preço da personalização", "format": "double" }, "customizationValue": { "type": "string", "description": "Conteúdo a ser preenchido na personalização", "maxLength": 255 } } }, "stocks": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemStockGet" } }, "marketPlaceId": { "type": "string", "description": "Id do item no marketplace / plataforma de e-commerce (Caso não informado, será o mesmo do sku)", "maxLength": 255 }, "orderItemId": { "type": "number", "description": "Id do item no pedido gerado pelo ANYMARKET", "format": "int64" }, "idInMarketPlace": { "type": "string", "description": "Código do sku no marketplace", "maxLength": 255 }, "officialStoreId": { "type": "string", "description": "Id da loja oficial (Mercado Livre)", "readOnly": true, "maxLength": 20 }, "officialStoreName": { "type": "string", "description": "Descrição da loja oficial (Mercado Livre)", "readOnly": true, "maxLength": 200 }, "listingType": { "type": "string", "description": "Tipo de listagem do anúncio do item vendido (Mercado Livre)", "readOnly": true, "maxLength": 30 }, "freeShipping": { "type": "boolean", "description": "Determina se o frete é grátis" } }, "required": [ "product", "sku", "amount", "unit", "gross", "total", "discount", "orderItemId", "idInMarketPlace" ], "example": { "product": { "id": 0, "title": "string" }, "sku": { "id": 0, "title": "string", "partnerId": "string", "externalId": "string", "ean": "string" }, "amount": -1.7976931348623157e+308, "unit": -1.7976931348623157e+308, "gross": -1.7976931348623157e+308, "total": -1.7976931348623157e+308, "discount": -1.7976931348623157e+308, "discountItemMetadata": [ { "type": "COUPON", "discountProductSeller": 5 } ], "shippings": { "id": 0, "shippingtype": "string", "shippingCarrierNormalized": "string", "shippingCarrierTypeNormalized": "string" }, "customization": { "customizationType": "Personalização de Nome", "customizationQuantity": 0, "customizationPrice": "string", "customizationValue": "string" }, "stocks": [ { "stockLocalId": 0, "stockName": "string", "amount": 0 } ], "marketPlaceId": "string", "orderItemId": "string", "idInMarketPlace": "string", "officialStoreId": "string", "officialStoreName": "string", "listingType": "string", "freeShipping": true } }, "OrderTracking": { "type": "object", "properties": { "carrier": { "type": "string", "description": "Nome da transportadora", "maxLength": 255 }, "date": { "type": "string", "description": "Data do rastreio (Necessário informar o fuso horario)", "format": "date-time" }, "deliveredDate": { "type": "string", "description": "Data de entrega ao Cliente (Necessário informar o fuso horario)", "format": "date-time" }, "estimateDate": { "type": "string", "description": "Data estimada (Necessário informar o fuso horario)", "format": "date-time" }, "number": { "type": "string", "description": "Número de rastreio", "maxLength": 255 }, "shippedDate": { "type": "string", "description": "Data em que foi entregue a transportadora (Necessário informar o fuso horario)", "format": "date-time" }, "url": { "type": "string", "description": "URL para o rastreamento", "maxLength": 255 }, "carrierDocument": { "type": "string", "description": "CNPJ da transportadora", "maxLength": 255 }, "bufferingDate": { "type": "string", "description": "Data que o pedido está agendado para envio (Apenas para pedidos com tempo de fabriação)", "format": "date-time" } } }, "PickUp": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da loja no ANYMARKET" }, "description": { "type": "string", "description": "Nome da loja", "maxLength": 60 }, "partnerId": { "type": "integer", "description": "Código da loja no parceiro" }, "marketplaceId": { "type": "string", "description": "ID da loja no marketplace", "maxLength": 255 }, "receiverName": { "type": "string", "description": "Nome de quem retira o pedido na loja", "maxLength": 255 } } }, "OrderMetadata": { "type": "object", "description": "Campos adicionais do pedido.", "properties": { "discountSummarized": { "type": "number", "format": "double", "description": "Sum of the order discount (discount) with the sum of the discounts of all order items (items[].discount). Returns 0 when there are no discounts.", "example": 35.9 }, "number-of-packages": { "type": "string", "default": "", "description": "Quantidade de volumes para a impressão de etiqueta (B2W Nova Api)" }, "cdZipCode": { "type": "string", "description": "CEP do Centro de Distribuição referente ao CNPJ de faturamento do pedido" }, "needInvoiceXML": { "type": "string", "description": "Caso o marketplace exija a integração do arquivo XML com os dados de faturamento", "example": "true" }, "mshops": { "type": "string", "description": "Caso o pedido tenha sido feito pelo canal de vendas Mercado Shops", "example": "true, false" }, "Envvias": { "type": "string" }, "VIAtotalDiscountAmount": { "type": "string" }, "B2WshippingType": { "type": "string" }, "logistic_type": { "type": "string", "description": "Tipo logistico do Mercado Livre", "example": "drop_off, cross_docking, xd_drop_off, self_service" }, "printTag": { "type": "string" }, "canceldetail_motivation": { "type": "string", "description": "Descrição do que foi o motivador do cancelamento, em alguns casos, pode ser aspectos fiscais, de fraude, entrega, entre outros" }, "canceldetail_code": { "type": "string", "description": "Código identificador do respectiva cancelamento ou, em alguns causos, o código da causa que provocou o cancelamento" }, "canceldetail_description": { "type": "string", "description": "Descrição do cancelamento ou da causa que o originou" }, "canceldetail_requested_by": { "type": "string", "description": "Origem do solicitante do cancelamento, em alguns casos pode ser solicitado pelo marketplace, pelo seller ou até pelo comprador" } }, "example": { "discountSummarized": 35.9, "number-of-packages": 1, "cdZipCode": "string", "needInvoiceXML": true, "mshops": true, "Envvias": "string", "VIAtotalDiscountAmount": "string", "B2WshippingType": "string", "logistic_type": "drop_off, cross_docking, xd_drop_off, self_service", "printTag": true, "canceldetail_motivation": "string", "canceldetail_code": "string", "canceldetail_description": "string", "canceldetail_requested_by": "string" } }, "DiscountDetails": { "type": "object", "properties": { "type": { "type": "string", "description": "**COUPON**: indica que a venda possui desconto do tipo Cupom, quando informado pelo canal de venda.
\n**FREE_ITEM**: indica que a venda possui 100% de desconto e é do tipo Amostra grátis, quando informado pelo canal de venda.", "enum": [ "FREE_ITEM", "COUPON" ] }, "discountOrderSeller": { "type": "number", "format": "double", "description": "Valor do desconto do pedido custeado pelo vendedor. Omitido quando não informado." }, "discountOrderMarketplace": { "type": "number", "format": "double", "description": "Valor do desconto do pedido custeado pelo marketplace. Omitido quando não informado." } } }, "DiscountMetadata": { "type": "object", "properties": { "type": { "type": "array", "description": "**COUPON**: indica que a venda possui desconto do tipo Cupom, quando informado pelo canal de venda.
\n**FREE_ITEM**: indica que a venda possui 100% de desconto e é do tipo Amostra grátis, quando informado pelo canal de venda.", "items": { "type": "string", "enum": [ "FREE_ITEM", "COUPON" ] } }, "discountDetails": { "type": "array", "description": "Detalha a origem do desconto do pedido, quando informada pelo canal de venda. Campo e subcampos omitidos (não retornam como `null`) quando não informados. Aplica-se apenas a pedidos importados após a entrada em produção desta funcionalidade — pedidos já existentes na base não são reprocessados nem atualizados retroativamente.", "items": { "$ref": "#/components/schemas/DiscountDetails" } } } }, "Order": { "type": "object", "required": [ "id", "accountName", "marketPlaceId", "marketPlaceNumber", "marketPlace", "createdAt", "transmissionStatus", "status", "marketPlaceStatus", "discount", "freight", "sellerFreight", "interestValue", "gross", "total", "shipping", "anymarketAddress", "buyer", "payments", "items", "deliveryStatus", "idAccount" ], "properties": { "id": { "type": "integer", "description": "ID do pedido gerado pelo ANYMARKET", "format": "int64" }, "accountName": { "type": "string", "description": "Identificador da conta do Marketplace", "maxLength": 255 }, "marketPlaceId": { "type": "string", "description": "ID interno do pedido no marketplace", "maxLength": 255 }, "marketPlaceNumber": { "type": "string", "description": "ID público do pedido no marketplace", "maxLength": 255 }, "partnerId": { "type": "string", "description": "Código do pedido no parceiro. Uma vez informado, não poderá ser alterado", "maxLength": 100 }, "marketPlace": { "$ref": "#/components/schemas/EnumMarketplaces" }, "subChannel": { "type": "string", "description": "Site onde foi realizado o pedido (conforme recebido pelo marketplace. Pode ser nulo caso o marketplace não possua subcanal)", "maxLength": 50 }, "subChannelNormalized": { "type": "string", "description": "Site onde foi realizado o pedido (normalizado pelo ANYMARKET. Pode ser nulo)", "maxLength": 100 }, "createdAt": { "type": "string", "description": "Data de criação do pedido", "format": "date-time" }, "paymentDate": { "type": "string", "description": "Data de pagamento do pedido", "format": "date-time" }, "cancelDate": { "type": "string", "description": "Data de cancelamento do pedido", "format": "date-time" }, "shippingOptionId": { "type": "string", "description": "ID do Envio de cada Marketplace", "maxLength": 50 }, "transmissionStatus": { "type": "string", "description": "Status da transmissão

\n\n **OK**: Pedido sincronizado com sucesso com o Marketplace
\n **ERROR**: Ocorreu erro na sincronização com o Marketplace
\n **WAITING**: Aguardando sincronização com o Marketplace
\n" }, "status": { "type": "string", "description": "Status do pedido

\n\n **CONCLUDED**: Pedido entregue (é a última situação do pedido). Mudando para essa situação é necessário informar: data de entrega
\n **CANCELED**: Cancelado
\n **INVOICED**: Faturado. Mudando para essa situação é necessário informar: número da nota, número de série, data de emissão e chave de acesso
\n **PAID_WAITING_DELIVERY**: Enviado (aguardando entrega). Mudando para essa situação é necessário informar: URL de rastreamento, número de rastreio, nome da transportadora, data de envio
\n **PAID_WAITING_SHIP**: Pago (está aguardando envio)
\n **PENDING**: Pendente (Ainda não foi pago. Existe parâmetro para que o ANYMARKET importe do MarketPlace o pedido que ainda não foi pago)
\n", "enum": [ "PENDING", "PAID_WAITING_SHIP", "INVOICED", "PAID_WAITING_DELIVERY", "CONCLUDED", "CANCELED" ] }, "marketPlaceStatus": { "type": "string", "description": "Situação do pedido no marketplace. Cada marketplace possui situações diferentes. Ex: no mercado livre não existe a situação faturado\n", "maxLength": 255 }, "marketPlaceStatusComplement": { "type": "string", "description": "Informação complementar à situação do pedido no marketplace. Cada marketplace possui situações diferentes. Ex: na Dafiti o pedido pode ser marcado como falha de entrega e a causa pode ser armazenada nesse atributo\n", "maxLength": 1000 }, "documentIntermediator": { "type": "string", "description": "Identificador de intermediador da Transação CNPJ", "maxLength": 14 }, "intermediateRegistrationId": { "type": "string", "description": "Identificador do cadastro (vendedor ou usuário) no intermediador", "maxLength": 60 }, "documentPaymentInstitution": { "type": "string", "description": "Identificador de Instituição de pagamento CNPJ", "maxLength": 14 }, "fulfillment": { "type": "boolean", "description": "Identifica se o pedido é fulfillment" }, "quoteReconciliation": { "type": "object", "description": "Cotação realizada", "properties": { "quoteId": { "type": "string", "description": "ID da cotação realizada" }, "price": { "type": "number", "description": "Preço retornado no momento da cotação" } } }, "discount": { "type": "number", "description": "Desconto do pedido", "format": "double" }, "freight": { "type": "number", "description": "Valor de frete", "format": "double" }, "sellerFreight": { "type": "number", "description": "Custo de Frete do Lojista", "format": "double" }, "interestValue": { "type": "number", "description": "Valor dos juros", "format": "double" }, "gross": { "type": "number", "description": "Total bruto sem o valor de frete", "format": "double" }, "total": { "type": "number", "description": "Total do pedido com o valor de frete", "format": "double" }, "marketPlaceUrl": { "type": "string", "description": "URL do pedido no marketplace", "maxLength": 255 }, "marketPlaceShipmentStatus": { "description": "Situação de envio do pedido no marketplace. Cada marketplace possui situações diferentes", "enum": [ "UNKNOWN", "PACKING", "HOLD_FOR_PICKUP", "DELAYED_PICKUP", "HOLD_FOR_SHIPPED", "DELAYED_SHIPPING", "SHIPPED", "SHIP_CONFIRMED", "QUARANTINE", "NOT_DELIVERED", "IN_TRANSIT", "DELIVERED", "DELAYED", "DELIVERED_LATE" ], "default": "UNKNOWN" }, "invoice": { "$ref": "#/components/schemas/OrderInvoice" }, "shipping": { "$ref": "#/components/schemas/OrderShippingAddressGet" }, "billingAddress": { "$ref": "#/components/schemas/OrderBillingAddressGet" }, "anymarketAddress": { "$ref": "#/components/schemas/OrderAnymarketAddress" }, "buyer": { "$ref": "#/components/schemas/BuyerGet" }, "payments": { "description": "Dados referente a pagamento (Será enviado pelo Marketplace)", "type": "array", "items": { "$ref": "#/components/schemas/OrderPaymentGet" } }, "items": { "description": "Dados referente aos produtos comprados", "type": "array", "items": { "$ref": "#/components/schemas/OrderShippingItemGet" } }, "tracking": { "$ref": "#/components/schemas/OrderTracking" }, "deliveryStatus": { "type": "string", "description": "Status do envio
\n **UNKNOWN**: Envio pendente
\n **IN_TRANSIT**: Pedido Enviado\n **DELIVERED**: Pedido entregue
\n", "enum": [ "UNKNOWN", "IN_TRANSIT", "DELIVERED", "HOLD_FOR_PICKUP", "DELAYED", "DELIVERED_LATE", "NOT_DELIVERY" ], "default": "UNKNOWN" }, "pickup": { "$ref": "#/components/schemas/PickUp" }, "idAccount": { "description": "ID da conta gerado automático pelo ANYMARKET", "type": "number" }, "metadata": { "$ref": "#/components/schemas/OrderMetadata" }, "orderTypeName": { "type": "string", "description": "Nome do tipo de pedido", "example": "DBA", "maxLength": 20 }, "shippingId": { "type": "string", "description": "Id do envio MERCADO_LIVRE" }, "discountMetadata": { "type": "array", "description": "Indica o valor do desconto quando informado pelo canal de venda.", "items": { "$ref": "#/components/schemas/DiscountMetadata" } }, "lastUpdate": { "type": "string", "format": "date-time", "description": "Data de atualização do pedido" } }, "example": { "id": 0, "accountName": "string", "marketPlaceId": "string", "marketPlaceNumber": "string", "partnerId": "string", "marketPlace": "string", "subChannel": "string", "subChannelNormalized": "string", "createdAt": "2022-02-24T14:15:22Z", "paymentDate": "2022-02-24T14:15:22Z", "cancelDate": "2022-02-24T14:15:22Z", "shippingOptionId": "string", "transmissionStatus": "string", "status": "PENDING", "marketPlaceStatus": "string", "marketPlaceStatusComplement": "string", "documentIntermediator": "string", "intermediateRegistrationId": "string", "documentPaymentInstitution": "string", "fulfillment": true, "discount": 0, "freight": 0, "interestValue": 0, "gross": 0, "total": 0, "marketPlaceUrl": "string", "marketPlaceShipmentStatus": "string", "invoice": { "accessKey": "string", "series": "string", "number": "string", "date": "2022-02-24T14:15:22Z", "cfop": "string", "companyStateTaxId": "string", "linkNfe": "string", "invoiceLink": "string", "extraDescription": "string", "fiscalMetadata": { "operationType": "string", "emissionType": "string", "authorizationProtocol": "string" } }, "shipping": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "address": "string", "number": "string", "neighborhood": "string", "street": "string", "comment": "string", "reference": "string", "zipCode": "string", "receiverName": "string", "promisedShippingTime": "2019-08-24T14:15:22Z" }, "billingAddress": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "street": "string", "number": "string", "neighborhood": "string", "comment": "string", "reference": "string", "zipCode": "string" }, "anymarketAddress": { "state": "string", "city": "string", "zipCode": "string", "neighborhood": "string", "address": "string", "street": "string", "number": "string", "comment": "string", "reference": "string", "receiverName": "string", "promisedShippingTime": "string" }, "buyer": { "marketPlaceId": "string", "name": "string", "email": "string", "document": "string", "documentType": "string", "phone": "string", "cellPhone": "string", "documentNumberNormalized": "string" }, "payments": [ { "method": "string", "status": "string", "value": 0, "installments": 0, "marketplaceId": "string", "gatewayFee": 0, "marketplaceFee": 0, "paymentMethodNormalized": "string", "paymentDetailNormalized": "string", "documentPaymentInstitution": "string", "cardOperator": "string", "orderAuthorizationCardCode": "string" } ], "items": [ { "product": { "id": 0, "title": "string" }, "sku": { "id": 0, "title": "string", "partnerId": "string", "externalId": "string", "ean": "string" }, "amount": 0, "unit": 0, "gross": 0, "total": 0, "discount": 0, "discountItemMetadata": [ { "type": "COUPON", "discountProductSeller": 5 } ], "shippings": [ { "id": 0, "shippingtype": "string", "shippingCarrierNormalized": "string", "shippingCarrierTypeNormalized": "string" } ], "stocks": [ { "stockLocalId": 0, "stockName": "string", "amount": 0 } ], "marketPlaceId": "string", "orderItemId": "string", "idInMarketPlace": "string", "officialStoreId": "string", "officialStoreName": "string", "listingType": "string", "freeShipping": true }, { "product": { "id": 1, "title": "string" }, "sku": { "id": 1, "title": "string", "partnerId": "string", "externalId": "string", "ean": "string" }, "amount": 0, "unit": 0, "gross": 0, "total": 0, "discount": 0, "discountItemMetadata": [ { "type": "FREE_ITEM", "discountProductMarketplace": 8 } ], "marketPlaceId": "string", "orderItemId": "string", "idInMarketPlace": "string", "officialStoreId": "string", "officialStoreName": "string", "listingType": "string", "freeShipping": true } ], "tracking": { "url": "string", "number": "string", "carrier": "string", "carrierDocument": "string", "date": "2019-08-24T14:15:22Z", "deliveredDate": "2019-08-24T14:15:22Z", "estimateDate": "2019-08-24T14:15:22Z", "shippedDate": "2019-08-24T14:15:22Z" }, "deliveryStatus": "UNKNOWN", "idAccount": 0, "pickup": { "id": 0, "description": "string", "partnerId": 0, "marketplaceId": "string", "receiverName": "string" }, "metadata": { "discountSummarized": 35.9, "number-of-packages": "1", "cdZipCode": "string", "needInvoiceXML": "true" }, "discountMetadata": [ { "type": [ "COUPON" ], "discountDetails": [ { "type": "COUPON", "discountOrderSeller": 10, "discountOrderMarketplace": 5.9 } ] } ] } }, "Page_Order": { "title": "Page_Order", "allOf": [ { "properties": { "links": { "type": "array", "description": "Referências de paginação", "uniqueItems": false, "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/PageLinks" } }, "content": { "type": "array", "description": "Lista de pedidos", "items": { "$ref": "#/components/schemas/Order" } }, "page": { "$ref": "#/components/schemas/PageMetadata" } } } ], "description": "", "type": "object", "example": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 0, "accountName": "string", "marketPlaceId": "string", "marketPlaceNumber": "string", "partnerId": "string", "marketPlace": "string", "subChannel": "string", "subChannelNormalized": "string", "createdAt": "2019-08-24T14:15:22Z", "paymentDate": "2019-08-24T14:15:22Z", "cancelDate": "2019-08-24T14:15:22Z", "shippingOptionId": "string", "transmissionStatus": "string", "status": "PENDING", "marketPlaceStatus": "string", "marketPlaceStatusComplement": "string", "documentIntermediator": "string", "intermediateRegistrationId": "string", "documentPaymentInstitution": "string", "fulfillment": true, "discount": 0, "freight": 0, "interestValue": 0, "gross": 0, "total": 0, "marketPlaceUrl": "string", "marketPlaceShipmentStatus": "string", "invoice": { "accessKey": "string", "series": "string", "number": "string", "date": "2019-08-24T14:15:22Z", "cfop": "string", "companyStateTaxId": "string", "linkNfe": "string", "invoiceLink": "string", "extraDescription": "string", "fiscalMetadata": { "operationType": "string", "emissionType": "string", "authorizationProtocol": "string" } }, "shipping": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "address": "string", "number": "string", "neighborhood": "string", "street": "string", "comment": "string", "reference": "string", "zipCode": "string", "receiverName": "string", "promisedShippingTime": "2019-08-24T14:15:22Z" }, "billingAddress": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "countryAcronymNormalized": "string", "countryNameNormalized": "string", "street": "string", "number": "string", "neighborhood": "string", "comment": "string", "reference": "string", "zipCode": "string" }, "anymarketAddress": { "state": "string", "city": "string", "zipCode": "string", "neighborhood": "string", "address": "string", "street": "string", "number": "string", "comment": "string", "reference": "string", "receiverName": "string", "promisedShippingTime": "string" }, "buyer": { "marketPlaceId": "string", "name": "string", "email": "string", "document": "string", "documentType": "string", "phone": "string", "cellPhone": "string", "documentNumberNormalized": "string" }, "payments": [ { "method": "string", "status": "string", "value": 0, "installments": 0, "marketplaceId": "string", "gatewayFee": 0, "marketplaceFee": 0, "paymentMethodNormalized": "string", "paymentDetailNormalized": "string", "documentPaymentInstitution": "string", "cardOperator": "string", "orderAuthorizationCardCode": "string" } ], "items": [ { "product": { "id": 0, "title": "string" }, "sku": { "id": 0, "title": "string", "partnerId": "string", "externalId": "string", "ean": "string" }, "amount": 0, "unit": 0, "gross": 0, "total": 0, "discount": 0, "discountItemMetadata": [ { "type": "COUPON", "discountProductSeller": 5 } ], "shippings": [ { "id": 0, "shippingtype": "string", "shippingCarrierNormalized": "string", "shippingCarrierTypeNormalized": "string" } ], "stocks": [ { "stockLocalId": 0, "stockName": "string", "amount": 0 } ], "marketPlaceId": "string", "orderItemId": "string", "idInMarketPlace": "string", "officialStoreId": "string", "officialStoreName": "string", "listingType": "string", "freeShipping": true }, { "product": { "id": 1, "title": "string" }, "sku": { "id": 1, "title": "string", "partnerId": "string", "externalId": "string", "ean": "string" }, "amount": 0, "unit": 0, "gross": 0, "total": 0, "discount": 0, "discountItemMetadata": [ { "type": "FREE_ITEM", "discountProductMarketplace": 8 } ], "marketPlaceId": "string", "orderItemId": "string", "idInMarketPlace": "string", "officialStoreId": "string", "officialStoreName": "string", "listingType": "string", "freeShipping": true } ], "tracking": { "url": "string", "number": "string", "carrier": "string", "carrierDocument": "string", "date": "2019-08-24T14:15:22Z", "deliveredDate": "2019-08-24T14:15:22Z", "estimateDate": "2019-08-24T14:15:22Z", "shippedDate": "2019-08-24T14:15:22Z" }, "deliverStatus": "UNKNOWN", "idAccount": 0, "pickup": { "id": 0, "description": "string", "partnerId": 0, "marketplaceId": "string", "receiverName": "string" }, "metadata": { "discountSummarized": "35.90", "number-of-packages": "1", "cdZipCode": "string", "needInvoiceXML": "true" }, "discountMetadata": [ { "type": [ "COUPON" ], "discountDetails": [ { "type": "COUPON", "discountOrderSeller": 10, "discountOrderMarketplace": 5.9 } ] } ] } ], "page": { "size": 5, "totalElements": 0, "totalPages": 1, "number": 1 } } }, "OrderShippingAddressPost": { "type": "object", "required": [ "city", "state", "address", "number", "neighborhood", "country", "street", "zipCode", "receiverName" ], "properties": { "city": { "type": "string", "description": "Cidade", "maxLength": 255 }, "state": { "type": "string", "description": "Estado", "maxLength": 255 }, "stateNameNormalized": { "type": "string", "description": "Nome do Estado padronizado internamente pelo ANYMARKET. Pode ser nulo se o state for nulo ou UNKNOWN para desconhecido.", "maxLength": 100 }, "address": { "type": "string", "description": "Endereço", "maxLength": 500 }, "number": { "type": "string", "description": "Número", "maxLength": 100 }, "neighborhood": { "type": "string", "description": "Bairro", "maxLength": 255 }, "country": { "type": "string", "description": "País", "maxLength": 255 }, "street": { "type": "string", "description": "Rua", "maxLength": 255 }, "comment": { "type": "string", "description": "Complemento", "maxLength": 500 }, "reference": { "type": "string", "description": "Referência", "maxLength": 255 }, "zipCode": { "type": "string", "description": "CEP", "maxLength": 255 }, "receiverName": { "type": "string", "description": "Nome do remetente para entrega", "maxLength": 255 }, "promisedShippingTime": { "type": "string", "description": "Data acordada para entrega", "example": "2024-09-17T03:00:00Z" }, "promisedDispatchTime": { "type": "string", "description": "Data prevista de coleta", "example": "2024-09-17T03:00:00Z" } } }, "OrderBillingAddressPost": { "type": "object", "required": [ "city", "state", "street", "number", "neighborhood", "zipCode" ], "properties": { "city": { "type": "string", "description": "Cidade", "maxLength": 255 }, "state": { "type": "string", "description": "Estado", "maxLength": 255 }, "stateNameNormalized": { "type": "string", "description": "Nome do Estado padronizado internamente pelo ANYMARKET. Pode ser nulo se o state for nulo ou UNKNOWN para desconhecido.", "maxLength": 100 }, "country": { "type": "string", "description": "País", "maxLength": 255 }, "street": { "type": "string", "description": "Rua", "maxLength": 255 }, "number": { "type": "string", "description": "Número", "maxLength": 100 }, "neighborhood": { "type": "string", "description": "Bairro", "maxLength": 255 }, "comment": { "type": "string", "description": "Complemento", "maxLength": 500 }, "reference": { "type": "string", "description": "Referência", "maxLength": 255 }, "zipCode": { "type": "string", "description": "CEP", "maxLength": 255 } } }, "BuyerPost": { "type": "object", "required": [ "name", "documentType", "document", "email", "phone" ], "properties": { "marketPlaceId": { "type": "string", "description": "ID no marketplace. Essa informação pode não existir para algum marketplace ou ecommerce." }, "name": { "type": "string", "description": "Nome do comprador", "maxLength": 255 }, "documentType": { "type": "string", "description": "Tipo do documento. Valores possíveis: CPF, CNPJ, OTHER\n" }, "document": { "type": "string", "description": "Número do documento. Essa informação pode não ser preenchida para algum marketplace ou ecommerce." }, "email": { "type": "string", "description": "E-mail do comprador", "maxLength": 255 }, "dateOfBirth": { "type": "string", "description": "Data de nascimento do comprador", "format": "date-time" }, "phone": { "type": "string", "description": "Telefone do comprador", "maxLength": 30 }, "cellPhone": { "type": "string", "description": "Celular do comprador", "maxLength": 30 }, "documentNumberNormalized": { "type": "string", "description": "Número do documento normalizado pelo ANYMARKET. Somente números. Caso o document não seja um CPF ou CNPJ este campo irá retornar nulo." }, "companyStateTaxId": { "type": "string", "description": "Inscrição Estadual do comprador." } }, "description": "" }, "OrderPaymentPost": { "type": "object", "properties": { "method": { "type": "string", "description": "Método de pagamento" }, "status": { "type": "string", "description": "Status do pagamento enviado pelo marketplace" }, "value": { "type": "number", "description": "Valor do pagamento (Em caso de cobrança de juros, o valor é adicionado ao total da compra. Ex: Mercado livre)\n", "format": "double" }, "installments": { "type": "number", "description": "Número de parcelas do meio do pagamento. Deve-se dividir o número de parcelas pelo valor para encontrar o valor de cada parcela.", "format": "int64" }, "marketplaceId": { "type": "string", "description": "ID do pagamento enviado pelo marketplace. Alguns marketplaces não disponibilizam o id, podendo o valor estar nulo ou com um valor fixo \"1\" dependendo da regra. (Exemplo- Cnova sempre tem apenas um pagamento para a compra, então o id do pagamento pode ser sempre \"1\")" }, "gatewayFee": { "type": "number", "description": "Taxa referente ao gateway de pagamento (Ex: MercadoPago).\n", "format": "double" }, "marketplaceFee": { "type": "number", "description": "Taxa referente ao Marketplace.\n", "format": "double" }, "paymentMethodNormalized": { "type": "string", "description": "Método de pagamento padronizado internamente pelo ANYMARKET. Caso for um valor desconhecido internamente irá retornar UNKNOWN. Se o method for nulo, este campo também será nulo." }, "paymentDetailNormalized": { "type": "string", "description": "Detalhamento do método de pagamento padronizado internamente pelo ANYMARKET. Caso for um valor desconhecido internamente irá retornar UNKNOWN. Se o method for nulo, este campo também será nulo." }, "documentPaymentInstitution": { "type": "string", "description": "Identificação através do CNPJ do responsavel pela transação de pagamento com cartão. tag card/CNPJ." }, "cardOperator": { "type": "string", "description": "Código da bandeira da operadora de cartão de crédito e/ou débito. Conforme publicada no Portal Nacional da Nota Fiscal Eletrônica. tag card/tBand" }, "orderAuthorizationCardCode": { "type": "string", "description": "Número de autorização da operação cartão de crédito e/ou débito. tag card/cAuth" } }, "required": [ "method", "value", "installments" ] }, "OrderItemShippingPost": { "type": "object", "required": [ "id", "shippingtype" ], "properties": { "shippingtype": { "type": "string", "description": "Forma de envio selecionado pelo cliente" }, "shippingCarrierNormalized": { "type": "string", "description": "Nome da transportadora padronizado internamente pelo ANYMARKET. Caso for um valor desconhecido internamente irá retornar UNKNOWN. Se o shippingType for nulo, este campo também será nulo." }, "shippingCarrierTypeNormalized": { "type": "string", "description": "Serviço da transportadora padronizado internamente pelo ANYMARKET. Caso for um valor desconhecido internamente irá retornar UNKNOWN. Se o shippingType for nulo, este campo também será nulo." } } }, "OrderShippingItemPost": { "type": "object", "required": [ "sku", "product", "amount", "unit", "gross", "total" ], "properties": { "sku": { "description": "Informações da SKU", "type": "object", "properties": { "title": { "type": "string", "description": "Titulo da SKU no MarketPlace" }, "partnerId": { "type": "string", "description": "Código do SKU no parceiro" } } }, "product": { "description": "Informações do produto", "type": "object", "properties": { "title": { "type": "string", "description": "Titulo da SKU no MarketPlace" } } }, "amount": { "type": "integer", "description": "Quantidade do item" }, "unit": { "type": "number", "description": "Unidade de medida", "format": "double" }, "discount": { "type": "number", "description": "Desconto do item", "format": "double" }, "discountItemMetadata": { "type": "array", "description": "Indica a origem do desconto aplicado ao item (seller ou marketplace). Cada campo de origem deve ser omitido quando não informado.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "**COUPON**: indica que o item possui desconto do tipo Cupom no Mercado Livre.
\n**FREE_ITEM**: indica que o item possui 100% de desconto e é do tipo Amostra grátis.", "enum": [ "FREE_ITEM", "COUPON" ] }, "discountProductSeller": { "type": "number", "format": "double", "description": "Valor do desconto do item concedido pelo seller. Omitido quando não informado pelo canal." }, "discountProductMarketplace": { "type": "number", "format": "double", "description": "Valor do desconto do item concedido pelo marketplace. Omitido quando não informado pelo canal." } } } }, "gross": { "type": "number", "description": "Valor bruto com desconto", "format": "double" }, "total": { "type": "number", "description": "Total do item sem desconto", "format": "double" }, "marketPlaceId": { "type": "string", "description": "ID do item no marketplace / plataforma de e-commerce (Caso não informado, será o mesmo do sku)" }, "shippings": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemShippingPost" } } } }, "PostOrder": { "type": "object", "required": [ "marketPlaceId", "marketPlaceNumber", "marketPlace", "createdAt", "transmissionStatus", "status", "marketPlaceStatus", "total", "buyer", "items" ], "properties": { "marketPlaceId": { "type": "string", "description": "ID do pedido no marketplace", "minLength": 0, "maxLength": 255 }, "marketPlaceNumber": { "type": "string", "description": "ID público do pedido no marketplace", "maxLength": 255 }, "marketPlace": { "$ref": "#/components/schemas/EnumMarketplaces" }, "accountName": { "type": "string", "description": "Identificador da conta do Marketplace", "maxLength": 255 }, "partnerId": { "type": "string", "description": "Código do pedido no parceiro. Uma vez informado, não poderá ser alterado", "maxLength": 100 }, "idAccount": { "description": "ID da conta gerado automático pelo ANYMARKET", "type": "number" }, "fulfillment": { "type": "boolean", "description": "Identifica se o pedido é fulfillment" }, "createdAt": { "type": "string", "description": "Data de criação do pedido", "format": "date-time" }, "paymentDate": { "type": "string", "description": "Data de pagamento do pedido", "format": "date-time" }, "transmissionStatus": { "type": "string", "description": "Status da transmissão

\n\n **OK**: Pedido sincronizado com sucesso com o Marketplace
\n **ERROR**: Ocorreu erro na sincronização com o Marketplace
\n **WAITING**: Aguardando sincronização com o Marketplace
\n", "enum": [ "OK", "ERROR", "WAITING" ] }, "status": { "type": "string", "description": "Status do pedido

\n\n **INVOICED**: Faturado. Mudando para essa situação é necessário informar: número da nota, número de série, data de emissão e chave de acesso
\n **PAID_WAITING_DELIVERY**: Enviado (aguardando entrega). Mudando para essa situação é necessário informar: URL de rastreamento, número de rastreio, nome da transportadora, data de envio
\n **PAID_WAITING_SHIP**: Pago (está aguardando envio)
\n **PENDING**: Pendente (Ainda não foi pago. Existe parâmetro para que o ANYMARKET importe do MarketPlace o pedido que ainda não foi pago)
\n", "enum": [ "PENDING", "PAID_WAITING_SHIP", "INVOICED", "PAID_WAITING_DELIVERY", "CONCLUDED", "CANCELED" ] }, "marketPlaceStatus": { "type": "string", "description": "Situação do pedido no marketplace. Cada marketplace possui situações diferentes. Ex: no mercado livre não existe a situação faturado\n", "maxLength": 255 }, "marketPlaceStatusComplement": { "type": "string", "description": "Informação complementar à situação do pedido no marketplace. Cada marketplace possui situações diferentes. Ex: na Dafiti o pedido pode ser marcado como falha de entrega e a causa pode ser armazenada nesse atributo\n", "maxLength": 1000 }, "documentIntermediator": { "type": "string", "description": "Identificador de intermediador da Transação CNPJ", "maxLength": 14 }, "intermediateRegistrationId": { "type": "string", "description": "Identificador do cadastro (vendedor ou usuário) no intermediador", "maxLength": 60 }, "documentPaymentInstitution": { "type": "string", "description": "Identificador de Instituição de pagamento CNPJ", "maxLength": 14 }, "discount": { "type": "number", "description": "Desconto do pedido", "format": "double" }, "freight": { "type": "number", "description": "Valor de frete", "format": "double" }, "sellerFreight": { "type": "number", "description": "Custo de Frete do Seller", "format": "double" }, "interestValue": { "type": "number", "description": "Valor dos juros", "format": "double" }, "gross": { "type": "number", "description": "Total bruto sem o valor de frete", "format": "double" }, "total": { "type": "number", "description": "Total do pedido com o valor de frete", "format": "double" }, "marketPlaceUrl": { "type": "string", "description": "URL do pedido no marketplace", "format": "uri" }, "marketPlaceShipmentStatus": { "type": "string", "description": "Situação de envio do pedido no marketplace. Cada marketplace possui situações diferentes", "maxLength": 255 }, "shipping": { "$ref": "#/components/schemas/OrderShippingAddressPost" }, "billingAddress": { "$ref": "#/components/schemas/OrderBillingAddressPost" }, "buyer": { "$ref": "#/components/schemas/BuyerPost" }, "payments": { "description": "Dados referente a pagamento (Será enviado pelo Marketplace)", "type": "array", "items": { "$ref": "#/components/schemas/OrderPaymentPost" } }, "items": { "description": "Dados referente aos produtos comprados", "type": "array", "items": { "$ref": "#/components/schemas/OrderShippingItemPost" } }, "deliverStatus": { "type": "string", "description": "Status do pedido

\n\n **UNKNOWN**: Envio pendente
\n **SHIPPED**: Pedido Enviado
\n **CONCLUDED**: Pedido entregue
\n", "enum": [ "UNKNOWN", "SHIPPED", "CONCLUDED" ] }, "metadata": { "$ref": "#/components/schemas/OrderMetadata" }, "discountMetadata": { "type": "array", "description": "Indica o valor do desconto quando informado pelo canal de venda.", "items": { "$ref": "#/components/schemas/DiscountMetadata" } } }, "example": { "marketPlaceId": "string", "marketPlaceNumber": "string", "marketPlace": "B2W", "accountName": "string", "partnerId": "string", "idAccount": 0, "fulfillment": true, "createdAt": "2019-08-24T14:15:22Z", "paymentDate": "2019-08-24T14:15:22Z", "transmissionStatus": "OK", "status": "PENDING", "marketPlaceStatus": "string", "marketPlaceStatusComplement": "string", "documentIntermediator": "string", "intermediateRegistrationId": "string", "documentPaymentInstitution": "string", "discount": 0, "freight": 0, "interestValue": 0, "gross": 0, "total": 0, "marketPlaceUrl": "http://example.com", "marketPlaceShipmentStatus": "string", "shipping": { "city": "string", "state": "string", "stateNameNormalized": "string", "address": "string", "number": "string", "neighborhood": "string", "country": "string", "street": "string", "comment": "string", "reference": "string", "zipCode": "string", "receiverName": "string", "promisedShippingTime": "2019-08-24T14:15:22Z" }, "billingAddress": { "city": "string", "state": "string", "stateNameNormalized": "string", "country": "string", "street": "string", "number": "string", "neighborhood": "string", "comment": "string", "reference": "string", "zipCode": "string" }, "anymarketAddress": { "state": "string", "city": "string", "zipCode": "string", "neighborhood": "string", "address": "string", "street": "string", "number": "string", "comment": "string", "reference": "string", "receiverName": "string", "promisedShippingTime": "string" }, "buyer": { "marketPlaceId": "string", "name": "string", "documentType": "string", "document": "string", "email": "string", "phone": "string", "cellPhone": "string", "documentNumberNormalized": "string" }, "payments": [ { "method": "string", "status": "string", "value": 0, "installments": 0, "marketplaceId": "string", "gatewayFee": 0, "marketplaceFee": 0, "paymentMethodNormalized": "string", "paymentDetailNormalized": "string", "documentPaymentInstitution": "string", "cardOperator": "string", "orderAuthorizationCardCode": "string" } ], "items": [ { "sku": { "title": "string", "partnerId": "string" }, "product": { "title": "string" }, "amount": 0, "unit": 0, "discount": 0, "discountItemMetadata": [ { "type": "COUPON", "discountProductSeller": 5 } ], "gross": 0, "total": 0, "marketPlaceId": "string", "shippings": [ { "shippingtype": "string", "shippingCarrierNormalized": "string", "shippingCarrierTypeNormalized": "string" } ] }, { "sku": { "title": "string", "partnerId": "string" }, "product": { "title": "string" }, "amount": 0, "unit": 0, "discount": 0, "discountItemMetadata": [ { "type": "FREE_ITEM", "discountProductMarketplace": 8 } ], "gross": 0, "total": 0, "marketPlaceId": "string" } ], "deliverStatus": "UNKNOWN", "metadata": { "number-of-packages": "1", "cdZipCode": "string", "needInvoiceXML": "true" }, "discountMetadata": [ { "type": [ "COUPON" ], "discountDetails": [ { "type": "COUPON", "discountOrderSeller": 10, "discountOrderMarketplace": 5.9 } ] } ] } }, "OrderQuoteId": { "type": "object", "title": "OrderQuoteId", "properties": { "quoteId": { "type": "string" }, "price": { "type": "number", "example": 1.23, "format": "double" } }, "example": { "quoteId": "1234567890", "price": 1.23 } }, "OrderUpdatePaid": { "title": "Pago", "type": "object", "properties": { "status": { "type": "string", "description": "Status do pedido

\n **PAID_WAITING_SHIP**: : Pago (está aguardando envio)\n", "enum": [ "PAID_WAITING_SHIP" ] }, "discountMetadata": { "type": "array", "description": "Indica o valor do desconto quando informado pelo canal de venda. Não obrigatório para esta transição de status; campos omitidos não alteram o valor já persistido no pedido.", "items": { "$ref": "#/components/schemas/DiscountMetadata" } }, "items": { "type": "array", "description": "Lista de itens do pedido para atualizar o detalhamento do desconto por origem (seller ou marketplace). Itens/campos omitidos mantêm o valor atual", "items": { "type": "object", "required": [ "orderItemId" ], "properties": { "orderItemId": { "type": "number", "format": "int64", "description": "Id do item no pedido gerado pelo ANYMARKET" }, "discountItemMetadata": { "type": "array", "description": "Indica a origem do desconto aplicado ao item (seller ou marketplace), quando informada pelo canal de venda. Cada campo de origem é omitido quando não informado.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "**COUPON**: indica que o item possui desconto do tipo Cupom no Mercado Livre.
\n**FREE_ITEM**: indica que o item possui 100% de desconto e é do tipo Amostra grátis.", "enum": [ "FREE_ITEM", "COUPON" ] }, "discountProductSeller": { "type": "number", "format": "double", "description": "Valor do desconto do item concedido pelo seller. Omitido quando não informado pelo canal." }, "discountProductMarketplace": { "type": "number", "format": "double", "description": "Valor do desconto do item concedido pelo marketplace. Omitido quando não informado pelo canal." } } } } } } } }, "required": [ "status" ], "example": { "status": "PAID_WAITING_SHIP", "discountMetadata": [ { "type": [ "COUPON" ], "discountDetails": [ { "type": "COUPON", "discountOrderSeller": 10, "discountOrderMarketplace": 5.9 } ] } ], "items": [ { "orderItemId": 0, "discountItemMetadata": [ { "type": "COUPON", "discountProductSeller": 5 } ] }, { "orderItemId": 1, "discountItemMetadata": [ { "type": "FREE_ITEM", "discountProductMarketplace": 8 } ] } ] } }, "OrderUpdateMetadata": { "type": "object", "description": "Campos adicionais do pedido.", "properties": { "number-of-packages": { "type": "string", "default": "1", "description": "Quantidade de volumes para a impressão de etiqueta" }, "cdZipCode": { "type": "string", "description": "CEP do Centro de Distribuição referente ao CNPJ de faturamento do pedido" } }, "title": "Campos adicionais do pedido." }, "OrderUpdateInvoiced": { "title": "Faturado", "type": "object", "properties": { "status": { "type": "string", "description": "Status do pedido

\n **INVOICED**: Faturado. Mudando para essa situação é necessário informar: número da nota, número de série, data de emissão e chave de acesso\n", "enum": [ "INVOICED" ] }, "invoice": { "type": "object", "required": [ "date" ], "properties": { "accessKey": { "type": "string", "description": "Chave de acesso da nota fiscal" }, "series": { "type": "string", "description": "Número de série da nota fiscal" }, "number": { "type": "string", "description": "Número da nota fiscal" }, "date": { "type": "string", "description": "Data de emissão da nota fiscal (Necessário informar o fuso horario)", "format": "date-time", "example": "2018-03-08T10:00:00-03:00" }, "cfop": { "type": "string", "description": "Código Fiscal de Operações e Prestações, esse campo será obrigátorio caso seja utilizado 'Mercado Envio Coleta'" }, "companyStateTaxId": { "type": "string", "description": "Inscrição Estadual quando o comprador é uma Pessoa Jurídica (CNPJ), esse campo será obrigátorio caso seja utilizado 'Mercado Envios Coleta'; é possível utilizar 'ISENTO'" }, "linkNfe": { "type": "string", "description": "Campo para inserir a URL para consulta da nota fiscal" }, "invoiceLink": { "type": "string", "description": "Campo para inserir a URL onde está armazenada o PDF ou o XML da nota fiscal (utilizado para a integração da Garbarino)" }, "extraDescription": { "type": "string", "description": "Campo para observações" }, "fiscalMetadata": { "$ref": "#/components/schemas/FiscalDocumentMetadata" } } }, "metadata": { "$ref": "#/components/schemas/OrderUpdateMetadata" } }, "required": [ "status", "invoice" ] }, "OrderUpdateDelivery": { "title": "Enviado", "type": "object", "properties": { "status": { "type": "string", "description": "Status do pedido

\n **PAID_WAITING_DELIVERY**: : Enviado (aguardando entrega). Mudando para essa situação é necessário informar: URL de rastreamento, número de rastreio, nome da transportadora e data de envio
\n", "enum": [ "PAID_WAITING_DELIVERY" ], "default": "PAID_WAITING_DELIVERY" }, "tracking": { "type": "object", "required": [ "number", "carrier", "shippedDate" ], "properties": { "url": { "type": "string", "description": "URL para o rastreamento" }, "number": { "type": "string", "description": "Número de rastreio" }, "carrier": { "type": "string", "description": "Nome da transportadora" }, "carrierDocument": { "type": "string", "description": "CNPJ da transportadora" }, "estimateDate": { "type": "string", "description": "Data estimada (Necessário informar o fuso horario)", "format": "date-time", "example": "2018-03-08T10:00:00-03:00" }, "shippedDate": { "type": "string", "description": "Data em que foi entregue a transportadora (Necessário informar o fuso horario)", "format": "date-time", "example": "2018-03-08T10:00:00-03:00" } } } }, "required": [ "status", "tracking" ] }, "OrderTrackingConcluded": { "required": [ "deliveredDate" ], "type": "object", "properties": { "deliveredDate": { "type": "string", "description": "Data de entrega ao Cliente (Necessário informar o fuso horario)", "format": "date-time" } } }, "OrderUpdateConcluded": { "title": "Concluído", "type": "object", "properties": { "status": { "type": "string", "description": "Status do pedido

\n **CONCLUDED**: Pedido entregue (é a última situação do pedido). Mudando para essa situação é necessário informar: data de entrega
\n", "enum": [ "CONCLUDED" ] }, "tracking": { "$ref": "#/components/schemas/OrderTrackingConcluded" } }, "required": [ "status", "tracking" ], "example": { "status": "CONCLUDED", "tracking": { "deliveredDate": "2019-08-24T14:15:22-03:00" } } }, "OrderUpdateCanceled": { "title": "Cancelado", "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "description": "Status do pedido

\n **CANCELED**: Pedido Cancelado\n", "enum": [ "CANCELED" ] }, "cancelDetails": { "type": "string", "description": "Detalhes do cancelamento, obrigatório para os Marketplaces:

\n GFG - Dafiti\n" }, "cancellationCode": { "type": "string", "description": "Razão de cancelamento.\n\nOs motivos disponíveis para vendedores MERCADO LIVRE são:\n- OUT_OF_STOCK: Sem estoque\n- BUYER_NOT_ENOUGH_MONEY: Comprador não tem dinheiro suficiente\n- BUYER_REGRETS: Comprador se arrependeu da operação\n- SELLER_REGRETS: Vendedor se arrependeu da operação\n- BUYER_DID_NOT_ANSWER: Comprador não responde\n- THEY_NOT_HONORING_POLICIES: Comprador não está atendendo às políticas\n- OTHER_MY_RESPONSIBILITY: Responsabilidade própria (outro motivo)\n- OTHER_THEIR_RESPONSIBILITY: Responsabilidade da contraparte (outro motivo)\n- DUBIOUS_BUYER: Comprador não confiável\n- HIGH_ML_COMISSION: Comissão de venda muito alta\n- HIGH_TAXES: Taxas muito altas\n- SELLER_HOLIDAY: Não há operação por férias\n- UNFRIENDLY_SHIPMENT_POLICY: Comprador não aceita política de envio\n- UNAVAILABLE_PRODUCT: Produto não disponível\n- SELLER_ADDRESS_WITHDRAWAL: Comprador prefere retirar pessoalmente\n- WRONG_RECEIVER_ADDRESS: Endereço de entrega errado\n- HIGH_SHIPMENT_COST: Custos de envio muito altos\n- WRONG_SHIPMENT_COST: Custo de envio mal calculado\n- UNPRINTED_LABEL: Etiqueta não pode ser impressa\n- UNWITHDRAWN_PRODUCT_BY_DELIVER_COMPANY: Empresa de envio não retirou o produto para entrega\n- DENIED_PACKAGE: Empresa de envio não aceita o pacote por causa do tamanho ou peso\n- UNABLE_TO_READ_LABEL: Empresa de envio não consegue ler a etiqueta\n- MANUFACTURING_PRODUCT_NOT_FINISHED: Produto manufaturado sem acabar\n- SHIPMENT_PROBLEM_OTHER: Envio teve algum outro problema\n- DELIVERY_COMPANY_PROBLEM_OTHER: Empresa de envio teve outro problema", "example": "OUT_OF_STOCK" } } }, "EnumTypeFulfillment": { "type": "string", "title": "", "enum": [ "sale", "sale_return", "sale_devolution", "gift", "inbound", "devolution", "inbound_devolution", "inbound_return", "inbound_supplier_return", "symbolic_inbound", "symbolic_inbound_return", "purchase", "removal", "symbolic_removal" ], "description": "Tipo do documento fulfillment.
\n**sale**: venda de mercadorias.
\n**sale_return**: retorno de mercadoria nao entregue.
\n**sale_devolution**: nota fiscal de devolução.
\n**inbound**: nota fiscal de entrada.
\n**inbound_devolution**: devolução entrada.
\n**inbound_return**: retorno de entrada.
\n**inbound_supplier_return**: nota de devolução ao fornecedor. Quando o fornecedor nos enviou uma nota errada essa anota ajuda devolvendo items a mais.
\n**symbolic_inbound**: retornos simbólicos.
\n**symbolic_inbound_return**: retornos simbólicos.
\n**symbolic_removal**: notas de retirada.
\n**removal**: notas de retirada.
\n", "readOnly": true, "example": [ { "id": 123456, "name": "Brastemp", "reducedName": "brastemp", "partnerId": "marca-001-brastemp" } ] }, "XmlFulfillment": { "type": "object", "required": [ "type", "url" ], "properties": { "type": { "$ref": "#/components/schemas/EnumTypeFulfillment" }, "url": { "type": "string", "format": "uri" } } }, "Answers": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da resposta gerado pelo ANYMARKET", "format": "int64", "minimum": 0 }, "answer": { "type": "string", "description": "Resposta", "maxLength": 2000 } }, "required": [ "answer" ] }, "Questions": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da pergunta gerado pelo ANYMARKET", "format": "int64" }, "questionerName": { "type": "string", "description": "Nome do questionador" }, "context": { "type": "string", "description": "ID da Transmissão concatenado com o nome do Produto" }, "question": { "type": "string", "description": "Pergunta" }, "answers": { "type": "array", "description": "Respostas", "items": { "$ref": "#/components/schemas/Answers" } }, "questionDate": { "type": "string", "description": "Data da Pergunta", "format": "date-time" } }, "required": [ "id", "questionerName", "context", "question", "answers", "questionDate" ], "example": { "id": 0, "questionerName": "string", "context": "string", "question": "string", "answers": [ { "id": 0, "answer": "string" } ], "questionDate": "2019-08-24T14:15:22Z" } }, "Page_Questions": { "title": "Page_Order", "allOf": [ { "properties": { "links": { "type": "array", "description": "Referências de paginação", "uniqueItems": false, "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/PageLinks" } }, "content": { "type": "array", "description": "Lista de pedidos", "items": { "$ref": "#/components/schemas/Questions" } }, "page": { "$ref": "#/components/schemas/PageMetadata" } } } ], "description": "", "type": "object" }, "Page_Answers": { "title": "Page_Order", "allOf": [ { "properties": { "links": { "type": "array", "description": "Referências de paginação", "uniqueItems": false, "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/PageLinks" } }, "content": { "type": "array", "description": "Lista de pedidos", "items": { "$ref": "#/components/schemas/Answers" } }, "page": { "$ref": "#/components/schemas/PageMetadata" } } } ], "description": "", "type": "object" }, "Brand": { "title": "Brand", "allOf": [ { "properties": { "id": { "type": "integer", "format": "int64", "minimum": 0, "description": "ID da marca" }, "name": { "type": "string", "description": "Nome da marca", "minLength": 1, "maxLength": 120 }, "reducedName": { "type": "string", "description": "Nome reduzido da marca", "minLength": 0, "maxLength": 30 }, "partnerId": { "type": "string", "minLength": 0, "maxLength": 255, "description": "ID da marca no parceiro" } }, "required": [ "name" ] } ], "description": "Brand", "type": "object" }, "Nbm": { "type": "object", "properties": { "id": { "type": "string", "description": "ID do NBM" }, "description": { "type": "string", "description": "Descrição do NBM" } }, "required": [ "id" ] }, "Origin": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da origem. Os valores vão de 0 a 7, conforme tabela abaixo:

\n\n **0**: Nacional
\n **1**: Estrangeira - Importação direta
\n **2**: Estrangeira - Adquirida no mercado interno
\n **3**: Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%
\n **4**: Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes
\n **5**: Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%
\n **6**: Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX
\n **7**: Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX
\n", "format": "int64" }, "description": { "type": "string", "description": "Descrição da origem" } }, "required": [ "id" ] }, "ProductCharacteristic": { "type": "object", "properties": { "index": { "type": "integer", "description": "Index da característica", "format": "int64" }, "name": { "type": "string", "description": "Nome da característica", "maxLength": 255 }, "value": { "type": "string", "description": "Valor da característica", "maxLength": 255 } }, "required": [ "name", "value" ] }, "AdditionalStocks": { "type": "object", "properties": { "price": { "type": "number", "description": "Preço do SKU", "format": "double" }, "amount": { "type": "number", "description": "Quantidade de stock do SKU", "minimum": 0 }, "additionalTime": { "type": "number", "description": "Prazo Adicional para entrega. Tambem chamado de 'crossdocking' este é o prazo de preparo de cada produto para envio. Utilizado em marketplaces como B2W e CNOVA. Caso não seja informado será atribuído o valor default 0.", "minimum": 0 }, "stockLocalId": { "type": "number", "description": "Código do local do estoque, caso este campo esteja vazio, é adicionado ao local padrão cadastrado no sistema.", "format": "long", "minimum": 0 } }, "required": [ "price", "amount", "additionalTime", "stockLocalId" ] }, "Sku": { "type": "object", "properties": { "id": { "type": "integer", "description": "SKU ID generated by ANYMARKET", "format": "int64" }, "title": { "type": "string", "description": "Título do SKU", "maxLength": 150 }, "partnerId": { "type": "string", "description": "SKU do parceiro. O código desse SKU será enviado para a maioria dos marketplaces e será utilizado como vínculo entre o ANYMARKET e o marketplace", "maxLength": 120 }, "ean": { "type": "string", "description": "Código de barras do SKU", "maxLength": 13 }, "amount": { "type": "number", "description": "Quantidade de estoque do SKU", "minimum": 0 }, "additionalTime": { "type": "number", "description": "Prazo Adicional para entrega do produto. Também chamado de 'crossdocking' este é o prazo de preparo de cada produto para envio, seja de fabricação, aquisição, embalagem ou redirecionamento de local. Utilizado em marketplaces como B2W e CNOVA.", "minimum": 0 }, "price": { "type": "number", "description": "Preço do SKU", "format": "double" }, "sellPrice": { "type": "number", "description": "Preço por do SKU (utilizado quando o definitionPriceScope for igual a SKU)", "format": "double" }, "stockLocalId": { "type": "number", "description": "Código do local do estoque, caso este campo esteja vazio, é adicionado ao local padrão cadastrado no sistema.", "minimum": 0 }, "variations": { "type": "object", "description": "Valores de variação", "properties": { "{variationTypeName}": { "type": "string", "description": "Ex: \"Cor\": \"Laranja\"" } } }, "additionalStocks": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalStocks" } }, "externalId": { "type": "string", "description": "ID externo, utilizado em alguns marketplaces para controle interno destes.", "maxLength": 100 }, "active": { "type": "boolean", "description": "Define se o SKU está ativo ou inativo" }, "volumes": { "type": "number", "description": "Quatidade de volumes do SKU.", "minimum": 0, "default": 0 } }, "required": [ "title", "partnerId", "amount", "additionalTime", "price", "sellPrice" ] }, "Product": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID do produto gerado pelo ANYMARKET", "format": "int64" }, "title": { "type": "string", "description": "Título do produto", "maxLength": 150 }, "description": { "type": "string", "description": "Descrição do produto", "maxLength": 10000 }, "externalIdProduct": { "type": "string", "description": "ID externo do produto ", "maxLength": 10000 }, "category": { "description": "Categoria do produto. Posteriormente o cliente realizará o vinculo da categoria enviada com a categoria de cada marketplace", "type": "object", "required": [ "id", "name", "path" ], "properties": { "id": { "type": "number", "description": "ID da categoria gerado pelo ANYMARKET" }, "name": { "type": "string", "description": "Nome da Categoria" }, "path": { "type": "string", "description": "Árvore de categorias até a categoria atual" } } }, "brand": { "$ref": "#/components/schemas/Brand" }, "nbm": { "$ref": "#/components/schemas/Nbm" }, "origin": { "$ref": "#/components/schemas/Origin" }, "model": { "type": "string", "description": "Modelo do produto" }, "videoUrl": { "type": "string", "description": "URL do video do Youtube", "maxLength": 255 }, "gender": { "type": "string", "description": "Gênero do produto. Os valores são MALE, FEMALE, BOY, GIRL e UNISSEX", "enum": [ "MALE", "FEMALE", "BOY", "GIRL", "UNISSEX", "BABIES", "CHILDISH_UNISSEX" ] }, "warrantyTime": { "type": "integer", "description": "Tempo da garantia", "format": "int32" }, "warrantyText": { "type": "string", "description": "Texto sobre a garantia" }, "height": { "type": "number", "description": "Altura da embalagem do produto (em centímetros)", "format": "double" }, "width": { "type": "number", "description": "Largura da embalagem do produto (em centímetros)", "format": "double" }, "weight": { "type": "number", "description": "Peso da embalagem do produto (em quilos)", "format": "double" }, "length": { "type": "number", "description": "Profundidade da embalagem do produto (em centímetros)", "format": "double" }, "priceFactor": { "type": "number", "description": "Fator de preço do produto. É utilizado como um Multiplicador para o preço de custo do produto. Corresponde ao campo Markup na tela do sistema", "format": "double" }, "calculatedPrice": { "type": "boolean", "description": "Identifica se o produto terá o preço calculado baseado no markup" }, "definitionPriceScope": { "type": "string", "description": "Suporte aos tipos SKU (Manual, eu controlo o preço pelo SKU), SKU_MARKETPLACE (Manual, eu controlo o preço pelo anúncio) ou COST (Automático, pela mudança do custo)" }, "hasVariations": { "type": "boolean", "description": "Informa se o produt possui variações" }, "isProductActive": { "type": "boolean", "description": "Informa se o produto está Ativo/Inativo" }, "type": { "type": "string", "description": "Product type. Accepted values: SIMPLE (simple product), VARIATION (with variations), KIT (kit without variations), KIT_VARIATION (kit with variations). Optional; when omitted, it remains null.", "enum": [ "SIMPLE", "VARIATION", "KIT", "KIT_VARIATION" ] }, "characteristics": { "type": "array", "description": "Define caracteristicas variaveis e específicas de cada produto. Por exemplo, no caso de uma raquete de tênis, a tensão da rede pode ser adicionada como caracteristica adicional.\n", "items": { "$ref": "#/components/schemas/ProductCharacteristic" } }, "images": { "type": "array", "description": "Arrays das imagens. Os índices se informados serão mantidos, caso alguma imagem não tenha o índice informado o ANYMARKET irá preencher de forma sequencial e sem repetição. Caso nenhuma imagem seja marcada como main o ANYMARKET irá marcar a imagem de índice 1 como main", "items": { "$ref": "#/components/schemas/Image" } }, "skus": { "type": "array", "items": { "$ref": "#/components/schemas/Sku" } }, "kitComponents": { "type": "object", "properties": { "idSku": { "type": "string", "description": "ID do SKU do componente" }, "stockLocalId": { "type": "string", "description": "ID do Local do Estoque" }, "percentage": { "type": "number", "description": "Porcentagem que o componente representa no KIT" }, "quantity": { "type": "number", "description": "Quantidade do Componente no KIT" }, "isMainComponent": { "type": "boolean", "description": "Informa se é o componente principal do KIT" } } }, "allowAutomaticSkuMarketplaceCreation": { "type": "boolean", "description": "Permite a criação de anúncios automáticos baseado na configuração existente na categoria (Valor padrão do campo é true)." } }, "required": [ "id", "title", "description", "category", "origin", "model", "warrantyTime", "height", "width", "weight", "length", "priceFactor", "calculatedPrice", "definitionPriceScope", "hasVariations", "images", "skus", "allowAutomaticSkuMarketplaceCreation" ], "example": { "id": -9223372036854776000, "title": "string", "description": "string", "externalIdProduct": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 123456, "name": "Brastemp", "reducedName": "brastemp", "partnerId": "marca-001-brastemp" }, "nbm": { "id": "string", "description": "string" }, "origin": { "id": 0, "description": "string" }, "model": "string", "videoUrl": "string", "gender": "string", "warrantyTime": -2147483648, "warrantyText": "string", "height": -1.7976931348623157e+308, "width": -1.7976931348623157e+308, "weight": -1.7976931348623157e+308, "length": -1.7976931348623157e+308, "priceFactor": -1.7976931348623157e+308, "calculatedPrice": true, "definitionPriceScope": "string", "hasVariations": true, "isProductActive": true, "type": "string", "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "images": [ { "id": 0, "index": 0, "main": false, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "Azul", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } ], "skus": [ { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": { "{variationTypeName}": "string" }, "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string", "active": true, "volumes": 0 } ], "kitComponents": { "idSku": "string", "stockLocalId": "string", "percentage": 0, "quantity": 0, "isMainComponent": true }, "allowAutomaticSkuMarketplaceCreation": true } }, "Page_Product": { "title": "Page_Stock", "allOf": [ { "properties": { "links": { "type": "array", "description": "Referências de paginação", "uniqueItems": false, "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/PageLinks" } }, "content": { "type": "array", "description": "Lista de marcas", "items": { "$ref": "#/components/schemas/Product" } }, "page": { "$ref": "#/components/schemas/PageMetadata" } } } ], "description": "", "type": "object", "example": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 0, "title": "string", "description": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 123456, "name": "Brastemp", "reducedName": "brastemp", "partnerId": "marca-001-brastemp" }, "nbm": { "id": "string", "description": "string" }, "origin": { "id": 0, "description": "string" }, "model": "string", "videoUrl": "string", "gender": "string", "warrantyTime": 0, "warrantyText": "string", "height": 0, "width": 0, "weight": 0, "length": 0, "priceFactor": 0, "calculatedPrice": true, "definitionPriceScope": "string", "hasVariations": true, "isProductActive": true, "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "images": [ { "id": 0, "index": 0, "main": true, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "string", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } ], "skus": [ { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } ], "allowAutomaticSkuMarketplaceCreation": true } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } }, "ProductCategory": { "title": "", "description": "", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "minimum": 0, "description": "ID da categoria gerado pelo ANYMARKET" }, "name": { "type": "string", "description": "Nome da categoria", "maxLength": 80 }, "partnerId": { "type": "string", "description": "ID da categoria no parceiro", "maxLength": 80 } }, "required": [ "id" ] }, "ProductBrand": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da marca gerado pelo ANYMARKET", "format": "int64" }, "name": { "type": "string", "description": "Nome da marca", "maxLength": 255 }, "reducedName": { "type": "string", "description": "Nome reduzido da marca", "maxLength": 255 }, "partnerId": { "type": "string", "description": "ID da Marca no Parceiro", "maxLength": 255 } }, "required": [ "id" ], "title": "", "description": "" }, "PostProduct": { "type": "object", "description": "Cria um produto com os dados informados", "required": [ "title", "description", "category", "brand", "warrantyTime", "height", "width", "length", "priceFactor", "calculatedPrice", "definitionPriceScope", "hasVariations", "images", "skus", "allowAutomaticSkuMarketplaceCreation" ], "properties": { "id": { "type": "integer", "description": "ID do produto gerado pelo ANYMARKET", "format": "int64" }, "title": { "type": "string", "description": "Título do produto", "maxLength": 150 }, "description": { "type": "string", "description": "Descrição do produto", "maxLength": 10000 }, "externalIdProduct": { "type": "string", "description": "ID externo do produto ", "maxLength": 10000 }, "category": { "$ref": "#/components/schemas/ProductCategory" }, "brand": { "$ref": "#/components/schemas/ProductBrand" }, "nbm": { "$ref": "#/components/schemas/Nbm" }, "origin": { "$ref": "#/components/schemas/Origin" }, "model": { "type": "string", "description": "Modelo do produto.\n\nNo caso de alguns marketplaces o campo pode ser exigito:\nAMAZON" }, "videoUrl": { "type": "string", "description": "URL do video do Youtube", "maxLength": 255 }, "gender": { "type": "string", "description": "Gênero do produto. Os valores são MALE, FEMALE, BOY, GIRL, UNISSEX, BABIES e CHILDISH_UNISSEX", "enum": [ "MALE", "FEMALE", "BOY", "GIRL", "UNISSEX", "BABIES", "CHILDISH_UNISSEX" ] }, "warrantyTime": { "type": "number", "description": "Tempo da garantia em meses" }, "warrantyText": { "type": "string", "description": "Texto sobre a garantia" }, "height": { "type": "number", "description": "Altura da embalagem do produto (em centímetros)", "format": "double" }, "width": { "type": "number", "description": "Largura da embalagem do produto (em centímetros)", "format": "double" }, "weight": { "type": "number", "description": "Peso da embalagem do produto (em quilos)", "format": "double", "maximum": 99999.999 }, "length": { "type": "number", "description": "Profundidade da embalagem do produto (em centímetros)", "format": "double" }, "priceFactor": { "type": "number", "description": "Fator de preço do produto. É utilizado como um Multiplicador para o preço de custo do produto. Corresponde ao campo Markup na tela do sistema", "format": "double", "example": 1 }, "calculatedPrice": { "type": "boolean", "description": "Identifica se o produto terá o preço calculado baseado no markup" }, "definitionPriceScope": { "type": "string", "description": "Suporte aos tipos SKU (Manual, eu controlo o preço pelo SKU), SKU_MARKETPLACE (Manual, eu controlo o preço pelo anúncio) ou COST (Automático, pela mudança do custo)", "enum": [ "SKU", "SKU_MARKETPLACE", "COST" ] }, "hasVariations": { "type": "boolean", "description": "Informa se o produt possui variações", "default": false }, "isProductActive": { "type": "boolean", "description": "Informa se o produto está Ativo/Inativo", "default": true }, "characteristics": { "type": "array", "description": "Define caracteristicas variaveis e específicas de cada produto. Por exemplo, no caso de uma raquete de tênis, a tensão da rede pode ser adicionada como caracteristica adicional.\n", "items": { "$ref": "#/components/schemas/ProductCharacteristic" } }, "images": { "type": "array", "description": "Arrays das imagens. Os índices se informados serão mantidos, caso alguma imagem não tenha o índice informado o ANYMARKET irá preencher de forma sequencial e sem repetição. Caso nenhuma imagem seja marcada como main o ANYMARKET irá marcar a imagem de índice 1 como main", "items": { "$ref": "#/components/schemas/Image" } }, "skus": { "type": "array", "items": { "$ref": "#/components/schemas/Sku" } }, "allowAutomaticSkuMarketplaceCreation": { "type": "boolean", "description": "Permite a criação de anúncios automáticos baseado na configuração existente na categoria (Valor padrão do campo é true).", "default": true }, "kitComponents": { "type": "object", "properties": { "idSku": { "type": "string", "description": "ID do SKU do componente" }, "stockLocalId": { "type": "string", "description": "ID do Local do Estoque" }, "percentage": { "type": "number", "description": "Porcentagem que o componente representa no KIT" }, "quantity": { "type": "number", "description": "Quantidade do Componente no KIT" }, "isMainComponent": { "type": "boolean", "description": "Informa se é o componente principal do KIT" } } }, "type": { "type": "string", "description": "Product type. Accepted values: SIMPLE (simple product), VARIATION (with variations), KIT (kit without variations), KIT_VARIATION (kit with variations). Optional; when omitted, it remains null.", "enum": [ "SIMPLE", "VARIATION", "KIT", "KIT_VARIATION" ] } }, "example": { "id": -9223372036854776000, "title": "string", "description": "string", "externalIdProduct": "string", "category": { "id": 0, "name": "string", "partnerId": "string" }, "brand": { "id": 0, "name": "string", "reducedName": "string", "partnerId": "string" }, "nbm": { "id": "string", "description": "string" }, "origin": { "id": 0, "description": "string" }, "model": "string", "videoUrl": "string", "gender": "MALE", "warrantyTime": 0, "warrantyText": "string", "height": -1.7976931348623157e+308, "width": -1.7976931348623157e+308, "weight": -1.7976931348623157e+308, "length": -1.7976931348623157e+308, "priceFactor": 1, "calculatedPrice": true, "definitionPriceScope": "SKU", "hasVariations": false, "isProductActive": true, "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "images": [ { "id": 0, "index": 0, "main": false, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "Azul", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } ], "skus": [ { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "additionalTime": 0, "price": 0, "sellPrice": 0, "stockLocalId": 0, "variations": { "{variationTypeName}": "string" }, "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string", "active": true, "volumes": 0 } ], "allowAutomaticSkuMarketplaceCreation": true, "kitComponents": true, "type": "string" } }, "NbmID": { "type": "object", "properties": { "id": { "type": "string", "description": "ID do NBM" } }, "example": { "id": "string" } }, "OriginID": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da origem. Os valores vão de 0 a 7, conforme tabela abaixo:

\n\n **0**: Nacional
\n **1**: Estrangeira - Importação direta
\n **2**: Estrangeira - Adquirida no mercado interno
\n **3**: Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%
\n **4**: Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes
\n **5**: Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%
\n **6**: Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX
\n **7**: Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX
\n", "format": "int64" } } }, "ProductUpdate": { "type": "object", "properties": { "title": { "type": "string", "description": "Título do produto", "maxLength": 150 }, "description": { "type": "string", "description": "Descrição do produto", "maxLength": 10000 }, "category": { "description": "Categoria do produto. Posteriormente o cliente realizará o vinculo da categoria enviada com a categoria de cada marketplace", "type": "object", "required": [ "id", "name", "path" ], "properties": { "id": { "type": "number", "description": "Id da categoria gerado pelo ANYMARKET" }, "name": { "type": "string", "description": "Nome da Categoria" }, "path": { "type": "string", "description": "Árvore de categorias até a categoria atual" } } }, "brand": { "$ref": "#/components/schemas/ProductBrand" }, "nbm": { "$ref": "#/components/schemas/NbmID" }, "origin": { "$ref": "#/components/schemas/OriginID" }, "model": { "type": "string", "description": "Modelo do produto" }, "videoUrl": { "type": "string", "description": "URL do video do Youtube", "maxLength": 255 }, "gender": { "type": "string", "description": "Gênero do produto. Os valores são MALE, FEMALE, BOY, GIRL e UNISSEX", "enum": [ "MALE", "FEMALE", "BOY", "GIRL", "UNISSEX", "BABIES", "CHILDISH_UNISSEX" ] }, "warrantyTime": { "type": "integer", "description": "Tempo da garantia", "format": "int32" }, "warrantyText": { "type": "string", "description": "Texto sobre a garantia" }, "height": { "type": "number", "description": "Altura da embalagem do produto (em centímetros)", "format": "double" }, "width": { "type": "number", "description": "Largura da embalagem do produto (em centímetros)", "format": "double" }, "weight": { "type": "number", "description": "Peso do produto (em quilos)", "format": "double" }, "length": { "type": "number", "description": "Profundidade da embalagem do produto (em centímetros)", "format": "double" }, "priceFactor": { "type": "number", "description": "Fator de preço do produto. É utilizado como um Multiplicador para o preço de custo do produto. Corresponde ao campo Markup na tela do sistema", "format": "double" }, "calculatedPrice": { "type": "boolean", "description": "Identifica se o produto terá o preço calculado baseado no markup" }, "definitionPriceScope": { "type": "string", "description": "Suporte aos tipos SKU (Manual, eu controlo o preço pelo SKU), SKU_MARKETPLACE (Manual, eu controlo o preço pelo anúncio) ou COST (Automático, pela mudança do custo)" }, "characteristics": { "type": "array", "description": "Define caracteristicas variaveis e específicas de cada produto. Por exemplo, no caso de uma raquete de tênis, a tensão da rede pode ser adicionada como caracteristica adicional.\n", "items": { "$ref": "#/components/schemas/ProductCharacteristic" } }, "kitComponents": { "type": "object", "properties": { "idSku": { "type": "string", "description": "ID do SKU do componente" }, "stockLocalId": { "type": "string", "description": "ID do Local do Estoque" }, "percentage": { "description": "Porcentagem que o componente representa no KIT", "type": "number" }, "quantity": { "description": "Quantidade do Componente no KIT", "type": "number" }, "isMainComponent": { "description": "Informa se é o componente principal do KIT", "type": "boolean" } } }, "allowAutomaticSkuMarketplaceCreation": { "type": "boolean", "description": "Permite a criação de anúncios automáticos baseado na configuração existente na categoria (Valor padrão do campo é true). " } }, "required": [ "title", "description", "category", "priceFactor" ], "example": { "title": "string", "description": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 0, "name": "string", "reducedName": "string", "partnerId": "string" }, "nbm": { "id": "string" }, "origin": { "id": 0 }, "model": "string", "videoUrl": "string", "gender": "string", "warrantyTime": -2147483648, "warrantyText": "string", "height": -1.7976931348623157e+308, "width": -1.7976931348623157e+308, "weight": -1.7976931348623157e+308, "length": -1.7976931348623157e+308, "priceFactor": -1.7976931348623157e+308, "calculatedPrice": true, "definitionPriceScope": "string", "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "kitComponents": { "idSku": "string", "stockLocalId": "string", "percentage": 0, "quantity": 0, "isMainComponent": true }, "allowAutomaticSkuMarketplaceCreation": true } }, "ProductMergePatch": { "type": "object", "example": { "title": "replace", "description": "Título do produto", "maxLength": 150 }, "description": "", "properties": { "title": { "type": "string", "description": "Título do produto", "maxLength": 150 }, "description": { "type": "string", "description": "Descrição do produto", "maxLength": 10000 }, "category": { "description": "Categoria do produto. Posteriormente o cliente realizará o vinculo da categoria enviada com a categoria de cada marketplace", "type": "object", "properties": { "id": { "type": "number", "description": "ID da categoria gerado pelo AnyMarket" }, "name": { "type": "string", "description": "Nome da Categoria" }, "path": { "type": "string", "description": "Árvore de categorias até a categoria atual" } }, "required": [ "id", "name", "path" ] }, "brand": { "$ref": "#/components/schemas/ProductBrand" }, "nbm": { "$ref": "#/components/schemas/NbmID" }, "origin": { "$ref": "#/components/schemas/OriginID" }, "model": { "type": "string", "description": "Modelo do produto" }, "videoUrl": { "type": "string", "description": "URL do video do Youtube", "maxLength": 255 }, "gender": { "type": "string", "description": "Gênero do produto. Os valores são MALE, FEMALE, BOY, GIRL e UNISSEX", "enum": [ "MALE", "FEMALE", "BOY", "GIRL", "UNISSEX", "BABIES", "CHILDISH_UNISSEX" ] }, "warrantyTime": { "type": "integer", "description": "Tempo da garantia", "format": "int32" }, "warrantyText": { "type": "string", "description": "Texto sobre a garantia" }, "height": { "type": "number", "description": "Altura da embalagem do produto (em centímetros)", "format": "double" }, "width": { "type": "number", "description": "Largura da embalagem do produto (em centímetros)", "format": "double" }, "weight": { "type": "number", "description": "Peso do produto (em quilos)", "format": "double" }, "length": { "type": "number", "description": "Profundidade da embalagem do produto (em centímetros)", "format": "double" }, "priceFactor": { "type": "number", "description": "Fator de preço do produto. É utilizado como um Multiplicador para o preço de custo do produto. Corresponde ao campo Markup na tela do sistema", "format": "double" }, "calculatedPrice": { "type": "boolean", "description": "Identifica se o produto terá o preço calculado baseado no markup" }, "definitionPriceScope": { "type": "string", "description": "Suporte aos tipos SKU (Manual, eu controlo o preço pelo SKU), SKU_MARKETPLACE (Manual, eu controlo o preço pelo anúncio) ou COST (Automático, pela mudança do custo)" }, "characteristics": { "type": "array", "description": "Define caracteristicas variaveis e específicas de cada produto. Por exemplo, no caso de uma raquete de tênis, a tensão da rede pode ser adicionada como caracteristica adicional.\n", "items": { "$ref": "#/components/schemas/ProductCharacteristic" } }, "kitComponents": { "description": "Permite a criação de anúncios automáticos baseado na configuração existente na categoria (Valor padrão do campo é true).", "type": "object", "properties": { "idSku": { "type": "string", "description": "ID do SKU do componente" }, "stockLocalId": { "type": "string", "description": "ID do Local do Estoque" }, "percentage": { "type": "number", "description": "Porcentagem que o componente representa no KIT" }, "quantity": { "type": "number", "description": "Quantidade do Componente no KIT" }, "isMainComponent": { "type": "boolean", "description": "Informa se é o componente principal do KIT" } } }, "allowAutomaticSkuMarketplaceCreation": { "type": "boolean", "description": "Permite a criação de anúncios automáticos baseado na configuração existente na categoria (Valor padrão do campo é true)." } } }, "ProductPatch": { "title": "ProductPatch", "type": "array", "description": "Nova Operação", "example": [ { "op": "replace", "path": "/title", "value": "novo título" }, { "op": "replace", "path": "/warrantyTime", "value": 2 }, { "op": "replace", "path": "/brand/id", "value": 1323057 } ], "items": { "type": "object", "properties": { "op": { "enum": [ "replace", "remove", "add", "move", "copy", "test" ], "description": "Operação a ser executada" }, "path": { "type": "string", "description": "Propriedade a ser modificada" }, "value": { "description": "Valor da propriedade" } } } }, "PromotionRuleActionValueResource": { "allOf": [ { "properties": { "id": { "type": "integer", "description": "ID gerado pelo ANYMARKET", "format": "int64" }, "value": { "type": "number", "description": "Valor", "format": "double" } } } ], "type": "object" }, "PromotionRuleActionResource": { "allOf": [ { "properties": { "id": { "type": "integer", "description": "ID gerado pelo ANYMARKET", "format": "int64" }, "type": { "type": "string", "description": "Tipo da ação", "enum": [ "PERCENT_VALUE", "FIXED_VALUE", "ADD_VALUE", "ADD_PERCENT_VALUE" ] }, "values": { "type": "array", "description": "Valores das ações", "items": { "$ref": "#/components/schemas/PromotionRuleActionValueResource" } } } } ], "type": "object" }, "PromotionRuleSubConditionValueResource": { "allOf": [ { "properties": { "id": { "type": "integer", "description": "ID gerado pelo ANYMARKET", "format": "int64" }, "value": { "type": "string", "description": "Valor da sub-condição" }, "description": { "type": "string", "description": "Descrição" } } } ], "type": "object" }, "PromotionRuleChildreenSubConditionResource": { "type": "object", "allOf": [ { "properties": { "id": { "type": "integer", "description": "Id gerado pelo ANYMARKET", "format": "int64" }, "subconditionType": { "type": "string", "description": "Tipo da sub condição", "enum": [ "LISTING_TYPE", "CONDITION", "SHIPPING_MODE", "ACCOUNT", "OFFICIAL_STORE" ] }, "values": { "type": "array", "description": "Valores das sub-condições", "items": { "$ref": "#/components/schemas/PromotionRuleSubConditionValueResource" } }, "childrenSubConditions": { "type": "array", "description": "Valores das sub-condições", "items": { "$ref": "#/components/schemas/PromotionRuleChildreenSubConditionResource" } } } } ] }, "PromotionRuleSubConditionResource": { "type": "object", "allOf": [ { "properties": { "id": { "type": "integer", "description": "Id gerado pelo ANYMARKET", "format": "int64" }, "subconditionType": { "type": "string", "description": "Tipo da sub condição", "enum": [ "LISTING_TYPE", "CONDITION", "SHIPPING_MODE", "ACCOUNT", "OFFICIAL_STORE" ] }, "values": { "type": "array", "description": "Valores das sub-condições", "items": { "$ref": "#/components/schemas/PromotionRuleSubConditionValueResource" } }, "childrenSubConditions": { "type": "array", "description": "Valores das sub-condições", "items": { "$ref": "#/components/schemas/PromotionRuleChildreenSubConditionResource" } } } } ] }, "PromotionRuleConditionValueResource": { "allOf": [ { "properties": { "id": { "type": "integer", "description": "ID gerado pelo ANYMARKET", "format": "int64" }, "value": { "type": "string", "description": "Valor da condição" }, "subConditions": { "type": "array", "description": "Valores das sub-condições", "items": { "$ref": "#/components/schemas/PromotionRuleSubConditionResource" } } } } ], "type": "object" }, "PromotionRuleConditionResource": { "allOf": [ { "properties": { "id": { "type": "integer", "description": "ID gerado pelo ANYMARKET", "format": "int64" }, "type": { "type": "string", "description": "Tipo da condição", "enum": [ "PRODUCT", "CATEGORY", "MARKETPLACE", "BRAND" ] }, "values": { "type": "array", "description": "Valores das condições", "items": { "$ref": "#/components/schemas/PromotionRuleConditionValueResource" } } } } ], "type": "object" }, "Promotion": { "allOf": [ { "properties": { "id": { "type": "integer", "description": "ID gerado pelo ANYMARKET", "format": "int64" }, "description": { "type": "string", "description": "Descrição da regra de preço", "maxLength": 255 }, "initialDate": { "type": "string", "description": "Data inicial", "format": "date-time" }, "finalDate": { "type": "string", "description": "Data final", "format": "date-time" }, "active": { "type": "boolean", "description": "Indica se a regra de preço esta ativa" }, "actions": { "type": "array", "description": "Ações programadas para a regra de preço", "items": { "$ref": "#/components/schemas/PromotionRuleActionResource" } }, "conditions": { "type": "array", "description": "Condições para a aplicação da regra de preços", "items": { "$ref": "#/components/schemas/PromotionRuleConditionResource" } }, "deleted": { "type": "boolean", "description": "Indica se o ANYMARKET deve encaminhar callback de pergunta" }, "status": { "type": "string", "description": "Status relacionado a regra de preço", "enum": [ "UNSCHEDULED", "SCHEDULED", "APPLIED", "FINALIZED" ] } } } ], "type": "object" }, "SkuPost": { "type": "object", "required": [ "amount", "price", "title" ], "properties": { "title": { "type": "string", "description": "Título do SKU", "maxLength": 150 }, "partnerId": { "type": "string", "description": "Código do SKU no parceiro", "maxLength": 120 }, "ean": { "type": "string", "maxLength": 13 }, "amount": { "type": "number", "description": "Quantidade de stock do SKU", "format": "double", "minimum": 0 }, "price": { "type": "number", "description": "Preço do SKU", "format": "double" }, "additionalTime": { "type": "number", "description": "Prazo Adicional para entrega. Tambem chamado de 'crossdocking' este é o prazo de preparo de cada produto para envio. Utilizado em marketplaces como B2W e CNOVA. Caso não seja informado será atribuído o valor default 0.", "format": "double", "minimum": 0 }, "stockLocalId": { "type": "number", "description": "Código do local do estoque, caso este campo esteja vazio, é adicionado ao local padrão cadastrado no sistema.", "format": "long", "minimum": 0 }, "variations": { "type": "object", "description": "Nome e valor da variação", "properties": { "variationName": { "type": "string", "description": "Nome da variação (substituir pelo nome de sua variação)", "enum": [ "VariationValue" ] } } }, "additionalStocks": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalStocks" } }, "externalId": { "type": "string", "description": "Id externo, utilizado em alguns marketplaces para controle interno destes.", "maxLength": 100 } }, "example": { "title": "string", "partnerId": "string", "ean": "string", "amount": 0, "price": 0, "additionalTime": 0, "stockLocalId": 0, "variations": { "variationName": "VariationValue" }, "additionalStocks": [ { "price": 0, "amount": 0, "additionalTime": 0, "stockLocalId": 0 } ], "externalId": "string" } }, "SkuPut": { "type": "object", "properties": { "title": { "type": "string", "description": "Título do SKU", "maxLength": 150 }, "partnerId": { "type": "string", "description": "Código do SKU no parceiro", "maxLength": 120 }, "ean": { "type": "string", "maxLength": 13 }, "price": { "type": "number", "description": "Preço (alterável apenas no tipo de controle \"Manual, eu controlo o preço pelo SKU\")", "format": "double" }, "sellPrice": { "type": "number", "description": "Preço por do SKU (utilizado quando o tipo de controle for \"Manual, eu controlo o preço pelo SKU\")", "format": "double" }, "externalId": { "type": "string", "description": "Id externo, utilizado em alguns marketplaces para controle interno destes.", "maxLength": 100 }, "active": { "type": "boolean", "description": "Informa se o SKU está Ativo/Inativo" } }, "example": { "title": "string", "partnerId": "string", "ean": "string", "price": 0, "sellPrice": 0, "externalId": "string" } }, "SkuMergePatch": { "type": "object", "example": { "title": "NewTitle", "ean": "1234567890" }, "properties": { "title": { "type": "string", "description": "Título do SKU", "maxLength": 150 }, "partnerId": { "type": "string", "description": "Código do SKU no parceiro", "maxLength": 120 }, "ean": { "type": "string", "maxLength": 13 }, "price": { "type": "number", "description": "Preço (alterável apenas no tipo de controle \"Manual, eu controlo o preço pelo SKU\")", "format": "double" }, "sellPrice": { "type": "number", "description": "Preço por do SKU (utilizado quando o tipo de controle for \"Manual, eu controlo o preço pelo SKU\")", "format": "double" }, "externalId": { "type": "string", "description": "Id externo, utilizado em alguns marketplaces para controle interno destes.", "maxLength": 100 }, "active": { "description": "Informa se o SKU está Ativo/Inativo", "type": "boolean" } } }, "SkuFileExport": { "type": "object", "properties": { "url": { "type": "string", "description": "URL para download de arquivo", "format": "uri" }, "dateTime": { "type": "string", "description": "Data do processamento do arquivo exportado", "format": "date-time" }, "documentId": { "type": "string", "description": "ID do documento exportado", "format": "uuid" }, "linesProcessed": { "type": "integer", "description": "Linhas processadas", "format": "int64", "minimum": 0 }, "countLines": { "type": "integer", "description": "Linhas contadas", "format": "int64", "minimum": 0 }, "FileExportStatus": { "type": "string", "description": "Status de processamento", "enum": [ "WAITING", "FINISHED", "FINISHED_WITHOUT_DATA", "PROCESSING", "ERROR" ] }, "marketPlace": { "type": "string", "description": "MARKETPLACE responsável pelos SKUs (filtro)." } }, "required": [ "url" ] }, "SkuMarketplaceField": { "type": "object", "description": "Informações especificas do anúncio por marketplace", "properties": { "title": { "type": "string", "description": "B2W,WALMART,MERCADO LIVRE", "maxLength": 255 }, "template": { "type": "integer", "description": "ID do template fornecido pelo ANYMARKET" }, "priceFactor": { "type": "string", "description": "B2W,CNOVA,WALMART,ECOMMERCE,MERCADO LIVRE", "format": "int64", "example": "1.000000" }, "DISCOUNT_TYPE": { "description": "B2W,CNOVA,WALMART,ECOMMERCE,MERCADO LIVRE", "enum": [ "PERCENT", "VALUE" ] }, "DISCOUNT_VALUE": { "type": "string", "description": "B2W,CNOVA,WALMART,ECOMMERCE,MERCADO LIVRE", "format": "int64", "example": "1.00" }, "HAS_DISCOUNT": { "description": "B2W,CNOVA,ECOMMERCE", "enum": [ true, false ] }, "CONCAT_ATTRIBUTES": { "type": "string", "description": "B2W", "format": "int64" }, "delivery_type": { "type": "string", "description": "B2W", "format": "int64" }, "SHIPMENT": { "type": "string", "description": "B2W", "format": "int64" }, "crossDocking": { "type": "string", "description": "B2W", "format": "int64" }, "CUSTOM_DESCRIPTION": { "type": "string", "description": "B2W", "format": "int64" }, "EAN": { "type": "string", "format": "int64", "description": "B2W,CNOVA" }, "MANUFACTURING_TIME": { "type": "string", "description": "CNOVA", "format": "int64" }, "VALUE": { "type": "string", "description": "WALMART,MERCADO LIVRE", "format": "int64" }, "PERCENT": { "type": "string", "description": "WALMART,MERCADO LIVRE", "format": "int64" }, "bronze_price": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "bronze_price_factor": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "buying_mode": { "description": "MERCADO LIVRE", "enum": [ "buy_it_now", "auction" ] }, "category_with_variation": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "condition": { "type": "string", "format": "int64", "description": "MERCADO LIVRE", "example": "NEW" }, "free_price": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "free_price_factor": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "free_shipping": { "description": "MERCADO LIVRE", "enum": [ false, true ] }, "gold_premium_price": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "gold_premium_price_factor": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "gold_price": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "gold_price_factor": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "gold_pro_price": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "gold_pro_price_factor": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "gold_special_price": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "gold_special_price_factor": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "listing_type_id": { "description": "MERCADO LIVRE", "enum": [ "gold_special", "gold_pro", "bronze", "silver", "gold", "free" ] }, "shipping_local_pick_up": { "description": "MERCADO LIVRE", "enum": [ false, true ] }, "shipping_mode": { "description": "MERCADO LIVRE", "enum": [ "me1", "me2", "Id ANYMARKET da tabela de frete" ] }, "silver_price": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "silver_price_factor": { "type": "string", "description": "MERCADO LIVRE", "format": "int64" }, "measurement_chart_id": { "type": "string", "format": "int64", "description": "Identificador ANYMARKET da tabela de medidas." }, "warranty_time": { "type": "string", "example": "60", "description": "Tempo de garantia." }, "HAS_FULFILLMENT": { "enum": [ false, true ], "description": "Anúncio Fulfillment." }, "official_store_id": { "type": "string", "description": "Código da loja oficial. (MERCADO LIVRE)" }, "ml_channels": { "enum": [ "marketplace", "mshops" ], "description": "Canal de exibição. (MERCADO L)" }, "is_main_sku": { "enum": [ true, false ], "description": "SKU Principal." }, "is_match": { "description": "Match a anúncio existente. (VIA)", "enum": [ false, true ] } }, "example": { "title": "string", "template": -9223372036854776000, "priceFactor": "string", "DISCOUNT_TYPE": "string", "DISCOUNT_VALUE": "string", "HAS_DISCOUNT": "string", "CONCAT_ATTRIBUTES": "string", "delivery_type": "string", "SHIPMENT": "string", "crossDocking": "string", "CUSTOM_DESCRIPTION": "string", "EAN": "string", "MANUFACTURING_TIME": "string", "VALUE": "string", "PERCENT": "string", "bronze_price": "string", "bronze_price_factor": "string", "buying_mode": "string", "category_with_variation": "string", "condition": "string", "free_price": "string", "free_price_factor": "string", "free_shipping": "string", "gold_premium_price": "string", "gold_premium_price_factor": "string", "gold_price": "string", "gold_price_factor": "string", "gold_pro_price": "string", "gold_pro_price_factor": "string", "gold_special_price": "string", "gold_special_price_factor": "string", "listing_type_id": "string", "shipping_local_pick_up": "string", "shipping_mode": "string", "silver_price": "string", "silver_price_factor": "string", "measurement_chart_id": "string" } }, "SkuMarketplace": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID do anúncio no ANYMARKET", "format": "int64" }, "accountName": { "type": "string", "description": "Identificador da conta no marketplace" }, "idAccount": { "type": "number", "description": "ID da conta gerado automático pelo ANYMARKET" }, "marketPlace": { "description": "Identificador do MARKETPLACE", "$ref": "#/components/schemas/EnumMarketplaces" }, "idInMarketplace": { "type": "string", "description": "ID do anúncio no Marketplace", "maxLength": 255 }, "index": { "type": "integer", "description": "Índice do anúncio por Marketplace", "format": "int64" }, "publicationStatus": { "type": "string", "description": "Status do anúncio no ANYMARKET", "enum": [ "ACTIVE", "CLOSED", "CORRUPTED", "PAUSED", "UNPUBLISHED", "WITHOUT_STOCK" ] }, "marketplaceStatus": { "type": "string", "description": "Status do anúncio no marketplace", "maxLength": 255 }, "price": { "type": "number", "description": "Preço do anúncio", "format": "double" }, "priceFactor": { "type": "number", "description": "Markup da transmissão", "format": "double" }, "discountPrice": { "type": "number", "description": "Preço com desconto do anúncio", "format": "double" }, "permalink": { "type": "string", "description": "Link da publicação no marketplace" }, "skuInMarketplace": { "type": "string", "description": "Identificador do SKU no marketplace" }, "fields": { "$ref": "#/components/schemas/SkuMarketplaceField" }, "attributes": { "type": "object", "description": "Lista os vínculos de tipo de variação e valor da variação da publicação com os valores do marketplace. Podem ser texto ou números de acordo com cada marketplace.\n
\n{\n \"63000\":\"71994\"\n}\n
\nExemplo do Mercado Livre onde para o tipo de variação (cor, tamanho, outros) e para os valores são utilizados valores numéricos.\n", "additionalProperties": { "type": "string" } }, "marketplaceItemCode": { "type": "string", "description": "Código do anúncio no marketplace" }, "warnings": { "type": "array", "description": "Lista de pendências do produto. Caso exista alguma pendência, o anúncio somente terá atualização de preço, estoque e status", "items": { "type": "string", "description": "Descrição da pendência" } } }, "required": [ "id", "accountName", "idAccount", "marketPlace", "index", "publicationStatus", "price", "priceFactor", "fields" ], "description": "", "title": "", "example": { "id": 0, "accountName": "string", "idAccount": 0, "marketPlace": "B2W", "idInMarketplace": "string", "index": 0, "publicationStatus": "ACTIVE", "marketplaceStatus": "string", "price": 0, "priceFactor": 0, "discountPrice": 0, "permalink": "string", "skuInMarketplace": "string", "fields": { "title": "string", "template": 0, "priceFactor": "string", "DISCOUNT_TYPE": "string", "DISCOUNT_VALUE": "string", "HAS_DISCOUNT": "string", "CONCAT_ATTRIBUTES": "string", "delivery_type": "string", "SHIPMENT": "string", "crossDocking": "string", "CUSTOM_DESCRIPTION": "string", "EAN": "string", "MANUFACTURING_TIME": "string", "VALUE": "string", "PERCENT": "string", "bronze_price": "string", "bronze_price_factor": "string", "buying_mode": "string", "category_with_variation": "string", "condition": "string", "free_price": "string", "free_price_factor": "string", "free_shipping": "string", "gold_premium_price": "string", "gold_premium_price_factor": "string", "gold_price": "string", "gold_price_factor": "string", "gold_pro_price": "string", "gold_pro_price_factor": "string", "gold_special_price": "string", "gold_special_price_factor": "string", "listing_type_id": "string", "shipping_local_pick_up": "string", "shipping_mode": "string", "silver_price": "string", "silver_price_factor": "string" }, "attributes": {}, "marketplaceItemCode": "string", "warnings": [ "string" ] } }, "StockReservationGet": { "type": "object", "description": "", "title": "StockReservationGet", "properties": { "reservedPending": { "type": "integer", "description": "Valor de reserva pendente", "format": "double" }, "reservedPaid": { "type": "integer", "description": "Valor de reserva pago", "format": "double" }, "reservedInvoiced": { "type": "integer", "format": "double", "description": "Valor de reserva faturado" } }, "example": { "reservedPending": 0, "reservedPaid": 0, "reservedInvoiced": 0 } }, "PostSkuMarketplace": { "type": "object", "properties": { "idInMarketplace": { "type": "string", "description": "Id do anúncio no Marketplace", "maxLength": 255 }, "marketPlace": { "type": "string", "description": "Marketplace" }, "accountName": { "type": "string", "description": "Identificador da conta do Marketplace" }, "price": { "type": "number", "description": "Preço do anúncio", "format": "double" }, "discountPrice": { "type": "number", "description": "Preço com desconto do anúncio", "format": "double" }, "permalink": { "type": "string", "description": "Link da publicação no marketplace" }, "skuInMarketplace": { "type": "string", "description": "Identificador do SKU no marketplace" }, "fields": { "$ref": "#/components/schemas/SkuMarketplaceField" } }, "required": [ "marketPlace", "price", "discountPrice", "fields" ], "example": { "idInMarketplace": "string", "marketPlace": "string", "accountName": "string", "price": -1.7976931348623157e+308, "discountPrice": -1.7976931348623157e+308, "permalink": "string", "skuInMarketplace": "string", "fields": { "title": "string", "template": 0, "priceFactor": "1.000000", "DISCOUNT_TYPE": "PERCENT", "DISCOUNT_VALUE": "1.00", "HAS_DISCOUNT": true, "CONCAT_ATTRIBUTES": "string", "delivery_type": "string", "SHIPMENT": "string", "crossDocking": "string", "CUSTOM_DESCRIPTION": "string", "EAN": "string", "MANUFACTURING_TIME": "string", "VALUE": "string", "PERCENT": "string", "bronze_price": "string", "bronze_price_factor": "string", "buying_mode": "buy_it_now", "category_with_variation": "string", "condition": "NEW", "free_price": "string", "free_price_factor": "string", "free_shipping": false, "gold_premium_price": "string", "gold_premium_price_factor": "string", "gold_price": "string", "gold_price_factor": "string", "gold_pro_price": "string", "gold_pro_price_factor": "string", "gold_special_price": "string", "gold_special_price_factor": "string", "listing_type_id": "gold_special", "shipping_local_pick_up": false, "shipping_mode": "me1", "silver_price": "string", "silver_price_factor": "string", "measurement_chart_id": "string", "warranty_time": "60", "HAS_FULFILLMENT": false, "official_store_id": "string", "ml_channels": "marketplace", "is_main_sku": true, "is_match": false } } }, "SkuMarketplaceDetail": { "allOf": [ { "$ref": "#/components/schemas/SkuMarketplace" } ] }, "SkuMarketplaceById": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID do anúncio no ANYMARKET", "format": "int64" }, "accountName": { "type": "string", "description": "Identificador da conta no marketplace" }, "idAccount": { "type": "number", "description": "ID da conta gerado automático pelo ANYMARKET" }, "marketPlace": { "description": "Identificador do MARKETPLACE", "$ref": "#/components/schemas/EnumMarketplaces" }, "idInMarketplace": { "type": "string", "description": "ID do anúncio no Marketplace", "maxLength": 255 }, "marketplaceItemCode": { "type": "string", "description": "Id do anúncio no Marketplace", "maxLength": 255 }, "index": { "type": "integer", "description": "Índice do anúncio por Marketplace", "format": "int64" }, "publicationStatus": { "type": "string", "description": "Status do anúncio no ANYMARKET", "enum": [ "ACTIVE", "CLOSED", "CORRUPTED", "PAUSED", "UNPUBLISHED", "WITHOUT_STOCK" ] }, "marketplaceStatus": { "type": "string", "description": "Status do anúncio no marketplace", "maxLength": 255 }, "price": { "type": "number", "description": "Preço do anúncio", "format": "double" }, "priceFactor": { "type": "number", "description": "Markup da transmissão", "format": "double" }, "discountPrice": { "type": "number", "description": "Preço com desconto do anúncio", "format": "double" }, "permalink": { "type": "string", "description": "Link da publicação no marketplace" }, "skuInMarketplace": { "type": "string", "description": "Identificador do SKU no marketplace" }, "fields": { "$ref": "#/components/schemas/SkuMarketplaceField" }, "availableStock": { "type": "object", "description": "Informações de Estoque", "properties": { "amount": { "type": "number", "description": "Quantidade total", "format": "double" }, "availableAmount": { "type": "number", "description": "Quantidade disponível", "format": "double" }, "cost": { "type": "number", "description": "Custo médio do SKU no estoque. A partir desse custo será calculado o preço final do produto caso o tipo do cálculo de preço esteja como atutomático.", "format": "double" }, "physicalAmount": { "type": "number", "description": "Quantidade em estoque físico", "format": "double" }, "totalReservation": { "type": "number", "description": "Quantidade de estoque reservada", "format": "double" }, "stockLocal": { "type": "string", "description": "Local do Estoque" } }, "required": [ "amount", "availableAmount", "cost", "physicalAmount", "totalReservation", "stockLocal" ] }, "attributes": { "type": "object", "description": "Lista os vínculos de tipo de variação e valor da variação da publicação com os valores do marketplace. Podem ser texto ou números de acordo com cada marketplace.\n
\n{\n \"63000\":\"71994\"\n}\n
\nExemplo do Mercado Livre onde para o tipo de variação (cor, tamanho, outros) e para os valores são utilizados valores numéricos.\n", "additionalProperties": { "type": "string" } }, "warnings": { "type": "array", "description": "Lista de pendências do produto. Caso exista alguma pendência, o anúncio somente terá atualização de preço, estoque e status", "items": { "type": "string", "description": "Descrição da pendência" } } }, "required": [ "id", "accountName", "idAccount", "marketPlace", "index", "publicationStatus", "price", "priceFactor", "fields" ], "example": { "id": 0, "accountName": "string", "idAccount": 0, "marketPlace": "B2W", "idInMarketplace": "string", "marketplaceItemCode": "string", "index": 0, "publicationStatus": "ACTIVE", "marketplaceStatus": "string", "price": 0, "priceFactor": 0, "discountPrice": 0, "permalink": "string", "skuInMarketplace": "string", "fields": { "title": "string", "template": 0, "priceFactor": "string", "DISCOUNT_TYPE": "string", "DISCOUNT_VALUE": "string", "HAS_DISCOUNT": "string", "CONCAT_ATTRIBUTES": "string", "delivery_type": "string", "SHIPMENT": "string", "crossDocking": "string", "CUSTOM_DESCRIPTION": "string", "EAN": "string", "MANUFACTURING_TIME": "string", "VALUE": "string", "PERCENT": "string", "bronze_price": "string", "bronze_price_factor": "string", "buying_mode": "string", "category_with_variation": "string", "condition": "string", "free_price": "string", "free_price_factor": "string", "free_shipping": "string", "gold_premium_price": "string", "gold_premium_price_factor": "string", "gold_price": "string", "gold_price_factor": "string", "gold_pro_price": "string", "gold_pro_price_factor": "string", "gold_special_price": "string", "gold_special_price_factor": "string", "listing_type_id": "string", "shipping_local_pick_up": "string", "shipping_mode": "string", "silver_price": "string", "silver_price_factor": "string" }, "availableStock": { "amount": 0, "availableAmount": 0, "cost": 0, "physicalAmount": 0, "totalReservation": 0, "stockLocal": "string" }, "attributes": {}, "warnings": [ "string" ] } }, "PutSkuMarketplace": { "type": "object", "required": [ "price" ], "properties": { "publicationStatus": { "type": "string", "description": "Status do anúncio no ANYMARKET", "enum": [ "ACTIVE", "CLOSED", "CORRUPTED", "PAUSED", "UNPUBLISHED", "WITHOUT_STOCK" ] }, "marketplaceStatus": { "type": "string", "description": "Status do anúncio no marketplace", "maxLength": 255 }, "price": { "type": "number", "description": "Preço do anúncio", "format": "double" }, "discountPrice": { "type": "number", "description": "Preço com desconto do anúncio", "format": "double" }, "priceFactor": { "type": "number", "description": "Markup da transmissão", "format": "double" }, "permalink": { "type": "string", "description": "Link da publicação no marketplace" }, "skuInMarketplace": { "type": "string", "description": "Identificador do SKU no marketplace. A atualização somente é permitida se o campo publicationStatus estiver como UNPUBLISHED, caso contrário não será possível atualizar o campo." }, "fields": { "$ref": "#/components/schemas/SkuMarketplaceField" } }, "example": { "publicationStatus": "ACTIVE", "marketplaceStatus": "string", "price": 0, "discountPrice": 0, "priceFactor": 0, "permalink": "string", "skuInMarketplace": "string", "fields": { "title": "string", "template": 0, "priceFactor": "string", "DISCOUNT_TYPE": "string", "DISCOUNT_VALUE": "string", "HAS_DISCOUNT": "string", "CONCAT_ATTRIBUTES": "string", "delivery_type": "string", "SHIPMENT": "string", "crossDocking": "string", "CUSTOM_DESCRIPTION": "string", "EAN": "string", "MANUFACTURING_TIME": "string", "VALUE": "string", "PERCENT": "string", "bronze_price": "string", "bronze_price_factor": "string", "buying_mode": "string", "category_with_variation": "string", "condition": "string", "free_price": "string", "free_price_factor": "string", "free_shipping": "string", "gold_premium_price": "string", "gold_premium_price_factor": "string", "gold_price": "string", "gold_price_factor": "string", "gold_pro_price": "string", "gold_pro_price_factor": "string", "gold_special_price": "string", "gold_special_price_factor": "string", "listing_type_id": "string", "shipping_local_pick_up": "string", "shipping_mode": "string", "silver_price": "string", "silver_price_factor": "string" } } }, "SkuMarketplaceMergePatch": { "type": "object", "required": [ "price" ], "properties": { "publicationStatus": { "type": "string", "description": "Status do anúncio no ANYMARKET", "enum": [ "ACTIVE", "CLOSED", "CORRUPTED", "PAUSED", "UNPUBLISHED", "WITHOUT_STOCK" ] }, "marketplaceStatus": { "type": "string", "description": "Status do anúncio no marketplace", "maxLength": 255 }, "price": { "type": "number", "description": "Preço do anúncio", "format": "double" }, "discountPrice": { "type": "number", "description": "Preço com desconto do anúncio", "format": "double" }, "priceFactor": { "type": "number", "description": "Markup da transmissão", "format": "double" }, "permalink": { "type": "string", "description": "Link da publicação no marketplace" }, "skuInMarketplace": { "type": "string", "description": "Identificador do SKU no marketplace. A atualização somente é permitida se o campo publicationStatus estiver como UNPUBLISHED, caso contrário não será possível atualizar o campo." }, "fields": { "$ref": "#/components/schemas/SkuMarketplaceField" } }, "example": { "publicationStatus": "ACTIVE", "marketplaceStatus": "string", "price": 0, "discountPrice": 0, "priceFactor": 0, "permalink": "string", "skuInMarketplace": "string", "fields": { "title": "string", "template": 0, "priceFactor": "string", "DISCOUNT_TYPE": "string", "DISCOUNT_VALUE": "string", "HAS_DISCOUNT": "string", "CONCAT_ATTRIBUTES": "string", "delivery_type": "string", "SHIPMENT": "string", "crossDocking": "string", "CUSTOM_DESCRIPTION": "string", "EAN": "string", "MANUFACTURING_TIME": "string", "VALUE": "string", "PERCENT": "string", "bronze_price": "string", "bronze_price_factor": "string", "buying_mode": "string", "category_with_variation": "string", "condition": "string", "free_price": "string", "free_price_factor": "string", "free_shipping": "string", "gold_premium_price": "string", "gold_premium_price_factor": "string", "gold_price": "string", "gold_price_factor": "string", "gold_pro_price": "string", "gold_pro_price_factor": "string", "gold_special_price": "string", "gold_special_price_factor": "string", "listing_type_id": "string", "shipping_local_pick_up": "string", "shipping_mode": "string", "silver_price": "string", "silver_price_factor": "string" } } }, "SkuMarketplacePatch": { "type": "array", "description": "Nova Operação", "example": [ { "op": "add", "patch": "/permalink", "value": "Link da publicação no marketplace" }, { "op": "replace", "patch": "/skuInMarketplace", "value": "skuNovo" }, { "op": "replace", "patch": "/fields/title", "value": "novo titulo" } ], "items": { "type": "object", "properties": { "op": { "enum": [ "replace", "remove", "add", "move", "copy", "test" ], "description": "Operação a ser executada" }, "path": { "type": "string", "description": "Propriedade a ser modificada" }, "value": { "description": "Valor da propriedade" }, "": { "type": "string" } } } }, "SkuMarketplaceUpdatePricesResource": { "type": "object", "required": [ "id", "price", "discountPrice" ], "description": "Informações de Preço De e Preço Por de um anúncio", "properties": { "id": { "type": "integer", "description": "ID do anúncio no ANYMARKET", "format": "int64" }, "price": { "type": "number", "description": "Preço do anúncio", "format": "double" }, "discountPrice": { "type": "number", "description": "Preço com desconto do anúncio", "format": "double" } } }, "PutSkuMarketplaceUpdatePricesResource": { "type": "array", "description": "Lista contendo as informações de Preço De (price) e Preço Por (discountPrice) de anúncios", "items": { "$ref": "#/components/schemas/SkuMarketplaceUpdatePricesResource" } }, "SkuMarketplaceUpdatePricesResourceResponse": { "type": "object", "required": [ "id", "errorMsg" ], "description": "Informações de Preço De e Preço Por de um anúncio", "properties": { "id": { "type": "integer", "description": "ID do anúncio no ANYMARKET", "format": "int64" }, "errorMsg": { "type": "string", "description": "Mensagem de erro" } } }, "PutSkuMarketplaceUpdatePricesResourceResponse": { "type": "array", "description": "Lista contendo as informações de Preço De (price) e Preço Por (discountPrice) de anúncios", "items": { "$ref": "#/components/schemas/SkuMarketplaceUpdatePricesResourceResponse" }, "example": [ { "id": 0, "errorMsg": "string" } ] }, "SkuMarketplacePricePost": { "type": "object", "description": "Dados de atualização de preço.", "properties": { "price": { "type": "number", "description": "Preço do anúncio." }, "discountPrice": { "type": "number", "description": "Preço com desconto do anúncio" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } }, "SkuMarketplaceUpdatePricesErrorResource": { "type": "object", "description": "Contem Lista para apresentar erros que aconteceram ao atualizar preço.", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "chave do SkuMarketplace que não pode ser atualizado." }, "value": { "type": "string", "description": "Mensagem de erro." } } } } } }, "PostTemplate": { "allOf": [ { "properties": { "name": { "type": "string", "description": "Identificador do template" }, "content": { "type": "string", "description": "Conteúdo do template caso o template seja do tipo HTML" }, "templateType": { "type": "string", "description": "Tipo do template", "enum": [ "HTML", "PLAIN_TEXT" ] }, "plainTextContent": { "type": "string", "description": "Conteúdo do template caso o template seja do tipo PLAIN_TEXT" }, "includeDimensionAttributes": { "type": "boolean", "description": "Permite ou não a inclusão dos dados da embalagem na tabela de características" }, "manualImageSize": { "type": "boolean", "description": "Permite ou não definir o tamanho da imagem" }, "manualImgAttributes": { "type": "string", "description": "Atributos da imagem" }, "isActive": { "type": "boolean", "description": "O status do template" }, "removeDescriptionTableContent": { "type": "boolean", "description": "Remove ou não todo conteúdo descrito em tabelas HTML" }, "marketPlace": { "type": "string", "description": "Descritivo de qual marketplace" } } } ], "type": "object", "example": { "name": "string", "content": "string", "templateType": "HTML", "plainTextContent": "string", "includeDimensionAttributes": true, "manualImageSize": true, "manualImgAttributes": "string", "isActive": true, "removeDescriptionTableContent": true, "marketPlace": "string" } }, "Template": { "allOf": [ { "properties": { "id": { "type": "integer", "description": "ID do Template gerado automático pelo ANYMARKET", "format": "int64" }, "name": { "type": "string", "description": "Identificador do template" }, "content": { "type": "string", "description": "Conteúdo do template caso o template seja do tipo HTML" }, "templateType": { "type": "string", "description": "Tipo do template", "enum": [ "HTML", "PLAIN_TEXT" ] }, "plainTextContent": { "type": "string", "description": "Conteúdo do template caso o template seja do tipo PLAIN_TEXT" }, "includeDimensionAttributes": { "type": "boolean", "description": "Permite ou não a inclusão dos dados da embalagem na tabela de características" }, "manualImageSize": { "type": "boolean", "description": "Permite ou não definir o tamanho da imagem" }, "manualImgAttributes": { "type": "string", "description": "Atributos da imagem" }, "isActive": { "type": "boolean", "description": "O status do template" }, "removeDescriptionTableContent": { "type": "boolean", "description": "Remove ou não todo conteúdo descrito em tabelas HTML" }, "marketPlace": { "$ref": "#/components/schemas/EnumMarketplaces", "description": "ID do MARKETPLACE" } } } ], "type": "object", "example": { "id": 0, "name": "string", "content": "string", "templateType": "HTML", "plainTextContent": "string", "includeDimensionAttributes": true, "manualImageSize": true, "manualImgAttributes": "string", "isActive": true, "removeDescriptionTableContent": true, "marketPlace": "B2W" } }, "Page_Template": { "title": "Page_Template", "allOf": [ { "properties": { "links": { "type": "array", "description": "Referências de paginação", "uniqueItems": false, "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/PageLinks" } }, "content": { "type": "array", "description": "Lista de marcas", "items": { "$ref": "#/components/schemas/Template" } }, "page": { "$ref": "#/components/schemas/PageMetadata" } } } ], "description": "", "type": "object", "example": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 0, "name": "string", "content": "string", "templateType": "HTML", "plainTextContent": "string", "includeDimensionAttributes": true, "manualImageSize": true, "manualImgAttributes": "string", "isActive": true, "removeDescriptionTableContent": true, "marketPlace": "B2W" } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } }, "PutTemplate": { "required": [ "name", "templateType" ], "allOf": [ { "properties": { "name": { "type": "string", "description": "Identificador do template" }, "content": { "type": "string", "description": "Conteúdo do template caso o template seja do tipo HTML" }, "templateType": { "type": "string", "description": "Tipo do template", "enum": [ "HTML", "PLAIN_TEXT" ] }, "plainTextContent": { "type": "string", "description": "Conteúdo do template caso o template seja do tipo PLAIN_TEXT" }, "includeDimensionAttributes": { "type": "boolean", "description": "Permite ou não a inclusão dos dados da embalagem na tabela de características" }, "manualImageSize": { "type": "boolean", "description": "Permite ou não definir o tamanho da imagem" }, "manualImgAttributes": { "type": "string", "description": "Atributos da imagem" }, "isActive": { "type": "boolean", "description": "O status do template" }, "removeDescriptionTableContent": { "type": "boolean", "description": "Remove ou não todo conteúdo descrito em tabelas HTML" } } } ] }, "VariationValueGet": { "type": "object", "properties": { "id": { "type": "number", "description": "Código do valor de variação" }, "description": { "type": "string", "description": "Descrição do valor de variação" }, "partnerId": { "type": "string", "description": "ID do valor no parceiro" } } }, "VariationGet": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID do tipo de variação gerado pelo ANYMARKET", "format": "int64" }, "name": { "type": "string", "description": "Descrição da origem" }, "partnerId": { "type": "string", "description": "ID da variação no parceiro" }, "values": { "type": "array", "description": "Valores da variação", "items": { "$ref": "#/components/schemas/VariationValueGet" } }, "visualVariation": { "type": "boolean", "description": "É visual" } }, "example": { "id": 0, "name": "string", "partnerId": "string", "values": [ { "id": 0, "description": "string", "partnerId": "string" } ], "visualVariation": true } }, "Page_Variation": { "title": "Page_Order", "allOf": [ { "properties": { "links": { "type": "array", "description": "Referências de paginação", "uniqueItems": false, "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/PageLinks" } }, "content": { "type": "array", "description": "Lista de pedidos", "items": { "$ref": "#/components/schemas/VariationGet" } }, "page": { "$ref": "#/components/schemas/PageMetadata" } } } ], "description": "", "type": "object" }, "VariationTypePut": { "type": "object", "properties": { "name": { "type": "string", "description": "Nome do tipo de variação", "maxLength": 200 }, "partnerId": { "type": "string", "description": "Id do tipo de variação no parceiro", "maxLength": 40 }, "visualVariation": { "type": "boolean", "description": "Indica se o tipo de variação possúi variação visual" } } }, "VariationValue": { "type": "array", "items": {}, "example": { "Cor": "Azul" } }, "TransmissionSku": { "type": "object", "properties": { "id": { "type": "integer", "description": "SKU ID generated by ANYMARKET", "format": "int64" }, "title": { "type": "string", "description": "Título do SKU" }, "partnerId": { "type": "string", "description": "Código do SKU no parceiro" }, "ean": { "type": "string", "description": "Código de barras" }, "price": { "type": "number", "description": "Preço do produto", "format": "double" }, "amount": { "type": "number", "description": "Quantidade disponível", "format": "double" }, "variations": { "type": "array", "description": "Valores de variação", "items": { "$ref": "#/components/schemas/VariationValue" } }, "discountPrice": { "type": "number", "description": "Preço do produto com desconto", "format": "double" } }, "required": [ "id", "title", "price", "amount", "discountPrice" ] }, "Transmission": { "allOf": [ { "properties": { "id": { "type": "integer", "description": "ID da Transmissão gerado automático pelo ANYMARKET", "format": "int64" }, "accountName": { "type": "string", "description": "Identificador da conta do Marketplace" }, "description": { "type": "string", "description": "Descrição da transmissão enviada ao marketplace" }, "category": { "description": "Categoria do produto. Posteriormente o cliente realizará o vinculo da categoria enviada com a categoria de cada marketplace", "type": "object", "properties": { "id": { "type": "number", "description": "ID da categoria gerado pelo ANYMARKET" }, "name": { "type": "string", "description": "Nome da Categoria" }, "path": { "type": "string", "description": "Árvore de categorias até a categoria atual" } }, "required": [ "id", "name", "path" ] }, "brand": { "type": "object", "description": "Marca do produto", "properties": { "id": { "type": "number", "description": "ID da Marca gerado automático pelo ANYMARKET" }, "name": { "type": "string", "description": "Nome da Marca" } }, "required": [ "id", "name" ] }, "product": { "$ref": "#/components/schemas/SimpleProduct" }, "nbm": { "$ref": "#/components/schemas/Nbm" }, "origin": { "$ref": "#/components/schemas/Origin" }, "model": { "type": "string", "description": "Modelo do produto" }, "videoUrl": { "type": "string", "description": "URL do produto" }, "warrantyTime": { "type": "integer", "description": "Tempo da garantia", "format": "int32" }, "warrantyText": { "type": "string", "description": "Texto sobre a garantia" }, "height": { "type": "number", "description": "Altura da embalagem do produto (em centímetros)", "format": "double" }, "width": { "type": "number", "description": "Largura da embalagem do produto (em centímetros)", "format": "double" }, "weight": { "type": "number", "description": "Peso da embalagem do produto (em quilos)", "format": "double" }, "length": { "type": "number", "description": "Profundidade da embalagem do produto (em centímetros)", "format": "double" }, "status": { "type": "string", "description": "Status de transmissão

\n\n **ACTIVATING**: Ativando tranmissão mas na fila para processamento (Usado pelo ANYMARKET para indicar progresso)
\n **CLOSING**: Transmissão finalizada mas na fila para processamento (Usado pelo ANYMARKET para indicar progresso)
\n **ERROR**: Erro na publicação no marketplace
\n **OK**: Transmissão enviada com sucesso para o marketplace
\n **PAUSING**: Pausando tranmissão no marketplace
\n **SENDING**: Enviando ao marketplace mas não houve resposta de sucesso ainda
\n **SYNCING**: Sincronizando status do marketplace com o ANYMARKET
\n **WAITING_SYNC**: Ativado para o marketplace, mas não foi sincronizado com marketplace ainda
\n" }, "transmissionMessage": { "type": "string", "description": "Campo para armazenar mensagem de retorno do parceiro para casos de problemas na transmissão." }, "publicationStatus": { "type": "string", "description": "Status do anúncio no ANYMARKET", "enum": [ "ACTIVE", "CLOSED", "CORRUPTED", "PAUSED", "UNPUBLISHED", "WITHOUT_STOCK" ] }, "marketPlaceStatus": { "type": "string", "description": "Situação do pedido no marketplace. Cada marketplace possui situações diferentes. Ex: no mercado livre não existe a situação faturado\n" }, "priceFactor": { "type": "number", "description": "Markup da transmissão", "format": "double" }, "sku": { "$ref": "#/components/schemas/TransmissionSku" }, "characteristics": { "type": "array", "description": "Define caracteristicas variaveis e específicas de cada produto. Por exemplo, no caso de uma raquete de tênis, a tensão da rede pode ser adicionada como caracteristica adicional.\n", "items": { "$ref": "#/components/schemas/ProductCharacteristic" } }, "images": { "type": "array", "description": "URL das imagens", "items": { "$ref": "#/components/schemas/Image" } } } } ], "type": "object", "example": { "id": 0, "accountName": "string", "description": "string", "category": { "id": 0, "name": "string", "path": "string" }, "brand": { "id": 0, "name": "string" }, "product": { "id": 0, "title": "string" }, "nbm": { "id": "string", "description": "string" }, "origin": { "id": 0, "description": "string" }, "model": "string", "videoUrl": "string", "warrantyTime": 0, "warrantyText": "string", "height": 0, "width": 0, "weight": 0, "length": 0, "status": "string", "transmissionMessage": "string", "publicationStatus": "ACTIVE", "marketPlaceStatus": "string", "priceFactor": 0, "sku": { "id": 0, "title": "string", "partnerId": "string", "ean": "string", "price": 0, "amount": 0, "variations": [ { "id": 0, "description": "string", "type": { "id": 0, "name": "string", "visualVariation": true } } ], "discountPrice": 0 }, "characteristics": [ { "index": 0, "name": "string", "value": "string" } ], "images": [ { "id": 0, "index": 0, "main": true, "url": "http://example.com", "thumbnailUrl": "http://example.com", "lowResolutionUrl": "http://example.com", "standardUrl": "http://example.com", "originalImage": "http://example.com", "variation": "string", "status": "UNPROCESSED", "statusMessage": "string", "standardWidth": 0, "standardHeight": 0, "originalWidth": 0, "originalHeight": 0 } ] } }, "Page_Transmission": { "title": "Page_Stock", "allOf": [ { "properties": { "links": { "type": "array", "description": "Referências de paginação", "uniqueItems": false, "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/PageLinks" } }, "content": { "type": "array", "description": "Lista de marcas", "items": { "$ref": "#/components/schemas/Transmission" } }, "page": { "$ref": "#/components/schemas/PageMetadata" } } } ], "description": "", "type": "object" }, "TransmissionPut": { "type": "object", "properties": { "publicationStatus": { "type": "string", "description": "Status de publicação no ANYMARKET

\n\n **ACTIVE**: Transmissão ativa no marketplace
\n **CLOSED**: Transmissão encerrada no marketplace
\n **CORRUPTED**: Transmissão corrompida no envio ao marketplace
\n **PAUSED**: Transmissão pausada no marketplace
\n **UNPUBLISHED**: Transmissão não publicada no marketplace
\n **WITHOUT_STOCK**: Transmissão sem estoque no ANYMARKET
\n", "enum": [ "ACTIVE", "CLOSED", "CORRUPTED", "PAUSED", "UNPUBLISHED", "WITHOUT_STOCK" ] }, "marketPlaceStatus": { "type": "string", "description": "Status da transmissão no marketplace", "maxLength": 255 } } }, "Page_VariationValue": { "title": "Page_Order", "allOf": [ { "properties": { "links": { "type": "array", "description": "Referências de paginação", "uniqueItems": false, "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/PageLinks" } }, "content": { "type": "array", "description": "Lista de pedidos", "items": { "$ref": "#/components/schemas/VariationValueGet" } }, "page": { "$ref": "#/components/schemas/PageMetadata" } } } ], "description": "", "type": "object", "example": { "links": [ { "rel": "next", "href": "https://.../v2/component?limit=5&offset=5" } ], "content": [ { "id": 0, "description": "string", "partnerId": "string" } ], "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 } } }, "VariationValuePost": { "type": "object", "properties": { "description": { "type": "string", "description": "Descrição do valor de variação", "maxLength": 4000 }, "partnerId": { "type": "string", "description": "Id do tipo de variação no parceiro", "maxLength": 100 } }, "required": [ "description" ] }, "VariationValuePut": { "required": [ "description" ], "type": "object", "properties": { "description": { "type": "string", "description": "Descrição do valor de variação", "maxLength": 4000 }, "partnerId": { "type": "string", "description": "Id do tipo de variação no parceiro", "maxLength": 100 } }, "example": { "description": "string", "partnerId": "string" } }, "dateTypeGMT": { "title": "dateTypeGMT", "type": "string", "example": "2024-08-30T08:26:00-03:00", "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}-[0-9]{2}:[0-9]{2}", "description": "Modelo de data e hora com GMT" }, "TransmissionPriceDiscount": { "type": "object", "title": "TransmissionPriceDiscount", "description": "Modelo de desconto da transmissão de preço", "properties": { "discountType": { "type": "string", "description": "Tipo de desconto" }, "discountValue": { "type": "integer", "description": "Valor do desconto" } }, "example": { "discountType": "PERCENT", "discountValue": 12.23 } }, "TransmissionPriceRule": { "type": "object", "title": "TransmissionPriceRule", "description": "Modelo de regra de preço da transmissão de preço", "properties": { "priceRuleRegular": { "type": "number", "description": "Preço DE" }, "priceRuleDeal": { "type": "number", "description": "Preço POR" } }, "example": { "priceRuleRegular": 1871.83, "priceRuleDeal": 1871.82 } }, "TransmissionPriceCampaign": { "type": "object", "title": "TransmissionPriceCampaign", "description": "Modelo de preço de campanha da transmissão de preço", "properties": { "campaignRegularPrice": { "type": "number", "description": "Preço DE" }, "campaignDealPrice": { "type": "number", "description": "Preço POR" } }, "example": { "campaignRegularPrice": 1871.83, "campaignDealPrice": 1871.82 } }, "TransmissionPrice": { "type": "object", "title": "TransmissionPrice", "description": "Modelo de transmissão de preço", "properties": { "id": { "type": "integer", "description": "ID da transmissão" }, "title": { "type": "string", "description": "Título da transmissão" }, "accountName": { "type": "string", "description": "Nome do marketplace" }, "idAccount": { "type": "integer", "description": "Conta do marketplace" }, "idSku": { "type": "integer", "description": "ID do SKU" }, "basePrice": { "type": "number", "description": "Preço base do SKU" }, "priceFactor": { "type": "number", "description": "Markup" }, "originalPrice": { "type": "number", "description": "Preço DE" }, "finalPrice": { "type": "number", "description": "Preço POR" }, "discount": { "$ref": "#/components/schemas/TransmissionPriceDiscount" }, "priceRule": { "$ref": "#/components/schemas/TransmissionPriceRule" }, "campaign": { "$ref": "#/components/schemas/TransmissionPriceCampaign" } }, "example": { "id": 9276, "title": "Kit 02 Poltrona 01 Namoradeira e 02 Puffs Dado Suede Amarelo", "accountName": "ECOMMERCE", "idAccount": 1, "idSku": 76579, "basePrice": 1039.9, "priceFactor": 1.8, "originalPrice": 1984.81, "finalPrice": 1875.81, "discount": { "discountType": "PERCENT", "discountValue": 12.78 }, "priceRule": { "priceRuleRegular": 1871.83, "priceRuleDeal": 1871.82 }, "campaign": { "campaignRegularPrice": 1871.83, "campaignDealPrice": 1871.82 } } }, "PackageReason": { "type": "object", "description": "Reason for the package, used by the remote marketplace integration mechanism", "properties": { "id": { "type": "string", "description": "Reason code" }, "description": { "type": "string", "description": "Reason description" } }, "example": { "id": "string", "description": "string" } }, "DimensionsPackage": { "type": "object", "description": "Package dimensions, in centimeters. Each field is individually optional.", "properties": { "length": { "type": "number", "description": "Package length, in centimeters", "minimum": 0 }, "width": { "type": "number", "description": "Package width, in centimeters", "minimum": 0 }, "height": { "type": "number", "description": "Package height, in centimeters", "minimum": 0 }, "weight": { "type": "number", "description": "Package weight", "minimum": 0 } }, "example": { "length": 0, "width": 0, "height": 0, "weight": 0 } }, "OrderPackageItemCreate": { "type": "object", "description": "Item that composes the package", "required": [ "sku", "quantity" ], "properties": { "sku": { "type": "string", "description": "Item SKU in the sales channel/marketplace" }, "quantity": { "type": "number", "description": "Quantity of the item that will compose the package", "minimum": 1 } }, "example": { "sku": "string", "quantity": 1 } }, "OrderPackageItem": { "type": "object", "description": "Item that composes the package, including data generated/enriched by ANYMARKET", "required": [ "sku", "quantity" ], "properties": { "packageItemId": { "type": "string", "format": "uuid", "description": "Package item identifier generated by ANYMARKET" }, "sku": { "type": "string", "description": "Item SKU in the sales channel/marketplace" }, "quantity": { "type": "number", "description": "Quantity of the item that composes the package", "minimum": 1 }, "salesOrderItemId": { "type": "integer", "format": "int64", "description": "Sales order item identifier" }, "skuInMarketplace": { "type": "string", "description": "Item SKU in the marketplace" }, "idInMarketplace": { "type": "string", "description": "Item identifier in the marketplace" } }, "example": { "packageItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sku": "string", "quantity": 1, "salesOrderItemId": 0, "skuInMarketplace": "string", "idInMarketplace": "string" } }, "OrderPackageEntryCreate": { "type": "object", "description": "A package to be created for the order", "required": [ "items" ], "properties": { "dimensions": { "$ref": "#/components/schemas/DimensionsPackage" }, "items": { "type": "array", "description": "Items that compose the package", "minItems": 1, "items": { "$ref": "#/components/schemas/OrderPackageItemCreate" } }, "externalId": { "type": "string", "description": "Seller identifier" } }, "example": { "dimensions": { "length": 0, "width": 0, "height": 0, "weight": 0 }, "items": [ { "sku": "string", "quantity": 1 } ], "externalId": "string" } }, "OrderPackageCreate": { "type": "object", "description": "Request body to create a package (multiple shipments) for an order", "required": [ "packages" ], "properties": { "packageReason": { "$ref": "#/components/schemas/PackageReason" }, "packages": { "type": "array", "description": "Packages to be created for the order", "minItems": 1, "items": { "$ref": "#/components/schemas/OrderPackageEntryCreate" } } }, "example": { "packageReason": { "id": "string", "description": "string" }, "packages": [ { "dimensions": { "length": 0, "width": 0, "height": 0, "weight": 0 }, "items": [ { "sku": "string", "quantity": 1 } ], "externalId": "string" } ] } }, "OrderPackageEntry": { "type": "object", "description": "A package of the order, including data generated/enriched by ANYMARKET", "properties": { "packageItemId": { "type": "string", "format": "uuid", "description": "Identifier of this package, generated by ANYMARKET" }, "externalId": { "type": "string", "description": "Seller identifier" }, "createdAt": { "type": "string", "format": "date-time", "description": "Package creation date" }, "trackingCode": { "type": "string", "description": "Package tracking code" }, "trackingDate": { "type": "string", "format": "date-time", "description": "Package tracking date" }, "dimensions": { "$ref": "#/components/schemas/DimensionsPackage" }, "reasonId": { "type": "string", "description": "Package reason code" }, "reasonDescription": { "type": "string", "description": "Package reason description" }, "createdUnit": { "type": "string", "format": "date-time", "description": "Package creation date at the unit" }, "issuedLabelAt": { "type": "string", "format": "date-time", "description": "Package label issue date" }, "statusMarketplace": { "type": "string", "description": "Package status in the marketplace" }, "status": { "type": "string", "description": "Package status" }, "items": { "type": "array", "description": "Items that compose the package", "items": { "$ref": "#/components/schemas/OrderPackageItem" } } }, "example": { "packageItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "externalId": "string", "createdAt": "2019-08-24T14:15:22Z", "trackingCode": "string", "trackingDate": "2019-08-24T14:15:22Z", "dimensions": { "length": 0, "width": 0, "height": 0, "weight": 0 }, "reasonId": "string", "reasonDescription": "string", "createdUnit": "2019-08-24T14:15:22Z", "issuedLabelAt": "2019-08-24T14:15:22Z", "statusMarketplace": "string", "status": "string", "items": [ { "packageItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sku": "string", "quantity": 1, "salesOrderItemId": 0, "skuInMarketplace": "string", "idInMarketplace": "string" } ] } }, "OrderPackage": { "type": "object", "description": "Package (multiple shipments) of an order, including data generated/enriched by ANYMARKET", "properties": { "orderId": { "type": "integer", "format": "int64", "description": "Order identifier in ANYMARKET" }, "packageId": { "type": "integer", "format": "int64", "description": "Package group identifier generated by ANYMARKET" }, "oi": { "type": "string", "description": "Organization (tenant) identifier in ANYMARKET" }, "orderIdInMarketplace": { "type": "string", "description": "Order identifier in the marketplace" }, "packageReason": { "$ref": "#/components/schemas/PackageReason" }, "packages": { "type": "array", "description": "Order packages", "items": { "$ref": "#/components/schemas/OrderPackageEntry" } } }, "example": { "orderId": 0, "packageId": 0, "oi": "string", "orderIdInMarketplace": "string", "packageReason": { "id": "string", "description": "string" }, "packages": [ { "packageItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "externalId": "string", "createdAt": "2019-08-24T14:15:22Z", "trackingCode": "string", "trackingDate": "2019-08-24T14:15:22Z", "dimensions": { "length": 0, "width": 0, "height": 0, "weight": 0 }, "reasonId": "string", "reasonDescription": "string", "createdUnit": "2019-08-24T14:15:22Z", "issuedLabelAt": "2019-08-24T14:15:22Z", "statusMarketplace": "string", "status": "string", "items": [ { "packageItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sku": "string", "quantity": 1, "salesOrderItemId": 0, "skuInMarketplace": "string", "idInMarketplace": "string" } ] } ] } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422" } } } } } } }