Mike.robski: 1 revision: Release 92

2014-04-08T17:20:17Z

1 revision: Release 92

Angel.dinev at 11:59, 3 April 2014

2014-04-03T11:59:32Z

New page

= Set and modify an account on a later step when ordering products and services =
This example provides the steps to set order's account on a later step and modify it afterward.

== Create a new order ==
Use [[Orders:POST|POST /orders]] to create a new order

=== Request ===
<nowiki>
POST /orders
Content-Type: application/json; charset=UTF-8

{}
</nowiki>

=== Response ===
<nowiki>
201 Created
Content-Type: application/json; charset=UTF-8
Location : </nowiki>{{APIBaseURL}}<nowiki>/orders/000001452259ee0103d4e652007f000000010001
Set-Cookie : OwnerId=d0977ed2-86e7-4101-adfe-2675ba0e26ac; Path=/

{
"orderId": "000001452259ee0103d4e652007f000000010001",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/000001452259ee0103d4e652007f000000010001", "rel": "item"}
]
}
</nowiki>

== Add a product ==
Use [[Orders-orderId-account-products:POST|POST /orders/{order_id}/account/products]] to add a product
=== Request ===
<nowiki>
POST /orders/000001452259ee0103d4e652007f000000010001/account/products
Content-Type: application/json; charset=UTF-8

{
"offering": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/core.plangroup.dedserver.plan4/offerings/USD-1"
}
</nowiki>

=== Response ===
<nowiki>
201 Created
Content-Type: application/json; charset=UTF-8
Location : </nowiki>{{APIBaseURL}}<nowiki>/orders/000001452259ee0103d4e652007f000000010001/account/products/00000145225a87f17bd8d66d007f000000010001/

{
"url": "</nowiki>{{APIBaseURL}}<nowiki>/orders/000001452259ee0103d4e652007f000000010001/account/products/00000145225a87f17bd8d66d007f000000010001/"
}
</nowiki>

== Add a service to the product with no attributes ==
Use [[Orders-orderId-account-products-productId-services:POST|POST /orders/{order_id}/account/products/{productId}/services ]] to add a product's service
=== Request ===
<nowiki>
POST /orders/000001452259ee0103d4e652007f000000010001/account/products/00000145225a87f17bd8d66d007f000000010001/services
Content-Type: application/json; charset=UTF-8

{
"name": "test123.com",
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/core.dedserver",
"billingCycle": 1
}
</nowiki>

=== Response ===
<nowiki>
201 Created
Content-Type: application/json; charset=UTF-8
Location : </nowiki>{{APIBaseURL}}<nowiki>/orders/000001452292557b24c2acc0007f000000010001/account/products/0000014522925d3222f0ce5b007f000000010001/services/0000014522926e5b266b61ad007f000000010001/

{
"url": "</nowiki>{{APIBaseURL}}<nowiki>/orders/000001452292557b24c2acc0007f000000010001/account/products/0000014522925d3222f0ce5b007f000000010001/services/0000014522926e5b266b61ad007f000000010001/"
}
</nowiki>

== Set an existing account for the order ==
Use [[Orders-orderId-account:PUT|PUT /orders/{order_id}/account]] to assign an existing account to the order
=== Request ===
<nowiki>
PUT /orders/000001452292557b24c2acc0007f000000010001/account
Content-Type: application/json; charset=UTF-8

{
"accountNumber": "test793347"
}
</nowiki>

=== Response ===
<nowiki>
204 No Content
</nowiki>

== Set some account attributes ==
Use [[Orders-orderId-account-attributes:PUT|PUT /orders/{orderId}/account/attributes]] to set the account attributes in an order.
=== Request ===
<nowiki>
PUT /orders/0000014522fbfd383c2b1a33007f000000010001/account/attributes
Content-Type: application/json; charset=UTF-8

[
{
"name":"partner_account_id",
"value":"paccid_030414051600"
}
]
</nowiki>

=== Response ===
<nowiki>
204 No Content
</nowiki>

== Set modified regular contact ==
Use [[Orders-orderId-account-contactInfo-contactType:PUT|PUT /orders/{orderId}/account/contactInfo/{contactType}]] to set the account contact details for a given contact type in an order.
=== Request ===
<nowiki>
PUT /orders/0000014522fbfd383c2b1a33007f000000010001/account/contactInfo/regular
Content-Type: application/json; charset=UTF-8

{
"name":
{
"firstName": "Test-Regular",
"lastName": "Contact",
"company": "MyCompany"
},
"address":
{
"street1": "111 My Street",
"street2": "street2",
"city": "Chicago",
"stateOrProvince": "IL",
"postalCode": "60606",
"countryCode": "US"
},
"contactMedia":
{
"phone1": "312-555-1111",
"phone2": "312-555-222",
"fax": "312-555-1111",
"email1": "myemail@something.com",
"email1Format": "html"
}
}
</nowiki>

== Set account payment info ==
Use [[Orders-orderId-account-paymentInfo:PUT|PUT /orders/{orderId}/account/paymentInfo]] to set the account's payment info.
=== Request ===
<nowiki>
PUT /orders/0000014522fbfd383c2b1a33007f000000010001/account/paymentInfo
Content-Type: application/json; charset=UTF-8

{
"paymentInfoType": "credit_card",
"creditCardType": "visa",
"accountNumber": "1234567890123456",
"cardHolderName": "John Jello",
"expirationDate": "2015-06",
"verificationNumber": "503",
"billingAddress":
{
"street1": "My street",
"street2": "",
"city": "Chicago",
"stateOrProvince": "IL",
"postalCode": "60606",
"countryCode": "US"
}
}
</nowiki>

=== Response ===
<nowiki>
204 No Content
</nowiki>

=== Response ===
<nowiki>
204 No Content
</nowiki>

== Submit the order ==
Use [[Orders-orderId-action:POST|POST /orders/{order_id}/action]] to submit the order and to invoke the ordered product provisioning.

=== Request ===
<nowiki>
POST /orders/000001452292557b24c2acc0007f000000010001/action
Content-Type: application/json; charset=UTF-8

{
"action": "submit"
}
</nowiki>

=== Response ===
<nowiki>
202 Accepted
</nowiki>

'''See also'''
* [[Products|Product Catalog API]]
* [[Orders|Ordering API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]

Order-Products-Account-Modify - Revision history

Mike.robski: 1 revision: Release 92

Angel.dinev at 11:59, 3 April 2014