Flexe (versão prévia)
O Flexe é uma rede dinâmica e flexível de armazenagem e atendimento que atende à demanda. Conecte-se ao Flexe para recuperar e atualizar informações relacionadas à realização.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Classe | Regions |
|---|---|---|
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Azure Government regiões - Azure regiões da China - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Microsoft Dynamics |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| iomdri@microsoft.com |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft |
| Site | https://www.flexe.com/ |
| Política de privacidade | https://www.flexe.com/privacy-policy |
| Categorias | Produtividade |
Esse conector foi desenvolvido especificamente para ser usado para a integração do provedor Flexe do Dynamics 365 Intelligent Order Management.
Pré-requisitos
Uma conta de desenvolvedor flexe é necessária. Se você não tiver um, poderá criá-lo em https://developer-sandbox.flexe.com. Observação: é recomendável usar esse conector especificamente para configurar o provedor flexe de gerenciamento de pedidos inteligentes do Dynamics 365.
Como obter credenciais
Flexe requer um token de API para autenticação. Você pode gerar um token https://developer-sandbox.flexe.com/tokens e usá-lo para configurar o conector.
Introdução ao conector
Configure a conexão com as chaves de API. Para saber mais sobre a API do Flexe, leia a documentação pública: https://developer-sandbox.flexe.com/doc/public
Problemas e limitações conhecidos
Esse conector foi desenvolvido especificamente para ser usado para a integração do provedor Flexe do Dynamics 365 Intelligent Order Management. O suporte para usos fora do Dynamics 365 Intelligent Order Management será limitado.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Chave de API | secureString | A chave de API para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar a ordem de cumprimento do varejo existente |
Atualize a ordem de cumprimento do varejo existente. |
| Atualizar um pedido |
Atualize um pedido. |
| Cancelar uma linha de pedido de saída |
Cancele uma linha de pedido de saída. |
| Cria uma única ordem |
Cria uma única ordem. |
| Criar ordem de atendimento de varejo |
Criar ordem de atendimento de varejo. |
| Criar um anexo de pedido |
Crie um anexo de pedido. |
| Criar uma linha de ordem de saída |
Crie uma linha de ordem de saída. |
| Gravar um arquivo na chave especificada |
Escreva um arquivo na chave especificada. |
| Notificar o warehouse de uma remessa de entrada que contém produtos não palletizados |
Notifique o warehouse de uma remessa de entrada que contém produtos não palletizados. |
| Obter remessas de entrada que contêm produtos não palletizados |
Obtenha remessas de entrada que contêm produtos não palletizados. |
| Recuperar erros de alocação para uma linha de ordem de saída |
Recupere erros de alocação para uma linha de ordem de saída. |
| Recuperar erros de alocação para uma ordem de saída |
Recupere erros de alocação para uma ordem de saída. |
| Recuperar linhas de pedido de saída |
Recuperar linhas de ordem de saída. |
| Recuperar linhas para uma ordem de saída |
Recuperar linhas para uma ordem de saída. |
| Recuperar pedidos de saída |
Recuperar pedidos de saída. |
| Recuperar uma linha de ordem de saída por ID de pedido e ID de linha |
Recupere uma linha de ordem de saída por ID de pedido e ID de linha. |
| Recuperar uma ordem de saída por sua ID |
Recupere uma ordem de saída por sua ID. |
| Solicitar uma contagem de inventário por SKU do Flexe |
Solicite uma contagem de inventário por SKU do Flexe. |
Atualizar a ordem de cumprimento do varejo existente
Atualize a ordem de cumprimento do varejo existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Remessa
|
shipmentId | True | string |
A ID de remessa usada para recuperar a ordem de cumprimento do varejo. |
|
estado
|
state | string | ||
|
Scac
|
scac | string | ||
|
bolNumber
|
bolNumber | string | ||
|
meta
|
meta | string |
Atualizar um pedido
Atualize um pedido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do pedido
|
orderId | True | string |
A ID do pedido usada para atualizar um pedido. |
|
labels
|
labels | string | ||
|
cidade
|
city | True | string | |
|
country
|
country | True | string | |
|
line1
|
line1 | True | string | |
|
Cp
|
postcode | True | string | |
|
região
|
region | True | string | |
|
line2
|
line2 | string | ||
|
linha3
|
line3 | string | ||
|
nome
|
name | True | string | |
|
phone
|
phone | string | ||
|
email
|
string | |||
|
instructions
|
instructions | string | ||
|
serviceType
|
serviceType | string | ||
|
carrierBillingAccountId
|
carrierBillingAccountId | string | ||
|
signatureConfirmation
|
signatureConfirmation | string | ||
|
labelReference1
|
labelReference1 | string | ||
|
labelReference2
|
labelReference2 | string | ||
|
reservationId
|
reservationId | string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
propriedade1
|
labels.property1 | string | |
|
property2
|
labels.property2 | string | |
|
ID externo
|
externalId | string | |
|
reservationId
|
reservationId | string | |
|
country
|
recipient.address.country | string | |
|
cidade
|
recipient.address.city | string | |
|
Cp
|
recipient.address.postcode | string | |
|
linha3
|
recipient.address.line3 | string | |
|
região
|
recipient.address.region | string | |
|
line2
|
recipient.address.line2 | string | |
|
line1
|
recipient.address.line1 | string | |
|
phone
|
recipient.phone | string | |
|
nome
|
recipient.name | string | |
|
email
|
recipient.email | string | |
|
serviceType
|
shipping.serviceType | string | |
|
instructions
|
shipping.instructions | string | |
|
labelReference1
|
shipping.labelReference1 | string | |
|
labelReference2
|
shipping.labelReference2 | string | |
|
carrierBillingAccountId
|
shipping.carrierBillingAccountId | string | |
|
signatureConfirmation
|
shipping.signatureConfirmation | string | |
|
id
|
id | string | |
|
createdAt
|
createdAt | string | |
|
updatedAt
|
updatedAt | string | |
|
estado
|
state | string | |
|
hasErrors
|
hasErrors | boolean | |
|
shipmentIds
|
shipmentIds | array of string |
shipmentIds |
Cancelar uma linha de pedido de saída
Cancele uma linha de pedido de saída.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do pedido
|
orderId | True | string |
A ID do pedido usada para cancelar a linha de pedidos de saída. |
|
ID da linha
|
lineId | True | string |
A ID de linha usada para cancelar a linha de pedidos de saída. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
quantidade
|
quantity | integer | |
|
unitOfMeasure
|
unitOfMeasure | string | |
|
ID externo
|
externalId | string | |
|
sku
|
sku | string | |
|
chave
|
labels.key | string | |
|
id
|
id | string | |
|
ID do pedido
|
orderId | string | |
|
createdAt
|
createdAt | string | |
|
updatedAt
|
updatedAt | string | |
|
cancelledAt
|
cancelledAt | string | |
|
completelyShippedAt
|
completelyShippedAt | string | |
|
percentAllocated
|
percentAllocated | integer | |
|
percentShipped
|
percentShipped | integer | |
|
hasErrors
|
hasErrors | boolean | |
|
shipmentIds
|
shipmentIds | array of string |
shipmentIds |
|
allocatedQuantity
|
allocatedQuantity | integer | |
|
shippedQuantity
|
shippedQuantity | integer |
Cria uma única ordem
Cria uma única ordem.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
createdAt
|
createdAt | string | |
|
updatedAt
|
updatedAt | string | |
|
estado
|
state | string | |
|
hasErrors
|
hasErrors | boolean | |
|
ID externo
|
externalId | string | |
|
chave
|
labels.key | string | |
|
reservationId
|
reservationId | string | |
|
nome
|
recipient.name | string | |
|
phone
|
recipient.phone | string | |
|
email
|
recipient.email | string | |
|
line1
|
recipient.address.line1 | string | |
|
line2
|
recipient.address.line2 | string | |
|
linha3
|
recipient.address.line3 | string | |
|
cidade
|
recipient.address.city | string | |
|
região
|
recipient.address.region | string | |
|
Cp
|
recipient.address.postcode | string | |
|
country
|
recipient.address.country | string | |
|
instructions
|
shipping.instructions | string | |
|
serviceType
|
shipping.serviceType | string | |
|
carrierBillingAccountId
|
shipping.carrierBillingAccountId | string | |
|
signatureConfirmation
|
shipping.signatureConfirmation | string | |
|
labelReference1
|
shipping.labelReference1 | string | |
|
labelReference2
|
shipping.labelReference2 | string |
Criar ordem de atendimento de varejo
Criar ordem de atendimento de varejo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string | |
|
tipo
|
type | True | string | |
|
customerUUID
|
customerUUID | True | string | |
|
value
|
value | True | string | |
|
value
|
value | True | string | |
|
sku
|
sku | True | string | |
|
value
|
value | string | ||
|
endereçoLinha1
|
addressLine1 | True | string | |
|
country
|
country | True | string | |
|
localidade
|
locality | True | string | |
|
nome
|
name | True | string | |
|
Cp
|
postcode | True | string | |
|
região
|
region | True | string | |
|
endereçoLinha2
|
addressLine2 | string | ||
|
endereçoLinha3
|
addressLine3 | string | ||
|
phone
|
phone | string | ||
|
email
|
string | |||
|
término
|
end | True | string | |
|
início
|
start | True | string | |
|
tipo de remessa
|
shipmentType | string | ||
|
tipo
|
type | True | string | |
|
shipmentMethod
|
shipmentMethod | string | ||
|
purchaseOrder
|
purchaseOrder | string | ||
|
routeBy
|
routeBy | string | ||
|
instructions
|
instructions | string | ||
|
operadora
|
carrier | string | ||
|
carrierServiceType
|
carrierServiceType | string | ||
|
carrierBillingAccountId
|
carrierBillingAccountId | string | ||
|
número
|
number | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
tipo
|
type | string | ||
|
routingDetailsId
|
routingDetailsId | string | ||
|
destinationType
|
destinationType | string | ||
|
destinationRetailer
|
destinationRetailer | string | ||
|
correlationId
|
correlationId | True | string |
Criar um anexo de pedido
Crie um anexo de pedido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do pedido
|
orderId | True | string |
A ID da ordem para a qual o anexo está sendo criado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
externalUrl
|
externalUrl | string | |
|
ID do pedido
|
orderId | string | |
|
documentType
|
documentType | string | |
|
nome de exibição
|
displayName | string | |
|
cancelledAt
|
cancelledAt | string | |
|
ID externo
|
externalId | string | |
|
fileKey
|
fileKey | string | |
|
tipo
|
type | string | |
|
chave
|
labels.key | string | |
|
barcodeText
|
barcodeText | string | |
|
createdAt
|
createdAt | string | |
|
id
|
id | string | |
|
Arquivos
|
fileGroup | string | |
|
número de rastreamento
|
trackingNumber | string |
Criar uma linha de ordem de saída
Crie uma linha de ordem de saída.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do pedido
|
orderId | True | string |
A ID do pedido usada para criar a linha de pedidos de saída. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
quantidade
|
quantity | integer | |
|
unitOfMeasure
|
unitOfMeasure | string | |
|
ID externo
|
externalId | string | |
|
sku
|
sku | string | |
|
chave
|
labels.key | string | |
|
id
|
id | string | |
|
ID do pedido
|
orderId | string | |
|
createdAt
|
createdAt | string | |
|
updatedAt
|
updatedAt | string | |
|
cancelledAt
|
cancelledAt | string | |
|
completelyShippedAt
|
completelyShippedAt | string | |
|
percentAllocated
|
percentAllocated | integer | |
|
percentShipped
|
percentShipped | integer | |
|
hasErrors
|
hasErrors | boolean | |
|
shipmentIds
|
shipmentIds | array of string |
shipmentIds |
|
allocatedQuantity
|
allocatedQuantity | integer | |
|
shippedQuantity
|
shippedQuantity | integer |
Gravar um arquivo na chave especificada
Escreva um arquivo na chave especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Chave
|
key | True | string |
Uma chave exclusiva usada para identificar um arquivo e impedir duplicatas. |
|
Nome
|
name | string |
O nome do arquivo. O nome não precisa ser exclusivo e pode ser usado para rastrear um nome de arquivo. |
|
|
body
|
body | True | binary |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
createdAt
|
createdAt | string | |
|
deletedAt
|
deletedAt | string | |
|
tamanho
|
size | integer | |
|
nome
|
name | string | |
|
tipo de conteúdo
|
contentType | string | |
|
chave
|
key | string | |
|
chave
|
labels.key | string | |
|
updatedAt
|
updatedAt | string |
Notificar o warehouse de uma remessa de entrada que contém produtos não palletizados
Notifique o warehouse de uma remessa de entrada que contém produtos não palletizados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
billOfLading
|
billOfLading | string | ||
|
amount
|
amount | True | integer | |
|
unidade
|
unit | True | string | |
|
sku
|
sku | string | ||
|
expectedInboundShipmentType
|
expectedInboundShipmentType | string | ||
|
customerUUID
|
customerUUID | True | string | |
|
containerNumber
|
containerNumber | string | ||
|
amount
|
amount | True | string | |
|
unidade
|
unit | True | string | |
|
Purchaseorderid
|
purchaseOrderId | True | string | |
|
dropoffDate
|
dropoffDate | True | string | |
|
containerSealNumber
|
containerSealNumber | string | ||
|
id
|
id | True | string | |
|
tipo
|
type | True | string | |
|
suplierOrVendor
|
suplierOrVendor | string | ||
|
id
|
id | string | ||
|
customReference1
|
customReference1 | string | ||
|
lotCode
|
lotCode | string | ||
|
asnNumber
|
asnNumber | string | ||
|
manufactureDate
|
manufactureDate | string | ||
|
chave
|
key | string | ||
|
countryOfOrigin
|
countryOfOrigin | string | ||
|
número po.
|
poNumber | string | ||
|
originSite
|
originSite | string | ||
|
customReference2
|
customReference2 | string | ||
|
data de expiração
|
expirationDate | string | ||
|
etiqueta
|
label | string | ||
|
unidade
|
unit | string | ||
|
quantidade
|
quantity | integer | ||
|
sku
|
sku | string | ||
|
correlationId
|
correlationId | True | string |
Obter remessas de entrada que contêm produtos não palletizados
Obtenha remessas de entrada que contêm produtos não palletizados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Token de continuação
|
continuationToken | True | string |
O token de continuação usado para recuperar as remessas de entrada da próxima página quando mais páginas ainda estiverem disponíveis. |
|
Tamanho da página
|
pageSize | True | string |
O tamanho da página usado para recuperar remessas de entrada. |
|
State
|
state | True | string |
O estado usado para recuperar remessas de entrada. |
|
Criado a partir de
|
createdAtFrom | True | string |
O criado a partir de usado para recuperar remessas de entrada. |
|
Criado em
|
createdAtTo | True | string |
O criado para ser usado para recuperar remessas de entrada. |
|
Atualizado em De
|
updatedAtFrom | True | string |
O atualizado em de usado para recuperar remessas de entrada. |
|
Atualizado em Para
|
updatedAtTo | True | string |
O atualizado para ser usado para recuperar remessas de entrada. |
|
UUID do cliente
|
customerUUID | True | string |
A UUID do cliente usada para recuperar remessas de entrada. |
|
Ordem de Compra
|
purchaseOrder | True | string |
A ordem de compra usada para recuperar remessas de entrada. |
|
Reservas
|
reservations | True | string |
As reservas usadas para recuperar remessas de entrada. |
Recuperar erros de alocação para uma linha de ordem de saída
Recupere erros de alocação para uma linha de ordem de saída.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tamanho da Página
|
pageSize | True | string |
O tamanho da página usado para recuperar erros de linha de ordem de saída. |
|
Token de continuação
|
continuationToken | True | string |
O token de continuação usado para recuperar erros de linha de ordem de saída da próxima página. |
|
ID do pedido
|
orderId | True | string |
A ID do pedido usada para recuperar erros de linha de pedidos de saída. |
|
ID da linha
|
lineId | True | string |
A ID de linha usada para recuperar erros de linha de pedidos de saída. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
total
|
total | integer | |
|
token de continuação (continuationToken)
|
continuationToken | string | |
|
allocationErrors
|
allocationErrors | array of object |
allocationErrors |
|
orderExternalId
|
allocationErrors.orderExternalId | string | |
|
createdAt
|
allocationErrors.createdAt | string | |
|
codificar
|
allocationErrors.code | string | |
|
ID do pedido
|
allocationErrors.orderId | string | |
|
lineExternalId
|
allocationErrors.lineExternalId | string | |
|
details
|
allocationErrors.details | string | |
|
orderLineId
|
allocationErrors.orderLineId | string | |
|
chave
|
allocationErrors.labels.key | string |
Recuperar erros de alocação para uma ordem de saída
Recupere erros de alocação para uma ordem de saída.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tamanho da Página
|
pageSize | True | string |
O tamanho da página usado para recuperar erros de ordem de saída. |
|
Token de continuação
|
continuationToken | True | string |
O token de continuação usado para recuperar erros de ordem de saída da próxima página. |
|
ID do pedido
|
orderId | True | string |
A ID do pedido usada para recuperar erros de ordem de saída. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
total
|
total | integer | |
|
token de continuação (continuationToken)
|
continuationToken | string | |
|
allocationErrors
|
allocationErrors | array of object |
allocationErrors |
|
orderExternalId
|
allocationErrors.orderExternalId | string | |
|
createdAt
|
allocationErrors.createdAt | string | |
|
codificar
|
allocationErrors.code | string | |
|
ID do pedido
|
allocationErrors.orderId | string | |
|
lineExternalId
|
allocationErrors.lineExternalId | string | |
|
details
|
allocationErrors.details | string | |
|
orderLineId
|
allocationErrors.orderLineId | string | |
|
chave
|
allocationErrors.labels.key | string |
Recuperar linhas de pedido de saída
Recuperar linhas de ordem de saída.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tamanho da Página
|
pageSize | True | string |
O tamanho da página usado para recuperar linhas de ordem de saída. |
|
Token de continuação
|
continuationToken | True | string |
O token de continuação usado para recuperar as linhas de ordem de saída da próxima página. |
|
Criado a partir de
|
createdAtFrom | True | string |
O criado a partir de usado para recuperar linhas de ordem de saída. |
|
Criado em
|
createdAtTo | True | string |
O criado para ser usado para recuperar linhas de ordem de saída. |
|
IDs externas
|
externalIds | True | string |
As IDs externas usadas para recuperar linhas de ordem de saída. |
|
Skus
|
skus | True | string |
Os skus usados para recuperar linhas de ordem de saída. |
|
Rótulos
|
labels | True | string |
Os rótulos usados para recuperar linhas de pedidos de saída. |
|
IDs do pedido
|
orderIds | True | string |
As IDs de pedido usadas para recuperar linhas de pedidos de saída. |
|
IDs de linha
|
lineIds | True | string |
As IDs de linha usadas para recuperar linhas de pedidos de saída. |
|
Tem erros
|
hasErrors | True | string |
Os erros usados para recuperar linhas de pedidos de saída. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
total
|
total | integer | |
|
token de continuação (continuationToken)
|
continuationToken | string | |
|
Linhas
|
lines | array of object |
Linhas |
|
id
|
lines.id | string | |
|
chave
|
lines.labels.key | string | |
|
ID externo
|
lines.externalId | string | |
|
sku
|
lines.sku | string | |
|
quantidade
|
lines.quantity | integer | |
|
unitOfMeasure
|
lines.unitOfMeasure | string | |
|
ID do pedido
|
lines.orderId | string | |
|
createdAt
|
lines.createdAt | string | |
|
updatedAt
|
lines.updatedAt | string | |
|
cancelledAt
|
lines.cancelledAt | string | |
|
completelyShippedAt
|
lines.completelyShippedAt | string | |
|
percentAllocated
|
lines.percentAllocated | integer | |
|
percentShipped
|
lines.percentShipped | integer | |
|
hasErrors
|
lines.hasErrors | boolean | |
|
shipmentIds
|
lines.shipmentIds | array of string |
shipmentIds |
|
allocatedQuantity
|
lines.allocatedQuantity | integer | |
|
shippedQuantity
|
lines.shippedQuantity | integer |
Recuperar linhas para uma ordem de saída
Recuperar linhas para uma ordem de saída.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tamanho da Página
|
pageSize | True | string |
O tamanho da página usado para recuperar linhas de ordem de saída. |
|
Token de continuação
|
continuationToken | True | string |
O token de continuação usado para recuperar as linhas de ordem de saída da próxima página. |
|
Criado a partir de
|
createdAtFrom | True | string |
O criado a partir de usado para recuperar linhas de ordem de saída. |
|
Criado em
|
createdAtTo | True | string |
O criado para ser usado para recuperar linhas de ordem de saída. |
|
IDs externas
|
externalIds | True | string |
As IDs externas usadas para recuperar linhas de ordem de saída. |
|
Skus
|
skus | True | string |
Os skus usados para recuperar linhas de ordem de saída. |
|
IDs de linha
|
lineIds | True | string |
As IDs de linha usadas para recuperar linhas de pedidos de saída. |
|
Rótulos
|
labels | True | string |
Os rótulos usados para recuperar linhas de pedidos de saída. |
|
ID do pedido
|
orderId | True | string |
A ID do pedido usada para recuperar linhas de pedidos de saída. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
total
|
total | integer | |
|
token de continuação (continuationToken)
|
continuationToken | string | |
|
Linhas
|
lines | array of object |
Linhas |
|
id
|
lines.id | string | |
|
chave
|
lines.labels.key | string | |
|
ID externo
|
lines.externalId | string | |
|
sku
|
lines.sku | string | |
|
quantidade
|
lines.quantity | integer | |
|
unitOfMeasure
|
lines.unitOfMeasure | string | |
|
ID do pedido
|
lines.orderId | string | |
|
createdAt
|
lines.createdAt | string | |
|
updatedAt
|
lines.updatedAt | string | |
|
cancelledAt
|
lines.cancelledAt | string | |
|
completelyShippedAt
|
lines.completelyShippedAt | string | |
|
percentAllocated
|
lines.percentAllocated | integer | |
|
percentShipped
|
lines.percentShipped | integer | |
|
hasErrors
|
lines.hasErrors | boolean | |
|
shipmentIds
|
lines.shipmentIds | array of string |
shipmentIds |
|
allocatedQuantity
|
lines.allocatedQuantity | integer | |
|
shippedQuantity
|
lines.shippedQuantity | integer |
Recuperar pedidos de saída
Recuperar pedidos de saída.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Token de continuação
|
continuationToken | True | string |
O token de continuação usado para recuperar pedidos de saída da próxima página. |
|
IDs
|
ids | True | string |
As IDs usadas para recuperar pedidos de saída. |
|
IDs externas
|
externalIds | True | string |
As IDs externas usadas para recuperar pedidos de saída. |
|
Tamanho da Página
|
pageSize | True | string |
O tamanho da página usado para recuperar pedidos de saída. |
|
Criado a partir de
|
createdAtFrom | True | string |
O criado a partir do usado para recuperar pedidos de saída. |
|
Criado em
|
createdAtTo | True | string |
O criado para ser usado para recuperar pedidos de saída. |
|
Rótulos
|
labels | True | string |
Os rótulos usados para recuperar pedidos de saída. |
|
Tem erros
|
hasErrors | True | string |
Os erros usados para recuperar pedidos de saída. |
|
State
|
state | True | string |
O estado usado para recuperar pedidos de saída. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
total
|
total | integer | |
|
token de continuação (continuationToken)
|
continuationToken | string | |
|
outboundOrders
|
outboundOrders | array of object |
outboundOrders |
|
id
|
outboundOrders.id | string | |
|
createdAt
|
outboundOrders.createdAt | string | |
|
updatedAt
|
outboundOrders.updatedAt | string | |
|
estado
|
outboundOrders.state | string | |
|
hasErrors
|
outboundOrders.hasErrors | boolean | |
|
ID externo
|
outboundOrders.externalId | string | |
|
chave
|
outboundOrders.labels.key | string | |
|
reservationId
|
outboundOrders.reservationId | string | |
|
nome
|
outboundOrders.recipient.name | string | |
|
phone
|
outboundOrders.recipient.phone | string | |
|
email
|
outboundOrders.recipient.email | string | |
|
line1
|
outboundOrders.recipient.address.line1 | string | |
|
line2
|
outboundOrders.recipient.address.line2 | string | |
|
linha3
|
outboundOrders.recipient.address.line3 | string | |
|
cidade
|
outboundOrders.recipient.address.city | string | |
|
região
|
outboundOrders.recipient.address.region | string | |
|
Cp
|
outboundOrders.recipient.address.postcode | string | |
|
country
|
outboundOrders.recipient.address.country | string | |
|
instructions
|
outboundOrders.shipping.instructions | string | |
|
serviceType
|
outboundOrders.shipping.serviceType | string | |
|
carrierBillingAccountId
|
outboundOrders.shipping.carrierBillingAccountId | string | |
|
signatureConfirmation
|
outboundOrders.shipping.signatureConfirmation | string | |
|
labelReference1
|
outboundOrders.shipping.labelReference1 | string | |
|
labelReference2
|
outboundOrders.shipping.labelReference2 | string |
Recuperar uma linha de ordem de saída por ID de pedido e ID de linha
Recupere uma linha de ordem de saída por ID de pedido e ID de linha.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do pedido
|
orderId | True | string |
A ID do pedido usada para recuperar a linha de pedidos de saída. |
|
ID da linha
|
lineId | True | string |
A ID de linha usada para recuperar a linha de pedidos de saída. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
quantidade
|
quantity | integer | |
|
unitOfMeasure
|
unitOfMeasure | string | |
|
ID externo
|
externalId | string | |
|
sku
|
sku | string | |
|
chave
|
labels.key | string | |
|
id
|
id | string | |
|
ID do pedido
|
orderId | string | |
|
createdAt
|
createdAt | string | |
|
updatedAt
|
updatedAt | string | |
|
cancelledAt
|
cancelledAt | string | |
|
completelyShippedAt
|
completelyShippedAt | string | |
|
percentAllocated
|
percentAllocated | integer | |
|
percentShipped
|
percentShipped | integer | |
|
hasErrors
|
hasErrors | boolean | |
|
shipmentIds
|
shipmentIds | array of string |
shipmentIds |
|
allocatedQuantity
|
allocatedQuantity | integer | |
|
shippedQuantity
|
shippedQuantity | integer |
Recuperar uma ordem de saída por sua ID
Recupere uma ordem de saída por sua ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do pedido
|
orderId | True | string |
A ID do pedido usada para recuperar a ordem de saída. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
propriedade1
|
labels.property1 | string | |
|
property2
|
labels.property2 | string | |
|
ID externo
|
externalId | string | |
|
reservationId
|
reservationId | string | |
|
country
|
recipient.address.country | string | |
|
cidade
|
recipient.address.city | string | |
|
Cp
|
recipient.address.postcode | string | |
|
linha3
|
recipient.address.line3 | string | |
|
região
|
recipient.address.region | string | |
|
line2
|
recipient.address.line2 | string | |
|
line1
|
recipient.address.line1 | string | |
|
phone
|
recipient.phone | string | |
|
nome
|
recipient.name | string | |
|
email
|
recipient.email | string | |
|
serviceType
|
shipping.serviceType | string | |
|
instructions
|
shipping.instructions | string | |
|
labelReference1
|
shipping.labelReference1 | string | |
|
labelReference2
|
shipping.labelReference2 | string | |
|
carrierBillingAccountId
|
shipping.carrierBillingAccountId | string | |
|
signatureConfirmation
|
shipping.signatureConfirmation | string | |
|
id
|
id | string | |
|
createdAt
|
createdAt | string | |
|
updatedAt
|
updatedAt | string | |
|
estado
|
state | string | |
|
hasErrors
|
hasErrors | boolean | |
|
shipmentIds
|
shipmentIds | array of string |
shipmentIds |
Solicitar uma contagem de inventário por SKU do Flexe
Solicite uma contagem de inventário por SKU do Flexe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de reserva
|
reservation_id | string |
Filtrar o inventário disponível em um armazém específico atribuído à reserva. |
|
|
ID da solicitação do cliente
|
client_request_id | string |
Uma chave que será enviada de volta ao cliente no objeto de resposta para que os clientes possam usar para identificar a chamada de origem. |
|
|
Token de continuação
|
continuation_token | string |
Obtenha a próxima página de dados. O tamanho da página é de 3.000 skus. O valor é fornecido na resposta anterior. |
|
|
Sempre em uso
|
ever_in_use | string |
Booliano, onde true obtém todos os inventários já armazenados enquanto false obtém todos os estoques atualmente armazenados. O padrão é true. |
|
|
Em uso desde
|
in_use_since | string |
Cadeia de caracteres opcional, ISO8601 data. Por exemplo, "2019-09-01". Se preenchido, retorne apenas o inventário que foi usado em ou após essa data. Não é válido, a menos que 'ever_in_use' também esteja definido. O padrão é zero. |
|
|
Item IDs
|
item_ids[] | string |
Filtre os detalhes de itens com IDs específicas. Se preenchido, as opções de filtro de ever_in_use e skus serão desconsideradas. |
|
|
Skus
|
skus[] | string |
Filtre os detalhes dos itens com skus específicos. Se populada, ever_in_use opção de filtro será desconsiderada. |
Gatilhos
| Ouça o webhook |
Estabeleça um webhook que receba transações do Flexe. |
Ouça o webhook
Estabeleça um webhook que receba transações do Flexe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
nome
|
name | True | string |