{"info":{"_postman_id":"1b3a27d6-c328-40fd-91d9-04ffa64042e1","name":"API Yapoli","description":"

Cada integração pode ser acessada via API da Yapoli. O que delimita e determina a qual integração um acesso se aplica é o host (DNS) gerado e o token específico.

\n

O host consiste no nome da integração dentro do domínio yapoli.io. Por exemplo: “integracao-cliente.yapoli.io” sendo que no caso de ambiente de validação ele recebe o sufixo “-homol”. Ex: https://integração-cliente-homol.yapoli.io.

\n

Os tokens requeridos nas chamadas devem ter sido emitidos pelo endpoint /api/app/login. O username e senha para autenticação serão fornecidos pela Yapoli na ocasião da criação da integração

\n

Status retornados:

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7711620","collectionId":"1b3a27d6-c328-40fd-91d9-04ffa64042e1","publishedId":"UVeJM5pk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-02-08T15:34:29.000Z"},"item":[{"name":"Authenticate (Login)","id":"fcdc62c6-5150-48fd-bcf5-4f01addcba53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"/api/app/login","description":"

Autenticação (Login)

\n

Gera o token para autenticação nos outros serviços da API. O tempo de expiração do token emitido é 1 hora

\n

Type: object

\n

path: #https://example.com/product.schema.json

\n

$schema: https://json-schema.org/draft/2020-12/schema

\n

$id: https://example.com/product.schema.json

\n

Properties

\n\n","urlObject":{"path":["api","app","login"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"fcdc62c6-5150-48fd-bcf5-4f01addcba53"},{"name":"Lista de itens distribuídos","event":[{"listen":"test","script":{"id":"a39ef330-5b20-4b7a-824d-8e4d521e8b3f","exec":["const jsonData = pm.response.json();","pm.test(\"Status test\", () => {"," pm.response.to.have.status(200);","});","","pm.test(\"Formating Test\", () => {"," pm.expect(jsonData.items).to.be.an(\"array\", \"items is not an object\")"," pm.expect(jsonData.items[0]).to.be.an(\"object\")","})","","pm.test(\"Test Metadata\", () => {"," const firstObject = jsonData.items[0]"," pm.expect(firstObject.data).to.be.an(\"array\")"," const firstData = firstObject.data[0]"," pm.expect(firstData).to.be.an(\"object\", \"firstData não é object\")","})","","/*pm.test(\"Test Files\", () => {"," const firstObject = jsonData.items[0]"," pm.expect(firstObject.files).to.be.an(\"array\")"," pm.expect(firstObject.files.length).to.be.equal(1)"," pm.expect(firstObject.files[0]).to.be.an(\"array\")"," pm.expect(firstObject.files[0].length).to.be.greaterThan(0)"," const firstLink = firstObject.files[0][0]"," const followLinkRequest = {"," url: firstLink,"," method: 'GET'"," };"," pm.sendRequest(followLinkRequest, (err, res) => {"," pm.expect(res.status).to.be.equal(\"OK\")"," });","})*/","","pm.test(\"Paging Test\", () => {"," pm.expect(jsonData.from).to.be.equal(0)"," pm.expect(jsonData.total).to.be.greaterThan(0)"," pm.expect(jsonData.total).to.be.equal(jsonData.items.length)","})"],"type":"text/javascript"}}],"id":"774aafc9-91fc-427d-808a-168f2e2a07fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fields\": [\"published\"]\n}","options":{"raw":{"language":"json"}}},"url":"/api/app/items","description":"

Item Distribuído

\n

Um item distribuído dentro do contexto de uma integração na Yapoli

\n

Type: object

\n

path: #https://example.com/product.schema.json

\n

$schema: https://json-schema.org/draft/2020-12/schema

\n

$id: https://example.com/product.schema.json

\n

Properties

\n\n

Generated with json-schema-md-doc

\n","urlObject":{"path":["api","app","items"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"3f425322-7350-4a8e-806a-e94c20de22c6","name":"Chama o endpoint de itens filtrando pelo metadado “MARCA”","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json","disabled":true}],"body":{"mode":"raw","raw":"{\n \"fields\": [\n \"taxonomy\",\n \"tags\"\n ],\n \"searchKeywords\": {\n \"filter_value.a1be6382-0deb-4158-a303-d54b171b8ac2\": \"ACME\"\n },\n \"metadata_values\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://cliente-homol.yapoli.io/api/app/items"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"total\": 2,\n \"from\": 0,\n \"to\": 2,\n \"items\": [\n {\n \"category\": \"product\",\n \"taxonomy\": \"product-acme-azul\",\n \"data\": [\n {\n \"BRAND\": \"ACME\"\n },\n {\n \"COLOR\": \"Azul\"\n }\n ],\n \"files\": [\n [\n \"https://cdn-client.yapoli.com/acme-azul-produto-0.jpg\",\n \"https://cdn-client.yapoli.com/acme-azul-produto-1.jpg\"\n ]\n ],\n \"tags\": [\n [\n [\n \"bombas\",\n \"caixas\"\n ]\n ],\n []\n ]\n },\n {\n \"category\": \"produto\",\n \"data\": [\n {\n \"BRAND\": \"ACME\"\n },\n {\n \"COLOR\": \"Vermelho\"\n }\n ],\n \"files\": [\n [\n \"https://cdn-client.yapoli.com/acme-vermelho-produto-0.jpg\"\n ]\n ],\n \"tags\": [\n [\n [\n \"bombas\"\n ]\n ]\n ]\n }\n ]\n}"},{"id":"53082016-aea3-42ca-b6fe-352406125e63","name":"Lista de itens distribuídos","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json","disabled":true}],"body":{"mode":"raw","raw":"{\n \"fields\": [\"name\", \"description\"]\n}","options":{"raw":{"language":"json"}}},"url":"/api/app/items"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"774aafc9-91fc-427d-808a-168f2e2a07fc"},{"name":"Lista de metadados cadastrados","id":"d1121fca-4930-4ad0-bab2-390f883fa81e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"/api/app/metadata","urlObject":{"path":["api","app","metadata"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"111cda4b-f481-4d4b-8f40-7780f17c2493","name":"Requisição sem parâmetros","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json","disabled":true}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://cliente-homol.yapoli.io/api/app/metadata"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"total\": 2,\n \"items\": [\n {\n \"list_value\": [\n \"ACME\",\n \"UMBRELLA\"\n ],\n \"name\": \"BRAND\",\n \"id\": \"a1be6382-0deb-4158-a303-d54b171b8ac2\"\n },\n {\n \"list_value\": [\n \"Azul\",\n \"Amarelo\",\n \"Vermelho\"\n ],\n \"name\": \"COLOR\",\n \"id\": \"e2061b00-3664-4d2e-94e7-7f9960e0a0e4\"\n }\n ]\n}"}],"_postman_id":"d1121fca-4930-4ad0-bab2-390f883fa81e"},{"name":"Upload Parameters","id":"8ccd1227-8d4c-4c84-8b89-9e2921e1086d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/api/app/upload","description":"

Parâmetros de upload

\n

Obtém parâmetros para fazer upload automatizado na plataforma da Yapo0li

\n

Type: object

\n

path: #https://example.com/product.schema.json

\n

$schema: https://json-schema.org/draft/2020-12/schema

\n

$id: https://example.com/product.schema.json

\n

Properties

\n\n

Generated with json-schema-md-doc

\n","urlObject":{"path":["api","app","upload"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"8ccd1227-8d4c-4c84-8b89-9e2921e1086d"},{"name":"Sign Urls","event":[{"listen":"prerequest","script":{"id":"7d426525-403b-43ce-add0-e0ff0a728c80","exec":["const domain = pm.variables.get(\"domain\");","const auth = btoa(`${pm.variables.get('username')}:${pm.variables.get('password')}`)","const echoPostRequest = {"," url: `${domain}/api/app/login`,"," method: 'POST',"," header: {"," \"Content-Type\": \"application/json\","," \"Authorization\": `Basic ${auth}`"," },"," body: {"," mode: 'application/json',"," raw: pm.variables.get('login_body')"," }","};","pm.sendRequest(echoPostRequest, function (err, res) {"," if (err === null) {"," pm.variables.set(\"token\", res.json().token);"," }","});"],"type":"text/javascript"}}],"id":"2c105697-4bce-4b9a-9576-9f4ff2c4e7d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"urls\": [\n \"https://yapoli-private-bucket.s3.sa-east-1.amazonaws.com/clients/client/private/local/acme-0.png\",\n \"https://yapoli-private-bucket.s3.sa-east-1.amazonaws.com/clients/client/private/local/acme-1.png\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/api/app/sign-urls","description":"

Assinar lista de URLs

\n

Autoriza para download uma lista de urls fornecidas

\n

Type: object

\n

path: #https://example.com/product.schema.json

\n

$schema: https://json-schema.org/draft/2020-12/schema

\n

$id: https://example.com/product.schema.json

\n

Properties

\n\n

Generated with json-schema-md-doc

\n

O retorno é em texto puro. Cada URL será encapsulada entre colchetes angulares \"<>\" sem um separador, seguindo o padrão definido no apêndice C da RFC-3896 (Uniform Resource Identifier (URI): Generic Syntax)

\n

O limite de urls para assinar em uma única chamada é de 100

\n","urlObject":{"path":["api","app","sign-urls"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"a29a1bb4-d427-4f36-9be8-5a06f3e73957","name":"Chama o endpoint com URLs do S3","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer <>","type":"text"}],"body":{"mode":"raw","raw":"{\n \"urls\": [\n \"https://yapoli-private-bucket.s3.sa-east-1.amazonaws.com/clients/client/private/local/acme-0.png\",\n \"https://yapoli-private-bucket.s3.sa-east-1.amazonaws.com/clients/client/private/local/acme-1.png\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/api/app/sign-urls"},"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"text/plain","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"''"}],"_postman_id":"2c105697-4bce-4b9a-9576-9f4ff2c4e7d7"},{"name":"Lista de Categorias","event":[{"listen":"prerequest","script":{"id":"43718651-ec2a-41d8-960e-b4666890581a","exec":["const domain = pm.variables.get(\"domain\");","const auth = btoa(`${pm.variables.get('username')}:${pm.variables.get('password')}`)","const echoPostRequest = {"," url: `${domain}/api/app/login`,"," method: 'POST',"," header: {"," \"Content-Type\": \"application/json\","," \"Authorization\": `Basic ${auth}`"," },"," body: {"," mode: 'application/json',"," raw: pm.variables.get('login_body')"," }","};","pm.sendRequest(echoPostRequest, function (err, res) {"," if (err === null) {"," pm.variables.set(\"token\", res.json().token);"," }","});"],"type":"text/javascript"}}],"id":"7d255073-d626-4870-b9c6-d4d1007e0321","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"region_id\": \"8dd5faf8-9659-4723-905b-bc6bc0078b40\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/app/category","description":"

Lista de Categorias

\n

Type: object

\n

path: #

\n

$schema: http://json-schema.org/draft-07/schema#

\n

Properties

\n
    \n
  • region_id optional
      \n
    • Type: string
      • \n
    • path: #/properties/region_id
      • \n
    \n
    • \n
\n

Generated with json-schema-md-doc

\n","urlObject":{"path":["api","app","category"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"2afb993b-d236-45d1-8379-674c554b8a14","name":"Lista de Categorias","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"region_id\": \"8dd5faf8-9659-4723-905b-bc6bc0078b40\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/app/category"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"total\": 2,\n \"items\": [\n {\n \"id\": \"20bcda90-e20a-4d38-a99b-f58ca0566ecb\",\n \"name\": \"Images\",\n \"region_id\": \"2cc3c296-9863-41aa-87f8-db961c833100\"\n },\n {\n \"id\": \"6336dd91-4182-4a26-a135-c93b03285e27\",\n \"name\": \"Videos\",\n \"region_id\": \"2cc3c296-9863-41aa-87f8-db961c833100\"\n }\n ]\n}"}],"_postman_id":"7d255073-d626-4870-b9c6-d4d1007e0321"},{"name":"Lista de Segmentos","event":[{"listen":"prerequest","script":{"id":"43718651-ec2a-41d8-960e-b4666890581a","exec":["const domain = pm.variables.get(\"domain\");","const auth = btoa(`${pm.variables.get('username')}:${pm.variables.get('password')}`)","const echoPostRequest = {"," url: `${domain}/api/app/login`,"," method: 'POST',"," header: {"," \"Content-Type\": \"application/json\","," \"Authorization\": `Basic ${auth}`"," },"," body: {"," mode: 'application/json',"," raw: pm.variables.get('login_body')"," }","};","pm.sendRequest(echoPostRequest, function (err, res) {"," if (err === null) {"," pm.variables.set(\"token\", res.json().token);"," }","});"],"type":"text/javascript"}}],"id":"2c8ed6da-75c5-4563-b101-09751bf3d069","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"/api/app/segment","description":"

Lista de Segmentos

\n

Type: object

\n

path: #

\n

$schema: http://json-schema.org/draft-07/schema#

\n

Properties

\n
    \n
  • region_id optional
      \n
    • Type: string
      • \n
    • path: #/properties/region_id
      • \n
    \n
    • \n
\n

Generated with json-schema-md-doc

\n","urlObject":{"path":["api","app","segment"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"1025e4d0-0cea-4fc5-8d24-72b4d1dcc825","name":"Lista de Segmentos","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"/api/app/segment"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"total\": 2,\n \"items\": [\n {\n \"id\": \"070b69f9-d190-4512-b282-b06df652ff7f\",\n \"name\": \"Bombs\",\n \"region_id\": \"2cc3c296-9863-41aa-87f8-db961c833100\"\n },\n {\n \"id\": \"0fe6441f-d9f2-4ecd-b63c-36bc7c6247c4\",\n \"name\": \"Anvils\",\n \"region_id\": \"2cc3c296-9863-41aa-87f8-db961c833100\"\n }\n ]\n}"}],"_postman_id":"2c8ed6da-75c5-4563-b101-09751bf3d069"},{"name":"Lista de Divisões","event":[{"listen":"prerequest","script":{"id":"43718651-ec2a-41d8-960e-b4666890581a","exec":["const domain = pm.variables.get(\"domain\");","const auth = btoa(`${pm.variables.get('username')}:${pm.variables.get('password')}`)","const echoPostRequest = {"," url: `${domain}/api/app/login`,"," method: 'POST',"," header: {"," \"Content-Type\": \"application/json\","," \"Authorization\": `Basic ${auth}`"," },"," body: {"," mode: 'application/json',"," raw: pm.variables.get('login_body')"," }","};","pm.sendRequest(echoPostRequest, function (err, res) {"," if (err === null) {"," pm.variables.set(\"token\", res.json().token);"," }","});"],"type":"text/javascript"}}],"id":"a1f71d3e-06ae-470d-ba13-b8260c8b4508","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"/api/app/division","description":"

Lista de Divisões

\n

Type: object

\n

path: #

\n

$schema: http://json-schema.org/draft-07/schema#

\n

Properties

\n
    \n
  • region_id optional
      \n
    • Type: string
      • \n
    • path: #/properties/region_id
      • \n
    \n
    • \n
\n

Generated with json-schema-md-doc

\n","urlObject":{"path":["api","app","division"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"13761a2d-6910-4e4a-bbc5-3de468996b76","name":"Lista de Divisões","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"/api/app/division"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"total\": 2,\n \"items\": [\n {\n \"id\": \"bba74cb5-f57b-4bb4-afe0-896c97ac18ae\",\n \"name\": \"Explosives\",\n \"region_id\": \"2cc3c296-9863-41aa-87f8-db961c833100\"\n },\n {\n \"id\": \"64369594-c327-4473-913f-51e1aeaa1b17\",\n \"name\": \"Blacksmithing\",\n \"region_id\": \"2cc3c296-9863-41aa-87f8-db961c833100\"\n }\n ]\n}"}],"_postman_id":"a1f71d3e-06ae-470d-ba13-b8260c8b4508"},{"name":"Criação de item","event":[{"listen":"prerequest","script":{"id":"450ae3b7-9473-4281-9fec-b7731b23cba2","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ee3a362a-e0c6-4ff1-a49d-e3fe0f46515b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Caixa ACME\",\n \"description\": \"Caixa de dados ACME\",\n \"published\": true,\n \"is_draft\": false,\n \"category_id\": \"2cc3c296-9863-41aa-87f8-db961c833100\",\n \"segment_id\": \"070b69f9-d190-4512-b282-b06df652ff7f\",\n \"attributes\": [\n {\n \"value\": \"ACME\",\n \"attribute_id\": \"a1be6382-0deb-4158-a303-d54b171b8ac2\"\n },\n {\n \"value\": \"BLUE\",\n \"attribute_id\": \"6336dd91-4182-4a26-a135-c93b03285e27\"\n }\n ]\n}"},"url":"/api/app/item","description":"

Criação de Item

\n

Criar item na plataforma.

\n

Type: object

\n

path: #https://example.com/product.schema.json

\n

$schema: https://json-schema.org/draft/2020-12/schema

\n

$id: https://example.com/product.schema.json

\n

Properties

\n

Generated schema for Root

\n

Type: object

\n

path: #

\n

$schema: http://json-schema.org/draft-07/schema#

\n

Properties

\n

Nome do item: Nesse campo você deve informar o nome do item que será criado na plataforma.

\n
    \n
  • name required
      \n
    • Type: string
      • \n
    • path: #/properties/name
      • \n
    \n
    • \n
\n

Descrição do item: Nesse campo você pode colocar informações mais detalhadas sobre o item.

\n
    \n
  • description required
      \n
    • Type: string
      • \n
    • path: #/properties/description
      • \n
    \n
    • \n
\n

Campo publicado | Despublicado: Nesse campo você define se o item será criado como publicado ou despublicado.

\n
    \n
  • True: Cria o item como publicado
    • \n
  • False: Cria o item como despublicado
      \n
    • published required
        \n
      • Type: boolean
        • \n
      • path: #/properties/published
        • \n
      \n
      • \n
    \n
    • \n
\n

Categoria: Nesse campo deve ser informado o ID da categoria onde o item será criado.

\n
    \n
  • category_id required
      \n
    • Type: string
      • \n
    \n
    • \n
\n

ID do Segmento: Aqui deve ser informado o ID do segmento dentro da Plataforma

\n
    \n
  • segment_id required
      \n
    • Type: string
      • \n
    • path: #/properties/segment_id
      • \n
    \n
    • \n
\n

Atributos: Nesse campo deve ser informado:
Value: Valor do metadado
Attribute_id: ID do metadados dentro da plataforma
Label: Nome do metadados

\n
    \n
  • attributes required
      \n
    • Type: array
      • \n
    • path: #/properties/attributes
        \n
      • Items
        • \n
      • Type: object
        • \n
      • path: #/properties/attributes/items
        • \n
      • Properties
          \n
        • value required
            \n
          • Type: string
            • \n
          • path: #/properties/attributes/items/properties/value
            • \n
          \n
          • \n
        • attribute_id required
            \n
          • Type: string
            • \n
          • path: #/properties/attributes/items/properties/attribute_id
            • \n
          \n
          • \n
        • label required
            \n
          • Type: string
            • \n
          • path: #/properties/attributes/items/properties/label
            • \n
          \n
          • \n
        \n
        • \n
      \n
      • \n
    \n
    • \n
\n

Generated with json-schema-md-doc

\n","urlObject":{"path":["api","app","item"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b35ced1f-fb9f-4c16-9ef9-10071fe62391","name":"Criação de item","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Caixa ACME\",\n \"description\": \"Caixa de dados ACME\",\n \"published\": true,\n \"category_id\": \"08da-569b-4231-1f17f500caef079c-a2da\",\n \"segment_id\": \"0f29a025-e201-4ffa-a03f-87442f6e81bc\",\n \"attributes\": [\n {\n \"value\": \"CAIXA ACME\",\n \"attribute_id\": \"57583ebb-ee29d98ba8-4b7d-848b-9fe402\",\n \"label\": \"CADASTRO\"\n },\n {\n \"value\": \"CARGA ACME\",\n \"attribute_id\": \"913ab94e-98d-4002-88af8-3ed23d8b9776\",\n \"label\": \"LOGISTICA\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{urlBase}}/item"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"86ff94f0-26ad-45e8-bfc7-da480281233b\"\n}"},{"id":"9f9c9886-c353-4b0e-994b-8b1215a87151","name":"Criação de item - erro nos parâmetros","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Caixa ACME\",\n \"description\": \"Caixa de dados ACME\",\n \"published\": true,\n \"category_id\": \"08da-569b-4231-1f17f500caef079c-a2da\",\n \"segment_id\": \"0f29a025-e201-4ffa-a03f-87442f6e81bc\",\n \"attributes\": [\n {\n \"value\": \"FOGUETE ACME\",\n \"attribute_id\": \"57583ebb-ee29d98ba8-4b7d-848b-9fe402\",\n \"label\": \"CADASTRO\"\n },\n {\n \"value\": \"CARGA ACME\",\n \"attribute_id\": \"913ab94e-98d-4002-88af8-3ed23d8b9776\",\n \"label\": \"LOGISTICA\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{urlBase}}/item"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8","description":"","type":"text"},{"key":"Content-Language ","value":"en","description":"","type":"text"},{"key":"X-Status-Response","value":"0","description":"","type":"text"},{"key":"X-Message","value":"Value to metadata not in list: FOGUETE ACME. Metadata: cadastro / 57583ebb-ee29d98ba8-4b7d-848b-9fe402","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"ee3a362a-e0c6-4ff1-a49d-e3fe0f46515b"},{"name":"Atualização de item","event":[{"listen":"prerequest","script":{"id":"78e7bdc5-fd07-4010-b3e2-eed66c0547ff","exec":[""],"type":"text/javascript"}}],"id":"cd4a9110-c6aa-4789-9460-f1a885fb05e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Produto ACME\",\n \"segment_id\": \"123v-e8111033-11bff03c-aaa123bbb3218\",\n \"category_id\": \"aaa-e8111033-11bff03c-aaa123bbb3218\",\n \"description\": {\n \"text\": \"Produto ACME\",\n \"formatter\": {\n \"name\": \"MUI-RTE/DraftJs\",\n \"version\": \"${npm_package_dependencies_mui_rte}\",\n \"format\": \"{\\\"blocks\\\":[{\\\"key\\\":\\\"56lso\\\",\\\"text\\\":\\\"Produto ACME\\\",\\\"type\\\":\\\"unstyled\\\",\\\"depth\\\":0,\\\"inlineStyleRanges\\\":[],\\\"entityRanges\\\":[],\\\"data\\\":{}}],\\\"entityMap\\\":{}}\"\n }\n },\n \"attributes\": [\n {\n \"value\": \"ACME Box\", \n \"attribute_id\": \"123a-e8111033-11bff03c-aaa123bbb3218\",\n \"label\": \"Categoria ACME\"\n },\n {\n \"value\": \"ACME Descrição\",\n \"attribute_id\": \"568a-e8111033-11bff03c-aaa123bbb3218\",\n \"label\": \"ACME Descrição\"\n }\n ],\n \"assets\": [\n \"23a-e8111033-11bff03c-aaa123bbb32183\",\n \"123a-e8111033-11bff03c-aaa123b887995\"\n \n ],\n \"published\": true\n}"},"url":"/api/app/item/{id}","description":"

Edição do Item

\n

Edição de item na plataforma.

\n

URL:

\n

id - id do item que foi cadastrado

\n

Type: object

\n

path: #https://example.com/product.schema.json

\n

$schema: http://json-schema.org/draft-07/schema#

\n

Properties

\n

Type: object

\n

Nome do item: Nesse campo você deve informar o nome do item que será alterado na plataforma.

\n
    \n
  • name required
      \n
    • Type: string
      • \n
    • path: #/properties/name
      • \n
    \n
    • \n
\n

Segmento: Nesse campo deve ser informado o ID do segmento onde o item está cadastrado.

\n
    \n
  • segment_id required
      \n
    • Type: string
      • \n
    • path: #/properties/segment_id
      • \n
    \n
    • \n
\n

Categoria: Nesse campo deve ser informado o ID da categoria onde o item está cadastrado.

\n
    \n
  • category_id required
      \n
    • Type: string
      • \n
    • path: #/properties/category_id
      • \n
    \n
    • \n
\n

Descrição do item: Nesse campo você alterar a descrição do item.

\n
    \n
  • description required
      \n
    • Type: string
      • \n
    • path: #/properties/description
      • \n
    \n
    • \n
\n

Atributos: Nesse campo deve ser informado
Value: Valor do metadado
Attribute_id: ID do metadados dentro da plataforma

\n
    \n
  • attributes required
      \n
    • Type: array
      • \n
    • path: #/properties/attributes
        \n
      • Items
        • \n
      • Type: object
        • \n
      • path: #/properties/attributes/items
        • \n
      • Properties
          \n
        • value required
            \n
          • Type: string
            • \n
          • path: #/properties/attributes/items/properties/value
            • \n
          \n
          • \n
        • attribute_id required
            \n
          • Type: string
            • \n
          • path: #/properties/attributes/items/properties/attribute_id
            • \n
          \n
          • \n
        \n
        • \n
      \n
      • \n
    \n
    • \n
\n

Campo publicado | Despublicado: Nesse campo você define se o item será criado como publicado ou despublicado.

\n
    \n
  • published required
      \n
    • Type: boolean
      • \n
    • path: #/properties/published
      • \n
    \n
    • \n
\n

Generated with json-schema-md-doc

\n","urlObject":{"path":["api","app","item","{id}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd4a9110-c6aa-4789-9460-f1a885fb05e7"},{"name":"Atualização de item por Atributo","event":[{"listen":"prerequest","script":{"id":"78e7bdc5-fd07-4010-b3e2-eed66c0547ff","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e1bd43fc-4f0b-46e7-b9b4-b00e89d1e087","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"lookup_attribute_id\": \"11111111-1111-1111-1111-111111111111\",\n \"lookup_attribute_value\": \"SKU-123456\",\n \"isDraft\": false,\n\n \"name\": \"Produto ACME\",\n \"segment_id\": \"123v-e8111033-11bff03c-aaa123bbb3218\",\n \"category_id\": \"aaa-e8111033-11bff03c-aaa123bbb3218\",\n \"description\": {\n \"text\": \"Produto ACME\",\n \"formatter\": {\n \"name\": \"MUI-RTE/DraftJs\",\n \"version\": \"${npm_package_dependencies_mui_rte}\",\n \"format\": \"{\\\"blocks\\\":[{\\\"key\\\":\\\"56lso\\\",\\\"text\\\":\\\"Produto ACME\\\",\\\"type\\\":\\\"unstyled\\\",\\\"depth\\\":0,\\\"inlineStyleRanges\\\":[],\\\"entityRanges\\\":[],\\\"data\\\":{}}],\\\"entityMap\\\":{}}\"\n }\n },\n \"attributes\": [\n {\n \"value\": \"ACME Box\", \n \"attribute_id\": \"123a-e8111033-11bff03c-aaa123bbb3218\",\n \"label\": \"Categoria ACME\"\n },\n {\n \"value\": \"ACME Descrição\",\n \"attribute_id\": \"568a-e8111033-11bff03c-aaa123bbb3218\",\n \"label\": \"ACME Descrição\"\n }\n ],\n \"assets\": [\n \"23a-e8111033-11bff03c-aaa123bbb32183\",\n \"123a-e8111033-11bff03c-aaa123b887995\"\n \n ],\n \"published\": true\n}"},"url":"/api/app/item/{id}","description":"

Edição do Item

\n

Edição de item na plataforma.

\n

URL:

\n

id - id do item que foi cadastrado

\n

Type: object

\n

path: #https://example.com/product.schema.json

\n

$schema: http://json-schema.org/draft-07/schema#

\n

Properties

\n

Type: object

\n

Nome do item: Nesse campo você deve informar o nome do item que será alterado na plataforma.

\n
    \n
  • name required
      \n
    • Type: string
      • \n
    • path: #/properties/name
      • \n
    \n
    • \n
\n

Segmento: Nesse campo deve ser informado o ID do segmento onde o item está cadastrado.

\n
    \n
  • segment_id required
      \n
    • Type: string
      • \n
    • path: #/properties/segment_id
      • \n
    \n
    • \n
\n

Categoria: Nesse campo deve ser informado o ID da categoria onde o item está cadastrado.

\n
    \n
  • category_id required
      \n
    • Type: string
      • \n
    • path: #/properties/category_id
      • \n
    \n
    • \n
\n

Descrição do item: Nesse campo você alterar a descrição do item.

\n
    \n
  • description required
      \n
    • Type: string
      • \n
    • path: #/properties/description
      • \n
    \n
    • \n
\n

Atributos: Nesse campo deve ser informado
Value: Valor do metadado
Attribute_id: ID do metadados dentro da plataforma

\n
    \n
  • attributes required
      \n
    • Type: array
      • \n
    • path: #/properties/attributes
        \n
      • Items
        • \n
      • Type: object
        • \n
      • path: #/properties/attributes/items
        • \n
      • Properties
          \n
        • value required
            \n
          • Type: string
            • \n
          • path: #/properties/attributes/items/properties/value
            • \n
          \n
          • \n
        • attribute_id required
            \n
          • Type: string
            • \n
          • path: #/properties/attributes/items/properties/attribute_id
            • \n
          \n
          • \n
        \n
        • \n
      \n
      • \n
    \n
    • \n
\n

Campo publicado | Despublicado: Nesse campo você define se o item será criado como publicado ou despublicado.

\n
    \n
  • published required
      \n
    • Type: boolean
      • \n
    • path: #/properties/published
      • \n
    \n
    • \n
\n

Generated with json-schema-md-doc

\n","urlObject":{"path":["api","app","item","{id}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e1bd43fc-4f0b-46e7-b9b4-b00e89d1e087"}],"event":[{"listen":"prerequest","script":{"id":"7893efa4-63a5-4e88-a75b-0737d4f4358f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1697c527-bd57-4267-9cb3-a58fabeadf8a","type":"text/javascript","exec":[""]}}],"variable":[{"key":"domain","value":""},{"key":"token","value":""},{"key":"usertoken","value":""}]}