{ "info": { "_postman_id": "63f1cec0-5da4-447c-94c9-025cdedf552e", "name": "API Koncili", "description": "Introduction \nThe Koncili API is a solution for order integration and reconciliation.\n\n## Authentication\n\nAll requests must include two mandatory headers:\n\n- `gumgaToken`: Authentication token provided by Koncili\n \n- `integrator`: Unique UUID identifying the integrator\n \n\n## Status Codes\n\nFor the complete list of HTTP status codes used, refer to the [API error reference](https:///docs/general-information/api-error-reference)\n\n## Support\n\nFor technical support, please contact [suporte@koncili.com](https://mailto:suporte@koncili.com)\n\nContact Support: \nName: Suporte Koncili \nEmail: [suporte@koncili.com](https://mailto:suporte@koncili.com)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "53419482", "_collection_link": "https://go.postman.co/collection/53419482-63f1cec0-5da4-447c-94c9-025cdedf552e?source=collection_link" }, "item": [ { "name": "public/api/auth", "item": [ { "name": "Generate JWT access tokens", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"credentials\": \"email:senha(base64)\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/public/api/auth/token", "host": [ "{{baseUrl}}" ], "path": [ "public", "api", "auth", "token" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] }, "description": "Authenticates the user using Base64-encoded credentials and returns access and refresh tokens. \nCredentials format: `Base64(email + \":\" + password)`" }, "response": [ { "name": "Successful authentication", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"credentials\": \"email:password(base64)\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/public/api/auth/token", "host": [ "{{baseUrl}}" ], "path": [ "public", "api", "auth", "token" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"access_token\": \"JWT token\",\n \"refresh_token\": \"JWT token\"\n}" } ] }, { "name": "Renews access tokens using a refresh token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"refreshToken\": \"refresh_token\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/public/api/auth/refresh-token", "host": [ "{{baseUrl}}" ], "path": [ "public", "api", "auth", "refresh-token" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] }, "description": "Generates a new token pair (access and refresh) using a valid refresh token." }, "response": [ { "name": "Tokens renovados com sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"refreshToken\": \"refresh_token\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/public/api/auth/refresh-token", "host": [ "{{baseUrl}}" ], "path": [ "public", "api", "auth", "refresh-token" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"access_token\": \"JWT token\",\n \"refresh_token\": \"JWT token\"\n}" } ] } ] }, { "name": "api/v3", "item": [ { "name": "order", "item": [ { "name": "Create or update an order", "request": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"marketplaceId\": \"701-2798273-4005859\",\n \"sequenceId\": \"\",\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"status\": \"PAID_WAITING_DELIVERY\",\n \"createdDate\": \"2025-05-09T12:00:00Z\",\n \"approvedDate\": \"2025-05-09T12:00:00Z\",\n \"sendDate\": \"2025-05-09T12:00:00Z\",\n \"estimatedDeliveryDate\": \"2025-05-15T12:00:00Z\",\n \"deliveryDate\": \"2025-05-15T12:00:00Z\",\n \"totalGrossValue\": 203.63,\n \"ship\": {\n \"totalValue\": 27.95,\n \"buyerValue\": 0,\n \"sellerValue\": 0,\n \"marketplaceValue\": 27.95,\n \"trackingType\": \"KOERICH Logistics\",\n \"logisticType\": \"Normal\"\n },\n \"invoices\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"status\": \"AUTHORIZED\",\n \"type\": \"SALE\",\n \"number\": \"NF-00012345\",\n \"series\": \"A1\",\n \"danfe\": \"78945612309876\",\n \"value\": 203.63\n }\n ],\n \"customer\": {\n \"name\": \"Cliente KOERICH\",\n \"document\": \"000.000.000-00\",\n \"phone\": \"00000000000\",\n \"state\": \"SP\",\n \"city\": \"São Paulo\",\n \"zipCode\": \"00000-000\",\n \"address\": \"Endereço KOERICH\",\n \"addressNumber\": \"0\"\n },\n \"items\": [\n {\n \"sellerSku\": \"10687\",\n \"marketplaceSku\": \"10687\",\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"productTitle\": \"WOLFF - Centro de Mesa de Cristal com Pé Geneva 32cm x 21cm\",\n \"brand\": \"WOLFF\",\n \"unitValue\": 203.63,\n \"shipValue\": 0,\n \"discountValue\": 0,\n \"quantity\": 1,\n \"height\": 0,\n \"width\": 0,\n \"length\": 0,\n \"weight\": 0,\n \"categories\": [\n {\n \"code\": \"GENEVA\",\n \"name\": \"Decoração\",\n \"parentCode\": \"MESA\"\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"method\": \"DEBIT_CARD\",\n \"status\": \"PAID\",\n \"installments\": 1,\n \"value\": 203.63\n }\n ],\n \"extracts\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SALE\",\n \"value\": 203.63,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"COMISSION\",\n \"value\": -24.44,\n \"expectedDate\": \"2025-06-05T12:00:00Z\",\n \"percentage\": 12\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SHIP\",\n \"value\": -27.95,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/order", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] }, "description": "Creates a new order or updates an existing one with complete information. \nUses the same fields as the GET method for order representation.EndFragment" }, "response": [ { "name": "Successfully created/updated order", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"marketplaceId\": \"701-2798273-4005859\",\n \"sequenceId\": \"\",\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"status\": \"PAID_WAITING_DELIVERY\",\n \"createdDate\": \"2025-05-09T12:00:00Z\",\n \"approvedDate\": \"2025-05-09T12:00:00Z\",\n \"sendDate\": \"2025-05-09T12:00:00Z\",\n \"estimatedDeliveryDate\": \"2025-05-15T12:00:00Z\",\n \"deliveryDate\": \"2025-05-15T12:00:00Z\",\n \"totalGrossValue\": 203.63,\n \"ship\": {\n \"totalValue\": 27.95,\n \"buyerValue\": 0,\n \"sellerValue\": 0,\n \"marketplaceValue\": 27.95,\n \"trackingType\": \"KOERICH Logistics\",\n \"logisticType\": \"Normal\"\n },\n \"invoices\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"status\": \"AUTHORIZED\",\n \"type\": \"SALE\",\n \"number\": \"NF-00012345\",\n \"series\": \"A1\",\n \"danfe\": \"78945612309876\",\n \"value\": 203.63\n }\n ],\n \"customer\": {\n \"name\": \"Cliente KOERICH\",\n \"document\": \"000.000.000-00\",\n \"phone\": \"00000000000\",\n \"state\": \"SP\",\n \"city\": \"São Paulo\",\n \"zipCode\": \"00000-000\",\n \"address\": \"Endereço KOERICH\",\n \"addressNumber\": \"0\"\n },\n \"items\": [\n {\n \"sellerSku\": \"10687\",\n \"marketplaceSku\": \"10687\",\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"productTitle\": \"WOLFF - Centro de Mesa de Cristal com Pé Geneva 32cm x 21cm\",\n \"brand\": \"WOLFF\",\n \"unitValue\": 203.63,\n \"shipValue\": 0,\n \"discountValue\": 0,\n \"quantity\": 1,\n \"height\": 0,\n \"width\": 0,\n \"length\": 0,\n \"weight\": 0,\n \"categories\": [\n {\n \"code\": \"GENEVA\",\n \"name\": \"Decoração\",\n \"parentCode\": \"MESA\"\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"method\": \"DEBIT_CARD\",\n \"status\": \"PAID\",\n \"installments\": 1,\n \"value\": 203.63\n }\n ],\n \"extracts\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SALE\",\n \"value\": 203.63,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"COMISSION\",\n \"value\": -24.44,\n \"expectedDate\": \"2025-06-05T12:00:00Z\",\n \"percentage\": 12\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SHIP\",\n \"value\": -27.95,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/order", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Order processed successfully\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"marketplaceId\": \"701-2798273-4005859\",\n \"sequenceId\": \"\",\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"status\": \"PAID_WAITING_DELIVERY\",\n \"createdDate\": \"2025-05-09T12:00:00Z\",\n \"approvedDate\": \"2025-05-09T12:00:00Z\",\n \"sendDate\": \"2025-05-09T12:00:00Z\",\n \"estimatedDeliveryDate\": \"2025-05-15T12:00:00Z\",\n \"deliveryDate\": \"2025-05-15T12:00:00Z\",\n \"totalGrossValue\": 203.63,\n \"ship\": {\n \"totalValue\": 27.95,\n \"buyerValue\": 0,\n \"sellerValue\": 0,\n \"marketplaceValue\": 27.95,\n \"trackingType\": \"KOERICH Logistics\",\n \"logisticType\": \"Normal\"\n },\n \"invoices\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"status\": \"AUTHORIZED\",\n \"type\": \"SALE\",\n \"number\": \"NF-00012345\",\n \"series\": \"A1\",\n \"danfe\": \"78945612309876\",\n \"value\": 203.63\n }\n ],\n \"customer\": {\n \"name\": \"Cliente KOERICH\",\n \"document\": \"000.000.000-00\",\n \"phone\": \"00000000000\",\n \"state\": \"SP\",\n \"city\": \"São Paulo\",\n \"zipCode\": \"00000-000\",\n \"address\": \"Endereço KOERICH\",\n \"addressNumber\": \"0\"\n },\n \"items\": [\n {\n \"sellerSku\": \"10687\",\n \"marketplaceSku\": \"10687\",\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"productTitle\": \"WOLFF - Centro de Mesa de Cristal com Pé Geneva 32cm x 21cm\",\n \"brand\": \"WOLFF\",\n \"unitValue\": 203.63,\n \"shipValue\": 0,\n \"discountValue\": 0,\n \"quantity\": 1,\n \"height\": 0,\n \"width\": 0,\n \"length\": 0,\n \"weight\": 0,\n \"categories\": [\n {\n \"code\": \"GENEVA\",\n \"name\": \"Decoração\",\n \"parentCode\": \"MESA\"\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"method\": \"DEBIT_CARD\",\n \"status\": \"PAID\",\n \"installments\": 1,\n \"value\": 203.63\n }\n ],\n \"extracts\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SALE\",\n \"value\": 203.63,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"COMISSION\",\n \"value\": -24.44,\n \"expectedDate\": \"2025-06-05T12:00:00Z\",\n \"percentage\": 12\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SHIP\",\n \"value\": -27.95,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/order", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Bad Request\",\n \"errorDetails\": [\n {\n \"message\": \"...\"\n }\n ],\n \"errorCode\": \"400-0\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Account not enabled for this channel", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"marketplaceId\": \"701-2798273-4005859\",\n \"sequenceId\": \"\",\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"status\": \"PAID_WAITING_DELIVERY\",\n \"createdDate\": \"2025-05-09T12:00:00Z\",\n \"approvedDate\": \"2025-05-09T12:00:00Z\",\n \"sendDate\": \"2025-05-09T12:00:00Z\",\n \"estimatedDeliveryDate\": \"2025-05-15T12:00:00Z\",\n \"deliveryDate\": \"2025-05-15T12:00:00Z\",\n \"totalGrossValue\": 203.63,\n \"ship\": {\n \"totalValue\": 27.95,\n \"buyerValue\": 0,\n \"sellerValue\": 0,\n \"marketplaceValue\": 27.95,\n \"trackingType\": \"KOERICH Logistics\",\n \"logisticType\": \"Normal\"\n },\n \"invoices\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"status\": \"AUTHORIZED\",\n \"type\": \"SALE\",\n \"number\": \"NF-00012345\",\n \"series\": \"A1\",\n \"danfe\": \"78945612309876\",\n \"value\": 203.63\n }\n ],\n \"customer\": {\n \"name\": \"Cliente KOERICH\",\n \"document\": \"000.000.000-00\",\n \"phone\": \"00000000000\",\n \"state\": \"SP\",\n \"city\": \"São Paulo\",\n \"zipCode\": \"00000-000\",\n \"address\": \"Endereço KOERICH\",\n \"addressNumber\": \"0\"\n },\n \"items\": [\n {\n \"sellerSku\": \"10687\",\n \"marketplaceSku\": \"10687\",\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"productTitle\": \"WOLFF - Centro de Mesa de Cristal com Pé Geneva 32cm x 21cm\",\n \"brand\": \"WOLFF\",\n \"unitValue\": 203.63,\n \"shipValue\": 0,\n \"discountValue\": 0,\n \"quantity\": 1,\n \"height\": 0,\n \"width\": 0,\n \"length\": 0,\n \"weight\": 0,\n \"categories\": [\n {\n \"code\": \"GENEVA\",\n \"name\": \"Decoração\",\n \"parentCode\": \"MESA\"\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"method\": \"DEBIT_CARD\",\n \"status\": \"PAID\",\n \"installments\": 1,\n \"value\": 203.63\n }\n ],\n \"extracts\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SALE\",\n \"value\": 203.63,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"COMISSION\",\n \"value\": -24.44,\n \"expectedDate\": \"2025-06-05T12:00:00Z\",\n \"percentage\": 12\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SHIP\",\n \"value\": -27.95,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/order", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"The account does not have permission to perform operations on this channel\",\n \"errorCode\": \"403-2\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Resource Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"marketplaceId\": \"701-2798273-4005859\",\n \"sequenceId\": \"\",\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"status\": \"PAID_WAITING_DELIVERY\",\n \"createdDate\": \"2025-05-09T12:00:00Z\",\n \"approvedDate\": \"2025-05-09T12:00:00Z\",\n \"sendDate\": \"2025-05-09T12:00:00Z\",\n \"estimatedDeliveryDate\": \"2025-05-15T12:00:00Z\",\n \"deliveryDate\": \"2025-05-15T12:00:00Z\",\n \"totalGrossValue\": 203.63,\n \"ship\": {\n \"totalValue\": 27.95,\n \"buyerValue\": 0,\n \"sellerValue\": 0,\n \"marketplaceValue\": 27.95,\n \"trackingType\": \"KOERICH Logistics\",\n \"logisticType\": \"Normal\"\n },\n \"invoices\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"status\": \"AUTHORIZED\",\n \"type\": \"SALE\",\n \"number\": \"NF-00012345\",\n \"series\": \"A1\",\n \"danfe\": \"78945612309876\",\n \"value\": 203.63\n }\n ],\n \"customer\": {\n \"name\": \"Cliente KOERICH\",\n \"document\": \"000.000.000-00\",\n \"phone\": \"00000000000\",\n \"state\": \"SP\",\n \"city\": \"São Paulo\",\n \"zipCode\": \"00000-000\",\n \"address\": \"Endereço KOERICH\",\n \"addressNumber\": \"0\"\n },\n \"items\": [\n {\n \"sellerSku\": \"10687\",\n \"marketplaceSku\": \"10687\",\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"productTitle\": \"WOLFF - Centro de Mesa de Cristal com Pé Geneva 32cm x 21cm\",\n \"brand\": \"WOLFF\",\n \"unitValue\": 203.63,\n \"shipValue\": 0,\n \"discountValue\": 0,\n \"quantity\": 1,\n \"height\": 0,\n \"width\": 0,\n \"length\": 0,\n \"weight\": 0,\n \"categories\": [\n {\n \"code\": \"GENEVA\",\n \"name\": \"Decoração\",\n \"parentCode\": \"MESA\"\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"method\": \"DEBIT_CARD\",\n \"status\": \"PAID\",\n \"installments\": 1,\n \"value\": 203.63\n }\n ],\n \"extracts\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SALE\",\n \"value\": 203.63,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"COMISSION\",\n \"value\": -24.44,\n \"expectedDate\": \"2025-06-05T12:00:00Z\",\n \"percentage\": 12\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SHIP\",\n \"value\": -27.95,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/order", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"The entity with ID 99999 was not found\",\n \"errorCode\": \"404-1\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Resource Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"marketplaceId\": \"701-2798273-4005859\",\n \"sequenceId\": \"\",\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"status\": \"PAID_WAITING_DELIVERY\",\n \"createdDate\": \"2025-05-09T12:00:00Z\",\n \"approvedDate\": \"2025-05-09T12:00:00Z\",\n \"sendDate\": \"2025-05-09T12:00:00Z\",\n \"estimatedDeliveryDate\": \"2025-05-15T12:00:00Z\",\n \"deliveryDate\": \"2025-05-15T12:00:00Z\",\n \"totalGrossValue\": 203.63,\n \"ship\": {\n \"totalValue\": 27.95,\n \"buyerValue\": 0,\n \"sellerValue\": 0,\n \"marketplaceValue\": 27.95,\n \"trackingType\": \"KOERICH Logistics\",\n \"logisticType\": \"Normal\"\n },\n \"invoices\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"status\": \"AUTHORIZED\",\n \"type\": \"SALE\",\n \"number\": \"NF-00012345\",\n \"series\": \"A1\",\n \"danfe\": \"78945612309876\",\n \"value\": 203.63\n }\n ],\n \"customer\": {\n \"name\": \"Cliente KOERICH\",\n \"document\": \"000.000.000-00\",\n \"phone\": \"00000000000\",\n \"state\": \"SP\",\n \"city\": \"São Paulo\",\n \"zipCode\": \"00000-000\",\n \"address\": \"Endereço KOERICH\",\n \"addressNumber\": \"0\"\n },\n \"items\": [\n {\n \"sellerSku\": \"10687\",\n \"marketplaceSku\": \"10687\",\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"productTitle\": \"WOLFF - Centro de Mesa de Cristal com Pé Geneva 32cm x 21cm\",\n \"brand\": \"WOLFF\",\n \"unitValue\": 203.63,\n \"shipValue\": 0,\n \"discountValue\": 0,\n \"quantity\": 1,\n \"height\": 0,\n \"width\": 0,\n \"length\": 0,\n \"weight\": 0,\n \"categories\": [\n {\n \"code\": \"GENEVA\",\n \"name\": \"Decoração\",\n \"parentCode\": \"MESA\"\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"method\": \"DEBIT_CARD\",\n \"status\": \"PAID\",\n \"installments\": 1,\n \"value\": 203.63\n }\n ],\n \"extracts\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SALE\",\n \"value\": 203.63,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"COMISSION\",\n \"value\": -24.44,\n \"expectedDate\": \"2025-06-05T12:00:00Z\",\n \"percentage\": 12\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SHIP\",\n \"value\": -27.95,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/order", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": {\n \"errorMessage\": \"Internal Server Error\",\n \"errorCode\": \"500-0\",\n \"errorSource\": \"KIE\"\n }\n}" } ] }, { "name": "Get order details", "request": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/order?channelName=KOERICH&accountId=67890&marketplaceCode=701-2798273-4005859", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "query": [ { "key": "channelName", "value": "KOERICH", "description": "(Required) Channel name" }, { "key": "accountId", "value": "67890", "description": "(Required) Account ID" }, { "key": "marketplaceCode", "value": "701-2798273-4005859", "description": "(Required) Unique order code in the marketplace" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] }, "description": "Return all information for a specific order." }, "response": [ { "name": "Order successfully found", "originalRequest": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/order?channelName=KOERICH&accountId=67890&marketplaceCode=701-2798273-4005859", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "accountId", "value": "67890" }, { "key": "marketplaceCode", "value": "701-2798273-4005859" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"marketplaceId\": \"98765\",\n \"sequenceId\": \"\",\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"status\": \"PAID_WAITING_DELIVERY\",\n \"createdDate\": \"2025-05-09T12:00:00Z\",\n \"approvedDate\": \"2025-05-09T12:10:00Z\",\n \"sendDate\": \"2025-05-09T16:00:00Z\",\n \"estimatedDeliveryDate\": \"2025-05-15T12:00:00Z\",\n \"deliveryDate\": \"2025-05-15T12:00:00Z\",\n \"totalGrossValue\": 203.63,\n \"ship\": {\n \"totalValue\": 27.95,\n \"buyerValue\": 0,\n \"sellerValue\": 15,\n \"marketplaceValue\": 27.95,\n \"trackingType\": \"KOERICH Logistics\",\n \"logisticType\": \"Normal\"\n },\n \"invoices\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"status\": \"AUTHORIZED\",\n \"type\": \"SALE\",\n \"number\": \"NFE-000123456\",\n \"series\": \"A1\",\n \"danfe\": \"78945612309876\",\n \"value\": 203.63\n }\n ],\n \"customer\": {\n \"name\": \"Cliente KOERICH\",\n \"document\": \"000.000.000-00\",\n \"phone\": \"00000000000\",\n \"state\": \"SP\",\n \"city\": \"São Paulo\",\n \"zipCode\": \"00000-000\",\n \"address\": \"Endereço KOERICH\",\n \"addressNumber\": \"0\"\n },\n \"items\": [\n {\n \"sellerSku\": \"10687\",\n \"marketplaceSku\": \"10687\",\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"productTitle\": \"WOLFF - Centro de Mesa de Cristal com Pé Geneva 32cm x 21cm\",\n \"brand\": \"WOLFF\",\n \"unitValue\": 203.63,\n \"shipValue\": 0,\n \"discountValue\": 0,\n \"quantity\": 1,\n \"height\": 0,\n \"width\": 0,\n \"length\": 0,\n \"weight\": 0,\n \"categories\": [\n {\n \"code\": \"GENEVA\",\n \"name\": \"Decoração\",\n \"parentCode\": \"MESA\"\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"date\": \"2025-05-09T12:00:00Z\",\n \"method\": \"DEBIT_CARD\",\n \"status\": \"PAID\",\n \"installments\": 1,\n \"value\": 203.63\n }\n ],\n \"extracts\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SALE\",\n \"value\": 203.63,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"COMISSION\",\n \"value\": -24.44,\n \"expectedDate\": \"2025-06-05T12:00:00Z\",\n \"percentage\": 12\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"type\": \"SHIP\",\n \"value\": -27.95,\n \"expectedDate\": \"2025-06-05T12:00:00Z\"\n }\n ]\n}" }, { "name": "Channel does not support import", "originalRequest": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/order?channelName=KOERICH&accountId=67890&marketplaceCode=701-2798273-4005859", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "accountId", "value": "67890" }, { "key": "marketplaceCode", "value": "701-2798273-4005859" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Bad Request\",\n \"errorDetails\": [\n {\n \"message\": \"...\"\n }\n ],\n \"errorCode\": \"400-0\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Account not enabled for this channel", "originalRequest": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/order?channelName=KOERICH&accountId=67890&marketplaceCode=701-2798273-4005859", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "accountId", "value": "67890" }, { "key": "marketplaceCode", "value": "701-2798273-4005859" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"The account does not have permission to perform operations on this channel\",\n \"errorCode\": \"403-2\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Resource Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/order?channelName=KOERICH&accountId=67890&marketplaceCode=701-2798273-4005859", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "accountId", "value": "67890" }, { "key": "marketplaceCode", "value": "701-2798273-4005859" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Order not found. (marketplaceCode: 701-2798273-4005859 - channelName: KOERICH - accountId: 67890)\",\n \"errorCode\": \"404-3\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/order?channelName=KOERICH&accountId=67890&marketplaceCode=701-2798273-4005859", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "accountId", "value": "67890" }, { "key": "marketplaceCode", "value": "701-2798273-4005859" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": {\n \"errorMessage\": \"Internal Server Error\",\n \"errorCode\": \"500-0\",\n \"errorSource\": \"KIE\"\n }\n}" } ] }, { "name": "Delete an order", "request": { "method": "DELETE", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/order?channelName=KOERICH&accountId=67890&marketplaceCode=701-2798273-4005859", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "query": [ { "key": "channelName", "value": "KOERICH", "description": "(Required) Nome do canal" }, { "key": "accountId", "value": "67890", "description": "(Required) ID da conta" }, { "key": "marketplaceCode", "value": "701-2798273-4005859", "description": "(Required) Código único do pedido" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] }, "description": "Removes an order from the system based on the indetifiers." }, "response": [ { "name": "Order successfully deleted", "originalRequest": { "method": "DELETE", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." } ], "url": { "raw": "{{baseUrl}}/api/v3/order?channelName=KOERICH&accountId=67890&marketplaceCode=701-2798273-4005859", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "accountId", "value": "67890" }, { "key": "marketplaceCode", "value": "701-2798273-4005859" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Account not enabled for this channel", "originalRequest": { "method": "DELETE", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/order?channelName=KOERICH&accountId=67890&marketplaceCode=701-2798273-4005859", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "accountId", "value": "67890" }, { "key": "marketplaceCode", "value": "701-2798273-4005859" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"The account does not have permission to perform operations on this channel\",\n \"errorCode\": \"403-2\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Order not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/order?channelName=KOERICH&accountId=67890&marketplaceCode=701-2798273-4005859", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "accountId", "value": "67890" }, { "key": "marketplaceCode", "value": "701-2798273-4005859" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Order not found. (marketplaceCode: 701-2798273-4005859 - channelName: KOERICH - accountId: 67890)\",\n \"errorCode\": \"404-3\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "DELETE", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/order?channelName=KOERICH&accountId=67890&marketplaceCode=701-2798273-4005859", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "order" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "accountId", "value": "67890" }, { "key": "marketplaceCode", "value": "701-2798273-4005859" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": {\n \"errorMessage\": \"Internal Server Error\",\n \"errorCode\": \"500-0\",\n \"errorSource\": \"KIE\"\n }\n}" } ] } ] }, { "name": "reconciliation", "item": [ { "name": "release", "item": [ { "name": "Send release", "request": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"CONCLUDED\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] }, "description": "Enables the sending of an entry for reconciliation creation." }, "response": [ { "name": "Release successfully created", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"CONCLUDED\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Bad request or contains invalid values", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"CONCLUDED\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Bad Request\",\n \"errorDetails\": [\n {\n \"message\": \"...\"\n }\n ],\n \"errorCode\": \"400-0\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Account not enabled for this channel", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"CONCLUDED\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"The account does not have permission to perform operations on this channel\",\n \"errorCode\": \"403-2\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Resource Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"CONCLUDED\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Reconciliation not found\",\n \"errorCode\": \"404-4\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Conflict with existing data", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"CONCLUDED\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Conflict: Same orders already in reconciliation\",\n \"errorCode\": \"409-3\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"CONCLUDED\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": {\n \"errorMessage\": \"Internal Server Error\",\n \"errorCode\": \"500-0\",\n \"errorSource\": \"KIE\"\n }\n}" } ] }, { "name": "Releases batch", "request": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"releaseOrders\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"PAID\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release", "batch" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] }, "description": "Enables the sending of a set of entries for reconciliation creation." }, "response": [ { "name": "Release(s) successfully created", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"releaseOrders\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"PAID\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release", "batch" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Bad request or contains invalid values", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"releaseOrders\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"PAID\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release", "batch" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Bad Request\",\n \"errorDetails\": [\n {\n \"message\": \"...\"\n }\n ],\n \"errorCode\": \"400-0\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Account not enabled for this channel", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"releaseOrders\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"PAID\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release", "batch" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"The account does not have permission to perform operations on this channel\",\n \"errorCode\": \"403-2\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"releaseOrders\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"PAID\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release", "batch" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Reconciliation not found\",\n \"errorCode\": \"404-4\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Conflict with existing data", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"releaseOrders\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"PAID\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release", "batch" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Conflict: Same orders already in reconciliation\",\n \"errorCode\": \"409-3\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reconciliationId\": 12345,\n \"channelName\": \"KOERICH\",\n \"accountId\": 67890,\n \"releaseOrders\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859\",\n \"status\": \"PAID\",\n \"createdDate\": \"2023-01-15T10:30:00Z\",\n \"releasedDate\": \"2023-01-20T08:15:00Z\",\n \"releaseType\": \"IN_CASH\",\n \"installment\": 1,\n \"installmentQuantity\": 1,\n \"releases\": [\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SALE\",\n \"value\": 203.63\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"COMISSION\",\n \"value\": -24.44\n },\n {\n \"marketplaceCode\": \"701-2798273-4005859-1\",\n \"type\": \"SHIP\",\n \"value\": -27.95\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation/release/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation", "release", "batch" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": {\n \"errorMessage\": \"Internal Server Error\",\n \"errorCode\": \"500-0\",\n \"errorSource\": \"KIE\"\n }\n}" } ] } ] }, { "name": "Create a new periodic reconciliation", "request": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channelName\": \"KOERICH\",\n \"accountId\": 54321,\n \"periodInitDate\": \"2024-03-01T00:00:00Z\",\n \"periodEndDate\": \"2024-03-31T23:59:59Z\",\n \"releasesQtd\": 42,\n \"totalNetValue\": 12500.75\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] }, "description": "Creates an aggregated reconciliation for a specific period." }, "response": [ { "name": "Periodic reconciliation successfully created", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channelName\": \"KOERICH\",\n \"accountId\": 54321,\n \"periodInitDate\": \"2024-03-01T00:00:00Z\",\n \"periodEndDate\": \"2024-03-31T23:59:59Z\",\n \"releasesQtd\": 42,\n \"totalNetValue\": 12500.75\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 98765\n}" }, { "name": "Bad request or contains invalid values", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channelName\": \"KOERICH\",\n \"accountId\": 54321,\n \"periodInitDate\": \"2024-03-01T00:00:00Z\",\n \"periodEndDate\": \"2024-03-31T23:59:59Z\",\n \"releasesQtd\": 42,\n \"totalNetValue\": 12500.75\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Bad Request\",\n \"errorDetails\": [\n {\n \"message\": \"...\"\n }\n ],\n \"errorCode\": \"400-0\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Account not enabled for this channel", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channelName\": \"KOERICH\",\n \"accountId\": 54321,\n \"periodInitDate\": \"2024-03-01T00:00:00Z\",\n \"periodEndDate\": \"2024-03-31T23:59:59Z\",\n \"releasesQtd\": 42,\n \"totalNetValue\": 12500.75\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"The account does not have permission to perform operations on this channel\",\n \"errorCode\": \"403-2\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Resource Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channelName\": \"KOERICH\",\n \"accountId\": 54321,\n \"periodInitDate\": \"2024-03-01T00:00:00Z\",\n \"periodEndDate\": \"2024-03-31T23:59:59Z\",\n \"releasesQtd\": 42,\n \"totalNetValue\": 12500.75\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Channel not found\",\n \"errorDetails\": [\n {\n \"message\": \"Channel CHANNEL_NAME not found\"\n }\n ],\n \"errorCode\": \"404-2\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Conflict with existing data", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channelName\": \"KOERICH\",\n \"accountId\": 54321,\n \"periodInitDate\": \"2024-03-01T00:00:00Z\",\n \"periodEndDate\": \"2024-03-31T23:59:59Z\",\n \"releasesQtd\": 42,\n \"totalNetValue\": 12500.75\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Conflict: Existing reconciliation in progress\",\n \"errorCode\": \"409-2\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channelName\": \"KOERICH\",\n \"accountId\": 54321,\n \"periodInitDate\": \"2024-03-01T00:00:00Z\",\n \"periodEndDate\": \"2024-03-31T23:59:59Z\",\n \"releasesQtd\": 42,\n \"totalNetValue\": 12500.75\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/reconciliation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation" ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": {\n \"errorMessage\": \"Internal Server Error\",\n \"errorCode\": \"500-0\",\n \"errorSource\": \"KIE\"\n }\n}" } ] }, { "name": "Get reconciliation details", "request": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/reconciliation?channelName=KOERICH&reconciliationId=54321&accountId=54321", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation" ], "query": [ { "key": "channelName", "value": "KOERICH", "description": "(Required) Nome do canal" }, { "key": "reconciliationId", "value": "54321", "description": "(Required) ID da conciliação" }, { "key": "accountId", "value": "54321", "description": "(Required) ID da conta" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] }, "description": "tReturns information for a specific reconciliation, \nincluding period data, total values, and status." }, "response": [ { "name": "Reconciliation details successfully retrieved", "originalRequest": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/reconciliation?channelName=KOERICH&reconciliationId=54321&accountId=54321", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "reconciliationId", "value": "54321" }, { "key": "accountId", "value": "54321" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12345,\n \"accountName\": \"KOERICH_ACCOUNT_NAME\",\n \"initDate\": \"2025-05-08T12:00:00Z\",\n \"endDate\": \"2025-05-11T12:00:00Z\",\n \"createDate\": \"2025-06-20T13:59:00Z\",\n \"closedDate\": \"2025-06-20T14:00:14Z\",\n \"situation\": \"WAITING\",\n \"status\": \"OPEN\",\n \"channel\": {\n \"id\": \"123\",\n \"name\": \"KOERICH\",\n \"label\": \"KOERICH\",\n \"channelType\": \"MARKETPLACE\"\n },\n \"totalExtracts\": 42,\n \"processedExtracts\": 3\n}" }, { "name": "Account not enabled for this channel", "originalRequest": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/reconciliation?channelName=KOERICH&reconciliationId=54321&accountId=54321", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "reconciliationId", "value": "54321" }, { "key": "accountId", "value": "54321" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"The account does not have permission to perform operations on this channel\",\n \"errorCode\": \"403-2\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Reconciliation not found", "originalRequest": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/reconciliation?channelName=KOERICH&reconciliationId=54321&accountId=54321", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "reconciliationId", "value": "54321" }, { "key": "accountId", "value": "54321" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorMessage\": \"Not Found\",\n \"errorDetails\": [\n {\n \"message\": \"Reconciliation with ID 99999 not found\"\n }\n ],\n \"errorCode\": \"404-4\",\n \"errorSource\": \"KIE\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/reconciliation?channelName=KOERICH&reconciliationId=54321&accountId=54321", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "reconciliation" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "reconciliationId", "value": "54321" }, { "key": "accountId", "value": "54321" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": {\n \"errorMessage\": \"Internal Server Error\",\n \"errorCode\": \"500-0\",\n \"errorSource\": \"KIE\"\n }\n}" } ] } ] }, { "name": "Search accounts associated with the user", "request": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/my-accounts?channelName=KOERICH&page=0&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "my-accounts" ], "query": [ { "key": "channelName", "value": "KOERICH", "description": "(Required) " }, { "key": "page", "value": "0", "description": "(Required) " }, { "key": "limit", "value": "10", "description": "(Required) " } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] }, "description": "Returns a paginated list of marketplace accounts associated with the authenticated user, \nallowing filtering by various criteria such as channel name, account name, etc." }, "response": [ { "name": "List of accounts successfully found", "originalRequest": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/my-accounts?channelName=KOERICH&page=0&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "my-accounts" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "page", "value": "0" }, { "key": "limit", "value": "10" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"page\": {\n \"count\": 3,\n \"offset\": 0,\n \"limit\": 10\n },\n \"accounts\": [\n {\n \"channelName\": \"KOERICH\",\n \"accountName\": \"Loja Principal\",\n \"accountId\": 54321\n },\n {\n \"channelName\": \"KOERICH\",\n \"accountName\": \"Loja Secundária\",\n \"accountId\": 67890\n },\n {\n \"channelName\": \"KOERICH\",\n \"accountName\": \"Loja Internacional\",\n \"accountId\": 11223\n }\n ]\n}" }, { "name": "Invalid search parameters", "originalRequest": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/my-accounts?channelName=KOERICH&page=0&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "my-accounts" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "page", "value": "0" }, { "key": "limit", "value": "10" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": {\n \"errorMessage\": \"Bad Request\",\n \"errorDetails\": [\n {\n \"message\": \"...\"\n }\n ],\n \"errorCode\": \"400-0\",\n \"errorSource\": \"KIE\"\n }\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "gumgaToken", "value": "culpa consequat", "description": "(Required) " }, { "key": "integrator", "value": "urn:uuid:648d5741-f55c-d140-9e4c-3944cd80e9d7", "description": "(Required) Unique UUID identifying the integrator accessing the API." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v3/my-accounts?channelName=KOERICH&page=0&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "my-accounts" ], "query": [ { "key": "channelName", "value": "KOERICH" }, { "key": "page", "value": "0" }, { "key": "limit", "value": "10" } ], "variable": [ { "key": "environment", "value": "{{environment}}", "description": " (This can only be one of production,prod)" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": {\n \"errorMessage\": \"Internal Server Error\",\n \"errorCode\": \"500-0\",\n \"errorSource\": \"KIE\"\n }\n}" } ] } ] } ], "variable": [ { "key": "environment", "value": "production" }, { "key": "baseUrl", "value": "https://api.koncili.com" } ] }