Digital Distribution Web Services (DDWS) … · and cancellation_reason to order_items_array. ... Line Number . 10 ... Web Service Reference Manual deployment String Length:

Digital Distribution Web Services (DDWS) GetOrderDetails - Service Manual

2 | Web Service Reference Manual

CONTENTS Revision History ..................................................................................................................................................... 2

1 Introduction ..................................................................................................................................................... 4

1.1 Overview ................................................................................................................................................ 4

1.2 Supporting documents ........................................................................................................................... 4

2 Getting Started ............................................................................................................................................... 4

3 GetOrderDetails Service Overview ................................................................................................................ 5

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

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

3.3 Benefits of GetOrderDetails Service ..................................................................................................... 6

4 GetOrderDetails Service Reference Information ........................................................................................... 6

4.1 Request Schema ................................................................................................................................... 6

4.2 Response Schema ................................................................................................................................ 7

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

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

4.3 Error Schema....................................................................................................................................... 12

4.4 Request Messages .............................................................................................................................. 12

4.4.1 Request Message - GetOrderDetails .............................................................................................. 13

4.5 Response Message ............................................................................................................................. 13

4.5.1 Response Message –GetOrderList ................................................................................................. 13

4.5.2 Response Message –GetOrderDetails ............................................................................................ 17

4.6 Error Messages ................................................................................................................................... 21

4.6.1 Sample Error Response .................................................................................................................. 22

Revision History Version Date Author Comments

3.2 10/22/2015 AR Added Revision History section

3.3 12/04/2015 AR Updated Section 4.5.2 to reflect changes in the Response Schema


3.4 12/21/2015 AR • Added serial_number under section 3.2

• Modified response message under section 4.5.1

• Modified response message under section 4.5.2

3.5 02/23/2016 RL • Add fields item_po_number, billing_start_date,

billing_end_date,

billing_status,item_cancellation_transaction_date,

and cancellation_reason to order_items_array.

3.6 02/23/2016 RL • Add field recurring_po to order_header_array.

3.7 02/23/2016 ER • Add field sales_licence_type to order_items

description

3.8 03/31/2016 PL • Added Street_2 and Street_3 to section 4.2.2

3.9 5/2/2016 PL • Added fields activity, type, transactiondate,

previousqty, newqty to section 4.2.2 and updated

example response in 4.5.2

3.10 6 June 2016 FX • Added field type and output lenght/format in

section 4.2.1 and 4.2.2

3.11 18 July 2016 JC • Added field unit_discount at item level in section

4.2.2 and updated example response in 4.5.2


1 Introduction

1.1 Overview

The Digital Distribution Web Service (DDWS) platform is an automation solution for order placement made directly from our Partners to Autodesk, all with low touch from Partners and zero touch from Autodesk. This new business capability will allow for true B2B web service transactions between Partners and Autodesk.

For Partners to have effective implementation of Autodesk’s Digital Services Platform, affiliates will need familiarity with REST web services, oAuth and JSON. A sample client application is provided (written in the Ruby language) in a Programming Guide document, which will help said affiliates’ developers to consume the Digital Service API.

1.2 Supporting documents

• Autodesk Partner Developer Guide: This guide helps Partners with their onboarding process and accessing DDWS services. The guide also serves to introduce Partners to Autodesk’s Digital Services Platform, using step-by-step instructions that guide them through the initial activities required for integration.

• Authentication API Documentation: This document guides Partners through the process of generating credentials, signatures, and access tokens necessary for utilizing Service APIs. It also contains information for the development of a Partner’s integrating application. It provides basic understanding of web service integration and demonstrates the development of a typical application.

2 Getting Started

As part of the onboarding process, Partners will be associated with a unique Customer Specific Number (CSN) and will have their application registered with Autodesk. For more details on the onboarding process, please refer to the Autodesk Partner Developer Guide.


3 GetOrderDetails Service Overview

The GetOrderDetails service will provide Partners with detailed order information, including contract numbers, serial numbers, and product information, among other fields. This data will be in a raw format

and it will be available to be consumed by a Partner’s system of choice. This document will include all scenarios of the GetOrderDetails service which are eligible for retrieving order information within the Autodesk environment.

There are two operations defined in this service for fetching orders, activated depending on the input provided to the GetOrderDetails service:


• GetOrderList

• GetOrderDetails

3.1 GetOrderList

The purpose of this operation is to get the order list from a back end system if the input only includes a date range. The response will include data that will allow a Partner to re-query the service in order to get order details. Once the requester receives the response and retrieves the information he or she needs from it, he or she will call GetOrderDetails using Customer Number/Purchase Order Number/Sales Order Number as inputs. The following inputs are required to invoke the operation:

1. customer_number

2. order_date_from

3. order_date_to

3.2 GetOrderDetails

The purpose of this operation is to get the order details for a given input. This operation can be called using the following sets of inputs:

1. customer_number

2. Only one of the following:

a. serial_number

b. contract_number

c. partner_po

d. customer_po

e. order_number

Note: Only a valid order will be populated as part of the GetOrderDetails API response.

3.3 Benefits of GetOrderDetails Service

1. A lightweight REST web service that can be consumed easily from any application via HTTP(s)

connection.

2. Real time order status and tracking information.

3. The ability to have information about the order as soon as it is available.

4 GetOrderDetails Service Reference Information

4.1 Request Schema

The details of the Request Message Parameters are in the following table for GetOrderDetails.

Element Field Type

Input Length/Format Utilization


GetO

rderL

ist(

) E

lem

en

ts

customer_number

String

Length: Max 10

Characters

Mandatory

order_date_from

Date

Format: ISO 8601

YYYY-MM-DD

Mandatory

order_date_to

Date

Format: ISO 8601

YYYY-MM-DD (Date Range Limited to

90 Days)

Mandatory

GetO

rderD

eta

ils()

Ele

men

ts

customer_number

String

Length: Max 10

Characters

Mandatory

contract_number

String

Length: Max 12 Characters

Only one can be passed along with customer_number

partner_po

String

Length: Max 35 Characters

customer_po String Length: Max 35

Characters

order_number

String

Length: 10 characters

serial_number String Length: Max 12

characters

4.2 Response Schema

4.2.1 GetOrderList

For date range submission, the following columns will be displayed.

Field Field Type Output Length/Format

Description

sales_order_number String Length: Max 10 Characters

SAP Order Number

Generated by Autodesk systems.

purchase_order_number String Length: Max 35 Characters

Purchase Order Number

Generated by the Partner and sent within PlaceOrder request.

order_date Date Format: ISO 8601 Order processed date


YYYY-MM-DD Thh:mm:ss+00:00

(e.g. 2016-06-06T17:51:00+0000)

customer_po_number String Length: Max 35 Characters

Customer Purchase Order Number

Belongs to the reseller who places the order via another reseller/distributor.

document_type String Length: Max 10 Characters

Document Type

customer_number String Length: Max 10 Characters

Customer Number

customer_name String Length: Max 35 Characters

Name of Customer

status String Confirmation response: “Completed”, “Open”

Order Status

tracking_number String Length: Max 35 Characters

Tracking Number

4.2.2 GetOrderDetails

Field Field Type

Output Length/Format

Description

status String Confirmation response: “OK”, “FAILED”, “ERROR”

Request Status

order_header_array [Array of JSON Objects]

Field Description

order_date String Format: ISO 8601 YYYY-MM-DD

Thh:mm:ss+00:00 (e.g. 2016-06-

06T17:51:00+0000)

Order Processed Date


SAP Order Number

Generated by Autodesk systems.

purchase_order_number String Length: Max 35 Characters

Purchase Order Number

Generated by the Partner and sent within PlaceOrder request.

customer_po_number String Length: Max 35 Characters

Customer Purchase Order Number

Belongs to the reseller who places the order via another reseller/distributor.

document_type String Length: Max 10 Characters

Document Type


customer_number String Length: Max 10 Characters

Customer Number

customer_name String Length: Max 35 Characters

Customer Name

order_status String Length: Max 20 Characters

Order Status

tracking_number String Length: Max 35 Characters

Tracking Number

order_amount String Length: Max 15 Characters

Order Amount

Is the total price of the order, which equals the price of the products in the initial order plus the price of those products for the next term. The latter will be invoiced next billing period.

tax_amount String Length: Max 13 Characters

Tax Amount

contract_number String Length: Max 12 Characters

Contract Number

Is a unique number associated with the master order.

shipment_method String Length: Max 20 Characters

Shipment Method

freight_charge String Length: Max 15 Characters

Freight Charge

purchase_order_date String Format: ISO 8601 YYYY-MM-DD

Thh:mm:ss+00:00 (e.g. 2016-06-

06T17:51:00+0000)

Purchase Order Date

contract_start_date String Format: ISO 8601 YYYY-MM-DD

Thh:mm:ss+00:00 (e.g. 2016-06-

06T17:51:00+0000)

Contract Start Date

Is the date when the billing will start. This is equal to order date unless the order is placed with a future start date.

contract_end_date String Format: ISO 8601 YYYY-MM-DD

Thh:mm:ss+00:00 (e.g. 2016-06-

06T17:51:00+0000)

Contract End Date

Is the date when the subscription will be terminated. For recurring orders, this field will be equal to XXXXX.

contract_usage_type String Length: Max 3 Characters

Contract Usage Type

recurring_po String Length: Max 40 Characters

Recurring PO Number

order_items_array [Array of JSON Objects]


Sales Order Number

line_number String Length: Max 6 Characters

Line Number


Item_po_number String Length: Max 40 Characters

Item PO Number

Is the order number generated by the Partner and sent within the PlaceOrder request. If the line item is generated during the initial order, the value will be equal to that of purchase_order_number at the header level. Otherwise, if a product is added to the same contract later on, it will contain the purchase order number of this request.

sku String Length: Max 18 Characters

Material Number

Is the number to identify the product being ordered. The format of this field is like the one below "001H1-007778-T275"

sku_description String Length: Max 60 Characters

Material Description

Is the description of the product that is being ordered.

quantity Integer Length: Max 15 Characters

Quantity

unit_price String Length: Max 11 Characters

Price per unit

Represents the price of one seat.

unit_discount String Length: Max 11 Characters

Discount per unit

Represents the discount of one seat

order_currency String Length: Max 5 Characters

Currency

Is the currency of the monetary value in the order, and is defined based on the locale of the Partner placing the order.

net_value String Length: Max 15 Characters

Net Value

product_key String Length: Max 30 Characters

Product Key

group_name String Length: Max 35 Characters

Group Name

serial_number String Length: Max 1300 Characters

Empty if the order is a Renewal or Add Seats

Generated by Autodesk to uniquely identify the product.

current_serial_number String Length: Max 130 Characters

Empty if the order is an Initial Order or Add Products

seats String Length: Max 10 Characters

Number of seats

For Subscription Orders, this field is always equal to 1. For perpetual licenses, it represents the seat number under the license.


deployment String Length: Max 1 Characters

Deployment

license_type String Length: Max 30 Characters

License Type

usage_type String Length: Max 3 Characters

Usage Type

license_description String Length: Max 155 Characters

License Description

subs_id String Length: Max 48 Characters

Subscription ID, Recurring Only

billing_start_date String Format: ISO 8601 YYYY-MM-DD Thh:mm:ss+00:00

Billing Start Date

billing_end_date String Format: ISO 8601 YYYY-MM-DD Thh:mm:ss+00:00 (e.g. 2016-06-06T17:51:00+0000)

Billing End Date

billing_status String Billing Status

item_cancellation_transaction_date

String Format: ISO 8601 YYYY-MM-DD

Thh:mm:ss+00:00 (e.g. 2016-06-

06T17:51:00+0000)

Item Cancellation Transaction Date

cancellation_reason String Length: Max 40 Characters

Cancellation Reason

sales_licence_type String Length: Max 30 Characters

“New” or “Renewal”

order_partners_array [Array of JSON Objects]


Sales Order Number

line_number String Length: Max 6 Characters

Line Number

partner_type String Length: Max 15 Characters

For each partner type, all the corresponding information will be displayed. Partner types are: Contact Person, Dealer, End User, Bill to, Ship to, Contract Mgr.

partner_number String Length: Max 10 Characters

Partner Number

contact_number String Length: Max 10 Characters

Contact Number

partner_name String Length: Max 80 Characters

Partner Name

street String Length: Max 30 Characters

Street

street_2 String Length: Max 40 Characters

Address Line 2

street_3 String Length: Max 40 Characters

Address Line 3

po_box String Length: Max 10 Characters

PO Box


city String Length: Max 25 Characters

City

postal_code String Length: Max 10 Characters

Postal Code

pobox_postal_code String Length: Max 10 Characters

Postal Code Corresponding to PO Box

country String Length: Max 15 Characters

Country

district String Length: Max 25 Characters

District

region String Length: Max 3 Characters

Region

end_user_email String Length: Max 241 Characters

Email

assetdetailslist [Array of JSON Objects]

serialnumber String Length: Max 18 Characters

All serial numbers associated to the order

registereddate String Format: ISO 8601 YYYY-MM-DD Thh:mm:ss+00:00

Registered date for each serial number

activity [Array of JSON Objects]

Element of assetdetailslist, audit trail list

type String Length: Max 15 Characters

Remove seat. This section will be populated for remove seat scenarios.

transactiondate String Format: ISO 8601 YYYY-MM-DD Thh:mm:ss+00:00

Date and time of seat removal

previousqty Integer Length: Max 15 Characters

Previous seat quantity

newqty Integer Length: Max 15 Characters

New seat quantity

welcomekitstatus String Length: Max 100 Characters

“Sent”, “Not Sent”

Note: As the GetOrderDetails Service exists now, the Welcome Kit Status field (welcomekitstatus) will return the default response "Not Sent”. This flag will be updated in the future when full development of the GetOrderDetails Service is completed.

4.3 Error Schema

Field Name Description

status Confirmation response: “OK”, “FAILED”, “ERROR”

message Message for failure or errors

transactionid Unique transaction id (combination of order number and time stamp). Only returned in case of success.

4.4 Request Messages

Below are sample requests for GetOrderDetails


4.4.1 Request Message - GetOrderDetails

4.5 Response Message

Note: Autodesk will send a response with the following structure. Partners can reformat this to different structures based on their need.

4.5.1 Response Message –GetOrderList

{ "status": "OK", "message": { "elements": [ { "order_list_array": [ { "sales_order_number": "7044892531", "purchase_order_number": "PONFRtes", "order_date": "2015-12-01T00:00:00+0000",

[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>>


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


4.5.2 Response Message –GetOrderDetails

{ "status": "OK", "message": {"elements": [ { "order_header_array": [ { "order_date": "2016-07-18T00:00:00+0000", "sales_order_number": "7055800683", "purchase_order_number": "JEM-REN-Jul18 PRUEBA_0001", "customer_po_number": "custPO JEM-REN-Jul18 PRUEBA_0001", "document_type": "GG Standard Order", "customer_number": "5125015587", "customer_name": "KCCGJCGDPJHMHJBKPBEDPEOHDAKIEHAD", "order_status": "Open", "tracking_number": "", "order_amount": "2,402.40", "tax_amount": "0.00", "contract_number": "110350004615", "shipment_method": "FDIDLNBAPOIFMJGOGPLD", "freight_charge": "0.00", "purchase_order_date": "2016-07-18T00:00:00+0000", "contract_start_date": "2016-07-18T00:00:00+0000", "contract_end_date": "2017-07-17T00:00:00+0000", "contract_usage_type": "COM", "recurring_po": "" }], "order_items_array": [ { "sales_order_number": "7055800683", "line_number": "000010", "item_po_number": "JEM-REN-Jul18 PRUEBA_0001", "sku": "765H1-WW4127-T897", "sku_description": "BDSP 2016 TBP:PA SUB WW ELD", "quantity": 1, "order_currency": "USD", "unit_price": "2,730.00", "unit_discount": "327.60-", "net_value": "2,402.40", "product_key": "765H1", "group_name": "", "serial_number": "561-03498320", "current_serial_number": "", "seats": "1", "deployment": "S", "license_type": "NOT APPLICABLE", "usage_type": "COM", "license_description": "Autodesk Building Design Suite Premium 2016", "subs_id": "", "billing_start_date": null, "billing_end_date": null, "billing_status": "N/A", "item_cancellation_transaction_date": null, "cancellation_reason": "",


"sales_license_type": "New" }], "order_partners_array": [ { "sales_order_number": "7055800683", "line_number": "000000", "partner_type": "Contact Person", "partner_number": "", "contact_number": "0019409152", "partner_name": "Eddie The Eagle", "street": "JJOPDAEJMHAFNPBGKCPCOENGLNFMGC", "street_2": "", "street_3": "", "po_box": "JJOPDAEJMH", "city": "San Rafael", "postal_code": "94903", "pobox_postal_code": "94903", "country": "US", "district": "", "region": "CA", "end_user_email": "" }, { "sales_order_number": "7055800683", "line_number": "000000", "partner_type": "Dealer", "partner_number": "0070176520", "contact_number": "0000000000", "partner_name": "NOFCMIEAEFKLMLPHIEGGOMOOMHMMIBNH JJOPDAEJMHAFNPBGKCPCOENGLNFMGCCM", "street": "OEECHGIHNFOJALFENFDBMIPKBIEPCJ", "street_2": "", "street_3": "", "po_box": "JJOPDAEJMH", "city": "Mississauga", "postal_code": "L5N 8G1", "pobox_postal_code": "L5N 8G1", "country": "CA", "district": "", "region": "ON", "end_user_email": "" }, { "sales_order_number": "7055800683", "line_number": "000000", "partner_type": "End User", "partner_number": "5125015587", "contact_number": "0000000000", "partner_name": "KCCGJCGDPJHMHJBKPBEDPEOHDAKIEHAD JJOPDAEJMHAFNPBGKCPCOENGLNFMGCCM", "street": "JJOPDAEJMHAFNPBGKCPCOENGLNFMGC", "street_2": "", "street_3": "",


"po_box": "JJOPDAEJMH", "city": "San Rafael", "postal_code": "94903", "pobox_postal_code": "94903", "country": "US", "district": "", "region": "CA", "end_user_email": "" }, { "sales_order_number": "7055800683", "line_number": "000000", "partner_type": "Bill to", "partner_number": "0070176510", "contact_number": "0000000000", "partner_name": "Test-Tech Data Prod MGT Commercial", "street": "5350 Tech Data Dr", "street_2": "", "street_3": "", "po_box": "", "city": "Clearwater", "postal_code": "33760-3122", "pobox_postal_code": "", "country": "US", "district": "PINELLAS", "region": "FL", "end_user_email": "" }, { "sales_order_number": "7055800683", "line_number": "000000", "partner_type": "Ship to", "partner_number": "5125015584", "contact_number": "0000000000", "partner_name": "KCCGJCGDPJHMHJBKPBEDPEOHDAKIEHAD JJOPDAEJMHAFNPBGKCPCOENGLNFMGCCM", "street": "JJOPDAEJMHAFNPBGKCPCOENGLNFMGC", "street_2": "", "street_3": "", "po_box": "JJOPDAEJMH", "city": "San Rafael", "postal_code": "94903", "pobox_postal_code": "94903", "country": "US", "district": "", "region": "CA", "end_user_email": "" }, { "sales_order_number": "7055800683", "line_number": "000000", "partner_type": "Contract Mgr", "partner_number": "5125015586",


"contact_number": "0000000000", "partner_name": "KCCGJCGDPJHMHJBKPBEDPEOHDAKIEHAD JJOPDAEJMHAFNPBGKCPCOENGLNFMGCCM", "street": "JJOPDAEJMHAFNPBGKCPCOENGLNFMGC", "street_2": "", "street_3": "", "po_box": "JJOPDAEJMH", "city": "San Rafael", "postal_code": "94903", "pobox_postal_code": "94903", "country": "US", "district": "", "region": "CA", "end_user_email": "" }, { "sales_order_number": "7055800683", "line_number": "000010", "partner_type": "Contract Mgr", "partner_number": "EU3000", "contact_number": "0000000000", "partner_name": "KCCGJCGDPJHMHJBKPBEDPEOHDAKIEHAD JJOPDAEJMHAFNPBGKCPCOENGLNFMGCCM", "street": "JJOPDAEJMHAFNPBGKCPCOENGLNFMGC", "street_2": "", "street_3": "", "po_box": "JJOPDAEJMH", "city": "San Rafael", "postal_code": "94903", "pobox_postal_code": "94903", "country": "US", "district": "", "region": "CA", "end_user_email": "" } ], "assetdetailslist": [ { "serialnumber": "561-03498320", "registereddate": "2016-07-18T00:00:00.000Z", "activity": [ { "type": "Remove Seat", "transactiondate": "2016-04-28T23:03:52.000Z", "previousqty": "3", "newqty": 2 }, { "type": "Remove Seat", "transactiondate": "2016-04-29T22:17:51.000Z", "previousqty": "2", "newqty": 1 } ]


}], "welcomekitstatus": "Not Sent" }]}

}

4.6 Error Messages

The following table shows error codes and their respective error messages present in response messages should an error be found:

Message Number Error Message

003 & is not found.

013 The input parameter is incomplete.

015 Order Number Not Found

016 Order Number Not Found

017 The Serial Number Provided is not valid

018 Duration should be less than ninety (90) days

UAN-GEN-00119 The Serial Number provided is not in the correct format

UAN-GEN-00108 Please provide Customer number

UAN-GEN-00108 Please enter "From Date" in YYYY-MM-DD format

UAN-GEN-00119 Please enter "From Date" in YYYY-MM-DD format

UAN-GEN-00108 Please enter "To Date" in YYYY-MM-DD format

UAN-GEN-00119 Please enter "To Date" in YYYY-MM-DD format

UAN-INV-00002 "From Date" should be prior than "To Date"

UAN-GEN-00141 Date range must not be more than 90 days. Please check your entry and try again

UAN-GEN-00119 Invalid Customer number. Please check your entry and try again

UAN-GEN-00123 Customer number may not exceed 10 characters. Please check your entry and try again

UAN-GEN-00119 Please provide a valid parameters combination

UAN-GEN-00119 Please provide the right parameters names

UAN-GEN-00108 Please provide Order number or another valid document number.

UAN-GEN-00123 Order number should be exact 10 characters. Please check your entry and try again

UAN-GEN-00123 Purchase Order number may not exceed 35 characters. Please check your entry and try again

Please Provide at least one of the following parameters SerialNumber,ContractNumber,OrderNumber or PONumber

The Serial Number Provided is not valid

APG-DWS-INV-002 Provided customer number is invalid.

UAN-GEN-00123 Partner PO may not exceed 35 characters. Please check your entry and try again

UAN-GEN-00123 Contract Number may not exceed 12 characters. Please check your entry and try again


4.6.1 Sample Error Response

Note: This Service Reference Manual is for the sole use of the intended recipients and may contain proprietary and/or confidential information which may be privileged or otherwise protected from disclosure. Any unauthorized review, use, disclosure or distribution is prohibited.

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

Documents

Digital Distribution Web Services (DDWS) … · and cancellation_reason to order_items_array. ... Line Number . 10 ... Web Service Reference Manual deployment String Length: