22
Servicios web de distribución digital (DDWS) GetOrderDetails - Manual del servicio

Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

  • Upload
    trandat

  • View
    215

  • Download
    1

Embed Size (px)

Citation preview

Page 1: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

Servicios web de distribución digital (DDWS) GetOrderDetails - Manual del servicio

Page 2: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

2 | Manual de referencia del servicio web

CONTENIDO Historial de revisiones ...................................................................................................................................... 3

1 Introducción .............................................................................................................................................. 4

1.1 Descripción general .......................................................................................................................... 4

1.2 Documentación complementaria ....................................................................................................... 4 2 Para empezar ............................................................................................................................................... 4

3 Descripción general del servicio GetOrderDetails ...................................................................................... 5

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

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

3.3 Ventajas del servicio GetOrderDetails ............................................................................................... 6

4 Información de referencia del servicio GetOrderDetails ............................................................................. 7 4.1 Esquema de solicitud ........................................................................................................................ 7

4.2 Esquema de respuesta ..................................................................................................................... 7

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

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

4.3 Esquema de error ........................................................................................................................... 12

4.4 Mensajes de solicitud ..................................................................................................................... 13 4.4.1 Mensaje de solicitud: GetOrderDetails ........................................................................................ 13

4.5 Mensaje de respuesta..................................................................................................................... 13

4.5.1 Mensaje de respuesta –GetOrderList .......................................................................................... 13

4.5.2 Mensaje de respuesta –GetOrderDetails ..................................................................................... 17

4.6 Mensajes de error ........................................................................................................................... 21 4.6.1 Ejemplo de respuesta de error .................................................................................................... 22

Page 3: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

3 | Manual de referencia del servicio web

Historial de revisiones Versión Fecha Autor Comentarios 3.2 22/10/2015 AR Se ha agregado la sección de historial de

revisiones. 3.3 04/12/2015 AR Se ha actualizado el punto 4.5.2 para reflejar los

cambios en el esquema de respuestas. 3.4 21/12/2015 AR • Se ha añadido serial_number en la sección

3.2. • Se ha modificado el mensaje de respuesta en

la sección 4.5.1. • Se ha modificado el mensaje de respuesta en

la sección 4.5.2.

3.5 23/02/2016 RL • Se han añadido los campos item_po_number, billing_start_date, billing_end_date, billing_status, item_cancellation_transaction_date y cancellation_reason a order_items_array.

3.6 23/02/2016 RL • Se ha añadido el campo recurring_po a order_header_array.

3.7 23/02/2016 ER • Se ha añadido el campo sales_licence_type a la descripción de order_items.

3.8 31/03/2016 PL • Se han añadido Street_2 y Street_3 a la sección 4.2.2.

3.9 02/05/2016 PL • Se han añadido los campos activity, type, transactiondate, previousqty, newqty a la sección 4.2.2 y se ha actualizado el ejemplo de respuesta en 4.5.2.

3.10 06/06/2016 FX • Se han añadido la longitud y el formato de salida, así como el tipo de campo en las secciones 4.2.1 y 4.2.2.

Page 4: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

4 | Manual de referencia del servicio web

1 Introducción

1.1 Descripción general

La plataforma de servicios web de distribución digital (DDWS) es una solución de automatización que permite a nuestros socios realizar pedidos directamente a Autodesk; este proceso requiere muy pocos pasos por parte de los socios y ninguno por parte de Autodesk.Esta nueva función de negocio permitirá realizar verdaderas transacciones de servicio web B2B entre los socios y Autodesk.

Para que los socios disfruten de una implementación eficaz de la plataforma de servicios digitales de Autodesk, las filiales deberán familiarizarse con los servicios web de REST, OAuth y JSON. En un documento llamado Guía a la programación, se ofrece un ejemplo de aplicación cliente (escrita en lenguaje Ruby) que ayudará a los desarrolladores de las filiales a usar la API del servicio digital.

1.2 Documentación complementaria • Guía para desarrolladores de socios de Autodesk: esta guía ayudará a los socios en su

proceso de incorporación y acceso a los servicios de DDWS. La guía sirve también para presentar a los socios la plataforma de servicios digitales de Autodesk, con instrucciones paso a paso que les guiarán a través de las actividades iniciales necesarias para la integración.

• Documentación de la API de autenticación: este documento guía a los socios a través del proceso de generación de credenciales, firmas y tokens de acceso necesarios para utilizar las API del servicio. También contiene información para el desarrollo de la aplicación de integración de un socio. Proporciona información básica acerca de la integración del servicio web y muestra el desarrollo de una aplicación típica.

2 Para empezar

Como parte del proceso de incorporación, los socios deberán estar asociados con un único número específico del cliente (CSN, del inglés Customer Specific Number) y su aplicación deberá estar registrada con Autodesk. Para obtener más información sobre el proceso de incorporación, consulte la Guía para desarrolladores de socios de Autodesk.

Page 5: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

5 | Manual de referencia del servicio web

3 Descripción general del servicio GetOrderDetails

El servicio GetOrderDetails proporcionará a los socios información detallada del pedido, incluyendo los números de contrato, números de serie e información de productos, entre otros campos. Estos datos se incluirán en un formato sin procesar y estarán disponibles para ser consumidos por un sistema de la elección del socio. Este documento incluirá todos los escenarios del servicio GetOrderDetails que reúnan los requisitos para recuperar información del pedido dentro del entorno de Autodesk.

Existen dos operaciones definidas en este servicio para la extracción de pedidos que se activan en función de la entrada proporcionada en el servicio GetOrderDetails:

• GetOrderList • GetOrderDetails

Page 6: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

6 | Manual de referencia del servicio web

3.1 GetOrderList La finalidad de esta operación es obtener la lista de pedidos de un sistema backend si la entrada solo incluye un intervalo de fechas. La respuesta incluirá datos que permitirán a un socio volver a solicitar el servicio con el fin de obtener detalles de los pedidos. Una vez que el solicitante recibe la respuesta y recupera la información que necesita, llamará a GetOrderDetails usando como entradas el número de cliente, el número de pedido de compra o el número de pedido de ventas. Las siguientes entradas son necesarias para ejecutar la operación:

1. customer_number

2. order_date_from

3. order_date_to

3.2 GetOrderDetails La finalidad de esta operación es obtener los detalles de los pedidos para una entrada dada. A esta operación se la puede llamar mediante los siguientes conjuntos de entradas:

1. customer_number 2. Solo uno de los siguientes:

a. serial_number b. contract_number c. partner_po d. customer_po e. order_number

Nota: Solo se rellenará un pedido válido como parte de la respuesta de la API de GetOrderDetails.

3.3 Ventajas del servicio GetOrderDetails 1. Un servicio web de REST optimizado que se puede consumir fácilmente desde cualquier aplicación a

través de una conexión HTTP(s). 2. Estado de pedido en tiempo real e información de seguimiento. 3. La capacidad de tener información sobre el pedido en cuanto esté disponible.

Page 7: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

7 | Manual de referencia del servicio web

4 Información de referencia del servicio GetOrderDetails

4.1 Esquema de solicitud Los detalles de los parámetros del mensaje de solicitud están en la tabla siguiente para GetOrderDetails.

Elemento Tipo de

campo Longitud/formato de

entrada Utilización

Elem

ento

s de

G

etO

rder

List

() customer_number Cadena Longitud: máx. 10 caracteres

Obligatorio

order_date_from Fecha Formato: ISO 8601 AAAA-MM-DD Obligatorio

order_date_to Fecha

Formato: ISO 8601 AAAA-MM-DD

(Intervalo de fechas limitado a 90 días)

Obligatorio

Elem

ento

s de

G

etO

rder

Deta

ils()

customer_number Cadena Longitud: máx. 10 caracteres Obligatorio

contract_number Cadena Longitud: máx. 12 caracteres

Solo se puede pasar uno junto

con customer_number

partner_po Cadena Longitud: máx. 35 caracteres

customer_po Cadena Longitud: máx. 35 caracteres

order_number Cadena Longitud: 10 caracteres

serial_number Cadena Longitud: máx. 12 caracteres

4.2 Esquema de respuesta 4.2.1 GetOrderList

Para el envío del intervalo de fechas, se muestran las siguientes columnas.

Campo Tipo de campo

Longitud y formato de salida

Descripción

sales_order_number Cadena Longitud: máx. 10 caracteres

Número de pedido de SAP

Generado por los sistemas de Autodesk.

purchase_order_number Cadena Longitud: máx. 35 caracteres

Número de pedido de compra

Generado por el distribuidor y enviado con la solicitud de PlaceOrder.

Page 8: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

8 | Manual de referencia del servicio web

order_date Fecha Formato: ISO 8601 AAAA-MM-

DDThh:mm:ss+00:00 (p. ej. 2016-06-

06T17:51:00+0000)

Fecha de procesamiento del pedido

customer_po_number Cadena Longitud: máx. 35 caracteres

Número de pedido de compra del cliente

Pertenece al distribuidor que realiza el pedido mediante otro distribuidor.

document_type Cadena Longitud: máx. 10 caracteres

Tipo de documento

customer_number Cadena Longitud: máx. 10 caracteres

Número de cliente

customer_name Cadena Longitud: máx. 35 caracteres

Nombre de cliente

status Cadena Respuesta de confirmación: "Completado", "Abierto"

Estado del pedido.

tracking_number Cadena Longitud: máx. 35 caracteres

Número de seguimiento

4.2.2 GetOrderDetails Campo Tipo de

campo Longitud y formato de salida

Descripción

status Cadena Respuesta de confirmación: "OK", "FAILED", "ERROR"

Estado de la solicitud

order_header_array [Matriz de objetos JSON] Campo Descripción order_date Cadena Formato: ISO 8601

AAAA-MM-DDThh:mm:ss+00:00

(p. ej. 2016-06-06T17:51:00+0000)

Fecha de procesamiento del pedido

sales_order_number Cadena Longitud: máx. 10 caracteres

Número de pedido de SAP

Generado por los sistemas de Autodesk. purchase_order_number Cadena Longitud: máx. 35

caracteres Número de pedido de compra

Generado por el distribuidor y enviado con la solicitud de PlaceOrder.

customer_po_number Cadena Longitud: máx. 35 caracteres

Número de pedido de compra del cliente

Pertenece al distribuidor que realiza el pedido mediante otro distribuidor.

document_type Cadena Longitud: máx. 10 caracteres

Tipo de documento

Page 9: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

9 | Manual de referencia del servicio web

customer_number Cadena Longitud: máx. 10 caracteres

Número de cliente

customer_name Cadena Longitud: máx. 35 caracteres

Nombre de cliente

order_status Cadena Longitud: máx. 20 caracteres

Estado del pedido.

tracking_number Cadena Longitud: máx. 35 caracteres

Número de seguimiento

order_amount Cadena Longitud: máx. 15 caracteres

Importe del pedido

Es el precio total del pedido, que es igual al precio de los productos del pedido inicial sumado al precio de los mismos productos para el siguiente período. El segundo precio se facturará en el siguiente período de facturación.

tax_amount Cadena Longitud: máx. 13 caracteres

Importe de los impuestos

contract_number Cadena Longitud: 12 caracteres máx.

Número de contrato

Es un número exclusivo asociado al pedido principal.

shipment_method Cadena Longitud: máx. 20 caracteres

Método de envío

freight_charge Cadena Longitud: máx. 15 caracteres

Tasa por mercancías

purchase_order_date Cadena Formato: ISO 8601 AAAA-MM-

DDThh:mm:ss+00:00 (p. ej. 2016-06-

06T17:51:00+0000)

Fecha del pedido de compra

contract_start_date Cadena Formato: ISO 8601 AAAA-MM-

DDThh:mm:ss+00:00 (p. ej. 2016-06-

06T17:51:00+0000)

Fecha de inicio del contrato

Es la fecha en la que se iniciará la facturación. Es igual a la fecha del pedido, a menos que el pedido se realice con una fecha de inicio posterior.

contract_end_date Cadena Formato: ISO 8601 AAAA-MM-

DDThh:mm:ss+00:00 (p. ej. 2016-06-

06T17:51:00+0000)

Fecha de finalización del contrato

Es la fecha en la que finaliza la suscripción. Para pedidos periódicos, este campo será igual a XXXXX.

contract_usage_type Cadena Longitud: máx. 3 caracteres

Tipo de uso del contrato

recurring_po Cadena Longitud: máx. 40 caracteres

Número de pedido de compra periódico

order_items_array [Matriz de objetos JSON] sales_order_number Cadena Longitud: máx. 10

caracteres Número de pedido de ventas

line_number Cadena Longitud: máx. 6 caracteres

Número de línea

Page 10: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

10 | Manual de referencia del servicio web

Item_po_number Cadena Longitud: máx. 40 caracteres

Número de pedido de compra del elemento

Es el número de pedido generado por el distribuidor y se envía en la solicitud de PlaceOrder. Si el elemento de línea se genera durante el pedido inicial, el valor será igual al de purchase_order_number en el nivel de encabezado. De lo contrario, si un producto se añade al mismo contrato posteriormente, contendrá el número del pedido de compra de esta solicitud.

sku Cadena Longitud: máx. 18 caracteres

Número del material

Es el número para identificar el producto que se va a pedir. El formato de este campo es similar que se encuentra en "001H1-007778-T275".

sku_description Cadena Longitud: máx. 60 caracteres

Descripción del material

Es la descripción del producto que se va a pedir.

quantity Entero Longitud: máx. 15 caracteres

Cantidad

unit_price Cadena Longitud: máx. 11 caracteres

Precio por unidad

Representa el precio de un puesto.

order_currency Cadena Longitud: máx. 5 caracteres

Moneda

La moneda del valor monetario en el pedido, la cual se define según la configuración regional del distribuidor que realiza el pedido.

net_value Cadena Longitud: máx. 15 caracteres

Valor neto

product_key Cadena Longitud: máx. 30 caracteres

Clave de producto

group_name Cadena Longitud: máx. 35 caracteres

Nombre del grupo

serial_number Cadena Longitud: máx. 1.300 caracteres

Está vacío si el pedido se realiza para renovar o añadir puestos

Generado por Autodesk para identificar el producto de forma exclusiva.

current_serial_number Cadena Longitud: máx. 130 caracteres

Está vacío si se trata de un pedido inicial o se realiza para añadir productos

seats Cadena Longitud: máx. 10 caracteres

Número de puestos

Para los pedidos de suscripción, este campo siempre es igual a 1. Para las licencias perpetuas, este campo representa el número de puestos de la licencia.

Page 11: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

11 | Manual de referencia del servicio web

deployment Cadena Longitud: máx. 1 caracteres

Implantación

license_type Cadena Longitud: máx. 30 caracteres

Tipo de licencia

usage_type Cadena Longitud: máx. 3 caracteres

Tipo de uso

license_description Cadena Longitud: máx. 155 caracteres

Descripción de la licencia

subs_id Cadena Longitud: máx. 48 caracteres

ID de suscripción, solo periódica

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

Fecha de inicio de facturación

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

Fecha de finalización de facturación

billing_status Cadena Estado de la facturación item_cancellation_transaction_date

Cadena Formato: ISO 8601 AAAA-MM-

DDThh:mm:ss+00:00 (p. ej. 2016-06-

06T17:51:00+0000)

Fecha de la transacción de cancelación del elemento

cancellation_reason Cadena Longitud: máx. 40 caracteres

Motivo de la cancelación

sales_licence_type Cadena Longitud: máx. 30 caracteres

"Nuevo" o " Renovación"

order_partners_array [Matriz de objetos JSON] sales_order_number Cadena Longitud: máx. 10

caracteres Número de pedido de ventas

line_number Cadena Longitud: máx. 6 caracteres

Número de línea

partner_type Cadena Longitud: máx. 15 caracteres

Para cada tipo de distribuidor, se muestra toda la información correspondiente. Los tipos de distribuidores son: persona de contacto, proveedor, usuario final, a quien se factura, a quien se envía y responsable del contrato

partner_number Cadena Longitud: máx. 10 caracteres

Número de distribuidor

contact_number Cadena Longitud: máx. 10 caracteres

Número del contacto

partner_name Cadena Longitud: máx. 80 caracteres

Nombre del distribuidor

street Cadena Longitud: máx. 30 caracteres

Calle

street_2 Cadena Longitud: máx. 40 caracteres

Línea 2 de la dirección

street_3 Cadena Longitud: máx. 40 caracteres

Línea 3 de la dirección

Page 12: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

12 | Manual de referencia del servicio web

po_box Cadena Longitud: máx. 10 caracteres

Apdo. de correos

city Cadena Longitud: máx. 25 caracteres

City

postal_code Cadena Longitud: máx. 10 caracteres

Código postal

pobox_postal_code Cadena Longitud: máx. 10 caracteres

Código postal correspondiente al apartado de correos

country Cadena Longitud: máx. 15 caracteres

País

district Cadena Longitud: máx. 25 caracteres

Distrito

region Cadena Longitud: máx. 3 caracteres

Región

end_user_email Cadena Longitud: máx. 241 caracteres

Correo electrónico

assetdetailslist [Matriz de objetos JSON] serialnumber Cadena Longitud: máx. 18

caracteres Todos los números de serie asociados al pedido

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

Fecha de registro de cada número de serie

activity [Matriz de objetos JSON]

Elemento de assetdetailslist, lista de pista de auditoría

type Cadena Longitud: máx. 15 caracteres

Eliminar puesto. Esta sección se rellenará para escenarios de eliminación de puestos.

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

Fecha y hora de la eliminación de puestos

previousqty Entero Longitud: máx. 15 caracteres

Cantidad de puestos anterior

newqty Entero Longitud: máx. 15 caracteres

Nueva cantidad de puestos

welcomekitstatus Cadena Longitud: máx. 100

caracteres "Enviado", "No enviado"

Nota: Como el servicio GetOrderDetails ya existe, el campo Estado del kit de bienvenida (welcomekitstatus) regresará a la respuesta por defecto "No enviado". Este indicador se actualizará en el futuro cuando se complete el desarrollo del servicio GetOrderDetails.

4.3 Esquema de error Nombre de campo Descripción

status Respuesta de confirmación: “OK”, “FAILED”, “ERROR” message Mensaje para fallo o errores transactionid ID de transacción único (combinación de número de pedido y marca

de hora). Solo se devolverá en caso de ejecución correcta.

Page 13: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

13 | Manual de referencia del servicio web

4.4 Mensajes de solicitud A continuación se muestran solicitudes de ejemplos de GetOrderDetails

4.4.1 Mensaje de solicitud: GetOrderDetails

4.5 Mensaje de respuesta

Nota: Autodesk enviará una respuesta con la siguiente estructura. Los socios pueden cambiar el formato de la respuesta a distintas estructuras en función de sus necesidades.

4.5.1 Mensaje de respuesta –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: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

14 | Manual de referencia del servicio 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", "tracking_number": ""

Page 15: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

15 | Manual de referencia del servicio web

}, { "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", "customer_name": "Sample Name",

Page 16: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

16 | Manual de referencia del servicio web

"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: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

17 | Manual de referencia del servicio web

4.5.2 Mensaje de respuesta –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”,

Page 18: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

18 | Manual de referencia del servicio web

"billing_end_date": “2016-01-15T00:00:00+0000”, "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",

Page 19: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

19 | Manual de referencia del servicio web

"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": "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",

Page 20: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

20 | Manual de referencia del servicio web

"pobox_postal_code": "", "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 }, {

Page 21: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

21 | Manual de referencia del servicio web

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

}

4.6 Mensajes de error La siguiente tabla muestra los códigos de error y sus respectivos mensajes de error presentes en los

mensajes de respuesta si se detecta un error:

Número de mensaje

Mensaje de error

003 No se encuentra &. 013 El parámetro de entrada no está completo. 015 No se encuentra el número de pedido 016 No se encuentra el número de pedido 017 El número de serie proporcionado no es válido 018 La duración debe ser inferior a noventa (90) días UAN-GEN-00119 El número de serie proporcionado no está en el formato correcto UAN-GEN-00108 Indique el número de cliente UAN-GEN-00108 Introduzca la "Fecha de inicio" en formato AAAA-MM-DD UAN-GEN-00119 Introduzca la "Fecha de inicio" en formato AAAA-MM-DD UAN-GEN-00108 Introduzca la "Fecha de fin" en formato AAAA-MM-DD UAN-GEN-00119 Introduzca la "Fecha de fin" en formato AAAA-MM-DD UAN-INV-00002 La "Fecha de inicio" debe ser anterior a la "Fecha de fin" UAN-GEN-00141 El intervalo de fechas no debe ser superior a 90 días. Compruebe la entrada y vuelva

a intentarlo UAN-GEN-00119 Número de cliente no válido. Compruebe la entrada y vuelva a intentarlo UAN-GEN-00123 El número de cliente no puede superar los 10 caracteres. Compruebe la entrada y

vuelva a intentarlo UAN-GEN-00119 Proporcione una combinación válida de parámetros UAN-GEN-00119 Introduzca los nombres de parámetros correctos UAN-GEN-00108 Introduzca el número de pedido u otro número de documento válido. UAN-GEN-00123 El número de pedido debe tener 10 caracteres exactamente. Compruebe la entrada y

vuelva a intentarlo UAN-GEN-00123 Número de pedido de compra no puede superar los 35 caracteres. Compruebe la

entrada y vuelva a intentarlo Introduzca al menos uno de los siguientes parámetros: SerialNumber,

Page 22: Servicios web de distribución digital (DDWS ... · PDF file... números de serie e información de ... Los detalles de los parámetros del mensaje de solicitud están en la tabla

22 | Manual de referencia del servicio web

ContractNumber, OrderNumber o PONumber El número de serie proporcionado no es válido APG-DWS-INV-002 El número de cliente proporcionado no es válido. UAN-GEN-00123 Pedido de compra de socio no puede superar los 35 caracteres. Compruebe la

entrada y vuelva a intentarlo UAN-GEN-00123 Número de contrato no puede superar los 12 caracteres. Compruebe la entrada y

vuelva a intentarlo

4.6.1 Ejemplo de respuesta de error

Nota: Este Manual de referencia del servicio es para uso exclusivo de los destinatarios a los que se dirige y puede contener información propietaria o confidencial que pueda ser información reservada o estar protegida frente a la divulgación. Queda totalmente prohibida cualquier revisión, uso, difusión o distribución no autorizados.

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