Partner Web Services PlaceOrder Version 1 Service Manual Contents 1 Introduction ........................................................................................................................................... 8 1.1 Overview ........................................................................................................................................ 8 1.2 Supporting Resources .................................................................................................................... 8 2 Subscription to Autodesk....................................................................................................................... 8 2.1 Recurring (auto-renew) ................................................................................................................. 9 2.2 Renewable ..................................................................................................................................... 9 3 Service Overview ................................................................................................................................... 9 3.1 Order Fulfillment ......................................................................................................................... 10 3.2 Order Revoke ............................................................................................................................... 10 3.3 SNS Messaging ............................................................................................................................. 10 3.4 GetOrderStatus Service ............................................................................................................... 11 4 Service Endpoints................................................................................................................................. 11 5 Request/Response Schema ................................................................................................................. 11 5.1 Request ........................................................................................................................................ 11 5.1.1 Detailed Request JSON Structure ........................................................................................ 12 5.2 Response ...................................................................................................................................... 24 5.2.1 High-Level Entity Relationship model .................................................................................. 24 5.2.2 Detailed Response JSON Structure ...................................................................................... 25 6 Sample Requests/Responses ............................................................................................................... 27 6.1 Place an Initial Order ................................................................................................................... 27 6.2 Add Seats ..................................................................................................................................... 28 6.3 Add Products................................................................................................................................ 29 6.4 Remove Seats............................................................................................................................... 29 6.5 Remove Products ......................................................................................................................... 30 6.6 Cancel Order ................................................................................................................................ 31 6.7 Generic Error applicable for all request types ............................................................................. 31 7 Formatting standards .......................................................................................................................... 31 8 Error Messages .................................................................................................................................... 32 AUTODESK PlaceOrder v1 Service Reference Manual 2 8.1 System Error codes ...................................................................................................................... 32 8.2 Service Error Code ....................................................................................................................... 32 Tables Table 1: Service endpoints ........................................................................................................................... 11 Table 2: Detailed JSON Request Structure for Initial Orders ....................................................................... 17 Table 3: Detailed JSON Request Structure for Add Seats ............................................................................ 18 Table 4: Detailed JSON Request Structure for Add Product ........................................................................ 21 Table 5: Detailed JSON Request Structure for Removing Seats .................................................................. 21 Table 6: Detailed JSON Request Structure for Removing Products ............................................................ 22 Table 7: Detailed JSON Request Structure for Contract Cancellation ......................................................... 22 Table 9: Detailed JSON Request Structure for Get Order Status ................................................................. 23 Table 10: Detailed JSON Response Structure .............................................................................................. 25 Table 11: Authentication Error Codes ......................................................................................................... 32 Table 12: Place Order v1 Application Error Codes....................................................................................... 37 Figures Figure 1: PlaceOrder v1 process flow .......................................................................................................... 10 AUTODESK PlaceOrder v1 Service Reference Manual 3 Revision History Version Date Author Comments 2.8 AR • Added Section 4.2, 4.7, 5.2 and 5.2.1 – to include the Recurring Billing service 2.9 AR • Updated the previously named Recurring Billing service to Update Recurring Purchase Order and Request URL 3.0 AR • Modified action_name values of Order Fulfillment from “add_seat” and “add_product” to “add_seats” and “add_products” 3.1 AR • Modified Sample Request Message for Order Fulfillment, Initial Order under Section 5.1 to display a sample payload for Recurring subscription models. • Modified Sample Request Message for Order Fulfillment, Initial Order under Section 5.2 to display a sample payload for Renewable subscription models. • Modified Create Initial Order Request Schema under Section 4.1 3.2 AR • Added add_seats Request Schema under section 4.3 • Added add_products Request Schema under section 4.4 • Added renew Request Schema under section 4.5 • Modified initial_order Request Schema under section 4.2 • Added Section 5.3, 5.4, 5.5, 5.6, 5.7 to include Sample Messages for order fulfillment actions: add_seats, add_products and renew 3.3 AR • Updated the sample data from the Sample Messages under Section 5. • Updated “Renew” Request Schema under Section 4.5 to remove “subscription_id”. AUTODESK PlaceOrder v1 Service Reference Manual 4 • Updated “initial_order” request schema under section 4.2 to remove “external_ref_number”. 3.4 AR • Modified request schema date examples to fit the ISO 8601 format • Updated possible “action_name” values for Order Revoke to remove products, remove seats, cancel and return. Note: return is not currently available. • Updated Order Revoke Request Schema under section 4.11 • Added Descriptions for Desktop Subscription Models under section 3.1 • Added “related_account_csn” to Add Seats Request Schema under section 4.3 • Removed “pricing_date” from Add Seats Request Schema under section 4.3 • Modified Error Codes in section 7.1 3.5 AR • Modified sections 4.2-4.5 to reflect the latest request schema • Modified section 4.9 from “po_number” to “reference number” 3.6 RL • Convert all fields named “quantity” to Integer. 3.7 RL • Substitute field ref_document with fields opportunity type and opportunity_number. 3.8 RL • Remove field order_date. • Indicate rules on contract_start_date 3.9 CC • Update Documentation for Status API response schema 3.10 CC • Update SNS to indicate availability for all PlaceOrder services 3.11 PL • Section 4.2 Removed comments from first_name, last_name, email, eu_first_name, eu_last_name, eu_email • Section 4.2 Changed from O to R for first_name, last_name, email, eu_first_name, eu_last_name, eu_email AUTODESK PlaceOrder v1 Service Reference Manual 5 • Section 4.2 edited comment section to only “Provide If Known” for contact_csn, eu_contact_csn • Section 4.2 in comments section for all fields beginning with primary_account, related_account, eu_primary_account added “*Rules apply to Recurring Only” 3.12 PL • Section 4.2, 4.3, 4.4, 4.11 updated all Quantity fields must be a Positive Integer • Section 4.2,4.3, 4.4 updated email and eu_email fields to max characters 80 • Section 4.2, 4.4, 5.1 added Address_Line2 and Address_Line3 for Primary, Eu_Primary, and Related Account fields. 3.13 PL • Removed the following fields from sections 4.2, 4.3, 4.4, 4.5 and their corresponding response messages: item_end_date, contact_csn, eu_csn, contract_end_date,