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 3.1 Desktop Subscription... 7 3.2 Atendimento do pedido... 7 3.3 Revogação de pedido... 7 3.4 Status do pedido... 7 4 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 posta - Criar pedido inicial... 20 4.14 Esquema de posta - Renovar o envio de pedido de compra automaticamente... 20 4.15 Esquema de ponsta - Obtenção de status do pedido... 20 4.16 Esquema de posta - Remover licença, Remover produto, Cancelamento de pedido [somente Recorrente]... 20 4.17 Esquema de posta - Devoluções de pedido [somente Recorrente]... 21 5 Amostra de mensagens... 21 5.1 Mensagem de solicitação - Atendimento de pedidos, Pedido inicial, Modelo recorrente do Subscription... 21 5.1.1 Mensagem de posta - Atendimento de pedidos, Pedido inicial... 23 5.2 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 Mensagem de posta - Atendimento de pedidos, Pedido inicial... 25 5.3 Mensagem de solicitação Atendimento de pedidos, Adicionar posições, Modelo de assinatura recorrente... 26 5.3.1 Mensagem de posta 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 posta 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 posta 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 posta Atendimento de pedidos, Adicionar produtos, Modelo de assinatura renovável... 29 5.7 Mensagem de solicitação - Atendimento de pedidos,, Modelo de assinatura renovável somente... 30 5.7.1 Mensagem de posta - Atendimento de pedidos,, 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 Mensagem de posta - Renovar o envio de pedido de compra automaticamente... 31 5.9 Mensagem de solicitação - Obter status do pedido (apenas para um pedido inicial recorrente)... 31 5.9.1 Mensagem de posta - Obter status do pedido (apenas para um pedido inicial recorrente)... 31 5.10 Mensagem de solicitação - Revogação de pedido (Remover instalação, Remover produto, Cancelamento de pedido)... 32 5.10.1 Mensagem de posta - 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 posta - 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 3 Manual de referência do serviço da Web
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 Renovar automaticamente envios de pedido de compra e Solicitar URL 3.0 10/28/2015 AR Os valo action_name do Atendimento de pedidos foram modificados de add_seat e add_product para add_seats e add_products 3.1 11/03/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 11/05/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 11/05/2015 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". 4 Manual de referência do serviço da Web
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 desenvolvedo 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 apentação e no acesso aos serviços do DDWS. O guia também serve para apentar 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 pectivo aplicativo registrado com a Autodesk. Para obter mais detalhes sobre o processo de integração, consulte o Guia do desenvolvedor para parceiros da Autodesk. 5 Manual de referência do serviço da Web
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 6 Manual de referência do serviço da Web
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 to 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 posta 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 posta associado também está incluído. 7 Manual de referência do serviço da Web
Os valo 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 corpondente for, os detalhes do cliente poderão ser recuperados dos sistemas da Autodesk. Se o CSN não for, 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 posta é 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 campo Definição do esquema Exemplo Tipo de campo Máx. Cara ctere s Obriga tório/ Opcio nal (O/O) Comentários / Recorrente action_name "initial_order" R initial_order, add_seats, add_products, renew ref_document Matriz do Objeto JSON O doc_type DDWSDocument LineNumber 40 R obrigatório caso ref_document seja doc_number SubscriptionID 15 R obrigatório caso ref_document seja currency_code 3 O Norma ISO Necessário para renovação Pedido po_date 25/12/2009 order_date 25/12/2009 Formato de data ISO 8601 Formato de data ISO 8601 10 O 10 O 8 Manual de referência do serviço da Web
po_number ORD1234 35 R Data do contrato SoldToParty ShipToP arty contract_start_date 25/12/2009 contract_end_date 25/12/2009 sold_to_account_csn 6228559800 ship_to_party_accou nt_csn 6228559800 Formato de data ISO 8601 Formato de data ISO 8601 10 O 10 O 15 O 15 O Parceiro vendido para CSN. Opcional; caso não seja, receberá o valor do cabeçalho de autorização Fornecer caso seja conhecido, caso contrário, utilizar os detalhes abaixo ship_to_party_accou nt_name "Partner Inc" o CSN não seja ShipToParty.Adds EndUse rprimar yaccou nt EndU serpri mary Acco unt.a dd ship_to_party_addre ss_line1 ship_to_party_addre ss_line2 ship_to_party_addre ss_city ship_to_party_addre ss_postal_code ship_to_party_addre ss_country_code ship_to_party_addre ss_county ship_to_party_addre ss_state_code "1 Parkway Road" "1 Parkway Road" "CA" 94604 "US" "MARINE" "CA" primary_account_csn 6228559800 primary_account_ad ds_line_1 "1 Parkway Road" 35 35 35 9 3 35 3 15 O o csn não seja o csn não seja o csn não seja o csn não seja o csn não seja o csn não seja o csn não seja Fornecer caso seja conhecido, caso contrário, utilizar os detalhes abaixo primary_account_c sn não seja 9 Manual de referência do serviço da Web
primary_account_ad ds_line_2 primary_account_ad ds_city primary_account_ad ds_postal_code primary_account_ad ds_country_code primary_account_ad ds_state "1 Parkway Road" "CA" 94604 "US" "CA" primary_account_c sn não seja primary_account_c sn não seja primary_account_c sn não seja primary_account_c sn não seja primary_account_c sn não seja Reseller Party eller_account_csn 6228559800 15 R Parceiro do DL EndUser Contract Manager Account eu_primary_account _csn 6228559800 15 O Fornecer caso seja conhecido, caso contrário, utilizar os detalhes abaixo eu_primary_account _name "Partner Inc1" eu_primary_accou nt_csn não seja eu_primary_account _adds_line1 "1 Parkway Road" eu_primary_accou nt_csn não seja EndUserContractManagerAccount eu_primary_account _adds_line2 eu_primary_account _adds_city eu_primary_account _adds_postal_cod e "1 Parkway Road" "CA" 94604 eu_primary_accou nt_csn não seja eu_primary_accou nt_csn não seja eu_primary_accou nt_csn não seja eu_primary_account "US" Valor ISO 10 Manual de referência do serviço da Web
_adds_country_co de eu_primary_accou nt_csn não seja eu_primary_account _adds_state "CA" eu_primary_accou nt_csn não seja contact_csn 6228559800 15 O Forneça o CSN ou preencha o to das informações EndUserContact end_user first_name last_name email language country line_items "John" "Smith" joh.smith@sttest. com "EN" "US" Matriz do Objeto JSON Matriz do Objeto JSON R 35 R 35 R 50 R Standard:email 2 R 2 R R Código de idioma de 2 dígitos Código do país com 2 dígitos subscription_id 40 R Formato da versão 4 do UUID. Recorrente ListOfLineItem.LineItem ListOfLineItem.LineItem.E ndusercontact.listofrel atedaccount.relatedacco unt part_number quantity "1" net_amount "39.33" 001G1-WW7929- T210 related_account_csn 6228559800 related_account_na me related_account_add s_line1 "Partner Inc" "1 Parkway Road" 35 R SKUNumber -> part_number 13 R 20 R Fornecer caso seja conhecido, caso contrário, utilizar os detalhes abaixo related_account_c sn não seja related_account_c sn não seja 11 Manual de referência do serviço da Web
ListOfLineItem.LineItem.EndUser Contact related_account_add s_line2 related_account_add s_city related_account_add s_postal_code related_account_add s_country_code related_account_add s_state "1 Parkway Road" "CA" 94604 "US" "CA" eu_contact_csn 6228559800 eu_first_name eu_last_name eu_email eu_language eu_country "Peter" "longslide" Peter.longslide@ sttest.com "EN" "US" related_account_c sn não seja related_account_c sn não seja related_account_c sn não seja related_account_c sn não seja related_account_c sn não seja 15 O 40 O 40 O eu_contact_csn não seja eu_contact_csn não seja 50 O Standard: email 2 R 2 R 4.3 Esquema de solicitação Adicionar posições Descrição do campo Definição do esquema Exemplo Tipo de campo Máx. de carac te Obriga tório/ Opcio nal (O/O) Comentário s Renovaçã o/recorren te action_name "add_seats" contract_number "40010000321" po_number "879653151939475545 " R "add_seats" 12 R 35 R 12 Manual de referência do serviço da Web
currency_code "USD" 3 R Obrigatório somente para pedidos de renovação. Código de modelo ISO de 3 letras net_amount "105.32" 20 R Soma de todos os line_items line_items Matriz de objetos JSON R order_date "2015-10-08" Data 10 R po_date "2015-10-08" Data 10 O eller_account_c sn "1160118032" 15 R ship_to_party_acc ount_csn "1160118032" 15 R sold_to_account_c sn 1160118032 15 R subscription_id "914fadc9-2b67-476eb480-e0e232e98745" 40 R formatada UUID versão 4 Recorrente serial_numbers ["364-81702573"] part_number quantity "7" "321K2-005205-T979" Matriz de sequências de R 35 R 13 R item_end_date "2015-10-08" Data 10 R item_start_date "2015-10-08" Data 10 R eu_csn "3265594" 15 O Obrigatório a menos que informações de contato sejam fornecidas eu_email "admin@autodesk.com" 50 O Obrigatório a menos que eu_csn seja line_items eu_first_name "John" 40 O Obrigatório a menos que eu_csn seja 13 Manual de referência do serviço da Web
eu_last_name "Smith" 40 O Obrigatório a menos que eu_csn seja pricing_date "2015-10-08" Data 10 R net_amount "105.32" 20 R Valor líquido por line_item 4.4 Esquema de solicitação - Adicionar produtos Descrição do campo Definição do esquema action_name Exemplo "add_products" contract_number "60010000321" po_number currency_code "879642151939475545 " "USD" net_amount "105.32" line_items Tipo de camp o Matriz de objetos JSON Máx. de carac te Obrigatóri o/ Opcional (O) R Comentário s "add_products " Renovaçã o/recorre nte 12 R 35 R 3 R 20 R R Obrigatório somente para pedidos de renovação. Código de modelo ISO de 3 letras Soma de todos os line_items order_date "2015-10-08" Data 10 R po_date "2015-10-08" Data 10 O Padroniza de acordo com a data do sistema pricing_date "2015-10-8" Data 10 R eller_account_csn 1160118032 15 R 14 Manual de referência do serviço da Web
ship_to_party_account_csn 1160118032 sold_to_account_csn 1160118032 subscription_id "914fadc9-2b67-476eb480-e0e232e98745" serial_numbers ["364-81702573"] part_number quantity "7" "321K2-004105-T868" Matriz de sequên cias de 15 R 15 R 40 R R formatada UUID versão 4 Matriz pode conter vários números de série Recorrente 35 R 13 R item_end_date "2015-10-08" Data 10 R item_start_date "2015-10-08" Data 10 R eu_csn "5285581" eu_email eu_first_name eu_last_name end_user "admin@autodesk.com" "John" "Smith" Objeto JSON 15 O 50 O 40 O 40 O O Obrigatório a menos que informações de contato sejam fornecidas Obrigatório a menos que eu_csn seja Obrigatório a menos que eu_csn seja Obrigatório a menos que eu_csn seja Recorrente contact_csn "90178032" 15 O Opcional Recorrente line_items first_name "John" Obrigatório caso contact_csn não seja Recorrente 15 Manual de referência do serviço da Web
last_name email primary_end_user_accou nt_csn primary_end_user_accou nt_name primary_end_user_accou nt_adds_line1 primary_end_user_accou nt_adds_city primary_end_user_accou nt_adds_state primary_end_user_accou nt_adds_country_code primary_end_user_accou nt_adds_postal_code "Smith" john@autodesk.com "90156444" "Arthur Doe" 50 O Obrigatório caso contact_csn não seja Obrigatório caso contact_csn não seja Recorrente Recorrente 15 O Recorrente 3 O 3 O 9 O Obrigatório caso primary end user csn não seja Obrigatório caso primary end user csn não seja Obrigatório caso primary end user csn não seja Obrigatório caso primary end user csn não seja Obrigatório caso primary end user csn não seja Obrigatório caso primary end user csn não seja Recorrente Recorrente Recorrente Recorrente Recorrente Recorrente pricing_date "2015-10-08" Data 10 R related_account_csn "80265031" net_amount "105.32" 35 R 20 R Valor líquido por line_item 16 Manual de referência do serviço da Web
4.5 Esquema de solicitação - Renovar Descrição do campo line_items Definição do esquema Exemplo Tipo de campo Máx. de caract e Obrigat ório/ Opciona l (O) Comentário s Renovaçã o/recorre nte action_name "renew" R "renew" contract_number "50010000321" 12 R contract_end_date "2015-10-08" Data 10 R contract_start_date "2015-10-08" Data 10 R po_number "768653151939475545" currency_code "USD" net_amount "105.32" line_items Matriz de objetos JSON 35 R 3 R 20 R R Obrigatório somente para pedidos de renovação. Código de modelo ISO de 3 letras Soma de todos os line_items order_date "2015-10-08" Data 10 R po_date "2015-10-08" Data 10 O pricing_date "2015-10-8" Data 10 R eller_account_csn 1160118032 ship_to_party_accou nt_csn 1160118032 sold_to_account_csn 1160118032 ref_document doc_type doc_number ["doc_type": "Opportunity","doc_nu mber": "A-4757212"] "Opportunity" "A-5857212" serial_numbers ["364-81702573"] part_number quantity "7" "123K2-004105-T979" Matriz de objetos JSON Matriz de sequências de 15 R 15 R 15 R R 40 R 15 R R 35 R 13 R item_end_date "2015-10-08" Data 10 R 17 Manual de referência do serviço da Web
item_start_date "2015-10-08" Data 10 R eu_csn "5285592" eu_email eu_first_name eu_last_name "admin@autodesk.com" "John" "Smith" 15 O 50 O 40 O 40 O Obrigatório a menos que informações de contato sejam fornecidas Obrigatório a menos que eu_csn seja Obrigatório a menos que eu_csn seja Obrigatório a menos que eu_csn seja pricing_date "2015-10-08" Data 10 R related_account_csn "80276031" 35 R net_amount "105.32" 20 R Valor líquido por line_item 4.6 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 Exemplo Tipo de campo action_name "po_update9" Compriment o 9 Comentários Deverá ser sempre po_number 18 Manual de referência do serviço da Web
contract_number 712100003683 30 Obrigatório po_number 8123789134934389 Mín. 20 Máx. 40 Obrigatório 4.8 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 posta associado, um status de sucesso ou falha, também está incluso. Descrição do campo 4.9 Esquema de solicitação - Obter status do pedido [apenas para um pedido inicial recorrente] Caminho da URL Definição do esquema po_number Exemplo 4.10 Revogação de pedido /order/status/8123789134934389 Tipo de campo cia de Compriment o Mín. 20 Máx. 40 Comentários Obrigatório. Parte do caminho da URL 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 posta associado também está incluído. Os valo de action_name valo 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 action_name reason Exemplo "Remove_seat" "User_Request" contract_number 712100003683 csn 5117338390 001G1-WW7929- sku T210 Tipo de campo Comprimento 3 3 30 17 35 Comentários Remover licença, Remover produto, Cancelamento. Obrigatório Não necessário para 19 Manual de referência do serviço da Web
de linha subscription_id "70b3a72e-efd1-45d8-d77d-July-08-2015-10" 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 posta - Criar pedido inicial Uma posta 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" message "Seu pedido está sendo processado." reference_number 5117338390-14039095465950600-1443636789 4.14 Esquema de posta - Renovar o envio de pedido de compra automaticamente Uma posta 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" message "O número de contrato não existe" reference_number 5123406609-8397298406-1445466752 4.15 Esquema de ponsta - Obtenção de status do pedido Uma posta 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 "Sucesso", Falha 4.16 Esquema de posta - Remover licença, Remover produto, Cancelamento de pedido [somente Recorrente] Uma posta 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. 20 Manual de referência do serviço da Web
Definição do esquema Exemplo Tipo de campo status "FALHOU" message "A SKU não está ativa" reference_number 5117338390-14039095465950600-1443636789 4.17 Esquema de posta - Devoluções de pedido [somente Recorrente] Uma posta 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. [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 21 Manual de referência do serviço da Web
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": "Laisha.Schaden@ssttest.net", "language": "EN", "country": "US", "primary_account_name": "emmiedicki", "primary_account_adds_line1": "854 Courtney Highway", "primary_account_adds_city": "San Rafael", "primary_account_adds_state": "CA", "primary_account_adds_country_code": "US", "primary_account_adds_postal_code": "94903", "related_account_name": "kaceykertzmann", "related_account_adds_line1": "771 June Stream", "related_account_adds_city": "San Rafael", "related_account_adds_state": "CA", "related_account_adds_country_code": "US", "related_account_adds_postal_code": "94903", 22 Manual de referência do serviço da Web
"eller_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": "Prudence.Pfannerstill@ssttest.net", "eu_language": "EN", "eu_country": "US", "eu_primary_account_name": "ashamitchell", "eu_primary_account_adds_line1": "61591 Vivien Mission", "eu_primary_account_adds_city": "San Rafael", "eu_primary_account_adds_state": "CA", "eu_primary_account_adds_country_code": "US", "eu_primary_account_adds_postal_code": "94903" ] 5.1.1 Mensagem de posta - Atendimento de pedidos, Pedido inicial "status": "OK", "message": "Your order is being processed", "reference_number": "0081265012-INITIAL ORDER 9-27 arc20-1443549162" 23 Manual de referência do serviço da Web
5.2 Mensagem de solicitação - Atendimento de pedidos, Pedido inicial, Modelo renovável 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": "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": "perffnl74282764004@adsk.com", "first_name": "PerfFNl74282764", "last_name": "PerfLNl74282764", "primary_account_name": "RESn-Tech Data Prod MGT Commercial", "primary_account_adds_line1": "5350 Tech Data Dr", "primary_account_adds_city": "Clearwater", "primary_account_adds_county": "United States", "primary_account_adds_country_code": "US", "primary_account_adds_geo": "NAMER", "primary_account_adds_postal_code": "33760-3122", "primary_account_adds_state": "FL", "related_account_name": "RESn-Tech Data Prod MGT Commercial", "related_account_adds_line1": "5350 Tech Data Dr", "related_account_adds_city": "Clearwater", "related_account_adds_county": "United States", "related_account_adds_country_code": "US", "related_account_adds_geo": "NAMER", "related_account_adds_postal_code": "33760-3122", "related_account_adds_state": "FL", 24 Manual de referência do serviço da Web
"eller_account_csn": "0068175430", "ship_to_party_account_name": "Resn-Tech Data Prod MGT Commercial VAR", "ship_to_party_adds_line1": "5350 Tech Data Dr", "ship_to_party_adds_city": "Clearwater", "ship_to_party_adds_county": "United States", "ship_to_party_adds_country_code": "US", "ship_to_party_adds_geo": "NAMER", "ship_to_party_adds_postal_code": "33760-3122", "ship_to_party_adds_state_code": "FL", "sold_to_account_csn": "0057175410", "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 posta - Atendimento de pedidos, Pedido inicial "status": "OK", "message": "Your order is being processed", "reference_number": "0081265012-INITIAL ORDER 9-27 arc20-1443549162" 25 Manual de referência do serviço da Web
5.3 Mensagem de solicitação Atendimento de pedidos, Adicionar posições, 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_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 posta Atendimento de pedidos, Adicionar posições, Modelo de assinatura recorrente "status": "OK", "message": "Your order is being processed", "reference_number": "0081265012-INITIAL ORDER 9-27 arc20-1443549162" 26 Manual de referência do serviço da Web
5.4 Mensagem de solicitação Atendimento de pedidos, Adicionar posições, 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", "currency_code": "USD", "order_date": "2015-10-30", "po_date": "2015-10-08", "po_number": "ARC ADDSEAT 10-8 11", "contract_number": "110000812267", "net_amount": "832.7", "pricing_date": "2015-10-08", "eller_account_csn": "0090387032", "ship_to_party_account_csn": "0090387032", "sold_to_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", "net_amount": "832.7", "pricing_date": "2015-10-08", "serial_numbers": [ "364-81702573" ] ] 5.4.1 Mensagem de posta Atendimento de pedidos, Adicionar posições, Modelo de assinatura renovável "status": "OK", "message": "Your order is being processed", "reference_number": "0081265012-INITIAL ORDER 9-27 arc20-1443549162" 27 Manual de referência do serviço da Web
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": "712100004481", "net_amount": "264.0", "po_number": "someethingunique", "line_items":[ "subscription_id":"5aad63269091420151011_13", "part_number": "767F1-059987-T826", "quantity": "1", "net_amount": "264.0", "end_user": "contact_csn": "", "first_name": "", "last_name": "", "email": "", "primary_end_user_account_csn": "", "primary_end_user_account_name": "", "primary_end_user_account_adds_line1": "", "primary_end_user_account_adds_city": "", "primary_end_user_account_adds_state": "", "primary_end_user_account_adds_country_code": "", "primary_end_user_account_adds_postal_code": "" ] 5.5.1 Mensagem de posta 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" 28 Manual de referência do serviço da Web
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", "currency_code": "USD", "order_date": "2015-10-30", "po_date": "2015-09-29", "po_number": "A PROD 10-8 112345678", "contract_number": "110000812062", "net_amount": "220.25", "pricing_date": "2015-10-08", "eller_account_csn": "0090387032", "ship_to_party_account_csn": "0090387032", "sold_to_account_csn": "0090387032", "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_email": "2feb192015@mailinator.com", "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 posta 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" 29 Manual de referência do serviço da Web
5.7 Mensagem de solicitação - Atendimento de pedidos,, 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", "currency_code": "USD", "order_date": "2016-01-01", "po_date": "2015-10-08", "po_number": "RCG RENEW oct 8 12 33", "contract_number": "110000812306", "net_amount": "3330.80", "pricing_date": "2015-10-08", "eller_account_csn": "0090387032", "ship_to_party_account_csn": "0090387032", "sold_to_account_csn": "0090387032", "ref_document": [ "doc_type": "Opportunity", "doc_number": "A-4757212" ], "line_items": [ "part_number": "757F1-009704-T385", "quantity": "1", "eu_csn": "4175592", "eu_email": "sadmin@null.autodesk.com", "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" ] ] 30 Manual de referência do serviço da Web
5.7.1 Mensagem de posta - Atendimento de pedidos,, 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 - Renovar o envio de pedido de compra automaticamente 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.8.1 Mensagem de posta - Renovar o envio de pedido de compra automaticamente "status": "OK", "message": "Your order is being processed", "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 posta - Obter status do pedido (apenas para um pedido inicial recorrente) "status": "OK", "message": "status": "Success", "last_updated": "2015-09-25 19:11:13 UTC" 31 Manual de referência do serviço da Web
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 Content-Type: application/json Authorization: Bearer <<Access Token>> "action_name": "cancel", "contract_number": 8900004623321" 5.10.1 Mensagem de posta - 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 posta - Revogação de pedido (devoluções de pedido) [Indisponível no momento] 6 Normas de formatação Versão 4 do UUID - sequên 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 32 Manual de referência do serviço da Web
7 Mensagens de erro 7.1 Códigos de erro A tabela a seguir mostra os códigos de erro e as pectivas mensagens de erro pentes na posta mensagens caso eles ocorram. Código de erro Mensagem de erro Descrição do erro UAN-GEN-00203 CSN inválido O CSN não está associado ao aplicativo do parceiro/desenvolvedor UAN-GEN-00208 Não autorizado O aplicativo não tem autorização para o recurso selecionado UAN-GEN-00241 Token de acesso inválido É preciso chamar o recurso Autorizar para gerar o token de acesso 7.2 Mensagem de erro A seguir está uma amostra de mensagem de erro de como ela será apentada para o Parceiro: "status": "Error", "reference_number": "23462783468224233423420150405", "message": [ "error_code": "UAN-GEN-00108", "error_message": "Please enter Account Number" ] 33 Manual de referência do serviço da Web