Plataforma Aberta da Cadeia de Abastecimento (Pré-visualização)

O Serviço Open Supply Chain Platform (OSCP) fornece uma API REST poderosa e extensa. Usando estas APIs, o cliente pode criar e gerir o OrderFulfillment, um armazém em OSCP. A OSCP irá integrar-se com múltiplos parceiros, incluindo retalhistas, fornecedores logísticos e empresas de armazenagem, entre outros, e impulsionará eficiências de ponta a ponta em toda a cadeia de abastecimento, integrando dados, operações e análises entre os parceiros.

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

Service	Classe	Regiões
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes:      - Regiões Azure Government      - Regiões Azure China      - Departamento de Defesa dos EUA (DoD)

Entrar em contato
Nome	Microsoft
URL	https://azure.microsoft.com/support/

Metadados do conector
Editor	Corporação Microsoft
Sítio Web	https://azure.microsoft.com/
Política de privacidade	https://www.microsoft.com/en-in/trust-center/privacy
Categorias	Colaboração; Dados

A Open Supply Chain Platform (OSCP) é um serviço Azure que fornece uma plataforma extensível para descobrir, consumir e expandir aplicações de cadeia de abastecimento prontas a ser desenvolvidas pela Microsoft e parceiros. Estas aplicações ajudam as organizações a desbloquear insights e eficiências de negócio valiosos a partir de dados dentro da sua organização e além.

Pré-requisitos

Deve ser utilizador numa aplicação OSCP para usar este conector. Tens de ter um espaço de trabalho criado no OSCP. Deve usar um ID Microsoft Entra.

Como obter credenciais

Para adicionar este conector ao seu fluxo de trabalho, deve primeiro iniciar sessão na conta Microsoft Entra ID com o OSCP Role (Contibutor/Reader) na aplicação OSCP à qual pretende ligar-se.

Erros e soluções comuns

Se o utilizador não tiver acesso ao contínuo OSCP no espaço de trabalho, o utilizador receberá o erro workspace not found(404). Para resolver isto, o utilizador precisa de ter acesso ao contiutor OSCP para o espaço de trabalho.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição	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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 espaço de trabalho	cadeia (de caracteres)	Especifique apenas o ID do seu Workspace	Verdade

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Apaga um armazém pelo ID do armazém	Apaga um armazém pelo ID do armazém.
Apaga um item do armazém pelo ID do armazém e pelo sku do item	Apaga um artigo do armazém pelo ID do armazém e pelo SKU do item.
Apaga um item para um determinado SKU	Apaga um item para um determinado SKU.
Apaga uma lista de armazéns	Apaga uma lista de armazéns para o ID de espaço de trabalho e uma lista de IDs de armazém
Apaga uma lista de itens do armazém por IDs de armazém	Apaga uma lista de itens do armazém por IDs de armazém.
Apaga uma lista de itens para os skus dados	Apaga uma lista de itens para determinados SKUs.
Apaga uma operadora com ID de operadora	Apaga um carteiro com ID de carteira para um espaço de trabalho.
Atualiza um pedido de orçamento de envio	Atualiza um pedido de orçamento de envio.
Atualiza um plano de cumprimento	Atualiza um plano de cumprimento com ID de espaço de trabalho, ID do plano de cumprimento e carga útil do plano de cumprimento.
Atualiza uma remessa	Atualiza uma remessa.
Atualizações de uma encomenda de envio	Atualiza uma encomenda de envio.
Cancela o cumprimento de encomendas por ID de cumprimento de encomenda	Cancela o cumprimento da encomenda pelo ID de cumprimento da encomenda.
Cria novo cumprimento de encomendas para ID de cumprimento de encomendas	Cria um novo cumprimento de encomendas para o ID de cumprimento de encomendas.
Cria o pedido de corrida de entrada de dados	Cria o pedido de corrida de entrada de dados para um espaço de trabalho.
Cria ou atualiza a saída de dados	Cria ou atualiza o fluxo de dados para um espaço de trabalho.
Cria ou atualiza o fluxo de dados	Cria ou atualiza o fluxo de dados para um espaço de trabalho.
Cria ou atualiza um armazém	Cria ou atualiza um armazém pelo ID do armazém.
Cria ou atualiza um artigo de armazém	Cria ou atualiza um artigo de armazém por ID de armazém e SKU do item.
Cria ou atualiza um conjunto de dados	Cria ou atualiza um conjunto de dados com um nome especificado.
Cria ou atualiza um item	Cria ou atualiza o item para o ID do workspace e o SKU atribuídos.
Cria ou atualiza um nó de entrega	Cria ou atualiza o nó de entrega para o ID do workspace e o ID do nó de entrega.
Cria ou atualiza um operador com o ID do operador	Cria ou atualiza um operador com o ID do operador para um espaço de trabalho.
Cria ou atualiza um orçamento de envio	Cria ou atualiza um orçamento de envio.
Cria ou atualiza uma lista de itens	Cria ou atualiza uma lista de itens para o ID do espaço de trabalho e skus dados.
Cria ou atualiza uma lista de itens do armazém	Cria ou atualiza uma lista de itens do armazém por ID do armazém e sku do item.
Cria ou atualiza uma lista de nós de entrega	Cria ou atualiza uma lista de nós de entrega para o ID de workspace e o ID do nó de entrega.
Cria um pedido de orçamento de envio	Cria um pedido de orçamento de envio.
Cria uma encomenda de envio	Cria uma encomenda de envio.
Cria uma lista de armazéns	Cria uma lista de armazéns para o ID do espaço de trabalho e uma lista de objetos do armazém.
Cria uma lista de encomendas de envio	Cria uma lista de encomendas de envio.
Cria uma remessa	Cria um envio.
Desencadeia uma execução para uma instância de Data Outflow	Desencadeia uma execução para a instância Data Outflow com o nome próprio.
Elimina a saída de dados	Elimina o fluxo de dados para o nome próprio e o espaço de trabalho.
Elimina o fluxo de dados	Elimina o fluxo de dados para o nome próprio e o espaço de trabalho.
Elimina o nó de entrega	Elimina o nó de entrega para o ID do workspace e do ID do nó de entrega.
Elimina um conjunto de dados com nome especificado	Apaga um conjunto de dados com nome especificado.
Elimina uma lista de nós de entrega	Apaga os nós de entrega para os IDs de nós de entrega indicados.
Gera opções de cumprimento	Gera opções de fulfillment para o ID do workspace e pedido de fulfillment
Liste todas as execuções para o dado Fluxo de Dados	Liste todas as execuções para o nome dado de Data Inflow.
Liste todas as execuções para o dado fluxo de dados	Liste todas as execuções para o nome Data Outflow referido.
Recupera a corrida de entrada de dados para ID de execução	Recupera a corrida de entrada de dados para o ID de execução dado.
Recupera a saída de dados	Recupera o fluxo de dados para o nome próprio e o espaço de trabalho.
Recupera detalhes de execução para dados dados de saída e ID de execução	Recupera os detalhes da execução para o nome de saída e ID da corrida dados dados.
Recupera o cumprimento de encomendas por ID de cumprimento de encomendas	Recupera o cumprimento de encomendas por ID de cumprimento de encomendas.
Recupera o fluxo de dados	Recupera o fluxo de dados para o nome dado e o espaço de trabalho.
Recupera os nós de entrega para um dado espaço de trabalho	Recupera os nós de entrega para o ID do workspace atribuído.
Recupera subdiretórios de um conjunto de dados	Recupera subdiretórios de um conjunto de dados com nome especificado.
Recupera todos os armazéns para um espaço de trabalho	Recupera todos os armazéns para um espaço de trabalho.
Recupera todos os conjuntos de dados para um espaço de trabalho	Recupera todos os conjuntos de dados para um espaço de trabalho.
Recupera todos os fluxos de dados	Recupera todos os fluxos de dados para o determinado espaço de trabalho.
Recupera todos os fluxos de dados para um espaço de trabalho	Recupera todos os fluxos de dados para o determinado espaço de trabalho.
Recupera um armazém pelo ID do armazém	Recupera um armazém pelo ID do armazém.
Recupera um conjunto de dados com nome especificado	Recupera um conjunto de dados com nome especificado.
Recupera um item	Recupera o item para o ID do espaço de trabalho e sku.
Recupera um item do armazém pelo ID do armazém e pelo sku do item	Recupera um item do armazém pelo ID do armazém e pelo sku do item.
Recupera um nó de entrega	Recupera o nó de entrega para o ID do workspace e o ID do nó de entrega.
Recupera um orçamento de envio	Recupera um orçamento de envio.
Recupera um pedido de orçamento de envio	Recupera um pedido de orçamento de envio.
Recupera um plano de cumprimento	Recupera o plano de cumprimento para o ID do espaço de trabalho e o ID do plano de cumprimento.
Recupera um portador com ID de carteira	Recupera um carteiro com o ID do transportador para um espaço de trabalho.
Recupera uma encomenda de envio	Recupera uma encomenda de envio.
Recupera uma lista de planos de cumprimento com estado específico de cumprimento	Recupera uma lista de planos de fulfillment com o estado de fulfillment specifica para o ID do workspace e do warehouse ID.
Recupera uma remessa pelo ID da remessa	Recupera uma remessa pelo ID da remessa.

Apaga um armazém pelo ID do armazém

ID da Operação:

Warehouse_Delete

Apaga um armazém pelo ID do armazém.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do depósito.	warehouseId	True	string	O ID do depósito.

Devoluções

response

file

Apaga um item do armazém pelo ID do armazém e pelo sku do item

ID da Operação:

WarehouseItem_Delete

Apaga um artigo do armazém pelo ID do armazém e pelo SKU do item.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do depósito.	warehouseId	True	string	O ID do depósito.
O item sku.	itemSKU	True	string	O item sku.

Devoluções

response

file

Apaga um item para um determinado SKU

ID da Operação:

Item_Delete

Apaga um item para um determinado SKU.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O item sku.	sku	True	string	O item sku.

Devoluções

response

file

Apaga uma lista de armazéns

ID da Operação:

Warehouse_BulkDelete

Apaga uma lista de armazéns para o ID de espaço de trabalho e uma lista de IDs de armazém

Parâmetros

Name	Chave	Necessário	Tipo	Description
warehouseIds	warehouseIds	True	array of string

Devoluções

response

array of BulkResponseItemOfString

Apaga uma lista de itens do armazém por IDs de armazém

ID da Operação:

WarehouseItem_BulkDelete

Apaga uma lista de itens do armazém por IDs de armazém.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do depósito.	warehouseId	True	string	O ID do depósito.
itemSKUs	itemSKUs	True	array of string

Devoluções

response

array of BulkResponseItemOfString

Apaga uma lista de itens para os skus dados

ID da Operação:

Item_BulkDelete

Apaga uma lista de itens para determinados SKUs.

Parâmetros

Name	Chave	Necessário	Tipo	Description
skus	skus	True	array of string

Devoluções

response

array of BulkResponseItemOfString

Apaga uma operadora com ID de operadora

ID da Operação:

Carrier_Delete

Apaga um carteiro com ID de carteira para um espaço de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da operadora.	carrierId	True	string	O ID da operadora.

Devoluções

response

file

Atualiza um pedido de orçamento de envio

ID da Operação:

ShipmentQuoteRequest_UpdateShipmentQuoteRequest

Atualiza um pedido de orçamento de envio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do pedido de orçamento de envio.	shipmentQuoteRequestId	True	string	O ID do pedido de orçamento de envio.
id	id	True	string	O identificador único de um Pedido de Orçamento de Envio.
itemSKU	itemSKU	True	string	O artigo é SKU.
quantidade	quantity	True	integer	A quantidade do item.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de envio. Atualmente, apenas Origin e Destination são suportados.
locationType	locationType		string	O tipo de localização representa se a localização é um armazém, cliente, etc.
nomedocontato	contactName		string	O nome de contacto de uma pessoa relacionada com a Localização
Número de contacto	contactNumber		string	O número de contacto de uma pessoa relacionada com a Localização
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
customAttributes	customAttributes		object	Informação adicional de Localização do Envio capturada como pares-chave-valor.
Volume de envio	shipmentVolume	True	double	O Volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnidadeDeMedida	volumeUnitOfMeasure		string	A Unidade de Volume de medida
PesoUnidadeDeMedida	weightUnitOfMeasure		string	A Unidade de Peso de Medida
EnvioComprimento	shipmentLength	True	double	A Duração
Largura de envio	shipmentWidth	True	double	A Largura
Carga Altura	shipmentHeight	True	double	A Altura
lwhUnidadeDeMedida	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de embalagem do envio
shipmentQuoteIds	shipmentQuoteIds		array of string	Os IDs do Orçamento de Envio correspondentes ao Pedido de Orçamento de Envio
Hora de Recolha planeada	plannedPickupTime		string	A hora planeada de recolha do Shipment.
planeadoTempo de EntregaT	plannedDeliveryTime		string	A hora planeada de entrega do Shipment.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define o último tempo modificado

Devoluções

Detalhes do Pedido de Orçamento de Envio

Corpo

ShipmentQuoteRequest

Atualiza um plano de cumprimento

ID da Operação:

FulfillmentPlan_UpdatePlan

Atualiza um plano de cumprimento com ID de espaço de trabalho, ID do plano de cumprimento e carga útil do plano de cumprimento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O identificador do plano de cumprimento.	fulfillmentPlanId	True	string	O identificador do plano de cumprimento.
id	id		string	O identificador único de uma realização.
warehouseId	warehouseId		string	O identificador único de um armazém.
Tempo de Execução Programado	scheduledExecutionTime		string
ID do Pedido	orderId	True	string	O número único que identifica uma Ordem.
itemSKU	itemSKU	True	string	O artigo é SKU.
quantidade	quantity	True	integer	A quantidade de artigos.
planeadoCedoEntregaHoraHora	plannedEarliestDeliveryDateTime		string	A data mais cedo em que a encomenda deve ser entregue.
planeadoLatestEntregaHoraHora	plannedLatestDeliveryDateTime	True	string	A data mais tardia em que a encomenda deve ser entregue.
id	id	True	string	O identificador único de um Envio.
estado	status		string	O estado da remessa.
shipmentOrderIds	shipmentOrderIds		array of string	A lista de IDs de Encomendas de Envio que são tratadas pelo Envio.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de envio. Atualmente, apenas Origin e Destination são suportados.
locationType	locationType		string	O tipo de localização representa se a localização é um armazém, cliente, etc.
nomedocontato	contactName		string	O nome de contacto de uma pessoa relacionada com a Localização
Número de contacto	contactNumber		string	O número de contacto de uma pessoa relacionada com a Localização
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
customAttributes	customAttributes		object	Informação adicional de Localização do Envio capturada como pares-chave-valor.
Volume de envio	shipmentVolume	True	double	O Volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnidadeDeMedida	volumeUnitOfMeasure		string	A Unidade de Volume de medida
PesoUnidadeDeMedida	weightUnitOfMeasure		string	A Unidade de Peso de Medida
EnvioComprimento	shipmentLength	True	double	A Duração
Largura de envio	shipmentWidth	True	double	A Largura
Carga Altura	shipmentHeight	True	double	A Altura
lwhUnidadeDeMedida	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de embalagem do envio
custo estimado	estimatedCost	True	double	O Custo Estimado
código da moeda	currencyCode	True	string	O Código Monetário
ID do cliente	customerId		string	O ID do Cliente
nome_do_cliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informação adicional de dados de faturação capturada como pares-chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	O ID do tipo de carga
chargeTypeName	chargeTypeName		string	O nome do tipo de carga
isOpcional	isOptional	True	boolean	A bandeira IsOptional é definida para True se as cobranças relacionadas com o componente forem opcionais. Else False
trackingNumber	trackingNumber		string	O número de rastreio
trackingUrl	trackingUrl		string	O URL de Rastreio
shipLabelUrl	shipLabelUrl		string	A URL da etiqueta do navio
itemSKU	itemSKU	True	string	O artigo é SKU.
quantidade	quantity	True	integer	A quantidade do item.
estimadoTempo de Recolha	estimatedPickupTime		string	A hora planeada de recolha da Encomenda de Envio.
estimadoTempoDeApanhaDeMais Cedo	estimatedEarliestPickupTime		string	A hora planeada de recolha mais cedo da Encomenda de Envio.
estimadoTempo de Recolha Mais Recente	estimatedLatestPickupTime		string	A hora mais tardia planeada para recolha da Encomenda de Envio.
estimadoTempoDeEntrega	estimatedDeliveryTime		string	O tempo planeado de entrega da Encomenda de Envio.
estimadoTempoDeEntregaCedoEstimado	estimatedEarliestDeliveryTime		string	A hora planeada de entrega mais cedo da Encomenda de Envio.
estimadoLatestEntregaTempo	estimatedLatestDeliveryTime		string	A hora mais tardia planeada para a entrega da Encomenda de Envio.
éFrágil	isFragile	True	boolean	A flag IsFragile está definida como verdadeira se existirem itens frágeis. Caso contrário, é falso.
inclui Bateria	includesBattery	True	boolean	A flag IncludesBattery está definida como true se a bateria fizer parte do pacote. Caso contrário, é falso.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define o último tempo modificado
Instruções de entrega	deliveryInstructions		object	As instruções de entrega do Shipment.
customAttributes	customAttributes		object	Informação adicional de envio capturada como pares-chave-valor.
carrierName	carrierName		string	O nome do transportador para a remessa
estado	status		string	O estado do Plano de Cumprimento.
statusRazão	statusReason		string
tempo de criação	creationTime		string	O carimbo temporal em que o Plano de Cumprimento foi criado.

Devoluções

As atividades planeadas ou efetivas relacionadas com o cumprimento de uma ordem. Estas atividades podem incluir Criação da Lista de Escolhas, Execução da Lista de Escolhas, Embalagem e Envio do(s) artigo(s) para o destino final.

Corpo

FulfillmentPlan

Atualiza uma remessa

ID da Operação:

Shipment_UpdateShipment

Atualiza uma remessa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do envio.	shipmentId	True	string	O ID do envio.
id	id	True	string	O identificador único de um Envio.
estado	status		string	O estado da remessa.
shipmentOrderIds	shipmentOrderIds		array of string	A lista de IDs de Encomendas de Envio que são tratadas pelo Envio.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de envio. Atualmente, apenas Origin e Destination são suportados.
locationType	locationType		string	O tipo de localização representa se a localização é um armazém, cliente, etc.
nomedocontato	contactName		string	O nome de contacto de uma pessoa relacionada com a Localização
Número de contacto	contactNumber		string	O número de contacto de uma pessoa relacionada com a Localização
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
customAttributes	customAttributes		object	Informação adicional de Localização do Envio capturada como pares-chave-valor.
Volume de envio	shipmentVolume	True	double	O Volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnidadeDeMedida	volumeUnitOfMeasure		string	A Unidade de Volume de medida
PesoUnidadeDeMedida	weightUnitOfMeasure		string	A Unidade de Peso de Medida
EnvioComprimento	shipmentLength	True	double	A Duração
Largura de envio	shipmentWidth	True	double	A Largura
Carga Altura	shipmentHeight	True	double	A Altura
lwhUnidadeDeMedida	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de embalagem do envio
custo estimado	estimatedCost	True	double	O Custo Estimado
código da moeda	currencyCode	True	string	O Código Monetário
ID do cliente	customerId		string	O ID do Cliente
nome_do_cliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informação adicional de dados de faturação capturada como pares-chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	O ID do tipo de carga
chargeTypeName	chargeTypeName		string	O nome do tipo de carga
isOpcional	isOptional	True	boolean	A bandeira IsOptional é definida para True se as cobranças relacionadas com o componente forem opcionais. Else False
trackingNumber	trackingNumber		string	O número de rastreio
trackingUrl	trackingUrl		string	O URL de Rastreio
shipLabelUrl	shipLabelUrl		string	A URL da etiqueta do navio
itemSKU	itemSKU	True	string	O artigo é SKU.
quantidade	quantity	True	integer	A quantidade do item.
estimadoTempo de Recolha	estimatedPickupTime		string	A hora planeada de recolha da Encomenda de Envio.
estimadoTempoDeApanhaDeMais Cedo	estimatedEarliestPickupTime		string	A hora planeada de recolha mais cedo da Encomenda de Envio.
estimadoTempo de Recolha Mais Recente	estimatedLatestPickupTime		string	A hora mais tardia planeada para recolha da Encomenda de Envio.
estimadoTempoDeEntrega	estimatedDeliveryTime		string	O tempo planeado de entrega da Encomenda de Envio.
estimadoTempoDeEntregaCedoEstimado	estimatedEarliestDeliveryTime		string	A hora planeada de entrega mais cedo da Encomenda de Envio.
estimadoLatestEntregaTempo	estimatedLatestDeliveryTime		string	A hora mais tardia planeada para a entrega da Encomenda de Envio.
éFrágil	isFragile	True	boolean	A flag IsFragile está definida como verdadeira se existirem itens frágeis. Caso contrário, é falso.
inclui Bateria	includesBattery	True	boolean	A flag IncludesBattery está definida como true se a bateria fizer parte do pacote. Caso contrário, é falso.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define o último tempo modificado
Instruções de entrega	deliveryInstructions		object	As instruções de entrega do Shipment.
customAttributes	customAttributes		object	Informação adicional de envio capturada como pares-chave-valor.
carrierName	carrierName		string	O nome do transportador para a remessa

Devoluções

Uma quantidade de artigos, bens ou carga a granel que são enviados em conjunto.

Corpo

Shipment

Atualizações de uma encomenda de envio

ID da Operação:

ShipmentOrder_UpdateShipmentOrder

Atualiza uma encomenda de envio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da encomenda.	shipmentOrderId	True	string	O ID da encomenda.
id	id	True	string	O identificador único de uma Ordem de Envio.
shipmentId	shipmentId		string	O Identificador de uma Remessa que envia esta Encomenda de Envio.
estado	status		string	O estado da Encomenda de Envio.
itemSKU	itemSKU	True	string	O artigo é SKU.
quantidade	quantity	True	integer	A quantidade do item.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de envio. Atualmente, apenas Origin e Destination são suportados.
locationType	locationType		string	O tipo de localização representa se a localização é um armazém, cliente, etc.
nomedocontato	contactName		string	O nome de contacto de uma pessoa relacionada com a Localização
Número de contacto	contactNumber		string	O número de contacto de uma pessoa relacionada com a Localização
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
customAttributes	customAttributes		object	Informação adicional de Localização do Envio capturada como pares-chave-valor.
Volume de envio	shipmentVolume	True	double	O Volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnidadeDeMedida	volumeUnitOfMeasure		string	A Unidade de Volume de medida
PesoUnidadeDeMedida	weightUnitOfMeasure		string	A Unidade de Peso de Medida
EnvioComprimento	shipmentLength	True	double	A Duração
Largura de envio	shipmentWidth	True	double	A Largura
Carga Altura	shipmentHeight	True	double	A Altura
lwhUnidadeDeMedida	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de embalagem do envio
custo estimado	estimatedCost	True	double	O Custo Estimado
código da moeda	currencyCode	True	string	O Código Monetário
ID do cliente	customerId		string	O ID do Cliente
nome_do_cliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informação adicional de dados de faturação capturada como pares-chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	O ID do tipo de carga
chargeTypeName	chargeTypeName		string	O nome do tipo de carga
isOpcional	isOptional	True	boolean	A bandeira IsOptional é definida para True se as cobranças relacionadas com o componente forem opcionais. Else False
Hora de Recolha planeada	plannedPickupTime		string	A hora planeada de recolha da Encomenda de Envio.
planeadoHora CedoPickupHora	plannedEarliestPickupTime		string	A hora planeada de recolha mais cedo da Encomenda de Envio.
planeadoTempo de RecolhaÚltima	plannedLatestPickupTime		string	A hora mais tardia planeada para recolha da Encomenda de Envio.
planeadoTempo de EntregaT	plannedDeliveryTime		string	O tempo planeado de entrega da Encomenda de Envio.
planeadoCedoPrazoDeEntrega	plannedEarliestDeliveryTime		string	A hora planeada de entrega mais cedo da Encomenda de Envio.
planeadoLatestEntregaTempo	plannedLatestDeliveryTime		string	A hora mais tardia planeada para a entrega da Encomenda de Envio.
éFrágil	isFragile	True	boolean	A flag IsFragile está definida como verdadeira se existirem itens frágeis. Caso contrário, é falso.
inclui Bateria	includesBattery	True	boolean	A flag IncludesBattery está definida como true se a bateria fizer parte do pacote. Caso contrário, é falso.
Instruções de entrega	deliveryInstructions		object	As instruções de entrega da Ordem de Envio.
customAttributes	customAttributes		object	Informações adicionais da Encomenda de Envio capturadas como pares-chave-valor.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define o último tempo modificado

Devoluções

A Encomenda de Envio com detalhes como artigos a enviar, localização de origem/destino, cobranças, etc...

Corpo

ShipmentOrder

Cancela o cumprimento de encomendas por ID de cumprimento de encomenda

ID da Operação:

OrderFulfillment_CancelOrderFulfillment

Cancela o cumprimento da encomenda pelo ID de cumprimento da encomenda.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID de cumprimento da encomenda.	orderFulfillmentId	True	string	O ID de cumprimento da encomenda.

Devoluções

Corpo

OrderFulfillment

Cria novo cumprimento de encomendas para ID de cumprimento de encomendas

ID da Operação:

OrderFulfillment_AcceptNewOrderFulfillment

Cria um novo cumprimento de encomendas para o ID de cumprimento de encomendas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID de cumprimento da encomenda.	orderFulfillmentId	True	string	O ID de cumprimento da encomenda.
ID do Pedido	orderId	True	string	O número único que identifica uma Ordem.
itemSKU	itemSKU	True	string	O artigo é SKU.
quantidade	quantity	True	integer	A quantidade de artigos.
planeadoCedoEntregaHoraHora	plannedEarliestDeliveryDateTime		string	A data mais cedo em que a encomenda deve ser entregue.
planeadoLatestEntregaHoraHora	plannedLatestDeliveryDateTime	True	string	A data mais tardia em que a encomenda deve ser entregue.
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
shipmentToName	shipmentToName		string
RecetorEnvioContacto	shipmentReceiverContact		string
estado	status		string
id	id		string
fulfillmentPlanIds	fulfillmentPlanIds		array of string
tempo de criação	creationTime	True	date-time
hora da última modificação	lastModifiedTime	True	date-time
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.

Devoluções

Corpo

OrderFulfillment

Cria o pedido de corrida de entrada de dados

ID da Operação:

DataInflow_PostDataInflowRun

Cria o pedido de corrida de entrada de dados para um espaço de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.
dataInflowName	dataInflowName		string	Recebe ou define o nome Data Inflow Immutable and unique within a workspace
runParams	runParams		object	Obtém ou define os parâmetros necessários para a corrida específicos de um tipo de conector
dataInflowRunId	dataInflowRunId		string	Obtém ou define o ID Data Inflow Run para Data Inflow Run
triggeredAt	triggeredAt		date-time	Obtém ou define o tempo desencadeado para a execução de entrada de dados
concluídoAt	completedAt		date-time	Obtém ou define o tempo concluído para a Execução do Fluxo de Dados
estado	status		string	Obtém ou define o estado para Data Inflow Run

Devoluções

Corpo

DataInflowRun

Cria ou atualiza a saída de dados

ID da Operação:

DataOutflow_PutDataOutflow

Cria ou atualiza o fluxo de dados para um espaço de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome da saída de dados.	name	True	string	O nome da saída de dados.
Nome	name	True	string	O nome Data Outflow é imutável e único dentro de um espaço de trabalho. Este seria o identificador único para uma Saída de Dados. Fornecido pelo utilizador como um parámetro URL obrigatório.
nome de exibição	displayName	True	string	O nome de exibição para Data Outflow.
descrição	description	True	string	A descrição da Saída de Dados.
Nome do Conjunto de Dados	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 de conector. Exemplo - CustomIngestion, CustomExport, FilterAndCopy
tipoPropriedades	typeProperties	True	object	Propriedades relativas ao tipo de conector
output	output		object	Contém os parâmetros de saída que seriam apresentados de volta ao cliente. Por exemplo, no caso do conector FilterAndCopy, o ID do convite e a localização ADS seriam devolvidos como parte da resposta.
tipo	type		string	Tipo de transformador
tipoPropriedades	typeProperties		object	Propriedades relativas ao tipo de transformador
state	state		string	O estado da saída de dados.

Devoluções

Corpo

DataOutflow

Cria ou atualiza o fluxo de dados

ID da Operação:

DataInflow_PutDataInflow

Cria ou atualiza o fluxo de dados para um espaço de trabalho.

Parâmetros

Name	Chave	Necessá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 Entrada de Dados Imutável e único dentro de um espaço de trabalho. Este seria o identificador único para um Fluxo de Dados. Fornecido pelo utilizador como um parámetro URL obrigatório.
nome de exibição	displayName	True	string	Obtém ou define o nome de exibição para o Fluxo de Dados
Nome do Conjunto de Dados	datasetName	True	string	Obtém ou define o nome do conjunto de dados para o conector
tipo	type	True	string	Tipo de conector. Exemplo - CustomIngestion, CustomExport, FilterAndCopy
tipoPropriedades	typeProperties	True	object	Propriedades relativas ao tipo de conector
output	output		object	Contém os parâmetros de saída que seriam apresentados de volta ao cliente. Por exemplo, no caso do conector FilterAndCopy, o ID do convite e a localização ADS seriam devolvidos como parte da resposta.
tipo	type		string	Tipo de transformador
tipoPropriedades	typeProperties		object	Propriedades relativas ao tipo de transformador
state	state		string	Obtém ou define o estado para o Fluxo de Dados

Devoluções

Corpo

DataInflow

Cria ou atualiza um armazém

ID da Operação:

Warehouse_Put

Cria ou atualiza um armazém pelo ID do armazém.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do depósito.	warehouseId	True	string	O ID do depósito.
id	id	True	string	O identificador do nó.
diaDeSemana Nome	dayOfWeekName		string	O dia da semana.
startTime	startTime		string	A hora de início.
endTime	endTime		string	A hora do fim.
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
labels	labels		array of string	Rótulos / Etiquetas
hora da última modificação	lastModifiedTime		date-time
Tempo de Entrega para PickAndPack	pickAndPackLeadTime	True	integer	Recebe ou define o PickAndPackLeadTime, que é o número de horas necessárias ao Armazém para escolher e embalar o artigo
CarrierId	carrierId	True	string	ID de operador associado
Tempo de corte	cutoffTime	True	string	O tempo limite do carteiro em relação ao armazém.
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
servingNodeIds	servingNodeIds		array of string	Servir identificadores de nó, que contém uma lista de IDs de nó a que o portador atual pode servir. Lista nula ou vazia significa que este portador pode servir a qualquer nó.

Devoluções

Corpo

Warehouse

Cria ou atualiza um artigo de armazém

ID da Operação:

WarehouseItem_Put

Cria ou atualiza um artigo de armazém por ID de armazém e SKU do item.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do depósito.	warehouseId	True	string	O ID do depósito.
O item sku.	itemSKU	True	string	O item sku.
Disponível ParaPromessaQuantidade	availableToPromiseQuantity	True	integer	A quantidade.
itemSKU	itemSKU	True	string	O SKU do item.
warehouseId	warehouseId		string	O SKU do item.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a última modificação da data em que este WarehouseItem foi obtido

Devoluções

Corpo

WarehouseItem

Cria ou atualiza um conjunto de dados

ID da Operação:

Dataset_Put

Cria ou atualiza um conjunto de dados com um nome especificado.

Parâmetros

Name	Chave	Necessá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	Recebe ou define um valor que indica se obtém ou define o isdisabled
operacionalalType	operationalType		string	Obtém ou define o tipo operacional: representa se os dados são transacionais (Cosmos) ou de longo prazo (ADLS)
dataModelId	dataModelId	True	string	Obtém ou define o 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 / Etiquetas
O nome do conjunto de dados.	name	True	string	O nome do conjunto de dados.

Devoluções

Corpo

Dataset

Cria ou atualiza um item

ID da Operação:

Item_Put

Cria ou atualiza o item para o ID do workspace e o SKU atribuídos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O item sku.	sku	True	string	O item sku.
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.
Nome padrão	standardName	True	string	O nome padrão do código de barras.
weight	weight	True	double	O peso padrão do item.
length	length	True	double	O comprimento padrão do item.
Largura	width	True	double	A largura padrão dos artigos.
profundidade	depth	True	double	A profundidade padrão dos itens.
Abreviatura	abbreviation	True	string	A unidade de medida, comprimento, largura e altura.
Abreviatura	abbreviation	True	string	A unidade de peso de medida.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define o último tempo modificado
sku	sku	True	string	O identificador da Unidade de Manutenção de Stock, que é normalmente utilizado para atividades relacionadas com inventário.
labels	labels		array of string	Rótulos / Etiquetas

Devoluções

Algo que seja inventariado. Um SKU, unidade de manutenção de stock, refere-se a um artigo específico numa unidade de medida específica.

Corpo

Item

Cria ou atualiza um nó de entrega

ID da Operação:

DeliveryNode_Put

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

Parâmetros

Name	Chave	Necessá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ó.
diaDeSemana Nome	dayOfWeekName		string	O dia da semana.
startTime	startTime		string	A hora de início.
endTime	endTime		string	A hora do fim.
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
labels	labels		array of string	Rótulos / Etiquetas
hora da última modificação	lastModifiedTime		date-time

Devoluções

Os detalhes operacionais do local de entrega, por exemplo, localização, horários de funcionamento, etc.

Corpo

DeliveryNode

Cria ou atualiza um operador com o ID do operador

ID da Operação:

Carrier_Put

Cria ou atualiza um operador com o ID do operador para um espaço de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da operadora.	carrierId	True	string	O ID da operadora.
id	id	True	string	O identificador único de um Carteiro.
tipo	type	True	string	O tipo do Carrier só pode ser o que o OSCP suporta.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.

Devoluções

Corpo

Carrier

Cria ou atualiza um orçamento de envio

ID da Operação:

ShipmentQuote_Put

Cria ou atualiza um orçamento de envio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da cotação de envio.	shipmentQuoteId	True	string	O ID da cotação de envio.
id	id	True	string	O identificador único de um Orçamento de Envio.
EnvioOrçamentoPedidoId	shipmentQuoteRequestId	True	string	O identificador do Pedido de Orçamento de Envio O Orçamento de Envio está relacionado.
custo estimado	estimatedCost	True	double	O Custo Estimado
código da moeda	currencyCode	True	string	O Código Monetário
ID do cliente	customerId		string	O ID do Cliente
nome_do_cliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informação adicional de dados de faturação capturada como pares-chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	O ID do tipo de carga
chargeTypeName	chargeTypeName		string	O nome do tipo de carga
isOpcional	isOptional	True	boolean	A bandeira IsOptional é definida para True se as cobranças relacionadas com o componente forem opcionais. Else False
Hora de Recolha planeada	plannedPickupTime		string	A hora planeada de recolha do Shipment.
planeadoTempo de EntregaT	plannedDeliveryTime		string	A hora planeada de entrega do Shipment.
CarrierId	carrierId	True	string	O ID da Operadora
carrierName	carrierName	True	string	O nome da Carrier
customAttributes	customAttributes		object	Informações adicionais sobre cotações de envio capturadas como pares-chave-valor.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define o último tempo modificado

Devoluções

Detalhes do orçamento de envio

Corpo

ShipmentQuote

Cria ou atualiza uma lista de itens

ID da Operação:

Item_BulkPut

Cria ou atualiza uma lista de itens para o ID do espaço de trabalho e skus dados.

Parâmetros

Name	Chave	Necessá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.
Nome padrão	standardName	True	string	O nome padrão do código de barras.
weight	weight	True	double	O peso padrão do item.
length	length	True	double	O comprimento padrão do item.
Largura	width	True	double	A largura padrão dos artigos.
profundidade	depth	True	double	A profundidade padrão dos itens.
Abreviatura	abbreviation	True	string	A unidade de medida, comprimento, largura e altura.
Abreviatura	abbreviation	True	string	A unidade de peso de medida.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define o último tempo modificado
sku	sku	True	string	O identificador da Unidade de Manutenção de Stock, que é normalmente utilizado para atividades relacionadas com inventário.
labels	labels		array of string	Rótulos / Etiquetas

Devoluções

response

array of BulkResponseItemOfItem

Cria ou atualiza uma lista de itens do armazém

ID da Operação:

WarehouseItem_BulkPut

Cria ou atualiza uma lista de itens do armazém por ID do armazém e sku do item.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do depósito.	warehouseId	True	string	O ID do depósito.
Disponível ParaPromessaQuantidade	availableToPromiseQuantity	True	integer	A quantidade.
itemSKU	itemSKU	True	string	O SKU do item.
warehouseId	warehouseId		string	O SKU do item.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a última modificação da data em que este WarehouseItem foi obtido

Devoluções

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 o ID de workspace e o ID do nó de entrega.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador do nó.
diaDeSemana Nome	dayOfWeekName		string	O dia da semana.
startTime	startTime		string	A hora de início.
endTime	endTime		string	A hora do fim.
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
labels	labels		array of string	Rótulos / Etiquetas
hora da última modificação	lastModifiedTime		date-time

Devoluções

response

array of BulkResponseItemOfDeliveryNode

Cria um pedido de orçamento de envio

ID da Operação:

ShipmentQuoteRequest_Put

Cria um pedido de orçamento de envio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do pedido de orçamento de envio.	shipmentQuoteRequestId	True	string	O ID do pedido de orçamento de envio.
id	id	True	string	O identificador único de um Pedido de Orçamento de Envio.
itemSKU	itemSKU	True	string	O artigo é SKU.
quantidade	quantity	True	integer	A quantidade do item.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de envio. Atualmente, apenas Origin e Destination são suportados.
locationType	locationType		string	O tipo de localização representa se a localização é um armazém, cliente, etc.
nomedocontato	contactName		string	O nome de contacto de uma pessoa relacionada com a Localização
Número de contacto	contactNumber		string	O número de contacto de uma pessoa relacionada com a Localização
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
customAttributes	customAttributes		object	Informação adicional de Localização do Envio capturada como pares-chave-valor.
Volume de envio	shipmentVolume	True	double	O Volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnidadeDeMedida	volumeUnitOfMeasure		string	A Unidade de Volume de medida
PesoUnidadeDeMedida	weightUnitOfMeasure		string	A Unidade de Peso de Medida
EnvioComprimento	shipmentLength	True	double	A Duração
Largura de envio	shipmentWidth	True	double	A Largura
Carga Altura	shipmentHeight	True	double	A Altura
lwhUnidadeDeMedida	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de embalagem do envio
shipmentQuoteIds	shipmentQuoteIds		array of string	Os IDs do Orçamento de Envio correspondentes ao Pedido de Orçamento de Envio
Hora de Recolha planeada	plannedPickupTime		string	A hora planeada de recolha do Shipment.
planeadoTempo de EntregaT	plannedDeliveryTime		string	A hora planeada de entrega do Shipment.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define o último tempo modificado

Devoluções

Detalhes do Pedido de Orçamento de Envio

Corpo

ShipmentQuoteRequest

Cria uma encomenda de envio

ID da Operação:

ShipmentOrder_Put

Cria uma encomenda de envio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da encomenda.	shipmentOrderId	True	string	O ID da encomenda.
id	id	True	string	O identificador único de uma Ordem de Envio.
shipmentId	shipmentId		string	O Identificador de uma Remessa que envia esta Encomenda de Envio.
estado	status		string	O estado da Encomenda de Envio.
itemSKU	itemSKU	True	string	O artigo é SKU.
quantidade	quantity	True	integer	A quantidade do item.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de envio. Atualmente, apenas Origin e Destination são suportados.
locationType	locationType		string	O tipo de localização representa se a localização é um armazém, cliente, etc.
nomedocontato	contactName		string	O nome de contacto de uma pessoa relacionada com a Localização
Número de contacto	contactNumber		string	O número de contacto de uma pessoa relacionada com a Localização
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
customAttributes	customAttributes		object	Informação adicional de Localização do Envio capturada como pares-chave-valor.
Volume de envio	shipmentVolume	True	double	O Volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnidadeDeMedida	volumeUnitOfMeasure		string	A Unidade de Volume de medida
PesoUnidadeDeMedida	weightUnitOfMeasure		string	A Unidade de Peso de Medida
EnvioComprimento	shipmentLength	True	double	A Duração
Largura de envio	shipmentWidth	True	double	A Largura
Carga Altura	shipmentHeight	True	double	A Altura
lwhUnidadeDeMedida	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de embalagem do envio
custo estimado	estimatedCost	True	double	O Custo Estimado
código da moeda	currencyCode	True	string	O Código Monetário
ID do cliente	customerId		string	O ID do Cliente
nome_do_cliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informação adicional de dados de faturação capturada como pares-chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	O ID do tipo de carga
chargeTypeName	chargeTypeName		string	O nome do tipo de carga
isOpcional	isOptional	True	boolean	A bandeira IsOptional é definida para True se as cobranças relacionadas com o componente forem opcionais. Else False
Hora de Recolha planeada	plannedPickupTime		string	A hora planeada de recolha da Encomenda de Envio.
planeadoHora CedoPickupHora	plannedEarliestPickupTime		string	A hora planeada de recolha mais cedo da Encomenda de Envio.
planeadoTempo de RecolhaÚltima	plannedLatestPickupTime		string	A hora mais tardia planeada para recolha da Encomenda de Envio.
planeadoTempo de EntregaT	plannedDeliveryTime		string	O tempo planeado de entrega da Encomenda de Envio.
planeadoCedoPrazoDeEntrega	plannedEarliestDeliveryTime		string	A hora planeada de entrega mais cedo da Encomenda de Envio.
planeadoLatestEntregaTempo	plannedLatestDeliveryTime		string	A hora mais tardia planeada para a entrega da Encomenda de Envio.
éFrágil	isFragile	True	boolean	A flag IsFragile está definida como verdadeira se existirem itens frágeis. Caso contrário, é falso.
inclui Bateria	includesBattery	True	boolean	A flag IncludesBattery está definida como true se a bateria fizer parte do pacote. Caso contrário, é falso.
Instruções de entrega	deliveryInstructions		object	As instruções de entrega da Ordem de Envio.
customAttributes	customAttributes		object	Informações adicionais da Encomenda de Envio capturadas como pares-chave-valor.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define o último tempo modificado

Devoluções

A Encomenda de Envio com detalhes como artigos a enviar, localização de origem/destino, cobranças, etc...

Corpo

ShipmentOrder

Cria uma lista de armazéns

ID da Operação:

Warehouse_BulkPut

Cria uma lista de armazéns para o ID do espaço de trabalho e uma lista de objetos do armazém.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador do nó.
diaDeSemana Nome	dayOfWeekName		string	O dia da semana.
startTime	startTime		string	A hora de início.
endTime	endTime		string	A hora do fim.
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
labels	labels		array of string	Rótulos / Etiquetas
hora da última modificação	lastModifiedTime		date-time
Tempo de Entrega para PickAndPack	pickAndPackLeadTime	True	integer	Recebe ou define o PickAndPackLeadTime, que é o número de horas necessárias ao Armazém para escolher e embalar o artigo
CarrierId	carrierId	True	string	ID de operador associado
Tempo de corte	cutoffTime	True	string	O tempo limite do carteiro em relação ao armazém.
servingNodeIds	servingNodeIds		array of string	Servir identificadores de nó, que contém uma lista de IDs de nó a que o portador atual pode servir. Lista nula ou vazia significa que este portador pode servir a qualquer nó.

Devoluções

response

array of BulkResponseItemOfWarehouse

Cria uma lista de encomendas de envio

ID da Operação:

ShipmentOrder_BulkPut

Cria uma lista de encomendas de envio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador único de uma Ordem de Envio.
shipmentId	shipmentId		string	O Identificador de uma Remessa que envia esta Encomenda de Envio.
estado	status		string	O estado da Encomenda de Envio.
itemSKU	itemSKU	True	string	O artigo é SKU.
quantidade	quantity	True	integer	A quantidade do item.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de envio. Atualmente, apenas Origin e Destination são suportados.
locationType	locationType		string	O tipo de localização representa se a localização é um armazém, cliente, etc.
nomedocontato	contactName		string	O nome de contacto de uma pessoa relacionada com a Localização
Número de contacto	contactNumber		string	O número de contacto de uma pessoa relacionada com a Localização
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
customAttributes	customAttributes		object	Informação adicional de Localização do Envio capturada como pares-chave-valor.
Volume de envio	shipmentVolume	True	double	O Volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnidadeDeMedida	volumeUnitOfMeasure		string	A Unidade de Volume de medida
PesoUnidadeDeMedida	weightUnitOfMeasure		string	A Unidade de Peso de Medida
EnvioComprimento	shipmentLength	True	double	A Duração
Largura de envio	shipmentWidth	True	double	A Largura
Carga Altura	shipmentHeight	True	double	A Altura
lwhUnidadeDeMedida	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de embalagem do envio
custo estimado	estimatedCost	True	double	O Custo Estimado
código da moeda	currencyCode	True	string	O Código Monetário
ID do cliente	customerId		string	O ID do Cliente
nome_do_cliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informação adicional de dados de faturação capturada como pares-chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	O ID do tipo de carga
chargeTypeName	chargeTypeName		string	O nome do tipo de carga
isOpcional	isOptional	True	boolean	A bandeira IsOptional é definida para True se as cobranças relacionadas com o componente forem opcionais. Else False
Hora de Recolha planeada	plannedPickupTime		string	A hora planeada de recolha da Encomenda de Envio.
planeadoHora CedoPickupHora	plannedEarliestPickupTime		string	A hora planeada de recolha mais cedo da Encomenda de Envio.
planeadoTempo de RecolhaÚltima	plannedLatestPickupTime		string	A hora mais tardia planeada para recolha da Encomenda de Envio.
planeadoTempo de EntregaT	plannedDeliveryTime		string	O tempo planeado de entrega da Encomenda de Envio.
planeadoCedoPrazoDeEntrega	plannedEarliestDeliveryTime		string	A hora planeada de entrega mais cedo da Encomenda de Envio.
planeadoLatestEntregaTempo	plannedLatestDeliveryTime		string	A hora mais tardia planeada para a entrega da Encomenda de Envio.
éFrágil	isFragile	True	boolean	A flag IsFragile está definida como verdadeira se existirem itens frágeis. Caso contrário, é falso.
inclui Bateria	includesBattery	True	boolean	A flag IncludesBattery está definida como true se a bateria fizer parte do pacote. Caso contrário, é falso.
Instruções de entrega	deliveryInstructions		object	As instruções de entrega da Ordem de Envio.
customAttributes	customAttributes		object	Informações adicionais da Encomenda de Envio capturadas como pares-chave-valor.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define o último tempo modificado

Devoluções

response

array of BulkResponseItemOfShipmentOrder

Cria uma remessa

ID da Operação:

Shipment_Put

Cria um envio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do envio.	shipmentId	True	string	O ID do envio.
id	id	True	string	O identificador único de um Envio.
estado	status		string	O estado da remessa.
shipmentOrderIds	shipmentOrderIds		array of string	A lista de IDs de Encomendas de Envio que são tratadas pelo Envio.
shipmentNodeType	shipmentNodeType	True	string	O tipo de nó de envio. Atualmente, apenas Origin e Destination são suportados.
locationType	locationType		string	O tipo de localização representa se a localização é um armazém, cliente, etc.
nomedocontato	contactName		string	O nome de contacto de uma pessoa relacionada com a Localização
Número de contacto	contactNumber		string	O número de contacto de uma pessoa relacionada com a Localização
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
customAttributes	customAttributes		object	Informação adicional de Localização do Envio capturada como pares-chave-valor.
Volume de envio	shipmentVolume	True	double	O Volume
shipmentNetWeight	shipmentNetWeight	True	double	O Peso
volumeUnidadeDeMedida	volumeUnitOfMeasure		string	A Unidade de Volume de medida
PesoUnidadeDeMedida	weightUnitOfMeasure		string	A Unidade de Peso de Medida
EnvioComprimento	shipmentLength	True	double	A Duração
Largura de envio	shipmentWidth	True	double	A Largura
Carga Altura	shipmentHeight	True	double	A Altura
lwhUnidadeDeMedida	lwhUnitOfMeasure		string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType		string	O tipo de embalagem do envio
custo estimado	estimatedCost	True	double	O Custo Estimado
código da moeda	currencyCode	True	string	O Código Monetário
ID do cliente	customerId		string	O ID do Cliente
nome_do_cliente	customerName		string	O Nome do Cliente
customAttributes	customAttributes		object	Informação adicional de dados de faturação capturada como pares-chave-valor
totalComponentCharge	totalComponentCharge	True	double	A carga total
chargeTypeId	chargeTypeId	True	string	O ID do tipo de carga
chargeTypeName	chargeTypeName		string	O nome do tipo de carga
isOpcional	isOptional	True	boolean	A bandeira IsOptional é definida para True se as cobranças relacionadas com o componente forem opcionais. Else False
trackingNumber	trackingNumber		string	O número de rastreio
trackingUrl	trackingUrl		string	O URL de Rastreio
shipLabelUrl	shipLabelUrl		string	A URL da etiqueta do navio
itemSKU	itemSKU	True	string	O artigo é SKU.
quantidade	quantity	True	integer	A quantidade do item.
estimadoTempo de Recolha	estimatedPickupTime		string	A hora planeada de recolha da Encomenda de Envio.
estimadoTempoDeApanhaDeMais Cedo	estimatedEarliestPickupTime		string	A hora planeada de recolha mais cedo da Encomenda de Envio.
estimadoTempo de Recolha Mais Recente	estimatedLatestPickupTime		string	A hora mais tardia planeada para recolha da Encomenda de Envio.
estimadoTempoDeEntrega	estimatedDeliveryTime		string	O tempo planeado de entrega da Encomenda de Envio.
estimadoTempoDeEntregaCedoEstimado	estimatedEarliestDeliveryTime		string	A hora planeada de entrega mais cedo da Encomenda de Envio.
estimadoLatestEntregaTempo	estimatedLatestDeliveryTime		string	A hora mais tardia planeada para a entrega da Encomenda de Envio.
éFrágil	isFragile	True	boolean	A flag IsFragile está definida como verdadeira se existirem itens frágeis. Caso contrário, é falso.
inclui Bateria	includesBattery	True	boolean	A flag IncludesBattery está definida como true se a bateria fizer parte do pacote. Caso contrário, é falso.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define o último tempo modificado
Instruções de entrega	deliveryInstructions		object	As instruções de entrega do Shipment.
customAttributes	customAttributes		object	Informação adicional de envio capturada como pares-chave-valor.
carrierName	carrierName		string	O nome do transportador para a remessa

Devoluções

Uma quantidade de artigos, bens ou carga a granel que são enviados em conjunto.

Corpo

Shipment

Desencadeia uma execução para uma instância de Data Outflow

ID da Operação:

DataOutflow_PostDataOutflowRun

Desencadeia uma execução para a instância Data Outflow com o nome próprio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome da saída de dados.	name	True	string	O nome da saída de dados.
dataOutflowName	dataOutflowName		string	Recebe ou define o nome Data Outflow
dataOutflowRunId	dataOutflowRunId		string	Obtém ou define o ID de Execução de Saída de Dados
runParams	runParams		object	Obtém ou define os parâmetros específicos para um tipo de conector
estado	status		string	Obtém ou define o estado de Data Outflow Run
triggeredAt	triggeredAt		date-time	Obtém ou define o tempo de disparo para a execução do fluxo de dados
concluídoAt	completedAt		date-time	Obtém ou define o tempo concluído para Data Outflow Run
triggeredBy	triggeredBy		string	Get ou define o mecanismo através do qual esta corrida foi desencadeada. Atualmente via API ou evento de Conclusão de Ingestão Datset.
triggerId	triggerId		string	Obtenha ou defina o identificador do mecanismo de disparo.

Devoluções

Corpo

DataOutflowRun

Elimina a saída de dados

ID da Operação:

DataOutflow_DeleteDataOutflow

Elimina o fluxo de dados para o nome próprio e o espaço de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome da saída de dados.	name	True	string	O nome da saída de dados.

Devoluções

Corpo

DataOutflow

Elimina o fluxo de dados

ID da Operação:

DataInflow_DeleteDataInflow

Elimina o fluxo de dados para o nome próprio e o espaço de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.

Devoluções

Corpo

DataInflow

Elimina o nó de entrega

ID da Operação:

DeliveryNode_Delete

Elimina o nó de entrega para o ID do workspace e do ID do nó de entrega.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O identificador do nó de entrega.	deliveryNodeId	True	string	O identificador do nó de entrega.

Devoluções

response

file

Elimina um conjunto de dados com nome especificado

ID da Operação:

Dataset_Delete

Apaga um conjunto de dados com nome especificado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome do conjunto de dados.	name	True	string	O nome do conjunto de dados.

Devoluções

Corpo

Dataset

Elimina uma lista de nós de entrega

ID da Operação:

DeliveryNode_BulkDelete

Apaga os nós de entrega para os IDs de nós de entrega indicados.

Parâmetros

Name	Chave	Necessário	Tipo	Description
deliveryNodeIds	deliveryNodeIds	True	array of string

Devoluções

response

array of BulkResponseItemOfString

Gera opções de cumprimento

ID da Operação:

FulfillmentOption_GenerateFulfillmentOptions

Gera opções de fulfillment para o ID do workspace e pedido de fulfillment

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Pedido	orderId	True	string	O número único que identifica uma Ordem.
itemSKU	itemSKU	True	string	O artigo é SKU.
quantidade	quantity	True	integer	A quantidade de artigos.
planeadoCedoEntregaHoraHora	plannedEarliestDeliveryDateTime		string	A data mais cedo em que a encomenda deve ser entregue.
planeadoLatestEntregaHoraHora	plannedLatestDeliveryDateTime	True	string	A data mais tardia em que a encomenda deve ser entregue.
TimeZoneName	timeZoneName		string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	True	string	O endereço principal.
endereçoLine2	addressLine2		string	O endereço secundário.
cidadeNome da cidade	cityName	True	string	O componente 'cidade' de um local.
stateName	stateName	True	string	O nome do estado ou da província.
nome_do_país	countryName	True	string	O nome do país.
postalCode	postalCode	True	string	O código postal.
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.
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.
Nome padrão	standardName	True	string	O nome padrão do código de barras.
weight	weight	True	double	O peso padrão do item.
length	length	True	double	O comprimento padrão do item.
Largura	width	True	double	A largura padrão dos artigos.
profundidade	depth	True	double	A profundidade padrão dos itens.
Abreviatura	abbreviation	True	string	A unidade de medida, comprimento, largura e altura.
Abreviatura	abbreviation	True	string	A unidade de peso de medida.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define o último tempo modificado
sku	sku	True	string	O identificador da Unidade de Manutenção de Stock, que é normalmente utilizado para atividades relacionadas com inventário.
labels	labels		array of string	Rótulos / Etiquetas
warehouseId	warehouseId		string
Disponível ParaPromessaQuantidade	availableToPromiseQuantity	True	integer	A quantidade.
itemSKU	itemSKU	True	string	O SKU do item.
warehouseId	warehouseId		string	O SKU do item.
hora da última modificação	lastModifiedTime		date-time	Obtém ou define a última modificação da data em que este WarehouseItem foi obtido
Nome	name	True	string	O nome de destaque.
value	value	True	string	O valor de notar.

Devoluções

Corpo

GenerateFulfillmentOptionsResponse

Liste todas as execuções para o dado Fluxo de Dados

ID da Operação:

DataInflowRun_ListDataInflowRuns

Liste todas as execuções para o nome dado de Data Inflow.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome de entrada dos dados.	name	True	string	O nome de entrada dos dados.

Devoluções

response

array of DataInflowRun

Liste todas as execuções para o dado fluxo de dados

ID da Operação:

DataOutflowRun_ListDataOutflowRuns

Liste todas as execuções para o nome Data Outflow referido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome da saída de dados.	name	True	string	O nome da saída de dados.

Devoluções

response

array of DataOutflowRun

Recupera a corrida de entrada de dados para ID de execução

ID da Operação:

DataInflowRun_GetDataInflowRun

Recupera a corrida de entrada de dados para o ID de execução dado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.
O ID da corrida de entrada de dados.	dataInflowRunId	True	string	O ID da corrida de entrada de dados.

Devoluções

Corpo

DataInflowRun

Recupera a saída de dados

ID da Operação:

DataOutflow_GetDataOutflow

Recupera o fluxo de dados para o nome próprio e o espaço de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome da saída de dados.	name	True	string	O nome da saída de dados.

Devoluções

Corpo

DataOutflow

Recupera detalhes de execução para dados dados de saída e ID de execução

ID da Operação:

DataOutflowRun_GetDataOutflowRun

Recupera os detalhes da execução para o nome de saída e ID da corrida dados dados.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome da saída de dados.	name	True	string	O nome da saída de dados.
O objeto de corrida de saída de dados.	dataOutflowRunId	True	string	O objeto de corrida de saída de dados.

Devoluções

Corpo

DataOutflowRun

Recupera o cumprimento de encomendas por ID de cumprimento de encomendas

ID da Operação:

OrderFulfillment_GetOrderFulfillment

Recupera o cumprimento de encomendas por ID de cumprimento de encomendas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID de cumprimento da encomenda.	orderFulfillmentId	True	string	O ID de cumprimento da encomenda.

Devoluções

Corpo

OrderFulfillment

Recupera o fluxo de dados

ID da Operação:

DataInflow_GetDataInflow

Recupera o fluxo de dados para o nome dado e o espaço de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome do fluxo de dados.	name	True	string	O nome do fluxo de dados.

Devoluções

Corpo

DataInflow

Recupera os nós de entrega para um dado espaço de trabalho

ID da Operação:

DeliveryNode_GetAllDeliveryNodes

Recupera os nós de entrega para o ID do workspace atribuído.

Devoluções

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 com nome especificado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome do conjunto de dados.	name	True	string	O nome do conjunto de dados.

Devoluções

response

array of Directory

Recupera todos os armazéns para um espaço de trabalho

ID da Operação:

Warehouse_GetAllWarehouses

Recupera todos os armazéns para um espaço de trabalho.

Devoluções

response

array of Warehouse

Recupera todos os conjuntos de dados para um espaço de trabalho

ID da Operação:

Dataset_GetAllDatasets

Recupera todos os conjuntos de dados para um espaço de trabalho.

Devoluções

response

array of Dataset

Recupera todos os fluxos de dados

ID da Operação:

DataInflow_GetAllDataInflows

Recupera todos os fluxos de dados para o determinado espaço de trabalho.

Devoluções

response

array of DataInflow

Recupera todos os fluxos de dados para um espaço de trabalho

ID da Operação:

DataOutflow_GetAllDataOutflows

Recupera todos os fluxos de dados para o determinado espaço de trabalho.

Devoluções

response

array of DataOutflow

Recupera um armazém pelo ID do armazém

ID da Operação:

Warehouse_Get

Recupera um armazém pelo ID do armazém.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do depósito.	warehouseId	True	string	O ID do depósito.

Devoluções

Corpo

Warehouse

Recupera um conjunto de dados com nome especificado

ID da Operação:

Dataset_Get

Recupera um conjunto de dados com nome especificado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O nome do conjunto de dados.	name	True	string	O nome do conjunto de dados.

Devoluções

Corpo

Dataset

Recupera um item

ID da Operação:

Item_Get

Recupera o item para o ID do espaço de trabalho e sku.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O item sku.	sku	True	string	O item sku.

Devoluções

Algo que seja inventariado. Um SKU, unidade de manutenção de stock, refere-se a um artigo específico numa unidade de medida específica.

Corpo

Item

Recupera um item do armazém pelo ID do armazém e pelo sku do item

ID da Operação:

WarehouseItem_Get

Recupera um item do armazém pelo ID do armazém e pelo sku do item.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do depósito.	warehouseId	True	string	O ID do depósito.
O item sku.	itemSKU	True	string	O item sku.

Devoluções

Corpo

WarehouseItem

Recupera um nó de entrega

ID da Operação:

DeliveryNode_Get

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
O identificador do nó de entrega.	deliveryNodeId	True	string	O identificador do nó de entrega.

Devoluções

Os detalhes operacionais do local de entrega, por exemplo, localização, horários de funcionamento, etc.

Corpo

DeliveryNode

Recupera um orçamento de envio

ID da Operação:

ShipmentQuote_Get

Recupera um orçamento de envio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da cotação de envio.	shipmentQuoteId	True	string	O ID da cotação de envio.

Devoluções

Detalhes do orçamento de envio

Corpo

ShipmentQuote

Recupera um pedido de orçamento de envio

ID da Operação:

ShipmentQuoteRequest_Get

Recupera um pedido de orçamento de envio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do pedido de orçamento de envio.	shipmentQuoteRequestId	True	string	O ID do pedido de orçamento de envio.

Devoluções

Detalhes do Pedido de Orçamento de Envio

Corpo

ShipmentQuoteRequest

Recupera um plano de cumprimento

ID da Operação:

FulfillmentPlan_GetPlan

Recupera o plano de cumprimento para o ID do espaço de trabalho e o ID do plano de cumprimento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O identificador do plano de cumprimento.	fulfillmentPlanId	True	string	O identificador do plano de cumprimento.

Devoluções

As atividades planeadas ou efetivas relacionadas com o cumprimento de uma ordem. Estas atividades podem incluir Criação da Lista de Escolhas, Execução da Lista de Escolhas, Embalagem e Envio do(s) artigo(s) para o destino final.

Corpo

FulfillmentPlan

Recupera um portador com ID de carteira

ID da Operação:

Carrier_Get

Recupera um carteiro com o ID do transportador para um espaço de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da operadora	carrierId	True	string	O ID da operadora.

Devoluções

Corpo

Carrier

Recupera uma encomenda de envio

ID da Operação:

ShipmentOrder_Get

Recupera uma encomenda de envio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da encomenda.	shipmentOrderId	True	string	O ID da encomenda.

Devoluções

A Encomenda de Envio com detalhes como artigos a enviar, localização de origem/destino, cobranças, etc...

Corpo

ShipmentOrder

Recupera uma lista de planos de cumprimento com estado específico de cumprimento

ID da Operação:

FulfillmentPlan_GetPlans

Recupera uma lista de planos de fulfillment com o estado de fulfillment specifica para o ID do workspace e do warehouse ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O identificador do armazém.	warehouseId		string	O identificador do armazém.
O estado de cumprimento.	status		string	O estado de cumprimento.

Devoluções

response

array of FulfillmentPlan

Recupera uma remessa pelo ID da remessa

ID da Operação:

Shipment_Get

Recupera uma remessa pelo ID da remessa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do envio.	shipmentId	True	string	O ID do envio.

Devoluções

Uma quantidade de artigos, bens ou carga a granel que são enviados em conjunto.

Corpo

Shipment

Definições

Operadora

Name	Caminho	Tipo	Description
id	id	string	O identificador único de um Carteiro.
tipo	type	string	O tipo do Carrier só pode ser o que o OSCP suporta.
Observações	notes	array of Note	ID da conta do lado da operadora, ID do contador, etc., que serão usados ao consultar a operadora.

Observação

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

Name	Caminho	Tipo	Description
Nome	name	string	O nome de destaque.
value	value	string	O valor de notar.

DataInflow

Name	Caminho	Tipo	Description
Nome	name	string	Obtém ou define o nome de Entrada de Dados Imutável e único dentro de um espaço de trabalho. Este seria o identificador único para um Fluxo de Dados. Fornecido pelo utilizador como um parámetro URL obrigatório.
nome de exibição	displayName	string	Obtém ou define o nome de exibição para o Fluxo de Dados
Nome do Conjunto de Dados	datasetName	string	Obtém ou define o nome do conjunto de dados para o conector
conector	connector	Connector
transformador	transformer	Transformer
state	state	string	Obtém ou define o estado para o Fluxo de Dados

Connector

Name	Caminho	Tipo	Description
tipo	type	string	Tipo de conector. Exemplo - CustomIngestion, CustomExport, FilterAndCopy
tipoPropriedades	typeProperties	object	Propriedades relativas ao tipo de conector
output	output	object	Contém os parâmetros de saída que seriam apresentados de volta ao cliente. Por exemplo, no caso do conector FilterAndCopy, o ID do convite e a localização ADS seriam devolvidos como parte da resposta.

Transformador

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

DataInflowRun

Name	Caminho	Tipo	Description
dataInflowName	dataInflowName	string	Recebe ou define o nome Data Inflow Immutable and unique within a workspace
runParams	runParams	object	Obtém ou define os parâmetros necessários para a corrida específicos de um tipo de conector
dataInflowRunId	dataInflowRunId	string	Obtém ou define o ID Data Inflow Run para Data Inflow Run
triggeredAt	triggeredAt	date-time	Obtém ou define o tempo desencadeado para a execução de entrada de dados
concluídoAt	completedAt	date-time	Obtém ou define o tempo concluído para a Execução do Fluxo de Dados
estado	status	string	Obtém ou define o estado para Data Inflow Run

DataOutflow

Name	Caminho	Tipo	Description
Nome	name	string	O nome Data Outflow é imutável e único dentro de um espaço de trabalho. Este seria o identificador único para uma Saída de Dados. Fornecido pelo utilizador como um parámetro URL obrigatório.
nome de exibição	displayName	string	O nome de exibição para Data Outflow.
descrição	description	string	A descrição da Saída de Dados.
Nome do Conjunto de Dados	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 esta propriedade fará com que todas as entidades sejam exportadas por defeito.
conector	connector	Connector
transformador	transformer	Transformer
state	state	string	O estado da saída de dados.

DataSchema

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

DataSchemaAttribute

Name	Caminho	Tipo	Description
Nome	name	string

DataOutflowRun

Name	Caminho	Tipo	Description
dataOutflowName	dataOutflowName	string	Recebe ou define o nome Data Outflow
dataOutflowRunId	dataOutflowRunId	string	Obtém ou define o ID de Execução de Saída de Dados
runParams	runParams	object	Obtém ou define os parâmetros específicos para um tipo de conector
estado	status	string	Obtém ou define o estado de Data Outflow Run
triggeredAt	triggeredAt	date-time	Obtém ou define o tempo de disparo para a execução do fluxo de dados
concluídoAt	completedAt	date-time	Obtém ou define o tempo concluído para Data Outflow Run
triggeredBy	triggeredBy	string	Get ou define o mecanismo através do qual esta corrida foi desencadeada. Atualmente via API ou evento de Conclusão de Ingestão Datset.
triggerId	triggerId	string	Obtenha ou defina o identificador do mecanismo de disparo.

Conjunto de dados

Name	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 deste conjunto de dados. Atualmente, este campo é opcional, no entanto, uma alteração futura tornará-lo obrigatório.
isDisabled	isDisabled	boolean	Recebe ou define um valor que indica se obtém ou define o isdisabled
operacionalalType	operationalType	string	Obtém ou define o tipo operacional: representa se os dados são transacionais (Cosmos) ou de longo prazo (ADLS)
schemaReference	schemaReference	SchemaReference
labels	labels	array of string	Rótulos / Etiquetas

SchemaReference

Name	Caminho	Tipo	Description
dataModelId	dataModelId	string	Obtém ou define o 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

Name	Caminho	Tipo	Description
ingestão Tempo	ingestionTime	string	Recebe 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, horários de funcionamento, etc.

Name	Caminho	Tipo	Description
id	id	string	O identificador do nó.
HorasDeOperações	hoursOfOperations	array of HoursOfOperation	Uma lista de horários de operação.
localização	location	Location	Uma localização de uma estrutura física.
labels	labels	array of string	Rótulos / Etiquetas
hora da última modificação	lastModifiedTime	date-time

HoráriodeFuncionamento

Horário de operação num dia da semana

Name	Caminho	Tipo	Description
diaDeSemana Nome	dayOfWeekName	string	O dia da semana.
startTime	startTime	string	A hora de início.
endTime	endTime	string	A hora do fim.

Localização

Uma localização de uma estrutura física.

Name	Caminho	Tipo	Description
TimeZoneName	timeZoneName	string	O identificador único de um fuso horário.
endereçoLine1	addressLine1	string	O endereço principal.
endereçoLine2	addressLine2	string	O endereço secundário.
cidadeNome da cidade	cityName	string	O componente 'cidade' de um local.
stateName	stateName	string	O nome do estado ou da província.
nome_do_país	countryName	string	O nome do país.
postalCode	postalCode	string	O código postal.
Observações	notes	array of Note	Uma lista de notas de localização.

BulkResponseItemOfDeliveryNode

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

Name	Caminho	Tipo	Description
código de estado	statusCode	integer	O código de estado de resposta da ação em massa.
response	response	DeliveryNode	Os detalhes operacionais do local de entrega, por exemplo, localização, horários de funcionamento, etc.
erro	error	ErrorObject	O código e a mensagem de erro detalhados.
pedido	request	DeliveryNode	Os detalhes operacionais do local de entrega, por exemplo, localização, horários de funcionamento, etc.

ErrorObject

O código e a mensagem de erro detalhados.

Name	Caminho	Tipo	Description
código	code	string	O código do erro.
mensagem	message	string	A mensagem de erro legível por humanos.

BulkResponseItemOfString

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

Name	Caminho	Tipo	Description
código de estado	statusCode	integer	O código de estado de resposta da ação em massa.
response	response	string	O objeto da ação em massa respondeu do tipo T.
erro	error	ErrorObject	O código e a mensagem de erro detalhados.
pedido	request	string	O objeto de pedido do tipo T para ação em massa.

GerarSatisfaçãoOpçõesResposta

Name	Caminho	Tipo	Description
fulfillmentOpções	fulfillmentOptions	array of FulfillmentOption

FulfillmentOption

A opção da realização.

Name	Caminho	Tipo	Description
fulfillmentOptionId	fulfillmentOptionId	string	O identificador de uma opção de cumprimento.
shipmentToLocation	shipmentToLocation	Location	Uma localização de uma estrutura física.
overoverall Custo	overallCost	Amount	O montante em moeda específica.
earlytiestDeliveryTime	earliestDeliveryTime	string	A hora de entrega mais cedo.
latestDeliveryTimeT	latestDeliveryTime	string	A hora de entrega mais recente.
tempo de expiração	expirationTime	string	O tempo de expiração da opção de cumprimento.
Planos de cumprimento	fulfillmentPlans	array of FulfillmentPlan	Uma lista de planos de cumprimento nesta opção de cumprimento.

Montante

O montante em moeda específica.

Name	Caminho	Tipo	Description
value	value	double
moeda	currency	string

Plano de Cumprimento

As atividades planeadas ou efetivas relacionadas com o cumprimento de uma ordem. Estas atividades podem incluir Criação da Lista de Escolhas, Execução da Lista de Escolhas, Embalagem e Envio do(s) artigo(s) para o destino final.

Name	Caminho	Tipo	Description
id	id	string	O identificador único de uma realização.
warehouseId	warehouseId	string	O identificador único de um armazém.
Tempo de Execução Programado	scheduledExecutionTime	string
OrderLines	orderLines	array of OrderLine	As Linhas de Encomendas que estão planeadas para serem cumpridas pelo Plano de Cumprimento
envios	shipments	array of Shipment	Os envios de um plano de cumprimento
estado	status	string	O estado do Plano de Cumprimento.
statusRazão	statusReason	string
tempo de criação	creationTime	string	O carimbo temporal em que o Plano de Cumprimento foi criado.

Linha de Encomenda

Um documento ou comissão do cliente para encomendar um artigo.

Name	Caminho	Tipo	Description
ID do Pedido	orderId	string	O número único que identifica uma Ordem.
itemSKU	itemSKU	string	O artigo é SKU.
quantidade	quantity	integer	A quantidade de artigos.
planeadoCedoEntregaHoraHora	plannedEarliestDeliveryDateTime	string	A data mais cedo em que a encomenda deve ser entregue.
planeadoLatestEntregaHoraHora	plannedLatestDeliveryDateTime	string	A data mais tardia em que a encomenda deve ser entregue.

Shipment

Uma quantidade de artigos, bens ou carga a granel que são enviados em conjunto.

Name	Caminho	Tipo	Description
id	id	string	O identificador único de um Envio.
estado	status	string	O estado da remessa.
shipmentOrderIds	shipmentOrderIds	array of string	A lista de IDs de Encomendas de Envio que são tratadas pelo Envio.
shipmentLocalizaçãoDados	shipmentLocationData	array of ShipmentLocation	Os dados das localizações do Envio. Atualmente, suporta apenas o tipo de localização de Origem e Destino.
shipmentPackingData	shipmentPackingData	ShipmentPackingData	Os Dados de Embalagem do Envio com detalhes das medições da embalagem
Carga de envio	shipmentCharge	ShipmentCharge	Detalhes da Taxa de Envio
shipmentReferenceData	shipmentReferenceData	ShipmentReferenceData	Os Dados de Referência de Envio que detêm os detalhes para rastrear a encomenda.
EnvioItens	shipmentItems	array of ShipmentItem	A lista de artigos a serem enviados como parte do envio.
estimadoTempo de Recolha	estimatedPickupTime	string	A hora planeada de recolha da Encomenda de Envio.
estimadoTempoDeApanhaDeMais Cedo	estimatedEarliestPickupTime	string	A hora planeada de recolha mais cedo da Encomenda de Envio.
estimadoTempo de Recolha Mais Recente	estimatedLatestPickupTime	string	A hora mais tardia planeada para recolha da Encomenda de Envio.
estimadoTempoDeEntrega	estimatedDeliveryTime	string	O tempo planeado de entrega da Encomenda de Envio.
estimadoTempoDeEntregaCedoEstimado	estimatedEarliestDeliveryTime	string	A hora planeada de entrega mais cedo da Encomenda de Envio.
estimadoLatestEntregaTempo	estimatedLatestDeliveryTime	string	A hora mais tardia planeada para a entrega da Encomenda de Envio.
shipmentContentData	shipmentContentData	ShipmentContentData	Os Dados de Conteúdo de Envio indicam a presença de certos tipos de artigos, como baterias ou frágeis.
hora da última modificação	lastModifiedTime	date-time	Obtém ou define o último tempo modificado
Instruções de entrega	deliveryInstructions	object	As instruções de entrega do Shipment.
customAttributes	customAttributes	object	Informação adicional de envio capturada como pares-chave-valor.
carrierName	carrierName	string	O nome do transportador para a remessa

EnvioLocalização

Os detalhes do local de embarque

Name	Caminho	Tipo	Description
shipmentNodeType	shipmentNodeType	string	O tipo de nó de envio. Atualmente, apenas Origin e Destination são suportados.
locationType	locationType	string	O tipo de localização representa se a localização é um armazém, cliente, etc.
nomedocontato	contactName	string	O nome de contacto de uma pessoa relacionada com a Localização
Número de contacto	contactNumber	string	O número de contacto de uma pessoa relacionada com a Localização
localização	location	Location	Uma localização de uma estrutura física.
customAttributes	customAttributes	object	Informação adicional de Localização do Envio capturada como pares-chave-valor.

ShipmentPackingData

Os Dados de Embalagem do Envio com detalhes das medições da embalagem

Name	Caminho	Tipo	Description
Volume de envio	shipmentVolume	double	O Volume
shipmentNetWeight	shipmentNetWeight	double	O Peso
volumeUnidadeDeMedida	volumeUnitOfMeasure	string	A Unidade de Volume de medida
PesoUnidadeDeMedida	weightUnitOfMeasure	string	A Unidade de Peso de Medida
EnvioComprimento	shipmentLength	double	A Duração
Largura de envio	shipmentWidth	double	A Largura
Carga Altura	shipmentHeight	double	A Altura
lwhUnidadeDeMedida	lwhUnitOfMeasure	string	A unidade de medida de comprimento, largura e altura
shipmentPackingType	shipmentPackingType	string	O tipo de embalagem do envio

ShipmentCharge

Detalhes da Taxa de Envio

Name	Caminho	Tipo	Description
custo estimado	estimatedCost	double	O Custo Estimado
código da moeda	currencyCode	string	O Código Monetário
billingData	billingData	BillingData	Os detalhes de Faturamento
componentCargas	componentCharges	array of ComponentCharge	Os dados de cargas componentes

BillingData

Os detalhes de Faturamento

Name	Caminho	Tipo	Description
ID do cliente	customerId	string	O ID do Cliente
nome_do_cliente	customerName	string	O Nome do Cliente
customAttributes	customAttributes	object	Informação adicional de dados de faturação capturada como pares-chave-valor

ComponentCharge

Os dados da Carga Componente

Name	Caminho	Tipo	Description
totalComponentCharge	totalComponentCharge	double	A carga total
chargeTypeId	chargeTypeId	string	O ID do tipo de carga
chargeTypeName	chargeTypeName	string	O nome do tipo de carga
isOpcional	isOptional	boolean	A bandeira IsOptional é definida para True se as cobranças relacionadas com o componente forem opcionais. Else False

ShipmentReferenceData

Os Dados de Referência de Envio que detêm os detalhes para rastrear a encomenda.

Name	Caminho	Tipo	Description
trackingNumber	trackingNumber	string	O número de rastreio
trackingUrl	trackingUrl	string	O URL de Rastreio
shipLabelUrl	shipLabelUrl	string	A URL da etiqueta do navio

ShipmentItem

Name	Caminho	Tipo	Description
itemSKU	itemSKU	string	O artigo é SKU.
quantidade	quantity	integer	A quantidade do item.

ShipmentContentData

Os Dados de Conteúdo de Envio indicam a presença de certos tipos de artigos, como baterias ou frágeis.

Name	Caminho	Tipo	Description
éFrágil	isFragile	boolean	A flag IsFragile está definida como verdadeira se existirem itens frágeis. Caso contrário, é falso.
inclui Bateria	includesBattery	boolean	A flag IncludesBattery está definida como true se a bateria fizer parte do pacote. Caso contrário, é falso.

Número

Algo que seja inventariado. Um SKU, unidade de manutenção de stock, refere-se a um artigo específico numa unidade de medida específica.

Name	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 dos códigos de barras dos artigos.
weight	weight	double	O peso padrão do item.
length	length	double	O comprimento padrão do item.
Largura	width	double	A largura padrão dos artigos.
profundidade	depth	double	A profundidade padrão dos itens.
Abreviatura	lwhUnitOfMeasure.abbreviation	string	A unidade de medida, comprimento, largura e altura.
Abreviatura	weightUnitOfMeasure.abbreviation	string	A unidade de peso de medida.
hora da última modificação	lastModifiedTime	date-time	Obtém ou define o último tempo modificado
sku	sku	string	O identificador da Unidade de Manutenção de Stock, que é normalmente utilizado para atividades relacionadas com inventário.
labels	labels	array of string	Rótulos / Etiquetas

Código de barras

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

ArmazémItem

Name	Caminho	Tipo	Description
Disponível ParaPromessaQuantidade	availableToPromiseQuantity	integer	A quantidade.
itemSKU	itemSKU	string	O SKU do item.
warehouseId	warehouseId	string	O SKU do item.
hora da última modificação	lastModifiedTime	date-time	Obtém ou define a última modificação da data em que este WarehouseItem foi obtido

BulkResponseItemDeItem

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

Name	Caminho	Tipo	Description
código de estado	statusCode	integer	O código de estado de resposta da ação em massa.
response	response	Item	Algo que seja inventariado. Um SKU, unidade de manutenção de stock, refere-se a um artigo específico numa unidade de medida específica.
erro	error	ErrorObject	O código e a mensagem de erro detalhados.
pedido	request	Item	Algo que seja inventariado. Um SKU, unidade de manutenção de stock, refere-se a um artigo específico numa unidade de medida específica.

Cumprimento de Encomendas

Name	Caminho	Tipo	Description
OrderLines	orderLines	array of OrderLine
shipmentToLocation	shipmentToLocation	Location	Uma localização de uma estrutura física.
shipmentToName	shipmentToName	string
RecetorEnvioContacto	shipmentReceiverContact	string
estado	status	string
id	id	string
fulfillmentPlanIds	fulfillmentPlanIds	array of string
tempo de criação	creationTime	date-time
hora da última modificação	lastModifiedTime	date-time
Observações	notes	array of Note

Encomenda

A Encomenda de Envio com detalhes como artigos a enviar, localização de origem/destino, cobranças, etc...

Name	Caminho	Tipo	Description
id	id	string	O identificador único de uma Ordem de Envio.
shipmentId	shipmentId	string	O Identificador de uma Remessa que envia esta Encomenda de Envio.
estado	status	string	O estado da Encomenda de Envio.
EnvioItens	shipmentItems	array of ShipmentItem	Os itens de envio que fazem parte da Ordem de Envio.
shipmentLocalizaçãoDados	shipmentLocationData	array of ShipmentLocation	Os dados das localizações da Encomenda de Envio. Atualmente, suporta apenas o tipo de localização de Origem e Destino.
shipmentPackingData	shipmentPackingData	ShipmentPackingData	Os Dados de Embalagem do Envio com detalhes das medições da embalagem
Carga de envio	shipmentCharge	ShipmentCharge	Detalhes da Taxa de Envio
Hora de Recolha planeada	plannedPickupTime	string	A hora planeada de recolha da Encomenda de Envio.
planeadoHora CedoPickupHora	plannedEarliestPickupTime	string	A hora planeada de recolha mais cedo da Encomenda de Envio.
planeadoTempo de RecolhaÚltima	plannedLatestPickupTime	string	A hora mais tardia planeada para recolha da Encomenda de Envio.
planeadoTempo de EntregaT	plannedDeliveryTime	string	O tempo planeado de entrega da Encomenda de Envio.
planeadoCedoPrazoDeEntrega	plannedEarliestDeliveryTime	string	A hora planeada de entrega mais cedo da Encomenda de Envio.
planeadoLatestEntregaTempo	plannedLatestDeliveryTime	string	A hora mais tardia planeada para a entrega da Encomenda de Envio.
shipmentContentData	shipmentContentData	ShipmentContentData	Os Dados de Conteúdo de Envio indicam a presença de certos tipos de artigos, como baterias ou frágeis.
Instruções de entrega	deliveryInstructions	object	As instruções de entrega da Ordem de Envio.
customAttributes	customAttributes	object	Informações adicionais da Encomenda de Envio capturadas como pares-chave-valor.
hora da última modificação	lastModifiedTime	date-time	Obtém ou define o último tempo modificado

Resposta em MassaEncomendaItemDeEnvio

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

Name	Caminho	Tipo	Description
código de estado	statusCode	integer	O código de estado de resposta da ação em massa.
response	response	ShipmentOrder	A Encomenda de Envio com detalhes como artigos a enviar, localização de origem/destino, cobranças, etc...
erro	error	ErrorObject	O código e a mensagem de erro detalhados.
pedido	request	ShipmentOrder	A Encomenda de Envio com detalhes como artigos a enviar, localização de origem/destino, cobranças, etc...

ShipmentQuote

Detalhes do orçamento de envio

Name	Caminho	Tipo	Description
id	id	string	O identificador único de um Orçamento de Envio.
EnvioOrçamentoPedidoId	shipmentQuoteRequestId	string	O identificador do Pedido de Orçamento de Envio O Orçamento de Envio está relacionado.
Carga de envio	shipmentCharge	ShipmentCharge	Detalhes da Taxa de Envio
Hora de Recolha planeada	plannedPickupTime	string	A hora planeada de recolha do Shipment.
planeadoTempo de EntregaT	plannedDeliveryTime	string	A hora planeada de entrega do Shipment.
CarrierData	carrierData	CarrierData	Os dados da Carrier
customAttributes	customAttributes	object	Informações adicionais sobre cotações de envio capturadas como pares-chave-valor.
hora da última modificação	lastModifiedTime	date-time	Obtém ou define o último tempo modificado

CarrierData

Os dados da Carrier

Name	Caminho	Tipo	Description
CarrierId	carrierId	string	O ID da Operadora
carrierName	carrierName	string	O nome da Carrier

Pedido de OrçamentoEnvio

Detalhes do Pedido de Orçamento de Envio

Name	Caminho	Tipo	Description
id	id	string	O identificador único de um Pedido de Orçamento de Envio.
EnvioItens	shipmentItems	array of ShipmentItem	Os itens de envio que fazem parte da Ordem de Envio.
shipmentLocalizaçãoDados	shipmentLocationData	array of ShipmentLocation	Os dados dos locais correspondentes ao Pedido de Orçamento de Envio. Atualmente, suporta apenas o tipo de localização de Origem e Destino.
shipmentPackingData	shipmentPackingData	ShipmentPackingData	Os Dados de Embalagem do Envio com detalhes das medições da embalagem
shipmentQuoteIds	shipmentQuoteIds	array of string	Os IDs do Orçamento de Envio correspondentes ao Pedido de Orçamento de Envio
Hora de Recolha planeada	plannedPickupTime	string	A hora planeada de recolha do Shipment.
planeadoTempo de EntregaT	plannedDeliveryTime	string	A hora planeada de entrega do Shipment.
hora da última modificação	lastModifiedTime	date-time	Obtém ou define o último tempo modificado

Armazém

Name	Caminho	Tipo	Description
id	id	string	O identificador do nó.
HorasDeOperações	hoursOfOperations	array of HoursOfOperation	Uma lista de horários de operação.
localização	location	Location	Uma localização de uma estrutura física.
labels	labels	array of string	Rótulos / Etiquetas
hora da última modificação	lastModifiedTime	date-time
Tempo de Entrega para PickAndPack	pickAndPackLeadTime	integer	Recebe ou define o PickAndPackLeadTime, que é o número de horas necessárias ao Armazém para escolher e embalar o artigo
CarrierReferências	carrierReferences	array of CarrierReference	A lista de informações sobre transportadores

CarrierReference

Name	Caminho	Tipo	Description
CarrierId	carrierId	string	ID de operador associado
Tempo de corte	cutoffTime	string	O tempo limite do carteiro em relação ao armazém.
Localizações de serviço	servingLocations	array of Location	Localizações de Serviço que contém uma lista de códigos postais a que o transportador atual pode servir. Lista nula ou vazia significa que este carteiro pode servir para qualquer código postal.
servingNodeIds	servingNodeIds	array of string	Servir identificadores de nó, que contém uma lista de IDs de nó a que o portador atual pode servir. Lista nula ou vazia significa que este portador pode servir a qualquer nó.

BulkResponseItemOfWarehouse

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

Name	Caminho	Tipo	Description
código de estado	statusCode	integer	O código de estado de resposta da ação em massa.
response	response	Warehouse
erro	error	ErrorObject	O código e a mensagem de erro detalhados.
pedido	request	Warehouse

RespostaBulkItemDeItemDeArmazémItem

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

Name	Caminho	Tipo	Description
código de estado	statusCode	integer	O código de estado de resposta da ação em massa.
response	response	WarehouseItem
erro	error	ErrorObject	O código e a mensagem de erro detalhados.
pedido	request	WarehouseItem

ficheiro

Este é o tipo de dados básicos 'arquivo'.