Spendint API - POST /sn_spend_intg/spenint/shipment

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 6 min. de leitura

    • Use este endpoint para aceitar atualizações em compras de terceiros.

    Ao receber dados, você deve corresponder os dados da remessa a uma linha de ordem de compra usando o número da linha da ordem de vendas. Você pode usar o número de rastreamento para encontrar um registro de detalhes da remessa existente relacionado à linha da ordem de compra. Se nenhum registro desse tipo for encontrado, crie um novo registro de detalhes da remessa. Se não houver ordem de compra ou linha de ordem de compra para os dados de remessa, você verá uma mensagem de erro informando que a ordem de compra desta remessa não existe.
    Nota:
    Se as linhas da ordem de compra e da ordem de compra estiverem no status Envio pendente e as linhas da ordem de venda e da ordem de venda não estiverem preenchidas, a remessa e a publicação da fatura do revendedor terceirizado não serão permitidas. Só é permitido quando o status da ordem de compra e das linhas da ordem de compra são Solicitado. Além disso, não há restrição sequencial na remessa e na publicação da fatura.

    Tabelas de status

    Para saber o status da solicitação de envio, faça uma chamada REST no ServiceNow banco de dados usando Tabela REST API. A resposta da API lista os registros em que a atualização de envio falhou. Para obter uma resposta de envio, consulte a tabela Erro de remessa com o seguinte parâmetro:

    se <supplier_id> você estiver usando o comando "outbound_error.supplier_id" "outbound_error.state", "outbound_error.state" é "20"

    Os detalhes sobre o ID do cliente, ID do fornecedor, tipo de erro, ID do conjunto de importação exclusivo e estado podem ser encontrados na tabela Status de saída, que é a tabela de erros primária.

    Formato de URL

    /api/sn_sp_intg/spenint/shipment

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    modo Suporte a modos assíncronos e síncronos para integração de terceiros.

    Tipo de dados: Cadeia de caracteres

    Valores válidos:
    • Async: Modo assíncrono.
    • Sincronização: Modo síncrono.

    Padrão: Assíncrono
    Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    customer_id Identificador do cliente.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100
    order_number Obrigatório. Número da ordem de compra fornecido pelo cliente para esta ordem.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40
    sales_order_number Obrigatório. Número ou valor gerado pelo fornecedor para este pedido.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40
    shipment_lines Lista de linhas de remessa que podem conter o número de série, o número IMEI e os detalhes da etiqueta do ativo.

    Tipo de dados: Matriz

    "shipment_lines": [
  {
    "actual_shipment_date": "String",
    "estimated_arrival_date": "String",
    "line_number": "String",
    "planned_shipment_date": "String",
    "product_details": [Array],
    "sales_order_line_number": "String",
    "shipping_address": {Object},
    "shipping_carrier": "String",
    "shipment_quantity": "String",
    "ship_to": "String",
    "tracking_number": "String"
  }
]
    shipment_lines.actual_shipment_date Data em que a remessa sai do local do fornecedor.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40

    FORMATO: AAAA-MM-DD
    shipment_lines.estimated_arrival_date Data em que a remessa deve chegar ao local especificado.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40

    FORMATO: AAAA-MM-DD
    shipment_lines.line_number Obrigatório. Número da linha da ordem de compra que é gerado pelo cliente para uma compra específica.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40
    shipment_lines.planned_shipment_date Data em que a remessa está planejada para sair do local do fornecedor.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40

    FORMATO: AAAA-MM-DD
    shipment_lines.product_details Lista de objetos que definem os detalhes sobre os produtos que estão sendo enviados. As opções incluem o número de série, o número IMEI e os detalhes da etiqueta do ativo.

    Tipo de dados: Matriz

    "product_details": [
  {
    "asset_tag": "String",
    "imei": "String",
    "serial_number": "String"
  }
]
    shipment_lines.product_details.asset_tag Etiqueta do ativo do produto enviado.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100
    shipment_lines.product_details.imei Número IMEI do produto enviado.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100
    shipment_lines.product_details.serial_number Obrigatório. Número de série do produto enviado.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100
    shipment_lines.sales_order_line_number Número da linha do pedido de vendas gerado pelo fornecedor. Este número é necessário somente para revisões desta compra.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40
    shipment_lines.shipping_address Endereço para onde os produtos serão enviados.

    Tipo de dados: Objeto

    "shipping_address":
  {
    "city": "String",
    "country": "String",
    "name": "String",
    "state": "String",
    "street": "String",
    "zip_code": "String"
  }
    shipment_lines.shipping_address.city Nome da cidade para onde os produtos são enviados.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 1000
    shipment_lines.shipping_address.country País para onde os produtos são enviados.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40
    shipment_lines.shipping_address.name Nome do cliente para o qual os produtos serão enviados.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 1000
    shipment_lines.shipping_address.state Estado para onde os produtos são enviados.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 1000
    shipment_lines.shipping_address.street Nome da rua para onde os produtos são enviados.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 1000
    shipment_lines.shipping_address.zip_code CEP ou código PIN para o qual os produtos são enviados.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40
    shipment_lines.shipment_quantity Obrigatório. Número de produtos sendo enviados como mercadorias físicas. O número deve conter a quantidade dos produtos que estão na remessa.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40
    shipment_lines.shipping_carrier Transportadora que está entregando o produto no local especificado, como FedEx, UPS, USPS e assim por diante.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100
    shipment_lines.ship_to Nome do destinatário para o qual os produtos são enviados.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100
    shipment_lines.tracking_number Número de rastreamento fornecido pela transportadora para a totalidade ou parte da compra.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100
    supplier_id Obrigatório. Identificador do revendedor ou fornecedor com o qual o cliente pode fazer pedidos.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100
    supplier_shipment_number Obrigatório. Número de identificação gerado para esta remessa. Esse número é gerado por um ERP (Enterprise Resource Planning, planejamento de recursos empresariais) ou sistema de acompanhamento de pedidos.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100
    third_party_import_id Identificador que permite que um terceiro passe um valor de cadeia de caracteres para identificar exclusivamente um conjunto de dados importados.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta.

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Nota:
    . application/jsonO formato de dados é compatível com a Estrutura de integração de compras.
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP.

    Tabela 6. Códigos de status
    Código do status Descrição
    êxito Bem-sucedido. A solicitação foi processada com sucesso.
    falha Malsucedido. A solicitação foi processada com erros.

    Parâmetros do corpo da resposta (JSON)

    Esses parâmetros do corpo de resposta são recebidos quando consultados no modo síncrono.
    Nome Descrição
    error_response_body Descrição dos erros, listados pelo número da linha da ordem de venda, número da ordem de venda, número da remessa do fornecedor e mensagem de erro.

    Tipo de dados: Matriz
    error_response_body.error_message Mensagem de erro detalhada.

    Tipo de dados: Cadeia de caracteres
    status_code Status da resposta, como "Sucesso" ou "Falha".

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    curl "https://instance.service-now.com/api/sn_spend_intg/spendint/shipment" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'
{"root":[{
  "customer_id" : "ACME CORP",
  "supplier_id" : "SUP-123456",
  "third_party_import_id": "DEL2134324",
  "supplier_shipment_number" : "TN-YU67898723",
  "order_number": "PO0001002",
  "sales_order_number": "SO00223002",
  "shipment_lines": [
    {
      "line_number": "POL0001005",
      "sales_order_line_number": "SOL0231325",
      "shipment_quantity": "4",
      "shipping_carrier": "FedEx",
      "tracking_number": "E-901290092",
      "shipping_address":
        {
          "name" : "1640 Camino Del Rio North #202, San Diego,CA",
          "street" : "1640 Camino Del Rio North",
          "city" : "San Diego",
          "state" : "CA",
          "zip_code" : "92108-1512",
          "country" : "US"
        },
      "ship_to": "John doe",
      "planned_shipment_date": "YYYY-MM-DD",
      "actual_shipment_date": "YYYY-MM-DD",
      "estimated_arrival_date": "YYYY-MM-DD",
      "product_details": [
        {
          "serial_number": "FL1234-23242319001",
          "imei": "2134890294",
          "asset_tag": ""
        },{
          "serial_number": "FL1234-23242319110",
          "imei": "245499003",
          "asset_tag": ""
        }
      ]
    }
  ]
}
]}

    Possíveis respostas:

    // Success response:
{
    "result": {
        "response": "success"
    }
}

// Error response:
{
    "result": {
        "response": [
            {
                "customer_id": "ACME CORP",
                "supplier_id": "SUP-123456",
                "third_party_import_id": "DEL2134324",
                "status_code": "failure",
                "error_response_body": [
                    {
                        "sales_order_line_number": "SOL0231325",
                        "sales_order_number": "SO00223002",
                        "supplier_shipment_number": "TN-YU67898723",
                        "error_message": "The purchase order for this shipment does not exist\nThe purchase order line for this shipment does not exist\n"
                    }
                ]
            }
        ]
    }
}