ShipStation (Pré-visualização)
A ShipStation é o principal software de envio baseado na web que ajuda os retalhistas online a simplificar o cumprimento das suas encomendas, onde quer que vendam e como enviem.
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 | Dinâmica da Microsoft |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| iomdri@microsoft.com |
| Metadados do conector | |
|---|---|
| Editor | Microsoft |
| Sítio Web | https://www.shipstation.com/ |
| Política de privacidade | https://www.shipstation.com/privacy-policy/ |
| Categorias | Productivity |
Este conector foi especificamente desenvolvido para ser utilizado na integração do fornecedor ShipStation do Dynamics 365 Intelligent Order Management.
Pré-requisitos
É necessária uma conta de programador ShipStation. Se não tiver um, pode criá-lo em https://www.shipstation.com/docs/api/requirements/. Nota: Recomenda-se usar este conector especificamente para configurar o fornecedor Dynamics 365 Intelligent Order Management ShipStation.
Como obter credenciais
O ShipStation requer uma API Key e um Secret para autenticação. Podes gerar um token https://ship13.shipstation.com/settings/api e usá-lo para configurar o conector.
Introdução ao conector
Configure a ligação com a Chave API e o Segredo. Para saber mais sobre as APIs da ShipStation, leia a documentação pública: https://www.shipstation.com/docs/api/
Problemas conhecidos e limitações
Este conector foi especificamente desenvolvido para ser utilizado na integração do fornecedor ShipStation do Dynamics 365 Intelligent Order Management. O suporte para casos de uso fora do Dynamics 365 Intelligent Order Management será limitado.
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 |
|---|---|---|---|
| nome de utilizador | securestring | O nome de usuário para esta api | Verdade |
| palavra-passe | securestring | A senha para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Criar Etiqueta para Ordem |
Cria uma etiqueta de envio para uma determinada encomenda. O campo labelData devolvido na resposta é um valor PDF codificado base64. Basta descodificar e guardar o resultado como ficheiro PDF para obter uma etiqueta imprimível. |
| Obter Encomenda |
Recupera uma única ordem da base de dados. |
| Ordem de Criação ou Atualização |
Se a orderKey for especificada, o método torna-se idempotente e a ordem existente com essa chave será atualizada. Nota: Apenas as encomendas em estado aberto no ShipStation (awaiting_payment, awaiting_shipment e on_hold) podem ser atualizadas através deste método. cancelados e enviados estão bloqueados para modificação através da API. |
Criar Etiqueta para Ordem
Cria uma etiqueta de envio para uma determinada encomenda. O campo labelData devolvido na resposta é um valor PDF codificado base64. Basta descodificar e guardar o resultado como ficheiro PDF para obter uma etiqueta imprimível.
Devoluções
Obter Encomenda
Recupera uma única ordem da base de dados.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Obter Encomenda
|
orderId | True | double |
O sistema gerava o identificador para a encomenda. |
Devoluções
- Corpo
- GetOrderResponse
Ordem de Criação ou Atualização
Se a orderKey for especificada, o método torna-se idempotente e a ordem existente com essa chave será atualizada. Nota: Apenas as encomendas em estado aberto no ShipStation (awaiting_payment, awaiting_shipment e on_hold) podem ser atualizadas através deste método. cancelados e enviados estão bloqueados para modificação através da API.
Devoluções
Acionadores
| Subscreva o Webhook |
Subscreve um tipo específico de webhook. Se um store_id for passado, os webhooks só serão ativados nesse store_id específico. O tipo de evento transmitido determinará que tipo de webhooks serão enviados. Deve conter um dos seguintes valores: ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK. |
Subscreva o Webhook
Subscreve um tipo específico de webhook. Se um store_id for passado, os webhooks só serão ativados nesse store_id específico. O tipo de evento transmitido determinará que tipo de webhooks serão enviados. Deve conter um dos seguintes valores: ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
friendly_name
|
friendly_name | True | string | |
|
store_id
|
store_id | string | ||
|
evento
|
event | True | string |
Definições
GetOrderResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Pedido
|
orderId | integer | |
|
Número da encomenda
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
orderDate
|
orderDate | string | |
|
createDate
|
createDate | string | |
|
modificarData
|
modifyDate | string | |
|
data de pagamento
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
ID do cliente
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
e-mail do cliente
|
customerEmail | string | |
|
BillTo
|
billTo | BillTo | |
|
ShipTo
|
shipTo | ShipTo | |
|
itens
|
items | array of Item | |
|
ordemTotal
|
orderTotal | double | |
|
montantePago
|
amountPaid | double | |
|
taxMontante
|
taxAmount | float | |
|
envioMontante
|
shippingAmount | float | |
|
notas do cliente
|
customerNotes | string | |
|
internalNotas
|
internalNotes | string | |
|
Presente
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
Método de pagamento
|
paymentMethod | string | |
|
solicitadoServiço de Envio
|
requestedShippingService | string | |
|
CarrierCode
|
carrierCode | string | |
|
ServiceCode
|
serviceCode | string | |
|
Código do pacote
|
packageCode | string | |
|
confirmação
|
confirmation | string | |
|
data de envio
|
shipDate | string | |
|
holdTillilDate
|
holdUntilDate | string | |
|
Peso
|
weight | Weight | |
|
Dimensões
|
dimensions | Dimensions | |
|
InsuranceOptions
|
insuranceOptions | InsuranceOptions | |
|
InternacionalOptions
|
internationalOptions | InternationalOptions | |
|
Opções Avançadas
|
advancedOptions | AdvancedOptions | |
|
tagIds
|
tagIds | string | |
|
ID de Utilizador
|
userId | string | |
|
externamenteRealizado
|
externallyFulfilled | boolean | |
|
externamenteFulfilledBy
|
externallyFulfilledBy | string |
BillTo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string | |
|
empresa
|
company | string | |
|
rua1
|
street1 | string | |
|
rua2
|
street2 | string | |
|
rua3
|
street3 | string | |
|
cidade
|
city | string | |
|
state
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
Residencial
|
residential | string | |
|
endereçoVerificado
|
addressVerified | string |
ShipTo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string | |
|
empresa
|
company | string | |
|
rua1
|
street1 | string | |
|
rua2
|
street2 | string | |
|
rua3
|
street3 | string | |
|
cidade
|
city | string | |
|
state
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
Residencial
|
residential | boolean | |
|
endereçoVerificado
|
addressVerified | string |
Option
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string | |
|
value
|
value | string |
Dimensões
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
unidades
|
units | string | |
|
length
|
length | float | |
|
Largura
|
width | float | |
|
altura
|
height | float |
InsuranceOptions
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
fornecedor
|
provider | string | |
|
insureShipment
|
insureShipment | boolean | |
|
Valor segurado
|
insuredValue | float |
InternacionalOptions
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
contents
|
contents | string | |
|
Itens Customizados
|
customsItems | array of CustomsItem | |
|
nãoEntrega
|
nonDelivery | string |
CustomsItem
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
customsItemId
|
customsItemId | integer | |
|
descrição
|
description | string | |
|
quantidade
|
quantity | float | |
|
value
|
value | float | |
|
Código Tarifário harmonizado
|
harmonizedTariffCode | string | |
|
paísDeOrigem
|
countryOfOrigin | string |
Opções Avançadas
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
warehouseId
|
warehouseId | integer | |
|
nãoMachineable
|
nonMachinable | boolean | |
|
sábadoEntrega
|
saturdayDelivery | boolean | |
|
contém álcool
|
containsAlcohol | boolean | |
|
mergedOrSplit
|
mergedOrSplit | boolean | |
|
mergedIds
|
mergedIds | array of string | |
|
parentId
|
parentId | string | |
|
storeId
|
storeId | integer | |
|
customField1
|
customField1 | string | |
|
customField2
|
customField2 | string | |
|
customField3
|
customField3 | string | |
|
origem
|
source | string | |
|
billToParty
|
billToParty | string | |
|
billToAccount
|
billToAccount | string | |
|
billToCódigo Postal
|
billToPostalCode | string | |
|
billToCountryCode
|
billToCountryCode | string |
Número
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
LineItemKey
|
lineItemKey | string | |
|
sku
|
sku | string | |
|
Nome
|
name | string | |
|
imageUrl
|
imageUrl | string | |
|
Peso
|
weight | Weight | |
|
quantidade
|
quantity | float | |
|
preço unitário
|
unitPrice | double | |
|
taxMontante
|
taxAmount | double | |
|
envioMontante
|
shippingAmount | double | |
|
ArmazénLocalização
|
warehouseLocation | string | |
|
options
|
options | array of Option | |
|
productId
|
productId | integer | |
|
fulfillmentSku
|
fulfillmentSku | string | |
|
ajuste
|
adjustment | boolean | |
|
UPC
|
upc | string |
Peso
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | float | |
|
unidades
|
units | string |
CriarEtiqueta ParaEncomendaResposta
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
shipmentId
|
shipmentId | integer | |
|
Custo de envio
|
shipmentCost | double | |
|
seguroCusto
|
insuranceCost | float | |
|
trackingNumber
|
trackingNumber | string | |
|
labelData
|
labelData | string | |
|
formData
|
formData | string |
CriarAtualizarOrdenarResposta
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Pedido
|
orderId | integer | |
|
Número da encomenda
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
orderDate
|
orderDate | string | |
|
createDate
|
createDate | string | |
|
modificarData
|
modifyDate | string | |
|
data de pagamento
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
ID do cliente
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
e-mail do cliente
|
customerEmail | string | |
|
BillTo
|
billTo | BillTo | |
|
ShipTo
|
shipTo | ShipTo | |
|
itens
|
items | array of Item | |
|
ordemTotal
|
orderTotal | double | |
|
montantePago
|
amountPaid | double | |
|
taxMontante
|
taxAmount | float | |
|
envioMontante
|
shippingAmount | float | |
|
notas do cliente
|
customerNotes | string | |
|
internalNotas
|
internalNotes | string | |
|
Presente
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
Método de pagamento
|
paymentMethod | string | |
|
solicitadoServiço de Envio
|
requestedShippingService | string | |
|
CarrierCode
|
carrierCode | string | |
|
ServiceCode
|
serviceCode | string | |
|
Código do pacote
|
packageCode | string | |
|
confirmação
|
confirmation | string | |
|
data de envio
|
shipDate | string | |
|
holdTillilDate
|
holdUntilDate | string | |
|
Peso
|
weight | Weight | |
|
Dimensões
|
dimensions | Dimensions | |
|
InsuranceOptions
|
insuranceOptions | InsuranceOptions | |
|
InternacionalOptions
|
internationalOptions | InternationalOptions | |
|
Opções Avançadas
|
advancedOptions | AdvancedOptions | |
|
tagIds
|
tagIds | string | |
|
ID de Utilizador
|
userId | string | |
|
externamenteRealizado
|
externallyFulfilled | boolean | |
|
externamenteFulfilledBy
|
externallyFulfilledBy | string |