Abrir a Plataforma da Cadeia de Suprimentos (versão prévia)

O Serviço open supply chain platform (OSCP) fornece uma API REST avançada e extensa. Usando essas APIs, o cliente pode criar e gerenciar OrderFulfillment, warehouse no OSCP. A OSCP se integrará a vários parceiros, incluindo varejistas, provedores logísticos e empresas de armazenagem, entre outros, e impulsionará eficiências de ponta a ponta em toda a cadeia de suprimentos integrando dados, operações e análises entre os parceiros.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Classe	Regions
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:      – Azure Government regiões      - Azure regiões da China      - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Microsoft
URL	https://azure.microsoft.com/support/

Metadados do conector
Publicador	Microsoft Corporation
Site	https://azure.microsoft.com/
Política de privacidade	https://www.microsoft.com/en-in/trust-center/privacy
Categorias	Colaboração; Dados

Open Supply Chain Platform (OSCP) é um serviço do Azure que fornece uma plataforma extensível para descobrir, consumir e estender aplicativos de cadeia de suprimentos prontos para uso criados pela Microsoft e parceiros. Esses aplicativos ajudam as organizações a desbloquear informações de negócios valiosas e eficiências de dados dentro de sua organização e além.

Pré-requisitos

Você deve ser um usuário em um aplicativo OSCP para usar esse conector. Você deve ter um workspace criado no OSCP. Você deve usar uma ID do Microsoft Entra.

Como obter credenciais

Para adicionar esse conector ao fluxo de trabalho, primeiro entre na conta da ID do Microsoft Entra com a Função OSCP (Contibutor/Leitor) no aplicativo OSCP ao qual você deseja se conectar.

Erros e soluções comuns

Se o usuário não tiver acesso ao contibutor OSCP no workspace, o usuário obterá o workspace não encontrado erro(404). Para corrigir, esse usuário precisa ter acesso ao contibutor OSCP para o workspace.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Descrição	Obrigatório
ID do workspace	cadeia	Especificar apenas a ID do workspace	Verdade

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Atualiza um pedido de remessa	Atualiza um pedido de remessa.
Atualiza um plano de cumprimento	Atualiza um plano de cumprimento dado ID do workspace, ID do plano de cumprimento e carga do plano de atendimento.
Atualiza uma remessa	Atualiza uma remessa.
Atualiza uma solicitação de cotação de remessa	Atualiza uma solicitação de cotação de remessa.
Cancela o cumprimento do pedido por ID de cumprimento do pedido	Cancela o cumprimento do pedido por ID de cumprimento do pedido.
Cria a solicitação de execução de fluxo de dados	Cria a solicitação de execução de fluxo de dados para um workspace.
Cria o novo cumprimento do pedido para a ID de cumprimento do pedido	Cria um novo cumprimento de ordem para a ID de cumprimento do pedido.
Cria ou atualiza o fluxo de dados	Cria ou atualiza o fluxo de dados para um workspace.
Cria ou atualiza o fluxo de saída de dados	Cria ou atualiza o fluxo de saída de dados para um workspace.
Cria ou atualiza um conjunto de dados	Cria ou atualiza um conjunto de dados que tem o nome especificado.
Cria ou atualiza um item	Cria ou atualiza o item para determinada ID de workspace e sku.
Cria ou atualiza um item de warehouse	Cria ou atualiza um item de warehouse por ID do warehouse e sku de item.
Cria ou atualiza um nó de entrega	Cria ou atualiza o nó de entrega para determinada ID do workspace e ID do nó de entrega.
Cria ou atualiza um warehouse	Cria ou atualiza um warehouse por ID do warehouse.
Cria ou atualiza uma cotação de remessa	Cria ou atualiza uma cotação de remessa.
Cria ou atualiza uma lista de itens	Cria ou atualiza uma lista de itens para determinada ID de workspace e skus.
Cria ou atualiza uma lista de itens do warehouse	Cria ou atualiza uma lista de itens de warehouse por ID do warehouse e sku de item.
Cria ou atualiza uma lista de nós de entrega	Cria ou atualiza uma lista de nós de entrega para determinada ID do workspace e ID do nó de entrega.
Cria ou atualiza uma operadora com a ID da operadora	Cria ou atualiza uma operadora com a ID da operadora para um workspace.
Cria uma lista de armazéns	Cria uma lista de armazéns para determinada ID de workspace e lista de objetos de armazém.
Cria uma lista de pedidos de remessa	Cria uma lista de pedidos de remessa.
Cria uma ordem de remessa	Cria uma ordem de remessa.
Cria uma remessa	Cria uma remessa.
Cria uma solicitação de cotação de remessa	Cria uma solicitação de cotação de remessa.
Dispara uma execução para a instância de Saída de Dados	Dispara uma execução para a instância de Saída de Dados para determinado nome.
Exclui o fluxo de dados	Exclui o fluxo de dados para determinado nome e workspace.
Exclui o fluxo de saída de dados	Exclui o fluxo de saída de dados para determinado nome e workspace.
Exclui o nó de entrega	Exclui o nó de entrega para a ID do workspace fornecida e a ID do nó de entrega.
Exclui um conjunto de dados que tem o nome especificado	Exclui um conjunto de dados que tem o nome especificado.
Exclui um item de warehouse por ID do warehouse e sku de item	Exclui um item de warehouse por ID do warehouse e sku de item.
Exclui um item para determinado sku	Exclui um item para determinado sku.
Exclui um warehouse por ID do warehouse	Exclui um warehouse por ID do warehouse.
Exclui uma lista de armazéns	Exclui uma lista de armazéns para determinada ID de workspace e uma lista de IDs do warehouse
Exclui uma lista de itens de warehouse por IDs de armazém	Exclui uma lista de itens de warehouse por IDs de armazém.
Exclui uma lista de itens para determinados skus	Exclui uma lista de itens para determinados skus.
Exclui uma lista de nós de entrega	Exclui os nós de entrega para determinadas IDs de nó de entrega.
Exclui uma operadora com a ID da transportadora	Exclui uma operadora com a ID da operadora para um workspace.
Gera opções de atendimento	Gera opções de atendimento para determinada ID de workspace e solicitação de atendimento
Listar todas as execuções para determinado Fluxo de Dados	Lista todas as execuções para determinado nome de Fluxo de Dados.
Listar todas as execuções para determinado fluxo de saída de dados	Lista todas as execuções para determinado nome de Saída de Dados.
Recupera a execução do fluxo de dados para a ID de execução	Recupera a execução do fluxo de dados para determinada ID de execução.
Recupera detalhes de execução para determinado fluxo de dados e ID de execução	Recupera detalhes de execução para determinado nome de fluxo de dados e ID de execução.
Recupera o cumprimento do pedido por ID de cumprimento da ordem	Recupera o cumprimento do pedido por ID de cumprimento da ordem.
Recupera o fluxo de dados	Recupera o fluxo de dados para determinado nome e workspace.
Recupera o fluxo de saída de dados	Recupera o fluxo de saída de dados para determinado nome e workspace.
Recupera os nós de entrega para determinado workspace	Recupera os nós de entrega para determinada ID do workspace.
Recupera subdiretórios de um conjunto de dados	Recupera subdiretórios de um conjunto de dados que tem o nome especificado.
Recupera todos os armazéns de um workspace	Recupera todos os armazéns de um workspace.
Recupera todos os conjuntos de dados de um workspace	Recupera todos os conjuntos de dados de um workspace.
Recupera todos os fluxos de dados	Recupera todos os fluxos de dados para determinado workspace.
Recupera todos os fluxos de dados para um workspace	Recupera todos os fluxos de dados para determinado workspace.
Recupera um conjunto de dados que tem o nome especificado	Recupera um conjunto de dados que tem o nome especificado.
Recupera um item	Recupera o item para determinada ID de workspace e sku.
Recupera um item de warehouse por ID do warehouse e sku de item	Recupera um item de warehouse por ID do warehouse e sku de item.
Recupera um nó de entrega	Recupera o nó de entrega para a ID do workspace fornecida e a ID do nó de entrega.
Recupera um pedido de remessa	Recupera um pedido de remessa.
Recupera um plano de cumprimento	Recupera o plano de atendimento para a ID do workspace fornecida e a ID do plano de cumprimento.
Recupera um warehouse por ID de armazém	Recupera um depósito por ID do armazém.
Recupera uma cotação de remessa	Recupera uma cotação de remessa.
Recupera uma lista de planos de atendimento com status de atendimento específico	Recupera uma lista de planos de cumprimento com um status de atendimento específico para determinada ID do workspace e ID do armazém.
Recupera uma remessa por ID de remessa	Recupera uma remessa por ID de remessa.
Recupera uma solicitação de cotação de remessa	Recupera uma solicitação de cotação de remessa.
Recupera uma transportadora com a ID da transportadora	Recupera uma operadora com a ID da operadora para um workspace.

Atualiza um pedido de remessa

ID da operação:

ShipmentOrder_UpdateShipmentOrder

Atualiza um pedido de remessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID do pedido de remessa.	shipmentOrderId	True	string	A ID do pedido de remessa.
id	id	True	string	O identificador exclusivo de uma ordem de remessa.
shipmentId	shipmentId		string	O identificador de uma remessa que envia esta ordem de remessa.
status	status		string	O status da ordem de remessa.
itemSKU	itemSKU	True	string	SKU do item.
quantidade	quantity	True	integer	A quantidade do item.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de remessa. Atualmente, há suporte apenas para Origem e Destino.
locationType	locationType		string	O tipo De localização representa se o Local é um armazém, um cliente etc.
nome do contato	contactName		string	O nome de contato de uma pessoa relacionada ao Local
contactNumber	contactNumber		string	O número de contato de uma pessoa relacionada ao Local
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
customAttributes	customAttributes		object	Informações adicionais de Localização de Remessa capturadas como pares chave-valor.
shipmentVolume	shipmentVolume	True	double	O volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnitOfMeasure	volumeUnitOfMeasure		string	A unidade de volume da medida
weightUnitOfMeasure	weightUnitOfMeasure		string	A unidade de peso da medida
shipmentLength	shipmentLength	True	double	O comprimento
shipmentWidth	shipmentWidth	True	double	A Largura
shipmentHeight	shipmentHeight	True	double	A Altura
lwhUnitOfMeasure	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de empacotamento de remessa
estimatedCost	estimatedCost	True	double	O custo estimado
código de moeda	currencyCode	True	string	O código de moeda
customerId	customerId		string	A ID do cliente
nomeDoCliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informações adicionais de Dados de Cobrança capturadas como pares chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	A ID do tipo de cobrança
chargeTypeName	chargeTypeName		string	O nome do tipo de cobrança
éOpcional	isOptional	True	boolean	O sinalizador IsOptional será definido como True se os encargos relacionados ao componente forem opcionais. Else False
plannedPickupTime	plannedPickupTime		string	A hora de retirada planejada da ordem de remessa.
plannedEarliestPickupTime	plannedEarliestPickupTime		string	A primeira hora de retirada planejada da ordem de remessa.
plannedLatestPickupTime	plannedLatestPickupTime		string	A hora de retirada mais recente planejada do Pedido de Remessa.
plannedDeliveryTime	plannedDeliveryTime		string	O tempo de entrega planejado do Pedido de Remessa.
plannedEarliestDeliveryTime	plannedEarliestDeliveryTime		string	O horário de entrega mais antigo planejado da Ordem de Remessa.
plannedLatestDeliveryTime	plannedLatestDeliveryTime		string	O horário de entrega mais recente planejado do Pedido de Remessa.
isFragile	isFragile	True	boolean	O sinalizador IsFragile será definido como true se houver itens frágeis. Caso contrário, False.
includesBattery	includesBattery	True	boolean	O sinalizador IncludesBattery será definido como true se a bateria fizer parte do pacote. Caso contrário, False.
deliveryInstructions	deliveryInstructions		object	As instruções de entrega do Pedido de Remessa.
customAttributes	customAttributes		object	Informações adicionais do Pedido de Remessa capturadas como pares chave-valor.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a hora da última modificação

Retornos

A ordem de remessa com detalhes como itens a serem enviados, informações de localizações de origem/destino, encargos etc...

Corpo

ShipmentOrder

Atualiza um plano de cumprimento

ID da operação:

FulfillmentPlan_UpdatePlan

Atualiza um plano de cumprimento dado ID do workspace, ID do plano de cumprimento e carga do plano de atendimento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O identificador do plano de cumprimento.	fulfillmentPlanId	True	string	O identificador do plano de cumprimento.
id	id		string	O identificador exclusivo de uma realização.
warehouseId	warehouseId		string	O identificador exclusivo de um armazém.
scheduledExecutionTime	scheduledExecutionTime		string
ID do pedido	orderId	True	string	O número exclusivo que identifica uma ordem.
itemSKU	itemSKU	True	string	SKU do item.
quantidade	quantity	True	integer	A quantidade de itens.
plannedEarliestDeliveryDateTime	plannedEarliestDeliveryDateTime		string	O datetime mais antigo em que o pedido deve ser entregue.
plannedLatestDeliveryDateTime	plannedLatestDeliveryDateTime	True	string	O datetime mais recente em que o pedido deve ser entregue.
id	id	True	string	O identificador exclusivo de uma remessa.
status	status		string	O status da remessa.
shipmentOrderIds	shipmentOrderIds		array of string	A lista de IDs de pedido de remessa que são atendidas pela Remessa.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de remessa. Atualmente, há suporte apenas para Origem e Destino.
locationType	locationType		string	O tipo De localização representa se o Local é um armazém, um cliente etc.
nome do contato	contactName		string	O nome de contato de uma pessoa relacionada ao Local
contactNumber	contactNumber		string	O número de contato de uma pessoa relacionada ao Local
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
customAttributes	customAttributes		object	Informações adicionais de Localização de Remessa capturadas como pares chave-valor.
shipmentVolume	shipmentVolume	True	double	O volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnitOfMeasure	volumeUnitOfMeasure		string	A unidade de volume da medida
weightUnitOfMeasure	weightUnitOfMeasure		string	A unidade de peso da medida
shipmentLength	shipmentLength	True	double	O comprimento
shipmentWidth	shipmentWidth	True	double	A Largura
shipmentHeight	shipmentHeight	True	double	A Altura
lwhUnitOfMeasure	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de empacotamento de remessa
estimatedCost	estimatedCost	True	double	O custo estimado
código de moeda	currencyCode	True	string	O código de moeda
customerId	customerId		string	A ID do cliente
nomeDoCliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informações adicionais de Dados de Cobrança capturadas como pares chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	A ID do tipo de cobrança
chargeTypeName	chargeTypeName		string	O nome do tipo de cobrança
éOpcional	isOptional	True	boolean	O sinalizador IsOptional será definido como True se os encargos relacionados ao componente forem opcionais. Else False
número de rastreamento	trackingNumber		string	O número de acompanhamento
trackingUrl	trackingUrl		string	A URL de Acompanhamento
shipLabelUrl	shipLabelUrl		string	A URL do rótulo Ship
itemSKU	itemSKU	True	string	SKU do item.
quantidade	quantity	True	integer	A quantidade do item.
estimatedPickupTime	estimatedPickupTime		string	A hora de retirada planejada da ordem de remessa.
estimatedEarliestPickupTime	estimatedEarliestPickupTime		string	A primeira hora de retirada planejada da ordem de remessa.
estimatedLatestPickupTime	estimatedLatestPickupTime		string	A hora de retirada mais recente planejada do Pedido de Remessa.
estimatedDeliveryTime	estimatedDeliveryTime		string	O tempo de entrega planejado do Pedido de Remessa.
estimatedEarliestDeliveryTime	estimatedEarliestDeliveryTime		string	O horário de entrega mais antigo planejado da Ordem de Remessa.
estimatedLatestDeliveryTime	estimatedLatestDeliveryTime		string	O horário de entrega mais recente planejado do Pedido de Remessa.
isFragile	isFragile	True	boolean	O sinalizador IsFragile será definido como true se houver itens frágeis. Caso contrário, False.
includesBattery	includesBattery	True	boolean	O sinalizador IncludesBattery será definido como true se a bateria fizer parte do pacote. Caso contrário, False.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a hora da última modificação
deliveryInstructions	deliveryInstructions		object	As instruções de entrega da Remessa.
customAttributes	customAttributes		object	Informações adicionais de remessa capturadas como pares chave-valor.
carrierName	carrierName		string	O nome da transportadora para a remessa
status	status		string	O status do Plano de Cumprimento.
motivo_de_status	statusReason		string
tempoDeCriação	creationTime		string	O carimbo de data/hora que o Plano de Cumprimento foi criado.

Retornos

As atividades planejadas ou reais relacionadas ao cumprimento de uma ordem. Essas atividades podem incluir a criação da lista de seleção, a execução da lista de seleção, o empacotamento e a remessa dos itens para o destino final.

Corpo

FulfillmentPlan

Atualiza uma remessa

ID da operação:

Shipment_UpdateShipment

Atualiza uma remessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID da remessa.	shipmentId	True	string	A ID da remessa.
id	id	True	string	O identificador exclusivo de uma remessa.
status	status		string	O status da remessa.
shipmentOrderIds	shipmentOrderIds		array of string	A lista de IDs de pedido de remessa que são atendidas pela Remessa.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de remessa. Atualmente, há suporte apenas para Origem e Destino.
locationType	locationType		string	O tipo De localização representa se o Local é um armazém, um cliente etc.
nome do contato	contactName		string	O nome de contato de uma pessoa relacionada ao Local
contactNumber	contactNumber		string	O número de contato de uma pessoa relacionada ao Local
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
customAttributes	customAttributes		object	Informações adicionais de Localização de Remessa capturadas como pares chave-valor.
shipmentVolume	shipmentVolume	True	double	O volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnitOfMeasure	volumeUnitOfMeasure		string	A unidade de volume da medida
weightUnitOfMeasure	weightUnitOfMeasure		string	A unidade de peso da medida
shipmentLength	shipmentLength	True	double	O comprimento
shipmentWidth	shipmentWidth	True	double	A Largura
shipmentHeight	shipmentHeight	True	double	A Altura
lwhUnitOfMeasure	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de empacotamento de remessa
estimatedCost	estimatedCost	True	double	O custo estimado
código de moeda	currencyCode	True	string	O código de moeda
customerId	customerId		string	A ID do cliente
nomeDoCliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informações adicionais de Dados de Cobrança capturadas como pares chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	A ID do tipo de cobrança
chargeTypeName	chargeTypeName		string	O nome do tipo de cobrança
éOpcional	isOptional	True	boolean	O sinalizador IsOptional será definido como True se os encargos relacionados ao componente forem opcionais. Else False
número de rastreamento	trackingNumber		string	O número de acompanhamento
trackingUrl	trackingUrl		string	A URL de Acompanhamento
shipLabelUrl	shipLabelUrl		string	A URL do rótulo Ship
itemSKU	itemSKU	True	string	SKU do item.
quantidade	quantity	True	integer	A quantidade do item.
estimatedPickupTime	estimatedPickupTime		string	A hora de retirada planejada da ordem de remessa.
estimatedEarliestPickupTime	estimatedEarliestPickupTime		string	A primeira hora de retirada planejada da ordem de remessa.
estimatedLatestPickupTime	estimatedLatestPickupTime		string	A hora de retirada mais recente planejada do Pedido de Remessa.
estimatedDeliveryTime	estimatedDeliveryTime		string	O tempo de entrega planejado do Pedido de Remessa.
estimatedEarliestDeliveryTime	estimatedEarliestDeliveryTime		string	O horário de entrega mais antigo planejado da Ordem de Remessa.
estimatedLatestDeliveryTime	estimatedLatestDeliveryTime		string	O horário de entrega mais recente planejado do Pedido de Remessa.
isFragile	isFragile	True	boolean	O sinalizador IsFragile será definido como true se houver itens frágeis. Caso contrário, False.
includesBattery	includesBattery	True	boolean	O sinalizador IncludesBattery será definido como true se a bateria fizer parte do pacote. Caso contrário, False.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a hora da última modificação
deliveryInstructions	deliveryInstructions		object	As instruções de entrega da Remessa.
customAttributes	customAttributes		object	Informações adicionais de remessa capturadas como pares chave-valor.
carrierName	carrierName		string	O nome da transportadora para a remessa

Retornos

Uma quantidade de itens, mercadorias ou carga em massa que são enviados juntos.

Corpo

Shipment

Atualiza uma solicitação de cotação de remessa

ID da operação:

ShipmentQuoteRequest_UpdateShipmentQuoteRequest

Atualiza uma solicitação de cotação de remessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID da solicitação de cotação de remessa.	shipmentQuoteRequestId	True	string	A ID da solicitação de cotação de remessa.
id	id	True	string	O identificador exclusivo de uma Solicitação de Cotação de Remessa.
itemSKU	itemSKU	True	string	SKU do item.
quantidade	quantity	True	integer	A quantidade do item.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de remessa. Atualmente, há suporte apenas para Origem e Destino.
locationType	locationType		string	O tipo De localização representa se o Local é um armazém, um cliente etc.
nome do contato	contactName		string	O nome de contato de uma pessoa relacionada ao Local
contactNumber	contactNumber		string	O número de contato de uma pessoa relacionada ao Local
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
customAttributes	customAttributes		object	Informações adicionais de Localização de Remessa capturadas como pares chave-valor.
shipmentVolume	shipmentVolume	True	double	O volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnitOfMeasure	volumeUnitOfMeasure		string	A unidade de volume da medida
weightUnitOfMeasure	weightUnitOfMeasure		string	A unidade de peso da medida
shipmentLength	shipmentLength	True	double	O comprimento
shipmentWidth	shipmentWidth	True	double	A Largura
shipmentHeight	shipmentHeight	True	double	A Altura
lwhUnitOfMeasure	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de empacotamento de remessa
shipmentQuoteIds	shipmentQuoteIds		array of string	As IDs de cotação de remessa correspondentes à solicitação de cotação de remessa
plannedPickupTime	plannedPickupTime		string	A hora de retirada planejada da remessa.
plannedDeliveryTime	plannedDeliveryTime		string	O tempo de entrega planejado da remessa.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a hora da última modificação

Retornos

Os detalhes da Solicitação de Cotação de Remessa

Corpo

ShipmentQuoteRequest

Cancela o cumprimento do pedido por ID de cumprimento do pedido

ID da operação:

OrderFulfillment_CancelOrderFulfillment

Cancela o cumprimento do pedido por ID de cumprimento do pedido.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID de cumprimento do pedido.	orderFulfillmentId	True	string	A ID de cumprimento do pedido.

Retornos

Corpo

OrderFulfillment

Cria a solicitação de execução de fluxo de dados

ID da operação:

DataInflow_PostDataInflowRun

Cria a solicitação de execução de fluxo de dados para um workspace.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.
dataInflowName	dataInflowName		string	Obtém ou define o nome de Fluxo de Dados Imutável e exclusivo em um workspace
runParams	runParams		object	Obtém ou define os parâmetros necessários para execução específica a um tipo de conector
dataInflowRunId	dataInflowRunId		string	Obtém ou define a ID de execução do fluxo de dados para a execução do fluxo de dados
triggeredAt	triggeredAt		date-time	Obtém ou define o tempo disparado para a execução do fluxo de dados
completedAt	completedAt		date-time	Obtém ou define o tempo concluído para a execução do fluxo de dados
status	status		string	Obtém ou define o status da Execução de Fluxo de Dados

Retornos

Corpo

DataInflowRun

Cria o novo cumprimento do pedido para a ID de cumprimento do pedido

ID da operação:

OrderFulfillment_AcceptNewOrderFulfillment

Cria um novo cumprimento de ordem para a ID de cumprimento do pedido.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID de cumprimento do pedido.	orderFulfillmentId	True	string	A ID de cumprimento do pedido.
ID do pedido	orderId	True	string	O número exclusivo que identifica uma ordem.
itemSKU	itemSKU	True	string	SKU do item.
quantidade	quantity	True	integer	A quantidade de itens.
plannedEarliestDeliveryDateTime	plannedEarliestDeliveryDateTime		string	O datetime mais antigo em que o pedido deve ser entregue.
plannedLatestDeliveryDateTime	plannedLatestDeliveryDateTime	True	string	O datetime mais recente em que o pedido deve ser entregue.
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
shipmentToName	shipmentToName		string
shipmentReceiverContact	shipmentReceiverContact		string
status	status		string
id	id		string
fulfillmentPlanIds	fulfillmentPlanIds		array of string
tempoDeCriação	creationTime	True	date-time
hora da última modificação	lastModifiedTime	True	date-time
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.

Retornos

Corpo

OrderFulfillment

Cria ou atualiza o fluxo de dados

ID da operação:

DataInflow_PutDataInflow

Cria ou atualiza o fluxo de dados para um workspace.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.
nome	name	True	string	Obtém ou define o nome de Fluxo de Dados Imutável e exclusivo em um workspace Esse seria o identificador exclusivo para um Fluxo de Dados. Fornecido pelo usuário como um parâmetro de URL obrigatório.
nome de exibição	displayName	True	string	Obtém ou define o nome de exibição do Fluxo de Dados
Datasetname	datasetName	True	string	Obtém ou define o nome do conjunto de dados para o conector
tipo	type	True	string	Tipo do conector. Exemplo- CustomIngestion, CustomExport, FilterAndCopy
typeProperties	typeProperties	True	object	Propriedades relativas ao tipo de conector
saída	output		object	Contém os parâmetros de saída que seriam exibidos novamente para o cliente. Por exemplo, no caso do conector FilterAndCopy, a ID do convite e o local ads seriam retornados como parte da resposta.
tipo	type		string	Tipo de transformador
typeProperties	typeProperties		object	Propriedades relativas ao tipo de transformador
estado	state		string	Obtém ou define o estado do Fluxo de Dados

Retornos

Corpo

DataInflow

Cria ou atualiza o fluxo de saída de dados

ID da operação:

DataOutflow_PutDataOutflow

Cria ou atualiza o fluxo de saída de dados para um workspace.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.
nome	name	True	string	O nome do Fluxo de Dados que é imutável e exclusivo em um workspace. Esse seria o identificador exclusivo para um Fluxo de Saída de Dados. Fornecido pelo usuário como um parâmetro de URL obrigatório.
nome de exibição	displayName	True	string	O nome de exibição do Fluxo de Dados.
descrição	description	True	string	A descrição do Fluxo de Saída de Dados.
Datasetname	datasetName	True	string	Obtém ou define o nome do conjunto de dados para o conector
nome	name	True	string
nome	name	True	string
tipo	type	True	string	Tipo do conector. Exemplo- CustomIngestion, CustomExport, FilterAndCopy
typeProperties	typeProperties	True	object	Propriedades relativas ao tipo de conector
saída	output		object	Contém os parâmetros de saída que seriam exibidos novamente para o cliente. Por exemplo, no caso do conector FilterAndCopy, a ID do convite e o local ads seriam retornados como parte da resposta.
tipo	type		string	Tipo de transformador
typeProperties	typeProperties		object	Propriedades relativas ao tipo de transformador
estado	state		string	O estado do Fluxo de Saída de Dados.

Retornos

Corpo

DataOutflow

Cria ou atualiza um conjunto de dados

ID da operação:

Dataset_Put

Cria ou atualiza um conjunto de dados que tem o nome especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
nome	name	True	string	Obtém ou define o nome
nome	name	True	string
nome	name	True	string
isDisabled	isDisabled	True	boolean	Obtém ou define um valor que indica se obtém ou define o que está desabilitado
operationalType	operationalType		string	Obtém ou define o tipo operacional: representa se os dados são transacionais (Cosmos) ou ADLS (longo prazo)
dataModelId	dataModelId	True	string	Obtém ou define a ID do modelo de dados
dataModelVersion	dataModelVersion		string	Obtém ou define o dataModelVersion
dataModelType	dataModelType		string	Obtém ou define o dataModelType
labels	labels		array of string	Rótulos
O nome do conjunto de dados.	name	True	string	O nome do conjunto de dados.

Retornos

Corpo

Dataset

Cria ou atualiza um item

ID da operação:

Item_Put

Cria ou atualiza o item para determinada ID de workspace e sku.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O sku do item.	sku	True	string	O sku do item.
nome	name		string	O nome do Item.
descrição	description		string	A descrição do Item.
value	value	True	string	O valor do código de barras.
Standardname	standardName	True	string	O nome padrão do código de barras.
weight	weight	True	double	O peso do item padrão.
length	length	True	double	O comprimento do item padrão.
largura	width	True	double	A largura do item padrão.
profundidade	depth	True	double	A profundidade do item padrão.
abreviação	abbreviation	True	string	A unidade de comprimento, largura e altura da medida.
abreviação	abbreviation	True	string	A unidade de peso da medida.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a hora da última modificação
sku	sku	True	string	O identificador de Unidade de Manutenção de Estoque, que normalmente é usado para atividades relacionadas ao inventário.
labels	labels		array of string	Rótulos

Retornos

Algo inventariado. Uma SKU, unidade de manutenção de estoque, refere-se a um item específico em uma unidade de medida específica.

Corpo

Item

Cria ou atualiza um item de warehouse

ID da operação:

WarehouseItem_Put

Cria ou atualiza um item de warehouse por ID do warehouse e sku de item.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID do armazém.	warehouseId	True	string	A ID do armazém.
O sku do item.	itemSKU	True	string	O sku do item.
availableToPromiseQuantity	availableToPromiseQuantity	True	integer	A quantidade.
itemSKU	itemSKU	True	string	A SKU do Item.
warehouseId	warehouseId		string	A SKU do Item.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a última vez que esse WarehouseItem foi obtido

Retornos

Corpo

WarehouseItem

Cria ou atualiza um nó de entrega

ID da operação:

DeliveryNode_Put

Cria ou atualiza o nó de entrega para determinada ID do workspace e ID do nó de entrega.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O identificador do nó de entrega.	deliveryNodeId	True	string	O identificador do nó de entrega.
id	id	True	string	O identificador do nó.
dayOfWeekName	dayOfWeekName		string	O dia da semana.
startTime	startTime		string	A hora de início.
endTime	endTime		string	A hora de término.
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
labels	labels		array of string	Rótulos
hora da última modificação	lastModifiedTime		date-time

Retornos

Os detalhes operacionais do local de entrega, por exemplo, localização, horas de operação etc.

Corpo

DeliveryNode

Cria ou atualiza um warehouse

ID da operação:

Warehouse_Put

Cria ou atualiza um warehouse por ID do warehouse.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID do armazém.	warehouseId	True	string	A ID do armazém.
id	id	True	string	O identificador do nó.
dayOfWeekName	dayOfWeekName		string	O dia da semana.
startTime	startTime		string	A hora de início.
endTime	endTime		string	A hora de término.
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
labels	labels		array of string	Rótulos
hora da última modificação	lastModifiedTime		date-time
pickAndPackLeadTime	pickAndPackLeadTime	True	integer	Obtém ou define o PickAndPackLeadTime, que é o número de horas exigido pelo Warehouse para escolher e empacotar o item
carrierId	carrierId	True	string	ID da transportadora associada
cutoffTime	cutoffTime	True	string	Tempo de corte da transportadora em relação ao armazém.
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
servingNodeIds	servingNodeIds		array of string	Atendendo identificadores de nó, que contém uma lista de IDs de nó para as quais a transportadora atual pode servir. Lista nula ou vazia significa que essa transportadora pode servir a qualquer nó.

Retornos

Corpo

Warehouse

Cria ou atualiza uma cotação de remessa

ID da operação:

ShipmentQuote_Put

Cria ou atualiza uma cotação de remessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID da cotação de remessa.	shipmentQuoteId	True	string	A ID da cotação de remessa.
id	id	True	string	O identificador exclusivo de uma cotação de remessa.
shipmentQuoteRequestId	shipmentQuoteRequestId	True	string	O identificador da solicitação de cotação de remessa à qual a cotação de remessa está relacionada.
estimatedCost	estimatedCost	True	double	O custo estimado
código de moeda	currencyCode	True	string	O código de moeda
customerId	customerId		string	A ID do cliente
nomeDoCliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informações adicionais de Dados de Cobrança capturadas como pares chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	A ID do tipo de cobrança
chargeTypeName	chargeTypeName		string	O nome do tipo de cobrança
éOpcional	isOptional	True	boolean	O sinalizador IsOptional será definido como True se os encargos relacionados ao componente forem opcionais. Else False
plannedPickupTime	plannedPickupTime		string	A hora de retirada planejada da remessa.
plannedDeliveryTime	plannedDeliveryTime		string	O tempo de entrega planejado da remessa.
carrierId	carrierId	True	string	A ID da transportadora
carrierName	carrierName	True	string	O nome da transportadora
customAttributes	customAttributes		object	Informações adicionais de Cotação de Remessa capturadas como pares chave-valor.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a hora da última modificação

Retornos

Os detalhes da cotação de remessa

Corpo

ShipmentQuote

Cria ou atualiza uma lista de itens

ID da operação:

Item_BulkPut

Cria ou atualiza uma lista de itens para determinada ID de workspace e skus.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
nome	name		string	O nome do Item.
descrição	description		string	A descrição do Item.
value	value	True	string	O valor do código de barras.
Standardname	standardName	True	string	O nome padrão do código de barras.
weight	weight	True	double	O peso do item padrão.
length	length	True	double	O comprimento do item padrão.
largura	width	True	double	A largura do item padrão.
profundidade	depth	True	double	A profundidade do item padrão.
abreviação	abbreviation	True	string	A unidade de comprimento, largura e altura da medida.
abreviação	abbreviation	True	string	A unidade de peso da medida.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a hora da última modificação
sku	sku	True	string	O identificador de Unidade de Manutenção de Estoque, que normalmente é usado para atividades relacionadas ao inventário.
labels	labels		array of string	Rótulos

Retornos

response

array of BulkResponseItemOfItem

Cria ou atualiza uma lista de itens do warehouse

ID da operação:

WarehouseItem_BulkPut

Cria ou atualiza uma lista de itens de warehouse por ID do warehouse e sku de item.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID do armazém.	warehouseId	True	string	A ID do armazém.
availableToPromiseQuantity	availableToPromiseQuantity	True	integer	A quantidade.
itemSKU	itemSKU	True	string	A SKU do Item.
warehouseId	warehouseId		string	A SKU do Item.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a última vez que esse WarehouseItem foi obtido

Retornos

response

array of BulkResponseItemOfWarehouseItem

Cria ou atualiza uma lista de nós de entrega

ID da operação:

DeliveryNode_BulkPut

Cria ou atualiza uma lista de nós de entrega para determinada ID do workspace e ID do nó de entrega.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador do nó.
dayOfWeekName	dayOfWeekName		string	O dia da semana.
startTime	startTime		string	A hora de início.
endTime	endTime		string	A hora de término.
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
labels	labels		array of string	Rótulos
hora da última modificação	lastModifiedTime		date-time

Retornos

response

array of BulkResponseItemOfDeliveryNode

Cria ou atualiza uma operadora com a ID da operadora

ID da operação:

Carrier_Put

Cria ou atualiza uma operadora com a ID da operadora para um workspace.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID da transportadora.	carrierId	True	string	A ID da transportadora.
id	id	True	string	O identificador exclusivo de uma Transportadora.
tipo	type	True	string	O tipo da transportadora só pode ser o que o OSCP dá suporte.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.

Retornos

Corpo

Carrier

Cria uma lista de armazéns

ID da operação:

Warehouse_BulkPut

Cria uma lista de armazéns para determinada ID de workspace e lista de objetos de armazém.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador do nó.
dayOfWeekName	dayOfWeekName		string	O dia da semana.
startTime	startTime		string	A hora de início.
endTime	endTime		string	A hora de término.
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
labels	labels		array of string	Rótulos
hora da última modificação	lastModifiedTime		date-time
pickAndPackLeadTime	pickAndPackLeadTime	True	integer	Obtém ou define o PickAndPackLeadTime, que é o número de horas exigido pelo Warehouse para escolher e empacotar o item
carrierId	carrierId	True	string	ID da transportadora associada
cutoffTime	cutoffTime	True	string	Tempo de corte da transportadora em relação ao armazém.
servingNodeIds	servingNodeIds		array of string	Atendendo identificadores de nó, que contém uma lista de IDs de nó para as quais a transportadora atual pode servir. Lista nula ou vazia significa que essa transportadora pode servir a qualquer nó.

Retornos

response

array of BulkResponseItemOfWarehouse

Cria uma lista de pedidos de remessa

ID da operação:

ShipmentOrder_BulkPut

Cria uma lista de pedidos de remessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo de uma ordem de remessa.
shipmentId	shipmentId		string	O identificador de uma remessa que envia esta ordem de remessa.
status	status		string	O status da ordem de remessa.
itemSKU	itemSKU	True	string	SKU do item.
quantidade	quantity	True	integer	A quantidade do item.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de remessa. Atualmente, há suporte apenas para Origem e Destino.
locationType	locationType		string	O tipo De localização representa se o Local é um armazém, um cliente etc.
nome do contato	contactName		string	O nome de contato de uma pessoa relacionada ao Local
contactNumber	contactNumber		string	O número de contato de uma pessoa relacionada ao Local
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
customAttributes	customAttributes		object	Informações adicionais de Localização de Remessa capturadas como pares chave-valor.
shipmentVolume	shipmentVolume	True	double	O volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnitOfMeasure	volumeUnitOfMeasure		string	A unidade de volume da medida
weightUnitOfMeasure	weightUnitOfMeasure		string	A unidade de peso da medida
shipmentLength	shipmentLength	True	double	O comprimento
shipmentWidth	shipmentWidth	True	double	A Largura
shipmentHeight	shipmentHeight	True	double	A Altura
lwhUnitOfMeasure	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de empacotamento de remessa
estimatedCost	estimatedCost	True	double	O custo estimado
código de moeda	currencyCode	True	string	O código de moeda
customerId	customerId		string	A ID do cliente
nomeDoCliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informações adicionais de Dados de Cobrança capturadas como pares chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	A ID do tipo de cobrança
chargeTypeName	chargeTypeName		string	O nome do tipo de cobrança
éOpcional	isOptional	True	boolean	O sinalizador IsOptional será definido como True se os encargos relacionados ao componente forem opcionais. Else False
plannedPickupTime	plannedPickupTime		string	A hora de retirada planejada da ordem de remessa.
plannedEarliestPickupTime	plannedEarliestPickupTime		string	A primeira hora de retirada planejada da ordem de remessa.
plannedLatestPickupTime	plannedLatestPickupTime		string	A hora de retirada mais recente planejada do Pedido de Remessa.
plannedDeliveryTime	plannedDeliveryTime		string	O tempo de entrega planejado do Pedido de Remessa.
plannedEarliestDeliveryTime	plannedEarliestDeliveryTime		string	O horário de entrega mais antigo planejado da Ordem de Remessa.
plannedLatestDeliveryTime	plannedLatestDeliveryTime		string	O horário de entrega mais recente planejado do Pedido de Remessa.
isFragile	isFragile	True	boolean	O sinalizador IsFragile será definido como true se houver itens frágeis. Caso contrário, False.
includesBattery	includesBattery	True	boolean	O sinalizador IncludesBattery será definido como true se a bateria fizer parte do pacote. Caso contrário, False.
deliveryInstructions	deliveryInstructions		object	As instruções de entrega do Pedido de Remessa.
customAttributes	customAttributes		object	Informações adicionais do Pedido de Remessa capturadas como pares chave-valor.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a hora da última modificação

Retornos

response

array of BulkResponseItemOfShipmentOrder

Cria uma ordem de remessa

ID da operação:

ShipmentOrder_Put

Cria uma ordem de remessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID do pedido de remessa.	shipmentOrderId	True	string	A ID do pedido de remessa.
id	id	True	string	O identificador exclusivo de uma ordem de remessa.
shipmentId	shipmentId		string	O identificador de uma remessa que envia esta ordem de remessa.
status	status		string	O status da ordem de remessa.
itemSKU	itemSKU	True	string	SKU do item.
quantidade	quantity	True	integer	A quantidade do item.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de remessa. Atualmente, há suporte apenas para Origem e Destino.
locationType	locationType		string	O tipo De localização representa se o Local é um armazém, um cliente etc.
nome do contato	contactName		string	O nome de contato de uma pessoa relacionada ao Local
contactNumber	contactNumber		string	O número de contato de uma pessoa relacionada ao Local
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
customAttributes	customAttributes		object	Informações adicionais de Localização de Remessa capturadas como pares chave-valor.
shipmentVolume	shipmentVolume	True	double	O volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnitOfMeasure	volumeUnitOfMeasure		string	A unidade de volume da medida
weightUnitOfMeasure	weightUnitOfMeasure		string	A unidade de peso da medida
shipmentLength	shipmentLength	True	double	O comprimento
shipmentWidth	shipmentWidth	True	double	A Largura
shipmentHeight	shipmentHeight	True	double	A Altura
lwhUnitOfMeasure	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de empacotamento de remessa
estimatedCost	estimatedCost	True	double	O custo estimado
código de moeda	currencyCode	True	string	O código de moeda
customerId	customerId		string	A ID do cliente
nomeDoCliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informações adicionais de Dados de Cobrança capturadas como pares chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	A ID do tipo de cobrança
chargeTypeName	chargeTypeName		string	O nome do tipo de cobrança
éOpcional	isOptional	True	boolean	O sinalizador IsOptional será definido como True se os encargos relacionados ao componente forem opcionais. Else False
plannedPickupTime	plannedPickupTime		string	A hora de retirada planejada da ordem de remessa.
plannedEarliestPickupTime	plannedEarliestPickupTime		string	A primeira hora de retirada planejada da ordem de remessa.
plannedLatestPickupTime	plannedLatestPickupTime		string	A hora de retirada mais recente planejada do Pedido de Remessa.
plannedDeliveryTime	plannedDeliveryTime		string	O tempo de entrega planejado do Pedido de Remessa.
plannedEarliestDeliveryTime	plannedEarliestDeliveryTime		string	O horário de entrega mais antigo planejado da Ordem de Remessa.
plannedLatestDeliveryTime	plannedLatestDeliveryTime		string	O horário de entrega mais recente planejado do Pedido de Remessa.
isFragile	isFragile	True	boolean	O sinalizador IsFragile será definido como true se houver itens frágeis. Caso contrário, False.
includesBattery	includesBattery	True	boolean	O sinalizador IncludesBattery será definido como true se a bateria fizer parte do pacote. Caso contrário, False.
deliveryInstructions	deliveryInstructions		object	As instruções de entrega do Pedido de Remessa.
customAttributes	customAttributes		object	Informações adicionais do Pedido de Remessa capturadas como pares chave-valor.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a hora da última modificação

Retornos

A ordem de remessa com detalhes como itens a serem enviados, informações de localizações de origem/destino, encargos etc...

Corpo

ShipmentOrder

Cria uma remessa

ID da operação:

Shipment_Put

Cria uma remessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID da remessa.	shipmentId	True	string	A ID da remessa.
id	id	True	string	O identificador exclusivo de uma remessa.
status	status		string	O status da remessa.
shipmentOrderIds	shipmentOrderIds		array of string	A lista de IDs de pedido de remessa que são atendidas pela Remessa.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de remessa. Atualmente, há suporte apenas para Origem e Destino.
locationType	locationType		string	O tipo De localização representa se o Local é um armazém, um cliente etc.
nome do contato	contactName		string	O nome de contato de uma pessoa relacionada ao Local
contactNumber	contactNumber		string	O número de contato de uma pessoa relacionada ao Local
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
customAttributes	customAttributes		object	Informações adicionais de Localização de Remessa capturadas como pares chave-valor.
shipmentVolume	shipmentVolume	True	double	O volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnitOfMeasure	volumeUnitOfMeasure		string	A unidade de volume da medida
weightUnitOfMeasure	weightUnitOfMeasure		string	A unidade de peso da medida
shipmentLength	shipmentLength	True	double	O comprimento
shipmentWidth	shipmentWidth	True	double	A Largura
shipmentHeight	shipmentHeight	True	double	A Altura
lwhUnitOfMeasure	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de empacotamento de remessa
estimatedCost	estimatedCost	True	double	O custo estimado
código de moeda	currencyCode	True	string	O código de moeda
customerId	customerId		string	A ID do cliente
nomeDoCliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informações adicionais de Dados de Cobrança capturadas como pares chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	A ID do tipo de cobrança
chargeTypeName	chargeTypeName		string	O nome do tipo de cobrança
éOpcional	isOptional	True	boolean	O sinalizador IsOptional será definido como True se os encargos relacionados ao componente forem opcionais. Else False
número de rastreamento	trackingNumber		string	O número de acompanhamento
trackingUrl	trackingUrl		string	A URL de Acompanhamento
shipLabelUrl	shipLabelUrl		string	A URL do rótulo Ship
itemSKU	itemSKU	True	string	SKU do item.
quantidade	quantity	True	integer	A quantidade do item.
estimatedPickupTime	estimatedPickupTime		string	A hora de retirada planejada da ordem de remessa.
estimatedEarliestPickupTime	estimatedEarliestPickupTime		string	A primeira hora de retirada planejada da ordem de remessa.
estimatedLatestPickupTime	estimatedLatestPickupTime		string	A hora de retirada mais recente planejada do Pedido de Remessa.
estimatedDeliveryTime	estimatedDeliveryTime		string	O tempo de entrega planejado do Pedido de Remessa.
estimatedEarliestDeliveryTime	estimatedEarliestDeliveryTime		string	O horário de entrega mais antigo planejado da Ordem de Remessa.
estimatedLatestDeliveryTime	estimatedLatestDeliveryTime		string	O horário de entrega mais recente planejado do Pedido de Remessa.
isFragile	isFragile	True	boolean	O sinalizador IsFragile será definido como true se houver itens frágeis. Caso contrário, False.
includesBattery	includesBattery	True	boolean	O sinalizador IncludesBattery será definido como true se a bateria fizer parte do pacote. Caso contrário, False.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a hora da última modificação
deliveryInstructions	deliveryInstructions		object	As instruções de entrega da Remessa.
customAttributes	customAttributes		object	Informações adicionais de remessa capturadas como pares chave-valor.
carrierName	carrierName		string	O nome da transportadora para a remessa

Retornos

Uma quantidade de itens, mercadorias ou carga em massa que são enviados juntos.

Corpo

Shipment

Cria uma solicitação de cotação de remessa

ID da operação:

ShipmentQuoteRequest_Put

Cria uma solicitação de cotação de remessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID da solicitação de cotação de remessa.	shipmentQuoteRequestId	True	string	A ID da solicitação de cotação de remessa.
id	id	True	string	O identificador exclusivo de uma Solicitação de Cotação de Remessa.
itemSKU	itemSKU	True	string	SKU do item.
quantidade	quantity	True	integer	A quantidade do item.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de remessa. Atualmente, há suporte apenas para Origem e Destino.
locationType	locationType		string	O tipo De localização representa se o Local é um armazém, um cliente etc.
nome do contato	contactName		string	O nome de contato de uma pessoa relacionada ao Local
contactNumber	contactNumber		string	O número de contato de uma pessoa relacionada ao Local
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
customAttributes	customAttributes		object	Informações adicionais de Localização de Remessa capturadas como pares chave-valor.
shipmentVolume	shipmentVolume	True	double	O volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnitOfMeasure	volumeUnitOfMeasure		string	A unidade de volume da medida
weightUnitOfMeasure	weightUnitOfMeasure		string	A unidade de peso da medida
shipmentLength	shipmentLength	True	double	O comprimento
shipmentWidth	shipmentWidth	True	double	A Largura
shipmentHeight	shipmentHeight	True	double	A Altura
lwhUnitOfMeasure	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de empacotamento de remessa
shipmentQuoteIds	shipmentQuoteIds		array of string	As IDs de cotação de remessa correspondentes à solicitação de cotação de remessa
plannedPickupTime	plannedPickupTime		string	A hora de retirada planejada da remessa.
plannedDeliveryTime	plannedDeliveryTime		string	O tempo de entrega planejado da remessa.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a hora da última modificação

Retornos

Os detalhes da Solicitação de Cotação de Remessa

Corpo

ShipmentQuoteRequest

Dispara uma execução para a instância de Saída de Dados

ID da operação:

DataOutflow_PostDataOutflowRun

Dispara uma execução para a instância de Saída de Dados para determinado nome.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.
dataOutflowName	dataOutflowName		string	Obtém ou define o nome do fluxo de dados
dataOutflowRunId	dataOutflowRunId		string	Obtém ou define a ID de Execução do Fluxo de Saída de Dados
runParams	runParams		object	Obtém ou define os parâmetros específicos para um tipo de conector
status	status		string	Obtém ou define o status da Execução do Fluxo de Saída de Dados
triggeredAt	triggeredAt		date-time	Obtém ou define o tempo disparado para a Execução do Fluxo de Saída de Dados
completedAt	completedAt		date-time	Obtém ou define o tempo concluído para a Execução do Fluxo de Saída de Dados
triggeredBy	triggeredBy		string	Obter ou definir o mecanismo por meio do qual essa execução foi disparada. Atualmente, por meio da API ou do evento Detset Ingestion Completion.
triggerId	triggerId		string	Obter ou definir o Identificador do mecanismo de gatilho.

Retornos

Corpo

DataOutflowRun

Exclui o fluxo de dados

ID da operação:

DataInflow_DeleteDataInflow

Exclui o fluxo de dados para determinado nome e workspace.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.

Retornos

Corpo

DataInflow

Exclui o fluxo de saída de dados

ID da operação:

DataOutflow_DeleteDataOutflow

Exclui o fluxo de saída de dados para determinado nome e workspace.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.

Retornos

Corpo

DataOutflow

Exclui o nó de entrega

ID da operação:

DeliveryNode_Delete

Exclui o nó de entrega para a ID do workspace fornecida e a ID do nó de entrega.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O identificador do nó de entrega.	deliveryNodeId	True	string	O identificador do nó de entrega.

Retornos

response

file

Exclui um conjunto de dados que tem o nome especificado

ID da operação:

Dataset_Delete

Exclui um conjunto de dados que tem o nome especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do conjunto de dados.	name	True	string	O nome do conjunto de dados.

Retornos

Corpo

Dataset

Exclui um item de warehouse por ID do warehouse e sku de item

ID da operação:

WarehouseItem_Delete

Exclui um item de warehouse por ID do warehouse e sku de item.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID do armazém.	warehouseId	True	string	A ID do armazém.
O sku do item.	itemSKU	True	string	O sku do item.

Retornos

response

file

Exclui um item para determinado sku

ID da operação:

Item_Delete

Exclui um item para determinado sku.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O sku do item.	sku	True	string	O sku do item.

Retornos

response

file

Exclui um warehouse por ID do warehouse

ID da operação:

Warehouse_Delete

Exclui um warehouse por ID do warehouse.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID do armazém.	warehouseId	True	string	A ID do armazém.

Retornos

response

file

Exclui uma lista de armazéns

ID da operação:

Warehouse_BulkDelete

Exclui uma lista de armazéns para determinada ID de workspace e uma lista de IDs do warehouse

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
warehouseIds	warehouseIds	True	array of string

Retornos

response

array of BulkResponseItemOfString

Exclui uma lista de itens de warehouse por IDs de armazém

ID da operação:

WarehouseItem_BulkDelete

Exclui uma lista de itens de warehouse por IDs de armazém.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID do armazém.	warehouseId	True	string	A ID do armazém.
itemSKUs	itemSKUs	True	array of string

Retornos

response

array of BulkResponseItemOfString

Exclui uma lista de itens para determinados skus

ID da operação:

Item_BulkDelete

Exclui uma lista de itens para determinados skus.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
skus	skus	True	array of string

Retornos

response

array of BulkResponseItemOfString

Exclui uma lista de nós de entrega

ID da operação:

DeliveryNode_BulkDelete

Exclui os nós de entrega para determinadas IDs de nó de entrega.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
deliveryNodeIds	deliveryNodeIds	True	array of string

Retornos

response

array of BulkResponseItemOfString

Exclui uma operadora com a ID da transportadora

ID da operação:

Carrier_Delete

Exclui uma operadora com a ID da operadora para um workspace.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID da transportadora.	carrierId	True	string	A ID da transportadora.

Retornos

response

file

Gera opções de atendimento

ID da operação:

FulfillmentOption_GenerateFulfillmentOptions

Gera opções de atendimento para determinada ID de workspace e solicitação de atendimento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do pedido	orderId	True	string	O número exclusivo que identifica uma ordem.
itemSKU	itemSKU	True	string	SKU do item.
quantidade	quantity	True	integer	A quantidade de itens.
plannedEarliestDeliveryDateTime	plannedEarliestDeliveryDateTime		string	O datetime mais antigo em que o pedido deve ser entregue.
plannedLatestDeliveryDateTime	plannedLatestDeliveryDateTime	True	string	O datetime mais recente em que o pedido deve ser entregue.
Timezonename	timeZoneName		string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	True	string	O endereço primário.
endereçoLinha2	addressLine2		string	O endereço secundário.
cityName	cityName	True	string	O componente "cidade" de um local.
stateName	stateName	True	string	O nome do estado ou da província.
countryName	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O CEP.
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.
maxNumOfFulfillmentOptions	maxNumOfFulfillmentOptions	True	integer
nome	name		string	O nome do Item.
descrição	description		string	A descrição do Item.
value	value	True	string	O valor do código de barras.
Standardname	standardName	True	string	O nome padrão do código de barras.
weight	weight	True	double	O peso do item padrão.
length	length	True	double	O comprimento do item padrão.
largura	width	True	double	A largura do item padrão.
profundidade	depth	True	double	A profundidade do item padrão.
abreviação	abbreviation	True	string	A unidade de comprimento, largura e altura da medida.
abreviação	abbreviation	True	string	A unidade de peso da medida.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a hora da última modificação
sku	sku	True	string	O identificador de Unidade de Manutenção de Estoque, que normalmente é usado para atividades relacionadas ao inventário.
labels	labels		array of string	Rótulos
warehouseId	warehouseId		string
availableToPromiseQuantity	availableToPromiseQuantity	True	integer	A quantidade.
itemSKU	itemSKU	True	string	A SKU do Item.
warehouseId	warehouseId		string	A SKU do Item.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a última vez que esse WarehouseItem foi obtido
nome	name	True	string	O nome da anotação.
value	value	True	string	O valor da observação.

Retornos

Corpo

GenerateFulfillmentOptionsResponse

Listar todas as execuções para determinado Fluxo de Dados

ID da operação:

DataInflowRun_ListDataInflowRuns

Lista todas as execuções para determinado nome de Fluxo de Dados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.

Retornos

response

array of DataInflowRun

Listar todas as execuções para determinado fluxo de saída de dados

ID da operação:

DataOutflowRun_ListDataOutflowRuns

Lista todas as execuções para determinado nome de Saída de Dados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.

Retornos

response

array of DataOutflowRun

Recupera a execução do fluxo de dados para a ID de execução

ID da operação:

DataInflowRun_GetDataInflowRun

Recupera a execução do fluxo de dados para determinada ID de execução.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.
A ID de execução do fluxo de dados.	dataInflowRunId	True	string	A ID de execução do fluxo de dados.

Retornos

Corpo

DataInflowRun

Recupera detalhes de execução para determinado fluxo de dados e ID de execução

ID da operação:

DataOutflowRun_GetDataOutflowRun

Recupera detalhes de execução para determinado nome de fluxo de dados e ID de execução.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.
O objeto de execução de fluxo de saída de dados.	dataOutflowRunId	True	string	O objeto de execução de fluxo de saída de dados.

Retornos

Corpo

DataOutflowRun

Recupera o cumprimento do pedido por ID de cumprimento da ordem

ID da operação:

OrderFulfillment_GetOrderFulfillment

Recupera o cumprimento do pedido por ID de cumprimento da ordem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID de cumprimento do pedido.	orderFulfillmentId	True	string	A ID de cumprimento do pedido.

Retornos

Corpo

OrderFulfillment

Recupera o fluxo de dados

ID da operação:

DataInflow_GetDataInflow

Recupera o fluxo de dados para determinado nome e workspace.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.

Retornos

Corpo

DataInflow

Recupera o fluxo de saída de dados

ID da operação:

DataOutflow_GetDataOutflow

Recupera o fluxo de saída de dados para determinado nome e workspace.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.

Retornos

Corpo

DataOutflow

Recupera os nós de entrega para determinado workspace

ID da operação:

DeliveryNode_GetAllDeliveryNodes

Recupera os nós de entrega para determinada ID do workspace.

Retornos

response

array of DeliveryNode

Recupera subdiretórios de um conjunto de dados

ID da operação:

Dataset_GetSubDirectoriesOfDataset

Recupera subdiretórios de um conjunto de dados que tem o nome especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do conjunto de dados.	name	True	string	O nome do conjunto de dados.

Retornos

response

array of Directory

Recupera todos os armazéns de um workspace

ID da operação:

Warehouse_GetAllWarehouses

Recupera todos os armazéns de um workspace.

Retornos

response

array of Warehouse

Recupera todos os conjuntos de dados de um workspace

ID da operação:

Dataset_GetAllDatasets

Recupera todos os conjuntos de dados de um workspace.

Retornos

response

array of Dataset

Recupera todos os fluxos de dados

ID da operação:

DataInflow_GetAllDataInflows

Recupera todos os fluxos de dados para determinado workspace.

Retornos

response

array of DataInflow

Recupera todos os fluxos de dados para um workspace

ID da operação:

DataOutflow_GetAllDataOutflows

Recupera todos os fluxos de dados para determinado workspace.

Retornos

response

array of DataOutflow

Recupera um conjunto de dados que tem o nome especificado

ID da operação:

Dataset_Get

Recupera um conjunto de dados que tem o nome especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O nome do conjunto de dados.	name	True	string	O nome do conjunto de dados.

Retornos

Corpo

Dataset

Recupera um item

ID da operação:

Item_Get

Recupera o item para determinada ID de workspace e sku.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O sku do item.	sku	True	string	O sku do item.

Retornos

Algo inventariado. Uma SKU, unidade de manutenção de estoque, refere-se a um item específico em uma unidade de medida específica.

Corpo

Item

Recupera um item de warehouse por ID do warehouse e sku de item

ID da operação:

WarehouseItem_Get

Recupera um item de warehouse por ID do warehouse e sku de item.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID do armazém.	warehouseId	True	string	A ID do armazém.
O sku do item.	itemSKU	True	string	O sku do item.

Retornos

Corpo

WarehouseItem

Recupera um nó de entrega

ID da operação:

DeliveryNode_Get

Recupera o nó de entrega para a ID do workspace fornecida e a ID do nó de entrega.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O identificador do nó de entrega.	deliveryNodeId	True	string	O identificador do nó de entrega.

Retornos

Os detalhes operacionais do local de entrega, por exemplo, localização, horas de operação etc.

Corpo

DeliveryNode

Recupera um pedido de remessa

ID da operação:

ShipmentOrder_Get

Recupera um pedido de remessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID do pedido de remessa.	shipmentOrderId	True	string	A ID do pedido de remessa.

Retornos

A ordem de remessa com detalhes como itens a serem enviados, informações de localizações de origem/destino, encargos etc...

Corpo

ShipmentOrder

Recupera um plano de cumprimento

ID da operação:

FulfillmentPlan_GetPlan

Recupera o plano de atendimento para a ID do workspace fornecida e a ID do plano de cumprimento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O identificador do plano de cumprimento.	fulfillmentPlanId	True	string	O identificador do plano de cumprimento.

Retornos

As atividades planejadas ou reais relacionadas ao cumprimento de uma ordem. Essas atividades podem incluir a criação da lista de seleção, a execução da lista de seleção, o empacotamento e a remessa dos itens para o destino final.

Corpo

FulfillmentPlan

Recupera um warehouse por ID de armazém

ID da operação:

Warehouse_Get

Recupera um depósito por ID do armazém.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID do armazém.	warehouseId	True	string	A ID do armazém.

Retornos

Corpo

Warehouse

Recupera uma cotação de remessa

ID da operação:

ShipmentQuote_Get

Recupera uma cotação de remessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID da cotação de remessa.	shipmentQuoteId	True	string	A ID da cotação de remessa.

Retornos

Os detalhes da cotação de remessa

Corpo

ShipmentQuote

Recupera uma lista de planos de atendimento com status de atendimento específico

ID da operação:

FulfillmentPlan_GetPlans

Recupera uma lista de planos de cumprimento com um status de atendimento específico para determinada ID do workspace e ID do armazém.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
O identificador do armazém.	warehouseId		string	O identificador do armazém.
O status de cumprimento.	status		string	O status de cumprimento.

Retornos

response

array of FulfillmentPlan

Recupera uma remessa por ID de remessa

ID da operação:

Shipment_Get

Recupera uma remessa por ID de remessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID da remessa.	shipmentId	True	string	A ID da remessa.

Retornos

Uma quantidade de itens, mercadorias ou carga em massa que são enviados juntos.

Corpo

Shipment

Recupera uma solicitação de cotação de remessa

ID da operação:

ShipmentQuoteRequest_Get

Recupera uma solicitação de cotação de remessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID da solicitação de cotação de remessa.	shipmentQuoteRequestId	True	string	A ID da solicitação de cotação de remessa.

Retornos

Os detalhes da Solicitação de Cotação de Remessa

Corpo

ShipmentQuoteRequest

Recupera uma transportadora com a ID da transportadora

ID da operação:

Carrier_Get

Recupera uma operadora com a ID da operadora para um workspace.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
A ID da transportadora	carrierId	True	string	A ID da transportadora.

Retornos

Corpo

Carrier

Definições

Portador

Nome	Caminho	Tipo	Description
id	id	string	O identificador exclusivo de uma Transportadora.
tipo	type	string	O tipo da transportadora só pode ser o que o OSCP dá suporte.
notas	notes	array of Note	ID da conta do lado da transportadora, ID do medidor etc., que será usada ao consultar a transportadora.

Observação

Um objeto genérico que contém um par de valores de nome pode ser usado para armazenar propriedades ou metadados não de primeira classe.

Nome	Caminho	Tipo	Description
nome	name	string	O nome da anotação.
value	value	string	O valor da observação.

DataInflow

Nome	Caminho	Tipo	Description
nome	name	string	Obtém ou define o nome de Fluxo de Dados Imutável e exclusivo em um workspace Esse seria o identificador exclusivo para um Fluxo de Dados. Fornecido pelo usuário como um parâmetro de URL obrigatório.
nome de exibição	displayName	string	Obtém ou define o nome de exibição do Fluxo de Dados
Datasetname	datasetName	string	Obtém ou define o nome do conjunto de dados para o conector
conector	connector	Connector
Transformador	transformer	Transformer
estado	state	string	Obtém ou define o estado do Fluxo de Dados

Conector

Nome	Caminho	Tipo	Description
tipo	type	string	Tipo do conector. Exemplo- CustomIngestion, CustomExport, FilterAndCopy
typeProperties	typeProperties	object	Propriedades relativas ao tipo de conector
saída	output	object	Contém os parâmetros de saída que seriam exibidos novamente para o cliente. Por exemplo, no caso do conector FilterAndCopy, a ID do convite e o local ads seriam retornados como parte da resposta.

Transformador

Nome	Caminho	Tipo	Description
tipo	type	string	Tipo de transformador
typeProperties	typeProperties	object	Propriedades relativas ao tipo de transformador

DataInflowRun

Nome	Caminho	Tipo	Description
dataInflowName	dataInflowName	string	Obtém ou define o nome de Fluxo de Dados Imutável e exclusivo em um workspace
runParams	runParams	object	Obtém ou define os parâmetros necessários para execução específica a um tipo de conector
dataInflowRunId	dataInflowRunId	string	Obtém ou define a ID de execução do fluxo de dados para a execução do fluxo de dados
triggeredAt	triggeredAt	date-time	Obtém ou define o tempo disparado para a execução do fluxo de dados
completedAt	completedAt	date-time	Obtém ou define o tempo concluído para a execução do fluxo de dados
status	status	string	Obtém ou define o status da Execução de Fluxo de Dados

DataOutflow

Nome	Caminho	Tipo	Description
nome	name	string	O nome do Fluxo de Dados que é imutável e exclusivo em um workspace. Esse seria o identificador exclusivo para um Fluxo de Saída de Dados. Fornecido pelo usuário como um parâmetro de URL obrigatório.
nome de exibição	displayName	string	O nome de exibição do Fluxo de Dados.
descrição	description	string	A descrição do Fluxo de Saída de Dados.
Datasetname	datasetName	string	Obtém ou define o nome do conjunto de dados para o conector
filteredEntities	filteredEntities	array of DataSchema	Obtém ou define o subconjunto de entidades a serem exportadas do conjunto de dados nomeado. Omitir essa propriedade padrão para todas as entidades que estão sendo exportadas.
conector	connector	Connector
Transformador	transformer	Transformer
estado	state	string	O estado do Fluxo de Saída de Dados.

DataSchema

Nome	Caminho	Tipo	Description
nome	name	string
attributes	attributes	array of DataSchemaAttribute

DataSchemaAttribute

Nome	Caminho	Tipo	Description
nome	name	string

DataOutflowRun

Nome	Caminho	Tipo	Description
dataOutflowName	dataOutflowName	string	Obtém ou define o nome do fluxo de dados
dataOutflowRunId	dataOutflowRunId	string	Obtém ou define a ID de Execução do Fluxo de Saída de Dados
runParams	runParams	object	Obtém ou define os parâmetros específicos para um tipo de conector
status	status	string	Obtém ou define o status da Execução do Fluxo de Saída de Dados
triggeredAt	triggeredAt	date-time	Obtém ou define o tempo disparado para a Execução do Fluxo de Saída de Dados
completedAt	completedAt	date-time	Obtém ou define o tempo concluído para a Execução do Fluxo de Saída de Dados
triggeredBy	triggeredBy	string	Obter ou definir o mecanismo por meio do qual essa execução foi disparada. Atualmente, por meio da API ou do evento Detset Ingestion Completion.
triggerId	triggerId	string	Obter ou definir o Identificador do mecanismo de gatilho.

Conjunto de dados

Nome	Caminho	Tipo	Description
nome	name	string	Obtém ou define o nome
dataSchema	dataSchema	array of DataSchema	Obtém ou define a coleção de entidades que fazem parte desse conjunto de dados. Atualmente, esse campo é opcional, no entanto, uma alteração futura o tornará necessário.
isDisabled	isDisabled	boolean	Obtém ou define um valor que indica se obtém ou define o que está desabilitado
operationalType	operationalType	string	Obtém ou define o tipo operacional: representa se os dados são transacionais (Cosmos) ou ADLS (longo prazo)
Schemareference	schemaReference	SchemaReference
labels	labels	array of string	Rótulos

Schemareference

Nome	Caminho	Tipo	Description
dataModelId	dataModelId	string	Obtém ou define a ID do modelo de dados
dataModelVersion	dataModelVersion	string	Obtém ou define o dataModelVersion
dataModelType	dataModelType	string	Obtém ou define o dataModelType

Diretório

Nome	Caminho	Tipo	Description
ingestionTime	ingestionTime	string	Obtém ou define o SnapshotTime
incrementType	incrementType	string	Obtém ou define o IncrementType

DeliveryNode

Os detalhes operacionais do local de entrega, por exemplo, localização, horas de operação etc.

Nome	Caminho	Tipo	Description
id	id	string	O identificador do nó.
hoursOfOperations	hoursOfOperations	array of HoursOfOperation	Uma lista de tempos de operação.
local	location	Location	Um local de uma estrutura física.
labels	labels	array of string	Rótulos
hora da última modificação	lastModifiedTime	date-time

HoursOfOperation

Tempo de operação em um dia da semana

Nome	Caminho	Tipo	Description
dayOfWeekName	dayOfWeekName	string	O dia da semana.
startTime	startTime	string	A hora de início.
endTime	endTime	string	A hora de término.

Localidade

Um local de uma estrutura física.

Nome	Caminho	Tipo	Description
Timezonename	timeZoneName	string	O identificador exclusivo de um fuso horário.
endereçoLinha1	addressLine1	string	O endereço primário.
endereçoLinha2	addressLine2	string	O endereço secundário.
cityName	cityName	string	O componente "cidade" de um local.
stateName	stateName	string	O nome do estado ou da província.
countryName	countryName	string	O nome do país.
postalCode	postalCode	string	O CEP.
notas	notes	array of Note	Uma lista de anotações de localização.

BulkResponseItemOfDeliveryNode

O objeto de resposta em massa genérico do tipo T

Nome	Caminho	Tipo	Description
código de status	statusCode	integer	O código de status de resposta da ação em massa.
response	response	DeliveryNode	Os detalhes operacionais do local de entrega, por exemplo, localização, horas de operação etc.
erro	error	ErrorObject	O código e a mensagem de detalhes do erro.
solicitação	request	DeliveryNode	Os detalhes operacionais do local de entrega, por exemplo, localização, horas de operação etc.

Errorobject

O código e a mensagem de detalhes do erro.

Nome	Caminho	Tipo	Description
codificar	code	string	O código do erro.
mensagem	message	string	A mensagem de erro legível humana.

BulkResponseItemOfString

O objeto de resposta em massa genérico do tipo T

Nome	Caminho	Tipo	Description
código de status	statusCode	integer	O código de status de resposta da ação em massa.
response	response	string	O objeto de resposta da ação em massa do tipo T.
erro	error	ErrorObject	O código e a mensagem de detalhes do erro.
solicitação	request	string	O objeto de solicitação do tipo T para a ação em massa.

GenerateFulfillmentOptionsResponse

Nome	Caminho	Tipo	Description
fulfillmentOptions	fulfillmentOptions	array of FulfillmentOption

FulfillmentOption

A opção de cumprimento.

Nome	Caminho	Tipo	Description
fulfillmentOptionId	fulfillmentOptionId	string	O identificador de uma opção de atendimento.
shipmentToLocation	shipmentToLocation	Location	Um local de uma estrutura física.
overallCost	overallCost	Amount	O valor em moeda específica.
earliestDeliveryTime	earliestDeliveryTime	string	O tempo de entrega mais antigo.
latestDeliveryTime	latestDeliveryTime	string	A hora de entrega mais recente.
tempo de expiração	expirationTime	string	A hora de expiração da opção de cumprimento.
fulfillmentPlans	fulfillmentPlans	array of FulfillmentPlan	Uma lista de planos de atendimento nesta opção de atendimento.

Montante

O valor em moeda específica.

Nome	Caminho	Tipo	Description
value	value	double
moeda	currency	string

FulfillmentPlan

As atividades planejadas ou reais relacionadas ao cumprimento de uma ordem. Essas atividades podem incluir a criação da lista de seleção, a execução da lista de seleção, o empacotamento e a remessa dos itens para o destino final.

Nome	Caminho	Tipo	Description
id	id	string	O identificador exclusivo de uma realização.
warehouseId	warehouseId	string	O identificador exclusivo de um armazém.
scheduledExecutionTime	scheduledExecutionTime	string
Orderlines	orderLines	array of OrderLine	As Linhas de Pedido que estão planejadas para serem atendidas pelo Plano de Cumprimento
Transferências	shipments	array of Shipment	As remessas de um plano de cumprimento
status	status	string	O status do Plano de Cumprimento.
motivo_de_status	statusReason	string
tempoDeCriação	creationTime	string	O carimbo de data/hora que o Plano de Cumprimento foi criado.

OrderLine

Um documento ou comissão do cliente para solicitar item.

Nome	Caminho	Tipo	Description
ID do pedido	orderId	string	O número exclusivo que identifica uma ordem.
itemSKU	itemSKU	string	SKU do item.
quantidade	quantity	integer	A quantidade de itens.
plannedEarliestDeliveryDateTime	plannedEarliestDeliveryDateTime	string	O datetime mais antigo em que o pedido deve ser entregue.
plannedLatestDeliveryDateTime	plannedLatestDeliveryDateTime	string	O datetime mais recente em que o pedido deve ser entregue.

Shipment

Uma quantidade de itens, mercadorias ou carga em massa que são enviados juntos.

Nome	Caminho	Tipo	Description
id	id	string	O identificador exclusivo de uma remessa.
status	status	string	O status da remessa.
shipmentOrderIds	shipmentOrderIds	array of string	A lista de IDs de pedido de remessa que são atendidas pela Remessa.
shipmentLocationData	shipmentLocationData	array of ShipmentLocation	Os dados dos locais da remessa. Atualmente, dá suporte apenas ao tipo de localização Origem e Destino.
shipmentPackingData	shipmentPackingData	ShipmentPackingData	Os dados de empacotamento de remessa com detalhes das medidas do pacote
shipmentCharge	shipmentCharge	ShipmentCharge	Os detalhes da Cobrança de Remessa
shipmentReferenceData	shipmentReferenceData	ShipmentReferenceData	Os dados de referência de remessa que contém os detalhes para acompanhar o pacote.
shipmentItems	shipmentItems	array of ShipmentItem	A lista de itens a serem enviados como parte da remessa.
estimatedPickupTime	estimatedPickupTime	string	A hora de retirada planejada da ordem de remessa.
estimatedEarliestPickupTime	estimatedEarliestPickupTime	string	A primeira hora de retirada planejada da ordem de remessa.
estimatedLatestPickupTime	estimatedLatestPickupTime	string	A hora de retirada mais recente planejada do Pedido de Remessa.
estimatedDeliveryTime	estimatedDeliveryTime	string	O tempo de entrega planejado do Pedido de Remessa.
estimatedEarliestDeliveryTime	estimatedEarliestDeliveryTime	string	O horário de entrega mais antigo planejado da Ordem de Remessa.
estimatedLatestDeliveryTime	estimatedLatestDeliveryTime	string	O horário de entrega mais recente planejado do Pedido de Remessa.
shipmentContentData	shipmentContentData	ShipmentContentData	Os Dados de Conteúdo de Remessa que indicam a presença de determinados tipos de itens, como bateria ou frágeis.
hora da última modificação	lastModifiedTime	date-time	Obtém ou define a hora da última modificação
deliveryInstructions	deliveryInstructions	object	As instruções de entrega da Remessa.
customAttributes	customAttributes	object	Informações adicionais de remessa capturadas como pares chave-valor.
carrierName	carrierName	string	O nome da transportadora para a remessa

ShipmentLocation

Os detalhes do local de envio

Nome	Caminho	Tipo	Description
shipmentNodeType	shipmentNodeType	string	O tipo de nó de remessa. Atualmente, há suporte apenas para Origem e Destino.
locationType	locationType	string	O tipo De localização representa se o Local é um armazém, um cliente etc.
nome do contato	contactName	string	O nome de contato de uma pessoa relacionada ao Local
contactNumber	contactNumber	string	O número de contato de uma pessoa relacionada ao Local
local	location	Location	Um local de uma estrutura física.
customAttributes	customAttributes	object	Informações adicionais de Localização de Remessa capturadas como pares chave-valor.

ShipmentPackingData

Os dados de empacotamento de remessa com detalhes das medidas do pacote

Nome	Caminho	Tipo	Description
shipmentVolume	shipmentVolume	double	O volume
shipmentNetWeight	shipmentNetWeight	double	O Peso
volumeUnitOfMeasure	volumeUnitOfMeasure	string	A unidade de volume da medida
weightUnitOfMeasure	weightUnitOfMeasure	string	A unidade de peso da medida
shipmentLength	shipmentLength	double	O comprimento
shipmentWidth	shipmentWidth	double	A Largura
shipmentHeight	shipmentHeight	double	A Altura
lwhUnitOfMeasure	lwhUnitOfMeasure	string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType	string	O tipo de empacotamento de remessa

Carregamento de carga

Os detalhes da Cobrança de Remessa

Nome	Caminho	Tipo	Description
estimatedCost	estimatedCost	double	O custo estimado
código de moeda	currencyCode	string	O código de moeda
billingData	billingData	BillingData	Os detalhes de cobrança
componentCharges	componentCharges	array of ComponentCharge	O componente cobra dados

BillingData

Os detalhes de cobrança

Nome	Caminho	Tipo	Description
customerId	customerId	string	A ID do cliente
nomeDoCliente	customerName	string	O Nome do Cliente
customAttributes	customAttributes	object	Informações adicionais de Dados de Cobrança capturadas como pares chave-valor

ComponentCharge

Os dados de cobrança do componente

Nome	Caminho	Tipo	Description
totalComponentCharge	totalComponentCharge	double	A carga total
chargeTypeId	chargeTypeId	string	A ID do tipo de cobrança
chargeTypeName	chargeTypeName	string	O nome do tipo de cobrança
éOpcional	isOptional	boolean	O sinalizador IsOptional será definido como True se os encargos relacionados ao componente forem opcionais. Else False

ShipmentReferenceData

Os dados de referência de remessa que contém os detalhes para acompanhar o pacote.

Nome	Caminho	Tipo	Description
número de rastreamento	trackingNumber	string	O número de acompanhamento
trackingUrl	trackingUrl	string	A URL de Acompanhamento
shipLabelUrl	shipLabelUrl	string	A URL do rótulo Ship

ShipmentItem

Nome	Caminho	Tipo	Description
itemSKU	itemSKU	string	SKU do item.
quantidade	quantity	integer	A quantidade do item.

ShipmentContentData

Os Dados de Conteúdo de Remessa que indicam a presença de determinados tipos de itens, como bateria ou frágeis.

Nome	Caminho	Tipo	Description
isFragile	isFragile	boolean	O sinalizador IsFragile será definido como true se houver itens frágeis. Caso contrário, False.
includesBattery	includesBattery	boolean	O sinalizador IncludesBattery será definido como true se a bateria fizer parte do pacote. Caso contrário, False.

Item

Algo inventariado. Uma SKU, unidade de manutenção de estoque, refere-se a um item específico em uma unidade de medida específica.

Nome	Caminho	Tipo	Description
nome	name	string	O nome do Item.
descrição	description	string	A descrição do Item.
códigos de barras	barcodes	array of Barcode	Uma lista de códigos de barras do item.
weight	weight	double	O peso do item padrão.
length	length	double	O comprimento do item padrão.
largura	width	double	A largura do item padrão.
profundidade	depth	double	A profundidade do item padrão.
abreviação	lwhUnitOfMeasure.abbreviation	string	A unidade de comprimento, largura e altura da medida.
abreviação	weightUnitOfMeasure.abbreviation	string	A unidade de peso da medida.
hora da última modificação	lastModifiedTime	date-time	Obtém ou define a hora da última modificação
sku	sku	string	O identificador de Unidade de Manutenção de Estoque, que normalmente é usado para atividades relacionadas ao inventário.
labels	labels	array of string	Rótulos

Código de barras

Nome	Caminho	Tipo	Description
value	value	string	O valor do código de barras.
Standardname	standardName	string	O nome padrão do código de barras.

WarehouseItem

Nome	Caminho	Tipo	Description
availableToPromiseQuantity	availableToPromiseQuantity	integer	A quantidade.
itemSKU	itemSKU	string	A SKU do Item.
warehouseId	warehouseId	string	A SKU do Item.
hora da última modificação	lastModifiedTime	date-time	Obtém ou define a última vez que esse WarehouseItem foi obtido

BulkResponseItemOfItem

O objeto de resposta em massa genérico do tipo T

Nome	Caminho	Tipo	Description
código de status	statusCode	integer	O código de status de resposta da ação em massa.
response	response	Item	Algo inventariado. Uma SKU, unidade de manutenção de estoque, refere-se a um item específico em uma unidade de medida específica.
erro	error	ErrorObject	O código e a mensagem de detalhes do erro.
solicitação	request	Item	Algo inventariado. Uma SKU, unidade de manutenção de estoque, refere-se a um item específico em uma unidade de medida específica.

OrderFulfillment

Nome	Caminho	Tipo	Description
Orderlines	orderLines	array of OrderLine
shipmentToLocation	shipmentToLocation	Location	Um local de uma estrutura física.
shipmentToName	shipmentToName	string
shipmentReceiverContact	shipmentReceiverContact	string
status	status	string
id	id	string
fulfillmentPlanIds	fulfillmentPlanIds	array of string
tempoDeCriação	creationTime	date-time
hora da última modificação	lastModifiedTime	date-time
notas	notes	array of Note

ShipmentOrder

A ordem de remessa com detalhes como itens a serem enviados, informações de localizações de origem/destino, encargos etc...

Nome	Caminho	Tipo	Description
id	id	string	O identificador exclusivo de uma ordem de remessa.
shipmentId	shipmentId	string	O identificador de uma remessa que envia esta ordem de remessa.
status	status	string	O status da ordem de remessa.
shipmentItems	shipmentItems	array of ShipmentItem	Os itens de remessa que fazem parte da ordem de remessa.
shipmentLocationData	shipmentLocationData	array of ShipmentLocation	Os dados dos locais da ordem de remessa. Atualmente, dá suporte apenas ao tipo de localização Origem e Destino.
shipmentPackingData	shipmentPackingData	ShipmentPackingData	Os dados de empacotamento de remessa com detalhes das medidas do pacote
shipmentCharge	shipmentCharge	ShipmentCharge	Os detalhes da Cobrança de Remessa
plannedPickupTime	plannedPickupTime	string	A hora de retirada planejada da ordem de remessa.
plannedEarliestPickupTime	plannedEarliestPickupTime	string	A primeira hora de retirada planejada da ordem de remessa.
plannedLatestPickupTime	plannedLatestPickupTime	string	A hora de retirada mais recente planejada do Pedido de Remessa.
plannedDeliveryTime	plannedDeliveryTime	string	O tempo de entrega planejado do Pedido de Remessa.
plannedEarliestDeliveryTime	plannedEarliestDeliveryTime	string	O horário de entrega mais antigo planejado da Ordem de Remessa.
plannedLatestDeliveryTime	plannedLatestDeliveryTime	string	O horário de entrega mais recente planejado do Pedido de Remessa.
shipmentContentData	shipmentContentData	ShipmentContentData	Os Dados de Conteúdo de Remessa que indicam a presença de determinados tipos de itens, como bateria ou frágeis.
deliveryInstructions	deliveryInstructions	object	As instruções de entrega do Pedido de Remessa.
customAttributes	customAttributes	object	Informações adicionais do Pedido de Remessa capturadas como pares chave-valor.
hora da última modificação	lastModifiedTime	date-time	Obtém ou define a hora da última modificação

BulkResponseItemOfShipmentOrder

O objeto de resposta em massa genérico do tipo T

Nome	Caminho	Tipo	Description
código de status	statusCode	integer	O código de status de resposta da ação em massa.
response	response	ShipmentOrder	A ordem de remessa com detalhes como itens a serem enviados, informações de localizações de origem/destino, encargos etc...
erro	error	ErrorObject	O código e a mensagem de detalhes do erro.
solicitação	request	ShipmentOrder	A ordem de remessa com detalhes como itens a serem enviados, informações de localizações de origem/destino, encargos etc...

ShipmentQuote

Os detalhes da cotação de remessa

Nome	Caminho	Tipo	Description
id	id	string	O identificador exclusivo de uma cotação de remessa.
shipmentQuoteRequestId	shipmentQuoteRequestId	string	O identificador da solicitação de cotação de remessa à qual a cotação de remessa está relacionada.
shipmentCharge	shipmentCharge	ShipmentCharge	Os detalhes da Cobrança de Remessa
plannedPickupTime	plannedPickupTime	string	A hora de retirada planejada da remessa.
plannedDeliveryTime	plannedDeliveryTime	string	O tempo de entrega planejado da remessa.
carrierData	carrierData	CarrierData	Os dados da transportadora
customAttributes	customAttributes	object	Informações adicionais de Cotação de Remessa capturadas como pares chave-valor.
hora da última modificação	lastModifiedTime	date-time	Obtém ou define a hora da última modificação

CarrierData

Os dados da transportadora

Nome	Caminho	Tipo	Description
carrierId	carrierId	string	A ID da transportadora
carrierName	carrierName	string	O nome da transportadora

ShipmentQuoteRequest

Os detalhes da Solicitação de Cotação de Remessa

Nome	Caminho	Tipo	Description
id	id	string	O identificador exclusivo de uma Solicitação de Cotação de Remessa.
shipmentItems	shipmentItems	array of ShipmentItem	Os itens de remessa que fazem parte da ordem de remessa.
shipmentLocationData	shipmentLocationData	array of ShipmentLocation	Os dados dos locais correspondentes à Solicitação de Cotação de Remessa. Atualmente, dá suporte apenas ao tipo de localização Origem e Destino.
shipmentPackingData	shipmentPackingData	ShipmentPackingData	Os dados de empacotamento de remessa com detalhes das medidas do pacote
shipmentQuoteIds	shipmentQuoteIds	array of string	As IDs de cotação de remessa correspondentes à solicitação de cotação de remessa
plannedPickupTime	plannedPickupTime	string	A hora de retirada planejada da remessa.
plannedDeliveryTime	plannedDeliveryTime	string	O tempo de entrega planejado da remessa.
hora da última modificação	lastModifiedTime	date-time	Obtém ou define a hora da última modificação

Armazém

Nome	Caminho	Tipo	Description
id	id	string	O identificador do nó.
hoursOfOperations	hoursOfOperations	array of HoursOfOperation	Uma lista de tempos de operação.
local	location	Location	Um local de uma estrutura física.
labels	labels	array of string	Rótulos
hora da última modificação	lastModifiedTime	date-time
pickAndPackLeadTime	pickAndPackLeadTime	integer	Obtém ou define o PickAndPackLeadTime, que é o número de horas exigido pelo Warehouse para escolher e empacotar o item
carrierReferences	carrierReferences	array of CarrierReference	A lista de informações da Transportadora

CarrierReference

Nome	Caminho	Tipo	Description
carrierId	carrierId	string	ID da transportadora associada
cutoffTime	cutoffTime	string	Tempo de corte da transportadora em relação ao armazém.
servingLocations	servingLocations	array of Location	Localizações de serviço que contém uma lista de cepco para a qual a transportadora atual pode servir. Lista nula ou vazia significa que essa transportadora pode servir a qualquer cep.
servingNodeIds	servingNodeIds	array of string	Atendendo identificadores de nó, que contém uma lista de IDs de nó para as quais a transportadora atual pode servir. Lista nula ou vazia significa que essa transportadora pode servir a qualquer nó.

BulkResponseItemOfWarehouse

O objeto de resposta em massa genérico do tipo T

Nome	Caminho	Tipo	Description
código de status	statusCode	integer	O código de status de resposta da ação em massa.
response	response	Warehouse
erro	error	ErrorObject	O código e a mensagem de detalhes do erro.
solicitação	request	Warehouse

BulkResponseItemOfWarehouseItem

O objeto de resposta em massa genérico do tipo T

Nome	Caminho	Tipo	Description
código de status	statusCode	integer	O código de status de resposta da ação em massa.
response	response	WarehouseItem
erro	error	ErrorObject	O código e a mensagem de detalhes do erro.
solicitação	request	WarehouseItem

arquivo

Esse é o tipo de dados básico 'file'.