HomeGuidesAPI Reference
Log In
Guides

Pedidos de saída

Os pedidos de saída retiram mercadorias que serão removidas do seu estoque. Podem ser Pedidos de Saída regulares (Operação 1), Pedidos de Saída Segregada (Operação 6) ou Pedidos de Saída de Falta (Operação 8).

Os pedidos são criados por meio do nosso endpoint de Pedidos. A requisição deve ser parecida com esta:

[
  {
    "relatedOrderCode": "4657812",
    "relationalLogisticOperationId": "171",
    "subOperation": "FOOD",
    "relationalEntityId": "5413",
    "operation": 1,
    "typing": "2022-03-28T19:46:59.376Z",
    "whoTyped": "John Doe",
    "orderItems": [
      {
        "relatedProductId": "5487",
        "quantity": 10,
        "itemNumber": 1
      }
    ]
  }
]

Estes são os campos obrigatórios para criar um pedido; você pode ver todos os campos abaixo.

🚧

A API exige obrigatoriamente relatedOrderCode, relationalEntityId, ao menos um item em orderItems e, para cada item, relatedProductId e quantity (maior que zero). Os demais campos marcados como "Sim" abaixo são exigidos por regras de negócio no WMS.

Todos os campos

NomeDescriçãoObrigatórioValor padrão
relatedOrderCodeId do documento no sistema de origem.Sim
relationalLogisticOperationIdId da operação logística no sistema de origem.Sim
operationOperação do pedido: 1 = Saída regular, 6 = Saída Segregada, 8 = Saída de Falta.Sim
subOperationSuboperação do pedido, pode ser qualquer valor, ex.: Venda, Transferência.Sim
reasonSubOperationMotivo da suboperação, pode ser qualquer valor.Não
relationalEntityIdId do cliente no sistema de origem.Sim
typingData de criação no sistema de origem.Sim
whoTypedQuem criou o pedido, pode ser qualquer valor.Sim
orderOriginOrigem do pedido, pode ser qualquer valor.NãoConfigurável no WMS
relationalCarrierCodeId da transportadora no sistema de origem.Não
orderObservationObservações do pedido, pode ser qualquer valor.Não
relationalTitleCodeId da nota fiscal no sistema de origem.Não
invoiceNumberNúmero da nota fiscal (somente Brasil).Não
invoiceSeriesSérie da nota fiscal (somente Brasil).Não
orderItemsItens do pedido, veja aqui.Sim
relationalRecipientCodeId do destinatário no sistema de origem.Não
deliveryAddressTypeIdTipo de endereço de entrega, ex.: Residencial, Comercial.Não
deliveryDistrictBairro do endereço de entrega.Não
deliveryZipCodeCEP do endereço de entrega.Não
deliveryAddressLogradouro de entrega.Não
deliveryAddressComplementComplemento do endereço de entrega.Não
deliveryCityCidade do endereço de entrega.Não
deliveryStateAcronymSigla do estado de entrega, ex.: RJ.Não
deliveryDaysPrazo estimado de entrega em dias.Não
receiverO destinatário.Não
documentuserUm identificador do destinatário.Não
documentObservationTipo de documento do destinatário, pode ser qualquer valor, ex.: RG.Não
receiverphoneTelefone do destinatário.Não
deliveryOrderNoteObservação para o romaneio.Não
formOfPaymentForma de pagamento, ex.: Cartão, Dinheiro.Não
dueDateData prevista de expedição.Não
deadlineData máxima de entrega.Não
urgentOrder1 se o pedido tem prioridade na separação, 0 se não.Não
printInvoiceTrue se a nota fiscal deve ser impressa no WMS.Nãofalse
descriptionShiftDeliveryPode ser qualquer valor, usado para agrupar e priorizar.Não
descriptionRegionDeliveryPode ser qualquer valor, usado para agrupar e priorizar.Não
channelPode ser qualquer valor, usado para agrupar e priorizar.Não
deliveryRouteRota de entrega.Não
obsPreGradeObservação a ser impressa na lista de separação.Não

Itens do pedido

NomeDescriçãoObrigatórioValor padrão
relatedProductIdId do produto no sistema de origem.Sim
quantityQuantidade do produto.Sim
itemNumberNúmero do item no pedido.Sim
itemNoteObservações do item dentro do pedido.Não
minimumValidityValidade mínima em dias.Não
variableQuantityQuantidade variável.Não
standardMeasureMedida padrão.Não
itemInventoryNoteObservações do item a conferir durante a expedição.Não
orderItemVolumeLotsLote a expedir, veja aqui.Não

Volumes de lote

NomeDescriçãoObrigatórioPadrão
originLotLote de origem.Sim
quantityQuantidade do lote.Sim
validityOriginData de validade do lote.Sim
manufacturingDateData de fabricação.Não
itemLotNoteObservações do lote, pode ser qualquer valor.Não
relatedOriginClassificationId da classificação do lote no sistema de origem.Não
variableQuantityQuantidade variável do produto.Não

Para mais informações sobre as propriedades necessárias, consulte a nossa Referência da API aqui.


Did this page help you?