ShipStation (versão prévia)
ShipStation é o principal software de envio baseado na Web que ajuda os varejistas online a simplificar seu cumprimento de pedidos, onde quer que eles vendam e no entanto eles enviam.
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.shipstation.com/ |
| Política de privacidade | https://www.shipstation.com/privacy-policy/ |
| Categorias | Produtividade |
Esse conector foi desenvolvido especificamente para ser usado para a integração do provedor ShipStation do Dynamics 365 Intelligent Order Management.
Pré-requisitos
Uma conta de desenvolvedor do ShipStation é necessária. Se você não tiver um, poderá criá-lo em https://www.shipstation.com/docs/api/requirements/. Observação: é recomendável usar esse conector especificamente para configurar o provedor ShipStation do Gerenciamento de Pedidos Inteligentes do Dynamics 365.
Como obter credenciais
O ShipStation requer uma chave de API e um segredo para autenticação. Você pode gerar um token https://ship13.shipstation.com/settings/api e usá-lo para configurar o conector.
Introdução ao conector
Configure a conexão com a Chave e o Segredo da API. Para saber mais sobre a API do ShipStation, leia a documentação pública: https://www.shipstation.com/docs/api/
Problemas e limitações conhecidos
Esse conector foi desenvolvido especificamente para ser usado para a integração do provedor ShipStation 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 |
|---|---|---|---|
| nome de usuário | secureString | O nome de usuário para esta api | Verdade |
| senha | secureString | A senha dessa api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Criar ou atualizar ordem |
Se o orderKey for especificado, o método se tornará idempotente e a ordem existente com essa chave será atualizada. Observação: somente os pedidos em um status aberto no ShipStation (awaiting_payment,awaiting_shipment e on_hold) podem ser atualizados por meio desse método. cancelados e enviados são bloqueados da modificação por meio da API. |
| Criar rótulo para ordem |
Cria uma etiqueta de remessa para um determinado pedido. O campo labelData retornado na resposta é um valor PDF codificado em base64. Basta decodificar e salvar a saída como um arquivo PDF para recuperar um rótulo imprimível. |
| Obter ordem |
Recupera uma única ordem do banco de dados. |
Criar ou atualizar ordem
Se o orderKey for especificado, o método se tornará idempotente e a ordem existente com essa chave será atualizada. Observação: somente os pedidos em um status aberto no ShipStation (awaiting_payment,awaiting_shipment e on_hold) podem ser atualizados por meio desse método. cancelados e enviados são bloqueados da modificação por meio da API.
Retornos
Criar rótulo para ordem
Cria uma etiqueta de remessa para um determinado pedido. O campo labelData retornado na resposta é um valor PDF codificado em base64. Basta decodificar e salvar a saída como um arquivo PDF para recuperar um rótulo imprimível.
Retornos
Obter ordem
Recupera uma única ordem do banco de dados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Obter ordem
|
orderId | True | double |
O identificador gerado pelo sistema para a ordem. |
Retornos
- Corpo
- GetOrderResponse
Gatilhos
| Assinar o Webhook |
Assina um tipo específico de webhook. Se um store_id for passado, os webhooks serão disparados apenas para esse store_id específico. O tipo de evento passado 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. |
Assinar o Webhook
Assina um tipo específico de webhook. Se um store_id for passado, os webhooks serão disparados apenas para esse store_id específico. O tipo de evento passado 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
friendly_name
|
friendly_name | True | string | |
|
store_id
|
store_id | string | ||
|
evento
|
event | True | string |
Definições
GetOrderResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do pedido
|
orderId | integer | |
|
número do pedido
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
orderDate
|
orderDate | string | |
|
data de criação
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
paymentDate
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
customerId
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
clienteE-mail
|
customerEmail | string | |
|
BillTo
|
billTo | BillTo | |
|
Shipto
|
shipTo | ShipTo | |
|
itens
|
items | array of Item | |
|
Ordertotal
|
orderTotal | double | |
|
amountPaid
|
amountPaid | double | |
|
taxAmount
|
taxAmount | float | |
|
shippingAmount
|
shippingAmount | float | |
|
customerNotes
|
customerNotes | string | |
|
internalNotes
|
internalNotes | string | |
|
presente
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
paymentMethod
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
confirmação
|
confirmation | string | |
|
data de envio
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
Peso
|
weight | Weight | |
|
Dimensões
|
dimensions | Dimensions | |
|
InsuranceOptions
|
insuranceOptions | InsuranceOptions | |
|
InternationalOptions
|
internationalOptions | InternationalOptions | |
|
Advancedoptions
|
advancedOptions | AdvancedOptions | |
|
tagIds
|
tagIds | string | |
|
userId
|
userId | string | |
|
externallyFulfilled
|
externallyFulfilled | boolean | |
|
externallyFulfilledBy
|
externallyFulfilledBy | string |
BillTo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string | |
|
empresa
|
company | string | |
|
street1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
cidade
|
city | string | |
|
estado
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
residencial
|
residential | string | |
|
addressVerified
|
addressVerified | string |
Shipto
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string | |
|
empresa
|
company | string | |
|
street1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
cidade
|
city | string | |
|
estado
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
residencial
|
residential | boolean | |
|
addressVerified
|
addressVerified | string |
Opção
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string | |
|
value
|
value | string |
Dimensões
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Unidades
|
units | string | |
|
length
|
length | float | |
|
largura
|
width | float | |
|
height
|
height | float |
InsuranceOptions
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
fornecedor
|
provider | string | |
|
insureShipment
|
insureShipment | boolean | |
|
insuredValue
|
insuredValue | float |
InternationalOptions
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
contents
|
contents | string | |
|
customsItems
|
customsItems | array of CustomsItem | |
|
nonDelivery
|
nonDelivery | string |
CustomsItem
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
customsItemId
|
customsItemId | integer | |
|
descrição
|
description | string | |
|
quantidade
|
quantity | float | |
|
value
|
value | float | |
|
harmonizedTariffCode
|
harmonizedTariffCode | string | |
|
countryOfOrigin
|
countryOfOrigin | string |
Advancedoptions
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
warehouseId
|
warehouseId | integer | |
|
nonMachinable
|
nonMachinable | boolean | |
|
saturdayDelivery
|
saturdayDelivery | boolean | |
|
containsAlcohol
|
containsAlcohol | boolean | |
|
mergedOrSplit
|
mergedOrSplit | boolean | |
|
mergedIds
|
mergedIds | array of string | |
|
ID do pai
|
parentId | string | |
|
storeId
|
storeId | integer | |
|
customField1
|
customField1 | string | |
|
customField2
|
customField2 | string | |
|
customField3
|
customField3 | string | |
|
fonte
|
source | string | |
|
billToParty
|
billToParty | string | |
|
billToAccount
|
billToAccount | string | |
|
billToPostalCode
|
billToPostalCode | string | |
|
billToCountryCode
|
billToCountryCode | string |
Item
| Nome | 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 | |
|
taxAmount
|
taxAmount | double | |
|
shippingAmount
|
shippingAmount | double | |
|
warehouseLocation
|
warehouseLocation | string | |
|
Opções
|
options | array of Option | |
|
ID do produto
|
productId | integer | |
|
fulfillmentSku
|
fulfillmentSku | string | |
|
ajuste
|
adjustment | boolean | |
|
Upc
|
upc | string |
Peso
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | float | |
|
Unidades
|
units | string |
CreateLabelforOrderResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
shipmentId
|
shipmentId | integer | |
|
shipmentCost
|
shipmentCost | double | |
|
insuranceCost
|
insuranceCost | float | |
|
número de rastreamento
|
trackingNumber | string | |
|
labelData
|
labelData | string | |
|
formData
|
formData | string |
CreateUpdateOrderResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do pedido
|
orderId | integer | |
|
número do pedido
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
orderDate
|
orderDate | string | |
|
data de criação
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
paymentDate
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
customerId
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
clienteE-mail
|
customerEmail | string | |
|
BillTo
|
billTo | BillTo | |
|
Shipto
|
shipTo | ShipTo | |
|
itens
|
items | array of Item | |
|
Ordertotal
|
orderTotal | double | |
|
amountPaid
|
amountPaid | double | |
|
taxAmount
|
taxAmount | float | |
|
shippingAmount
|
shippingAmount | float | |
|
customerNotes
|
customerNotes | string | |
|
internalNotes
|
internalNotes | string | |
|
presente
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
paymentMethod
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
confirmação
|
confirmation | string | |
|
data de envio
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
Peso
|
weight | Weight | |
|
Dimensões
|
dimensions | Dimensions | |
|
InsuranceOptions
|
insuranceOptions | InsuranceOptions | |
|
InternationalOptions
|
internationalOptions | InternationalOptions | |
|
Advancedoptions
|
advancedOptions | AdvancedOptions | |
|
tagIds
|
tagIds | string | |
|
userId
|
userId | string | |
|
externallyFulfilled
|
externallyFulfilled | boolean | |
|
externallyFulfilledBy
|
externallyFulfilledBy | string |