Pular para o conteúdo
platform
PT EN

Referência da API

Pedidos

Serviços para consulta e gerenciamento de pedidos.

Gestão loja

  • GET Listar Pedidos da Loja /partnerOrders/list

    Lista os pedidos em que a sua loja é a fornecedora, os que você recebeu para atender, do mais recente para o mais antigo, com paginação e filtros.

  • GET Buscar Detalhes do Pedido - Loja /partnerOrders/:id

    Devolve o pedido inteiro: valores, cliente, pagamentos, entregas com os produtos, e o histórico de status.

  • PUT Atualizar Status do Pedido - Loja /partnerOrders/:id

    Move o pedido para o próximo status do fluxo de atendimento e grava, junto, os dados que aquele status exige, o número do pedido no seu ERP, a nota fiscal, o código de rastreio.

  • GET Listar Itens com Lead Time Sob Consulta /partnerOrders/:id/partnerOrderLines

    Lista os produtos do pedido cujo prazo de entrega ficou sob consulta e ainda não foi preenchido. É a fila de itens que dependem de você informar o prazo antes de o pedido seguir.

  • PUT Atualizar Lead Time dos Itens /partnerOrders/:id/partnerOrderLines

    Informa o prazo de preparo dos itens que ficaram com o prazo sob consulta. É este envio que libera o pedido para o pagamento: respondidos os prazos, o cliente é avisado de que o pedido está disponível.

  • PUT Upload de XML da Nota Fiscal - Loja /partnerOrders/:id/invoice

    Anexa o XML da nota fiscal ao pedido. O corpo da requisição é o próprio arquivo, enviado como conteúdo binário, o stream cru dos bytes do.xml. Não é multipart/form-data, não há campo de formulário e o XML não vai dentro de um JSON.

  • POST Enviar Acompanhamento dos Itens - Loja /partnerOrders/:id/complementaryInfo

    Informa, item a item, em que situação está cada produto do pedido, o que já saiu, o que está sendo preparado, o que ficou pendente. É o acompanhamento que o cliente vê durante o atendimento.

  • GET Consultar Acompanhamento dos Itens - Loja /partnerOrders/:id/complementaryInfo

    Devolve o acompanhamento dos itens que está gravado no pedido, o conjunto ativo.

  • DELETE Remover Acompanhamento dos Itens - Loja /partnerOrders/:id/complementaryInfo

    Apaga o acompanhamento dos itens do pedido, inteiro, todas as peças, todas as situações. O pedido volta a não ter acompanhamento nenhum.

Gestão Marketplace

  • GET Listar Pedidos do Marketplace /partnerOrders/list/store

    Lista os pedidos originados na sua loja, os que os seus clientes fizeram, incluindo os que serão atendidos por outros parceiros, do mais recente para o mais antigo, com paginação e filtros.

  • GET Buscar Detalhes do Pedido - Marketplace /partnerOrders/store/:id

    Devolve o pedido inteiro de um pedido originado na sua loja: valores, cliente, pagamentos, entregas com os produtos, e o histórico de status.

  • GET Listar Pedidos Filhos por Pedido Pai /partnerOrders/store/order/:id

    Lista os pedidos de parceiro que nasceram de um mesmo pedido do cliente. Um pedido com itens de fornecedores diferentes é dividido em um pedido de parceiro por fornecedor, e é essa divisão que esta rota devolve.

  • PUT Atualizar Status do Pedido - Marketplace /partnerOrders/store/:id

    Permite que a loja de origem mova para o próximo status um pedido que nasceu nela, gravando junto os dados que aquele status exige.

  • PUT Upload de XML da Nota Fiscal - Marketplace /partnerOrders/store/:id/invoice

    Permite que a loja de origem anexe o XML da nota fiscal a um pedido que nasceu nela. O corpo da requisição é o próprio arquivo, enviado como conteúdo binário, o stream cru dos bytes do.xml. Não é multipart/form-data, não há campo de formulário e o XML não vai dentro de um JSON.

  • POST Enviar Acompanhamento dos Itens - Marketplace /partnerOrders/store/:id/complementaryInfo

    Permite que a loja de origem informe, item a item, em que situação está cada produto de um pedido que nasceu nela.

  • GET Consultar Acompanhamento dos Itens - Marketplace /partnerOrders/store/:id/complementaryInfo

    Devolve o acompanhamento dos itens de um pedido originado na sua loja, o conjunto ativo.

  • DELETE Remover Acompanhamento dos Itens - Marketplace /partnerOrders/store/:id/complementaryInfo

    Apaga, inteiro, o acompanhamento dos itens de um pedido originado na sua loja.

Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.