Serviços da rede de distribuição digital (DDWS) PlaceOrder ... · 3 | Manual de referência do serviço da Web 5.2 Mensagem de solicitação —Atendimento de pedidos, Pedido inicial,

Serviços da rede de distribuição digital (DDWS) PlaceOrder - Serviço manual

2 | Manual de referência do serviço da Web

ÍNDICE Histórico de revisão ......................................................................................................................................... 4

1 Introdução............................................................................................................................................... 10

1.1 Visão geral ..................................................................................................................................... 10

1.2 Documentação de suporte .............................................................................................................. 10 2 Introdução............................................................................................................................................... 10

3 Visão geral do serviço PlaceOrder .......................................................................................................... 11

3.1 Assinatura da Autodesk .................................................................................................................. 12

3.1.1 Recorrente .................................................................................................................................. 12

3.1.2 Renovável .................................................................................................................................. 12

3.2 Atendimento do pedido ................................................................................................................... 12 3.3 Revogação de pedido ..................................................................................................................... 12

3.4 Mensagens SNS ............................................................................................................................. 12

3.5 Obtenção de status do pedido ........................................................................................................ 13

4 Informações de referência do serviço PlaceOrder ................................................................................... 13

4.1 Atendimento do pedido ................................................................................................................... 13

4.2 Esquema de solicitação - Criar pedido inicial .................................................................................. 13 4.3 Esquema de solicitação — Adicionar licenças ................................................................................. 22

4.4 Esquema de solicitação — Adicionar produtos ................................................................................ 24

4.5 Esquema de solicitação — Renovar ............................................................................................... 28

4.6 Atualizar ordem de compra recorrente ............................................................................................ 30

4.7 Esquema de solicitação — Atualizar ordem de compra recorrente .................................................. 30

4.8 Obtenção de status do pedido ........................................................................................................ 30 4.9 Esquema de solicitação — Obtenção de status do pedido [apenas para um pedido inicial recorrente] .................................................................................................................................................. 30

4.10 Revogação de pedido ..................................................................................................................... 31

4.11 Esquema de solicitação — Remover licenças, remover produtos, cancelamento de pedido ............ 31

4.12 Esquema de resposta - Criar pedido inicial ..................................................................................... 32

4.13 Esquema de resposta — Atualizar ordem de compra recorrente ..................................................... 32 4.14 Esquema de responsta — Obtenção de status do pedido ............................................................... 32

4.15 Esquema de resposta - Remover licença, Remover produto, Cancelamento de pedido [somente Recorrente] ................................................................................................................................................ 33

4.16 Esquema de resposta — Notificação de SNS ................................................................................. 33

5 Amostra de mensagens .......................................................................................................................... 34

5.1 Mensagem de solicitação — Atendimento de pedidos, Pedido inicial, Modelo de assinatura recorrente................................................................................................................................................... 34

5.1.1 Mensagem de resposta — Atendimento de pedidos, Pedido inicial ............................................. 35


5.2 Mensagem de solicitação — Atendimento de pedidos, Pedido inicial, Modelo de assinatura renovável ................................................................................................................................................... 36

5.2.1 Mensagem de resposta — Atendimento de pedidos, Pedido inicial ............................................. 37

5.3 Mensagem de solicitação — Atendimento de pedidos, Adicionar licenças, Modelo de assinatura recorrente................................................................................................................................................... 38

5.3.1 Mensagem de resposta — Atendimento de pedidos, Adicionar licenças, Modelo de assinatura recorrente ............................................................................................................................................... 38

5.4 Mensagem de solicitação — Atendimento de pedidos, Adicionar licenças, Modelo de assinatura renovável ................................................................................................................................................... 39

5.4.1 Mensagem de resposta — Atendimento de pedidos, Adicionar licenças, Modelo de assinatura renovável ................................................................................................................................................ 40

5.5 Mensagem de solicitação — Atendimento de pedidos, Adicionar produtos, Modelo de assinatura recorrente................................................................................................................................................... 40

5.5.1 Mensagem de resposta — Atendimento de pedidos, Adicionar produtos, Modelo de assinatura recorrente ............................................................................................................................................... 41

5.6 Mensagem de solicitação — Atendimento de pedidos, Adicionar produtos, Modelo de assinatura renovável ................................................................................................................................................... 41

5.6.1 Mensagem de resposta — Atendimento de pedidos, Adicionar produtos, Modelo de assinatura renovável ................................................................................................................................................ 42

5.7 Mensagem de solicitação — Atendimento de pedidos, Renovação, Modelo de assinatura renovável somente ..................................................................................................................................... 43

5.7.1 Mensagem de resposta — Atendimento de pedidos, Renovação, Modelo de assinatura renovável somente.................................................................................................................................. 44

5.8 Mensagem de solicitação — Atualizar ordem de compra recorrente ................................................ 44 5.8.1 Mensagem de resposta — Atualizar ordem de compra recorrente ............................................... 44

5.9 Mensagem de solicitação — Obtenção de status do pedido ............................................................ 44

5.9.1 Mensagem de resposta — Obtenção de status do pedido ........................................................... 44

5.1 }Mensagem de solicitação — Revogação de pedidos (Remover posição, Remover produto, Cancelamento de pedido) ........................................................................................................................... 44

5.1.1 Mensagem de resposta - Revogação de pedido (Remover licença, Remover produto, Cancelamento de pedido) ....................................................................................................................... 45

5.2 Mensagem de solicitação - Revogação de pedido (devoluções de pedido)...................................... 45

5.2.1 Mensagem de resposta - Revogação de pedido (devoluções de pedido)..................................... 45

5.3 Mensagem de solicitação — Mensagens SNS ................................................................................ 45

5.3.1 Mensagem de resposta — Mensagens SNS ............................................................................... 45

6 Normas de formatação ............................................................................................................................ 45 7 Mensagens de erro ................................................................................................................................. 46

7.1 Códigos de erro .............................................................................................................................. 46

7.2 Mensagem de erro.......................................................................................................................... 47


Histórico de revisão Versão Data Autor Comentários 2.8 21/10/2015 AR Seções adicionadas 4.2,

4.7, 5.2 e 5.2.1 - para incluir o serviço de Cobrança recorrente

2.9 22/10/2015 AR O serviço anteriormente chamado de Cobrança recorrente foi atualizado para Atualizar ordem de compra recorrente e Solicitar URL

3.0 28/10/2015 AR Os valores action_name do Atendimento de pedidos foram modificados de “add_seat” e “add_product” para “add_seats” e “add_products”

3.1 03/11/2015 AR • 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.2 05/11/2015 AR • 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.

3.3 05/11/2015 AR • 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".

3.4 09/11/2015 AR • Os exemplos de data de esquema de solicitação foram modificados para se ajustarem ao formato ISO 8601

• Os valores possíveis de “action_name” para revogação de pedido foram atualizados para remover produtos, remover licenças, cancelar e voltar. Nota: voltar não está disponível no momento.

• O esquema de solicitação de revogação de pedido foi atualizado na seção 4.11

• Foram adicionadas descrições para os modelos de Desktop Subscription na seção 3.1

• Foi adicionado “related_account_csn” para o esquema de solicitação para adicionar licenças na seção 4.3

• Foi removido “pricing_date” do esquema de solicitação para adicionar licenças na seção 4.3

• Foram modificados os códigos de erro na seção 7.1


3.5 21/12/2015 AR • Foram modificadas as seções 4.2 a 4.5 para refletir o último esquema de solicitação

• Foi modificada a seção 4.9 de “po_number” para “reference number”

3.6 22/02/2016 RL • Converter todos os campos denominados “quantidade” para número inteiro.

3.7 22/02/2016 RL • Substituir o campo ref_document pelos campos opportunity type e opportunity_number.

3.8 23/02/2016 RL • Remover o campo order_date.

• Indicar as regras em contract_start_date.

3.9 26/02/2016 CC • Atualizar documentação para esquema de resposta da API de status

3.10 26/02/2016 CC • Atualizar SNS para indicar a disponibilidade de todos os serviços para fazer pedido

3.11 04/03/16 PL • Na seção 4.2, foram removidos os comentários de first_name, last_name, email, eu_first_name, eu_last_name, eu_email

• Na seção 4.2, foi alterado de O para R em first_name, last_name, email,


eu_first_name, eu_last_name, eu_email

• Na seção 4.2, foi editada a seção de comentário para somente “fornecer se conhecido” para contact_csn, eu_contact_csn

• Na seção 4.2, na seção de comentários de todos os campos que começam com primary_account, related_account, eu_primary_account, foi adicionado "*As regras se aplicam a somente recorrente”

3.12 31/03/16 PL • Nas seções 4.2, 4.3, 4.4, 4.11, foram atualizados todos os campos Quantidade para número inteiro positivo

• Nas seções 4.2,4.3, 4.4, foram atualizados os campos email e eu_email para o máximo de 80 caracteres

• Nas seções 4.2, 4.4, 5.1, foram adicionados Address_Line2 e Address_Line3 para os campos Primary, Eu_Primary e Related Account.

3.13 04/05/16 PL • Foram removidos os seguintes campos das seções 4.2, 4.3, 4.4, 4.5 e suas


mensagens de resposta correspondentes: item_end_date, contact_csn, eu_csn, contract_end_date, currency_code, eu_contact_csn

• Foram adicionadas descrições a todos os campos nas seções 4.2, 4.3, 4.4, 4.5.

• Foi adicionada uma possível mensagem de erro a 4.15

3.14 19 de julho de 2016 FX • Removidas todas as ocorrências do “Desktop Subscription”, já que esta terminologia está obsoleta.

• A duração da assinatura era denominada “período”.

• Na versão em inglês, “multiyear” foi alterado para “multi-year” (multianual) já que agora é um período genérico.


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 Documentação de suporte

• 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.

• Detalhes da interface/esquema da API: este documento contém informações de carga em relação a todos os possíveis cenários para Fazer Pedido, ele pode ser usado por desenvolvedores para gerar as solicitações de amostra preenchendo os campos desejados.

• Para obter mais informações sobre o Autodesk Web Services, consulte o Portal do desenvolvedor, onde você pode encontrar toda a documentação disponível e instruções passo a passo sobre como nossos serviços funcionam.

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 dois recursos de API para o gerenciamento de pedidos: /orders/fulfillment e /orders/revoke. Esses recursos são compostos de operações, que lidam com a criação do pedido, o cancelamento de pedido, as devoluções de pedido, as adições de licenças e produtos aos contratos existentes, bem como a remoção de licenças 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 • 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 Assinatura da Autodesk A assinatura da Autodesk é uma abordagem de pagamento pré-pago, com a opção de períodos mensal, trimestral, anual ou multianual selecionada por clientes. Há dois modelos principais: recorrente e renovável.

3.1.1 Recorrente Em um modelo de assinatura recorrente, uma determinada assinatura do cliente é atualizada automaticamente, com base no período (mensal, trimestral ou anual) selecionado pelo parceiro. A assinatura não expira e somente será cancelada quando o cliente solicitar explicitamente ou alterar o modelo da assinatura em questão.

3.1.2 Renovável Quando os clientes assinam um serviço segundo o modelo renovável, a assinatura expirará após o término do período selecionado (trimestral, anual, multianual). Essa mesma assinatura pode ser renovada perto do final do período. Em resumo, as assinaturas renováveis têm uma data final associada a elas enquanto as recorrentes não têm nenhuma data final.

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 Mensagens SNS As Mensagens SNS são um serviço opcional que os Parceiros da Autodesk podem solicitar, o que lhes permite receber alertas sobre qualquer serviço de realização de pedidos. O parceiro receberá um alerta após a conclusão da transação. A mensagem no alerta indicará o status da transação. Ela exibirá a transação e indicará se o status é "Sucesso" ou "Falha". A mensagem SNS está disponível para todos os cenários de realização de pedidos para modelos recorrentes e renováveis. Se estiver inscrito para receber as notificações de conclusão de pedido, um Parceiro poderá escolher um dos três seguintes métodos de entrega: o E-mail o Mensagem SMS o Extremidade


3.5 Obtenção de status do pedido O recurso de API Obtenção de status do pedido retorna o status atual de um determinado pedido dado o número de referência obtido da resposta à API Fazer pedido. Há suporte para a API Obtenção de status do pedido para todos os serviços Fazer pedido dos cenários recorrentes e renováveis. Para obter o status da ordem de compra desejada, a ID da transação deve ser fornecida.

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 de assinaturas, 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. Fazer isso retornará uma resposta de erro.

4.1 Atendimento do pedido Com base no campo action_name fornecido no corpo da solicitação, diferentes operações serão invocadas. 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 licenças. 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 (que compõe uma concatenação de CSN, número da ordem de compra e carimbo de data e hora). 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 transação de um status de processamento para um estado completo, assim que o Pedido em questão for criado no SAP.


Matriz do campo Definição do esquema Descrição do campo Exemplo Tipo de campo

Máx. Caracteres

Obrigatório/ Opcional

(O/O) Comentários Renovação/

Recorrente

Pedi

do

action_name Nome do evento que o

parceiro realizará ao fazer pedido

"initial_order" Sequência de caracteres 13 R initial_order Ambos

opportunity_type Tipo de oportunidade de vendas exclusivo, criado

para um pedido “A” Sequência de

caracteres 1 O Os valores possíveis são

“A” (ACE) e "R" (Renovação).

Ambos

opportunity_number

ID exclusiva que faz referência a uma

oportunidade de vendas que foi criada para um

pedido

“A-2076096” Sequência de caracteres 15 O

Quando você fornece o opportunity_type ou o opportunity_number, é

preciso fornecer o outro.

Ambos

po_date

Data em que o parceiro se eleva a OC no sistema

interno (pode ser data do sistema ou data no

passado)

25/12/2009 Formato de

data ISO 8601

10 O Ambos

po_number

Número da ordem de compra a ser determinado

pelo solicitante para identificar cada ordem

ORD1234 Sequência de caracteres 35 R Ambos

customer_po_number Número da OC do cliente. “51612614351612” Sequência de caracteres 35 O Ambos

Dat

a do

con

trato

contract_start_date Data de início do contrato 25/12/2009

Formato de data ISO

8601 10 O

Quando contract_start_date é especificado, a data

deve estar dentro de 30 dias a partir da data

atual. Quando

contract_start_date não é especificado, a data é

a data atual.

Ambos

EndU

ser

Con

tact

end_user Matriz do Objeto JSON R Ambos

first_name Nome do gerente de contratos (pessoa de

contato) "John" Sequência de

caracteres 35 R Ambos


last_name Sobrenome do gerente de

contratos (pessoa de contato)

"Smith" Sequência de caracteres 35 R Ambos

email E-mail do gerente de contratos (pessoa de

contato) [email protected]

Sequência de caracteres 80 R E-mail padrão Ambos

language Preferência de idioma da pessoa de contato “EN” Sequência de

caracteres 2 O É inglês como padrão quando não informado Recorrente

primary_account_csn CSN da conta de usuário final “6228559800” Sequência de

caracteres 10 O

*As regras se aplicam somente a recorrente.

Forneça se souber, caso contrário, preencha os

detalhes abaixo da conta principal

Ambos

primary_account_name Nome da conta "Partner Inc1" Sequência de caracteres 35 O


Obrigatório caso primary_account_csn

não seja fornecido

Ambos

primary_account_address_line1

Linha 1 do endereço da conta "1 Parkway Road" Sequência de

caracteres 35 O



não seja fornecido

Ambos


Linha 2 do endereço da conta

“Departamento de engenharia”

Sequência de caracteres 35 O



não seja fornecido

Ambos


Linha 3 do endereço da conta “Desk 5405” Sequência de

caracteres 35 O



não seja fornecido

Ambos

primary_account_address_city Cidade da conta “San Jose” Sequência de

caracteres 35 O



não seja fornecido

Ambos

mailto:[email protected]


primary_account_address_state Estado da conta "CA" Sequência de

caracteres 35 O



não seja fornecido

Ambos

primary_account_address_country_code Código do país da conta "US" Sequência de

caracteres 35 O


Obrigatório caso primary_account_csn não seja fornecido.

Código ISO de 2 dígitos

Ambos

primary_account_address_postal_code CEP da conta “94604” Sequência de

caracteres 35 O



não seja fornecido

Ambos

related_account_csn

CSN da conta para o qual o gerente de contratos está associado (poderia ser o

mesmo ou outro)

“6228559800” Sequência de caracteres 10 O



detalhes abaixo da conta relacionada

Ambos

related_account_name Nome da conta à qual o

gerente de contratos está associado

"Partner Inc" Sequência de caracteres 35 O


Obrigatório caso related_account_csn não

seja fornecido

Ambos

related_account_address_line1

Linha 1 do endereço da conta relacionada "1 Parkway Road" Sequência de

caracteres 35 O



seja fornecido

Ambos


Linha 2 do endereço da conta relacionada





seja fornecido

Ambos


Linha 3 do endereço da conta relacionada “Desk 5405” Sequência de

caracteres 35 O



seja fornecido

Ambos


related_account_address_city

Cidade da conta relacionada “San Jose” Sequência de

caracteres 35 O



seja fornecido

Ambos

related_account_address_state

Estado da conta relacionada "CA" Sequência de

caracteres 35 O



seja fornecido

Ambos

related_account_address_country_code

Código do país da conta relacionada "US" Sequência de

caracteres 35 O



seja fornecido. Código ISO de 2 dígitos

Ambos

related_account_address_postal_code CEP da conta relacionada “94604” Sequência de

caracteres 35 O



seja fornecido

Ambos

Res

elle

rPa

rty

reseller_account_csn CSN da conta relacionada “6228559800” Sequência de caracteres 10 R Parceiro do DL Ambos

Sold

ToPa

rty

sold_to_account_csn CSN da conta Vendido para “6228559800” Sequência de caracteres 10 O

Parceiro vendido para CSN. Caso não seja fornecido, receberá o valor do cabeçalho de

autorização.

Ambos

other_parties Matriz do Objeto JSON R Renovação

account_csn CSN da conta da pessoa (por exemplo, agente de

encaminhamento) “555678908765432” Sequência de

caracteres 10 R Renovação

partner_type Os valores a serem

inseridos são somente "ForwardingAgent"

“ForwardingAgent” Sequência de caracteres 18 R Renovação


List

OfL

ineI

tem

s

line_items Matriz do Objeto JSON R Ambos

subscription_id

No caso de pedido recorrente, para identificar de forma única cada linha de produtos, uma única ID

SUBS é gerada por linha de produtos. A mesma

assinatura. A ID precisa ser referenciada ao realizar as transações subsequentes, como adicionar licenças da mesma linha de produtos

ao mesmo contrato

"845cd4b7-2f20-4c1a-aaa2-102015110615"

Sequência de caracteres 36 R Formato da versão 4 do

UUID. Recorrente

part_number SKU 001G1-WW7929-T210 Sequência de caracteres 35 R SKUNumber ->

part_number Ambos

quantity Quantidade 1 Número inteiro

positivo R Ambos

net_amount Valor "39.33" Sequência de caracteres 20 R Ambos

delivery_method Valor do método de entrega a ser aprovado “ED” “ED” Sequência de

caracteres - R Renovação

eu_first_name Nome do coordenador de

software (pessoa de contato)

"Peter" Sequência de caracteres 40 R Recorrente

eu_last_name Sobrenome do coordenador

de software (pessoa de contato)

"longslide" Sequência de caracteres 40 R Recorrente

eu_email E-mail do coordenador de

software (pessoa de contato)

[email protected]

Sequência de caracteres 80 R Padrão: e-mail Recorrente

eu_language Idioma de preferência do coordenador de software

para comunicações "EN" Sequência de

caracteres 2 R Código ISO de 2 dígitos Recorrente

eu_country Código de país do coordenador de software "US" Sequência de

caracteres 2 R Código ISO de 2 dígitos Recorrente


eu_primary_account_csn

CSN da conta à qual o coordenador de software

está associado, neste cenário em que o

coordenador de software de uma determinada linha de

produtos é diferente do gerente de contratos

“6228559800” Sequência de caracteres 10 O



detalhes abaixo de eu_primary_account

Recorrente

eu_primary_account_name Nome da conta à qual o

Coordenador de software está associado

"Partner Inc1" Sequência de caracteres 35 O


Obrigatório caso eu_primary_account_csn

não seja fornecido

Recorrente

eu_primary_account_address_line1

Linha 1 do endereço da conta do coordenador de

software "1 Parkway Road" Sequência de

caracteres 35 O



não seja fornecido

Recorrente



software





não seja fornecido

Recorrente



software “Desk 5405” Sequência de

caracteres 35 O



não seja fornecido

Recorrente

eu_primary_account_address_city

Cidade da conta do coordenador de software “San Jose” Sequência de

caracteres 35 O



não seja fornecido

Recorrente

eu_primary_account_address_state

Estado da conta do coordenador de software "CA" Sequência de

caracteres 35 O



não seja fornecido

Recorrente


eu_primary_account_address_country_code

Código do país da conta do coordenador de software "US" Sequência de

caracteres 35 O



não seja fornecido. Código ISO de 2 dígitos

Recorrente

eu_primary_account_address_postal_code

CEP da conta do coordenador de software “94604” Sequência de

caracteres 35 O



não seja fornecido

Recorrente


Agora a carga pode ser de dois tipos. Se o CSN da conta principal, o CSN da conta relacionada ou eu_primary_account_csn for informado, será possível criar a carga como mostrado na versão aprimorada abaixo Carga existente do pedido inicial Carga aprimorada do pedido inicial


4.3 Esquema de solicitação — Adicionar licenças


Máx. de caracteres


(O/O) Comentários Renovação/

Recorrente

action_name Nome do evento que o parceiro realizará ao fazer pedido, como

adicionar licença. "add_seats"

Sequência de

caracteres 9 R "add_seats" Ambos

contract_number Número do contrato/acordo "40010000321" Sequência

de caracteres

12 R Ambos

po_date

Data em que o parceiro se eleva a OC no sistema interno (pode ser data do sistema ou data no

passado)

"2015-10-08" Data 10 O Ambos

po_number Número da ordem de compra a ser determinado pelo solicitante

para identificar cada ordem "879653151939475545"

Sequência de

caracteres 35 R Ambos

customer_po_number Número da OC do cliente. “51678901928765423” Sequência

de caracteres

35 O Ambos

contract_start_date Data de início do contrato 2009-12-25 Formato de

data ISO 8601

10 O

Quando contract_start_

date é especificado, a data deve estar

dentro de 30 dias a partir da

data atual. Quando

contract_start_date não é

especificado, a data é a data

atual.

Renovação

net_amount Valor total (soma dos valores em itens de linha) "105.32"

Sequência de

caracteres 20 R Soma de todos

os line_items Ambos

reseller_account_csn CSN da conta do revendedor "1160118032" Sequência

de caracteres

10 R Renovação


sold_to_account_csn CSN da conta Vendido para “1160118032” Sequência

de caracteres

10 O

Caso não seja fornecido, receberá o

valor do cabeçalho de autorização.

Renovação

opportunity_type Tipo de oportunidade de vendas

exclusivo, criado para um pedido

“A” Sequência

de caracteres

1 O

Os valores possíveis são

“A” (ACE) e "R" (Renovação).

Ambos

opportunity_number ID exclusiva que faz referência a

uma oportunidade de vendas que foi criada para um pedido

“A-2076096” Sequência

de caracteres

15 O

Quando você fornece o

opportunity_type ou o

opportunity_number, é preciso

fornecer o outro.

Ambos

line_

item

s

line_items Matriz de objetos JSON

R Ambos

subscription_id

No caso de pedido recorrente, para identificar de forma única cada linha de produtos, uma única ID SUBS é gerada por linha de produtos. A mesma assinatura. A ID precisa ser referenciada ao realizar as

transações subsequentes, como adicionar licenças da mesma linha de produtos ao mesmo

contrato

"914fadc9-2b67-476e-b480-e0e232e98745"

Sequência de

caracteres 36 R

Sequência de caracteres formatada

UUID versão 4

Recorrente

item_start_date Data em que inicia a cobrança desta adição de licença "2015-10-08" Data 10 O Renovação

part_number SKU "321K2-005205-T979" Sequência

de caracteres

35 R Ambos


positivo R Ambos


eu_email E-mail do coordenador de software (pessoa de contato) "[email protected]"

Sequência de


eu_first_name Nome do coordenador de software (pessoa de contato) "John"

Sequência de


eu_last_name Sobrenome do coordenador de software (pessoa de contato) "Smith"

Sequência de


net_amount Valor "105.32" Sequência

de caracteres

20 R Valor líquido por line_item Ambos

serial_numbers Número de série ["364-81702573"]

Matriz de sequências

de caracteres

R Renovação

4.4 Esquema de solicitação — Adicionar produtos


Máx. de caracteres


(O) Comentários Renovação/

Recorrente

action_name Nome do evento que o

parceiro realizará, como adicionar produtos

"add_products" Sequência de caracteres 12 R "add_products" Ambos

contract_number Número do contrato/acordo "60010000321" Sequência de caracteres 12 R Ambos

po_number

Número da ordem de compra a ser determinado pelo

solicitante para identificar cada ordem

"879642151939475545" Sequência de caracteres 35 R Ambos

net_amount Valor total (soma dos valores em itens de linha) "105.32" Sequência de

caracteres 20 R Soma de todos os line_items Ambos


po_date

Data em que o parceiro se eleva a OC no sistema interno (pode ser data do sistema ou

data no passado)

"2015-10-08" Data 10 O Padroniza de

acordo com a data do sistema

Ambos

customer_po_number Número da OC do cliente “516261439088877” Sequência de caracteres 35 O Ambos

contract_start_date Data de início do contrato “2009-12-25” Formato de

data ISO 8601

10 O

Quando contract_start_date é especificado, a data deve estar

dentro de 30 dias a partir da data atual.

Quando contract_start_date não é especificado,

a data é a data atual.

Renovação

reseller_account_csn CSN da conta do revendedor “1160118032” Sequência de caracteres 10 R Renovação


Caso não seja fornecido, receberá

o valor do cabeçalho de autorização.

Renovação

opportunity_type Tipo de oportunidade de

vendas exclusivo, criado para um pedido

“A” Sequência de caracteres 1 O

Os valores possíveis são “A”

(ACE) e "R" (Renovação).

Ambos

opportunity_number ID exclusiva que faz referência a uma oportunidade de vendas que foi criada para um pedido

“A-2076096” Sequência de caracteres 15 O




fornecer o outro.

Ambos


line_

item

s


R Ambos

subscription_id

No caso de pedido recorrente, para identificar de forma única cada linha de produtos, uma única ID SUBS é gerada por linha de produtos. A mesma assinatura. A ID precisa ser referenciada ao realizar as transações subsequentes, como adicionar licenças da

mesma linha de produtos ao mesmo contrato

"914fadc9-2b67-476e-b480-e0e232e98745"

Sequência de caracteres 36 R

Sequência de caracteres

formatada UUID versão 4

Recorrente

part_number SKU "321K2-004105-T868" Sequência de caracteres 35 R Ambos


positivo R Ambos

item_start_date Data em que inicia a cobrança desta adição de licença "2015-10-08" Data 10 O Renovação

eu_email E-mail do coordenador de software (pessoa de contato) "[email protected]" Sequência de


eu_first_name Nome do coordenador de software (pessoa de contato) "John" Sequência de


eu_last_name Sobrenome do coordenador de software (pessoa de contato) "Smith" Sequência de


end_user Objeto JSON O Recorrente

first_name Nome do gerente de contratos (pessoa de contato) "John" Sequência de

caracteres 35 R Recorrente

last_name Sobrenome do gerente de contratos (pessoa de contato) "Smith" Sequência de


email E-mail do gerente de contratos (pessoa de contato) [email protected] Sequência de



language Preferência de idioma da pessoa de contato “EN” Sequência de

caracteres 2 O É inglês como

padrão quando não informado

Recorrente

primary_account_csn CSN da conta de usuário final "9015644411" Sequência de caracteres 10 O


detalhes abaixo da conta principal

Recorrente

primary_account_name Nome da conta "Arthur Doe" Sequência de caracteres 35 O

Obrigatório caso primary_account_c

sn não seja fornecido

Recorrente

primary_account_address_line1 Linha 1 do endereço da conta "1 Parkway Road" Sequência de caracteres 35 O



Recorrente

primary_account_address_line2 Linha 2 do endereço da conta “Departamento de engenharia”




Recorrente

primary_account_address_line3 Linha 3 do endereço da conta “Desk 5405” Sequência de caracteres 35 O



Recorrente

primary_account_address_city Cidade da conta “San Jose” Sequência de caracteres 35 O



Recorrente

primary_account_address_state Estado da conta "CA" Sequência de caracteres 3 O



Recorrente

primary_account_address_country_code Código do país da conta "US" Sequência de

caracteres 3 O


sn não seja fornecido. Código ISO de 2 dígitos

Recorrente

primary_account_address_postal_code CEP da conta “94604” Sequência de

caracteres 9 O



Recorrente


net amount Valor "105.32" Sequência de caracteres 20 R Valor líquido por

line_item Ambos

4.5 Esquema de solicitação — Renovar

Matriz do campo Definição do esquema Descrição do campo Exemplo Tipo de

campo Máx. de

caracteres


(O) Comentários Renovação/

Recorrente

action_name Nome do evento que o parceiro realizará ao fazer pedido, como

renovar "renew" Sequência de

caracteres 5 R "renew" Renovação

order_date Data na qual o pedido é enviado "2015-10-08" Data 10 O Renovação

po_date

Data em que o parceiro se eleva a OC no sistema interno (pode ser

data do sistema ou data no passado)

"2015-10-08" Data 10 O Renovação

po_number Número da ordem de compra a ser determinado pelo solicitante para

identificar cada ordem "768653151939475545" Sequência de


customer_po_number Número da OC do cliente. “516143268789900111” Sequência de caracteres 35 O Renovação

contract_number Número do contrato/acordo "50010000321" Sequência de caracteres 12 R Renovação

reseller_account_csn CSN da conta do revendedor “1160118032” Sequência de caracteres 10 R Renovação


Caso não seja fornecido, receberá o

valor do cabeçalho de autorização.

Renovação


opportunity_type Tipo de oportunidade de vendas exclusivo, criado para um pedido “A” Sequência de

caracteres 1 O

Os valores possíveis são “A” (ACE) e

"R" (Renovação).

Renovação

opportunity_number ID exclusiva que faz referência a uma oportunidade de vendas que

foi criada para um pedido “A-2076096” Sequência de

caracteres 15 O




fornecer o outro.

Renovação

line_

item

s

line_items Matriz de objetos JSON R Renovação

part_number SKU "123K2-004105-T979" Sequência de caracteres 35 R Renovação

quantity Quantidade 7 Número inteiro positivo R Renovação

net_amount Valor "105.32" Sequência de caracteres 20 R Valor líquido

por line_item Renovação

serial_numbers Número de série ["364-81702573"] Matriz de

sequências de caracteres

R Renovação


4.6 Atualizar ordem de compra recorrente O recurso da API Atualizar ordem de compra recorrente gerencia a atualização de um número de OC de uma cobrança recorrente. A API Atualizar ordem de compra recorrente pode ser utilizada apenas por parceiros que tenham assinado um modelo recorrente. Essa assinatura será renovada automaticamente dentro do intervalo selecionado (trimestral, anual, multianual) e o pedido que estiver em aberto no momento será atualizado com um novo número de OC 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 — Atualizar ordem de compra recorrente Nota: o esquema a seguir se aplica somente aos parceiros que usam um modelo de assinatura recorrente. Descrição do campo

Definição do esquema Exemplo Tipo de

campo Comprimento Comentários

action_name "po_update" Sequência de caracteres 9 Deve ser sempre

“po_update”

contract_number 712100003683 Sequência de caracteres 30 Obrigatório

po_number 8123789134934389 Sequência de caracteres 35 Obrigatório

4.8 Obtenção de status do pedido O micro serviço Obtenção de status do pedido é uma solicitação de obtenção simples no seguinte formato: https://enterprise-api-dev.autodesk.com/v1/orders/status/<número_referência>, 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 é incluído.

4.9 Esquema de solicitação — Obtenção de status do pedido [apenas para um pedido inicial recorrente]

Descrição do campo


campo Comprimento Comentários

Caminho da URL reference number …/order/status/5123454340-

705786004296-1450719941


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. As solicitações de revogação de pedido só estão disponíveis para os Parceiros que utilizam um modelo de assinatura Recorrente. No momento, as devoluções de pedido não estão disponíveis e serão lançadas como melhoria futura. Os valores de action_name esperados são: remover licenças, remover produtos, cancelar.

4.11 Esquema de solicitação — Remover licenças, remover produtos, cancelamento de pedido

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 se aplica somente aos parceiros que usam um modelo de assinatura recorrente. No momento, um esquema do modelo de assinatura renovável não está disponível.

Descrição do campo


campo Obrigatório/

opcional Comprimento Comentários

Cabeçalho do

contrato

action_name "remover licenças"

Sequência de

caracteres R 15

remover licenças, remover

produtos, cancelar

contract_number 712100003683 Sequência

de caracteres

R 30 Obrigatório


R

Não necessário

para cancelamento

Nível do item de

linha

subscription_id

"bac19ced-7aa0-4737-

96a6-463159c8e98d"

Sequência de

caracteres R 36

Não necessário

para cancelamento

quantity 3 Número inteiro

positivo R 13

Só é necessário

para remover licenças.

Número de licenças a

serem removidas


4.12 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 "OK" Sequência de caracteres mensagem "Seu pedido está sendo processado." Sequência de caracteres número de referência 5117338390-14039095465950600-1443636789 Sequência de caracteres

4.13 Esquema de resposta — Atualizar ordem de compra recorrente 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 "FALHOU" Sequência de caracteres

mensagem "O número de contrato não existe" “Não é possível adicionar licenças a um produto cancelado com a ID de assinatura <Subs ID>”


número de referência 5123406609-8397298406-1445466752 Sequência de caracteres

4.14 Esquema de responsta — Obtenção de status do pedido A resposta da API de status retorna o status da ordem de acordo com a ID da transação fornecida. O status indicará se o pedido está em processamento, foi concluído ou falhou com um número de caso do código de status. Definição do esquema Exemplo Tipo de

campo status "OK", “FALHA”, “Pedido aceito” Sequência de

caracteres

mensagem

“Pedidos em processamento” “O pedido foi criado com êxito.” “Erro no processamento do pedido. Entre em contato com a Autodesk (código de erro 71)” “Erro no processamento do pedido. Entre em contato com a Autodesk CASE#0000123”


última atualização "2016-01-08 17:15:54 UTC" Sequência de caracteres


4.15 Esquema de resposta - Remover licença, Remover produto, Cancelamento de pedido [somente Recorrente]

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 "FALHOU" Sequência de caracteres mensagem "A SKU não está ativa" Sequência de caracteres número de referência 5117338390-14039095465950600-1443636789 Sequência de caracteres

4.16 Esquema de resposta — Notificação de SNS Abaixo estão os itens presentes na resposta de uma notificação de SNS. A resposta fornece detalhes sobre o status do pedido realizado. Se for bem-sucedido, o número da entidade será preenchido com o número do pedido de vendas dos nossos sistemas de back office. Caso tenha ocorrido um erro ao processar o pedido, o campo de mensagem fornecerá um código de erro. Definição do esquema Exemplo Tipo de campo

csn "510214546554" Sequência de caracteres

transaction_id “6177425549-18578107667443833628-1452425305" Sequência de caracteres

status "Sucesso", "Falha" Sequência de caracteres

mensagem

“O pedido foi criado com êxito.” “O pedido de adição de licença foi atualizado com êxito.” “Erro no processamento do pedido. Entre em contato com a Autodesk (código de erro 71)”


entity_number “71239173496” Sequência de caracteres


5 Amostra de mensagens

5.1 Mensagem de solicitação — Atendimento de pedidos, Pedido inicial, Modelo de assinatura recorrente

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", "po_number": "5555500002015110615", "customer_po_number": "123123123123123123", "opportunity_type": “A”, “opportunity_number”: “A-2076096”, "end_user": { "first_name": "Gitman2015110615", "last_name": "Gitman2015110615", "email": "[email protected]", "language": "EN", "country": "US", "primary_account_name": "Corp 2015110615 Account1", "primary_account_address_line1": "500 Las Gallinas Ave", “primary_account_address_line2”: “Engineering Dept.”, “primary_account_address_line3”: “Office 5342”, "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": "Corp 2015110615 Account1", "related_account_address_line1": "400 Las Gallinas Ave", “related _account_address_line2”: “Engineering Dept.”, “related _account_address_line3”: “Office 5342”, "related_account_address_city": "San Rafael", "related_account_address_state": "CA", "related_account_address_country_code": "US", "related_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" }

"reseller_account_csn": "9872424531", "line_items": [ { "subscription_id": "845cd4b7-2f20-4c1a-aaa2-102015110615", "part_number": "767F1-058492-T279", "quantity": 1, "net_amount": "264.00", "eu_first_name": "Gitman2015110615", "eu_last_name": "Gitman2015110615", "eu_email": "[email protected]", "eu_language": "EN", "eu_country": "US", "eu_primary_account_name": "Gitman Corp 2015110615 Accoun1", "eu_primary_account_address_line1": "600 Las Gallinas Ave", "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.2 Mensagem de solicitação — Atendimento de pedidos, Pedido inicial, Modelo de assinatura renovável

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", "po_date": "2015-11-25", "po_number": "SSDD-002", "customer_po_number": "initial custpo", "end_user": { "email": "[email protected]", "first_name": "Rawr", "last_name": "Stein", "primary_account_name": "Rawrstein World", "primary_account_address_line1": "666 Mars Way", "primary_account_address_city": "San Rafael", "primary_account_address_county": "United States", "primary_account_address_country_code": "US", "primary_account_address_geo": "NAMER", "primary_account_address_postal_code": "94903", "primary_account_address_state": "CA", "related_account_name": "Rawrstein World", "related_account_address_line1": "666 Mars Way", "related_account_address_city": "San Rafael", "related_account_address_county": "United States", "related_account_address_country_code": "US", "related_account_address_geo": "NAMER", "related_account_address_postal_code": "94903", "related_account_address_state": "CA" },


5.2.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" }

"reseller_account_csn": "1170174511", "ship_to_party_account_name": "Rawrstein World", "ship_to_party_address_line1": "666 Mars Way", "ship_to_party_address_city": "San Rafael", "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": "94903", "ship_to_party_address_state_code": "CA", "sold_to_account_csn": "1170174511", "other_parties": [ { "account_csn": "1234567890", "partner_type": "ForwardingAgent" } ], "line_items": [ { "part_number": "978G1-WW2859-T981", "quantity": 1, "net_amount": "1570.8", "delivery_method": "ED" }, { "part_number": "978G1-WW6919-T229", "quantity": 1, "net_amount": "1293.6", "delivery_method": "ED" } ] }


5.3 Mensagem de solicitação — Atendimento de pedidos, Adicionar licenças, Modelo de assinatura recorrente

5.3.1 Mensagem de resposta — Atendimento de pedidos, Adicionar licenças, Modelo de assinatura recorrente { "status": "OK", "message": "Your order is being processed", "reference number": "0081265012-INITIAL ORDER 9-27 arc20-1443549162" }

https://enterprise-api-stg.autodesk.com/v1/orders/fulfillment Message Headers Authorization: Bearer <<Access Token>> Content-Type: application/json CSN: <<CSN>> Body { "action_name": "add_seats", "contract_number": "40010000123", "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" }, { "subscription_id": "173789c1-d4b1-4bda-aaa1-8b3ea18ee53e", "part_number": "123F1-004105-T970", "quantity": 2, "net_amount": "105.32" } ] }


5.4 Mensagem de solicitação — Atendimento de pedidos, Adicionar licenças, Modelo de assinatura renovável

https://enterprise-api-stg.autodesk.com/v1/orders/fulfillment Message Headers Authorization: Bearer <<Access Token>> Content-Type: application/json CSN: <<CSN>> Body { "action_name": "add_seats", "po_date": "2015-12-10", "po_number": "adds-mp-001", "customer_po_number": "adds s.s.d.d.", "contract_number": "110001181743", "net_amount": "2864.4", "pricing_date": "2015-12-03", "reseller_account_csn": "1175166620", "ship_to_party_account_csn": "1175166620", "sold_to_account_csn": "1175166620", "line_items": [ { "item_start_date": "2015-12-10", "part_number": "978G1-004781-T761", "quantity": 1, "related_account_csn" : "5163460123", "net_amount": "1570.8", "serial_numbers": [ "560-43395041" ] }, { "item_start_date": "2015-12-10", "part_number": "978G1-007939-T204", "quantity": 1, "related_account_csn" : "5163460123", "net_amount": "1293.6", "serial_numbers": [ "560-43395140" ] } ] }


5.4.1 Mensagem de resposta — Atendimento de pedidos, Adicionar licenças, Modelo de assinatura renovável { "status": "OK", "message": "Your order is being processed", "reference number": "0081265012-INITIAL ORDER 9-27 arc20-1443549162" }

5.5 Mensagem de solicitação — Atendimento de pedidos, Adicionar produtos, Modelo de assinatura recorrente

https://enterprise-api-stg.autodesk.com/v1/orders/fulfillment Message Headers Authorization: Bearer <<Access Token>> Content-Type: application/json CSN: <<CSN>> Body { "action_name": "add_products", "contract_number": "712100004596", "po_number": "ae9be-3205ec9a9f3b", "net_amount": "264.0", "line_items": [ { "subscription_id": "fa724c53-a376-4ab4-9a26-3205ec9a9f3b", "part_number": "767F1-059987-T826", "quantity": 2, "net_amount": "264.0", "end_user": { "first_name": "ddwsman2015110625", "last_name": "ddwsman2015110625", "email": "[email protected]", "language": "EN", "country": "US", "primary_account_name": "ddwsman Corp 2015110625 Account1", "primary_account_address_line1": "810 Civic Center Dr", "primary_account_address_city": "San Rafael", "primary_account_address_state": "CA", "primary_account_address_country_code": "US", "primary_account_address_postal_code": "94903" } } ] }


5.5.1 Mensagem de resposta — Atendimento de pedidos, Adicionar produtos, Modelo de assinatura recorrente { "status": "OK", "message": "Your order is being processed", "reference number": "0081265012-INITIAL ORDER 9-27 arc20-1443549162" }

5.6 Mensagem de solicitação — Atendimento de pedidos, Adicionar produtos, Modelo de assinatura renovável

https://enterprise-api-stg.autodesk.com/v1/orders/fulfillment Message Headers Authorization: Bearer <<Access Token>> Content-Type: application/json CSN: <<CSN>> Body { "action_name": "add_products", "po_date": "2015-12-10", "po_number": "de2398-addp-002", "contract_number": "110001181748", "customer_po_number": "addp s.s.d.d.", "net_amount": "1570.8", "pricing_date": "2015-12-10", "reseller_account_csn": "5168907654", "ship_to_party_account_csn": "5168907654", "sold_to_account_csn": "5168907654", "line_items": [ { "item_start_date": "2015-12-10", "part_number": "978G1-WW2859-T981", "quantity": 1, "eu_email": "[email protected]", "eu_first_name": "Rawr", "eu_last_name": "Stein", "related_account_csn": "5163464321", "net_amount": "1570.8" } ] }


5.6.1 Mensagem de resposta — Atendimento de pedidos, Adicionar produtos, Modelo de assinatura renovável { "status": "OK", "message": "Your order is being processed", "reference number": "0081265012-INITIAL ORDER 9-27 arc20-1443549162" }


5.7 Mensagem de solicitação — Atendimento de pedidos, Renovação, Modelo de assinatura renovável somente

https://enterprise-api-stg.autodesk.com/v1/orders/fulfillment Message Headers Authorization: Bearer <<Access Token>> Content-Type: application/json CSN: <<CSN>> Body { "action_name": "renew", "po_date": "2015-11-25", "po_number": "SSDD-RENEW-02", "contract_number": "110001154585", "net_amount": "1293.6", "pricing_date": "2015-11-25", "reseller_account_csn": "5168907654", "ship_to_party_account_csn": "5168907654", "sold_to_account_csn": "5168907654", "opportunity_type": “A”, “opportunity_number”: “A-2079069", "line_items": [ { "part_number": "978G1-005445-T374", "quantity": 1, "eu_email": "[email protected]", "eu_first_name": "Rawr", "eu_last_name": "Stein", "related_account_csn": "5162614311", "net_amount": "1293.6", "serial_numbers": [ "560-34438575" ] } ] }


5.7.1 Mensagem de resposta — Atendimento de pedidos, Renovação, Modelo de assinatura renovável somente { "status": "OK", "message": "Your order is being processed", "reference number": "0081265012-INITIAL ORDER 9-27 arc20-1443549162" }

5.8 Mensagem de solicitação — Atualizar ordem de compra recorrente

5.8.1 Mensagem de resposta — Atualizar ordem de compra recorrente { "status": "OK", "message": "Your order is being processed", "reference number": "5123406609-8397298406-1445466752" }

5.9 Mensagem de solicitação — Obtenção de status do pedido https://enterprise-api-stg.autodesk.com/v1/orders/status/<<reference_number>>

5.9.1 Mensagem de resposta — Obtenção de status do pedido { "status": "Order Accepted", "message": "Order was created successfully.", "last_updated": "2016-01-08 19:21:54 UTC" }

https://enterprise-api-stg.autodesk.com/v1/orders/ Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> { "action_name":"po_update", "contract_number":"71210003346", "po_number":"013444500000123456004561" }


5.10 Mensagem de solicitação — Revogação de pedidos (Remover posição, Remover produto, Cancelamento de pedido)

5.10.1 Mensagem de resposta - Revogação de pedido (Remover licença, Remover produto, Cancelamento de pedido) { "status": "OK", "message": "Your order is being processed", "reference number": "6227338390-14039092436950600-1443636789" }

5.11 Mensagem de solicitação - Revogação de pedido (devoluções de pedido) [Indisponível no momento]

5.11.1 Mensagem de resposta - Revogação de pedido (devoluções de pedido) [Indisponível no momento]

5.12 Mensagem de solicitação — Mensagens SNS SNS é um serviço de adesão que envia ativamente atualizações para a extremidade fornecida. Uma solicitação para uma extremidade não é necessária.

5.12.1 Mensagem de resposta — Mensagens SNS { "csn": "5123442696", "transaction_id": "5123442696-juxtapoze-1456524940", "entity_number": "7355591712", "message": { "message": "Add seat order was updated successfully.", "status": "Success" } }

https://enterprise-api-stg.autodesk.com/v1/orders/revoke?customer_number=<<csn>> Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> { "action_name": "cancel", "contract_number": “8900004623321" }


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 status de HTTP Código de erro da Autodesk Mensagem interna

200 - OK 201 - criado 304 - não modificado 400 - solicitação incorreta Erro: 4000 Solicitação incorreta ou

corrompida 401 - não autorizado Erro: 4100 Nenhum CSN foi informado na

solicitação 401 - não autorizado Erro: 4101 Nenhuma Assinatura do

HMAC foi informada na solicitação

401 - não autorizado Erro: 4102 Nenhum ID do cliente do HMAC foi informado na solicitação

401 - não autorizado Erro: 4103 Nenhum Registro de data de hora do HMAC foi informado na solicitação

401 - não autorizado Erro: 4104 Nenhuma Autorização foi informada na solicitação

401 - não autorizado Erro: 4105 Token inválido 401 - não autorizado Erro: 4106 Algo deu errado ao gerar o

token 403 - proibido Erro: 4301 A assintura de HMAC foi

informada, mas não uma correta

403 - proibido Erro: 4302 O registro de data e hora de HMAC foi informado, mas não um correto

403 - proibido Erro: 4300 O CSN foi informado, mas não um correto


7.2 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" } ] }

Documents

Serviços da rede de distribuição digital (DDWS) PlaceOrder ... · 3 | Manual de referência do serviço da Web 5.2 Mensagem de solicitação —Atendimento de pedidos, Pedido inicial,