APIs de ordem de contrato

Sterling™ Order Management O sistema fornece APIs para gerenciamento de contratos. Como desenvolvedor ou integrador de sistemas, você pode usar essas informações para conectar casos de uso e ações às respectivas APIs.

Ordens de contrato

A ordem do contrato descreve os termos e as condições do acordo. Por exemplo, os produtos e a quantidade a ser entregue, as datas de entrega recorrentes e os endereços de cobrança e envio. Você também pode ver as ações importantes que são suportadas pelos recursos avançados business-to-business ( B2B ) no sistema Sterling Order Management para entender as APIs que são usadas para executar essas ações. Em um cenário B2B, um contrato entre empresas ajuda a garantir que ambas as partes cumpram suas obrigações e compromissos. O gerenciamento eficaz de contratos é fundamental nos relacionamentos B2B, pois afeta diretamente a receita, a satisfação do cliente e as parcerias de longo prazo.

Uma ordem de contrato por negociação é usada para criar ordens do cliente. As ordens de vendas podem ser geradas automaticamente com base no cronograma de entrega do contrato ou criadas manualmente pelos usuários quando necessário.

Os casos de uso do sistema Sterling Order Management a seguir mostram quais APIs devem ser usadas para realizar as ações descritas relacionadas a ordens de contrato. Para obter mais informações sobre APIs de ordem de contrato, consulte Acesso à documentação relacionada ao desenvolvimento.

Ações de precificação

  • Criar ou gerenciar uma lista de preços para pedidos de contrato

    Criar ou gerenciar listas de preços que incluam preços de itens negociados para pedidos de contrato.

    managePricelistHeader API

  • Adicionar ou modificar linhas da lista de preços

    managePricelistLine API

  • Atribuir uma lista de preços a um comprador

    managePricelistAssignment API

  • Atribuir uma lista de preços a um vendedor

    managePricelistSellerAssignment API

  • Recuperar uma lista de listas de preços de contratos

    Recupera as listas de preços de contrato que podem ser usadas para criar um pedido de contrato para um comprador.

    getAssignedPricelistHeaderList API

Ações de ordem de contrato

  • Criar uma ordem de contrato

    createOrder API

  • Modificar uma ordem de contrato
    changeOrder API
  • Fechar uma ordem de contrato

    Conclua uma ordem de contrato depois que os pedidos de vendas forem feitos para todas as quantidades da linha de pedido ou feche a ordem de contrato antecipadamente antes que todos os pedidos de vendas sejam feitos. As linhas de ordens de contrato que foram totalmente solicitadas são Concluídas e as linhas de ordens de contrato que foram parcialmente solicitadas são Encerradas.

    closeContractOrder API

  • Alterar o status de uma ordem de contrato não confirmada

    Registre o progresso da negociação alterando o status da ordem de contrato de uma ordem de contrato não confirmada. Por exemplo, rejeitar ou aprovar as alterações feitas na ordem do contrato.

    changeOrderStatus API

  • Excluir uma ordem de contrato não confirmada ou suas linhas de ordem de contrato

    deleteOrderAPI API

  • Confirmar uma minuta de ordem de contrato e suas linhas de ordem de contrato

    Durante o processo de confirmação, várias validações são realizadas, incluindo verificações com detalhes do produto, direitos e preços de linha.

    confirmContractOrder API

  • Cancelar uma ordem de contrato ou suas linhas de ordem de contrato

    O cancelamento de uma ordem de contrato confirmada só é permitido se as entregas não forem iniciadas para nenhum dos itens de linha da ordem de contrato. Use essa API para cancelar uma ordem de contrato confirmada ou qualquer uma de suas linhas de ordem de contrato.

    changeOrder API

  • Recuperar uma lista de ordens de contrato que correspondem aos critérios de pesquisa

    Recupere a lista de ordens de contrato que correspondem aos critérios de pesquisa que você especificar.

    getContractOrderList API

  • Recuperar detalhes da ordem do contrato

    Recuperar detalhes da ordem de contrato sem incluir as linhas de contrato individuais.

    getContractOrderDetails API

  • Modificar uma ordem de contrato para adicionar ou revisar as informações do cabeçalho da lista de preços

    changeOrder API

  • Pausar temporariamente as entregas de uma ordem de contrato confirmada.

    Interromper temporariamente as entregas de uma ordem de contrato. Isso é útil quando as entregas futuras precisam ser temporariamente interrompidas sem modificar as programações de linhas de ordens de contrato configuradas ou excluir as linhas de entrega que já estão programadas. A ordem do contrato deve estar no estado Confirmado para essa ação.

    pauseContractOrderSchedule API

  • Retomar as entregas de uma ordem de contrato cujas solicitações de remessa foram pausadas temporariamente.

    Retomar as entregas de uma ordem de contrato que foi temporariamente pausada. Quando essa API é chamada, o estado da ordem de contrato é alterado para Confirmado, permitindo que o sistema crie linhas programadas para entrega com base nas programações de linha da ordem de contrato configuradas nas linhas da ordem de contrato.

    resumeContractOrderSchedule API

Ações de linha de ordem de contrato

  • Adicionar ou modificar linhas de ordem de contrato

    changeOrder API

  • Excluir linhas de ordem de contrato de uma ordem de contrato não confirmada

    deleteOrder API

  • Recuperar uma lista de linhas de ordens de contrato

    Recuperar a lista de linhas de ordens de contrato que correspondem aos critérios de pesquisa que você especificar.

    getContractOrderLineList API

  • Recuperar os detalhes de uma linha de ordem de contrato

    getContractOrderLineDetails API

  • Modificar uma linha de ordem de contrato para revisar o preço unitário

    changeOrder API

  • Adicionar uma programação de recorrência para uma linha de ordem de contrato

    createContractOrderLineSchedule API

  • Recuperar uma lista de programações de recorrência de linha de ordem de contrato

    Recupere a lista de programações de recorrência de linha de ordem de contrato que correspondem aos critérios de pesquisa que você especificar.

    getContractOrderLineScheduleList API

  • Modificar uma programação de recorrência para uma linha de ordem de contrato

    Modificar a programação de recorrência de uma linha de ordem de contrato para vários requisitos. Por exemplo, altere as datas de início ou término da programação, a quantidade de recorrência, o local de expedição ou o plano de recorrência. Use essa API para também pausar a programação por um breve período.

    modifyContractOrderLineSchedule API

  • Eliminar uma programação de recorrência para uma linha de ordem de contrato

    deleteContractOrderLineSchedule API

  • Recuperar os detalhes de uma programação de recorrência criada para uma linha de ordem de contrato

    getContractOrderLineScheduleDetails API

  • Resumir as programações de linha da ordem do contrato de uma ordem do contrato

    Resuma as programações em relação às linhas da ordem do contrato, ShipToKeys, distinto, RecurrencePlanKeys, distinto ou uma combinação distinta de ShipToKey e RecurrencePlanKey, em uma ordem do contrato. A contagem de programações de linha de pedido de contrato para cada valor distinto de linha de pedido de contrato, ShipToKey, RecurrencePlanKey, ou a combinação de ShipToKey e RecurrencePlanKey também é exibida.

    getContractOrderScheduleSummary API

  • Recuperar linhas programadas para entrega

    Recupera as próximas linhas programadas de entrega para uma conta, uma ordem de contrato, uma linha de ordem de contrato ou uma programação de linha de ordem de contrato. As linhas consumidas, fechadas ou canceladas programadas para entrega também podem ser recuperadas se não forem removidas do sistema.

    getContractDeliveryScheduledLineList API

  • Resumir as próximas entregas de uma ordem de contrato

    Resuma as próximas entregas em relação às linhas do pedido de contrato, ShipToKeys, distinto, RecurrencePlanKeys, distinto ou uma combinação distinta de ShipToKey e RecurrencePlanKey em um pedido de contrato. A contagem de entregas, a quantidade total e o preço total para cada valor distinto da linha de pedido de contrato, ShipToKey, RecurrencePlanKey, ou a combinação de ShipToKey e RecurrencePlanKey também são exibidos.

    getContractOrderDeliverySummary API

  • Gerenciar as linhas programadas de entrega

    Gerencie a data de entrega solicitada, a quantidade e o preço unitário das linhas programadas para entrega de uma ordem de contrato. Usando essa API, você pode adiantar ou adiar a data de entrega solicitada das linhas programadas para entrega. A nova data deve estar dentro do intervalo da data mínima em que a entrega do produto pode ser antecipada e da programação da linha da ordem do contrato ou da data final da ordem do contrato. Você também pode alterar a quantidade de linhas programadas de entrega para atender à sua demanda em qualquer entrega imediata. Use essa API para cancelar proativamente as linhas programadas para entrega se os produtos correspondentes não forem mais necessários, em vez de cancelar os pedidos ou devolver os produtos posteriormente.

    manageContractDeliveryScheduledLines API

Ações de recorrência de pedidos de contrato

As APIs de ações de recorrência de pedidos de contrato permitem registrar referências em relação aos planos de recorrência de pedidos de contrato. Essas referências são aplicadas automaticamente aos pedidos de venda criados nas datas de recorrência. Além disso, é possível manter referências para uma combinação específica de Plano de Recorrência e Endereço de ShipTo. Isso permite que informações de referência específicas de cada local sejam aplicadas ao gerar pedidos de venda para cada uma das unidades do sistema de gestão de estoque ( ShipTo ).

  • Criar referência no nível de recorrência

    Cria uma referência em um plano de recorrência, usada entre os cronogramas de linhas de ordem de contrato de uma ordem de contrato. Essa referência é definida por um par ReferenceName-ReferenceValue, e você pode especificar qualquer informação específica da empresa relevante para esse padrão de recorrência. As ordens de venda automáticas criadas para as datas de entrega que correspondem ao padrão de recorrência obtêm esses dados específicos do negócio como referências do cabeçalho da ordem.

    createContractRecurrenceReference API

  • Modificar uma referência existente no nível de recorrência

    Atualiza uma referência definida em relação ao plano de recorrência, usada entre os cronogramas das linhas de pedido de contrato de um pedido de contrato.

    modifyContractRecurrenceReference

  • Excluir uma referência existente no nível de recorrência

    Exclui uma referência definida em relação ao plano de recorrência, usada entre os cronogramas de linhas de ordem de contrato de uma ordem de contrato.

    deleteContractRecurrenceReference

  • Recuperar uma referência específica de nível de recorrência

    Recupera uma referência definida em relação ao plano de recorrência, usada entre os cronogramas de linhas de ordem de contrato de uma ordem de contrato.

    getContractRecurrenceReferenceDetails

  • Recuperar uma lista de referências de nível de recorrência

    Recupera uma lista de referências de recorrência de pedidos de contrato com base nos critérios fornecidos.

    getContractRecurrenceReferenceList

Visualizar auditorias para pedido de contrato

  • Recuperar auditorias de pedidos de contrato e entidades relacionadas

    Utilize a getAuditList API para recuperar as auditorias registradas em pedidos de contrato, atribuições de lista de preços, linhas de pedidos de contrato, cronogramas de linhas, linhas com entrega programada e referências de recorrência, referentes às diversas ações documentadas nesta página sobre pedidos de contrato e entidades comerciais relacionadas.

    É necessário inserir o TableName atributo conforme mostrado na tabela a seguir para obter as auditorias relativas à ordem contratual ou às entidades comerciais relacionadas:
    Entidade de Negócios TableName
    Ordem de contrato YFS_CONTRATO_PEDIDO
    Linha de pedido do contrato YFS_CONTRATO_LINHA_DE_PEDIDO
    Cronograma das linhas de pedido do contrato YFS_CONTRATO_ORDEM_LINHA_PROGRAMAÇÃO
    Referência à recorrência de pedidos de contrato YFS_CONTRATO_PEDIDO_RECURRENTE_REF
    Linha de entrega programada YFS_CONTRATO_CRONOGRAMA_DE_ENTREGA_LINHA

    Além disso, você pode inserir o Createprogid atributo com o nome de uma API para obter as auditorias registradas por essa API na ordem de contrato ou nas entidades comerciais relacionadas.

    Se você quiser visualizar os registros de auditoria relativos às modificações em uma ordem contratual específica ou os dados correspondentes nas entidades comerciais relacionadas, insira TableKey a chave primária da ordem contratual ou os dados da entidade comercial relacionada.

    Recuperar auditorias relacionadas às atividades de gestão de pedidos contratuais

    Utilize a getOrderAuditList API para recuperar os registros de auditoria relativos às atividades de gerenciamento de pedidos contratuais, incluindo atualizações de rascunhos de pedidos contratuais, confirmação de pedidos contratuais, alterações na quantidade das linhas de pedido, atualizações dos endereços de cobrança e de entrega, alterações temporárias nos endereços de contato, notas e instruções adicionadas aos pedidos contratuais e às linhas de pedido, bem como suspensões de pedidos contratuais e de suas linhas.

    Insira o OrderHeaderKey atributo ou OrderLineKey com a chave primária da ordem de contrato ou da linha da ordem de contrato, respectivamente, para recuperar as auditorias acima referidas relativas a uma determinada ordem de contrato ou a uma determinada linha da ordem de contrato.

Ações do item

  • Recuperar itens e seus preços unitários

    Recupera uma lista de itens e seus preços unitários com base na chave de cabeçalho da lista de preços fornecida que atende aos critérios de pesquisa especificados.

    getItemListForOrdering API

  • Pesquisar itens e seus preços unitários em um índice de catálogo

    Pesquise produtos em um site Catalog Index e seus preços unitários com base na chave de cabeçalho da lista de preços fornecida que atenda aos critérios de pesquisa especificados.

    searchCatalogIndex API

Ações de ordem de vendas

  • Criar uma ordem de vendas

    Criar uma ordem do cliente a partir de uma ordem de contrato confirmada.

    createOrderFromContract API

  • Copiar uma ordem do cliente

    Criar uma nova ordem de vendas copiando uma ordem de vendas existente criada a partir de uma ordem de contrato.

    copyOrder API
  • Adicionar linhas de pedido de contrato a um pedido de vendas

    Adicionar uma ou mais linhas de ordem de contrato a um pedido de vendas criado a partir de uma ordem de contrato.

    addContractLinesToOrder API

  • Modificar ordens do cliente criadas a partir de uma ordem do contrato

    Em casos excepcionais, use essa API para alterar pedidos de vendas ou linhas de pedidos gerados a partir de uma ordem de contrato.

    changeOrder API

  • Recuperar exceções para pedidos de vendas criados a partir de um pedido de contrato

    Use esta API para recuperar exceções personalizadas em pedidos de vendas criados a partir de pedidos de contrato e consultar com filtros específicos do contrato. Você pode passar filtros específicos do contrato no elemento ContractOrder na solicitação da API. O sistema deriva as ordens de venda criadas a partir das ordens contratuais, identificadas por esses atributos de filtro, e, em seguida, recupera as exceções vinculadas a essas ordens de venda.

    Apenas exceções comerciais ou personalizadas levantadas pelo usuário e vinculadas às ordens de venda por meio do OrderHeaderKey podem ser recuperadas.

    getIExceptionListForOrder API