Orders-orderId-account-products:POST - Revision history

Mike.robski: 1 revision: Release 101

2014-12-17T04:49:15Z

1 revision: Release 101

Mike.robski: 1 revision: Release 100

2014-11-19T05:08:49Z

1 revision: Release 100

Jerry.dimitrov: /* Request Body */

2014-11-12T11:59:22Z

Request Body

Emanuela.mitreva: /* POST /orders/{orderId}/account/products */

2014-10-17T12:33:10Z

POST /orders/{orderId}/account/products

Mike.robski: 1 revision: Release 99

2014-10-14T15:07:00Z

1 revision: Release 99

Emanuela.mitreva: /* POST /orders/{orderId}/account/products */

2014-10-01T13:58:00Z

POST /orders/{orderId}/account/products

Show changes

Mike.robski: 1 revision: Release 98

2014-09-15T13:51:35Z

1 revision: Release 98

Emanuela.mitreva: /* Status Code */

2014-09-11T14:16:03Z

Status Code

Mike.robski: 1 revision: Release 86

2013-10-11T16:59:47Z

1 revision: Release 86

Stanimir.dimitrov: /* Parameters */

2013-10-03T10:42:22Z

Parameters

@@ Line 29: / Line 29: @@
    "promoCode": "{promoCode}",
    "displayName": "My custom product name",
-   "partnerId": "PartnerId"
+   "partnerId": "PartnerId",
 }</nowiki>

@@ Line 29: / Line 29: @@
    "promoCode": "{promoCode}",
    "displayName": "My custom product name",
-   "partnerId": "PartnerId",
+   "partnerId": "PartnerId"
 }</nowiki>

@@ Line 1: / Line 1: @@
 = POST /orders/''{orderId}''/account/products =
-Adds a new Product to the Account's Order.
+Adds a new or existing Product to the Account's Order.
 If, at the time the product is created, there is not yet an Account in the order, then this call will implicitly add a very rudimentary Account (containing only a default language & the currency of this product).
@@ Line 23: / Line 23: @@
 === Request Body ===
   <nowiki>
+{
@@ Line 29: / Line 30: @@
    "displayName": "My custom product name",
    "partnerId": "PartnerId",
+}</nowiki>
   </nowiki>
 ==== Parameters ====
@@ Line 41: / Line 49: @@
 ; partnerId - ''string'' (optional)
 : Partner id.
 === Validation Rules ===
@@ Line 48: / Line 58: @@
 :# The product use type (public, internal, internal view only, etc.) should be allowed for the current user.
 :# The product offering should be valid according to the back-end.
 == Response ==
@@ Line 61: / Line 72: @@
 | The operation was successfully completed.
 |-
-| rowspan="8"| 400 Bad Request
+| rowspan="12"| 400 Bad Request
 | POST data error
 | Trying to create a product with invalid body.
@@ Line 85: / Line 96: @@
 | Trying to add Internal View Only product {product}
 | Trying to add product, which is internal view only, without the proper credentials.
 |-
 | 401 Unauthorized
@@ Line 196: / Line 219: @@
          "guid": "8165a0b2-80f5-436f-ab47-075d824144d9",
          "message": "The requested offering is invalid",
-         "code": 400, "details": ""
+         "code": 400,
+     }
 }</nowiki>

@@ Line 26: / Line 26: @@
+{
    "offering": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
-   "promoCode": "{promoCode}"
+   "promoCode": "{promoCode}",
+}
   </nowiki>
@@ Line 33: / Line 35: @@
 ; offering - ''string''
 : Link to the [[Products#Product_Offerings|product catalog offering]] specifying the new product.
-; promoCode - ''string''
+; promoCode - ''string'' (optional)
 : A promotion code for the new product [[Orders#Promotion_Codes|promotion codes]].
 === Validation Rules ===
@@ Line 46: / Line 52: @@
 === Status Code ===
-;201 Created
+{| class="wikitable"
-: The product was successfully added to the order.
+! Status Code
+! Error Message
-;400 Bad Request
+! Description
-: The request body contains invalid JSON or the values do not adhere to the restrictions set for them.
+|-
+| 201 Created
-;401 Unauthorized
+| -
-: The ''OwnerId'' cookie was not specified or is incorrect.
+| The operation was successfully completed.
+|-
-;403 Forbidden
+| rowspan="6"| 400 Bad Request
-: The client does not have permissions to add products.
+| POST data error
+| Trying to create a product without passing offerings
-;404 Not Found
+|-
-: An account has not been added to the given order or the order does not exist.
+| Cannot add non-existent product \"fake\"
 === Response Headers ===
@@ Line 66: / Line 98: @@
 === Response Body ===
-None.
+==== Successful response ====
 == See also ==

@@ Line 25: / Line 25: @@
   <nowiki>
+{
-   "offering": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}"
+   "offering": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
+}
   </nowiki>
@@ Line 31: / Line 32: @@
 ==== Parameters ====
 ; offering - ''string''
-: Link to the [[Products|product catalog offering]] specifying the new product.
+: Link to the [[Products#Product_Offerings|product catalog offering]] specifying the new product.
 === Validation Rules ===

← Older revision	Revision as of 05:08, 19 November 2014
(One intermediate revision by one user not shown)