{"info":{"_postman_id":"3282507f-be1c-4361-b0f6-ecbeca936ee9","name":"TrackCash API (Marketplace)","description":"

Esta documentação tem como objetivo explicar o funcionamento da integração de novos\nMarketplaces e Meios de Pagamento na ferramenta TrackCash para o cadastro de pedidos\nna plataforma.

\n

Partes interessadas

\n

Marketplaces e Meios de pagamento que queiram se integrar a TrackCash para oferecer\nnossas soluções aos seus clientes.

\n

Formato de dados

\n

No cabeçalho da requisição você precisará enviar duas informações: Content-Type que definirá o tipo de requisição - neste caso usaremos o formato json.

\n

Padronização

\n

Por convenção todos os valores identificados como decimais nesta documentação deverão ser enviados como valor inteiro, portanto considere a operação (valor * 100) para os\nvalores enviados.

\n

O padrão de data utilizado para a comunicação é o formato ISO 8601, onde usa-se:\nYYYY-MM-DD para campos que recebem a data.

\n

Autenticação

\n

Para a autenticação utilizaremos o modelo Basic Autentication, basicamente você precisará combinar o Usuário e Senha (Administrador) e criptografar via code_64, o resultado será enviado no header (cabeçalho) da solicitação como token.

\n

Vamos imaginar que seu usuário seja teste@meuemail.com e sua senha mudar123

\n

ficará assim:$token = base64_encode('teste@meuemail.com:mudar123');

\n

A saída será: dGVzdGVAbWV1ZW1haWwuY29tOm11ZGFyMTIz

\n

Tabelas auxiliares

\n
(id_status)
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
IDStatus
1Não Identificado
2Aguardando Pagamento
3Processando
4Enviado
5Entregue
6Cancelado
7Troca
8Devolução
9Não Relacionado
10Pedido incompleto
\n
(id_channel, shipment_method e payment_method)
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
IDCanal
1Amazon
6Magazine Luiza
12Mercado Livre
13Cnova
14Carrefour
15Netshoes
100B2w
101Leroy Merlin
113Madeira Madeira
114Dafiti
141Pagseguro
142Wirecard
143Pagar.me
144Zoom
159GetNet
160Redecard
165Cielo
169Ticket
172Sodexo
179VR Benefícios
196Stone
202SafraPay
431Alpe
443Ame
444Shopee
\n
(shipment_service)
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
IDTipo de serviço
60Magalu Entregas
101B2w Entregas
120ME1
121ME2
1401JAD LOG CAP
1402JAD LOG INT Agendada
1561PAC
1562SEDEX
1563SEDEX 10
1564SEDEX 12
1565SEDEX HOJE
4341Transfolha Terrestre
4351VTEXLOG CARRIERS
4361TEX COURIER E
4362TEX COURIER E1
4363TEX COURIER E2
4364TEX COURIER E3
4365TEX COURIER S
4366TEX COURIER S1
4371Ontime Normal
4372Ontime Diferenciada
\n
(payment_brand)
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
IDTipo de Pagamento
3Débito
4Débito parcelado
10Crédito parcelado
15Crédito a vista
16Voucher
17Voucher parcelado
19Boleto
\n
(payment_brand)
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
IDBandeira
1Visa
2Mastercard
3Hipercard
4Banricompras
5Amex
6Cabal
7Elo
8Sorocred
9Diners
10Discover
11Aura
12Sicredi
13Mais
14CUP
15Ticket
16Sodexo
17Planvale
18Goodcard
19Greencard
20Agiplan
21Banescard
22Credsystem
23Esplanada
24CredZ
25Alelo Alimentação
26Alelo Refeição
27Elo Alimentação
28Elo Refeição
29Ticket Alimentação
30Ticket Refeição
31Sodexo Gift/Premium
32Sodexo Alimentação
33Sodexo Refeição
34DMCard
35Verocheque
36VR Benefícios
37Policard
38Valecard
39BIN (first data)
40Personalcard
41Flex Car
45Convcard
47Alelo Auto
48Avista
50Bahamascard
51Sodexo Gift Pass
52JCB
53Verdecard
54Hiper
55Tricard
56Hiper/Hipercard
57Valemais
59Refeisul
61Abrapetite
62Valeshop
63Bradescard
64Brasilcard
65Coopercred
66Maxxcard
67BIQ
68Siscred
69Convenios card
70Use card
71Orgcard
72Sincard
73ECXCard
74Banestes
76Comprocard
77Nutricash
78Club+
81Credicesta
82Fortbrasil
83Convênios Card
84Ourocard
85Infocards
86Banricard
87Mvcard
88Banese
89Usecred
92Banestik
93Credishop
95Sindplus
96Eucard
98008 Cards
101Unocard
107Personalnet
108Visa Vale
109Plantão Card
110VR Alimentação
111VR Auto
112VR Cultura
113VR Refeição
\n
(id_code)
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
IDPagamento
1Frete não encontrado
2Frete reverso
3Frete encontrado
4Serviços Adicionais
5Frete Grátis
6Reverso não encontrado
7Venda
8Comissão
9Frete Marketplace
10Devoluções
11Comissão sobre Devolução
12Devolução de Comissões
13Antecipação
14Custo por Antecipações
15Cashback
16Disputas
17Retirada/Transferência
18Custo sobre retirada/trasferência
19Processos judiciais
20Declarações bancárias
21Outras ocorrências de crédito/débito
22Previsão de Pagamento
23Previsão de Comissão
71Pagamento ao Fornecedor
81MDR
82Taxa fixa
231Previsão de MDR
232Imposto de Renda
233Previsão de Pagamento ao Fornecedor
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Partes interessadas","slug":"partes-interessadas"},{"content":"Formato de dados","slug":"formato-de-dados"},{"content":"Autenticação","slug":"autenticacao"},{"content":"Tabelas auxiliares","slug":"tabelas-auxiliares"}],"owner":"14060043","collectionId":"3282507f-be1c-4361-b0f6-ecbeca936ee9","publishedId":"Tzm9kajM","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-07-14T17:14:40.000Z"},"item":[{"name":"Pedido","item":[{"name":"Cadastrar Pedido","id":"63efb632-5242-4446-ac09-3c64c053f276","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"id_store\": 2,\n \"id_channel\": 144,\n \"id_account\": 1,\n \"id_order\": \"2636059069\",\n \"reference\": \"2636059069\",\n \"original_status\": \"Canceled\",\n \"id_status\": 6,\n \"date\": \"2021-06-01\",\n \"products\": [\n {\n \"product_id\": \"2125802\",\n \"product_sku\": \"2125802\",\n \"product_description\": \"Caixa Som Port\\u00e1til Bluetooth Multilaser SP336 200W RMS Mini Torre USB Auxiliar SD Encaixe Para Trip\\u00e9\",\n \"product_category\": \"N\\u00e3o Informada\",\n \"product_total\": 39990,\n \"product_total_cost\": null,\n \"product_total_discount\": 0,\n \"product_total_fee\": null,\n \"product_width\": null,\n \"product_height\": null,\n \"product_length\": null,\n \"product_weight\": null\n }\n ],\n \"shipments\": [\n {\n \"shipment_id\": \"2636059069\",\n \"shipment_method\": 144,\n \"shipment_service\": \"N\\u00e3o Relacionada\",\n \"shipment_code\": \"\",\n \"shipment_status\": 1,\n \"shipment_total\": 2599,\n \"shipment_total_discount\": null,\n \"shipment_total_fee\": null,\n \"shipment_send_date\": null,\n \"shipment_estimate_date\": null,\n \"shipment_delivery_date\": null\n }\n ]\n }\n]"},"url":"https://sistema.trackcash.com.br/api/mkp/orders","description":"

Pedidos

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NomeTipoDescriçãoObrigatório
id_storeIntID que identifica loja na TCSim
id_channelIntIdentificação do canal na TC. Tabela 2Sim
id_accountIntID que identifica conta dentro do canalSim
id_orderStringNúmero do pedido no canalSim
original_statusStringStatus original dentro do canalSim
id_statusTipoDescriçãoSim
NomeIntID do status TC. Tabela 1Sim
dateDateTimeEx: 2021-07-19 14:30:59Sim
\n

Produtos

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NomeTipoDescriçãoObrigatório
product_idStringID que identifica item vendidoSim
product_skuStringSKU identificar do itemSim
product_descriptionStringNome do itemNão
product_categoryStringCategoria do itemNão
product_totalDecimalValor total do item. Considerar quantidade * valor unitárioSim
product_total_costDecimalValor total do item a preço de custo. Considerar quantidade * valor unitárioNão
product_discountDecimalValor de desconto do item. Considerar quantidade * valor unitárioNão
product_feeDecimalValor total da comissão sobre o itemNão
product_widthDecimalLargura do item. Enviar em centímetrosNão
product_heightDecimalAltura do item. Enviar em centímetrosNão
product_lengthDecimalComprimento do item. Enviar em centímetrosNão
product_weightDecimalPeso do item. Enviar em gramasNão
\n

Shipments

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NomeTipoDescriçãoObrigatório
shipment_idStringID que identifica o envioSim
shipment_methodIntMétodo de envio. Tabela 2
shipment_serviceIntServiço de envio. Tabela 3
shipment_codeStringCódigo de rastreio do envio
shipment_statusIntStatus do envio. Tabela 1
shipment_totalDecimalValor total do envioSim
shipment_total_discountDecimalValor total de desconto sobre o envio
shipment_total_feeDecimalValor total da comissão sobre o envio
shipment_send_dateDateData do envio. Ex: 2021-07-19
shipment_estimate_dateDatePrevisão de entrega. Ex: 2021-07-19
shipment_delivery_dateDateData de entrega. Ex: 2021-07-19
\n

Payments

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NomeTipoDescriçãoObrigatório
payment_idStringID que identifica o pagamento do cliente finalSim
payment_methodIntMétodo de pagamento utilizado na efetivação da compra. Tabela 2
payment_serviceIntServiço utilizado durante pagamento. Tabela 4
payment_brandIntBandeira utilizada na efetivação do pagamento. Tabela 5
payment_installmentsIntNúmero de parcelas existentes no pedido. Enviar 1 para pagamento à vista.
payment_statusIntStatus do pagamento. 0 = Pagamento pendente 1 = Pagamento realizado
payment_totalDecimalValor total do pagamentoSim
payment_total_discountDecimalValor total do desconto sobre o pagamento
payment_total_feeDecimalValor total da comissão sobre pagamento
payment_total_rateDecimalValor total dos juros pago pelo cliente
payment_due_dateDateData de vencimento. Ex: 2021-07-19
payment_confirmed_dateDateData de efetivação do pagamento. Ex: 2021-07-19Sim
\n

Invoices

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NomeTipoDescriçãoObrigatório
invoice_idIntNúmero da nota fiscal
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":"dGVzdGVAYXBpLmNvbS5icjp0ZXN0ZTEyMw=="}]},"isInherited":true,"source":{"_postman_id":"3282507f-be1c-4361-b0f6-ecbeca936ee9","id":"3282507f-be1c-4361-b0f6-ecbeca936ee9","name":"TrackCash API (Marketplace)","type":"collection"}},"urlObject":{"path":["api","mkp","orders"],"host":["https://sistema.trackcash.com.br"],"query":[],"variable":[]}},"response":[],"_postman_id":"63efb632-5242-4446-ac09-3c64c053f276"}],"id":"a40536c0-a525-4076-ad9c-78121efb6466","_postman_id":"a40536c0-a525-4076-ad9c-78121efb6466","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":"dGVzdGVAYXBpLmNvbS5icjp0ZXN0ZTEyMw=="}]},"isInherited":true,"source":{"_postman_id":"3282507f-be1c-4361-b0f6-ecbeca936ee9","id":"3282507f-be1c-4361-b0f6-ecbeca936ee9","name":"TrackCash API (Marketplace)","type":"collection"}}},{"name":"Repasses","item":[{"name":"Cadastrar Repasses","id":"1df8eee1-49dc-4089-9d61-1b1e088632d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"id_store\": \"611\",\n \"id_channel\": \"432\",\n \"id_account\": \"1\",\n \"id_order\": \"123\",\n \"id_withdrawal\":\"999\",\n \"id_code\": \"7\",\n \"reference\":\"\",\n \"description\":\"Pagamento\",\n \"date\":\"2021-01-12\",\n \"installments\":\"1\",\n \"current_installment\":\"1\",\n \"total\":\"20000\"\n },\n {\n \"id_store\": \"611\",\n \"id_channel\": \"432\",\n \"id_account\": \"1\",\n \"id_order\": \"456\",\n \"id_withdrawal\":\"999\",\n \"id_code\": \"8\",\n \"reference\":\"\",\n \"description\":\"Comissão\",\n \"date\":\"2021-01-12\",\n \"installments\":\"1\",\n \"current_installment\":\"1\",\n \"total\":\"-1000\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://sistema.trackcash.com.br/api/mkp/payments","description":"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NomeTipoDescriçãoObrigatório
id_storeIntID da lojaSim
id_channelIntID do canalSim
id_accountIntID da contaSim
id_orderIntID do pedidoSim
id_withdrawalIntIdentificação de saqueSim
id_codeIntStatus de pagamentoSim
referenceStringDiferenciar linhas identicasNão
descriptionStringDescrição do pagamentoSim
dateDateData de pagamentoSim
installmentsIntQuantidade de parcelasSim
current_installmentsIntParcelas a serem execultadasSim
totalDecimalTotal do pagamentoSim
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":"dGVzdGVAYXBpLmNvbS5icjp0ZXN0ZTEyMw=="}]},"isInherited":true,"source":{"_postman_id":"3282507f-be1c-4361-b0f6-ecbeca936ee9","id":"3282507f-be1c-4361-b0f6-ecbeca936ee9","name":"TrackCash API (Marketplace)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","mkp","payments"],"host":["sistema","trackcash","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"1df8eee1-49dc-4089-9d61-1b1e088632d2"}],"id":"d2842720-c9ba-4f10-b34c-3c92b4febb2b","_postman_id":"d2842720-c9ba-4f10-b34c-3c92b4febb2b","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":"dGVzdGVAYXBpLmNvbS5icjp0ZXN0ZTEyMw=="}]},"isInherited":true,"source":{"_postman_id":"3282507f-be1c-4361-b0f6-ecbeca936ee9","id":"3282507f-be1c-4361-b0f6-ecbeca936ee9","name":"TrackCash API (Marketplace)","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":"dGVzdGVAYXBpLmNvbS5icjp0ZXN0ZTEyMw=="}]}},"event":[{"listen":"prerequest","script":{"id":"fb3daf08-cd07-45d1-aa90-3fb536db4a0b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bede92d3-dd93-44e5-b02b-0971606cbf3d","type":"text/javascript","exec":[""]}}],"variable":[{"key":"url","value":"https://sistema.trackcash.com.br"},{"key":"token","value":"dGVzdGVAYXBpLmNvbS5icjp0ZXN0ZTEyMw=="}]}