Manual de Referência do Serviço PlaceOrder

Transcrição

Serviços da rede de distribuição digital (DDWS)
Fazer pedido - Manual de Serviço
ÍNDICE
Histórico de revisão ............................................................................................................................................... 4
1
Introdução ...................................................................................................................................................... 5
1.1
Visão geral ............................................................................................................................................. 5
1.2
Documentos de suporte ........................................................................................................................ 5
2
Introdução ...................................................................................................................................................... 5
3
Visão geral do serviço PlaceOrder ................................................................................................................. 6
4
5
3.1
Desktop Subscription ............................................................................................................................. 7
3.2
Atendimento do pedido .......................................................................................................................... 7
3.3
Revogação de pedido ............................................................................................................................ 7
3.4
Status do pedido .................................................................................................................................... 7
Informações de referência do serviço PlaceOrder ......................................................................................... 7
4.1
Atendimento do pedido .......................................................................................................................... 7
4.2
Esquema de solicitação - Criar pedido inicial ........................................................................................ 8
4.3
Esquema de solicitação – Adicionar posições .................................................................................... 12
4.4
Esquema de solicitação - Adicionar produtos ..................................................................................... 14
4.5
Esquema de solicitação - Renovar ...................................................................................................... 17
4.6
Renovar o envio de pedido de compra automaticamente ................................................................... 18
4.7
Esquema de solicitação - Renovar o envio de pedido de compra automaticamente ......................... 18
4.8
Obtenção de status do pedido............................................................................................................. 19
4.9
Esquema de solicitação - Obter status do pedido [apenas para um pedido inicial recorrente] .......... 19
4.10
Revogação de pedido .......................................................................................................................... 19
4.11
Esquema de solicitação - Remover licença, Remover produto, Cancelamento de pedido [somente
Recorrente] .......................................................................................................................................... 19
4.12
Esquema de solicitação - Devoluções de pedido [somente Recorrente] ............................................ 20
4.13
Esquema de resposta - Criar pedido inicial ......................................................................................... 20
4.14
Esquema de resposta - Renovar o envio de pedido de compra automaticamente ............................ 20
4.15
Esquema de responsta - Obtenção de status do pedido .................................................................... 20
4.16
Esquema de resposta - Remover licença, Remover produto, Cancelamento de pedido [somente
Recorrente] .......................................................................................................................................... 20
4.17
Esquema de resposta - Devoluções de pedido [somente Recorrente] ............................................... 21
Amostra de mensagens ............................................................................................................................... 21
5.1
5.1.1
5.2
Mensagem de solicitação - Atendimento de pedidos, Pedido inicial, Modelo recorrente do
Subscription ......................................................................................................................................... 21
Mensagem de resposta - Atendimento de pedidos , Pedido inicial ................................................ 23
Mensagem de solicitação - Atendimento de pedidos, Pedido inicial, Modelo renovável do
Subscription ......................................................................................................................................... 24
2 | Manual de referência do serviço da Web
5.2.1
5.3
Mensagem de resposta - Atendimento de pedidos, Pedido inicial ................................................. 25
Mensagem de solicitação – Atendimento de pedidos, Adicionar posições, Modelo de assinatura
recorrente ............................................................................................................................................ 26
5.3.1 Mensagem de resposta – Atendimento de pedidos, Adicionar posições, Modelo de assinatura
recorrente ..................................................................................................................................................... 26
5.4
Mensagem de solicitação – Atendimento de pedidos, Adicionar posições, Modelo de assinatura
renovável ............................................................................................................................................. 27
5.4.1 Mensagem de resposta – Atendimento de pedidos, Adicionar posições, Modelo de assinatura
renovável ...................................................................................................................................................... 27
5.5
Mensagem de solicitação – Atendimento de pedidos, Adicionar produtos, Modelo de assinatura
recorrente ............................................................................................................................................ 28
5.5.1 Mensagem de resposta – Atendimento de pedidos, Adicionar produtos, Modelo de assinatura
recorrente ..................................................................................................................................................... 28
5.6
Mensagem de solicitação – Atendimento de pedidos, Adicionar produtos, Modelo de assinatura
renovável ............................................................................................................................................. 29
5.6.1 Mensagem de resposta – Atendimento de pedidos, Adicionar produtos, Modelo de assinatura
renovável ...................................................................................................................................................... 29
5.7
Mensagem de solicitação - Atendimento de pedidos, Renovação, Modelo de assinatura renovável
somente ............................................................................................................................................... 30
5.7.1 Mensagem de resposta - Atendimento de pedidos, Renovação, Modelo de assinatura renovável
somente ........................................................................................................................................................ 31
5.8
Mensagem de solicitação - Renovar o envio de pedido de compra automaticamente....................... 31
5.8.1
5.9
Mensagem de resposta - Renovar o envio de pedido de compra automaticamente ...................... 31
Mensagem de solicitação - Obter status do pedido (apenas para um pedido inicial recorrente) ....... 31
5.9.1
5.10
Mensagem de resposta - Obter status do pedido (apenas para um pedido inicial recorrente) ...... 31
Mensagem de solicitação - Revogação de pedido (Remover instalação, Remover produto,
Cancelamento de pedido) ................................................................................................................... 32
5.10.1
Mensagem de resposta - Revogação de pedido (Remover licença, Remover produto,
Cancelamento de pedido) ............................................................................................................................ 32
5.11
Mensagem de solicitação - Revogação de pedido (devoluções de pedido) ....................................... 32
5.11.1
Mensagem de resposta - Revogação de pedido (devoluções de pedido) .................................. 32
6
Normas de formatação ................................................................................................................................. 32
7
Mensagens de erro ...................................................................................................................................... 33
7.1
Códigos de erro ................................................................................................................................... 33
7.2
Mensagem de erro .............................................................................................................................. 33
Histórico de revisão
Versão
2.8
Data
21/10/2015
Autor
AR
2.9
22/10/2015
AR
3.0
10/28/2015
AR
3.1
11/03/2015
AR
3.2
11/05/2015
AR
Comentários
Seções adicionadas 4.2, 4.7, 5.2 e 5.2.1 - para incluir o
serviço de Cobrança recorrente
O serviço anteriormente chamado de Cobrança recorrente
foi atualizado para Renovar automaticamente envios de
pedido de compra e Solicitar URL
Os valores action_name do Atendimento de pedidos foram
modificados de “add_seat” e “add_product” para
“add_seats” e “add_products”
 A Mensagem de solicitação de amostra do Atendimento
de pedidos e do Pedido inicial na seção 5.1 foi
modificada para exibir uma carga útil de amostra para
modelos de modelos recorrentes do Subscription.
 A Mensagem de solicitação de amostra do Atendimento
de pedidos e do Pedido inicial na seção 5.2 foi
modificada para exibir uma carga útil de amostra para
modelos de modelos renováveis do Subscription.
 Foi modificada a criação de um esquema de solicitação
de pedido inicial na seção 4.1





3.3
11/05/2015



Foi adicionado um Esquema de solicitação add_seats
na seção 4.3
Foi adicionado um Esquema de solicitação
add_products na seção 4.4
Foi adicionado um Esquema de solicitação renew na
seção 4.5
Foi modificado um Esquema de solicitação initial_order
na seção 4.2
Foram adicionadas as seções 5.3, 5.4, 5.5, 5.6 e 5.7
para incluir Mensagens de amostra para ações de
atendimento de pedidos: add_seats, add_products e
renew.
Foram atualizados os dados de amostra das
Mensagens de amostra na Seção 5.
Foi atualizado o Esquema de solicitação "Renew" na
Seção 4.5 para mover "subscription_id".
Foi atualizado o Esquema de solicitação "initial_order"
na seção 4.2 para remover "external_ref_number".
1 Introdução
1.1
Visão geral
Os Serviços da Web de distribuição digital (DDWS) consistem em uma solução para realização de
pedidos diretamente pelos Parceiros para a Autodesk, com pouco toque dos Parceiros e nenhum toque
da Autodesk. O novo recurso de negócios é a capacidade de realizar transações verdadeiras do serviço
da Web B2B entre os nossos Parceiros e a Autodesk. O envio do pedido deve ser totalmente
automatizado do Parceiro para a Autodesk e de volta para o cliente final sem contato manual.
Para que o Parceiro tenha uma implementação efetiva do DDWS da Autodesk, as afiliadas precisarão ter
a familiaridade dos serviços da Web REST, do OAuth 2.0 e do JSON. Uma amostra de um aplicativo de
cliente na linguagem Ruby é fornecida no documento Guia de programação. Isso ajuda os
desenvolvedores das afiliadas a consumir a API do DDWS.
1.2
Documentos de suporte

Guia do desenvolvedor para parceiros da Autodesk: este guia ajuda os Parceiros no processo
de apresentação e no acesso aos serviços do DDWS. O guia também serve para apresentar aos
Parceiros a Plataforma de serviços digitais da Autodesk, usando instruções passo a passo que os
orientam nas atividades iniciais necessárias para integração.

Documentação da API de autenticação: este documento orientará os Parceiros pelo processo
de geração de credenciais, assinaturas e tokens de acesso necessários para usar as APIs do
serviço. Ele também contém informações para o desenvolvimento de um aplicativo de integração
de um Parceiro. Ele fornece a compreensão básica da integração do serviço da Web e demonstra
o desenvolvimento de um aplicativo típico.

Casos de uso do arquivo mestre do programa DDWS: esse documento fornece aos parceiros
uma grande quantidade de casos de uso para solicitações do PlaceOrder, detalhando quais
campos são obrigatórios e quais são opcionais para uma dada solicitação sob circunstâncias
específicas.
2 Introdução
Como parte do processo de integração, os Parceiros serão associados a um único Número específico do
cliente (CSN). O Parceiro terá seu respectivo aplicativo registrado com a Autodesk.
Para obter mais detalhes sobre o processo de integração, consulte o Guia do desenvolvedor para
parceiros da Autodesk.
3 Visão geral do serviço PlaceOrder
O serviço PlaceOrder expõe três recursos da API para o gerenciamento de pedidos: /orders/fulfillment,
/orders/revoke e orders/status. Esses recursos são compostos de operações que incluem a criação do
pedido, o cancelamento de pedido, as devoluções de pedido, as adições de instalações e produtos aos
contratos existentes, a verificação de um pedido inicial, bem como a remoção de instalações e produtos
dos contratos existentes.
Este documento incluirá os diversos cenários do serviço PlaceOrder que são elegíveis para a geração de
pedido ou modificações do contrato no ambiente da Autodesk. Os detalhes dos serviços incluídos no
atendimento de pedido e no processo de revogação de pedido podem ser encontrados abaixo.








Enviando novo pedidos
Verificando o status de pedidos iniciais
Adicionando licenças aos contratos existentes
Adicionando produtos aos contratos existentes
Removendo licenças de contratos existentes
Removendo produtos de contratos existentes
Devolvendo um contrato recorrente (indisponível no momento)
Cancelando um contrato recorrente
3.1
Desktop Subscription
Um Desktop Subscription (DTS) é uma abordagem de pagamento pré-pago para assinaturas da Autodesk,
com a opção de modos de assinatura mensal, trimestral ou anual convenientes para seleção por clientes.
Há dois modelos do Desktop Subscription: Recorrente e Renovável. Em um modelo Renovável do DTS,
um Parceiro tem a opção de fazer a renovação de um Subscription no final do período pelo qual o
Subscription esteve ativo. Em um modelo Recorrente do DTS, uma determinada assinatura do Parceiro é
permanente e é atualizada automaticamente, sendo cancelada somente quando um Parceiro o solicita.
3.2
Atendimento do pedido
O recurso da API de atendimento de pedido cuida da criação do pedido, adiciona licenças e adiciona
operações do produto. As operações de adição de licença e de produto são somente para os contratos
existentes.
3.3
Revogação de pedido
O recurso da API de revogação de pedido cuida da operação de devolução de pedido para pedidos
recorrentes, bem como as operações de remoção de licença, remoção de produto e cancelamento. As
devoluções só são válidas no período de carência acordado. Se o retorno for válido, o contrato será
cancelado e o valor reembolsado. Para a operação de cancelamento, o comportamento de renovação
automática é encerrado. O contrato ainda é válido para o resto do prazo. As operações de remoção de
licença e de produto são somente para os contratos existentes.
3.4
Status do pedido
O recurso da API para Obter status do pedido retorna o status atual de um pedido em particular de
acordo com um dado número da ordem de compra. O serviço Obter status do pedido só pode recuperar
informações sobre o status de um Pedido inicial para um Subscription recorrente até esse ponto do
desenvolvimento. Para obter o status do pedido de compra desejado, você deverá fornecer o mesmo
parceiro CSN usado para criar o pedido.
4 Informações de referência do serviço PlaceOrder
Nota: a seção a seguir contém o Esquema de solicitação e resposta para o serviço PlaceOrder. A
pergunta de quais campos são obrigatórios ou opcionais em cada um dos esquemas a seguir é determinada
pelo uso de um Parceiro de um dos dois modelos do Desktop Subscription, Renovável ou Recorrente. Neste
ponto, os Parceiros podem não enviar pedidos em uma combinação de modelos de assinatura Recorrente e
Renovável. Isso gerará um erro. Para obter informações mais detalhadas sobre o esquema de PlaceOrder,
consulte o seguinte documento: "DDWS Program Master File USE CASES.xlsx"
4.1
Atendimento do pedido
Com base no campo action_name, diferentes operações serão executadas. Por exemplo, um
action_name de "initial_order" especificará a opção para criar a opção de compra e "add_seats"
especificará a opção para adicionar instalações. Este campo é especificado no corpo da solicitação.
Abaixo está o esquema de solicitação para os casos nos quais o tipo de solicitação é para criação de
licenças ou para adição de licenças ou produtos. O esquema de resposta associado também está
incluído.
Os valores de action_name esperados são os seguintes: initial_order, add_seats, add_products.
4.2
Esquema de solicitação - Criar pedido inicial
Os detalhes dos campos esperados no corpo da solicitação estão localizados na tabela a seguir para
Criação de pedido. Vamos exigir campos relacionados às informações de usuário final, de cliente e de
produto. As linhas realçadas são elementos cujo valor é um objeto JSON ou uma Matriz que contém
as informações nas linhas recuadas abaixo. Consulte a seção de mensagens de solicitação de
amostra para consultar o agrupamento correto de campos.
Se uma conta existir e o CSN correspondente for fornecido, os detalhes do cliente poderão ser
recuperados dos sistemas da Autodesk. Se o CSN não for fornecido, os parceiros precisarão fornecer
as informações, como nome, endereço e localização, para criar uma nova conta.
Uma nota sobre a conclusão de pedido: quando os sistemas da Autodesk recebem um Pedido
inicial de parceiro, as validações básicas para itens, como SKU, Contrato e Preço são
concluídas antecipadamente na camada do Serviço da API PlaceOrder. Após isso, uma
resposta é gerada e enviada para o Parceiro sobre o sucesso ou a falha da solicitação, com um
Número de referência (uma concatenação da Ordem de compra [OC] + CSN) enviada quando a
solicitação é bem-sucedida, e uma mensagem de erro de "Falha na validação" caso a
solicitação falhe. Utilizar o Número de referência como entrada para a API GetOrderStatus
permitirá que o Parceiro exiba o status da OC. Por fim, os sistemas da Autodesk atualizarão o
status da OC "Recebido" para "Concluído" depois que o Pedido em questão é criado no SAP,
com os sistemas da Autodesk enviando o SNS nesse momento.
Descrição do Definição do
campo
esquema
action_name
Obriga
tório/
Opcio
nal
(O/O)
Comentários
Renovação/
Recorrente
initial_order,
add_seats,
add_products,
renew
Ambos
Exemplo
"initial_order"
Sequência de
caracteres
R
Matriz do
Objeto JSON
O
ref_document
Cara
ctere
s
Ambos
doc_type
DDWSDocument
LineNumber
Sequência de
caracteres
40
R
obrigatório caso
ref_document seja
fornecido
Ambos
doc_number
SubscriptionID
Sequência de
caracteres
15
R
obrigatório caso
ref_document seja
fornecido
Ambos
Sequência de
caracteres
3
O
Norma ISO
Necessário
para
renovação
currency_code
Pedido
Máx.
Tipo de
campo
po_date
25/12/2009
Formato de
10
data ISO 8601
O
Ambos
order_date
25/12/2009
Formato de
10
data ISO 8601
O
Ambos
Data do
contrato
SoldToParty
ShipToP
arty
ShipToParty.Address
ORD1234
Sequência de
caracteres
35
R
Ambos
contract_start_date
25/12/2009
Formato de
data ISO 8601
10
O
Ambos
contract_end_date
25/12/2009
Formato de
data ISO 8601
10
O
Ambos
sold_to_account_csn “6228559800”
Sequência de
caracteres
15
O
ship_to_party_accou
nt_csn
“6228559800”
Sequência de
caracteres
15
O
ship_to_party_accou
nt_name
"Partner Inc"
Sequência de
caracteres
35
O
ship_to_party_addre
ss_line1
"1 Parkway Road"
Sequência de
caracteres
35
ship_to_party_addre
ss_line2
"1 Parkway Road"
Sequência de
caracteres
35
ship_to_party_addre
ss_city
"CA"
Sequência de
caracteres
35
ship_to_party_addre
ss_postal_code
“94604”
Sequência de
caracteres
9
ship_to_party_addre
ss_country_code
"US"
Sequência de
caracteres
3
ship_to_party_addre
ss_county
"MARINE"
Sequência de
caracteres
35
ship_to_party_addre
ss_state_code
"CA"
Sequência de
caracteres
3
primary_account_csn
“6228559800”
Sequência de
caracteres
15
O
"1 Parkway Road"
Sequência de
caracteres
35
O
EndU
serPri
mary
Acco
unt.A
ddres
s
EndUse
rPrimar
yAccou
nt
po_number
primary_account_ad
dress_line_1
Parceiro vendido
para CSN.
Opcional; caso
não seja
Ambos
fornecido,
receberá o valor
do cabeçalho de
autorização
Fornecer caso
seja conhecido,
caso contrário,
Ambos
utilizar os detalhes
abaixo
Obrigatório caso o
CSN não seja
fornecido
Obrigatório caso o
csn não seja
fornecido
Obrigatório caso o
csn não seja
fornecido
Obrigatório caso o
csn não seja
fornecido
Obrigatório caso o
csn não seja
fornecido
Obrigatório caso o
csn não seja
fornecido
Obrigatório caso o
csn não seja
fornecido
Obrigatório caso o
csn não seja
fornecido
Fornecer caso
seja conhecido,
caso contrário,
abaixo
Obrigatório caso
primary_account_c
sn não seja
fornecido
Renovação
Renovação
Renovação
Renovação
Renovação
Renovação
Renovação
Renovação
Ambos
Ambos
Reseller
Party
EndUser
Contract
Manager
Account
EndUserContractManagerAccount
Obrigatório caso
primary_account_c
sn não seja
fornecido
Obrigatório caso
primary_account_c
sn não seja
fornecido
Obrigatório caso
primary_account_c
sn não seja
fornecido
Obrigatório caso
primary_account_c
sn não seja
fornecido
Obrigatório caso
primary_account_c
sn não seja
fornecido
primary_account_ad
dress_line_2
Sequência de
"1 Parkway Road"
caracteres
35
O
primary_account_ad
dress_city
"CA"
Sequência de
caracteres
35
O
primary_account_ad
dress_postal_code
“94604”
Sequência de
caracteres
35
O
primary_account_ad
dress_country_code
"US"
Sequência de
caracteres
35
O
primary_account_ad
dress_state
"CA"
Sequência de
caracteres
35
O
Sequência de
caracteres
15
R
Parceiro do DL
O
Fornecer caso
seja conhecido,
caso contrário,
Ambos
abaixo
O
Obrigatório caso
eu_primary_accou
nt_csn não seja
fornecido
Ambos
O
Obrigatório caso
eu_primary_accou
nt_csn não seja
fornecido
Ambos
O
Obrigatório caso
eu_primary_accou
nt_csn não seja
fornecido
Ambos
O
Obrigatório caso
eu_primary_accou
nt_csn não seja
fornecido
Ambos
Ambos
Ambos
reseller_account_csn “6228559800”
eu_primary_account
_csn
“6228559800”
Sequência de
caracteres
eu_primary_account
_name
"Partner Inc1"
Sequência de
caracteres
eu_primary_account
_address_line1
Sequência de
"1 Parkway Road"
caracteres
eu_primary_account
_address_line2
Sequência de
"1 Parkway Road"
caracteres
eu_primary_account
_address_city
Sequência de
caracteres
"CA"
15
35
35
35
35
eu_primary_account
_address_postal_cod “94604”
e
Sequência de
caracteres
35
O
Obrigatório caso
eu_primary_accou
nt_csn não seja
fornecido
eu_primary_account
Sequência de
35
O
Valor ISO
"US"
Ambos
Ambos
Ambos
Ambos
Ambos
Ambos
_address_country_co
de
caracteres
eu_primary_account
_address_state
"CA"
Sequência de
caracteres
35
O
Obrigatório caso
eu_primary_accou
nt_csn não seja
fornecido
“6228559800”
Sequência de
caracteres
15
O
Forneça o CSN ou
preencha o resto
Ambos
das informações
R
Ambos
35
R
Ambos
35
R
Ambos
50
R
2
R
2
R
contact_csn
ListOfLineItem.LineItem.E
ndUserContact.ListOfRel
atedAccount.RelatedAcco
unt
ListOfLineItem.LineItem
EndUserContact
end_user
first_name
"John"
last_name
"Smith"
email
joh.smith@sttest.
com
language
"EN"
country
"US"
Obrigatório caso
eu_primary_accou
nt_csn não seja
fornecido
Matriz do
Objeto JSON
Sequência de
caracteres
Sequência de
caracteres
Sequência de
caracteres
Sequência de
caracteres
Sequência de
caracteres
Standard:email
Código de idioma
de 2 dígitos
Código do país
com 2 dígitos
Ambos
Ambos
Ambos
Ambos
line_items
Matriz do
Objeto JSON
subscription_id
Sequência de
caracteres
40
R
Formato da versão
Recorrente
4 do UUID.
Sequência de
caracteres
35
R
SKUNumber ->
part_number
13
R
Ambos
20
R
Ambos
part_number
001G1-WW7929T210
quantity
"1"
net_amount
"39.33"
Sequência de
caracteres
Sequência de
caracteres
R
related_account_csn
“6228559800”
Sequência de
caracteres
35
O
related_account_na
me
"Partner Inc"
Sequência de
caracteres
35
O
related_account_add
ress_line1
"1 Parkway Road"
Sequência de
caracteres
35
O
Ambos
Ambos
Fornecer caso
seja conhecido,
caso contrário,
Ambos
abaixo
Obrigatório caso
related_account_c
Ambos
sn não seja
fornecido
Obrigatório caso
related_account_c
Ambos
sn não seja
fornecido
ListOfLineItem.LineItem.EndUser
Contact
4.3
Obrigatório caso
related_account_c
sn não seja
fornecido
Obrigatório caso
related_account_c
sn não seja
fornecido
Obrigatório caso
related_account_c
sn não seja
fornecido
Obrigatório caso
related_account_c
sn não seja
fornecido
Obrigatório caso
related_account_c
sn não seja
fornecido
related_account_add
ress_line2
Sequência de
"1 Parkway Road"
caracteres
35
O
related_account_add
ress_city
"CA"
Sequência de
caracteres
35
O
related_account_add
ress_postal_code
“94604”
Sequência de
caracteres
35
O
related_account_add
ress_country_code
"US"
Sequência de
caracteres
35
O
related_account_add
ress_state
"CA"
Sequência de
caracteres
35
O
eu_contact_csn
“6228559800”
Sequência de
caracteres
15
O
eu_first_name
"Peter"
Sequência de
caracteres
40
O
Obrigatório caso
eu_contact_csn
não seja fornecido
Ambos
eu_last_name
"longslide"
Sequência de
caracteres
40
O
Obrigatório caso
eu_contact_csn
não seja fornecido
Ambos
eu_email
Peter.longslide@
sttest.com
Sequência de
caracteres
50
O
Standard: email
Ambos
eu_language
"EN"
Sequência de
caracteres
2
R
Ambos
eu_country
"US"
Sequência de
caracteres
2
R
Ambos
Ambos
Ambos
Ambos
Ambos
Ambos
Ambos
Esquema de solicitação – Adicionar posições
Descrição do Definição do
campo
esquema
Exemplo
Máx.
de
carac
teres
Tipo de
campo
Sequência de
caracteres
Sequência de
caracteres
Obriga
tório/
Opcio
nal
(O/O)
Renovaçã
Comentário
o/Recorren
s
te
R
"add_seats"
action_name
"add_seats"
Ambos
contract_number
"40010000321"
12
R
Ambos
po_number
"879653151939475545 Sequência de
35
"
caracteres
R
Ambos
currency_code
"USD"
Sequência de
3
caracteres
R
net_amount
"105.32"
Sequência de
20
caracteres
R
Matriz de
objetos JSON
R
Ambos
line_items
Ambos
Ambos
order_date
"2015-10-08"
Data
10
R
Renovação
po_date
"2015-10-08"
Data
10
O
Renovação
reseller_account_c
"1160118032"
sn
Sequência de
15
caracteres
R
Renovação
ship_to_party_acc
ount_csn
"1160118032"
Sequência de
15
caracteres
R
Renovação
sold_to_account_c
“1160118032”
sn
Sequência de
15
caracteres
R
Renovação
Sequência de
caracteres
formatada
UUID versão 4
subscription_id
"914fadc9-2b67-476eb480-e0e232e98745"
Sequência de
40
caracteres
R
serial_numbers
["364-81702573"]
Matriz de
sequências
de caracteres
R
Renovação
part_number
"321K2-005205-T979"
Sequência de
35
caracteres
R
Ambos
quantity
"7"
Sequência de
13
caracteres
R
Ambos
item_end_date
"2015-10-08"
Data
10
R
Renovação
item_start_date
"2015-10-08"
Data
10
R
Renovação
eu_csn
eu_email
line_items
Obrigatório
somente para
pedidos de
renovação.
Código de
modelo ISO
de 3 letras
Soma de
todos os
line_items
eu_first_name
"3265594"
Sequência de
15
caracteres
"[email protected]"
Sequência de
50
caracteres
"John"
Sequência de
40
caracteres
Recorrente
O
Obrigatório a
menos que
informações
de contato
sejam
fornecidas
Renovação
O
Obrigatório a
menos que
eu_csn seja
fornecido
Renovação
O
Obrigatório a
menos que
eu_csn seja
fornecido
Renovação
4.4
Descrição
do campo
eu_last_name
"Smith"
Sequência de
40
caracteres
pricing_date
"2015-10-08"
Data
10
R
net_amount
"105.32"
Sequência de
20
caracteres
R
O
Obrigatório a
menos que
eu_csn seja
fornecido
Renovação
Renovação
Valor líquido
por line_item
Ambos
Esquema de solicitação - Adicionar produtos
Definição do
esquema
action_name
contract_number
po_number
currency_code
net_amount
Exemplo
Máx.
de
carac
teres
Sequên
cia de
"add_products"
caracte
res
Sequên
cia de
"60010000321"
12
caracte
res
Sequên
"879642151939475545 cia de
35
"
caracte
res
"USD"
"105.32"
line_items
order_date
Tipo
de
camp
o
"2015-10-08"
Sequên
cia de
3
caracte
res
Sequên
cia de
20
caracte
res
Matriz
de
objetos
JSON
Data
10
Obrigatóri
o/
Opcional
(O)
Renovaçã
Comentário
o/Recorre
s
nte
R
"add_products
Ambos
"
R
Ambos
R
Ambos
R
Obrigatório
somente para
pedidos de
renovação.
Código de
modelo ISO
de 3 letras
Ambos
R
Soma de
todos os
line_items
Ambos
R
Ambos
R
Renovação
Padroniza de
acordo com a
data do
sistema
po_date
"2015-10-08"
Data
10
O
pricing_date
"2015-10-8"
Data
10
R
Renovação
“1160118032”
Sequên
cia de
15
caracte
res
R
Renovação
reseller_account_csn
Renovação
ship_to_party_account_csn “1160118032”
sold_to_account_csn
subscription_id
“1160118032”
"914fadc9-2b67-476eb480-e0e232e98745"
Sequên
cia de
40
caracte
res
Matriz
de
sequên
cias de
caracte
res
Sequên
cia de
35
caracte
res
Sequên
cia de
13
caracte
res
serial_numbers
["364-81702573"]
part_number
"321K2-004105-T868"
quantity
"7"
item_end_date
"2015-10-08"
Data
item_start_date
"2015-10-08"
Data
eu_csn
"5285581"
Sequên
cia de
caracte
res
eu_email
"[email protected]"
eu_first_name
"John"
eu_last_name
"Smith"
end_user
contact_csn
line_items
Sequên
cia de
15
caracte
res
Sequên
cia de
15
caracte
res
first_name
"90178032"
"John"
R
Renovação
R
Renovação
R
Sequência de
caracteres
formatada
UUID versão
4
Recorrente
R
Matriz pode
conter vários
números de
série
Renovação
R
Ambos
R
Ambos
10
R
Renovação
10
R
Renovação
15
Sequên
cia de
50
caracte
res
Sequên
cia de
40
caracte
res
Sequên
cia de
40
caracte
res
Objeto
JSON
15
Sequên
cia de
35
caracte
res
O
O
O
O
Obrigatório a
menos que
informações
de contato
sejam
fornecidas
Obrigatório a
menos que
eu_csn seja
fornecido
Obrigatório a
menos que
eu_csn seja
fornecido
Obrigatório a
menos que
eu_csn seja
fornecido
O
Renovação
Renovação
Renovação
Renovação
Recorrente
O
Opcional
Recorrente
O
Obrigatório
caso
contact_csn
não seja
fornecido
Recorrente
Obrigatório
caso
contact_csn
não seja
fornecido
Obrigatório
caso
contact_csn
não seja
fornecido
"Smith"
Sequên
cia de
35
caracte
res
O
[email protected]
Sequên
cia de
50
caracte
res
O
"90156444"
Sequên
cia de
caracte
res
O
"Arthur Doe"
Sequên
cia de
caracte
res
35
O
primary_end_user_accou
nt_address_line1
Sequên
cia de
caracte
res
35
O
nt_address_city
Sequên
cia de
caracte
res
35
O
nt_address_state
Sequên
cia de
caracte
res
3
O
nt_address_country_code
Sequên
cia de
3
caracte
res
O
nt_address_postal_code
Sequên
cia de
caracte
res
9
O
Data
10
R
Renovação
R
Renovação
last_name
email
nt_csn
nt_name
pricing_date
"2015-10-08"
related_account_csn
"80265031"
net_amount
"105.32"
15
Sequên
cia de
35
caracte
res
Sequên
cia de
20
caracte
res
R
Recorrente
Recorrente
Recorrente
Obrigatório
caso primary
end user csn
não seja
fornecido
Obrigatório
caso primary
end user csn
não seja
fornecido
Obrigatório
caso primary
end user csn
não seja
fornecido
Obrigatório
caso primary
end user csn
não seja
fornecido
Obrigatório
caso primary
end user csn
não seja
fornecido
Obrigatório
caso primary
end user csn
não seja
fornecido
Valor líquido
por line_item
Recorrente
Recorrente
Recorrente
Recorrente
Recorrente
Recorrente
Ambos
4.5
Descrição
do campo
Esquema de solicitação - Renovar
Definição do
esquema
Exemplo
action_name
"renew"
contract_number
"50010000321"
contract_end_date
contract_start_date
"2015-10-08"
"2015-10-08"
po_number
"768653151939475545"
Obrigat
ório/
Opciona
l
(O)
Renovaçã
Comentário
o/Recorre
s
nte
R
"renew"
Sequência de
caracteres
Sequência de
caracteres
Data
Data
12
R
Renovação
10
10
R
R
Renovação
Renovação
Sequência de
caracteres
35
R
Renovação
currency_code
"USD"
Sequência de
caracteres
3
R
net_amount
"105.32"
Sequência de
caracteres
20
R
Matriz de
objetos JSON
line_items
line_items
Máx.
de
caract
eres
Tipo de
campo
Obrigatório
somente para
pedidos de
renovação.
Código de
modelo ISO
de 3 letras
Soma de
todos os
line_items
Renovação
Renovação
Renovação
R
Renovação
order_date
"2015-10-08"
Data
10
R
Renovação
po_date
"2015-10-08"
Data
10
O
Renovação
pricing_date
"2015-10-8"
Data
10
R
Renovação
reseller_account_csn
“1160118032”
Sequência de
caracteres
15
R
Renovação
ship_to_party_accou
“1160118032”
nt_csn
Sequência de
caracteres
15
R
Renovação
sold_to_account_csn
“1160118032”
Sequência de
caracteres
15
R
Renovação
ref_document
[{"doc_type":
"Opportunity","doc_nu
mber": "A-4757212"}]
Matriz de
objetos JSON
R
Renovação
doc_type
"Opportunity"
40
R
Renovação
doc_number
"A-5857212"
15
R
Renovação
serial_numbers
["364-81702573"]
R
Renovação
part_number
"123K2-004105-T979"
Sequência de
caracteres
35
R
Renovação
quantity
"7"
Sequência de
caracteres
13
R
Renovação
item_end_date
"2015-10-08"
Data
10
R
Renovação
Sequência de
caracteres
Sequência de
caracteres
Matriz de
sequências de
caracteres
item_start_date
4.6
"2015-10-08"
Data
10
R
Renovação
Obrigatório a
menos que
informações
de contato
sejam
fornecidas
Obrigatório a
menos que
eu_csn seja
fornecido
Obrigatório a
menos que
eu_csn seja
fornecido
Obrigatório a
menos que
eu_csn seja
fornecido
eu_csn
"5285592"
Sequência de
caracteres
15
O
eu_email
"[email protected]"
Sequência de
caracteres
50
O
eu_first_name
"John"
Sequência de
caracteres
40
O
eu_last_name
"Smith"
Sequência de
caracteres
40
O
pricing_date
"2015-10-08"
Data
10
R
Renovação
related_account_csn
"80276031"
Sequência de
caracteres
35
R
Renovação
net_amount
"105.32"
Sequência de
caracteres
20
R
Valor líquido
por line_item
Renovação
Renovação
Renovação
Renovação
Renovação
Renovar o envio de pedido de compra automaticamente
O recurso da API para Renovar o envio de pedido de compra automaticamente gerencia a atualização de um
número de pedido de compra de uma cobrança recorrente. O serviço de Renovar o envio de pedido de
compra automaticamente pode ser utilizado apenas por Parceiros que tenham se inscrito em um modelo
recorrente do Desktop Subscription. Essa inscrição será renovada automaticamente dentro do intervalo
selecionado (mensalmente, trimestralmente, anualmente) e o pedido que estiver em aberto no momento será
atualizado com um novo número de pedido de compra e, consequentemente, uma nova cobrança recorrente.
Para que as atualizações possam ser aplicadas, o pedido deverá ser incluído na cobrança recorrente
agendada no mínimo com 48 horas de antecedência.
4.7
Esquema de solicitação - Renovar o envio de pedido de compra
automaticamente
Nota: o seguinte esquema se aplica somente aos parceiros que usam um modelo recorrente do Desktop
Subscription.
Descriçã
o do
campo
Definição do
esquema
action_name
Exemplo
"po_update9"
Tipo de campo
Sequência de caracteres
Compriment
o
Comentários
9
Deverá ser
sempre
“po_number”
4.8
contract_number
712100003683
po_number
8123789134934389
30
Mín. 20
Máx. 40
caracteres
Obrigatório
Obrigatório
Obtenção de status do pedido
O micro serviço Obter status do pedido é uma solicitação de obtenção simplificada no seguinte formato:
https://enterprise-api-dev.autodesk.com/v1/orders/status/:po_number, o qual possui um único campo no
esquema de solicitação descrito abaixo. O esquema de resposta associado, um status de sucesso ou falha,
também está incluso.
4.9
Esquema de solicitação - Obter status do pedido [apenas para um pedido
inicial recorrente]
Descrição
do campo
Definição
do
esquema
Caminho da
URL
po_number
Tipo de
campo
Exemplo
…/order/status/8123789134934389
Sequência
de
caracteres
Compriment
o
Comentários
Mín. 20
Máx. 40
caracteres
Obrigatório.
Parte do
caminho da
URL
4.10 Revogação de pedido
Abaixo está o esquema de solicitação para os casos nos quais o tipo de solicitação é para remoção de
licença, remoção de produto, cancelamento de pedido ou devoluções de pedido. O esquema de resposta
associado também está incluído.
Os valores de action_name valores esperados são os seguintes: remove_seat, remove_product, cancellation,
return.
4.11 Esquema de solicitação - Remover licença, Remover produto, Cancelamento
de pedido [somente Recorrente]
Os detalhes dos campos esperados no corpo da solicitação para as modificações em um pedido
existente, como reduzir a quantidade de licenças para remover outro produto estão localizadas na
tabela a seguir. Nota: o esquema a seguir só se aplica aos Parceiros que usam um modelo
Recorrente do Desktop Subscription. Um esquema para o modelo Renovável do Desktop Subscription
não está disponível.
Descrição do
campo
Cabeçalho do
contrato
Nível do item
Definição do
esquema
Exemplo
action_name
"Remove_seat"
reason
"User_Request"
contract_number
712100003683
csn
5117338390
001G1-WW7929T210
sku
Tipo de
campo
Comprimento
Sequência de
caracteres
Sequência de
caracteres
Sequência de
caracteres
Sequência de
caracteres
Sequência de
caracteres
3
Comentários
Remover licença,
Remover produto,
Cancelamento.
3
30
Obrigatório
17
35
Não necessário
para
de linha
subscription_id
"70b3a72e-efd145d8-d77d-July-082015-10"
Sequência de
caracteres
quantity
3
Número inteiro
36
15
cancelamento
Não necessário
para
cancelamento
Não necessário
para
cancelamento
4.12 Esquema de solicitação - Devoluções de pedido [somente Recorrente]
Os detalhes dos campos esperados no corpo da solicitação para devoluções de pedidos estão
localizados na tabela a seguir. O campo action_name será sempre retornado.
[Indisponível no momento]
4.13 Esquema de resposta - Criar pedido inicial
Uma resposta simples da API que verifica se uma chamada passou por autenticação, autorização e
validações e se ela está sendo processada em nossos sistemas de back-end.
Definição do
esquema
Exemplo
Tipo de campo
status
message
reference_number
"OK"
"Seu pedido está sendo processado."
5117338390-14039095465950600-1443636789
4.14 Esquema de resposta - Renovar o envio de pedido de compra
automaticamente
Definição do
esquema
Exemplo
Tipo de campo
status
message
reference_number
"FALHOU"
"O número de contrato não existe"
5123406609-8397298406-1445466752
4.15 Esquema de responsta - Obtenção de status do pedido
Definição do
esquema
Exemplo
Tipo de campo
status
"Sucesso", “Falha”
4.16 Esquema de resposta - Remover licença, Remover produto, Cancelamento de
pedido [somente Recorrente]
Definição do
esquema
Exemplo
Tipo de campo
status
message
reference_number
"FALHOU"
"A SKU não está ativa"
5117338390-14039095465950600-1443636789
4.17 Esquema de resposta - Devoluções de pedido [somente Recorrente]
[Não está disponível no momento]
5 Amostra de mensagens
5.1
Mensagem de solicitação - Atendimento de pedidos, Pedido inicial, Modelo
recorrente do Subscription
https://enterprise-api-stg.autodesk.com/v1/orders/fulfillment
Message Headers
Authorization: Bearer <<Access Token>>
Content-Type: application/json
CSN: <<CSN>>
Body
{
"action_name": "initial_order",
"order": {
"request": {
"campaign_identifier": "NEW",
"order_type": "ZOLT",
"status": "New",
"ref_document": {
"doc_type": "DDWSDocumentLineNumber",
"doc_number": "SubscriptionID"
},
"currency_code": "US",
"order_date": "2015-10-26",
"po_date": "2015-10-26",
"po_number": "20990890262450959711",
"po_type": "ZDDS",
"request_type": "IO",
"contract_end_date": "2015-10-26",
"contract_start_date": "2015-10-26",
"end_user": {
"first_name": "Laisha",
"last_name": "Schaden",
"email": "[email protected]",
"language": "EN",
"country": "US",
"primary_account_name": "emmiedicki",
"primary_account_address_line1": "854 Courtney Highway",
"primary_account_address_city": "San Rafael",
"primary_account_address_state": "CA",
"primary_account_address_country_code": "US",
"primary_account_address_postal_code": "94903",
"related_account_name": "kaceykertzmann",
"related_account_address_line1": "771 June Stream",
"related_account_address_city": "San Rafael",
"related_account_address_state": "CA",
"related_account_address_country_code": "US",
"related_account_address_postal_code": "94903"
},
"reseller_account_csn": "0080136032",
"sold_to_account_csn": "0080136032",
"line_items": [
{
"item_number": "000010",
"subscription_id": "7e1624e0-f104-4b63-9806-a5eb0b68ba41",
"part_number": "964H1-NS9534-T754",
"quantity": "5",
"net_amount": "289.0",
"eu_first_name": "Prudence",
"eu_last_name": "Pfannerstill",
"eu_email": "[email protected]",
"eu_language": "EN",
"eu_country": "US",
"eu_primary_account_name": "ashamitchell",
"eu_primary_account_address_line1": "61591 Vivien Mission",
"eu_primary_account_address_city": "San Rafael",
"eu_primary_account_address_state": "CA",
"eu_primary_account_address_country_code": "US",
"eu_primary_account_address_postal_code": "94903"
}
]
}
}
}
5.1.1
Mensagem de resposta - Atendimento de pedidos , Pedido inicial
{
"status": "OK",
"message": "Your order is being processed",
"reference_number": "0081265012-INITIAL ORDER 9-27 arc20-1443549162"
}
5.2
Mensagem de solicitação - Atendimento de pedidos, Pedido inicial, Modelo
renovável do Subscription
Message Headers
CSN: <<CSN>>
Body
{
"action_name": "initial_order",
"order": {
"request": {
"currency_code": "USD",
"order_date": "2015-10-22",
"po_date": "2015-10-19",
"po_number": "RCG INIT Oct22-14",
"contract_end_date": "2016-10-18",
"contract_start_date": "2015-10-19",
"end_user": {
"email": "[email protected]",
"first_name": "PerfFNl74282764",
"last_name": "PerfLNl74282764",
"primary_account_name": "RESn-Tech Data Prod MGT Commercial",
"primary_account_address_line1": "5350 Tech Data Dr",
"primary_account_address_city": "Clearwater",
"primary_account_address_county": "United States",
"primary_account_address_country_code": "US",
"primary_account_address_geo": "NAMER",
"primary_account_address_postal_code": "33760-3122",
"primary_account_address_state": "FL",
"related_account_name": "RESn-Tech Data Prod MGT Commercial",
"related_account_address_line1": "5350 Tech Data Dr",
"related_account_address_city": "Clearwater",
"related_account_address_county": "United States",
"related_account_address_country_code": "US",
"related_account_address_geo": "NAMER",
"related_account_address_postal_code": "33760-3122",
"related_account_address_state": "FL"
},
}
"ship_to_party_account_name": "Resn-Tech Data Prod MGT Commercial VAR",
"ship_to_party_address_line1": "5350 Tech Data Dr",
"ship_to_party_address_city": "Clearwater",
"ship_to_party_address_county": "United States",
"ship_to_party_address_country_code": "US",
"ship_to_party_address_geo": "NAMER",
"ship_to_party_address_postal_code": "33760-3122",
"ship_to_party_address_state_code": "FL",
"other_parties": [
{
"account_csn": "0000900605",
"partner_type": "ForwardingAgent"
}
],
"line_items": [
{
"item_number": "000010",
"part_number": "765G1-WW2432-T707",
"quantity": "1",
"net_amount": "902",
"delivery_method": "ED"
}
]
}
}
5.2.1
Mensagem de resposta - Atendimento de pedidos, Pedido inicial
{
"status": "OK",
}
5.3
Mensagem de solicitação – Atendimento de pedidos, Adicionar posições,
Modelo de assinatura recorrente
Message Headers
CSN: <<CSN>>
Body
{
"action_name": "add_seats",
"contract_number": "50010000321",
"po_number": ""879653151939475545",
"net_amount": "105.32",
"line_items": [
{
"subscription_id": "173789c1-d4b1-4bda-aaa1-8b3ea18ee53e",
"part_number": "123F1-004105-T979",
"quantity": 3,
"net_amount": "105.32"
}
]
}
5.3.1
Mensagem de resposta – Atendimento de pedidos, Adicionar posições, Modelo de
assinatura recorrente
{
"status": "OK",
}
5.4
Mensagem de solicitação – Atendimento de pedidos, Adicionar posições,
Modelo de assinatura renovável
Message Headers
CSN: <<CSN>>
Body
{
"action_name": "add_seats",
"order_date": "2015-10-30",
"po_date": "2015-10-08",
"po_number": "ARC ADDSEAT 10-8 11",
"pricing_date": "2015-10-08",
"ship_to_party_account_csn": "0090387032",
"line_items": [
{
"item_end_date": "2015-12-31",
"item_start_date": "2015-10-08",
"part_number": "757F1-005532-T760",
"quantity": "1",
"eu_csn": "4175592",
"pricing_date": "2015-10-08",
"serial_numbers": [
"364-81702573"
]
}
]
}
5.4.1
Mensagem de resposta – Atendimento de pedidos, Adicionar posições, Modelo de
assinatura renovável
{
"status": "OK",
}
5.5
Mensagem de solicitação – Atendimento de pedidos, Adicionar produtos,
Modelo de assinatura recorrente
Message Headers
CSN: <<CSN>>
Body
{
"action_name": "add_products",
"po_number": "someethingunique",
"line_items":[
{
"subscription_id":"5aad63269091420151011_13",
"part_number": "767F1-059987-T826",
"quantity": "1",
"end_user": {
"contact_csn": "",
"first_name": "",
"last_name": "",
"email": "",
"primary_end_user_account_csn": "",
"primary_end_user_account_name": "",
"primary_end_user_account_address_line1": "",
"primary_end_user_account_address_city": "",
"primary_end_user_account_address_state": "",
"primary_end_user_account_address_country_code": "",
"primary_end_user_account_address_postal_code": ""
}
}
]
}
5.5.1
Mensagem de resposta – Atendimento de pedidos, Adicionar produtos, Modelo de
assinatura recorrente
{
"status": "OK",
}
5.6
Mensagem de solicitação – Atendimento de pedidos, Adicionar produtos,
Modelo de assinatura renovável
Message Headers
CSN: <<CSN>>
Body
{
"action_name": "add_products",
"order_date": "2015-10-30",
"po_date": "2015-09-29",
"po_number": "A PROD 10-8 112345678",
"net_amount": "220.25",
"pricing_date": "2015-10-08",
"line_items": [
{
"item_end_date": "2016-01-15",
"item_start_date": "2015-10-08",
"part_number": "959H1-WWN452-T716",
"quantity": "1",
"eu_csn": "4276747",
"eu_first_name": "Mr. 2feb192015fname 2feb192015lname",
"eu_last_name": "INGRAM MICRO- AOLP/Subs/VAR Prod",
"related_account_csn": "0090387032",
"net_amount": "220.25",
"pricing_date": "2015-10-08"
}
]
}
5.6.1
Mensagem de resposta – Atendimento de pedidos, Adicionar produtos, Modelo de
assinatura renovável
{
"status": "OK",
}
5.7
Mensagem de solicitação - Atendimento de pedidos, Renovação, Modelo de
assinatura renovável somente
Message Headers
CSN: <<CSN>>
Body
{
"action_name": "renew",
"order_date": "2016-01-01",
"po_date": "2015-10-08",
"po_number": "RCG RENEW oct 8 12 33",
"net_amount": "3330.80",
"pricing_date": "2015-10-08",
"ref_document": [
{
"doc_type": "Opportunity",
"doc_number": "A-4757212"
}
],
"line_items": [
{
"part_number": "757F1-009704-T385",
"quantity": "1",
"eu_csn": "4175592",
"eu_first_name": "Siebel-Del Administrator",
"eu_last_name": "INGRAM MICRO- AOLP/Subs/VAR Prod",
"related_account_csn": "0090387032",
"net_amount": "3330.80",
"pricing_date": "2015-10-08",
"serial_numbers": [
"364-81713956"
]
}
]
}
5.7.1
5.8
Mensagem de resposta - Atendimento de pedidos, Renovação, Modelo de
assinatura renovável somente
{
"status": "OK",
}
Mensagem de solicitação - Renovar o envio de pedido de compra
automaticamente
https://enterprise-api-stg.autodesk.com/v1/orders/
Message Headers
{
"action_name":"po_update",
"contract_number":"71210003346",
"po_number":"013444500000123456004561"
}
5.8.1
Mensagem de resposta - Renovar o envio de pedido de compra automaticamente
{
"status": "OK",
"reference_number": "5123406609-8397298406-1445466752"
}
5.9
Mensagem de solicitação - Obter status do pedido (apenas para um pedido
inicial recorrente)
https://enterprise-api-stg.autodesk.com/v1/orders/status/<<po_number>>
5.9.1
Mensagem de resposta - Obter status do pedido (apenas para um pedido inicial
recorrente)
{
"status": "OK",
"message": {
"status": "Success",
"last_updated": "2015-09-25 19:11:13 UTC"
}
}
5.10 Mensagem de solicitação - Revogação de pedido (Remover instalação,
Remover produto, Cancelamento de pedido)
https://enterprise-apistg.autodesk.com/v1/orders/revoke?customer_number=<<csn>>
Message Headers
{
"action_name": "cancel",
"contract_number": “8900004623321"
}
5.10.1 Mensagem de resposta - Revogação de pedido (Remover licença, Remover
produto, Cancelamento de pedido)
{
"status": "OK",
"reference_number": "6227338390-14039092436950600-1443636789"
}
5.11 Mensagem de solicitação - Revogação de pedido (devoluções de pedido)
5.11.1 Mensagem de resposta - Revogação de pedido (devoluções de pedido)
6 Normas de formatação
Versão 4 do UUID - sequência de caracteres exclusiva gerada aleatoriamente
https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_.28random.29
ISO 8601 - formato de data AAAA-MM-DD
http://www.iso.org/iso/home/standards/iso8601.htm
ISO 639-1 - código de idioma de duas letras
http://www.iso.org/iso/home/store/catalogue_tc/catalogue_detail.htm?csnumber=22109
Formato alfa 2 de ISO 3166-1 - formato de código de país de duas letras
http://www.iso.org/iso/country_codes
7 Mensagens de erro
7.1
Códigos de erro
A tabela a seguir mostra os códigos de erro e as respectivas mensagens de erro presentes na
resposta mensagens caso eles ocorram.
Código de erro
UAN-GEN-00203
UAN-GEN-00208
UAN-GEN-00241
7.2
Mensagem de erro
CSN inválido
Descrição do erro
O CSN não está associado ao
aplicativo do parceiro/desenvolvedor
Não autorizado
O aplicativo não tem autorização para o
recurso selecionado
Token de acesso inválido
É preciso chamar o recurso Autorizar
para gerar o token de acesso
Mensagem de erro
A seguir está uma amostra de mensagem de erro de como ela será apresentada para o Parceiro:
{
"status": "Error",
"reference_number": "23462783468224233423420150405",
"message": [
{
"error_code": "UAN-GEN-00108",
"error_message": "Please enter Account Number"
}
]
}

Manual de Referência do Serviço PlaceOrder

Transcrição

Documentos relacionados

Account - Cidade das Profissões

Clique aqui para baixar Conta Real Guia Auctus

Account Planning

Inserindo Caracteres Especiais no Editor de Textos

account management

anexo xxxi - DFPC - Exército Brasileiro

new GCPU - Junho:2013

Fontes grátis em

Tabela ASCII

APÊNDICE C -Padrão de nomenclatura de arquivos