API de pedidos de contratos

Sterling™ Order Management El sistema proporciona API para la gestión de contratos. Como desarrollador o integrador de sistemas, puede utilizar esta información para conectar casos de uso y acciones a las API respectivas.

Pedidos por contrato

El pedido contractual describe los términos y condiciones del acuerdo. Por ejemplo, los productos y la cantidad a entregar, las fechas de entrega periódicas y las direcciones de facturación y envío. También puede ver las acciones importantes que admiten las funciones avanzadas de empresa a empresa ( B2B ) en Sterling Order Management System para comprender las API que se utilizan para realizar esas acciones. En un escenario B2B, un contrato entre empresas ayuda a garantizar que ambas partes cumplen sus obligaciones y compromisos. La gestión eficaz de los contratos es fundamental en las relaciones de B2B, ya que repercute directamente en los ingresos, la satisfacción del cliente y las asociaciones a largo plazo.

Para crear pedidos de venta se utiliza una orden de contrato por negociación. Los pedidos de venta pueden generarse automáticamente en función del plazo de entrega del contrato o ser creados manualmente por los usuarios cuando sea necesario.

Los siguientes casos de uso del sistema Sterling Order Management muestran qué API utilizar para llevar a cabo las acciones descritas que pertenecen a los pedidos de contratos. Para obtener más información sobre las API de pedidos de contrato, consulte Acceso a la documentación relacionada con el desarrollo.

Acciones de fijación de precios

  • Crear o gestionar una lista de precios para pedidos abiertos

    Cree o gestione listas de precios que incluyan precios de artículos negociados para pedidos de contratos.

    managePricelistHeader API

  • Añadir o modificar líneas de la lista de precios

    managePricelistLine API

  • Asignar una lista de precios a un comprador

    managePricelistAssignment API

  • Asignar una lista de precios a un vendedor

    managePricelistSellerAssignment API

  • Recuperar una lista de precios de contratos

    Recuperar las listas de precios de contrato que pueden utilizarse para crear un pedido de contrato para un comprador.

    getAssignedPricelistHeaderList API

Acciones de pedido de contrato

  • Crear un pedido de contrato

    createOrder API

  • Modificar un pedido
    changeOrder API
  • Cerrar una orden de contrato

    Complete un pedido abierto después de que se hayan realizado los pedidos de venta para todas las cantidades de la línea de pedido, o cierre el pedido abierto antes de que se hayan realizado todos los pedidos de venta. Las líneas de pedido de contrato que están totalmente pedidas están Completadas y las líneas de pedido de contrato que están parcialmente pedidas están Cerradas.

    closeContractOrder API

  • Cambiar el estado de un pedido de contrato no confirmado

    Registre el progreso de la negociación cambiando el estado de la orden de contrato de una orden de contrato no confirmada. Por ejemplo, rechazar o aprobar los cambios que se realicen en el pedido del contrato.

    changeOrderStatus API

  • Suprimir una orden de pedido no confirmada o sus líneas de orden de pedido

    deleteOrderAPI API

  • Confirmar un proyecto de pedido de contrato y sus líneas de pedido de contrato

    Durante el proceso de confirmación, se llevan a cabo varias validaciones, incluidas comprobaciones con los detalles del producto, los derechos y el precio de la línea.

    confirmContractOrder API

  • Anular un pedido contractual o sus líneas de pedido contractual

    La cancelación de una orden de pedido confirmada sólo se permite si no se han iniciado las entregas de ninguna de las partidas de la orden de pedido. Utilice esta API para cancelar una orden de contrato confirmada o cualquiera de sus líneas de orden de contrato.

    changeOrder API

  • Recuperar una lista de pedidos de contratos que coincidan con los criterios de búsqueda

    Recupere la lista de pedidos de contrato que coincidan con los criterios de búsqueda que especifique.

    getContractOrderList API

  • Recuperar los detalles del pedido de contrato

    Recuperar los detalles del pedido de contrato sin incluir las líneas de contrato individuales.

    getContractOrderDetails API

  • Modificar un pedido de contrato para añadir o revisar la información de cabecera de la lista de precios

    changeOrder API

  • Ponga en pausa temporalmente las entregas de un pedido por contrato confirmado.

    Detener temporalmente las entregas de un pedido contractual. Esto resulta útil cuando es necesario detener temporalmente futuras entregas sin modificar las programaciones de las líneas de pedido configuradas ni borrar las líneas de entrega ya programadas. El pedido de contrato debe estar en estado Confirmado para esta acción.

    pauseContractOrderSchedule API

  • Reanudar las entregas de un pedido abierto cuyas órdenes de entrega están temporalmente en pausa.

    Reanudar las entregas de un pedido por contrato que estaba temporalmente en pausa. Cuando se invoca esta API, el estado del pedido de contrato vuelve a ser Confirmado, lo que permite al sistema crear líneas programadas de entrega basadas en las programaciones de línea de pedido de contrato configuradas en las líneas de pedido de contrato.

    resumeContractOrderSchedule API

Acciones de línea de pedido de contrato

  • Añadir o modificar líneas de pedido de contrato

    changeOrder API

  • Borrar líneas de pedido de un pedido no confirmado

    deleteOrder API

  • Recuperar una lista de líneas de pedido de contrato

    Recupere la lista de líneas de pedido de contrato que coincidan con los criterios de búsqueda que especifique.

    getContractOrderLineList API

  • Recuperar los detalles de una línea de pedido de contrato

    getContractOrderLineDetails API

  • Modificar una línea de pedido de contrato para revisar el precio unitario

    changeOrder API

  • Añadir un plan de recurrencia para una línea de pedido de contrato

    createContractOrderLineSchedule API

  • Recuperar una lista de calendarios de recurrencia de línea de pedido de contrato

    Recupere la lista de planes de recurrencia de línea de pedido de contrato que coincidan con los criterios de búsqueda que especifique.

    getContractOrderLineScheduleList API

  • Modificar un plan de recurrencia para una línea de pedido de contrato

    Modificar el calendario de recurrencia de una línea de pedido de contrato para diversas necesidades. Por ejemplo, cambie las fechas de inicio o fin de la programación, la cantidad de recurrencia, el lugar de envío o el plan de recurrencia. Utilice esta API también para pausar la programación durante un breve periodo.

    modifyContractOrderLineSchedule API

  • Suprimir un plan de repetición para una línea de pedido de contrato

    deleteContractOrderLineSchedule API

  • Recuperar los detalles de un plan de repetición creado para una línea de pedido de contrato

    getContractOrderLineScheduleDetails API

  • Resumir los calendarios de las líneas de un pedido de contrato

    Resuma los calendarios en función de las líneas de pedido de contrato, ShipToKeys, distintas RecurrencePlanKeys, distintas o una combinación distinta de ShipToKey y RecurrencePlanKey, en un pedido de contrato. También se muestra el recuento de programaciones de líneas de pedido de contrato para cada valor distinto de línea de pedido de contrato, ShipToKey, RecurrencePlanKey, o la combinación de ShipToKey y RecurrencePlanKey.

    getContractOrderScheduleSummary API

  • Recuperar líneas programadas para entregas

    Recuperar las próximas líneas programadas de entrega para una cuenta, un pedido de contrato, una línea de pedido de contrato o una programación de línea de pedido de contrato. Las líneas de entrega programada consumidas, cerradas o canceladas también pueden recuperarse si no se han purgado del sistema.

    getContractDeliveryScheduledLineList API

  • Resumir las próximas entregas de un pedido contractual

    Resuma las próximas entregas contra las líneas de pedido de contrato, distintas ShipToKeys, distintas RecurrencePlanKeys, o una combinación distinta de ShipToKey y RecurrencePlanKey en un pedido de contrato. También se muestra el recuento de entregas, la cantidad total y el precio total para cada valor distinto de línea de pedido de contrato, ShipToKey, RecurrencePlanKey, o la combinación de ShipToKey y RecurrencePlanKey.

    getContractOrderDeliverySummary API

  • Gestionar las líneas programadas de entrega

    Gestione la fecha de entrega solicitada, la cantidad y el precio unitario de las líneas de entrega programada de un pedido abierto. Mediante esta API, puede adelantar o aplazar la fecha de entrega solicitada de las líneas con entrega programada. La nueva fecha debe estar dentro del rango de la fecha mínima en la que se puede adelantar la entrega del producto y el calendario de la línea de pedido del contrato o la fecha de finalización del pedido del contrato. También puede modificar la cantidad de líneas de entrega programada para satisfacer su demanda en cualquier entrega inmediata. Utilice esta API para cancelar proactivamente las líneas programadas para entrega si los productos correspondientes ya no son necesarios, en lugar de cancelar los pedidos o devolver los productos más tarde.

    manageContractDeliveryScheduledLines API

Acciones de recurrencia de órdenes de contrato

Las API de acciones de repetición de pedidos contractuales te permiten registrar referencias en relación con los planes de repetición de pedidos contractuales. Estas referencias se aplican automáticamente a los pedidos de venta creados en las fechas de recurrencia. Además, puedes mantener referencias para una combinación específica de «Plan de recurrencia» y «Dirección de ShipTo ». Esto permite aplicar información de referencia específica de cada centro cuando se generan pedidos de cliente para centros concretos de ShipTo.

  • Crear referencia a nivel de recurrencia

    Crea una referencia en un plan de recurrencia, utilizada entre las programaciones de líneas de pedido de un pedido de contrato. Esta referencia se establece mediante un par « ReferenceName-ReferenceValue » (recurrencia de tipo/fecha) y se puede especificar cualquier información específica del negocio relevante para ese patrón de recurrencia. Los pedidos de cliente automáticos creados para las fechas de entrega que coinciden con el patrón de recurrencia obtienen estos datos específicos de la empresa como referencias de cabecera del pedido.

    createContractRecurrenceReference API

  • Modificar una referencia de nivel de recurrencia existente

    Actualiza una referencia definida según el plan de recurrencia, utilizada entre las programaciones de líneas de pedido de contrato de un pedido de contrato.

    modifyContractRecurrenceReference

  • Eliminar una referencia existente a nivel de recurrencia

    Elimina una referencia definida en el plan de recurrencia, utilizada entre las programaciones de líneas de pedido de contrato de un pedido de contrato.

    deleteContractRecurrenceReference

  • Recuperar una referencia de nivel de recurrencia específica

    Recupera una referencia definida según el plan de recurrencia, utilizada entre las programaciones de líneas de pedido de contrato de un pedido de contrato.

    getContractRecurrenceReferenceDetails

  • Recuperar una lista de referencias a nivel de recurrencia

    Recupera una lista de referencias de recurrencia de pedidos de contratos basadas en los criterios proporcionados.

    getContractRecurrenceReferenceList

Acciones

  • Recuperar artículos y sus precios unitarios

    Recuperar una lista de artículos y sus precios unitarios basados en la clave de encabezado de la lista de precios proporcionada que cumpla con los criterios de búsqueda especificados.

    getItemListForOrdering API

  • Buscar artículos y sus precios unitarios en un índice de catálogo

    Buscar productos en Catalog Index y sus precios unitarios a partir de la clave de cabecera de lista de precios proporcionada que cumpla los criterios de búsqueda especificados.

    searchCatalogIndex API

Acciones relativas a los pedidos de venta

  • Crear un pedido de cliente

    Crear un pedido de cliente a partir de un pedido de contrato confirmado.

    createOrderFromContract API

  • Copiar un pedido de cliente

    Cree un nuevo pedido de cliente copiando un pedido de cliente existente creado a partir de un pedido de contrato.

    copyOrder API
  • Añadir líneas de pedido de contrato a un pedido de cliente

    Añade una o más líneas de pedido de contrato a un pedido de cliente creado a partir de un pedido de contrato.

    addContractLinesToOrder API

  • Modificar los pedidos de cliente creados a partir de un pedido abierto

    En casos excepcionales, utilice esta API para modificar pedidos de cliente o líneas de pedido generados a partir de un pedido de contrato.

    changeOrder API

  • Recuperar excepciones para pedidos de venta creados a partir de un pedido de contrato

    Utilice esta API para recuperar excepciones personalizadas en pedidos de venta creados a partir de pedidos de contrato y realizar consultas con filtros específicos del contrato. Puede pasar filtros específicos del contrato en el elemento « ContractOrder » (Filtros de contrato) de la solicitud de API. El sistema obtiene los pedidos de venta creados a partir de los pedidos de contrato, identificados por estos atributos de filtro, y luego recupera las excepciones vinculadas a dichos pedidos de venta.

    Solo se pueden recuperar las excepciones comerciales o personalizadas generadas por el usuario y vinculadas a los pedidos de venta a través del servicio de datos de ventas ( OrderHeaderKey ).

    getIExceptionListForOrder API