22
Serviç os da Web de distribuiç ã o digital (DDWS) GetOrderDetails - Manual do serviço

Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

  • Upload
    lediep

  • View
    216

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

Serviç os da Web de distribuiç ã o digital (DDWS) GetOrderDetails - Manual do serviço

Page 2: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

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

1 Introdução ...................................................................................................................................................... 4

1.1 Visão geral ............................................................................................................................................. 4

1.2 Documentos de suporte ........................................................................................................................ 4

2 Introdução ...................................................................................................................................................... 4

3 Visão geral do serviço GetOrderDetails ......................................................................................................... 5

3.1 GetOrderList .......................................................................................................................................... 6

3.2 GetOrderDetails ..................................................................................................................................... 6

3.3 Vantagens do serviço GetOrderDetails ................................................................................................. 6

4 Informações de referência do serviço GetOrderDetails ................................................................................. 6

4.1 Esquema de solicitação ......................................................................................................................... 6

4.2 Esquema de resposta ............................................................................................................................ 7

4.2.1 GetOrderList ...................................................................................................................................... 7

4.2.2 GetOrderDetails ................................................................................................................................. 8

4.3 Esquema de erro ................................................................................................................................. 12

4.4 Mensagens de solicitação ................................................................................................................... 13

4.4.1 Mensagem de solicitação - GetOrderDetails ................................................................................... 13

4.5 Mensagem de resposta ....................................................................................................................... 13

4.5.1 Mensagem de resposta - GetOrderList ........................................................................................... 13

4.5.2 Mensagem de resposta - GetOrderDetails ...................................................................................... 17

4.6 Mensagens de erro .............................................................................................................................. 21

4.6.1 Amostra de resposta de erro ........................................................................................................... 22

Page 3: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

Histórico de revisão Versão Data Autor Comentários

3.2 22/10/2015 AR Seção Histórico de revisão adicionada

3.3 04/12/2015 AR A seção 4.5.2 foi atualizada para refletir as alterações no Esquema de resposta

3.4 21/12/2015 AR serial_number adicionado na seção 3.2

Mensagem de resposta modificada na seção

4.5.1

Mensagem de resposta modificada na seção

4.5.2

3.5 23/02/2016 RL Adicionar os campos item_po_number,

billing_start_date, billing_end_date,

billing_status,

item_cancellation_transaction_date e

cancellation_reason a order_items_array.

3.6 23/02/2016 RL Adicionar o campo recurring_po a

order_header_array.

3.7 23/02/2016 ER Adicionar o campo sales_licence_type à

descrição de order_items

3.8 31/03/2016 PL Foram adicionados Street_2 e Street_3 à

seção 4.2.2

3.9 2/5/2016 PL Foram adicionados os campos activity, type,

transactiondate, previousqty, newqty à seção

4.2.2 e a resposta de exemplo foi atualizada

em 4.5.2

3.10 6 de junho de 2016

FX Foram adicionados o tipo de campo e o

formato/comprimento da saída na na seção

4.2.1 e 4.2.2

Page 4: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

1 Introdução

1.1 Visão geral

A plataforma do Serviço da Web de distribuição digital (DDWS) é uma solução para realização de pedidos criada diretamente por nossos Parceiros para a Autodesk, com pouco toque dos Parceiros e nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B verdadeiras entre os Parceiros e a Autodesk.

Para os Parceiros têm a implementação efetiva da Plataforma de serviços digitais da Autodesk, as afiliadas precisarão ter familiaridade com os serviços da Web REST, o OAuth e o JSON. Uma amostra de um aplicativo de cliente é fornecida (gravado na linguagem Ruby) em um documento Guia de programação, que ajudarão os chamados desenvolvedores afiliados a consumirem a API do serviço digital.

1.2 Documentos de suporte

Guia do desenvolvedor para parceiros da Autodesk: este guia ajuda os Parceiros no processo de apresentação e no acesso aos serviços do DDWS. O guia também serve para apresentar aos Parceiros a Plataforma de serviços digitais da Autodesk, usando instruções passo a passo que os orientam nas atividades iniciais necessárias para integração.

Documentação da API de autenticação: este documento orientará os Parceiros pelo processo de geração de credenciais, assinaturas e tokens de acesso necessários para usar as APIs do serviço. Ele também contém informações para o desenvolvimento de um aplicativo de integração de um Parceiro. Ele fornece a compreensão básica da integração do serviço da Web e demonstra o desenvolvimento de um aplicativo típico.

2 Introdução

Como parte do processo de apresentação, os Parceiros serão associados a um único Número específico do cliente (CSN) e terão seu aplicativo registrado com a Autodesk. Para obter mais detalhes sobre o processo de integração, consulte o Guia do desenvolvedor para parceiros da Autodesk.

Page 5: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

3 Visão geral do serviço GetOrderDetails

O serviço GetOrderDetails fornecerá os Parceiros as informações detalhadas do pedido, como números de contrato, números de série, e as informações do produto, entre outros campos. Esses dados estarão em um formato não processado e disponíveis para ser consumidos por um sistema do Parceiro de

escolha. Este documento incluirá todos os cenários do serviço GetOrderDetails que são elegíveis para recuperar informações de pedido de dentro do ambiente da Autodesk.

Há duas operações definidas neste serviço para pesquisa de pedidos, ativados dependendo da entrada fornecida no serviço GetOrderDetails:

GetOrderList

GetOrderDetails

Page 6: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

3.1 GetOrderList

A finalidade desta operação é obter a lista de pedidos de um sistema de back-end se a entrada inclui somente um intervalo de datas. A resposta incluirá os dados que permitirão que um parceiro consulte novamente o serviço para obter os detalhes do pedido. Depois que o solicitante receber a resposta e recuperar as informações de que ele(a) precisa, ele(a) chamará GetOrderDetails usando Número do cliente / Número da ordem de compra / Número do pedido de vendas como entradas. As seguintes entradas são necessárias para executar a operação:

1. customer_number

2. order_date_from

3. order_date_to

3.2 GetOrderDetails

A finalidade desta operação é obter os detalhes do pedido de uma entrada especificada. Esta operação pode ser chamada usando os seguintes conjuntos de entradas:

1. customer_number

2. Somente um dos seguintes:

a. serial_number

b. contract_number

c. partner_po

d. customer_po

e. order_number

Nota: somente um pedido será preenchido como parte da resposta da API GetOrderDetails.

3.3 Vantagens do serviço GetOrderDetails

1. Um serviço da Web REST leve que podem ser consumido facilmente em qualquer aplicativo por meio

da conexão HTTP(s).

2. Informações de status e de rastreamento do pedido em tempo real.

3. A capacidade de ter informações sobre o pedido assim que estiverem disponíveis.

4 Informações de referência do serviço GetOrderDetails

4.1 Esquema de solicitação

Os detalhes dos Parâmetros de mensagem de solicitação na tabela a seguir para GetOrderDetails.

Page 7: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

Elemento Tipo de campo

Comprimento/formato de entrada

Utilização E

lem

en

tos

de

Ge

tOrd

erL

ist(

) customer_number Sequência de

caracteres Comprimento: máx. 10

caracteres Obrigatório

order_date_from Data Formato: ISO 8601

AAAA-MM-DD Obrigatório

order_date_to Data

Formato: ISO 8601 AAAA-MM-DD

(Intervalo de datas limitado a 90 dias)

Obrigatório

Ele

me

nto

s d

e

Ge

tOrd

erD

eta

ils

()

customer_number Sequência de

caracteres Comprimento: máx. 10

caracteres Obrigatório

contract_number Sequência de

caracteres Comprimento: máx. 12

caracteres

Somente um pode ser informado com customer_number

partner_po Sequência de

caracteres Comprimento: máx. 35

caracteres

customer_po Sequência de

caracteres Comprimento: máx. 35

caracteres

order_number Sequência de

caracteres Comprimento: 10

caracteres

serial_number Sequência de

caracteres Comprimento: máx. 12

caracteres

4.2 Esquema de resposta

4.2.1 GetOrderList

Para o envio do intervalo de datas, as colunas a seguir serão exibidas.

Campo Tipo de campo

Comprimento/formato de saída

Descrição

sales_order_number Sequência de caracteres

Comprimento: máx. 10 caracteres

Número do pedido SAP

Gerado pelo sistemas da Autodesk.

purchase_order_number Sequência de caracteres

Comprimento: máx. 35 caracteres

Número do pedido de compra

Gerado pelo Parceiro e enviado na solicitação de PlaceOrder.

order_date Data Formato: ISO 8601 AAAA-MM-DD Thh:mm:ss+00:00 (ex., 2016-06-06T17:51:00+0000)

Data de processamento do pedido

customer_po_number Sequência de caracteres

Comprimento: máx. 35 caracteres

Número da ordem de compra do cliente

Pertence ao revendedor que faz o pedido por meio de outro revendedor ou distribuidor.

Page 8: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

document_type Sequência de caracteres

Comprimento: máx. 10 caracteres

Tipo de documento

customer_number Sequência de caracteres

Comprimento: máx. 10 caracteres

Número do cliente

customer_name Sequência de caracteres

Comprimento: máx. 35 caracteres

Nome do cliente

status Sequência de caracteres

Resposta de confirmação: “Concluído”, “Aberto”

Status do pedido

tracking_number Sequência de caracteres

Comprimento: máx. 35 caracteres

Número de rastreamento

4.2.2 GetOrderDetails

Campo Tipo de campo

Comprimento/formato de saída

Descrição

status Sequência de caracteres

Resposta de confirmação: "OK", "FALHA", "ERRO"

Status da solicitação

order_header_array [Matriz de objetos JSON]

Campo Descrição

order_date Sequência de caracteres

Formato: ISO 8601 AAAA-MM-DD Thh:mm:ss+00:00 (ex., 2016-06-06T17:51:00+0000)

Data de processamento do pedido

sales_order_number Sequência de caracteres

Comprimento: máx. 10 caracteres

Número do pedido SAP

Gerado pelo sistemas da Autodesk.

purchase_order_number

Sequência de caracteres

Comprimento: máx. 35 caracteres

Número da ordem de compra

Gerado pelo Parceiro e enviado na solicitação de PlaceOrder.

customer_po_number Sequência de caracteres

Comprimento: máx. 35 caracteres

Número da ordem de compra do cliente

Pertence ao revendedor que faz o pedido por meio de outro revendedor ou distribuidor.

document_type Sequência de caracteres

Comprimento: máx. 10 caracteres

Tipo de documento

customer_number Sequência de caracteres

Comprimento: máx. 10 caracteres

Número do cliente

customer_name Sequência de caracteres

Comprimento: máx. 35 caracteres

Nome do cliente

order_status Sequência de caracteres

Comprimento: máx. 20 caracteres

Status do pedido

tracking_number Sequência de caracteres

Comprimento: máx. 35 caracteres

Número de rastreamento

Page 9: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

order_amount Sequência de caracteres

Comprimento: máx. 15 caracteres

Quantidade do pedido

É o preço total do pedido, que é igual ao preço dos produtos no pedido inicial mais o preço desses produtos para o próximo período. O último será cobrado próximo ao período de cobrança.

tax_amount Sequência de caracteres

Comprimento: máx. 13 caracteres

Valor de impostos

contract_number Sequência de caracteres

Comprimento: máx. 12 caracteres

Número do contrato

É um número exclusivo associado ao pedido mestre.

shipment_method Sequência de caracteres

Comprimento: máx. 20 caracteres

Método de envio

freight_charge Sequência de caracteres

Comprimento: máx. 15 caracteres

Custo de frete

purchase_order_date Sequência de caracteres

Formato: ISO 8601 AAAA-MM-DD Thh:mm:ss+00:00 (ex., 2016-06-06T17:51:00+0000)

Data da ordem de compra

contract_start_date Sequência de caracteres

Formato: ISO 8601 AAAA-MM-DD Thh:mm:ss+00:00 (ex., 2016-06-06T17:51:00+0000)

Data de início do contrato

É a data quando a cobrança será iniciada. Essa é igual à data do pedido, a menos que o pedido seja feito com uma data de início futura.

contract_end_date Sequência de caracteres

Formato: ISO 8601 AAAA-MM-DD Thh:mm:ss+00:00 (ex., 2016-06-06T17:51:00+0000)

Data de término do contrato

É a data quando a assinatura será encerrada. Para pedidos recorrentes, esse campo será igual a XXXXX.

contract_usage_type Sequência de caracteres

Comprimento: máx. 3 caracteres

Tipo de utilização do contrato

recurring_po Sequência de caracteres

Comprimento: máx. 40 caracteres

Número da ordem de compra recorrente

order_items_array [Matriz de objetos JSON]

sales_order_number Sequência de caracteres

Comprimento: máx. 10 caracteres

Número do pedido de venda

line_number Sequência de caracteres

Comprimento: máx. 6 caracteres

Número da linha

Page 10: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

Item_po_number Sequência de caracteres

Comprimento: máx. 40 caracteres

Número da ordem de compra do item

É o número do pedido gerado pelo Parceiro e enviado na solicitação PlaceOrder. Se o item de linha for gerado durante o pedido inicial, o valor será igual ao de purchase_order_number no nível de cabeçalho. Caso contrário, se um produto for adicionado ao mesmo contrato mais tarde, ele conterá o número do pedido de compra dessa solicitação.

sku Sequência de caracteres

Comprimento: máx. 18 caracteres

Número do material

É o número para identificar o produto que está sendo pedido. O formato do campo é como abaixo "001H1-007778-T275"

sku_description Sequência de caracteres

Comprimento: máx. 60 caracteres

Descrição do material

É a descrição do produto que está sendo pedido.

quantity Número inteiro Comprimento: máx. 15 caracteres

Quantidade

unit_price Sequência de caracteres

Comprimento: máx. 11 caracteres

Preço unitário

Representa o preço de uma licença.

order_currency Sequência de caracteres

Comprimento: máx. 5 caracteres

Moeda

É a moeda do valor monetário no pedido e é definida com base na localização do Parceiro que faz o pedido.

net_value Sequência de caracteres

Comprimento: máx. 15 caracteres

Valor líquido

product_key Sequência de caracteres

Comprimento: máx. 30 caracteres

Chave do produto

group_name Sequência de caracteres

Comprimento: máx. 35 caracteres

Nome do grupo

serial_number Sequência de caracteres

Comprimento: máx. 1300 caracteres

Vazio se o pedido for uma renovação ou adicionar licenças

Gerado pela Autodesk para identificar o produto de forma exclusiva.

current_serial_number Sequência de caracteres

Comprimento: máx. 130 caracteres

Vazio se o pedido for um pedido inicial ou adicionar produtos

seats Sequência de caracteres

Comprimento: máx. 10 caracteres

Número de licenças

Para pedidos de assinatura, esse campo é sempre igual a 1. Para licenças permanentes, representa o número de posições sob a licença.

deployment Sequência de caracteres

Comprimento: máx. 1 caractere

Implantação

Page 11: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

license_type Sequência de caracteres

Comprimento: máx. 30 caracteres

Tipo de licença

usage_type Sequência de caracteres

Comprimento: máx. 3 caracteres

Tipo de uso

license_description Sequência de caracteres

Comprimento: máx. 155 caracteres

Descrição da licença

subs_id Sequência de caracteres

Comprimento: máx. 48 caracteres

ID de assinatura, somente recorrente

billing_start_date Sequência de caracteres

Formato: ISO 8601 AAAA-MM-DDThh:mm:ss+00:00

Data de início da cobrança

billing_end_date Sequência de caracteres

Formato: ISO 8601 AAAA-MM-DD Thh:mm:ss+00:00 (ex., 2016-06-06T17:51:00+0000)

Data de término da cobrança

billing_status Sequência de caracteres

Status da cobrança

item_cancellation_transaction_date

Sequência de caracteres

Formato: ISO 8601 AAAA-MM-DD Thh:mm:ss+00:00 (ex., 2016-06-06T17:51:00+0000)

Data da transação de cancelamento de item

cancellation_reason Sequência de caracteres

Comprimento: máx. 40 caracteres

Motivo do cancelamento

sales_licence_type Sequência de caracteres

Comprimento: máx. 30 caracteres

“Novo” ou “Renovação”

order_partners_array [Matriz de objetos JSON]

sales_order_number Sequência de caracteres

Comprimento: máx. 10 caracteres

Número do pedido de venda

line_number Sequência de caracteres

Comprimento: máx. 6 caracteres

Número da linha

partner_type Sequência de caracteres

Comprimento: máx. 15 caracteres

Para cada tipo de parceiro, todas as informações correspondentes serão exibidas. Os tipos de parceiro são: pessoa de contato, revendedor, usuário final, faturar para, enviar para, gerente de contrato.

partner_number Sequência de caracteres

Comprimento: máx. 10 caracteres

Número do parceiro

contact_number Sequência de caracteres

Comprimento: máx. 10 caracteres

Número de contato

partner_name Sequência de caracteres

Comprimento: máx. 80 caracteres

Nome do parceiro

street Sequência de caracteres

Comprimento: máx. 30 caracteres

Rua

street_2 Sequência de caracteres

Comprimento: máx. 40 caracteres

Linha 2 do endereço

street_3 Sequência de caracteres

Comprimento: máx. 40 caracteres

Linha 3 do endereço

po_box Sequência de caracteres

Comprimento: máx. 10 caracteres

Caixa postal

Page 12: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

city Sequência de caracteres

Comprimento: máx. 25 caracteres

Cidade

postal_code Sequência de caracteres

Comprimento: máx. 10 caracteres

CEP

pobox_postal_code Sequência de caracteres

Comprimento: máx. 10 caracteres

CEP correspondente à Caixa postal

country Sequência de caracteres

Comprimento: máx. 15 caracteres

País

district Sequência de caracteres

Comprimento: máx. 25 caracteres

Distrito

region Sequência de caracteres

Comprimento: máx. 3 caracteres

Região

end_user_email Sequência de caracteres

Comprimento: máx. 241 caracteres

E-mail

assetdetailslist [Matriz de objetos JSON]

serialnumber Sequência de caracteres

Comprimento: máx. 18 caracteres

Todos os números de série associados ao pedido

registereddate Sequência de caracteres

Formato: ISO 8601 AAAA-MM-DD Thh:mm:ss+00:00

Data de registro de cada número de série

activity [Matriz de objetos JSON]

Elemento de assetdetailslist, lista de trilha de auditoria

type Sequência de caracteres

Comprimento: máx. 15 caracteres

Remover licença. Esta seção será preenchida para os cenários de remoção de licença.

transactiondate Sequência de caracteres

Formato: ISO 8601 AAAA-MM-DD Thh:mm:ss+00:00

Data e hora da remoção de licença

previousqty Número inteiro Comprimento: máx. 15 caracteres

Quantidade de licenças anterior

newqty Número inteiro Comprimento: máx. 15 caracteres

Nova quantidade de licenças

welcomekitstatus Sequência de caracteres

Comprimento: máx. 100 caracteres

“Enviado”, “Não enviado”

Nota: como agora existe o serviço GetOrderDetails, o campo Status do kit de boas-vindas (welcomekitstatus) retornará a resposta padrão "Não enviado". Este sinalizador será atualizado no futuro quando o desenvolvimento total do serviço GetOrderDetails for concluído.

4.3 Esquema de erro

Nome do campo Descrição

status Resposta de confirmação: "OK", "FALHA", "ERRO"

message Mensagem de falha ou erros

transactionid ID exclusivo de transação (combinação de número do pedido e registro de data e hora). Somente retornado em caso de sucesso.

Page 13: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

4.4 Mensagens de solicitação

A seguir estão amostras de solicitações para GetOrderDetails

4.4.1 Mensagem de solicitação - GetOrderDetails

4.5 Mensagem de resposta

Nota: a Autodesk enviará uma resposta com a estrutura a seguir. Os Parceiros podem reformatar para diferentes estruturas de acordo com suas necessidades.

4.5.1 Mensagem de resposta - GetOrderList

{ "status": "OK", "message": { "elements": [ { "order_list_array": [

[Getting GetOrderList using Customer Number and Date Range]

https://enterprise-api-

stg.autodesk.com/v1/orders?customer_number=51174443900&order_date_from=2015-05-

01&order_date_to=2015-07-29

Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>>

[Getting GetOrderDetails using Customer Number and Serial Number]

https://enterprise-api-

stg.autodesk.com/v1/orders?customer_number=5117444390&serial_number=D45-

10000111

Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>>

Page 14: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

{ "sales_order_number": "7044892531", "purchase_order_number": "PONFRtes", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123355730", "customer_name": "newstgsasp endcomp", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044788406", "purchase_order_number": "RCG-annual-renew No order date", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "Cust po renew no orderdate", "document_type": "GG Standard Order", "customer_number": "5123459790", "customer_name": "Sample Name", "status": "Being processed", "tracking_number": "" }, { "sales_order_number": "7044788407", "purchase_order_number": "InitialOrderQTR1130", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123472202", "customer_name": "Initialorderqtr 1130", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044788408", "purchase_order_number": "InitialOrderQTR1130A", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123472202", "customer_name": "Initialorderqtr 1130", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044788410", "purchase_order_number": "AddSeat1130PT", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "01234567890123456789012345678901234", "document_type": "GG Standard Order", "customer_number": "1430176516", "customer_name": "SAMPLE NAME", "status": "Completed",

Page 15: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

"tracking_number": "" }, { "sales_order_number": "7044790246", "purchase_order_number": "testpo983534362", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123459790", "customer_name": "Sample Name", "status": "Being processed", "tracking_number": "" }, { "sales_order_number": "7044790248", "purchase_order_number": "testpo98353436432", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123459790", "customer_name": "Sample Name", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044790250", "purchase_order_number": "testpo8362932", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123459790", "customer_name": "Sample Name", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044790252", "purchase_order_number": "testpo8912371239283", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123459790", "customer_name": "Sample Name", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044790560", "purchase_order_number": "RCG Initial Dec 01", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "12345678899", "document_type": "GG Standard Order", "customer_number": "5123459790",

Page 16: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

"customer_name": "Sample Name", "status": "Being processed", "tracking_number": "" }, { "sales_order_number": "7044790562", "purchase_order_number": "NewOrder1201PT", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123472262", "customer_name": "Neworder 1201Pt", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044790565", "purchase_order_number": "RenewalOrder1201PT", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123472265", "customer_name": "Renewalorder 1201Pt", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7344575547", "purchase_order_number": "ddwsmultiseattest2", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "Online Transaction", "customer_number": "5123460006", "customer_name": "SEnterprises", "status": "Being processed", "tracking_number": "" }, { "sales_order_number": "7344575551", "purchase_order_number": "functest_1449009521", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "Online Transaction", "customer_number": "5123460006", "customer_name": "SEnterprises", "status": "Being processed", "tracking_number": "" } ] } ] } }

Page 17: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

4.5.2 Mensagem de resposta - GetOrderDetails

{ "status": "OK", "message": { "elements": [ { "order_header_array": [ { "order_date": "2015-12-01T00:00:00+0000", "sales_order_number": "7055788410", "purchase_order_number": "AddSeat1130PT", "customer_po_number": "01234567890123456789012345678901234", "document_type": "GG Standard Order", "customer_number": "1430176516", "customer_name": "Sample & Co", "order_status": "Completed", "tracking_number": "", "order_amount": "601.33", "tax_amount": "0.00", "contract_number": "110001161985", "shipment_method": "IBLFMJDPIEDCAJFHIDGN", "freight_charge": "0.00", "purchase_order_date": "2015-12-01T00:00:00+0000", "contract_start_date": "2015-10-16T00:00:00+0000", "contract_end_date": "2016-01-15T00:00:00+0000", "contract_usage_type": "COM", “recurring_po”: “AddSeat1130PT-recurring-po” } ], "order_items_array": [ { "sales_order_number": "7055788410", "line_number": "000010", "item_po_number": "712100004772", "sku": "765G1-008204-T820", "sku_description": "BDSP 2015 TBP:QT SUB +1", "quantity": 1, "unit_price": "601.33", "order_currency": "USD", "net_value": "601.33", "product_key": "765G1", "group_name": "", "serial_number": "", "current_serial_number": "560-38200294", "seats": "1", "deployment": "S", "license_type": "New", "usage_type": "COM", "license_description": "Autodesk Building Design Suite Premium 2015", "subs_id": "", "billing_start_date": “2015-10-16T00:00:00+0000”, "billing_end_date": “2016-01-15T00:00:00+0000”,

Page 18: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

"billing_status": "N/A", "item_cancellation_transaction_date": null, "cancellation_reason": "", "sales_licence_type": "New" } ], "order_partners_array": [ { "sales_order_number": "7055788410", "line_number": "000000", "partner_type": "Contact Person", "partner_number": "", "contact_number": "0019490593", "partner_name": "InitialOrderQTR1130", "street": "Sample Ave", “street_2”: “Engineering Dept”, “street_3”: “Office 5432”, "po_box": "", "city": "San Jose", "postal_code": "98516", "pobox_postal_code": "", "country": "US", "district": "MARIN", "region": "CA", "end_user_email": "[email protected]" }, { "sales_order_number": "7055788410", "line_number": "000000", "partner_type": "Dealer", "partner_number": "1430176516", "contact_number": "0000000000", "partner_name": "Sample & Co", "street": "Buenavista St", "po_box": "PO BOX", "city": "Clearwater", "postal_code": "33760-3122", "pobox_postal_code": "33760-3122", "country": "US", "district": "PINELLAS", "region": "FL", "end_user_email": "" }, { "sales_order_number": "7055788410", "line_number": "000000", "partner_type": "End User", "partner_number": "1430176516", "contact_number": "0000000000", "partner_name": "Sample & Co", "street": "Buenavista St", "po_box": "PO Box", "city": "Clearwater",

Page 19: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

"postal_code": "33760-3122", "pobox_postal_code": "33760-3122", "country": "US", "district": "PINELLAS", "region": "FL", "end_user_email": "" }, { "sales_order_number": "7055788410", "line_number": "000000", "partner_type": "Bill to", "partner_number": "1430176516", "contact_number": "0000000000", "partner_name": "Sample & Co", "street": "Buenavista St", "po_box": "PO BOX", "city": "Clearwater", "postal_code": "33760-3122", "pobox_postal_code": "33760-3122", "country": "US", "district": "PINELLAS", "region": "FL", "end_user_email": "" }, { "sales_order_number": "7055788410", "line_number": "000000", "partner_type": "Ship to", "partner_number": "1430176516", "contact_number": "0000000000", "partner_name": "Sample & Co", "street": "Buenavista St", "po_box": "PO BOX", "city": "Clearwater", "postal_code": "33760-3122", "pobox_postal_code": "33760-3122", "country": "US", "district": "PINELLAS", "region": "FL", "end_user_email": "" }, { "sales_order_number": "7055788410", "line_number": "000000", "partner_type": "Contract Mgr", "partner_number": "5123472202", "contact_number": "0000000000", "partner_name": "Initialorderqtr 1130", "street": "Sample Ave", "po_box": "", "city": "San Jose", "postal_code": "98516", "pobox_postal_code": "",

Page 20: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

"country": "US", "district": "MARIN", "region": "CA", "end_user_email": "" }, { "sales_order_number": "7055788410", "line_number": "000010", "partner_type": "Contact Person", "partner_number": "", "contact_number": "0019490593", "partner_name": "InitialOrderQTR1130", "street": "Sample Ave", "po_box": "", "city": "San Jose", "postal_code": "98516", "pobox_postal_code": "", "country": "US", "district": "MARIN", "region": "CA", "end_user_email": "[email protected]" }, { "sales_order_number": "7055788410", "line_number": "000010", "partner_type": "Contract Mgr", "partner_number": "5123472202", "contact_number": "0000000000", "partner_name": "Initialorderqtr 1130", "street": "Sample Ave", "po_box": "", "city": "San Jose", "postal_code": "98516", "pobox_postal_code": "", "country": "US", "district": "MARIN", "region": "CA", "end_user_email": "" } ], "assetdetailslist": [ { "serialnumber": "560-38200294", "registereddate": null "activity": [ { "type": "Remove Seat", "transactiondate": "2016-04-28T23:03:52.000Z", "previousqty": "3", "newqty": 2 }, { "type": "Remove Seat",

Page 21: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

"transactiondate": "2016-04-29T22:17:51.000Z", "previousqty": "2", "newqty": 1 } ] } ], "welcomekitstatus": "Not Sent" } ] }

}

4.6 Mensagens de erro

A tabela a seguir mostra os códigos de erro e as respectivas mensagens de erro presentes na resposta mensagens caso um erro seja encontrado:

Número da mensagem

Mensagem de erro

003 & não encontrado.

013 O parâmetro de entrada está incompleto.

015 Número do pedido não encontrado

016 Número do pedido não encontrado

017 O Número de série fornecido não é válido

018 A duração deve ser menor que noventa (90) dias

UAN-GEN-00119 O Número de série fornecido não está no formato correto

UAN-GEN-00108 Forneça o Número do cliente

UAN-GEN-00108 Insira "De data" no formato AAAA-MM-DD

UAN-GEN-00119 Insira "De data" no formato AAAA-MM-DD

UAN-GEN-00108 Insira "Para data" no formato AAAA-MM-DD

UAN-GEN-00119 Insira "Para data" no formato AAAA-MM-DD

UAN-INV-00002 "De data" deve ser antes de "Para data"

UAN-GEN-00141 O intervalo de datas não deve ter mais de 90 dias. Verifique sua entrada e tente novamente

UAN-GEN-00119 Número inválido de cliente. Verifique sua entrada e tente novamente

UAN-GEN-00123 O número do cliente não pode ter mais de 10 caracteres. Verifique sua entrada e tente novamente

UAN-GEN-00119 Forneça uma combinação válida de parâmetros

UAN-GEN-00119 Forneça os nomes de parâmetros à direita

UAN-GEN-00108 Forneça o Número do pedido ou outro número de documento válido.

UAN-GEN-00123 O Número do pedido deve ter exatos 10 caracteres. Verifique sua entrada e tente novamente

UAN-GEN-00123 O Número da ordem de compra não pode ter mais de 35 caracteres. Verifique sua entrada e tente novamente

Forneça pelo menos um dos seguintes parâmetros SerialNumber, ContractNumber, OrderNumber ou PONumber

O Número de série fornecido não é válido

APG-DWS-INV-002 O Número do cliente fornecido é inválido.

Page 22: Serviç os da Web de distribuiç ã o digital (DDWS ... · nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B ... AAAA-MM-DD (Intervalo

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

UAN-GEN-00123 A OC do parceiro não pode ter mais de 35 caracteres. Verifique sua entrada e tente novamente

UAN-GEN-00123 O número do contrato não pode ter mais de 12 caracteres. Verifique sua entrada e tente novamente

4.6.1 Amostra de resposta de erro

Nota: este Manual de referência do serviço é para uso exclusivo pelos destinatários pretendidos e pode conter informações proprietárias e/ou confidenciais que podem ser privilegiadas ou protegidas contra divulgação. Qualquer revisão, utilização, divulgação ou distribuição não autorizada é proibida.

{ "status": "Error", "transactionid": "INV51046287871433503736", "message": [ { "error_code": " APG-DWS-INV-002", "error_message": "Provided customer number is invalid." } ] }