logo
API docs by Redocly

API de Integração OMS PlatinumLog (1.09.06)

Download OpenAPI specification:Download

License: © 2024 - Platinum Log - Não somos parte da solução, somos a solução

Autenticação

URL DE HOMOLOGAÇÃO
Esta URL dará acesso ao ambiente de HOMOLOGACAO e PRODUCAO que será definido pela autenticação fornecida pelo seu contato comercial (e/ou equipe de projetos).

- O ambiente de HOMOLOGAÇÃO é definido pelo uso da conta SANDBOX, no entanto testes de funcionalidades novas poderão ser usado na URL BETA.

- Esta integração se dará através de chamadas REST (método POST) onde entendemos que será postado uma solicitação exigindo uma resposta.

Gerar token

Retorna token dinamico válido por 1h para uso do serviço

Authorizations:
BearerAuth
Request Body schema: application/json
apikey
string

fornecido pelo comercial/projetos Platinum Log

token
string

fornecido pelo comercial/projetos Platinum log

email
string

e-mail autorizado a utilizar o serviço

Responses

Request samples

Content type
application/json
{
  • "apikey": "string",
  • "token": "string",
  • "email": "string"
}

Response samples

Content type
applicatizon/json
{
  • "auth": "YYko8uSVoyF9tGtan+o75AponwE=",
  • "id": "1616516asdda1d26wd1as6"
}

Produto

Endpoints para cadastro, consulta e alteração de produtos.

Cadastrar produtos

Incluir/Alterar/Excluir produtos e KITs

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

token de autorização

Array of objects (DoRegistroProduto)

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "do": [
    ]
}

Response samples

Content type
application/json
{
  • "Retorno": [
    ]
}

Produtos sem Estoque

Retorna os SKUs sem estoque. Onde há pedidos cujo SKU não tenha saldo para atende-lo

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

Responses

Request samples

Content type
application/json
{
  • "auth": "string"
}

Response samples

Content type
application/json
{
  • "stock": {
    }
}

Consultar Estoque

Retorna o saldo atual do estoque de um determinado produto ou de todos os produtos.

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

sku
Array of strings

vetor com os SKUs a serem consultados

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "sku": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "stock": [
    ]
}

Consultar Estoque por período

Retorna o saldo atual do estoque de um determinado produto ou de todos os produtos.

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

start
string

data inicial do periodo (dd/mm/yyyy) - padrao 7 dias atrás

end
string

data final do periodo (dd/mm/yyyy) - padrao hoje

resume
integer

inteiro – para saber se mostra o resumo ocorrido antes do “start” (0/nao, 1/sim)

Array of objects

vetor com os SKUs a serem consultados

Responses

Request samples

Content type
application/json
{
  • "auth": "YYko8uSVoyF9tGtan+o75AponwE=",
  • "start": "01/02/2024",
  • "end": "07/01/2024",
  • "resume": 0,
  • "sku": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "stock": [
    ]
}

Entrada

Endpoints para cadastro, consulta e alteração de entradas.

Cadastrar Entrada

Envia nota fiscal de compra (para entrada de mercadorias)

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

required
object (InvoiceDetail)

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "invoice": {
    }
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "OK",
  • "id": 568515
}

Enviar XML

Envia nota fiscal de compra (para entrada de mercadorias)

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

object (OrderXMLDetail)

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "Mensagem": "Arquivo recebido"
}

Consultar Entrada

Busca a situação da nota de entrada

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

object (PurchaseDetailList)

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "invoice": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "id": 0,
  • "detail": [
    ],
  • "items": [
    ]
}

Pedido

Endpoints para cadastro, consulta e alteração de pedidos.

Cadastrar pedido

Cadastrar Pedido para separação da Platinum Log

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

object (OrderPutDetail)

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "Pedido Cadastrdo",
  • "id": 1,
  • "stock": 0,
  • "missing": "Pedido Cadastrdo"
}

Cadastrar Pedido por XML

Gera um pedido a partir dos dados de um XML de NFe.

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

required
object (InvoiceDetail)

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "invoice": {
    }
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "Pedido Cadastrdo",
  • "id": 1,
  • "stock": 0,
  • "missing": "Pedido Cadastrdo"
}

Cancelar Pedido

Apaga um pedido da base Enivix

Authorizations:
BearerAuth
Request Body schema: application/json
auth
required
string

chave obtida no método get/auth

id
required
string

identificação única do pedido retornando por put/order

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "pedido excluido com sucesso"
}

Consultar Pedido

Busca a situação do pedido (detalhado com informações de transporte)

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

object (OrderDetailList)

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "order": {
    }
}

Consultar Situação do Pedido

Busca a situação do pedido (detalhado com informações de transporte)

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

object

base64 do arquivo contendo a etiqueta

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "order": {
    }
}

Listar Pedidos

Retorna o saldo atual do estoque de um determinado produto ou de todos os produtos.

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

token de autenticacao

begin
Array of arrays

data – d/m/aaaa – inicial de insercao do pedido na Platinum

end
string

data – d/m/aaaa – final de insercao do pedido na Platinum

Responses

Request samples

Content type
application/json
{
  • "auth": "16asd168dasd32465as1d12esx154",
  • "begin": "01/05/2022",
  • "end": "10/05/2022"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "list": [
    ]
}

Listar Pedidos por Transportadora

RRetorna uma lista com os pedidos recebidos em um determinado periodo de uma determinada transportadora

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

begin
Array of arrays

data – d/m/aaaa – inicial de insercao do pedido na Platinum

end
string

data – d/m/aaaa – final de insercao do pedido na Platinum

carrier
integer

id da transportadora (fornecido pela ENIVIX)

Responses

Request samples

Content type
application/json
{
  • "auth": "16asd168dasd32465as1d12esx154",
  • "begin": "01/05/2022",
  • "end": "10/05/2022",
  • "carrier": 50
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "list": [
    ]
}

Listar Pedidos ERP

Retorna o saldo atual do estoque de um determinado produto ou de todos os produtos.

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

status
integer

inteiro - 0/nao lido, 1/lido, 2/todos

order
string

texto - numero do pedido

invoice
integer

inteiro - numero da nota fiscal

begin
Array of arrays

data – d/m/aaaa – inicial de insercao do pedido na Platinum

end
string

data – d/m/aaaa – final de insercao do pedido na Platinum

Responses

Request samples

Content type
application/json
{
  • "auth": "16asd168dasd32465as1d12esx154",
  • "status": 0,
  • "order": 50807,
  • "invoice": 105050,
  • "begin": "01/05/2022",
  • "end": "10/05/2022"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": 200,
  • "qty": 780,
  • "list": [
    ]
}

Transporte

Endpoints para BID, Tracking

Inserir Tracking

Insere o tracking (correio ou outras transportadoras) no pedido de forma ativa

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

token de autorização

Responses

Request samples

Content type
application/json
{
  • "auth": "string"
}

Response samples

Content type
application/json
{
  • "code": "200",
  • "messagem": "TRACKING INSERIDO COM SUCESSO",
  • "id": 99999,
  • "stock": 99999
}

BID

Retorna a cotação do gateway de frete da Platinum Log.

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

to
string

chave obtida no método get/auth

weight
string

peso em gramas

value
string

valor total da compra (sem o frete)

object (ProductsIDimensions)
object (ProductsItems)
object (ProductsBid)

Responses

Request samples

Content type
application/json
{
  • "auth": "xcvwsvsdvsdvsd",
  • "to": "Fulano de Tal",
  • "weight": 150,
  • "value": 599,
  • "dimensions": {
    },
  • "items": {
    },
  • "products": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Buscar Transportadoras

Retorna o nome e ID das transportadoras habilitadas para o cliente

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

Responses

Request samples

Content type
application/json
{
  • "auth": "string"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "carriers": {
    }
}

Documento

Endpoints para envio de notas e etiquetas

Cadastrar Documento

Permite anexar um documento ao pedido para impressao no CHECKOUT

Authorizations:
BearerAuth
Request Body schema: application/json
auth
required
string

chave obtida no método get/auth

key
required
string

chave da nota fiscal

order
required
string

numero do pedido

document
required
string

PDF em base64 do documento

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "key": "string",
  • "order": "string",
  • "document": "string"
}

Response samples

Content type
application/json
{
  • "code": "Arquivo recebido",
  • "message": "Arquivo recebido"
}

Cadastrar Etiqueta

Vincula uma etiqueta ao pedido

Authorizations:
BearerAuth
Request Body schema: application/json
auth
required
string

chave obtida no método get/auth

label
required
string

base64 do arquivo contendo a etiqueta

style
required
string

inteiro - codigo do estilo de etiqueta

id
required
string

inteiro - codigo interno do pedido

idFrom
required
string

Permite que a etiquta seja vinculada ao id do canal informado (omie, meli, vtex, bling, millenium, tiny)

idNumber
required
string

id vinculado a origem do campo idFrom

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "label": "string",
  • "style": "string",
  • "id": "string",
  • "idFrom": "string",
  • "idNumber": "string"
}

Response samples

Content type
application/json
{
  • "Mensagem": "Arquivo recebido"
}

Webhook

Endpoints com gatilhos e envios para o servidor do cliente

Cadastrar Trigger

GATILHOS VALIDOS:

RECUSADO - recusado pelo destinatario
AGUARDANDO NOTA - aguardando NF
AGUARDANDO WMS - pedido no OMS aguardando envio para o WMS
AGUARDANDO PICKING - separacao efetuada pronto para checkout
CHECKOUT - checkout efetuado no CD proto para coleta
EM TRANSITO - pedido em transito conforme indicativo da transportadora
ENTREGUE - pedido entregue ao destinatario
ROUBADO - roubo/furto de carga
DEVOLVIDO - devolvido a origem
EXTRAVIO - pedido extraviado
CANCELADO - pedido cancelado

Authorizations:
BearerAuth
Request Body schema: application/json
auth
string

chave obtida no método get/auth

Array of objects (TriggerPut)

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "map": [
    ]
}

Response samples

Content type
application/json
{
  • "auth": "string",
  • "map": []
}