POST api/Panier?user={user}

Create a new panier. Confirmed items will be used to create a transaction, unconfirmed items will be placed in a new panier.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
user

string

None.

Body Parameters

Panier to create

UpdatePanier
NameDescriptionTypeAdditional information
Messenger

Messenger

None.
Errors

Collection of Error

None.
IpAddress

Client ip address

string

None.
Currency

string

None.
Id

Panier id. Use for adding, deleting items and updating panier

integer

None.
TransactionID

Transaction id of the transaction that was created when the panier was confirmed. This is normally empty

string

None.
ModePaiementID

integer

None.
OpState

byte

None.
Total_HT

Total price before tax for the panier. Readonly

decimal number

None.
Total_TTC

Total price with tax. Readonly

decimal number

None.
Items

The items contained in the panier

Collection of Item

None.

Request Formats

application/json, text/json

Sample: 
{
  "Messenger": null,
  "Errors": [
    {
      "Code": 1,
      "Detail": "sample string 2",
      "Data": {}
    }
  ],
  "IpAddress": "sample string 3",
  "Currency": "sample string 4",
  "Id": 5,
  "TransactionID": "sample string 6",
  "ModePaiementID": 7,
  "OpState": 64,
  "Total_HT": 9.0,
  "Total_TTC": 10.0,
  "Items": [
    {
      "Id": 1,
      "ProduitID": 1,
      "Period": 1.1,
      "Quantity": 1,
      "Pu": 2.0,
      "Confirm": true,
      "IsUpdate": true,
      "NewQuantity": 1,
      "PeriodLeft": 1.1,
      "OldProduitID": 1,
      "OldPu": 1.0,
      "Total_HT": 5.0,
      "Attributes": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Namebay.Rest.Api.Services.Messenger' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Namebay.Rest.Api.Services.Messenger' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UpdatePanier'.

Response Information

Resource Description

Returns a response object that contains a panier and a transcation on success
Collection of errors on failure
Return codes
200 - ok
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error
510 - object does not exist
511 - object has expired
512 - object parent does not exist
514 - object product incorrect
515 - invalid status
516 - parent product not in command
520 - missing required attribute
525 - object already registered
530 - invalid attribute value
531 - domain is not catchable
532 - domain is not available
533 - domain is not restorable
551 - duplicate entry
552 - object name and object handle mismatch
570 - object status does not allow for operation
572 - operation not allowed for this TLD
700 - Invalid request
706 - Unexpected error
722 - CSR is invalid
733 - Wildcards not allowed
734 - Domain name must be idn
735 - Must be a sub-domain
736 - CSR san limit exceeded
737 - Contact is missing required attribute
738 - CSR san mismatch
739 - CN does not match domain
740 - Must be a wildcard

PanierResponse
NameDescriptionTypeAdditional information
Panier

When confirming items in a panier, this will be a new panier with any remaining items in it. For simple updates this will be the updated panier.

Panier

None.
OriginalPanierId

The id of the panier that when updated caused this panier and transaction to be created

integer

None.
Transaction

When confirming items in a panier, this will be the transaction that was generated by the confirmed items.

Transaction

None.

Response Formats

application/json, text/json

Sample: 
{
  "Panier": {
    "UserHandle": "sample string 1",
    "UserId": 2.0,
    "Messenger": null,
    "Errors": [
      {
        "Code": 1,
        "Detail": "sample string 2",
        "Data": {}
      }
    ],
    "IpAddress": "sample string 3",
    "Currency": "sample string 4",
    "Id": 5,
    "TransactionID": "sample string 6",
    "ModePaiementID": 7,
    "OpState": 64,
    "Total_HT": 9.0,
    "Total_TTC": 10.0,
    "Items": [
      {
        "Id": 1,
        "ProduitID": 1,
        "Period": 1.1,
        "Quantity": 1,
        "Pu": 2.0,
        "Confirm": true,
        "IsUpdate": true,
        "NewQuantity": 1,
        "PeriodLeft": 1.1,
        "OldProduitID": 1,
        "OldPu": 1.0,
        "Total_HT": 5.0,
        "Attributes": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        }
      }
    ]
  },
  "OriginalPanierId": 1,
  "Transaction": {
    "TransactionID": "sample string 1",
    "TransferTransactionID": "sample string 2",
    "Total_HT": 3.0,
    "Total_TTC": 4.0,
    "PanierID": 5,
    "OpDetails": [
      {
        "Id": 1.0,
        "ProduitID": 1,
        "Period": 1.1,
        "Quantity": 1,
        "Pu": 2.0,
        "IsUpdate": true,
        "NewQuantity": 1,
        "PeriodLeft": 1.1,
        "OldProduitID": 1,
        "OldPu": 1.0,
        "Total_HT": 4.0,
        "OpDetailPacks": [
          {
            "Id": 1.0,
            "DetailId": 2.0,
            "ProduitID": 1,
            "Pu": 3.0,
            "CartItems": [
              {
                "Id": 1.0,
                "DetailPackId": 2.0,
                "Name": "sample string 3",
                "Handle": "sample string 4",
                "Class": "sample string 5",
                "Attributes": {
                  "sample string 1": "sample string 2",
                  "sample string 3": "sample string 4"
                }
              }
            ]
          }
        ]
      }
    ],
    "AutoRenew": true,
    "ModePaiementID": 1,
    "OpState": 64,
    "Errors": [
      {
        "Code": 1,
        "Detail": "sample string 2",
        "Data": {}
      }
    ],
    "IpAddress": "sample string 9",
    "Currency": "sample string 10"
  }
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Namebay.Rest.Api.Services.Messenger' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Namebay.Rest.Api.Services.Messenger' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.